Package com.planet_ink.coffee_mud.Commands

Class Deviations

java.lang.Object

com.planet_ink.coffee_mud.Commands.StdCommand

com.planet_ink.coffee_mud.Commands.Deviations

All Implemented Interfaces:

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

public class Deviations
extends StdCommand

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	Deviations.DeviationType
protected static class	Deviations.DevSortBy

Field Summary

Fields

Modifier and Type	Field	Description
static Filterer<Environmental>	FILTER_ALL	a constant used in the Deviations to filter on only items
static Filterer<Environmental>	FILTER_ARMORONLY	a constant used in the Deviations to filter on only items
static Filterer<Environmental>	FILTER_ITEMONLY	a constant used in the Deviations to filter on only items
static Filterer<Environmental>	FILTER_MOBONLY	a constant used in the Deviations to filter on only items
static Filterer<Environmental>	FILTER_WEAPONONLY	a constant used in the Deviations to filter on only items
static java.util.Comparator<Environmental>	SORTBY_LEVEL	a constant used in the Deviations to filter on only items
static java.util.Comparator<Environmental>	SORTBY_NAME	a constant used in the Deviations to filter on only items
static java.util.Comparator<Environmental>	SORTBY_PLEVEL	a constant used in the Deviations to filter on only items
static java.util.Comparator<Environmental>	SORTBY_TYPE	a constant used in the Deviations to filter on only items

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

idConverter

Fields inherited from class com.planet_ink.coffee_mud.Commands.StdCommand

ID, noCoinFilter

Constructor Summary

Constructors

Constructor	Description
Deviations()

Method Summary

Modifier and Type	Method	Description
boolean	alreadyDone(Environmental E, Environmental actualE, java.util.List<Environmental> itemsDone, java.util.Map<Environmental,java.util.Set<java.lang.String>> locMap)
boolean	canBeOrdered()	Whether a group leader or charmer can order their followers to do this command.
java.lang.StringBuffer	deviations(MOB mob, Room mobR, java.lang.String rest)
boolean	execute(MOB mob, java.util.List<java.lang.String> commands, int metaFlags)	This method actually performs the command, when the given parsed set of command-line words.
java.lang.Object	executeInternal(MOB mob, int metaFlags, java.lang.Object... args)	This method is used for making "insider" calls to the command.
java.lang.String[]	getAccessWords()	Returns the set of command words, with the most public one first, that are entered by the user to initiate this command.
java.lang.String	getColor(Physical P)
protected java.lang.String	getDeviation(double val, double val2)
protected java.lang.String	getDeviation(int val, java.util.Map<java.lang.String,java.lang.String> vals, java.lang.String key)
protected java.lang.String	itemHeader()
protected java.lang.String	mobHeader(Faction useFaction)
boolean	securityCheck(MOB mob)	Whether this command is available to the given player

Methods inherited from class java.lang.Object

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

Methods inherited from class com.planet_ink.coffee_mud.Commands.StdCommand

actionsCost, canBeCancelled, checkArguments, checkedActionsCost, combatActionsCost, compareTo, copyOf, getArgumentSetIndex, getVisibleRoomTarget, I, ID, initializeClass, isOccupiedWithOtherWork, L, name, newInstance, preExecute, putInCommandlist

Field Detail

FILTER_ITEMONLY

public static final Filterer<Environmental> FILTER_ITEMONLY

a constant used in the Deviations to filter on only items

FILTER_MOBONLY

public static final Filterer<Environmental> FILTER_MOBONLY

a constant used in the Deviations to filter on only items

FILTER_WEAPONONLY

public static final Filterer<Environmental> FILTER_WEAPONONLY

a constant used in the Deviations to filter on only items

FILTER_ARMORONLY

public static final Filterer<Environmental> FILTER_ARMORONLY

a constant used in the Deviations to filter on only items

FILTER_ALL

public static final Filterer<Environmental> FILTER_ALL

