Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface AutoAwardsLibrary

All Superinterfaces:

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

All Known Implementing Classes:

AutoAwards

public interface AutoAwardsLibrary
extends CMLibrary

The library for managing the various automatic player awards, such as auto-titles, which are player titles that can, according to a mask, be automatically added and removed from players as they meet, and stop meeting, various criterium. Similar are the AutoProperties entries, which award properties based on player and date-based masks.

See Also:

reloadAutoTitles()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AutoAwardsLibrary.AutoProperties	Class to store the definitional information about a single set of AutoProperties
static interface	AutoAwardsLibrary.AutoTitle	Class to store the definitional information about a single AutoTitle

Field Summary

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

idConverter

Method Summary

Modifier and Type	Method	Description
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.
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.
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.
void	giveAutoProperties(MOB mob)	Allows the given mob to start participating in auto-properties.
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.

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

autoTitles

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

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

Returns:

an enumerator of the auto-title strings themselves

getAutoTitle

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

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

Parameters:

title - the title itself

Returns:

the AutoTitle object that defines it further

getAutoTitleMask

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

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

Parameters:

title - the title itself

Returns:

the zapper mask to determine who should get this title

See Also:

MaskingLibrary

isExistingAutoTitle

boolean isExistingAutoTitle(java.lang.String title)

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

Parameters:

title - the strong to match

Returns:

true if a title of that string exists, false otherwise

evaluateAutoTitle

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.

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

evaluateAutoTitles

boolean evaluateAutoTitles(MOB mob)

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.

Parameters:

mob - the mob to check for new titles for

Returns:

true if any titles were added, false otherwise

reloadAutoTitles

void reloadAutoTitles()

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

appendAutoTitle

void appendAutoTitle(java.lang.String text)

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

Parameters:

text - the text of the new title definition

deleteTitleAndResave

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.

Parameters:

title - the title to remove

Returns:

an error message, or null for success

getAutoTitleFilename

java.lang.String getAutoTitleFilename()

Returns the filename of the auto-title recipe file.

Returns:

the auto-files filename

getAutoPropsFilename

java.lang.String getAutoPropsFilename()

Returns the filename of the auto-properties recipe file.

Returns:

the auto-properties filename

getAutoAwardInstructions

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

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

Parameters:

filename - the file to read

Returns:

the instructions

getAutoProperties

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

Returns an enumeration of all defined auto-properties

Returns:

the auto-properties

getAutoPropertiesHash

int getAutoPropertiesHash()

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

Returns:

the auto-properties hash

giveAutoProperties

void giveAutoProperties(MOB mob)

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

Parameters:

mob - the mob who wants auto properties

modifyAutoProperty

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. Comments beginning with "#" or lines with no content are skipped. Send Integer.MAX_VALUE to append.

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