Class: StatusEffectsReceiver

StatusEffectsReceiver()

new StatusEffectsReceiver()

Source:

Methods

AddStatus(statusCode, data, attacker, attackerOwner)

Adds a status effect to the entity.
Parameters:
Name Type Description
statusCode string The code of the status effect.
data Object The various effects and timings.
attacker number optional, the entity ID of the attacker.
attackerOwner number optional, the player ID of the attacker.
Source:

ApplyStatus(effectData, attacker, attackerOwner, bonusMultiplier) → {Object}

Called by Attacking effects. Adds status effects for each entry in the effectData.
Parameters:
Name Type Description
effectData Object An object containing the status effects to give to the entity.
attacker number The entity ID of the attacker.
attackerOwner number The player ID of the attacker.
bonusMultiplier number A value to multiply the damage with (not implemented yet for SE).
Source:
Returns:
- The codes of the status effects which were processed.
Type
Object

ExecuteEffect(statusCode, lateness)

Called by the timers. Executes a status effect.
Parameters:
Name Type Description
statusCode string The status effect to be executed.
lateness number The delay between the calling of the function and the actual execution (turn time?).
Source:

GetActiveStatuses() → {Object}

Which status effects are active on this entity.
Source:
Returns:
- An object containing the status effects which currently affect the entity.
Type
Object

Init()

Initialises the status effects.
Source:

RemoveStatus(statusCode)

Removes a status effect from the entity.
Parameters:
Name Type Description
statusCode string The status effect to be removed.
Source: