Package com.planet_ink.coffee_mud.Libraries

Class SlaveryParser.GeasStepImpl

java.lang.Object

com.planet_ink.coffee_mud.Libraries.SlaveryParser.GeasStepImpl

All Implemented Interfaces:

SlaveryLibrary.GeasStep

Enclosing class:

SlaveryParser

public static class SlaveryParser.GeasStepImpl
extends java.lang.Object
implements SlaveryLibrary.GeasStep

Field Summary

Fields

Modifier and Type	Field	Description
MOB	bothering
java.util.List<java.util.List<java.lang.String>>	que
SlaveryLibrary.GeasSteps	steps
int	subStepNum
MOB	targetM

Constructor Summary

Constructors

Constructor	Description
GeasStepImpl(SlaveryLibrary.GeasSteps gs)

Method Summary

Modifier and Type	Method	Description
boolean	botherIfAble(java.lang.String msgOrQ)	Given a message or question, this will cause the slave to speak it to someone in the room, thus bothering them.
MOB	getBotheredMob()	When an individual step action 'bothers' a mob with questions or other actions, this method allows that chosen mob to be tracked over to to judge the response.
boolean	sayResponse(MOB speakerM, MOB targetM, java.lang.String response)	When the slave hears someone speak in the same room as them, it might be to answer a question.
void	setSubStep(int subStepNum)	Sometimes an individual action inside a step requires multiple ticks to accomplish.
java.lang.String	step()	The main ticking method, which will cause the slave/mob to take an action towards the completion of the geas step.

Methods inherited from class java.lang.Object

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

Field Detail

que

public java.util.List<java.util.List<java.lang.String>> que

subStepNum

public int subStepNum

bothering

public MOB bothering

steps

public SlaveryLibrary.GeasSteps steps

targetM

public MOB targetM

Constructor Detail

GeasStepImpl

public GeasStepImpl(SlaveryLibrary.GeasSteps gs)

Method Detail

getBotheredMob

public MOB getBotheredMob()

Description copied from interface: SlaveryLibrary.GeasStep

When an individual step action 'bothers' a mob with questions or other actions, this method allows that chosen mob to be tracked over to to judge the response.

Specified by:

getBotheredMob in interface SlaveryLibrary.GeasStep

Returns:

null, or the mob last bothered

botherIfAble

public boolean botherIfAble(java.lang.String msgOrQ)

Description copied from interface: SlaveryLibrary.GeasStep

Given a message or question, this will cause the slave to speak it to someone in the room, thus bothering them.

Specified by:

botherIfAble in interface SlaveryLibrary.GeasStep

Parameters:

msgOrQ - the message to speak.

Returns:

true if someone was bothered, false otherwise

setSubStep

public void setSubStep(int subStepNum)

Description copied from interface: SlaveryLibrary.GeasStep

Sometimes an individual action inside a step requires multiple ticks to accomplish. This simple ordinal counter is used to keep track of those. It is 0 based.

Specified by:

setSubStep in interface SlaveryLibrary.GeasStep

Parameters:

subStepNum - the sub step ordinal

sayResponse

public boolean sayResponse(MOB speakerM,
                           MOB targetM,
                           java.lang.String response)

Description copied from interface: SlaveryLibrary.GeasStep

When the slave hears someone speak in the same room as them, it might be to answer a question. This method is therefore called to process any perceived speech, whether currently needed or not.

Specified by:

sayResponse in interface SlaveryLibrary.GeasStep

Parameters:

speakerM - the speaker mob

targetM - the target mob, if any

response - the words spoken

Returns:

true if the response was processed, false if ignored

step

public java.lang.String step()

Description copied from interface: SlaveryLibrary.GeasStep

The main ticking method, which will cause the slave/mob to take an action towards the completion of the geas step. It returns the next string action to take.

Specified by:

step in interface SlaveryLibrary.GeasStep

Returns:

the next action to take