Effect()

See the Effect guide for usage.

new Effect()
Effect.js, line 35

Listens to Events:
Properties:
Name Type Description
config object

Effect configuration (name/desc/duration/etc.)

Properties
Name Type Description
autoActivate boolean

If this effect immediately activates itself when added to the target
hidden boolean

If this effect is shown in the character's effect list
refreshes boolean

If an effect with the same type is applied it will trigger an effectRefresh event instead of applying the additional effect.
unique boolean

If multiple effects with the same config.type can be applied at once
maxStacks number

When adding an effect of the same type it adds a stack to the current effect up to maxStacks instead of adding the effect. Implies config.unique
persists boolean

If false the effect will not save to the player
type string

The effect category, mainly used when disallowing stacking
tickInterval boolean | number

Number of seconds between calls to the updateTick listener
description string
duration number

Total duration of effect in milliseconds
elapsed number

Get elapsed time in milliseconds
id string

filename minus .js
modifiers EffectModifiers

Attribute modifier functions
name string
remaining number

Number of seconds remaining
startedAt number

Date.now() time this effect became active
state object

Configuration of this type of effect (magnitude, element, stat, etc.)
target Character

Character this effect is... effecting

Extends

  • EventEmitter

Members

description :string
Effect.js, line 92

duration :number
Effect.js, line 99

elapsed :number
Effect.js, line 111

Elapsed time in milliseconds since event was activated

name :string
Effect.js, line 85

remaining :number
Effect.js, line 123

Remaining time in seconds

Methods

activate()
Effect.js, line 139

Set this effect active

Fires:

deactivate()
Effect.js, line 160

Set this effect active

Fires:

hydrate(state, data)
Effect.js, line 264

Reinitialize from persisted data

Parameters:
Name Type Description
state GameState
data Object

isCurrent() → {boolean}
Effect.js, line 131

Whether this effect has lapsed

Returns:
boolean

modifyAttribute(attrName, currentValue) → {number}
Effect.js, line 203

Parameters:
Name Type Description
attrName string
currentValue number
Returns:
number -

attribute modified by effect

modifyIncomingDamage(damage, currentAmount) → {Damage}
Effect.js, line 220

Parameters:
Name Type Description
damage Damage
currentAmount number
Returns:
Damage

modifyOutgoingDamage(damage, currentAmount) → {Damage}
Effect.js, line 230

Parameters:
Name Type Description
damage Damage
currentAmount number
Returns:
Damage

pause()
Effect.js, line 186

Stop this effect from having any effect temporarily

remove()
Effect.js, line 176

Remove this effect from its target

Fires:

resume()
Effect.js, line 193

Resume a paused effect

serialize() → {Object}
Effect.js, line 239

Gather data to persist

Returns:
Object

Events

effectActivated
Effect.js, line 149

effectAdded
EffectList.js, line 128

Listeners of This Event:

effectDeactivated
Effect.js, line 165

effectRefreshed
EffectList.js, line 111

Parameters:
Name Type Description
effect Effect

The new effect that is trying to be added

effectStackAdded
EffectList.js, line 102

Parameters:
Name Type Description
effect Effect

The new effect that is trying to be added

remove
Effect.js, line 177