Package com.planet_ink.coffee_mud.Common.interfaces

Interface Triggerer

All Superinterfaces:

java.lang.Cloneable, CMCommon, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

DefaultTriggerer, NonTriggerer

public interface Triggerer
extends CMCommon

A Triggerer is a manager for one or more series of actions which, when done properly, results in a completed trigger, which can then, well, trigger something.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Triggerer.TriggerCode	The definition of the key words in the definitions.
static class	Triggerer.TrigSignal	In order to have a Triggerer signaled that the rituals may need refreshing, this method exists to be called globally.

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Method Summary

Modifier and Type	Method	Description
void	addTrigger(java.lang.Object key, java.lang.String encodedTrigger, java.util.Map<java.lang.String,java.util.List<Social>> socials, java.util.List<java.lang.String> errors)	Parses and adds a new series of steps, which together form a complete trigger.
void	addTriggerAssist(MOB assistingM, java.lang.Object key)	If a trigger allows otherwise non-qualifying participants, this will allow it to add other participants to the message listener for their main triggerer and key, using the INCLUDE trigger directive.
void	deleteTracking(MOB mob, java.lang.Object key)	If the given trigger key is in progress by the given mob, this cancels it entirely.
CMMsg	genNextAbleTrigger(MOB hostM, MOB mob, java.lang.Object key, boolean force)	Generates a message for the next step in the tracked trigger denoted by the given trigger key.
Triad<MOB,java.lang.Object,java.util.List<java.lang.String>>	getCompleted(MOB hostM, java.lang.Object[] keys, CMMsg msg)	Given a set of trigger keys that may be progressed or completed by the given message, this will progress them, and then return the first one which , because of the message, is now in a completed state, along with any args accumulated.
java.lang.Object[]	getInProgress(MOB mob)	Returns the trigger keys for any triggers that the given mob currently has in progress.
java.util.Map<java.lang.String,java.util.List<Social>>	getSocialSets()	Returns the internal socials applicable to this trigger.
java.lang.String	getTriggerDesc(java.lang.Object key)	Returns a description of the trigger steps of the given trigger key
boolean	hasTrigger(java.lang.Object key)	Returns whether a trigger with the given key is being tracked here.
boolean	isCompleted(java.lang.Object key, CMMsg msg)	Given a trigger key, and a message which may be progressed completed by the given message, this will progress it, and then return true if it was completed.
boolean	isDisabled()	If this triggering engine is disabled, this will return true
boolean	isObsolete()	If something has changed that requires a triggerer or tracker to be reset, then every instance is notified, and this method can be called to see if this specific object needs resetting.
boolean	isTracking(MOB mob, java.lang.Object key)	Returns whether the given trigger key is in progress by the given mob
boolean	isTracking(java.lang.Object key, CMMsg msg)	Given a message and a trigger key, this will see if the message might begin, progress, or complete the given trigger steps.
void	setIgnoreTracking(MOB mob, boolean truefalse)	Sets the given mob as being ignored for the purpose of tracking, or re-enables tracking.
Triggerer	setName(java.lang.String name)	Some triggers benefit from unique names, and in those cases, this allows that name to be set for proper matching.
void	setObsolete()	If this triggering engine needs disabling due to changes in local abilities, this method can be called.
boolean	wasCompletedRecently(MOB mob, java.lang.Object key)	Returns whether the given mob recently completed the trigger with the given key, typically within 4 seconds.
java.lang.Object[]	whichCompleted(java.lang.Object[] keys, CMMsg msg)	Given a set of trigger keys that may be progressed or completed by the given message, this will progress them, and then return the set of keys which, because of the message, are now in a completed state.
java.lang.Object[]	whichTracking(CMMsg msg)	Given a message, this will check all triggers to see if the message might begin, progress, or complete one of the triggers.
MOB[]	whosDoneWaiting()	If any triggers are currently in a wait state, this will return which ones, as of the moment this method was called, are now done waiting.

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

setName

Triggerer setName(java.lang.String name)

Some triggers benefit from unique names, and in those cases, this allows that name to be set for proper matching.

Parameters:

name - the Name

Returns:

this is this

addTrigger

void addTrigger(java.lang.Object key,
                java.lang.String encodedTrigger,
                java.util.Map<java.lang.String,java.util.List<Social>> socials,
                java.util.List<java.lang.String> errors)

Parses and adds a new series of steps, which together form a complete trigger. The key is an arbitrary object that is sent back to the caller when a trigger occurs, and so should be unique to each series of steps

Parameters:

key - the arbitrary but unique key object

encodedTrigger - the encoded trigger steps

socials - null, or list of custom socials that might apply to this trigger

errors - null, or a list to put errors into

hasTrigger

boolean hasTrigger(java.lang.Object key)

Returns whether a trigger with the given key is being tracked here.

Parameters:

key - the trigger key

Returns:

true if it was found, false otherwise

getTriggerDesc

java.lang.String getTriggerDesc(java.lang.Object key)

Returns a description of the trigger steps of the given trigger key

Parameters:

key - the arbitrary but unique key object

Returns:

a readable description

genNextAbleTrigger

CMMsg genNextAbleTrigger(MOB hostM,
                         MOB mob,
                         java.lang.Object key,
                         boolean force)

Generates a message for the next step in the tracked trigger denoted by the given trigger key.

Parameters:

hostM - TODO

mob - the mob to check

