Package com.planet_ink.coffee_mud.Libraries

Class AutoAwards

java.lang.Object

com.planet_ink.coffee_mud.Libraries.StdLibrary

com.planet_ink.coffee_mud.Libraries.AutoAwards

All Implemented Interfaces:

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

public class AutoAwards
extends StdLibrary
implements AutoAwardsLibrary

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AutoAwards.AutoPropertiesImpl

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.AutoAwardsLibrary

AutoAwardsLibrary.AutoProperties, AutoAwardsLibrary.AutoTitle

Field Summary

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

idConverter

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

isDebugging, name, serviceClient, tickStatus

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

STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors

Constructor	Description
AutoAwards()

Method Summary

Modifier and Type	Method	Description
protected boolean	addProp(PairList<java.lang.String,java.lang.String> fprops, java.lang.String propID, java.lang.String arg, java.lang.String s)
void	appendAutoTitle(java.lang.String text)	Appends to the list of titles from the given text and refreshes the cache.
java.util.Enumeration<java.lang.String>	autoTitles()	Returns an enumerator of the auto-title strings themselves.
java.lang.String	deleteTitleAndResave(java.lang.String title)	Removes the given title from all affected players, removes the given title from the titles properties file, and refreshes the titles cache.
protected void	dispossessOldTimers(AutoAwardsLibrary.AutoTitle A, MOB mob)
protected void	dispossesTitle(java.lang.String title)
java.lang.String	evaluateAutoTitle(java.lang.String row, boolean addIfPossible)	Scans an admin-given auto-title definition string to see if it is properly formatted for adding to the list of auto-titles.
boolean	evaluateAutoTitles(MOB mob)	Scans all existing titles to see if any should be added to the given mob.
protected java.util.Vector<AutoAwardsLibrary.AutoProperties>	getAllAutoAwards()
java.lang.String	getAutoAwardInstructions(java.lang.String filename)	Reads the auto-award recipe file given and returns the instructions from it (basically, the comments)
java.util.Enumeration<AutoAwardsLibrary.AutoProperties>	getAutoProperties()	Returns an enumeration of all defined auto-properties
int	getAutoPropertiesHash()	Returns a hash of the auto-properties, allowing quick checks for changes.
java.lang.String	getAutoPropsFilename()	Returns the filename of the auto-properties recipe file.
AutoAwardsLibrary.AutoTitle	getAutoTitle(java.lang.String title)	Returns the full auto-title definition for the given title/id.
java.lang.String	getAutoTitleFilename()	Returns the filename of the auto-title recipe file.
java.lang.String	getAutoTitleMask(java.lang.String title)	Returns the string mask attributed to a particular title string.
protected int	getTitleIndex(java.util.List<java.lang.String> ptV, java.lang.String title, java.lang.String fixedTitle)
void	giveAutoProperties(MOB mob)	Allows the given mob to start participating in auto-properties.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
boolean	isExistingAutoTitle(java.lang.String title)	Returns whether the given string matches one of the defined player titles.
boolean	modifyAutoProperty(int lineNum, java.lang.String newLine)	In auto properties, this will allow it to be modified on a line-by-line basis automatically, either adding, replacing or deleting a line numbered 1..n.
void	reloadAutoTitles()	Forces this library to re-load its list of titles from the resource file titles.ini.
protected void	updateTitleMax(AutoAwardsLibrary.AutoTitle A)

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, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

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.Libraries.StdLibrary

activate, checkDatabase, compareTo, copyOf, getServiceClient, getTickStatus, initializeClass, L, name, newInstance, propertiesLoaded, setThreadStatus, shutdown, tick

Constructor Detail

AutoAwards

public AutoAwards()

Method Detail

ID

public java.lang.String ID()

Description copied from interface: CMObject

The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Overrides:

ID in class StdLibrary

Returns:

the name of this class

getAutoTitleFilename

public java.lang.String getAutoTitleFilename()

Description copied from interface: AutoAwardsLibrary

Returns the filename of the auto-title recipe file.

Specified by:

getAutoTitleFilename in interface AutoAwardsLibrary

Returns:

the auto-files filename

getAutoPropsFilename

public java.lang.String getAutoPropsFilename()

Description copied from interface: AutoAwardsLibrary

Returns the filename of the auto-properties recipe file.

Specified by:

getAutoPropsFilename in interface AutoAwardsLibrary

Returns:

the auto-properties filename

evaluateAutoTitle

public java.lang.String evaluateAutoTitle(java.lang.String row,
                                          boolean addIfPossible)

Description copied from interface: AutoAwardsLibrary

Scans an admin-given auto-title definition string to see if it is properly formatted for adding to the list of auto-titles.

Specified by:

evaluateAutoTitle in interface AutoAwardsLibrary

Parameters:

row - the admin-entered command string

addIfPossible - true to add it to the list, false to scan-only

Returns:

true if the title meets the criterium, false if it is rejected

isExistingAutoTitle

public boolean isExistingAutoTitle(java.lang.String title)

Description copied from interface: AutoAwardsLibrary

Returns whether the given string matches one of the defined player titles.

Specified by:

isExistingAutoTitle in interface AutoAwardsLibrary

Parameters:

