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

Consumable Inventory Item base type that is thrown by the character causing an explosion with a damaging effect. More...

Public Member Functions

void SetDamageAtCenter (Context instigator, int damage)
 Set the damage at the center (usually max damage) of this bomb's explosion.
 
void SetDamageAtEdge (Context instigator, int damage)
 Set the damage at the edge (usually least damage) of this bomb's explosion.
 
void SetCenterRadius (Context instigator, float radius)
 Set how large the center radius of the explosion.
 
void SetTotalBlastRadius (Context instigator, float radius)
 Set the total radius of the explosion.
 
void SetCenterBlastForce (Context instigator, float force)
 Set the force applied to objects that are within the center radius of the explosion (usually most force).
 
void SetEdgeBlastForce (Context instigator, float force)
 Set the force applied to objects at the edge of the explosion's total radius (usually least force).
 
int GetDamageAtCenter ()
 Get the current Damage At Center setting.
 
int GetDamageAtEdge ()
 Get the current Damage At Edge setting.
 
float GetCenterRadius ()
 Get the current Center Radius setting.
 
float GetTotalBlastRadius ()
 Get the current Total Blast Radius setting.
 
float GetCenterBlastForce ()
 Get the current Center Blast Force setting.
 
float GetEdgeBlastForce ()
 Get the current Edge Blast Force setting.
 

Detailed Description

Consumable Inventory Item base type that is thrown by the character causing an explosion with a damaging effect.

Member Function Documentation

◆ GetCenterBlastForce()

float GetCenterBlastForce ( )

Get the current Center Blast Force setting.

Returns
Center blast force magnitude

◆ GetCenterRadius()

float GetCenterRadius ( )

Get the current Center Radius setting.

Returns
Center radius

◆ GetDamageAtCenter()

int GetDamageAtCenter ( )

Get the current Damage At Center setting.

Returns
Damage at center

◆ GetDamageAtEdge()

int GetDamageAtEdge ( )

Get the current Damage At Edge setting.

Returns
Damage at edge

◆ GetEdgeBlastForce()

float GetEdgeBlastForce ( )

Get the current Edge Blast Force setting.

Returns
Edge blast force magnitude

◆ GetTotalBlastRadius()

float GetTotalBlastRadius ( )

Get the current Total Blast Radius setting.

Returns
Total blast radius

◆ SetCenterBlastForce()

void SetCenterBlastForce ( Context instigator,
float force )

Set the force applied to objects that are within the center radius of the explosion (usually most force).

Parameters
instigatorThe source context triggering this change
forceForce magnitude

◆ SetCenterRadius()

void SetCenterRadius ( Context instigator,
float radius )

Set how large the center radius of the explosion.

Parameters
instigatorThe source context triggering this change
radiusCenter radius

◆ SetDamageAtCenter()

void SetDamageAtCenter ( Context instigator,
int damage )

Set the damage at the center (usually max damage) of this bomb's explosion.

Parameters
instigatorThe source context triggering this change
damageDamage amount

◆ SetDamageAtEdge()

void SetDamageAtEdge ( Context instigator,
int damage )

Set the damage at the edge (usually least damage) of this bomb's explosion.

Parameters
instigatorThe source context triggering this change
damageDamage amount

◆ SetEdgeBlastForce()

void SetEdgeBlastForce ( Context instigator,
float force )

Set the force applied to objects at the edge of the explosion's total radius (usually least force).

Parameters
instigatorThe source context triggering this change
forceForce magnitude

◆ SetTotalBlastRadius()

void SetTotalBlastRadius ( Context instigator,
float radius )

Set the total radius of the explosion.

Parameters
instigatorThe source context triggering this change
radiusTotal radius