Trigger

Trigger

new Trigger(name, options, concept)

Description:
  • Create a new trigger

Source:
Parameters:
Name Type Description
name string

The name of this trigger

options object | string

The options of this trigger

concept Concept

The owning concept of this trigger

Methods

destroy(concept)

Description:
  • Destroy this trigger

Source:
Parameters:
Name Type Description
concept Concept

The concept this trigger is registered on

disable()

Description:
  • Disable this trigger

Source:

enable()

Description:
  • Enable this trigger

Source:

(static) getTrigger(type, name, options) → {Trigger}

Description:
  • Create a new named instance of the given trigger type, using the given options

Source:
Parameters:
Name Type Description
type string

The type of trigger to create

name string

The name to give the trigger

options object

The options to pass along to the trigger

Returns:
  • The newly created trigger
Type
Trigger

(static) isTriggerType(type) → {boolean}

Description:
  • Checks if the given type corresponds to a trigger type

Source:
Parameters:
Name Type Description
type tring

the type to check

Returns:

true/false depending on if type was a trigger type

Type
boolean

(static) registerTrigger(type, trigger)

Description:
  • Register a new type of trigger

Source:
Parameters:
Name Type Description
type string

The type of trigger to register

trigger Trigger

The trigger to register