Sent when the entity local or world transformation matrix change (position/rotation/scale). nParam[0] = combination of the EEntityXFormFlags.

Called when the entity is moved/scaled/rotated in the editor. Only send on mouseButtonUp (hence finished).

Sent when the entity timer expire. nParam[0] = TimerId, nParam[1] = milliseconds.

Sent for unremovable entities when they are respawn.

Sent before entity is removed.

Sent to reset the state of the entity (used from Editor). nParam[0] is 1 if entering game mode, 0 if exiting

Sent to parent entity after child entity have been attached. nParam[0] contains ID of child entity.

Sent to child entity after it has been attached to the parent. nParam[0] contains ID of parent entity.

Sent to parent entity after child entity have been detached. nParam[0] contains ID of child entity.

Sent to child entity after it has been detached from the parent. nParam[0] contains ID of parent entity.

Sent to an entity when a new named link was added to it (normally through the Editor)

See also

IEntity::GetEntityLinks

IEntity::AddEntityLink nParam[0] contains IEntityLink ptr.

Sent to an entity when a named link was removed from it (normally through the Editor)

See also

IEntity::RemoveEntityLink nParam[0] contains IEntityLink ptr.

Sent when the entity must be hidden.

Sent when the entity must become not hidden.

Sent when the entity must be hidden.

Sent when the entity must become not hidden.

Sent when a physics processing for the entity must be enabled/disabled. nParam[0] == 1 physics must be enabled if 0 physics must be disabled.

Sent when a physics in an entity changes state. nParam[0] == 1 physics entity awakes, 0 physics entity get to a sleep state.

Sent when script is broadcasting its events. nParam[0] = Pointer to the ASCIIZ string with the name of the script event. nParam[1] = Type of the event value from IEntityClass::EventValueType. nParam[2] = Pointer to the event value depending on the type.

Sent when triggering entity enters to the area proximity, this event sent to all target entities of the area. nParam[0] = TriggerEntityId, nParam[1] = AreaId, nParam[2] = EntityId of Area

Sent when triggering entity leaves the area proximity, this event sent to all target entities of the area. nParam[0] = TriggerEntityId, nParam[1] = AreaId, nParam[2] = EntityId of Area

Sent when triggering entity is near to the area proximity, this event sent to all target entities of the area. nParam[0] = TriggerEntityId, nParam[1] = AreaId, nParam[2] = EntityId of Area fParam[0] = distance

Sent when triggering entity leaves the near area within proximity region of the outside area border. nParam[0] = TriggerEntityId, nParam[1] = AreaId, nParam[2] = EntityId of Area

Sent when triggering entity moves inside the area within proximity region of the outside area border. nParam[0] = TriggerEntityId, nParam[1] = AreaId, nParam[2] = EntityId of Area

Sent when triggering entity moves inside the area within the near region of the outside area border. nParam[0] = TriggerEntityId, nParam[1] = AreaId, nParam[2] = EntityId of Area, fParam[0] = FadeRatio (0-1)

Sent when an entity with pef_monitor_poststep receives a poststep notification (the hamdler should be thread safe!) fParam[0] = time interval

Sent when Breakable object is broken in physics.

Sent when a logged physical collision is processed on the Main thread. The collision has already occurred since this event is logged, but can be handled on the main thread without considering threading. nParam[0] = const EventPhysCollision *, contains collision info and can be obtained as: reinterpret_cast(event.nParam[0]) nParam[1] 0 if we are the source of the collision, otherwise 1.

#include 

// Example of how a component can listen to collision events
// Note that this example assumes that the entity has already been physicalized
class CPhysicsMonitorCompoent final : public IEntityComponent
{
public:
    // Provide a virtual destructor, ensuring correct destruction of IEntityComponent members
    virtual ~CPhysicsMonitorCompoent() = default;

    static void ReflectType(Schematyc::CTypeDesc& desc) { /* Reflect type here */ }

