Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface GenericEditor

All Superinterfaces:

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

All Known Implementing Classes:

CMGenEditor

public interface GenericEditor
extends CMLibrary

The command line user interface for almost all On Line Editor functions goes through this library. Functions are available for Modifiable interface edits, general menu edits, as well as abstract object editor menu interfaces.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	GenericEditor.CMEval	An interface for implementing a custom evaluator for prompts requiring lists of things.

Field Summary

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

idConverter

Method Summary

Modifier and Type	Method	Description
Room	changeRoomType(Room R, Room newRoom)	Changes the given rooms type into that of the given new room.
void	genAbility(MOB mob, Physical P, int showNumber, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	genAffects(MOB mob, Physical P, int showNumber, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	genBehaviors(MOB mob, PhysicalAgent P, int showNumber, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	genDescription(MOB mob, Environmental E, int showNumber, int showFlag)	Prompts the given user for a new description value using the mud's standard menu interface, and changes the given objects description.
void	genDisplayText(MOB mob, Environmental E, int showNumber, int showFlag)	Prompts the given user for a new display text using the mud's standard menu interface, and changes the given objects display text.
void	genMiscSet(MOB mob, Environmental E, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	genMiscText(MOB mob, Environmental E, int showNumber, int showFlag)	Provides an command line editor menu for a CoffeeMud object.
void	genName(MOB mob, Environmental E, int showNumber, int showFlag)	Prompts the given user for a new name value using the mud's standard menu interface, and changes the given objects name.
void	modifyAccount(MOB mob, PlayerAccount A, int showFlag)	Prompts the given user using the mud's standard menu interface.
AbilityMapper.AbilityMapping	modifyAllQualifyEntry(MOB mob, java.lang.String eachOrAll, Ability me, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	modifyArea(MOB mob, Area myArea, java.util.Set<Area> alsoUpdateAreas, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	modifyClan(MOB mob, Clan C, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	modifyComponents(MOB mob, java.lang.String skillID, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	modifyGenAbility(MOB mob, Ability me, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	modifyGenClass(MOB mob, CharClass me, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	modifyGenCraftSkill(MOB mob, Ability me, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	modifyGenExit(MOB mob, Exit me, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	modifyGenGatheringSkill(MOB mob, Ability me, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	modifyGenLanguage(MOB mob, Language me, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	modifyGenRace(MOB mob, Race me, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	modifyGenTrap(MOB mob, Trap me, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	modifyGenWrightSkill(MOB mob, Ability me, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	modifyGovernment(MOB mob, ClanGovernment me, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	modifyManufacturer(MOB mob, Manufacturer me, int showFlag)	Prompts the given user using the mud's standard menu interface.
java.lang.String	modifyPlane(MOB mob, java.lang.String planeName, java.util.Map<java.lang.String,java.lang.String> planeSet, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	modifyPlayer(MOB mob, MOB me, int showFlag)	Prompts the given user using the mud's standard menu interface.
Room	modifyRoom(MOB mob, Room R, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	modifyStdItem(MOB mob, Item I, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	modifyStdMob(MOB mob, MOB M, int showFlag)	Prompts the given user using the mud's standard menu interface.
boolean	prompt(MOB mob, boolean oldVal, int showNumber, int showFlag, java.lang.String fieldDisp)	Prompts the given user for a boolean value using the mud's standard menu interface.
boolean	prompt(MOB mob, boolean oldVal, int showNumber, int showFlag, java.lang.String fieldDisp, java.lang.String help)	Prompts the given user for a boolean value using the mud's standard menu interface.
double	prompt(MOB mob, double oldVal, int showNumber, int showFlag, java.lang.String fieldDisp)	Prompts the given user for a double value using the mud's standard menu interface.
double	prompt(MOB mob, double oldVal, int showNumber, int showFlag, java.lang.String fieldDisp, java.lang.String help)	Prompts the given user for a double value using the mud's standard menu interface.
int	prompt(MOB mob, int oldVal, int showNumber, int showFlag, java.lang.String fieldDisp)	Prompts the given user for a int value using the mud's standard menu interface.
int	prompt(MOB mob, int oldVal, int showNumber, int showFlag, java.lang.String fieldDisp, java.lang.String help)	Prompts the given user for a int value using the mud's standard menu interface.
long	prompt(MOB mob, long oldVal, int showNumber, int showFlag, java.lang.String fieldDisp)	Prompts the given user for a long value using the mud's standard menu interface.
long	prompt(MOB mob, long oldVal, int showNumber, int showFlag, java.lang.String fieldDisp, java.lang.String help)	Prompts the given user for a long value using the mud's standard menu interface.
java.lang.String	prompt(MOB mob, java.lang.String oldVal, int showNumber, int showFlag, java.lang.String fieldDisp)	Prompts the given user for a string using the mud's standard menu interface.
java.lang.String	prompt(MOB mob, java.lang.String oldVal, int showNumber, int showFlag, java.lang.String fieldDisp, boolean emptyOK)	Prompts the given user for a string using the mud's standard menu interface.
java.lang.String	prompt(MOB mob, java.lang.String oldVal, int showNumber, int showFlag, java.lang.String fieldDisp, boolean emptyOK, boolean rawPrint)	Prompts the given user for a string using the mud's standard menu interface.
java.lang.String	prompt(MOB mob, java.lang.String oldVal, int showNumber, int showFlag, java.lang.String fieldDisp, boolean emptyOK, boolean rawPrint, int maxChars, java.lang.String help, GenericEditor.CMEval eval, java.lang.Object[] choices)	Prompts the given user for a string using the mud's standard menu interface.
java.lang.String	prompt(MOB mob, java.lang.String oldVal, int showNumber, int showFlag, java.lang.String fieldDisp, boolean emptyOK, boolean rawPrint, java.lang.String help)	Prompts the given user for a string using the mud's standard menu interface.
java.lang.String	prompt(MOB mob, java.lang.String oldVal, int showNumber, int showFlag, java.lang.String fieldDisp, boolean emptyOK, boolean rawPrint, java.lang.String help, GenericEditor.CMEval eval, java.lang.Object[] choices)	Prompts the given user for a string using the mud's standard menu interface.
java.lang.String	prompt(MOB mob, java.lang.String oldVal, int showNumber, int showFlag, java.lang.String fieldDisp, boolean emptyOK, java.lang.String help)	Prompts the given user for a string using the mud's standard menu interface.
java.lang.String	prompt(MOB mob, java.lang.String oldVal, int showNumber, int showFlag, java.lang.String fieldDisp, java.lang.String help)	Prompts the given user for a string using the mud's standard menu interface.
java.lang.String	promptChoice(MOB mob, java.lang.String oldVal, int showNumber, int showFlag, java.lang.String fieldDisp, PairList<java.lang.String,java.lang.String> choices)	Prompts the given user using the mud's standard menu interface.
java.util.Collection<? extends java.lang.Object>	promptEnumChoices(MOB mob, java.util.Collection<? extends java.lang.Object> flags, java.lang.Object[] values, int showNumber, int showFlag, java.lang.String fieldDisplayStr)	Prompts the given mob for one or more choices from a given enum values array.
int	promptMulti(MOB mob, int oldVal, int showNumber, int showFlag, java.lang.String fieldDisp, PairList<java.lang.String,java.lang.String> choices)	Prompts the given user using the mud's standard menu interface.
java.lang.String	promptMultiOrExtra(MOB mob, java.lang.String oldVal, int showNumber, int showFlag, java.lang.String fieldDisp, PairList<java.lang.String,java.lang.String> choices)	Prompts the given user using the mud's standard menu interface.
java.lang.String	promptMultiSelectList(MOB mob, java.lang.String oldVal, java.lang.String delimiter, int showNumber, int showFlag, java.lang.String fieldDisp, PairList<java.lang.String,java.lang.String> choices, boolean nullOK)	Prompts the given user using the mud's standard menu interface.
void	promptStatBool(MOB mob, Modifiable E, int showNumber, int showFlag, java.lang.String fieldDisp, java.lang.String statField)	Prompts the given mob for a Modifiable interface Boolean stat value.
void	promptStatBool(MOB mob, Modifiable E, java.lang.String help, int showNumber, int showFlag, java.lang.String fieldDisp, java.lang.String statField)	Prompts the given mob for a Modifiable interface Boolean stat value.
void	promptStatChoices(MOB mob, Modifiable E, java.lang.String help, int showNumber, int showFlag, java.lang.String fieldDisp, java.lang.String statField, java.lang.Object[] choices)	Prompts the given mob for a Modifiable interface stat value chosen from a set of choices.
void	promptStatCommaChoices(MOB mob, Modifiable E, java.lang.String help, int showNumber, int showFlag, java.lang.String fieldDisp, java.lang.String statField, java.lang.Object[] choices)	Prompts the given mob for a Modifiable interface stat value that consists of a comma delimited list of values from a set of choices.
void	promptStatDouble(MOB mob, Modifiable E, int showNumber, int showFlag, java.lang.String fieldDisp, java.lang.String statField)	Prompts the given mob for a Modifiable interface Double stat value.
void	promptStatDouble(MOB mob, Modifiable E, java.lang.String help, int showNumber, int showFlag, java.lang.String fieldDisp, java.lang.String statField)	Prompts the given mob for a Modifiable interface Double stat value.
void	promptStatInt(MOB mob, Modifiable E, int showNumber, int showFlag, java.lang.String fieldDisp, java.lang.String statField)	Prompts the given mob for a Modifiable interface Integer stat value.
void	promptStatInt(MOB mob, Modifiable E, java.lang.String help, int showNumber, int showFlag, java.lang.String fieldDisp, java.lang.String statField)	Prompts the given mob for a Modifiable interface Integer stat value.
void	promptStatStr(MOB mob, Modifiable E, int showNumber, int showFlag, java.lang.String fieldDisp, java.lang.String statField)	Prompts the given mob for a Modifiable interface String stat value.
void	promptStatStr(MOB mob, Modifiable E, java.lang.String help, int showNumber, int showFlag, java.lang.String fieldDisp, java.lang.String statField, boolean emptyOK)	Prompts the given mob for a Modifiable interface String stat value.
boolean	promptToggle(MOB mob, int showNumber, int showFlag, java.lang.String fieldDisp)	Prompts the given user for a boolean value using the mud's standard menu interface.
void	spellsOrBehaviors(MOB mob, java.util.List<CMObject> V, int showNumber, int showFlag, boolean inParms)	Prompts the given user using the mud's standard menu interface.
void	spellsOrBehavs(MOB mob, java.util.List<CMObject> V, int showNumber, int showFlag, boolean inParms)	Prompts the given user using the mud's standard menu interface.
void	wornLayer(MOB mob, short[] layerAtt, short[] clothingLayer, int showNumber, int showFlag)	Prompts the given user using the mud's standard menu interface.
void	wornLocation(MOB mob, long[] oldWornLocation, boolean[] logicalAnd, int showNumber, int showFlag)	Prompts the given user using the mud's standard menu interface.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getServiceClient, L, propertiesLoaded, shutdown

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

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

modifyArea

void modifyArea(MOB mob,
                Area myArea,
                java.util.Set<Area> alsoUpdateAreas,
                int showFlag)
         throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows the editing of an existing Area.

Parameters:

mob - the player doing the editing

myArea - the area being edited

alsoUpdateAreas - set to put other area objects changed by this one (parents/children)

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyRoom

Room modifyRoom(MOB mob,
                Room R,
                int showFlag)
         throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows the editing of an existing Room.

Parameters:

mob - the player doing the editing

R - the room being edited

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Returns:

the new room, if its type was changed

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyAccount

void modifyAccount(MOB mob,
                   PlayerAccount A,
                   int showFlag)
            throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows the editing of an existing Player Account.

Parameters:

mob - the player doing the editing

A - the account being edited

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyStdItem

void modifyStdItem(MOB mob,
                   Item I,
                   int showFlag)
            throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows modifying the modest editable parameters of a standard item

Parameters:

mob - the player doing the editing

I - the item to edit

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyStdMob

void modifyStdMob(MOB mob,
                  MOB M,
                  int showFlag)
           throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows modifying the modest editable parameters of a standard mob

Parameters:

mob - the player doing the editing

M - the mob to edit

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyComponents

void modifyComponents(MOB mob,
                      java.lang.String skillID,
                      int showFlag)
               throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows the editing of a set of material components required to use a skill or cast a spell.

Parameters:

mob - the player doing the editing

skillID - the ability ID to modify components for

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyClan

void modifyClan(MOB mob,
                Clan C,
                int showFlag)
         throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows the editing of an existing Clan.

Parameters:

mob - the player doing the editing

C - the object being edited

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyGenAbility

void modifyGenAbility(MOB mob,
                      Ability me,
                      int showFlag)
               throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows the editing of an existing Generic Ability (non Lang/Common)

Parameters:

mob - the player doing the editing

me - the object being edited

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyGenLanguage

void modifyGenLanguage(MOB mob,
                       Language me,
                       int showFlag)
                throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows the editing of an existing Generic Language.

Parameters:

mob - the player doing the editing

me - the object being edited

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyManufacturer

void modifyManufacturer(MOB mob,
                        Manufacturer me,
                        int showFlag)
                 throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows the editing of an existing Generic Manufacturer.

Parameters:

mob - the player doing the editing

me - the object being edited

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyGenCraftSkill

void modifyGenCraftSkill(MOB mob,
                         Ability me,
                         int showFlag)
                  throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows the editing of an existing Generic Crafting Skill.

Parameters:

mob - the player doing the editing

me - the object being edited

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyGenWrightSkill

void modifyGenWrightSkill(MOB mob,
                          Ability me,
                          int showFlag)
                   throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows the editing of an existing Generic Wrighting Skill.

Parameters:

mob - the player doing the editing

me - the object being edited

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyGenTrap

void modifyGenTrap(MOB mob,
                   Trap me,
                   int showFlag)
            throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows the editing of an existing Generic Trap.

Parameters:

mob - the player doing the editing

me - the object being edited

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyGenGatheringSkill

void modifyGenGatheringSkill(MOB mob,
                             Ability me,
                             int showFlag)
                      throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows the editing of an existing Generic Gathering Skill.

Parameters:

mob - the player doing the editing

me - the object being edited

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyGenClass

void modifyGenClass(MOB mob,
                    CharClass me,
                    int showFlag)
             throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows the editing of an existing Generic Char Class.

Parameters:

mob - the player doing the editing

me - the object being edited

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyGenExit

void modifyGenExit(MOB mob,
                   Exit me,
                   int showFlag)
            throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows the editing of an existing Generic Exit.

Parameters:

mob - the player doing the editing

me - the object being edited

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyGenRace

void modifyGenRace(MOB mob,
                   Race me,
                   int showFlag)
            throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows the editing of an existing Generic Race.

Parameters:

mob - the player doing the editing

me - the object being edited

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyPlayer

void modifyPlayer(MOB mob,
                  MOB me,
                  int showFlag)
           throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows the editing of an existing Player Character.

Parameters:

mob - the player doing the editing

me - the object being edited

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyGovernment

void modifyGovernment(MOB mob,
                      ClanGovernment me,
                      int showFlag)
               throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows the editing of an existing Clan Government.

Parameters:

mob - the player doing the editing

me - the object being edited

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyAllQualifyEntry

AbilityMapper.AbilityMapping modifyAllQualifyEntry(MOB mob,
                                                   java.lang.String eachOrAll,
                                                   Ability me,
                                                   int showFlag)
                                            throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Modifies the All Qualify rule for the given Ability. These are the rules that auto-apply certain abilities to All classes as an abstract group, or to Each class as an individual skill.

Parameters:

mob - the player doing the editing

eachOrAll - true for Each class, false for All classes

me - the Ability to find the rule for

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Returns:

the new AbilityMapping object containing the criteria.

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

modifyPlane

java.lang.String modifyPlane(MOB mob,
                             java.lang.String planeName,
                             java.util.Map<java.lang.String,java.lang.String> planeSet,
                             int showFlag)
                      throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Generates an edited Planar Rule string after allowing the user to add/edit various rules to define the Plane of Existence.

Parameters:

mob - the player doing the editing

planeName - the name of the Plane of Existence

planeSet - the existing variable definitions for the plane

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Returns:

the edited Planar Rule string (key=value pairs)

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

genMiscSet

void genMiscSet(MOB mob,
                Environmental E,
                int showFlag)
         throws java.io.IOException

Prompts the given user using the mud's standard menu interface. The general command line editor entry point will direct the user to the specific editor menu most appropriate to the given object, whether room, exit, area, item, or mob.

Parameters:

mob - the player doing the editing

E - the object to edit

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

changeRoomType

Room changeRoomType(Room R,
                    Room newRoom)

Changes the given rooms type into that of the given new room. Copies all the things, and destroys the old room. If the old room is savable, the DB is also updated.

Parameters:

R - the old room with all the stuff in it

newRoom - the new room type

Returns:

the new room

spellsOrBehavs

void spellsOrBehavs(MOB mob,
                    java.util.List<CMObject> V,
                    int showNumber,
                    int showFlag,
                    boolean inParms)
             throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows populating/modifying a list containing either Ability or Behavior objects, and, optionally, their parameters.

Parameters:

mob - the player doing the editing

V - the list of ability/behavior objects

showNumber - the item number of this menu entry, possibly ignored

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

inParms - true to allow parms to be edited, false otherwise

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

See Also:

spellsOrBehaviors(MOB, List, int, int, boolean)

spellsOrBehaviors

void spellsOrBehaviors(MOB mob,
                       java.util.List<CMObject> V,
                       int showNumber,
                       int showFlag,
                       boolean inParms)
                throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows populating/modifying a list containing either Ability or Behavior objects, and, optionally, their parameters.

Parameters:

mob - the player doing the editing

V - the list of ability/behavior objects

showNumber - the item number of this menu entry, possibly ignored

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

inParms - true to allow parms to be edited, false otherwise

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

See Also:

spellsOrBehavs(MOB, List, int, int, boolean)

wornLocation

void wornLocation(MOB mob,
                  long[] oldWornLocation,
                  boolean[] logicalAnd,
                  int showNumber,
                  int showFlag)
           throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows changing an armors given worn location bitmap, as well as its and/or distinction.

Parameters:

mob - the player doing the editing

oldWornLocation - the old/new worn location bitmap

logicalAnd - true for All locations, false for Any loc

showNumber - the item number of this menu entry, possibly ignored

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

wornLayer

void wornLayer(MOB mob,
               short[] layerAtt,
               short[] clothingLayer,
               int showNumber,
               int showFlag)
        throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows changing an Armor's given clothing layer number, as well as it's layering attribute value.

Parameters:

mob - the player doing the editing

layerAtt - the existing/new layer attributes

clothingLayer - the existing/new clothing layer

showNumber - the item number of this menu entry, possibly ignored

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

genAbility

void genAbility(MOB mob,
                Physical P,
                int showNumber,
                int showFlag)
         throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows changing the given objects phyStat "ability" value, either as a Magic Level or Tech Level.

Parameters:

mob - the player doing the editing

P - the object to edit

showNumber - the item number of this menu entry, possibly ignored

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

genAffects

void genAffects(MOB mob,
                Physical P,
                int showNumber,
                int showFlag)
         throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows changing the given objects set of affects.

Parameters:

mob - the player doing the editing

P - the object to edit

showNumber - the item number of this menu entry, possibly ignored

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

genBehaviors

void genBehaviors(MOB mob,
                  PhysicalAgent P,
                  int showNumber,
                  int showFlag)
           throws java.io.IOException

Prompts the given user using the mud's standard menu interface. Allows changing the given objects set of behaviors.

Parameters:

mob - the player doing the editing

P - the object to edit

showNumber - the item number of this menu entry, possibly ignored

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

genDescription

void genDescription(MOB mob,
                    Environmental E,
                    int showNumber,
                    int showFlag)
             throws java.io.IOException

Prompts the given user for a new description value using the mud's standard menu interface, and changes the given objects description.

Parameters:

mob - the player doing the editing

E - the object to edit

showNumber - the item number of this menu entry, possibly ignored

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

genDisplayText

void genDisplayText(MOB mob,
                    Environmental E,
                    int showNumber,
                    int showFlag)
             throws java.io.IOException

Prompts the given user for a new display text using the mud's standard menu interface, and changes the given objects display text.

Parameters:

mob - the player doing the editing

E - the object to edit

showNumber - the item number of this menu entry, possibly ignored

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

genName

void genName(MOB mob,
             Environmental E,
             int showNumber,
             int showFlag)
      throws java.io.IOException

Prompts the given user for a new name value using the mud's standard menu interface, and changes the given objects name.

Parameters:

mob - the player doing the editing

E - the object to edit

showNumber - the item number of this menu entry, possibly ignored

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

genMiscText

void genMiscText(MOB mob,
                 Environmental E,
                 int showNumber,
                 int showFlag)
          throws java.io.IOException

Provides an command line editor menu for a CoffeeMud object. If the given object is generic, an appropriate generic editor menu is given, and showNumber is ignored. If the object is not generic, a single string editor for the misc text is used, and showNumber is respected.

Parameters:

mob - the player doing the editing

E - the object to edit

showNumber - the item number of this menu entry, possibly ignored

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

promptToggle

boolean promptToggle(MOB mob,
                     int showNumber,
                     int showFlag,
                     java.lang.String fieldDisp)
              throws java.io.IOException

Prompts the given user for a boolean value using the mud's standard menu interface. This returns the users choice, giving a Toggle? prompt.

Parameters:

mob - the player doing the toggling

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

Returns:

the value entered by the user

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

prompt

boolean prompt(MOB mob,
               boolean oldVal,
               int showNumber,
               int showFlag,
               java.lang.String fieldDisp)
        throws java.io.IOException

Prompts the given user for a boolean value using the mud's standard menu interface. A previous boolean value is be provided for editing purposes.

Parameters:

mob - the player doing the editing

oldVal - the previous value

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

Returns:

the new value entered by the user

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

prompt

boolean prompt(MOB mob,
               boolean oldVal,
               int showNumber,
               int showFlag,
               java.lang.String fieldDisp,
               java.lang.String help)
        throws java.io.IOException

Prompts the given user for a boolean value using the mud's standard menu interface. A previous boolean value is be provided for editing purposes.

Parameters:

mob - the player doing the editing

oldVal - the previous value

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

help - null, or a help message to respond to on ?

Returns:

the new value entered by the user

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

prompt

double prompt(MOB mob,
              double oldVal,
              int showNumber,
              int showFlag,
              java.lang.String fieldDisp)
       throws java.io.IOException

Prompts the given user for a double value using the mud's standard menu interface. A previous double value is be provided for editing purposes.

Parameters:

mob - the player doing the editing

oldVal - the previous value

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

Returns:

the new value entered by the user

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

prompt

double prompt(MOB mob,
              double oldVal,
              int showNumber,
              int showFlag,
              java.lang.String fieldDisp,
              java.lang.String help)
       throws java.io.IOException

Prompts the given user for a double value using the mud's standard menu interface. A previous double value is be provided for editing purposes.

Parameters:

mob - the player doing the editing

oldVal - the previous value

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

help - null, or a help message to respond to on ?

Returns:

the new value entered by the user

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

prompt

int prompt(MOB mob,
           int oldVal,
           int showNumber,
           int showFlag,
           java.lang.String fieldDisp)
    throws java.io.IOException

Prompts the given user for a int value using the mud's standard menu interface. A previous int value is be provided for editing purposes.

Parameters:

mob - the player doing the editing

oldVal - the previous value

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

Returns:

the new value entered by the user

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

prompt

int prompt(MOB mob,
           int oldVal,
           int showNumber,
           int showFlag,
           java.lang.String fieldDisp,
           java.lang.String help)
    throws java.io.IOException

Prompts the given user for a int value using the mud's standard menu interface. A previous int value is be provided for editing purposes.

Parameters:

mob - the player doing the editing

oldVal - the previous value

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

help - null, or a help message to respond to on ?

Returns:

the new value entered by the user

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

prompt

long prompt(MOB mob,
            long oldVal,
            int showNumber,
            int showFlag,
            java.lang.String fieldDisp)
     throws java.io.IOException

Prompts the given user for a long value using the mud's standard menu interface. A previous long value is be provided for editing purposes.

Parameters:

mob - the player doing the editing

oldVal - the previous value

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

Returns:

the new value entered by the user

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

prompt

long prompt(MOB mob,
            long oldVal,
            int showNumber,
            int showFlag,
            java.lang.String fieldDisp,
            java.lang.String help)
     throws java.io.IOException

Prompts the given user for a long value using the mud's standard menu interface. A previous long value is be provided for editing purposes.

Parameters:

mob - the player doing the editing

oldVal - the previous value

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

help - null, or a help message to respond to on ?

Returns:

the new value entered by the user

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

promptMulti

int promptMulti(MOB mob,
                int oldVal,
                int showNumber,
                int showFlag,
                java.lang.String fieldDisp,
                PairList<java.lang.String,java.lang.String> choices)
         throws java.io.IOException

Prompts the given user using the mud's standard menu interface. This function accepts from the user and generates a bitmap based on named bits (first value of each choices pair is a bit value, and second is the name). The returned and given old value are bitmap numbers.

Parameters:

mob - the player doing the editing

oldVal - the previous value of the bitmap

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

choices - list of bit pair choices: str(int)/str pairs

Returns:

the new int value generated from options entered by the user from the choices

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

promptChoice

java.lang.String promptChoice(MOB mob,
                              java.lang.String oldVal,
                              int showNumber,
                              int showFlag,
                              java.lang.String fieldDisp,
                              PairList<java.lang.String,java.lang.String> choices)
                       throws java.io.IOException

Prompts the given user using the mud's standard menu interface. This accepts a previous string key value, and returns the same. The key value is chosen from a list of choice pairs where the first entry is the key value, and the second a display value. Only one selection is permitted.

Parameters:

mob - the player doing the editing

oldVal - the previous key value

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

choices - set of choices as pair(key value, display value)

Returns:

the new key value selected by the user

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

promptMultiSelectList

java.lang.String promptMultiSelectList(MOB mob,
                                       java.lang.String oldVal,
                                       java.lang.String delimiter,
                                       int showNumber,
                                       int showFlag,
                                       java.lang.String fieldDisp,
                                       PairList<java.lang.String,java.lang.String> choices,
                                       boolean nullOK)
                                throws java.io.IOException

Prompts the given user using the mud's standard menu interface. This accepts a string of delimited key values, and returns the same. Each key value is chosen from a list of choice pairs where the first entry is the key value, and the second a display value. Obviously this means multiple selections from the list of choices is permitted.

Parameters:

mob - the player doing the editing

oldVal - the previous values as a delimited string

delimiter - the delimiter of the choices in the string

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

choices - set of choices as pair(key value, display value)

nullOK - true if selecting nothing is OK, false otherwise

Returns:

the new delimited values selected by the user

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

promptMultiOrExtra

java.lang.String promptMultiOrExtra(MOB mob,
                                    java.lang.String oldVal,
                                    int showNumber,
                                    int showFlag,
                                    java.lang.String fieldDisp,
                                    PairList<java.lang.String,java.lang.String> choices)
                             throws java.io.IOException

Prompts the given user using the mud's standard menu interface. This function accepts EITHER a string from a set of choices (first value of each choices pair applies) OR generating a bitmap based on named bits (first value of each choices pair is a bit value, and second is the name). In the second case, the returned and given old value are numbers cast as strings. Seriously, this should be two unrelated functions, but it made the QuestManager CL editor a lot smaller.

Parameters:

mob - the player doing the editing

oldVal - the previous value of the string, or str(int)

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

choices - list of unique choices, or str(int)/str pairs

Returns:

the new string or str(int) value entered by the user from the choices

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

prompt

java.lang.String prompt(MOB mob,
                        java.lang.String oldVal,
                        int showNumber,
                        int showFlag,
                        java.lang.String fieldDisp)
                 throws java.io.IOException

Prompts the given user for a string using the mud's standard menu interface. A previous string value can be provided for editing purposes.

Parameters:

mob - the player doing the editing

oldVal - the previous value of the string

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

Returns:

the new string value entered by the user

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

prompt

java.lang.String prompt(MOB mob,
                        java.lang.String oldVal,
                        int showNumber,
                        int showFlag,
                        java.lang.String fieldDisp,
                        boolean emptyOK)
                 throws java.io.IOException

Prompts the given user for a string using the mud's standard menu interface. A previous string value can be provided for editing purposes.

Parameters:

mob - the player doing the editing

oldVal - the previous value of the string

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

emptyOK - true if "" is acceptable, false otherwise

Returns:

the new string value entered by the user

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

prompt

java.lang.String prompt(MOB mob,
                        java.lang.String oldVal,
                        int showNumber,
                        int showFlag,
                        java.lang.String fieldDisp,
                        boolean emptyOK,
                        boolean rawPrint)
                 throws java.io.IOException

Prompts the given user for a string using the mud's standard menu interface. A previous string value can be provided for editing purposes.

Parameters:

mob - the player doing the editing

oldVal - the previous value of the string

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

emptyOK - true if "" is acceptable, false otherwise

rawPrint - true to show old values unfiltered, false for normal view

Returns:

the new string value entered by the user

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

prompt

java.lang.String prompt(MOB mob,
                        java.lang.String oldVal,
                        int showNumber,
                        int showFlag,
                        java.lang.String fieldDisp,
                        boolean emptyOK,
                        java.lang.String help)
                 throws java.io.IOException

Prompts the given user for a string using the mud's standard menu interface. A previous string value can be provided for editing purposes.

Parameters:

mob - the player doing the editing

oldVal - the previous value of the string

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

emptyOK - true if "" is acceptable, false otherwise

help - null, or a help message to respond to on ?

Returns:

the new string value entered by the user

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

prompt

java.lang.String prompt(MOB mob,
                        java.lang.String oldVal,
                        int showNumber,
                        int showFlag,
                        java.lang.String fieldDisp,
                        java.lang.String help)
                 throws java.io.IOException

Prompts the given user for a string using the mud's standard menu interface. A previous string value can be provided for editing purposes.

Parameters:

mob - the player doing the editing

oldVal - the previous value of the string

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

help - null, or a help message to respond to on ?

Returns:

the new string value entered by the user

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

prompt

java.lang.String prompt(MOB mob,
                        java.lang.String oldVal,
                        int showNumber,
                        int showFlag,
                        java.lang.String fieldDisp,
                        boolean emptyOK,
                        boolean rawPrint,
                        java.lang.String help)
                 throws java.io.IOException

Prompts the given user for a string using the mud's standard menu interface. A previous string value can be provided for editing purposes.

Parameters:

mob - the player doing the editing

oldVal - the previous value of the string

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

emptyOK - true if "" is acceptable, false otherwise

rawPrint - true to show old values unfiltered, false for normal view

help - null, or a help message to respond to on ?

Returns:

the new string value entered by the user

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

prompt

java.lang.String prompt(MOB mob,
                        java.lang.String oldVal,
                        int showNumber,
                        int showFlag,
                        java.lang.String fieldDisp,
                        boolean emptyOK,
                        boolean rawPrint,
                        java.lang.String help,
                        GenericEditor.CMEval eval,
                        java.lang.Object[] choices)
                 throws java.io.IOException

Prompts the given user for a string using the mud's standard menu interface. A previous string value can be provided for editing purposes. It supports picking strings from options and other features.

Parameters:

mob - the player doing the editing

oldVal - the previous value of the string

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

emptyOK - true if "" is acceptable, false otherwise

rawPrint - true to show old values unfiltered, false for normal view

help - null, or a help message to respond to on ?

eval - null, or an GenericEditor.CMEval object

choices - null, or the set of valid choices, any objects that have toString()

Returns:

the new string value entered by the user

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

prompt

java.lang.String prompt(MOB mob,
                        java.lang.String oldVal,
                        int showNumber,
                        int showFlag,
                        java.lang.String fieldDisp,
                        boolean emptyOK,
                        boolean rawPrint,
                        int maxChars,
                        java.lang.String help,
                        GenericEditor.CMEval eval,
                        java.lang.Object[] choices)
                 throws java.io.IOException

Prompts the given user for a string using the mud's standard menu interface. A previous string value can be provided for editing purposes. It supports picking strings from options, max chars, and other features.

Parameters:

mob - the player doing the editing

oldVal - the previous value of the string

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

emptyOK - true if "" is acceptable, false otherwise

rawPrint - true to show old values unfiltered, false for normal view

maxChars - 0, or a maximum number of chars for the string

help - null, or a help message to respond to on ?

eval - null, or an GenericEditor.CMEval object

choices - null, or the set of valid choices, any objects that have toString()

Returns:

the new string value entered by the user

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

promptStatStr

void promptStatStr(MOB mob,
                   Modifiable E,
                   int showNumber,
                   int showFlag,
                   java.lang.String fieldDisp,
                   java.lang.String statField)
            throws java.io.IOException

Prompts the given mob for a Modifiable interface String stat value. Sets the Modifiable stat value appropriately.

Parameters:

mob - the player doing the editing

E - the Modifiable object to modify

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

statField - the official Modifiable stat field id

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

See Also:

Modifiable

promptStatStr

void promptStatStr(MOB mob,
                   Modifiable E,
                   java.lang.String help,
                   int showNumber,
                   int showFlag,
                   java.lang.String fieldDisp,
                   java.lang.String statField,
                   boolean emptyOK)
            throws java.io.IOException

Prompts the given mob for a Modifiable interface String stat value. Sets the Modifiable stat value appropriately.

Parameters:

mob - the player doing the editing

E - the Modifiable object to modify

help - null, or a help message to respond to on ?

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

statField - the official Modifiable stat field id

emptyOK - true if "" is acceptable, false otherwise

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

See Also:

Modifiable

promptStatInt

void promptStatInt(MOB mob,
                   Modifiable E,
                   int showNumber,
                   int showFlag,
                   java.lang.String fieldDisp,
                   java.lang.String statField)
            throws java.io.IOException

Prompts the given mob for a Modifiable interface Integer stat value. Sets the Modifiable stat value appropriately.

Parameters:

mob - the player doing the editing

E - the Modifiable object to modify

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

statField - the official Modifiable stat field id

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

See Also:

Modifiable

promptStatInt

void promptStatInt(MOB mob,
                   Modifiable E,
                   java.lang.String help,
                   int showNumber,
                   int showFlag,
                   java.lang.String fieldDisp,
                   java.lang.String statField)
            throws java.io.IOException

Prompts the given mob for a Modifiable interface Integer stat value. Sets the Modifiable stat value appropriately.

Parameters:

mob - the player doing the editing

E - the Modifiable object to modify

help - null, or a help message to respond to on ?

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

statField - the official Modifiable stat field id

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

See Also:

Modifiable

promptStatBool

void promptStatBool(MOB mob,
                    Modifiable E,
                    int showNumber,
                    int showFlag,
                    java.lang.String fieldDisp,
                    java.lang.String statField)
             throws java.io.IOException

Prompts the given mob for a Modifiable interface Boolean stat value. Sets the Modifiable stat value appropriately.

Parameters:

mob - the player doing the editing

E - the Modifiable object to modify

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

statField - the official Modifiable stat field id

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

See Also:

Modifiable

promptStatBool

void promptStatBool(MOB mob,
                    Modifiable E,
                    java.lang.String help,
                    int showNumber,
                    int showFlag,
                    java.lang.String fieldDisp,
                    java.lang.String statField)
             throws java.io.IOException

Prompts the given mob for a Modifiable interface Boolean stat value. Sets the Modifiable stat value appropriately.

Parameters:

mob - the player doing the editing

E - the Modifiable object to modify

help - null, or a help message to respond to on ?

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

statField - the official Modifiable stat field id

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

See Also:

Modifiable

promptStatDouble

void promptStatDouble(MOB mob,
                      Modifiable E,
                      int showNumber,
                      int showFlag,
                      java.lang.String fieldDisp,
                      java.lang.String statField)
               throws java.io.IOException

Prompts the given mob for a Modifiable interface Double stat value. Sets the Modifiable stat value appropriately.

Parameters:

mob - the player doing the editing

E - the Modifiable object to modify

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

statField - the official Modifiable stat field id

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

See Also:

Modifiable

promptStatDouble

void promptStatDouble(MOB mob,
                      Modifiable E,
                      java.lang.String help,
                      int showNumber,
                      int showFlag,
                      java.lang.String fieldDisp,
                      java.lang.String statField)
               throws java.io.IOException

Prompts the given mob for a Modifiable interface Double stat value. Sets the Modifiable stat value appropriately.

Parameters:

mob - the player doing the editing

E - the Modifiable object to modify

help - null, or a help message to respond to on ?

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

statField - the official Modifiable stat field id

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

See Also:

Modifiable

promptStatChoices

void promptStatChoices(MOB mob,
                       Modifiable E,
                       java.lang.String help,
                       int showNumber,
                       int showFlag,
                       java.lang.String fieldDisp,
                       java.lang.String statField,
                       java.lang.Object[] choices)
                throws java.io.IOException

Prompts the given mob for a Modifiable interface stat value chosen from a set of choices. Sets the Modifiable stat value appropriately.

Parameters:

mob - the player doing the editing

E - the Modifiable object to modify

help - null, or a help message to respond to on ?

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

statField - the official Modifiable stat field id

choices - the set of valid choices, any object that has toString()

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

See Also:

Modifiable

promptStatCommaChoices

void promptStatCommaChoices(MOB mob,
                            Modifiable E,
                            java.lang.String help,
                            int showNumber,
                            int showFlag,
                            java.lang.String fieldDisp,
                            java.lang.String statField,
                            java.lang.Object[] choices)
                     throws java.io.IOException

Prompts the given mob for a Modifiable interface stat value that consists of a comma delimited list of values from a set of choices. Sets the Modifiable stat value appropriately.

Parameters:

mob - the player doing the editing

E - the Modifiable object to modify

help - null, or a help message to respond to on ?

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisp - the prompt display string

statField - the official Modifiable stat field id

choices - the set of valid choices, any object that has toString()

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)

See Also:

Modifiable

promptEnumChoices

java.util.Collection<? extends java.lang.Object> promptEnumChoices(MOB mob,
                                                                   java.util.Collection<? extends java.lang.Object> flags,
                                                                   java.lang.Object[] values,
                                                                   int showNumber,
                                                                   int showFlag,
                                                                   java.lang.String fieldDisplayStr)
                                                            throws java.io.IOException

Prompts the given mob for one or more choices from a given enum values array. Returns all the choices in a collection. Uses the standard menu interface.

Parameters:

mob - the player doing the editing

flags - the current existing set of selected enum values

values - the full set of all enum values

showNumber - the item number of this menu entry

showFlag - 0 to only show prompt and value, -999 to always edit, or the showNumber to edit

fieldDisplayStr - the prompt display string

Returns:

the new user value

Throws:

java.io.IOException - any i/o errors that occur (socket reset errors usually)