Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface SlaveryLibrary.GeasSteps

All Superinterfaces:

java.util.Collection<SlaveryLibrary.GeasStep>, java.lang.Iterable<SlaveryLibrary.GeasStep>, java.util.List<SlaveryLibrary.GeasStep>

All Known Implementing Classes:

SlaveryParser.GeasStepsImpl

Enclosing interface:

SlaveryLibrary

public static interface SlaveryLibrary.GeasSteps
extends java.util.List<SlaveryLibrary.GeasStep>

The main stepping object for the slave/geas victim, which tracks multiple high-level steps, even of which must be completed for the task itself to be completed.

Method Summary

Modifier and Type	Method	Description
java.util.Set<MOB>	getBotheredMobs()	Returns the set of mobs that these steps have bothered with questions, in order to prevent repeats.
boolean	isDone()	Returns true only when the slave has completed every step in their process and these steps can be deleted.
void	move(boolean wander)	For internal use, mostly, this will cause the mob to change rooms is possible.
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	step()	The main ticking method, which will cause the slave/mob to take an action towards the completion of the geas task.
MOB	stepperM()	Returns this geas steps slave mob.

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Method Detail

step

void step()

The main ticking method, which will cause the slave/mob to take an action towards the completion of the geas task.

move

void move(boolean wander)

For internal use, mostly, this will cause the mob to change rooms is possible.

Parameters:

wander - true to allow leaving an area

sayResponse

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. This method is therefore called to process any perceived speech, whether currently needed or not.

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

stepperM

MOB stepperM()

Returns this geas steps slave mob.

Returns:

this geas steps slave mob

getBotheredMobs

java.util.Set<MOB> getBotheredMobs()

Returns the set of mobs that these steps have bothered with questions, in order to prevent repeats.

Returns:

the set of bothered mobs

isDone

boolean isDone()

Returns true only when the slave has completed every step in their process and these steps can be deleted.

Returns:

true when done