Base

Data Structures
class	BaseAnimPhysComponentClass
class	BaseAttachmentType
class	BaseCommandHandlerComponentClass
class	BaseStaminaComponentClass
class	FlattenGrassParametersObject
class	HidingCloth
class	MeshesVisibilitySwitchConfig
class	ScriptedCommand

Functions
BaseAnimPhysComponentClass GameComponentClass	SetCurrentCommand (AnimPhysCommandScripted pCommand)
proto external AnimPhysCommandScripted	GetCommandScripted ()
proto external TAnimGraphCommand	BindCommand (string pCommandName)
proto external TAnimGraphVariable	BindVariableFloat (string pVariableName)
	binds variable More...
proto external TAnimGraphVariable	BindVariableInt (string pVariableName)
proto external TAnimGraphVariable	BindVariableBool (string pVariableName)
proto external TAnimGraphTag	BindTag (string pTagName)
	binds tag More...
proto external TAnimGraphEvent	BindEvent (string pEventName)
	binds event More...
proto external TAnimGraphPrediction	BindPrediction (string pPredictionName)
	binds prediction More...
proto external void	SetVariableFloat (TAnimGraphVariable varIdx, float value)
proto external void	SetVariableInt (TAnimGraphVariable varIdx, int value)
proto external void	SetVariableBool (TAnimGraphVariable varIdx, bool value)
proto external void	CallCommand (TAnimGraphCommand pCmdIndex, int intParam, float floatParam)
proto external void	CallCommand4I (TAnimGraphCommand pCmdIndex, int intParam1, int intParam2, int intParam3, int intParam4, float floatParam)
proto external bool	PhysicsIsFalling ()
	returns true when character is physically falling More...
proto external void	PhysicsEnableGravity (bool pState)
	enables physics More...
BaseCommandHandlerComponentClass GameComponentClass	SetSimulationDisabled (bool pSimulationDisabled)
event protected void	OnInit (IEntity owner)
event protected void	OnCommandActivate (int pCmdId)
event protected void	OnCommandDeactivate (int pCmdId)
event protected void	Update (float pDt, int pCurrentCommandID, bool pCurrentCommandFinished)
BaseStaminaComponentClass GameComponentClass	GetOwner ()
	Owner entity of the fuel tank. More...
proto external float	GetStamina ()
	Get the current stamina value <0..1>. More...

Detailed Description

Function Documentation

BindCommand()

proto external TAnimGraphCommand BindCommand

(

string

pCommandName

)

---

script binding

BindEvent()

proto external TAnimGraphEvent BindEvent

(

string

pEventName

)

binds event

BindPrediction()

proto external TAnimGraphPrediction BindPrediction

(

string

pPredictionName

)

binds prediction

BindTag()

proto external TAnimGraphTag BindTag

(

string

pTagName

)

binds tag

BindVariableBool()

proto external TAnimGraphVariable BindVariableBool

(

string

pVariableName

)

BindVariableFloat()

proto external TAnimGraphVariable BindVariableFloat

(

string

pVariableName

)

binds variable

BindVariableInt()

proto external TAnimGraphVariable BindVariableInt

(

string

pVariableName

)

CallCommand()

proto external void CallCommand	(	TAnimGraphCommand	pCmdIndex,
		int	intParam,
		float	floatParam
	)

CallCommand4I()

proto external void CallCommand4I	(	TAnimGraphCommand	pCmdIndex,
		int	intParam1,
		int	intParam2,
		int	intParam3,
		int	intParam4,
		float	floatParam
	)

GetCommandScripted()

proto external AnimPhysCommandScripted GetCommandScripted

(

)

GetOwner()

BaseStaminaComponentClass GameComponentClass GetOwner

(

)

Owner entity of the fuel tank.

Returns the entity owning the component.

Returns the entity owner of the component.

This component takes care of sending chat messages.

Returns the parent entity of this component.

Returns

Entity this component is atached to.

Definition at line 128 of file SCR_FuelNode.c.

GetStamina()

proto external float GetStamina

(

)

Get the current stamina value <0..1>.

OnCommandActivate()

event protected void OnCommandActivate

(

int

pCmdId

)

Definition at line 36 of file SCR_CharacterCommandHandler.c.

OnCommandDeactivate()

event protected void OnCommandDeactivate

(

int

pCmdId

)

OnInit()

event protected void OnInit

(

IEntity

owner

)

Called during EOnInit.

Parameters

owner

Entity this component is attached to.

Definition at line 523 of file SCR_CharacterCommandHandler_Tests.c.

PhysicsEnableGravity()

proto external void PhysicsEnableGravity

(

bool

pState

)

enables physics

PhysicsIsFalling()

proto external bool PhysicsIsFalling

(

)

returns true when character is physically falling

SetCurrentCommand()

BaseAnimPhysComponentClass GameComponentClass SetCurrentCommand

(

AnimPhysCommandScripted

pCommand

)

---

commands

SetSimulationDisabled()

BaseCommandHandlerComponentClass GameComponentClass SetSimulationDisabled

(

bool

pSimulationDisabled

)

Sets the flag for disabling animation update. This function is ignored in MP.

Parameters

simulationDisabled

If true simulation is disabled

SetVariableBool()

proto external void SetVariableBool	(	TAnimGraphVariable	varIdx,
		bool	value
	)

SetVariableFloat()

proto external void SetVariableFloat	(	TAnimGraphVariable	varIdx,
		float	value
	)

Functions for setting animation variables and calling animation commands. It is recommended to, instead of binding and setting the variables directly, use a ScriptedCommand object with a static table, and to set those variables in the PreAnimUpdate function using the functions provideed by ScriptedCommand instead. For an example on how to use those, see SCR_CharacterCommandSwim. Animation variables can also be overwritten by the character commands, as they are evaluated right before animations, leading to manually set values being discarded.

SetVariableInt()

proto external void SetVariableInt	(	TAnimGraphVariable	varIdx,
		int	value
	)

Update()

event protected void Update	(	float	pDt,
		int	pCurrentCommandID,
		bool	pCurrentCommandFinished
	)

Overrides the whole native command handling

Parameters

pDt	Delta time since last call.
pCurrentCommandID	Current command ID.
pCurrentCommandFinished	True if current command is finished.