io.github.wysohn.triggerreactor.core.manager.trigger

Class Trigger

java.lang.Object

io.github.wysohn.triggerreactor.core.manager.trigger.Trigger

All Implemented Interfaces:

IObservable, Cloneable

Direct Known Subclasses:

AbstractLocationBasedTriggerManager.ClickTrigger, AbstractLocationBasedTriggerManager.WalkTrigger, AreaTrigger, AreaTrigger.EnterTrigger, AreaTrigger.ExitTrigger, CommandTrigger, CustomTrigger, InventoryTrigger, NamedTrigger, RepeatingTrigger

public abstract class Trigger
extends Object
implements Cloneable, IObservable

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<UUID,Long>	cooldowns
protected Map<String,Executor>	executorMap
protected Map<Object,Object>	gvarMap
protected TriggerInfo	info
protected IObserver	observer
protected Map<String,Placeholder>	placeholderMap
protected Node	root
protected String	script

Constructor Summary

Constructors

Constructor and Description
Trigger(TriggerInfo info, String script) This constructor does not initialize the fields.

Method Summary

Modifier and Type	Method and Description
boolean	activate(Object e, Map<String,Object> scriptVars) Start this trigger.
protected boolean	checkCooldown(Object e)
abstract Trigger	clone()
TriggerInfo	getInfo()
String	getScript() get the actual plain code of this trigger.
protected String	getTimingId() Get unique id to be used as fully qualified name for the Timings System.
void	init()
protected Interpreter	initInterpreter(Map<String,Object> scriptVars) Create interpreter with appropriate options and variables.
boolean	isSync() Check if this Trigger is sync mode.
void	notifyObservers()
void	setScript(String script)
void	setSync(boolean sync) Set this Trigger's sync mode.
protected void	start(Object e, Map<String,Object> scriptVars, Interpreter interpreter, boolean sync) The actual execution part.
protected void	start(Timings.Timing timing, Object e, Map<String,Object> scriptVars, Interpreter interpreter, boolean sync) The actual execution part.
protected void	startInterpretation(Object e, Map<String,Object> scriptVars, Interpreter interpreter, boolean sync) Start interpreting the code.
String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

cooldowns

protected final Map<UUID,Long> cooldowns

info

protected final TriggerInfo info

observer

protected IObserver observer

script

protected String script

root

protected Node root

executorMap

protected Map<String,Executor> executorMap

placeholderMap

protected Map<String,Placeholder> placeholderMap

gvarMap

protected Map<Object,Object> gvarMap

Constructor Detail

Trigger

public Trigger(TriggerInfo info,
               String script)

This constructor does not initialize the fields. It is essential to call init() method in order to make the Trigger work properly. If you want to create a Trigger with customized behavior, it's not necessary to call init() but need to override initInterpreter(Map), startInterpretation(Object, Map, Interpreter, boolean), or activate(Object, Map) method as your need

Method Detail

notifyObservers

public void notifyObservers()

Specified by:

notifyObservers in interface IObservable

getInfo

public TriggerInfo getInfo()

getTimingId

protected String getTimingId()

Get unique id to be used as fully qualified name for the Timings System. Override to alter the id.

Returns:

the id.

init

public void init()
          throws AbstractTriggerManager.TriggerInitFailedException

Throws:

IOException - low level exception from Lexer

LexerException - throws if lexical analysis failed

ParserException - throws if parsing failed

AbstractTriggerManager.TriggerInitFailedException

getScript

public String getScript()

get the actual plain code of this trigger.

Returns:

setScript

public void setScript(String script)
               throws AbstractTriggerManager.TriggerInitFailedException

Throws:

AbstractTriggerManager.TriggerInitFailedException

isSync

public boolean isSync()

Check if this Trigger is sync mode.

Returns:

setSync

public void setSync(boolean sync)

Set this Trigger's sync mode.

Parameters:

sync -

activate

public boolean activate(Object e,
                        Map<String,Object> scriptVars)

Start this trigger. Variables in scriptVars may be overridden if it has same name as the name of fields of Event class.

Parameters:

e - the Event associated with this Trigger

scriptVars - the temporary local variables

Returns:

true if activated; false if on cooldown

checkCooldown

protected boolean checkCooldown(Object e)

Parameters:

e -

Returns:

true if cooldown; false if not cooldown or 'e' is not a compatible type

initInterpreter

protected Interpreter initInterpreter(Map<String,Object> scriptVars)

Create interpreter with appropriate options and variables.

Parameters:

scriptVars -

Returns:

startInterpretation

protected void startInterpretation(Object e,
                                   Map<String,Object> scriptVars,
                                   Interpreter interpreter,
                                   boolean sync)

Start interpreting the code.

Parameters:

e - The Event associated with this Trigger

scriptVars - temporary variables

interpreter - The Interpreter

sync - set it true will make this method run in the thread that has called this method. This is useful when this trigger has to cancel an Event; set it to false will let it run in separate thread. This is more efficient if you only need to read data from Event and never interact with it.

start

protected void start(Timings.Timing timing,
                     Object e,
                     Map<String,Object> scriptVars,
                     Interpreter interpreter,
                     boolean sync)

The actual execution part. The Trigger can be sync/async depends on which thread invokes this method.

Parameters:

e -

scriptVars -

interpreter -

sync -

timing -

start

protected void start(Object e,
                     Map<String,Object> scriptVars,
                     Interpreter interpreter,
                     boolean sync)

The actual execution part. The Trigger can be sync/async depends on which thread invokes this method.

Parameters:

e -

scriptVars -

interpreter -

sync -

clone

public abstract Trigger clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object