Package com.planet_ink.coffee_mud.MOBS.interfaces

Interface Deity.DeityWorshipper

All Superinterfaces:

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

All Known Subinterfaces:

CharStats

All Known Implementing Classes:

DefaultCharStats, Prayer_InfuseBalance, Prayer_InfuseDiscipline, Prayer_InfuseHoliness, Prayer_InfuseImpunity, Prayer_InfuseModeration, Prayer_InfuseUnholiness, Prop_HaveZapper, Prop_ReqEntry, Prop_RideZapper, Prop_WearZapper

Enclosing interface:

Deity

public static interface Deity.DeityWorshipper
extends CMObject

Helper interface for the deity to identify worshippers and other things associated with a specific deity.

Field Summary

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

idConverter

Method Summary

Modifier and Type	Method	Description
java.lang.String	deityName()	Returns the displayable name of this mobs current deity.
Deity	getMyDeity()	Returns the Deity object of the mob that this player/mob worships.
java.lang.String	getWorshipCharID()	Returns the name of the Deity mob that this player/mob worships.
void	setDeityName(java.lang.String newDeityName)	Changes the apparent deity of ths mob by setting a new name.
void	setWorshipCharID(java.lang.String newVal)	Sets the name of the Deity mob that this player/mob worships.

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

getWorshipCharID

java.lang.String getWorshipCharID()

Returns the name of the Deity mob that this player/mob worships. Empty string means they are an atheist. :) The name here should always be the same as a Deity type mob in the game in order for the religion system to work correctly. For Clerics, this field has particular importance.

Returns:

the name of the Deity mob that this player/mob worships.

See Also:

setWorshipCharID(String), getMyDeity(), setDeityName(String), deityName()

setWorshipCharID

void setWorshipCharID(java.lang.String newVal)

Sets the name of the Deity mob that this player/mob worships. Empty string means they are an atheist. :) The name here should always be the same as a Deity type mob in the game in order for the religion system to work correctly. For Clerics, this field has particular importance.

Parameters:

newVal - the name of the Deity mob that this player/mob worships.

See Also:

setWorshipCharID(String), getMyDeity(), deityName()

getMyDeity

Deity getMyDeity()

Returns the Deity object of the mob that this player/mob worships. A null return means they are an atheist. Very important for Clerics.

Returns:

the Deity object of the mob that this player/mob worships

See Also:

getWorshipCharID(), setWorshipCharID(String), deityName()

deityName

java.lang.String deityName()

Returns the displayable name of this mobs current deity. If this method is called on the mobs charStats() object, as opposed to baseCharStats(), it may return something different than charStats().getMyDeity().name(). For this reason, you should ONLY use this method when you want to display the mobs current deity.

Returns:

the name of this mobs current deity, or empty string.

See Also:

getWorshipCharID(), setWorshipCharID(String), getMyDeity()

setDeityName

void setDeityName(java.lang.String newDeityName)

Changes the apparent deity of ths mob by setting a new name. A value of null will reset this setting, allowing the mobs TRUE deity to be displayed through the deityName method instead of the string set through this one.

Parameters:

newDeityName - the name of the mobs apparent deity

See Also:

deityName()