Endstar LUA API Documentation
Loading...
Searching...
No Matches
SpikeTrap Class Reference

Base type that senses overlaps to apply damage to. More...

Public Member Functions

void Activate (Context instigator)
 Enables automatic spike trap behavior.
 
void Deactivate (Context instigator)
 Disables automatic spike trap behavior.
 
bool GetActive ()
 Check to see if automatic spike trap is active.
 
void SetSpikeDamage (Context instigator, int damage)
 Set the amount of damage this spike trap deals.
 
void Trigger (Context instigator)
 Trigger spike trap manually.
 

Detailed Description

Base type that senses overlaps to apply damage to.

Member Function Documentation

◆ Activate()

void Activate ( Context instigator)

Enables automatic spike trap behavior.

Parameters
instigatorThe source context triggering this change

◆ Deactivate()

void Deactivate ( Context instigator)

Disables automatic spike trap behavior.

Parameters
instigatorThe source context triggering this change

◆ GetActive()

bool GetActive ( )

Check to see if automatic spike trap is active.

Returns
True if active

◆ SetSpikeDamage()

void SetSpikeDamage ( Context instigator,
int damage )

Set the amount of damage this spike trap deals.

Parameters
instigatorThe source context triggering this change
damageDamage amount

◆ Trigger()

void Trigger ( Context instigator)

Trigger spike trap manually.

Parameters
instigatorThe source context triggering this change