C# Class CryEngine.Actor

Inheritance: ActorBase
Show file Open project: PoppermostProductions/CryMono

Protected Methods

Method Description
OnAttach ( CryEngine.EntityId child ) : void

Called whenever another entity has been linked to this entity.

OnCollision ( ColliderInfo source, ColliderInfo target, Vec3 hitPos, Vec3 contactNormal, float penetration, float radius ) : void

Sent on entity collision.

OnDetach ( CryEngine.EntityId child ) : void

Called whenever another entity has been unlinked from this entity.

OnDetachThis ( CryEngine.EntityId parent ) : void

Called whenever this entity is unliked from another entity.

OnEditorReset ( bool enteringGame ) : void

Called when resetting the state of the entity in Editor.

OnEnterArea ( CryEngine.EntityId entityId, int areaId, CryEngine.EntityId areaEntityId ) : void

Sent when entity enters to the area proximity.

OnEnterNearArea ( CryEngine.EntityId entityId, int areaId, CryEngine.EntityId areaEntityId ) : void
OnLeaveArea ( CryEngine.EntityId entityId, int areaId, CryEngine.EntityId areaEntityId ) : void

Sent when entity leaves the area proximity.

OnLeaveNearArea ( CryEngine.EntityId entityId, int areaId, CryEngine.EntityId areaEntityId ) : void
OnLevelLoaded ( ) : void

Called after level has been loaded, is not called on serialization. Note that this is called prior to GameRules.OnClientConnect and OnClientEnteredGame!

OnMove ( EntityMoveFlags moveFlags ) : void

Called when the entities local or world transformation matrix changes. (Position / Rotation / Scale)

OnMoveInsideArea ( CryEngine.EntityId entityId, int areaId, CryEngine.EntityId areaEntityId ) : void

Sent when entity moves inside the area proximity.

OnMoveNearArea ( CryEngine.EntityId entityId, int areaId, CryEngine.EntityId areaEntityId, float fade ) : void
OnPostUpdate ( ) : void
OnPrePhysicsUpdate ( ) : void
OnStartGame ( ) : void

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

OnStartLevel ( ) : void

Called when the level is started.

PostSerialize ( ) : void
PostUpdateView ( ViewParams &viewParams ) : void

Called after updating the view associated to this actor.

UpdateView ( ViewParams &viewParams ) : void

Called to update the view associated to this actor.

Private Methods

Method Description
FullSerialize ( Serialization serialize ) : void
InternalFullSerialize ( Serialization serialize ) : void
InternalNetSerialize ( Serialization serialize, int aspect, byte profile, int flags ) : void
NetSerialize ( Serialization serialize, int aspect, byte profile, int flags ) : void
OnAnimationEvent ( AnimationEvent animEvent ) : void

Method Details

OnAttach() protected method

Called whenever another entity has been linked to this entity.
protected OnAttach ( CryEngine.EntityId child ) : void
child CryEngine.EntityId
return void

OnCollision() protected method

Sent on entity collision.
protected OnCollision ( ColliderInfo source, ColliderInfo target, Vec3 hitPos, Vec3 contactNormal, float penetration, float radius ) : void
source ColliderInfo
target ColliderInfo
hitPos Vec3
contactNormal Vec3
penetration float
radius float
return void

OnDetach() protected method

Called whenever another entity has been unlinked from this entity.
protected OnDetach ( CryEngine.EntityId child ) : void
child CryEngine.EntityId
return void

OnDetachThis() protected method

Called whenever this entity is unliked from another entity.
protected OnDetachThis ( CryEngine.EntityId parent ) : void
parent CryEngine.EntityId
return void

OnEditorReset() protected method

Called when resetting the state of the entity in Editor.
protected OnEditorReset ( bool enteringGame ) : void
enteringGame bool true if currently entering gamemode, false if exiting.
return void

OnEnterArea() protected method

Sent when entity enters to the area proximity.
protected OnEnterArea ( CryEngine.EntityId entityId, int areaId, CryEngine.EntityId areaEntityId ) : void
entityId CryEngine.EntityId
areaId int
areaEntityId CryEngine.EntityId
return void

OnEnterNearArea() protected method

protected OnEnterNearArea ( CryEngine.EntityId entityId, int areaId, CryEngine.EntityId areaEntityId ) : void
entityId CryEngine.EntityId
areaId int
areaEntityId CryEngine.EntityId
return void

OnLeaveArea() protected method

Sent when entity leaves the area proximity.
protected OnLeaveArea ( CryEngine.EntityId entityId, int areaId, CryEngine.EntityId areaEntityId ) : void
entityId CryEngine.EntityId
areaId int
areaEntityId CryEngine.EntityId
return void

OnLeaveNearArea() protected method

protected OnLeaveNearArea ( CryEngine.EntityId entityId, int areaId, CryEngine.EntityId areaEntityId ) : void
entityId CryEngine.EntityId
areaId int
areaEntityId CryEngine.EntityId
return void

OnLevelLoaded() protected method

Called after level has been loaded, is not called on serialization. Note that this is called prior to GameRules.OnClientConnect and OnClientEnteredGame!
protected OnLevelLoaded ( ) : void
return void

OnMove() protected method

Called when the entities local or world transformation matrix changes. (Position / Rotation / Scale)
protected OnMove ( EntityMoveFlags moveFlags ) : void
moveFlags EntityMoveFlags
return void

OnMoveInsideArea() protected method

Sent when entity moves inside the area proximity.
protected OnMoveInsideArea ( CryEngine.EntityId entityId, int areaId, CryEngine.EntityId areaEntityId ) : void
entityId CryEngine.EntityId
areaId int
areaEntityId CryEngine.EntityId
return void

OnMoveNearArea() protected method

protected OnMoveNearArea ( CryEngine.EntityId entityId, int areaId, CryEngine.EntityId areaEntityId, float fade ) : void
entityId CryEngine.EntityId
areaId int
areaEntityId CryEngine.EntityId
fade float
return void

OnPostUpdate() protected method

protected OnPostUpdate ( ) : void
return void

OnPrePhysicsUpdate() protected method

protected OnPrePhysicsUpdate ( ) : void
return void

OnStartGame() protected method

Called when game is started (games may start multiple times)
protected OnStartGame ( ) : void
return void

OnStartLevel() protected method

Called when the level is started.
protected OnStartLevel ( ) : void
return void

PostSerialize() protected method

protected PostSerialize ( ) : void
return void

PostUpdateView() protected method

Called after updating the view associated to this actor.
protected PostUpdateView ( ViewParams &viewParams ) : void
viewParams ViewParams
return void

UpdateView() protected method

Called to update the view associated to this actor.
protected UpdateView ( ViewParams &viewParams ) : void
viewParams ViewParams
return void