title - the strong to match

Returns:

true if a title of that string exists, false otherwise

autoTitles

public java.util.Enumeration<java.lang.String> autoTitles()

Description copied from interface: AutoAwardsLibrary

Returns an enumerator of the auto-title strings themselves. The strings will substitute a * character for the players name when building the final title.

Specified by:

autoTitles in interface AutoAwardsLibrary

Returns:

an enumerator of the auto-title strings themselves

getAutoTitleMask

public java.lang.String getAutoTitleMask(java.lang.String title)

Description copied from interface: AutoAwardsLibrary

Returns the string mask attributed to a particular title string. The mask is as described by the masking library.

Specified by:

getAutoTitleMask in interface AutoAwardsLibrary

Parameters:

title - the title itself

Returns:

the zapper mask to determine who should get this title

See Also:

MaskingLibrary

evaluateAutoTitles

public boolean evaluateAutoTitles(MOB mob)

Description copied from interface: AutoAwardsLibrary

Scans all existing titles to see if any should be added to the given mob. If any match, the title is added to the mobs list of choices, after being customized.

Specified by:

evaluateAutoTitles in interface AutoAwardsLibrary

Parameters:

mob - the mob to check for new titles for

Returns:

true if any titles were added, false otherwise

getTitleIndex

protected int getTitleIndex(java.util.List<java.lang.String> ptV,
                            java.lang.String title,
                            java.lang.String fixedTitle)

updateTitleMax

protected void updateTitleMax(AutoAwardsLibrary.AutoTitle A)

dispossessOldTimers

protected void dispossessOldTimers(AutoAwardsLibrary.AutoTitle A,
                                   MOB mob)

dispossesTitle

protected void dispossesTitle(java.lang.String title)

getAutoTitle

public AutoAwardsLibrary.AutoTitle getAutoTitle(java.lang.String title)

Description copied from interface: AutoAwardsLibrary

Returns the full auto-title definition for the given title/id.

Specified by:

getAutoTitle in interface AutoAwardsLibrary

Parameters:

title - the title itself

Returns:

the AutoTitle object that defines it further

appendAutoTitle

public void appendAutoTitle(java.lang.String text)

Description copied from interface: AutoAwardsLibrary

Appends to the list of titles from the given text and refreshes the cache. This will also save the file.

Specified by:

appendAutoTitle in interface AutoAwardsLibrary

Parameters:

text - the text of the new title definition

deleteTitleAndResave

public java.lang.String deleteTitleAndResave(java.lang.String title)

Description copied from interface: AutoAwardsLibrary

Removes the given title from all affected players, removes the given title from the titles properties file, and refreshes the titles cache.

Specified by:

deleteTitleAndResave in interface AutoAwardsLibrary

Parameters:

title - the title to remove

Returns:

an error message, or null for success

reloadAutoTitles

public void reloadAutoTitles()

Description copied from interface: AutoAwardsLibrary

Forces this library to re-load its list of titles from the resource file titles.ini.

Specified by:

reloadAutoTitles in interface AutoAwardsLibrary

getAutoAwardInstructions

public java.lang.String getAutoAwardInstructions(java.lang.String filename)

Description copied from interface: AutoAwardsLibrary

Reads the auto-award recipe file given and returns the instructions from it (basically, the comments)

Specified by:

getAutoAwardInstructions in interface AutoAwardsLibrary

Parameters:

filename - the file to read

Returns:

the instructions

getAutoProperties

public java.util.Enumeration<AutoAwardsLibrary.AutoProperties> getAutoProperties()

Description copied from interface: AutoAwardsLibrary

Returns an enumeration of all defined auto-properties

Specified by:

getAutoProperties in interface AutoAwardsLibrary

Returns:

the auto-properties

getAutoPropertiesHash

public int getAutoPropertiesHash()

Description copied from interface: AutoAwardsLibrary

Returns a hash of the auto-properties, allowing quick checks for changes.

Specified by:

getAutoPropertiesHash in interface AutoAwardsLibrary

Returns:

the auto-properties hash

addProp

protected boolean addProp(PairList<java.lang.String,java.lang.String> fprops,
                          java.lang.String propID,
                          java.lang.String arg,
                          java.lang.String s)

getAllAutoAwards

protected java.util.Vector<AutoAwardsLibrary.AutoProperties> getAllAutoAwards()

giveAutoProperties

public void giveAutoProperties(MOB mob)

Description copied from interface: AutoAwardsLibrary

Allows the given mob to start participating in auto-properties.

Specified by:

giveAutoProperties in interface AutoAwardsLibrary

Parameters:

mob - the mob who wants auto properties

modifyAutoProperty

public boolean modifyAutoProperty(int lineNum,
                                  java.lang.String newLine)

Description copied from interface: AutoAwardsLibrary

In auto properties, this will allow it to be modified on a line-by-line basis automatically, either adding, replacing or deleting a line numbered 1..n. Comments beginning with "#" or lines with no content are skipped. Send Integer.MAX_VALUE to append.

Specified by:

modifyAutoProperty in interface AutoAwardsLibrary

Parameters:

lineNum - the line to edit

newLine - null to delete the line, or the new line

Returns:

true if the line was found, false otherwise