FiveM Docs / Native Reference
API Set:
  • all
  • server
  • client
Language:
  • raw
  • lua
  • c#
  • js
Namespace: CFXAPI set: sharededitImprove

GET_ENTITY_FROM_STATE_BAG_NAME

0x4BDF1867
// GetEntityFromStateBagName
Entity GET_ENTITY_FROM_STATE_BAG_NAME(char* bagName);
Parameters:
  • bagName:

    An internal state bag ID from the argument to a state bag change handler.

Returns:

The entity handle or 0 if the state bag name did not refer to an entity, or the entity does not exist.

Returns the entity handle for the specified state bag name. For use with ADD_STATE_BAG_CHANGE_HANDLER.

Examples:

  • JavaScript
  • Lua
AddStateBagChangeHandler("blockTasks", null, async (bagName, key, value /* boolean */) => {
    let entity = GetEntityFromStateBagName(bagName);
    // Whoops, we were don't have a valid entity!
    if (entity === 0) return;
    // We don't want to freeze the entity position if the entity collision hasn't loaded yet
    while (!HasCollisionLoadedAroundEntity(entity)) {
        // The entity went out of our scope before the collision loaded
        if (!DoesEntityExist(entity)) return;
        await Delay(250);
    }
    SetEntityInvincible(entity, value)
    FreezeEntityPosition(entity, value)
    TaskSetBlockingOfNonTemporaryEvents(entity, value)
})
FLAG_SERVER_AS_PRIVATE(BOOL private_)
FLUSH_RESOURCE_KVP()
FORCE_SNOW_PASS(BOOL enabled)
FREEZE_ENTITY_POSITION(Entity entity, BOOL toggle)
GET_ACTIVE_PLAYERS()
GET_AIR_DRAG_MULTIPLIER_FOR_PLAYERS_VEHICLE(char* playerSrc)
GET_ALL_OBJECTS()
GET_ALL_PEDS()
GET_ALL_ROPES()
GET_ALL_VEHICLE_MODELS()
GET_ALL_VEHICLES()
GET_AMBIENT_PED_RANGE_MULTIPLIER()
GET_AMBIENT_VEHICLE_RANGE_MULTIPLIER()
GET_CAM_MATRIX(Cam camera, Vector3* rightVector, Vector3* forwardVector, Vector3* upVector, Vector3* position)
GET_CONSOLE_BUFFER()
GET_CONVAR(char* varName, char* default_)
GET_CONVAR_INT(char* varName, int default_)
GET_CURRENT_GAME_NAME()
GET_CURRENT_RESOURCE_NAME()
GET_CURRENT_SERVER_ENDPOINT()
GET_DUI_HANDLE(long duiObject)
GET_ENTITY_ARCHETYPE_NAME(Entity entity)
GET_ENTITY_ATTACHED_TO(Entity entity)
GET_ENTITY_COORDS(Entity entity)
GET_ENTITY_FROM_STATE_BAG_NAME(char* bagName)
GET_ENTITY_HEADING(Entity entity)
GET_ENTITY_HEALTH(Entity entity)
GET_ENTITY_INDEX_FROM_MAPDATA(int mapdata, int entity)
GET_ENTITY_MAPDATA_OWNER(Entity entity, int* mapdataHandle, int* entityHandle)
GET_ENTITY_MAX_HEALTH(Entity entity)
GET_ENTITY_MODEL(Entity entity)
GET_ENTITY_POPULATION_TYPE(Entity entity)
GET_ENTITY_ROTATION(Entity entity)
GET_ENTITY_ROTATION_VELOCITY(Entity entity)
GET_ENTITY_ROUTING_BUCKET(Entity entity)