ScriptObjectFx Class Reference

Fx script class must inherit from this class. More...

Public Member Functions
void	OnTick ()
	Required.
void	OnRemoved ()
	called when actor is removed (Internally or through scripting). IsStale will return true immediately after this.
void	OnCollisionStart ()
	Collision Movement Check is starting.
void	OnCollisionFinish ()
	Collision Movement Check has ended.
void	OnCollide (kCModel @pCModel)
	Called just before any of the OnImpact functions (except water).
void	OnCollidePost ()
	Called right after OnCollide and the OnImpact functions (except water).
bool	OnImpactWall (int impactType, const kVec3 &in normal)
bool	OnImpactFloor (int impactType, const kVec3 &in normal)
bool	OnImpactCeiling (int impactType, const kVec3 &in normal)
bool	OnImpactObject (int impactType, int impactDmgType, kActor@ actor, const kVec3 &in normal)
void	OnImpactWater ()
	Called OnTick after Fx Movement update.
void	OnExpire ()
	Called OnTick.

Detailed Description

Fx script class must inherit from this class.

class TurokFx : ScriptObjectFx
{
    kFx @self;
    TurokFx(kFx @fx)
    {
        @self = fx;
    }
}

Definition at line 1022 of file t1_scriptAPI.cpp.

Member Function Documentation

OnCollide()

void ScriptObjectFx::OnCollide

(

kCModel @

pCModel

)

Called just before any of the OnImpact functions (except water).

OnCollidePost()

void ScriptObjectFx::OnCollidePost

(

)

Called right after OnCollide and the OnImpact functions (except water).

OnCollisionFinish()

void ScriptObjectFx::OnCollisionFinish

(

)

Collision Movement Check has ended.

OnCollisionStart()

void ScriptObjectFx::OnCollisionStart

(

)

Collision Movement Check is starting.

OnExpire()

void ScriptObjectFx::OnExpire

(

)

Called OnTick.

OnImpactCeiling()

bool ScriptObjectFx::OnImpactCeiling	(	int	impactType,
		const kVec3 &in	normal )

OnImpactFloor()

bool ScriptObjectFx::OnImpactFloor	(	int	impactType,
		const kVec3 &in	normal )

OnImpactObject()

bool ScriptObjectFx::OnImpactObject	(	int	impactType,
		int	impactDmgType,
		kActor@	actor,
		const kVec3 &in	normal )

OnImpactWall()

bool ScriptObjectFx::OnImpactWall	(	int	impactType,
		const kVec3 &in	normal )

OnImpactWater()

void ScriptObjectFx::OnImpactWater

(

)

Called OnTick after Fx Movement update.

OnRemoved()

void ScriptObjectFx::OnRemoved

(

)

called when actor is removed (Internally or through scripting). IsStale will return true immediately after this.

OnTick()

void ScriptObjectFx::OnTick

(

)

Required.