BaseAnimPhysComponent Interface Reference

Inheritance diagram for BaseAnimPhysComponent:

Public Member Functions
proto external void	SetCurrentCommand (AnimPhysCommandScripted pCommand)
proto external AnimPhysCommandScripted	GetCommandScripted ()
proto external TAnimGraphCommand	BindCommand (string pCommandName)
proto external TAnimGraphVariable	BindVariableFloat (string pVariableName)
	binds variable
proto external TAnimGraphVariable	BindVariableInt (string pVariableName)
proto external TAnimGraphVariable	BindVariableBool (string pVariableName)
proto external TAnimGraphTag	BindTag (string pTagName)
	binds tag
proto external TAnimGraphEvent	BindEvent (string pEventName)
	binds event
proto external TAnimGraphPrediction	BindPrediction (string pPredictionName)
	binds prediction
proto external void	SetVariableFloat (TAnimGraphVariable varIdx, float value)
	Functions for setting animation variables and calling animation commands.
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
proto external void	PhysicsEnableGravity (bool pState)
	enables physics
proto external void	PhysicsSetStance (int index)
proto external void	PhysicsSetCollisionOffset (vector pOff)
Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Member Function Documentation

BindCommand()

proto external TAnimGraphCommand BaseAnimPhysComponent.BindCommand

(

string

pCommandName

)

---

script binding

BindEvent()

proto external TAnimGraphEvent BaseAnimPhysComponent.BindEvent

(

string

pEventName

)

binds event

BindPrediction()

proto external TAnimGraphPrediction BaseAnimPhysComponent.BindPrediction

(

string

pPredictionName

)

binds prediction

BindTag()

proto external TAnimGraphTag BaseAnimPhysComponent.BindTag

(

string

pTagName

)

binds tag

BindVariableBool()

proto external TAnimGraphVariable BaseAnimPhysComponent.BindVariableBool

(

string

pVariableName

)

BindVariableFloat()

proto external TAnimGraphVariable BaseAnimPhysComponent.BindVariableFloat

(

string

pVariableName

)

binds variable

BindVariableInt()

proto external TAnimGraphVariable BaseAnimPhysComponent.BindVariableInt

(

string

pVariableName

)

CallCommand()

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

CallCommand4I()

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

GetCommandScripted()

proto external AnimPhysCommandScripted BaseAnimPhysComponent.GetCommandScripted

(

)

PhysicsEnableGravity()

proto external void BaseAnimPhysComponent.PhysicsEnableGravity

(

bool

pState

)

enables physics

PhysicsIsFalling()

proto external bool BaseAnimPhysComponent.PhysicsIsFalling

(

)

returns true when character is physically falling

PhysicsSetCollisionOffset()

proto external void BaseAnimPhysComponent.PhysicsSetCollisionOffset

(

vector

pOff

)

PhysicsSetStance()

proto external void BaseAnimPhysComponent.PhysicsSetStance

(

int

index

)

SetCurrentCommand()

proto external void BaseAnimPhysComponent.SetCurrentCommand

(

AnimPhysCommandScripted

pCommand

)

---

commands

SetVariableBool()

proto external void BaseAnimPhysComponent.SetVariableBool	(	TAnimGraphVariable	varIdx,
		bool	value
	)

SetVariableFloat()

proto external void BaseAnimPhysComponent.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 BaseAnimPhysComponent.SetVariableInt	(	TAnimGraphVariable	varIdx,
		int	value
	)

---

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

• Game/generated/Base/BaseAnimPhysComponent.c