key - the arbitrary but unique key object

force - true to force even an unstarted trigger

Returns:

null, or a message for the given mob to do

setIgnoreTracking

void setIgnoreTracking(MOB mob,
                       boolean truefalse)

Sets the given mob as being ignored for the purpose of tracking, or re-enables tracking.

Parameters:

mob - the mob to check

truefalse - true to turn on ignoring, false otherwise

deleteTracking

void deleteTracking(MOB mob,
                    java.lang.Object key)

If the given trigger key is in progress by the given mob, this cancels it entirely.

Parameters:

mob - the mob to check

key - the arbitrary but unique key object

isTracking

boolean isTracking(MOB mob,
                   java.lang.Object key)

Returns whether the given trigger key is in progress by the given mob

Parameters:

mob - the mob to check

key - the arbitrary but unique key object

Returns:

true if tracking is happening, false otherwise

addTriggerAssist

void addTriggerAssist(MOB assistingM,
                      java.lang.Object key)

If a trigger allows otherwise non-qualifying participants, this will allow it to add other participants to the message listener for their main triggerer and key, using the INCLUDE trigger directive.

Parameters:

assistingM - the mob being assisted, the main triggerer mob

key - the key to the trigger

isTracking

boolean isTracking(java.lang.Object key,
                   CMMsg msg)

Given a message and a trigger key, this will see if the message might begin, progress, or complete the given trigger steps. If it might (just might) do that, it will return true, or false otherwise.

Parameters:

key - the arbitrary but unique key object

msg - the message that might be relevant.

Returns:

true if it is relevant, false otherwise

See Also:

isCompleted(Object, CMMsg), whichTracking(CMMsg), whichCompleted(Object[], CMMsg)

whichTracking

java.lang.Object[] whichTracking(CMMsg msg)

Given a message, this will check all triggers to see if the message might begin, progress, or complete one of the triggers. If it might (just might) do any of those, this will return the trigger keys that should be checked further by calling whichCompleted.

Parameters:

msg - the message that might be relevant

Returns:

the unique keys being tracked related to the msg

See Also:

isCompleted(Object, CMMsg), isTracking(Object, CMMsg), whichCompleted(Object[], CMMsg)

isCompleted

boolean isCompleted(java.lang.Object key,
                    CMMsg msg)

Given a trigger key, and a message which may be progressed completed by the given message, this will progress it, and then return true if it was completed.

Parameters:

key - the arbitrary but unique key object

msg - the message which may cause a trigger to complete

Returns:

true if it is completed, false otherwise

See Also:

whichTracking(CMMsg), isTracking(Object, CMMsg), whichCompleted(Object[], CMMsg)

whichCompleted

java.lang.Object[] whichCompleted(java.lang.Object[] keys,
                                  CMMsg msg)

Given a set of trigger keys that may be progressed or completed by the given message, this will progress them, and then return the set of keys which, because of the message, are now in a completed state.

Parameters:

keys - the arbitrary but unique keys to apply the message to

msg - the message which may cause triggers to complete

Returns:

the keys for completed triggers

See Also:

isCompleted(Object, CMMsg), whichTracking(CMMsg), isTracking(Object, CMMsg)

getCompleted

Triad<MOB,java.lang.Object,java.util.List<java.lang.String>> getCompleted(MOB hostM,
                                                                          java.lang.Object[] keys,
                                                                          CMMsg msg)

Given a set of trigger keys that may be progressed or completed by the given message, this will progress them, and then return the first one which , because of the message, is now in a completed state, along with any args accumulated.

Parameters:

hostM - normally the msg.source(), but who is the trigger host

keys - the arbitrary but unique keys to apply the message to

msg - the message which may cause triggers to complete

Returns:

null, or the key and arguments pair

See Also:

isCompleted(Object, CMMsg), whichTracking(CMMsg), isTracking(Object, CMMsg)

whosDoneWaiting

MOB[] whosDoneWaiting()

If any triggers are currently in a wait state, this will return which ones, as of the moment this method was called, are now done waiting. Calling this will reset those wait times. It returns the set of players who have triggers in wait state. The caller should 'ping' those players with a message that called one of the completed methods here.

Returns:

the set of players whose triggers need pinging

getSocialSets

java.util.Map<java.lang.String,java.util.List<Social>> getSocialSets()

Returns the internal socials applicable to this trigger.

Returns:

Map of social names and their variations applicable here

getInProgress

java.lang.Object[] getInProgress(MOB mob)

Returns the trigger keys for any triggers that the given mob currently has in progress.

Parameters:

mob - the mob who started something

Returns:

all of the trigger keys in progress

wasCompletedRecently

boolean wasCompletedRecently(MOB mob,
                             java.lang.Object key)

Returns whether the given mob recently completed the trigger with the given key, typically within 4 seconds.

Parameters:

mob - the mob to check

key - the object key to check

Returns:

true if completed recently, false

isObsolete

boolean isObsolete()

If something has changed that requires a triggerer or tracker to be reset, then every instance is notified, and this method can be called to see if this specific object needs resetting.

Returns:

true if this instance is obsolete, false otherwise

See Also:

setObsolete()

setObsolete

void setObsolete()

If this triggering engine needs disabling due to changes in local abilities, this method can be called.

See Also:

isObsolete()

isDisabled

boolean isDisabled()

If this triggering engine is disabled, this will return true

Returns:

true if this instance is disabled