a constant used in the Deviations to filter on only items

SORTBY_NAME

public static final java.util.Comparator<Environmental> SORTBY_NAME

a constant used in the Deviations to filter on only items

SORTBY_LEVEL

public static final java.util.Comparator<Environmental> SORTBY_LEVEL

a constant used in the Deviations to filter on only items

SORTBY_PLEVEL

public static final java.util.Comparator<Environmental> SORTBY_PLEVEL

a constant used in the Deviations to filter on only items

SORTBY_TYPE

public static final java.util.Comparator<Environmental> SORTBY_TYPE

a constant used in the Deviations to filter on only items

Constructor Detail

Deviations

public Deviations()

Method Detail

getAccessWords

public java.lang.String[] getAccessWords()

Description copied from interface: Command

Returns the set of command words, with the most public one first, that are entered by the user to initiate this command.

Specified by:

getAccessWords in interface Command

Overrides:

getAccessWords in class StdCommand

Returns:

the set of command words that the user enters

canBeOrdered

public boolean canBeOrdered()

Description copied from interface: Command

Whether a group leader or charmer can order their followers to do this command.

Specified by:

canBeOrdered in interface Command

Overrides:

canBeOrdered in class StdCommand

Returns:

whether this command can be ordered.

mobHeader

protected java.lang.String mobHeader(Faction useFaction)

itemHeader

protected java.lang.String itemHeader()

alreadyDone

public boolean alreadyDone(Environmental E,
                           Environmental actualE,
                           java.util.List<Environmental> itemsDone,
                           java.util.Map<Environmental,java.util.Set<java.lang.String>> locMap)

getDeviation

protected java.lang.String getDeviation(int val,
                                        java.util.Map<java.lang.String,java.lang.String> vals,
                                        java.lang.String key)

getDeviation

protected java.lang.String getDeviation(double val,
                                        double val2)

getColor

public java.lang.String getColor(Physical P)

deviations

public java.lang.StringBuffer deviations(MOB mob,
                                         Room mobR,
                                         java.lang.String rest)

execute

public boolean execute(MOB mob,
                       java.util.List<java.lang.String> commands,
                       int metaFlags)
                throws java.io.IOException

Description copied from interface: Command

This method actually performs the command, when the given parsed set of command-line words. The commands list is almost always the set of strings, starting with the access word that triggered the command. Some commands have custom APIs however, that allow almost anything to be in the commands list, or even for the commands to be null. This method is not allowed to be called until the player or mob has satisfied the actionsCost requirements and the securityCheck

Specified by:

execute in interface Command

Overrides:

execute in class StdCommand

Parameters:

mob - the mob or player issueing the command

commands - usually the command words and parameters; a set of strings

metaFlags - flags denoting how the command is being executed

Returns:

whether the command was successfully executed. Is almost meaningless.

Throws:

java.io.IOException - usually means the player has dropped carrier

See Also:

Command.actionsCost(MOB, List), Command.securityCheck(MOB)

executeInternal

public java.lang.Object executeInternal(MOB mob,
                                        int metaFlags,
                                        java.lang.Object... args)
                                 throws java.io.IOException

Description copied from interface: Command

This method is used for making "insider" calls to the command. It's parameters and implementation can follow any rules you like. The engine will sometimes use these to make direct calls to the command implementations.

Specified by:

executeInternal in interface Command

Overrides:

executeInternal in class StdCommand

Parameters:

mob - the mob or player issueing the command

metaFlags - flags denoting how the command is being executed

args - a set of object parameters

Returns:

a object response

Throws:

java.io.IOException - usually means the player has dropped carrier

securityCheck

public boolean securityCheck(MOB mob)

Description copied from interface: Command

Whether this command is available to the given player

Specified by:

securityCheck in interface Command

Overrides:

securityCheck in class StdCommand

Parameters:

mob - the player mob who might not even know about this command

Returns:

true if the command is available, and false if it is unknown