Weapon script classes must inherit from this class. More...

Inheritance diagram for ScriptObjectWeapon:

Public Member Functions
void	OnBeginFire ()
	Required.

void	OnFire ()
	Required.

void	OnEndFire ()
	Required.

void	OnLower ()
	Required.

void	OnRaise ()
	Required.

void	OnHoldster ()
	Required.

Public Member Functions inherited from ScriptObject
void	OnSpawn ()
	Required.

void	OnTick ()
	Required.

void	OnBeginLevel ()

void	OnRestore ()

void	OnPostBeginLevel ()

void	OnSleep ()

void	OnWake ()

void	OnTouch (kActor @theActorThatTouchedMe)
	called even if alseep

void	OnCollide (kCModel@)
	called even if alseep

void	OnCollisionStart ()
	Collision Movement Check is starting.

void	OnCollisionFinish ()
	Collision Movement Check has ended.

void	OnMenuTick ()
	called only when dummymenu active

void	OnRemoved ()
	called when actor is removed (Internally or through scripting). IsStale will return true immediately after this, RenderModel will be null, and the scriptobject will be destroyed.

void	OnActivate ()

void	OnDeactivate ()
	Never used.

void	OnPreDamage (kActor @instigator, kDictMem @damageDef, const int damage)
	always called when damaged even after death. Call OverrideOnDamageValue on the actor if you need to override the damage value to prevent death.

void	OnDeath (kActor @killer, kDictMem @damageDef)
	called only when actor dies

void	OnDamage (kActor @instigator, kDictMem @damageDef, const int damage)
	always called even after death

void	OnEndLevel ()

void	OnPreTick ()
	For the player script only! Called right before all other actors are ticked.

void	OnPostTick ()
	For the player script only! Called right after level script ticks.

Detailed Description

Weapon script classes must inherit from this class.

class TurokWeapon : ScriptObjectWeapon
{
    kWeapon @self;
    TurokWeapon(kWeapon @actor)
    {
        @self = actor;
    }
}

Definition at line 973 of file t1_scriptAPI.cpp.

Member Function Documentation

void ScriptObjectWeapon::OnBeginFire ( )

Required.

void ScriptObjectWeapon::OnEndFire ( )

Required.

void ScriptObjectWeapon::OnFire ( )

Required.

void ScriptObjectWeapon::OnHoldster ( )

Required.

void ScriptObjectWeapon::OnLower ( )

Required.

void ScriptObjectWeapon::OnRaise ( )

Required.