ObjectTyped Class Reference

Private Member Functions
proto native void	DisableSimulation (bool disable)
proto native bool	GetIsSimulationDisabled ()
	Returns whether simulation is disabled.
proto native int	GetSimulationTimeStamp ()
	Returns simulation timestamp.
proto native float	GetAnimationPhase (string animation)
	Return animation phase of animation on object.
proto native void	SetAnimationPhase (string animation, float phase)
	Process animation on object. Animation is defined in config file. Wanted animation phase is set to phase.
proto int	GetNumUserAnimationSourceNames ()
proto string	GetUserAnimationSourceName (int index)
void	SetAnimationPhaseNow (string animation, float phase)
	Same as SetAnimationPhase, only ignores any animation and sets the phase immediately.
proto native void	ResetAnimationPhase (string animation, float phase)
void	OnAnimationPhaseStarted (string animSource, float phase)
	callback called from C++ when AnimationPhase has started
proto native int	GetBoneIndex (string proxySelectionName)
	Returns skeleton's bone index of named proxy selection.
proto native Object	GetBoneObject (int boneIndex)
	Returns proxy object that corresponds given bone inside skeleton.
proto native void	SetInvisible (bool invisible)
	Turns on/off invisibility.
void	OnInvisibleSet (bool invisible)
	event
proto void	MoveInTime (vector targetTransform[4], float deltaT)
	On server, entity's transformation is directly changed to targetTransform, on client entity's transformation is interpolated to targetTransform in time deltaT.
void	OnCreatePhysics ()
	callback called when entity is moved to world and creating its physics representation
bool	OnNetworkTransformUpdate (out vector pos, out vector ypr)
	Client event on transformation update from network.

Member Function Documentation

DisableSimulation()

proto native void DisableSimulation ( bool  disable )

private

GetAnimationPhase()

proto native float GetAnimationPhase ( string  animation )

private

Return animation phase of animation on object.

GetBoneIndex()

proto native int GetBoneIndex ( string  proxySelectionName )

private

Returns skeleton's bone index of named proxy selection.

GetBoneObject()

proto native Object GetBoneObject ( int  boneIndex )

private

Returns proxy object that corresponds given bone inside skeleton.

GetIsSimulationDisabled()

proto native bool GetIsSimulationDisabled ( )

private

Returns whether simulation is disabled.

GetNumUserAnimationSourceNames()

proto int GetNumUserAnimationSourceNames ( )

private

GetSimulationTimeStamp()

proto native int GetSimulationTimeStamp ( )

private

Returns simulation timestamp.

GetUserAnimationSourceName()

proto string GetUserAnimationSourceName ( int  index )

private

MoveInTime()

proto void MoveInTime ( vector  targetTransform[4], float  deltaT  )

private

On server, entity's transformation is directly changed to targetTransform, on client entity's transformation is interpolated to targetTransform in time deltaT.

Parameters

targetTransform
deltaT,interpolation	time between current transformation and target transformation

Note

it's not recommended to call this on client as it can break interpolation process if called on server previously

OnAnimationPhaseStarted()

void OnAnimationPhaseStarted ( string  animSource, float  phase  )

private

callback called from C++ when AnimationPhase has started

OnCreatePhysics()

void OnCreatePhysics ( )

private

callback called when entity is moved to world and creating its physics representation

OnInvisibleSet()

void OnInvisibleSet ( bool  invisible )

private

event

OnNetworkTransformUpdate()

bool OnNetworkTransformUpdate ( out vector  pos, out vector  ypr  )

private

Client event on transformation update from network.

Parameters

pos,world	space position
ypr,world	space orientation in radians in form of Yaw/Pitch/Roll

Returns

true if visual cut (won't do any interpolation) should be done after calling this callback

ResetAnimationPhase()

proto native void ResetAnimationPhase ( string  animation, float  phase  )

private

SetAnimationPhase()

proto native void SetAnimationPhase ( string  animation, float  phase  )

private

Process animation on object. Animation is defined in config file. Wanted animation phase is set to phase.

SetAnimationPhaseNow()

void SetAnimationPhaseNow ( string  animation, float  phase  )

inlineprivate

Same as SetAnimationPhase, only ignores any animation and sets the phase immediately.

SetInvisible()

proto native void SetInvisible ( bool  invisible )

private

Turns on/off invisibility.

---

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

• P:/scripts/3_Game/Entities/Entity.c