WeaponAnimationComponent Interface Reference

Inheritance diagram for WeaponAnimationComponent:

Public Member Functions
proto external bool	GetBipod ()
proto external bool	HasBipod ()
proto external void	SetBipod (bool open, bool fastForwardAnimations=false)
proto external void	FoldWeapon (bool fastForwardAnimations=false)
proto external void	UnfoldWeapon (bool fastForwardAnimations=false)
proto external bool	IsFolded ()
Public Member Functions inherited from BaseItemAnimationComponent
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)

Additional Inherited Members
Protected Member Functions inherited from BaseItemAnimationComponent
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

FoldWeapon()

proto external void WeaponAnimationComponent.FoldWeapon

(

bool

fastForwardAnimations = false

)

GetBipod()

proto external bool WeaponAnimationComponent.GetBipod

(

)

HasBipod()

proto external bool WeaponAnimationComponent.HasBipod

(

)

IsFolded()

proto external bool WeaponAnimationComponent.IsFolded

(

)

SetBipod()

proto external void WeaponAnimationComponent.SetBipod	(	bool	open,
		bool	fastForwardAnimations = false
	)

UnfoldWeapon()

proto external void WeaponAnimationComponent.UnfoldWeapon

(

bool

fastForwardAnimations = false

)

---

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

• Game/generated/Weapon/WeaponAnimationComponent.c