Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface SlaveryLibrary.GeasStep

All Known Implementing Classes:

SlaveryParser.GeasStepImpl

Enclosing interface:

SlaveryLibrary

public static interface SlaveryLibrary.GeasStep

A process handler for an individual requires step in a geas or command.

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.

Method Detail

step

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. It returns the next string action to take.

Returns:

the next action to take

setSubStep

void setSubStep(int subStepNum)

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.

Parameters:

subStepNum - the sub step ordinal

getBotheredMob

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.

Returns:

null, or the mob last bothered

botherIfAble

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.

Parameters:

msgOrQ - the message to speak.

Returns:

true if someone was bothered, false otherwise

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