C# Class CryEngine.EntityBase

Represents an CryENGINE entity

Inheritance: CryScriptInstance

Show file Open project: PoppermostProductions/CryMono Class Usage Examples

Private Properties

Property	Type	Description
Physicalize	void

Public Methods

Method	Description
AddMovement ( CryEngine.EntityMovementRequest &request ) : void	Requests movement at the specified slot, providing an animated character is currently loaded.
DePhysicalize ( ) : void
FreeSlot ( int slot ) : void	Frees the specified slot of all objects.
GetAttachment ( int index, int characterSlot ) : Attachment	Gets the attachment at the specified slot and index.
GetAttachment ( string name, int characterSlot ) : Attachment	Gets the attachment by name at the specified slot.
GetAttachmentCount ( int characterSlot ) : int	Gets the number of attachments at the specified character slot.
GetJointAbsolute ( string jointName, int characterSlot ) : QuatT	Gets the absolute of the specified joint
GetJointRelative ( string jointName, int characterSlot ) : QuatT	Gets the relative of the specified joint
GetObjectFilePath ( int slot ) : string	Gets the path to the currently loaded object.
GetSlotFlags ( int slot ) : EntitySlotFlags	Retrieves the flags of the specified slot.
LoadLight ( LightParams parameters, int slot = 1 ) : int	Loads a light source to the specified slot, or to the next available slot.
LoadObject ( string name, int slot ) : bool	Loads a mesh for this entity. Can optionally load multiple meshes using entity slots.
LoadParticleEmitter ( ParticleEffect particleEffect, ParticleSpawnParameters &spawnParams, int slot = -1 ) : ParticleEmitter
PlayAnimation ( string animationName, AnimationFlags flags, int slot, int layer, float blend = 0.175f, float speed = 1.0f ) : void	Plays a raw animation.
Remove ( bool forceRemoveNow = false ) : void	Removes the entity from the CryEngine world.
RemoveAllLinks ( ) : void
SetSlotFlags ( EntitySlotFlags flags, int slot ) : void	Sets the flags of the specified slot.
StopAnimation ( int slot, int layer, float blendOutTime ) : void	Stops the currently playing animation.

Private Methods

Method	Description
Physicalize ( PhysicalizationParams physicalizationParams ) : void

Method Details

AddMovement() public method

Requests movement at the specified slot, providing an animated character is currently loaded.

public AddMovement ( CryEngine.EntityMovementRequest &request ) : void
request	CryEngine.EntityMovementRequest
return	void

DePhysicalize() public method

public DePhysicalize ( ) : void
return	void

FreeSlot() public method

Frees the specified slot of all objects.

public FreeSlot ( int slot ) : void
slot	int
return	void

GetAttachment() public method

Gets the attachment at the specified slot and index.

public GetAttachment ( int index, int characterSlot ) : Attachment
index	int	Attachment index
characterSlot	int	Index of the character slot we wish to get an attachment from
return	Attachment

GetAttachment() public method

Gets the attachment by name at the specified slot.

public GetAttachment ( string name, int characterSlot ) : Attachment
name	string	Attachment name
characterSlot	int	Index of the character slot we wish to get an attachment from
return	Attachment

GetAttachmentCount() public method

Gets the number of attachments at the specified character slot.

public GetAttachmentCount ( int characterSlot ) : int
characterSlot	int	Index of the slot we wish to get the attachment count of
return	int

GetJointAbsolute() public method

Gets the absolute of the specified joint

public GetJointAbsolute ( string jointName, int characterSlot ) : QuatT
jointName	string	Name of the joint
characterSlot	int	Slot containing the character
return	QuatT

GetJointRelative() public method

Gets the relative of the specified joint

public GetJointRelative ( string jointName, int characterSlot ) : QuatT
jointName	string	Name of the joint
characterSlot	int	Slot containing the character
return	QuatT

GetObjectFilePath() public method

Gets the path to the currently loaded object.

public GetObjectFilePath ( int slot ) : string
slot	int	Slot containing the object we want to know the path of.
return	string

GetSlotFlags() public method

Retrieves the flags of the specified slot.

public GetSlotFlags ( int slot ) : EntitySlotFlags
slot	int	Index of the slot
return	EntitySlotFlags

LoadLight() public method

Loads a light source to the specified slot, or to the next available slot.

public LoadLight ( LightParams parameters, int slot = 1 ) : int
parameters	LightParams	New params of the light source we wish to load
slot	int	Slot we want to load the light into, if -1 chooses the next available slot.
return	int

LoadObject() public method

Loads a mesh for this entity. Can optionally load multiple meshes using entity slots.

public LoadObject ( string name, int slot ) : bool
name	string	Path to the object (Relative to the game directory)
slot	int
return	bool

LoadParticleEmitter() public method

public LoadParticleEmitter ( ParticleEffect particleEffect, ParticleSpawnParameters &spawnParams, int slot = -1 ) : ParticleEmitter
particleEffect	ParticleEffect
spawnParams	ParticleSpawnParameters
slot	int
return	ParticleEmitter

PlayAnimation() public method

Plays a raw animation.

public PlayAnimation ( string animationName, AnimationFlags flags, int slot, int layer, float blend = 0.175f, float speed = 1.0f ) : void
animationName	string	Name of the animation we wish to play
flags	AnimationFlags
slot	int	Slot on which to play the animation
layer	int	Animation layer to play the animation in.
blend	float	Transition time between two animations.
speed	float	Animation playback speed
return	void

Remove() public method

Removes the entity from the CryEngine world.

public Remove ( bool forceRemoveNow = false ) : void
forceRemoveNow	bool	If true, the entity will be removed immediately.
return	void

RemoveAllLinks() public method

public RemoveAllLinks ( ) : void
return	void

SetSlotFlags() public method

Sets the flags of the specified slot.

public SetSlotFlags ( EntitySlotFlags flags, int slot ) : void
flags	EntitySlotFlags	Flags to set.
slot	int	Index of the slot, if -1 apply to all existing slots.
return	void

StopAnimation() public method

Stops the currently playing animation.

public StopAnimation ( int slot, int layer, float blendOutTime ) : void
slot	int	The character slot.
layer	int	The animation layer which we want to stop. If -1, stops all layers.
blendOutTime	float
return	void