CryEngine.EntityComponent

Represents a component that can be attached to an entity at runtime Automatically exposes itself to Schematyc for usage by designers. More...

Classes

struct GUID
class TypeInfo
Unique information for each registered component type

Public Member Functions

void SendSignal< T > (params object[] args)
Sends a signal attributed with [SchematycSignal] to Schematyc More...

Protected Member Functions

virtual void OnTransformChanged ()
virtual void OnInitialize ()
virtual void OnUpdate (float frameTime)
virtual void OnEditorUpdate (float frameTime)
virtual void OnEditorGameModeChange (bool enterGame)
virtual void OnRemove ()
virtual void OnHide ()
virtual void OnUnhide ()
virtual void OnGameplayStart ()
virtual void OnCollision (CollisionEvent collisionEvent)
virtual void OnPrePhysicsUpdate (float frameTime)

Properties

Entity Entity [get]

Detailed Description

Represents a component that can be attached to an entity at runtime Automatically exposes itself to Schematyc for usage by designers.

Systems reference entity components by GUID, for example when serializing to file to detect which type a component belongs to. By default we generate a GUID automatically based on the EntityComponent implementation type, however this will result in serialization breaking if you rename it. To circumvent this, use either System.Runtime.Interopservices.GuidAttribute or the Guid property of the CryEngine.EntityComponent to explicitly specify your desired GUID. Example: [Guid("C47DF64B-E1F9-40D1-8063-2C533A1CE7D5")] public class MyComponent : public EntityComponent {} or [EntityComponent(Guid="C47DF64B-E1F9-40D1-8063-2C533A1CE7D5")] public class MyComponent : public EntityComponent {}

Member Function Documentation

◆ OnCollision()

virtual void CryEngine.EntityComponent.OnCollision ( CollisionEvent collisionEvent)
inline
protected
virtual

◆ OnEditorGameModeChange()

virtual void CryEngine.EntityComponent.OnEditorGameModeChange ( bool enterGame)
inline
protected
virtual

◆ OnEditorUpdate()

virtual void CryEngine.EntityComponent.OnEditorUpdate ( float frameTime)
inline
protected
virtual

◆ OnGameplayStart()

virtual void CryEngine.EntityComponent.OnGameplayStart ( )
inline
protected
virtual

◆ OnHide()

virtual void CryEngine.EntityComponent.OnHide ( )
inline
protected
virtual

◆ OnInitialize()

virtual void CryEngine.EntityComponent.OnInitialize ( )
inline
protected
virtual

◆ OnPrePhysicsUpdate()

virtual void CryEngine.EntityComponent.OnPrePhysicsUpdate ( float frameTime)
inline
protected
virtual

◆ OnRemove()

virtual void CryEngine.EntityComponent.OnRemove ( )
inline
protected
virtual

◆ OnTransformChanged()

virtual void CryEngine.EntityComponent.OnTransformChanged ( )
inline
protected
virtual

◆ OnUnhide()

virtual void CryEngine.EntityComponent.OnUnhide ( )
inline
protected
virtual

◆ OnUpdate()

virtual void CryEngine.EntityComponent.OnUpdate ( float frameTime)
inline
protected
virtual

◆ SendSignal< T >()

void CryEngine.EntityComponent.SendSignal< T > ( params object [] args)
inline

Sends a signal attributed with [SchematycSignal] to Schematyc

Template Parameters
TA delegate contained in an EntityComponent decorated with [SchematycSignal]
Parameters
argsThe exact arguments specified with the specified delegate
Type Constraints
T :class

Property Documentation

◆ Entity

Entity CryEngine.EntityComponent.Entity
get