    virtual void ProcessEvent(const SEntityEvent& event) override
    {
        if (event.event == ENTITY_EVENT_COLLISION)
        {
            // Get the EventPhysCollision structure describing the collision that occurred
            const EventPhysCollision* pPhysCollision = reinterpret_cast(event.nParam[0]);

            // The EventPhysCollision provides information for both the source and target entities
            // Therefore, we store the indices of this entity (and the other collider)
            // This can for example be used to get the surface identifier (and thus the material) of the part of our entity that collided
            const int thisEntityIndex = static_cast(event.nParam[1]);
            // Calculate the index of the other entity
            const int otherEntityIndex = (thisEntityIndex + 1) % 2;

            // Get the contact point (in world coordinates) of the two entities
            const Vec3& contactPoint = pPhysCollision->pt;
            // Get the collision normal vector
            const Vec3& contactNormal = pPhysCollision->n;

            // Get properties for our entity, starting with the local velocity of our entity at the contact point
            const Vec3& relativeContactVelocity = pPhysCollision->vloc[thisEntityIndex];
            // Get the mass of our entity
            const float contactMass = pPhysCollision->mass[thisEntityIndex];
            // Get the identifier of the part of our entity that collided
            // This is the same identifier that is added with IPhysicalEntity::AddGeometry
            const int contactPartId = pPhysCollision->partid[thisEntityIndex];
            // Get the surface on our entity that collided
            const int contactSurfaceId = pPhysCollision->idmat[thisEntityIndex];
            // Get the ISurfaceType representation of the surface that collided
            if (const ISurfaceType* pContactSurface = gEnv->p3DEngine->GetMaterialManager()->GetSurfaceType(contactSurfaceId))
            {
                /* Interact with pContactSurface here*/
            }
        }
    }

    virtual uint64 GetEventMask() const override
    {
        // Indicate that we want to receive the ENTITY_EVENT_COLLISION entity event
        return ENTITY_EVENT_BIT(ENTITY_EVENT_COLLISION);
    }
};

Sent when a physical collision is reported just as it occurred, most likely on the physics thread. This callback has to be thread-safe! nParam[0] = const EventPhysCollision *, contains collision info and can be obtained as: reinterpret_cast(event.nParam[0]) nParam[1] 0 if we are the source of the collision, otherwise 1.

Sent only if ENTITY_FLAG_SEND_RENDER_EVENT is set Called when entity is first rendered (When any of the entity render nodes are considered by 3D engine for rendering this frame) Or called when entity is not being rendered for at least several frames nParam[0] == 0 if rendeing Stops. nParam[0] == 1 if rendeing Starts.

Called when the level loading is complete.

Called when the level is started.

Called when the game is started (games may start multiple times).

Called when the entity enters a script state.

Called when the entity leaves a script state.

Called before we serialized the game from file.

Called after we serialized the game from file.

Called when the entity becomes invisible. nParam[0] = if 1 physics will ignore this event

Called when the entity gets out of invisibility. nParam[0] = if 1 physics will ignore this event

Called when the entity material change. nParam[0] = pointer to the new IMaterial.

Called when the entitys material layer mask changes.

Called when an animation event (placed on animations in editor) is encountered. nParam[0] = AnimEventInstance* pEventParameters. nParam[1] = ICharacterInstance* that this event occurred on

Called from ScriptBind_Entity when script requests to set collidermode. nParam[0] = ColliderMode

Called to activate some output in a flow node connected to the entity nParam[0] = Output port index nParam[1] = TFlowInputData* to send to output

Called in the editor when a property of the selected entity changes. This is not sent when using IEntityPropertyGroup nParam[0] = IEntityComponent pointer or nullptr nParam[1] = Member id of the changed property, (

See also

IEntityComponent::GetClassDesc() FindMemberById(nParam[1]))

Called when a script reloading is requested and done in the editor.

Called when the entity is added to the list of entities that are updated. Note that this event is deprecated, and should not be used

Called when the entity is removed from the list of entities that are updated. Note that this event is deprecated, and should not be used

Called when the entity's network authority changes. Only the server is able to delegate/revoke the authority to/from the client. nParam[0] stores the new authority value.

Sent once to the to the client when the special player entity has spawned.

See also

ENTITY_FLAG_LOCAL_PLAYER

Called when the entity should be added to the radar.

Called when the entity should be removed from the radar.

Called when the entity's name is set.

Called when an event related to an audio trigger occurred. REMARK:: Only sent for triggers that have their ERequestFlags set to receive Callbacks via (CallbackOnExternalOrCallingThread | DoneCallbackOnExternalThread) from the main-thread nParam[0] stores a const CryAudio::SRequestInfo* const

Remark: Will also be sent, if the trigger failed to start.

Sent when an entity slot changes, i.e. geometry was added nParam[0] stores the slot index

Sent when the physical type of an entity changed, i.e. physicalized or dephysicalized.

Entity was just spawned on this machine as requested by the server.

Called when the pre-physics update is done; fParam[0] is the frame time.

Sent when the entity is updating every frame. nParam[0] = pointer to SEntityUpdateContext structure. fParam[0] = frame time

Last entity event in list.