Package com.planet_ink.coffee_mud.Common

Class DefaultTriggerer

java.lang.Object

com.planet_ink.coffee_mud.Common.DefaultTriggerer

All Implemented Interfaces:

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

public class DefaultTriggerer
extends java.lang.Object
implements Triggerer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	DefaultTriggerer.Trigger
protected class	DefaultTriggerer.TrigState
protected class	DefaultTriggerer.TrigTracker

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Common.interfaces.Triggerer

Triggerer.TriggerCode, Triggerer.TrigSignal

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<java.lang.Object,MOB>	assisting
protected java.lang.String	holyName
protected java.util.Set<java.lang.String>	ignoreOf
protected static java.util.Map<java.lang.String,DefaultTriggerer.Trigger[]>	ritualCache
protected java.util.Map<java.lang.Object,DefaultTriggerer.Trigger[]>	rituals
protected java.util.Map<java.lang.String,java.util.List<Social>>	socialsMap
protected java.util.Map<java.lang.String,DefaultTriggerer.TrigTracker>	trackers
protected int	version
protected java.util.List<DefaultTriggerer.TrigState>	waitingFor

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

idConverter

Constructor Summary

Constructors

Constructor	Description
DefaultTriggerer()

Method Summary

Modifier and Type	Method	Description
void	addTrigger(java.lang.Object key, java.lang.String trigger, 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.
protected void	clearState(MOB mob, java.lang.Object type)
int	compareTo(CMObject o)
boolean	containsString(java.lang.String toSrchStr, java.lang.String srchForStr)
CMObject	copyOf()	Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
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.
protected int	getCMMsgCode(Triggerer.TriggerCode trig)
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.
protected DefaultTriggerer.TrigState	getCreateTrigState(MOB mob, java.lang.Object key)
protected DefaultTriggerer.TrigTracker	getCreateTrigTracker(MOB mob)
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
protected DefaultTriggerer.TrigState	getTrigState(MOB mob, java.lang.Object key)
protected DefaultTriggerer.TrigTracker	getTrigTracker(MOB mob)
boolean	hasTrigger(java.lang.Object key)	Returns whether a trigger with the given key is being tracked here.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
void	initializeClass()	Called ONCE after all objects are loaded, but before the map is read in during initialization.
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
protected boolean	isIgnoring(MOB mob)
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.
protected java.lang.String	L(java.lang.String str, java.lang.String... xs)
java.lang.String	name()	The displayable name of this object.
CMObject	newInstance()	Returns a new instance of this class.
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.
protected DefaultTriggerer.TrigState	stepGetCompleted(MOB hostM, java.lang.Object key, CMMsg msg)
protected java.lang.String	targName(Environmental target)
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 class java.lang.Object

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

Field Detail

ritualCache

protected static final java.util.Map<java.lang.String,DefaultTriggerer.Trigger[]> ritualCache

trackers

protected java.util.Map<java.lang.String,DefaultTriggerer.TrigTracker> trackers

assisting

protected java.util.Map<java.lang.Object,MOB> assisting

rituals

protected java.util.Map<java.lang.Object,DefaultTriggerer.Trigger[]> rituals

waitingFor

protected java.util.List<DefaultTriggerer.TrigState> waitingFor

ignoreOf

protected java.util.Set<java.lang.String> ignoreOf

holyName

protected java.lang.String holyName

version

protected int version

socialsMap

protected java.util.Map<java.lang.String,java.util.List<Social>> socialsMap

Constructor Detail

DefaultTriggerer

public DefaultTriggerer()

Method Detail

ID

public java.lang.String ID()

Description copied from interface: CMObject

The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Returns:

the name of this class

newInstance

public CMObject newInstance()

Description copied from interface: CMObject

Returns a new instance of this class.

Specified by:

newInstance in interface CMObject

Returns:

a new instance of this class

name

public java.lang.String name()

Description copied from interface: CMObject

The displayable name of this object. May be modified by phyStats() object. Is derived from the Name().

Specified by:

name in interface CMObject

Returns:

the modified final name of this object on the map.

See Also:

Environmental.Name()

setName

public Triggerer setName(java.lang.String name)

Description copied from interface: Triggerer

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

Specified by:

setName in interface Triggerer

Parameters:

name - the Name

Returns:

this is this

isObsolete

public boolean isObsolete()

Description copied from interface: Triggerer

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.

Specified by:

isObsolete in interface Triggerer

Returns:

true if this instance is obsolete, false otherwise

See Also:

Triggerer.setObsolete()

setObsolete

public void setObsolete()

Description copied from interface: Triggerer

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

Specified by:

setObsolete in interface Triggerer

See Also:

Triggerer.isObsolete()

isDisabled

public boolean isDisabled()

Description copied from interface: Triggerer

If this triggering engine is disabled, this will return true

Specified by:

isDisabled in interface Triggerer

Returns:

true if this instance is disabled

isIgnoring

protected boolean isIgnoring(MOB mob)

addTrigger

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

Description copied from interface: Triggerer

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

Specified by:

addTrigger in interface Triggerer

Parameters:

key - the arbitrary but unique key object

trigger - 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

getTrigTracker

protected DefaultTriggerer.TrigTracker getTrigTracker(MOB mob)

getCreateTrigTracker

protected DefaultTriggerer.TrigTracker getCreateTrigTracker(MOB mob)

getCreateTrigState

protected DefaultTriggerer.TrigState getCreateTrigState(MOB mob,
                                                        java.lang.Object key)

getTrigState

protected DefaultTriggerer.TrigState getTrigState(MOB mob,
                                                  java.lang.Object key)

clearState

protected void clearState(MOB mob,
                          java.lang.Object type)

L

protected java.lang.String L(java.lang.String str,
                             java.lang.String... xs)

getTriggerDesc

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

Description copied from interface: Triggerer

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

Specified by:

getTriggerDesc in interface Triggerer

Parameters:

key - the arbitrary but unique key object

Returns:

a readable description

setIgnoreTracking

public void setIgnoreTracking(MOB mob,
                              boolean truefalse)

Description copied from interface: Triggerer

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

Specified by:

setIgnoreTracking in interface Triggerer

Parameters:

mob - the mob to check

truefalse - true to turn on ignoring, false otherwise

deleteTracking

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

Description copied from interface: Triggerer

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

Specified by:

deleteTracking in interface Triggerer

Parameters:

mob - the mob to check

key - the arbitrary but unique key object

genNextAbleTrigger

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

Description copied from interface: Triggerer

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

Specified by:

genNextAbleTrigger in interface Triggerer

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

getCMMsgCode

protected int getCMMsgCode(Triggerer.TriggerCode trig)

isTracking

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

Description copied from interface: Triggerer

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

Specified by:

isTracking in interface Triggerer

Parameters:

mob - the mob to check

key - the arbitrary but unique key object

Returns:

true if tracking is happening, false otherwise

isTracking

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

Description copied from interface: Triggerer

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.

Specified by:

isTracking in interface Triggerer

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:

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

whichTracking

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

Description copied from interface: Triggerer

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.

Specified by:

whichTracking in interface Triggerer

Parameters:

msg - the message that might be relevant

Returns:

the unique keys being tracked related to the msg

See Also:

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

targName

protected java.lang.String targName(Environmental target)

containsString

public boolean containsString(java.lang.String toSrchStr,
                              java.lang.String srchForStr)

stepGetCompleted

protected DefaultTriggerer.TrigState stepGetCompleted(MOB hostM,
                                                      java.lang.Object key,
                                                      CMMsg msg)

isCompleted

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

Description copied from interface: Triggerer

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.

Specified by:

isCompleted in interface Triggerer

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:

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

whichCompleted

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

Description copied from interface: Triggerer

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.

Specified by:

whichCompleted in interface Triggerer

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:

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

getCompleted

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

Description copied from interface: Triggerer

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.

Specified by:

getCompleted in interface Triggerer

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:

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

getInProgress

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

Description copied from interface: Triggerer

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

Specified by:

getInProgress in interface Triggerer

Parameters:

mob - the mob who started something

Returns:

all of the trigger keys in progress

wasCompletedRecently

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

Description copied from interface: Triggerer

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

Specified by:

wasCompletedRecently in interface Triggerer

Parameters:

mob - the mob to check

key - the object key to check

Returns:

true if completed recently, false

whosDoneWaiting

public MOB[] whosDoneWaiting()

Description copied from interface: Triggerer

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.

Specified by:

whosDoneWaiting in interface Triggerer

Returns:

the set of players whose triggers need pinging

hasTrigger

public boolean hasTrigger(java.lang.Object key)

Description copied from interface: Triggerer

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

Specified by:

hasTrigger in interface Triggerer

Parameters:

key - the trigger key

Returns:

true if it was found, false otherwise

getSocialSets

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

Description copied from interface: Triggerer

Returns the internal socials applicable to this trigger.

Specified by:

getSocialSets in interface Triggerer

Returns:

Map of social names and their variations applicable here

addTriggerAssist

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

Description copied from interface: Triggerer

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.

Specified by:

addTriggerAssist in interface Triggerer

Parameters:

assistingM - the mob being assisted, the main triggerer mob

key - the key to the trigger

copyOf

public CMObject copyOf()

Description copied from interface: CMObject

Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.

Specified by:

copyOf in interface CMObject

Returns:

a clone of this object

initializeClass

public void initializeClass()

Description copied from interface: CMObject

Called ONCE after all objects are loaded, but before the map is read in during initialization.

Specified by:

initializeClass in interface CMObject

compareTo

public int compareTo(CMObject o)

Specified by:

compareTo in interface java.lang.Comparable<CMObject>