C# Class CryEngine.Advanced.GameObject

Show file Open project: PoppermostProductions/CryMono Class Usage Examples

Private Properties

Property Type Description
GameObject System
GameObject System
SetAspectProfile bool
TryGetExtension GameObjectExtension

Public Methods

Method Description
AcquireExtension ( string name ) : GameObjectExtension

Forcefully get a pointer to an extension (may instantiate if needed)

ActivateExtension ( string name ) : bool

Turn an extension on

BindToNetwork ( BindToNetworkMode mode = BindToNetworkMode.Normal ) : bool
DeactivateExtension ( string name ) : void

Turn an extension off

EnablePhysicsEvent ( bool enable, EntityPhysicsEvents physicsEvent ) : void
Get ( EntityId id ) : GameObject
NotifyNetworkStateChange ( int aspect ) : void
QueryExtension ( string name ) : GameObjectExtension

Query extension. returns 0 if extension is not there.

ReleaseExtension ( string name ) : void

Release a previously acquired extension

WantsPhysicsEvent ( EntityPhysicsEvents physicsEvent ) : bool

Private Methods

Method Description
GameObject ( ) : System
GameObject ( IntPtr handle ) : System
SetAspectProfile ( EntityAspects aspect, ushort profile, bool fromNetwork = false ) : bool
TryGetExtension ( IntPtr handle ) : GameObjectExtension

Method Details

AcquireExtension() public method

Forcefully get a pointer to an extension (may instantiate if needed)
public AcquireExtension ( string name ) : GameObjectExtension
name string
return GameObjectExtension

ActivateExtension() public method

Turn an extension on
public ActivateExtension ( string name ) : bool
name string
return bool

BindToNetwork() public method

public BindToNetwork ( BindToNetworkMode mode = BindToNetworkMode.Normal ) : bool
mode BindToNetworkMode
return bool

DeactivateExtension() public method

Turn an extension off
public DeactivateExtension ( string name ) : void
name string
return void

EnablePhysicsEvent() public method

public EnablePhysicsEvent ( bool enable, EntityPhysicsEvents physicsEvent ) : void
enable bool
physicsEvent EntityPhysicsEvents
return void

Get() public static method

public static Get ( EntityId id ) : GameObject
id EntityId
return GameObject

NotifyNetworkStateChange() public method

public NotifyNetworkStateChange ( int aspect ) : void
aspect int
return void

QueryExtension() public method

Query extension. returns 0 if extension is not there.
public QueryExtension ( string name ) : GameObjectExtension
name string
return GameObjectExtension

ReleaseExtension() public method

Release a previously acquired extension
public ReleaseExtension ( string name ) : void
name string
return void

WantsPhysicsEvent() public method

public WantsPhysicsEvent ( EntityPhysicsEvents physicsEvent ) : bool
physicsEvent EntityPhysicsEvents
return bool