Determines the state of simulation in the Editor, see OnEditorSimulationModeChanged.

Adds the sink of the entity system. The sink is a class which implements IEntitySystemSink.

Parameters

sink	Pointer to the sink, must not be 0.
subscription	- combination of SinkEventSubscriptions flags specifying which events to receive.

Creates entity from XML. To ensure that entity links work, call BeginCreateEntities. Before using CreateEntity, then call EndCreateEntities when you're done to setup all the links.

Parameters

entityNode	XML entity node.
spawnParams	Entity spawn parameters.
outusingID	Resulting ID.

Extract entity archetype load parameters from XML.

Parameters

entityNode	XML archetype entity node.
spawnParams	Archetype entity spawn parameters.

Extract entity load parameters from XML.

Parameters

entityNode	XML entity node.
spawnParams	Entity spawn parameters.

Find first entity with given name.

Parameters

sEntityName

Name to look for.

Returns

The entity if found, 0 if failed.

#include 

void FindEntityByName()
{
    // The name of the entity that we want to query for
    // This is the name specified with SEntitySpawnParams::sName, IEntity::SetName and in the properties panel inside the Editor when an entity is selected.
    const char* szMyEntityName = "MyEntity";

    // Query the entity system for the entity, searching the by-name entity map
    // Note that this operation is more costly than looking up by Id, and is *not* reliable as entity names are not unique!
    if (IEntity* pEntity = gEnv->pEntitySystem->FindEntityByName(szMyEntityName))
    {
        /* Entity was present in the world, and the pointer can now be used. 
           Note that the lifetime of pEntity is managed by the entity system, avoid storing the raw pointer to be safe. */
    }
}

Returns

The breakable manager interface.

Retrieves the entity class registry interface.

Returns

Pointer to the valid entity class registry interface.

Retrieves entity from its unique id.

Parameters

id	Unique ID of the entity required.

Returns

Entity if one with such an ID exists, and NULL if no entity could be matched with the id

#include 
#include 

void GetEntity()
{
    // Identifier of the entity that we want to find, for example found by calling IEntity::GetId.
    // For the sake of this example we will query the default player entity identifier.
    EntityId id = LOCAL_PLAYER_ENTITY_ID;

    // Query the entity system for the entity, this will result in a constant-time lookup.
    if (IEntity* pEntity = gEnv->pEntitySystem->GetEntity(id))
    {
        /* Entity was present in the world, and the pointer can now be used. 
           Note that the lifetime of pEntity is managed by the entity system, avoid storing the raw pointer to be safe. */
    }
}

Gets a entity iterator. This iterator interface can be used to traverse all the entities in this entity system.

#include 

void TraverseEntities()
{
    // Retrieves an iterator that can be used to traverse all the entities in the scene
    // Note that this can easily become expensive due to the sheer number of entities that can be in each scene
    IEntityItPtr pEntityIterator = gEnv->pEntitySystem->GetEntityIterator();

    // Traverse the entities until IEntityIt::Next returns a nullptr
    while (IEntity* pEntity = pEntityIterator->Next())
    {
        // Skip entities that have been marked for deletion (clean-up will occur at the start of the next frame)
        if (!pEntity->IsGarbage())
        {
            /* pEntity can now be safely used */
        }
    }
}

Returns

Number of stored in entity system.

Gets all entities in specified radius.

Parameters

origin
radius
pList
physFlags	Is one or more of PhysicalEntityFlag.

Initialize entity if entity was spawned not initialized (with bAutoInit false in SpawnEntity).

Note

Used only by Editor, to setup properties & other things before initializing entity, do not use this directly.

Parameters

pEntity	Pointer to just spawned entity object.
params	Entity descriptor structure that describes what kind of entity needs to be spawned.

Returns

true if successfully initialized entity.

Loads entities exported from Editor. bIsLoadingLevelFile indicates if the loaded entities come from the original level file.

Pause all entity timers.

Parameters

bPause

true to pause timer, false to resume.

Updates entity system and all entities before physics is called (or as early as possible after input in the multithreaded physics case). This function executes once per frame.

Get all entities within proximity of the specified bounding box.

Note

Query is not exact, entities reported can be a few meters away from the bounding box.

Removes an entity by ID.

Parameters

entity	Id of the entity to be removed.
bForceRemoveNow	If true, forces immediately delete of entity, overwise will delete entity on next update.

Removes listening sink from the entity system. The sink is a class which implements IEntitySystemSink.

Parameters

sink	Pointer to the sink, must not be 0.

Note

Might be needed to call before loading of entities to be sure we get the requested IDs.

Parameters

id	Must not be 0.

Resizes the proximity grid.

Note

Call this when you know dimensions of the level, before entities are created.

Resets physical simulation suppressed by LiveCreate during "edit mode". Called by LiveCreate subsystem when user resumed normal game mode.

Sends the same event to all entities in Entity System.

Parameters

event

Event to send.

Spawns a new entity according to the data in the Entity Descriptor.

Parameters

params	Entity descriptor structure that describes what kind of entity needs to be spawned.
bAutoInit	If true, automatically initialize entity.

Returns

If successful, the spawned entity, otherwise nullptr.

#include 

void SpawnEntity(const Matrix34& initialWorldTransformation)
{
    // Create a spawn parameters structure, used to specify the initial state of the entity we want to spawn
    SEntitySpawnParams spawnParameters;
    // Specify position in world coordinates
    spawnParameters.vPosition = initialWorldTransformation.GetTranslation();
    // Specify world rotation
    spawnParameters.qRotation = Quat(initialWorldTransformation);
    // Specify scale
    spawnParameters.vScale = initialWorldTransformation.GetScale();

    // Now spawn the entity in the world
    if (IEntity* pEntity = gEnv->pEntitySystem->SpawnEntity(spawnParameters))
    {
        /* pEntity can now be used, and will persist until manually removed or when the level is unloaded */
    }
}