BaseItemAnimationComponent Interface Reference

Inheritance diagram for BaseItemAnimationComponent:

Public Member Functions
proto external IEntity	GetOwner ()
proto external bool	SyncWithCharacter (ChimeraCharacter pCharacter, bool isMainCharacter, string overrideStartNode)
	Syncs item with character and subscribing to it's variable changes and command calls returns true on success.
proto external bool	RemoveSyncReference (ChimeraCharacter pCharacter)
	Removes previously synced character reference.
proto external bool	IsAnimationTag (AnimationTagID animTagID)
proto external bool	IsAnimationEvent (AnimationEventID animEventID, out int userInt)

Protected Member Functions
void	OnAnimationEvent (AnimationEventID animEventType, AnimationEventID animUserString, int intParam, float timeFromStart, float timeToEnd)
bool	OnPrepareAnimInput (IEntity owner, float ts)
	Called every frame right before animation controller will be updated return true to stop default animation behavior of an item, return false otherwise (default)
bool	OnProcessAnimOutput (IEntity owner, float ts)
	Called every frame right before animation controller will be updated return true to stop default animation behavior of an item, return false otherwise (default)
void	OnCharacterFloatVariablet (int variableID, float value)
	Called when variable was changed in synced character's animation logic.
void	OnCharacterIntVariable (int variableID, int value)
void	OnCharacterBoolVariable (int variableID, bool value)
void	OnCharacterCommand (int commandID, int intValue, float floatValue)
	Called when animation command was called in synced character's animation logic.

Member Function Documentation

GetOwner()

proto external IEntity BaseItemAnimationComponent.GetOwner

(

)

IsAnimationEvent()

proto external bool BaseItemAnimationComponent.IsAnimationEvent	(	AnimationEventID	animEventID,
		out int	userInt
	)

IsAnimationTag()

proto external bool BaseItemAnimationComponent.IsAnimationTag

(

AnimationTagID

animTagID

)

OnAnimationEvent()

void BaseItemAnimationComponent.OnAnimationEvent ( AnimationEventID  animEventType, AnimationEventID  animUserString, int  intParam, float  timeFromStart, float  timeToEnd  )

protected

Implemented in SCR_MineAnimationComponent.

OnCharacterBoolVariable()

void BaseItemAnimationComponent.OnCharacterBoolVariable ( int  variableID, bool  value  )

protected

OnCharacterCommand()

void BaseItemAnimationComponent.OnCharacterCommand ( int  commandID, int  intValue, float  floatValue  )

protected

Called when animation command was called in synced character's animation logic.

OnCharacterFloatVariablet()

void BaseItemAnimationComponent.OnCharacterFloatVariablet ( int  variableID, float  value  )

protected

Called when variable was changed in synced character's animation logic.

OnCharacterIntVariable()

void BaseItemAnimationComponent.OnCharacterIntVariable ( int  variableID, int  value  )

protected

OnPrepareAnimInput()

bool BaseItemAnimationComponent.OnPrepareAnimInput ( IEntity  owner, float  ts  )

protected

Called every frame right before animation controller will be updated return true to stop default animation behavior of an item, return false otherwise (default)

OnProcessAnimOutput()

bool BaseItemAnimationComponent.OnProcessAnimOutput ( IEntity  owner, float  ts  )

protected

Called every frame right before animation controller will be updated return true to stop default animation behavior of an item, return false otherwise (default)

RemoveSyncReference()

proto external bool BaseItemAnimationComponent.RemoveSyncReference

(

ChimeraCharacter

pCharacter

)

Removes previously synced character reference.

SyncWithCharacter()

proto external bool BaseItemAnimationComponent.SyncWithCharacter	(	ChimeraCharacter	pCharacter,
		bool	isMainCharacter,
		string	overrideStartNode
	)

Syncs item with character and subscribing to it's variable changes and command calls returns true on success.

---

The documentation for this interface was generated from the following file:

• Game/generated/Components/BaseItemAnimationComponent.c