Package com.planet_ink.coffee_mud.Common.interfaces

Interface ClanGovernment

All Superinterfaces:

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

All Known Implementing Classes:

DefaultClanGovernment

public interface ClanGovernment
extends Modifiable, CMCommon

A class defining the characteristics of a clan government, and its membership.

Field Summary

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

idConverter

Method Summary

Modifier and Type	Method	Description
ClanPosition	addPosition()	Adds the position.
void	delPosition(ClanPosition pos)	Del position.
ClanPosition	findPositionRole(java.lang.Integer roleID)	returns clan position by the given role id
ClanPosition	findPositionRole(java.lang.String pos)	returns clan position based on role id, or some part of its id or name.
int	getAcceptPos()	Gets the accept pos.
Clan.AutoPromoteFlag	getAutoPromoteBy()	Gets the auto promote by.
int	getAutoRole()	Gets the auto role.
java.lang.String	getCategory()	Gets the category.
SearchIDList<Ability>	getClanLevelAbilities(MOB mob, Clan clan, java.lang.Integer level)	Return the list of abilities owned by someone who is part of a clan of the given level.
ChameleonList<Ability>	getClanLevelEffects(MOB mob, Clan clan, java.lang.Integer level)	Return the list of effects owned by someone who is part of a clan of the given level.
java.lang.String	getEntryScript()	Gets the Scriptable parm when joining/creating a clan.
java.lang.String	getExitScript()	Gets the Scriptable parm when resigning/exiling a clan.
java.lang.String	getHelpStr()	Gets the help str.
int	getID()	Gets the iD.
int[]	getLevelProgression()	Gets the level progression.
java.lang.String	getLongDesc()	Gets the long desc.
int	getMaxVoteDays()	Gets the max vote days.
java.lang.String	getMiscVariableSettings()	Returns a miscellaneous variable setting configuration string to be applied to new clans created with this government.
java.lang.String	getName()	Gets the name.
java.lang.Integer	getOverrideMinMembers()	Gets the override min members.
ClanPosition	getPosition(java.lang.String pos)	Gets the position.
ClanPosition[]	getPositions()	Gets the positions.
java.lang.String	getRequiredMaskStr()	Gets the required mask str.
java.lang.String	getShortDesc()	Gets the short desc.
java.util.List<java.lang.String>	getTitleAwards()	Returns a list of titles granted to players of clans in this government.
int	getVoteQuorumPct()	Gets the vote quorum pct.
CMath.CompiledFormula	getXPCalculationFormula()	Returns the compiled xp calculation formula
java.lang.String	getXpCalculationFormulaStr()	Gets the xp calculation formula.
boolean	isConquestByWorship()	Checks if is conquest by worship.
boolean	isConquestEnabled()	Checks if is conquest enabled.
boolean	isConquestItemLoyalty()	Checks if is conquest item loyalty.
boolean	isDefault()	Checks if is default.
boolean	isFamilyOnly()	Checks if is family only.
boolean	isPublic()	Checks if is public.
boolean	isRivalrous()	Returns true if this clan is rivalrous with other rivalrous clans, meaning that pvp is enabled between them, and war can be declared between them.
void	setAcceptPos(int acceptPos)	Sets the accept pos.
void	setAutoPromoteBy(Clan.AutoPromoteFlag autoPromoteBy)	Sets the auto promote by.
void	setAutoRole(int autoRole)	Sets the auto role.
void	setCategory(java.lang.String category)	Sets the category.
void	setConquestByWorship(boolean conquestByWorship)	Sets the conquest by worship.
void	setConquestEnabled(boolean conquestEnabled)	Sets the conquest enabled.
void	setConquestItemLoyalty(boolean conquestItemLoyalty)	Sets the conquest item loyalty.
void	setDefault(boolean isDefault)	Sets the default.
void	setEntryScript(java.lang.String scriptParm)	Sets the Scriptable parm when joining/creating a clan.
void	setExitScript(java.lang.String scriptParm)	Sets the Scriptable parm when resigning/exiling a clan.
void	setFamilyOnly(boolean isFamilyOnly)	Sets the family only.
void	setID(int iD)	Sets the iD.
void	setLevelProgression(int[] levelProgression)	Sets the level progression.
void	setLongDesc(java.lang.String longDesc)	Sets the long desc.
void	setMaxVoteDays(int maxVoteDays)	Sets the max vote days.
void	setMiscVariableSettings(java.lang.String vars)	Sets a miscellaneous variable setting configuration string to be applied to new clans created with this government.
void	setName(java.lang.String name)	Sets the name.
void	setOverrideMinMembers(java.lang.Integer overrideMinMembers)	Sets the override min members.
void	setPositions(ClanPosition[] positions)	Sets the positions.
void	setPublic(boolean isPublic)	Sets the public.
void	setRequiredMaskStr(java.lang.String requiredMaskStr)	Sets the required mask str.
void	setRivalrous(boolean isRivalrous)	Set to true if this clan is rivalrous with other rivalrous clans, meaning that pvp is enabled between them, and war can be declared
void	setShortDesc(java.lang.String shortDesc)	Sets the short desc.
void	setVoteQuorumPct(int voteQuorumPct)	Sets the vote quorum pct.
void	setXpCalculationFormulaStr(java.lang.String xpCalculationFormulaStr)	Sets the xp calculation formula.

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

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

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

Method Detail

getID

int getID()

Gets the iD.

Returns:

the iD

See Also:

getID()

setID

void setID(int iD)

Sets the iD.

Parameters:

iD - the new iD

See Also:

getID()

getName

java.lang.String getName()

Gets the name.

Returns:

the name

See Also:

setName(String)

setName

void setName(java.lang.String name)

Sets the name.

Parameters:

name - the new name

See Also:

getName()

getCategory

java.lang.String getCategory()

Gets the category.

Returns:

the category

See Also:

setCategory(String)

setCategory

void setCategory(java.lang.String category)

Sets the category.

Parameters:

category - the new category

See Also:

getCategory()

getAutoRole

int getAutoRole()

Gets the auto role.

Returns:

the auto role

See Also:

setAutoRole(int)

setAutoRole

void setAutoRole(int autoRole)

Sets the auto role.

Parameters:

autoRole - the new auto role

See Also:

getAutoRole()

getAcceptPos

int getAcceptPos()

Gets the accept pos.

Returns:

the accept pos

See Also:

setAcceptPos(int)

setAcceptPos

void setAcceptPos(int acceptPos)

Sets the accept pos.

Parameters:

acceptPos - the new accept pos

See Also:

getAcceptPos()

getShortDesc

java.lang.String getShortDesc()

Gets the short desc.

Returns:

the short desc

See Also:

setShortDesc(String)

setShortDesc

void setShortDesc(java.lang.String shortDesc)

Sets the short desc.

Parameters:

shortDesc - the new short desc

See Also:

getShortDesc()

getLongDesc

java.lang.String getLongDesc()

Gets the long desc.

Returns:

the long desc

See Also:

setLongDesc(String)

setLongDesc

void setLongDesc(java.lang.String longDesc)

Sets the long desc.

Parameters:

longDesc - the new long desc

See Also:

getLongDesc()

getRequiredMaskStr

java.lang.String getRequiredMaskStr()

Gets the required mask str.

Returns:

the required mask str

See Also:

setRequiredMaskStr(String)

setRequiredMaskStr

void setRequiredMaskStr(java.lang.String requiredMaskStr)

Sets the required mask str.

Parameters:

requiredMaskStr - the new required mask str

See Also:

getRequiredMaskStr()

getEntryScript

java.lang.String getEntryScript()

Gets the Scriptable parm when joining/creating a clan.

Returns:

the script for joining/creating a clan

See Also:

setEntryScript(String)

setEntryScript

void setEntryScript(java.lang.String scriptParm)

Sets the Scriptable parm when joining/creating a clan.

Parameters:

scriptParm - the Scriptable parm

See Also:

getEntryScript()

getExitScript

java.lang.String getExitScript()

Gets the Scriptable parm when resigning/exiling a clan.

Returns:

the script for resigning/exiling a clan

See Also:

setExitScript(String)

setExitScript

void setExitScript(java.lang.String scriptParm)

Sets the Scriptable parm when resigning/exiling a clan.

Parameters:

scriptParm - the Scriptable parm

See Also:

getExitScript()

isPublic

boolean isPublic()

Checks if is public.

Returns:

true, if is public

See Also:

setPublic(boolean)

setPublic

void setPublic(boolean isPublic)

Sets the public.

Parameters:

isPublic - the new public

See Also:

isPublic()

isFamilyOnly

boolean isFamilyOnly()

Checks if is family only.

Returns:

true, if is family only

See Also:

setFamilyOnly(boolean)

setFamilyOnly

void setFamilyOnly(boolean isFamilyOnly)

Sets the family only.

Parameters:

isFamilyOnly - the new family only

See Also:

isFamilyOnly()

getTitleAwards

java.util.List<java.lang.String> getTitleAwards()

Returns a list of titles granted to players of clans in this government. Variables in the titles include: @x1 The Clan Name @x2 The Clan Government Name This list is manipulable.

Returns:

the clan base titles

isRivalrous

boolean isRivalrous()

Returns true if this clan is rivalrous with other rivalrous clans, meaning that pvp is enabled between them, and war can be declared between them.

Returns:

true or false

See Also:

setRivalrous(boolean)

setRivalrous

void setRivalrous(boolean isRivalrous)

Set to true if this clan is rivalrous with other rivalrous clans, meaning that pvp is enabled between them, and war can be declared

Parameters:

isRivalrous - true or false

See Also:

isRivalrous()

getOverrideMinMembers

java.lang.Integer getOverrideMinMembers()

Gets the override min members.

Returns:

the override min members

See Also:

setOverrideMinMembers(Integer)

setOverrideMinMembers

void setOverrideMinMembers(java.lang.Integer overrideMinMembers)

Sets the override min members.

Parameters:

overrideMinMembers - the new override min members

See Also:

getOverrideMinMembers()

isConquestEnabled

boolean isConquestEnabled()

Checks if is conquest enabled.

Returns:

true, if is conquest enabled

See Also:

setConquestEnabled(boolean)

setConquestEnabled

void setConquestEnabled(boolean conquestEnabled)

Sets the conquest enabled.

Parameters:

conquestEnabled - the new conquest enabled

See Also:

isConquestEnabled()

isConquestItemLoyalty

boolean isConquestItemLoyalty()

Checks if is conquest item loyalty.

Returns:

true, if is conquest item loyalty

See Also:

setConquestItemLoyalty(boolean)

setConquestItemLoyalty

void setConquestItemLoyalty(boolean conquestItemLoyalty)

Sets the conquest item loyalty.

Parameters:

conquestItemLoyalty - the new conquest item loyalty

See Also:

isConquestItemLoyalty()

isConquestByWorship

boolean isConquestByWorship()

Checks if is conquest by worship.

Returns:

true, if is conquest by worship

See Also:

setConquestByWorship(boolean)

setConquestByWorship

void setConquestByWorship(boolean conquestByWorship)

Sets the conquest by worship.

Parameters:

conquestByWorship - the new conquest by worship

See Also:

isConquestByWorship()

getMaxVoteDays

int getMaxVoteDays()

Gets the max vote days.

Returns:

the max vote days

See Also:

setMaxVoteDays(int)

setMaxVoteDays

void setMaxVoteDays(int maxVoteDays)

Sets the max vote days.

Parameters:

maxVoteDays - the new max vote days

See Also:

getMaxVoteDays()

getVoteQuorumPct

int getVoteQuorumPct()

Gets the vote quorum pct.

Returns:

the vote quorum pct

See Also:

setVoteQuorumPct(int)

setVoteQuorumPct

void setVoteQuorumPct(int voteQuorumPct)

Sets the vote quorum pct.

Parameters:

voteQuorumPct - the new vote quorum pct

See Also:

getVoteQuorumPct()

getMiscVariableSettings

java.lang.String getMiscVariableSettings()

Returns a miscellaneous variable setting configuration string to be applied to new clans created with this government. The format is VAR1="VALUE" VAR2="VALUE", etc..

Returns:

the coded var string

See Also:

setMiscVariableSettings(String)

setMiscVariableSettings

void setMiscVariableSettings(java.lang.String vars)

Sets a miscellaneous variable setting configuration string to be applied to new clans created with this government. The format is VAR1="VALUE" VAR2="VALUE", etc..

Parameters:

vars - the coded var string

See Also:

getMiscVariableSettings()

getXpCalculationFormulaStr

java.lang.String getXpCalculationFormulaStr()

Gets the xp calculation formula.

Returns:

the xp calculation formula

See Also:

setXpCalculationFormulaStr(String), getXPCalculationFormula()

setXpCalculationFormulaStr

void setXpCalculationFormulaStr(java.lang.String xpCalculationFormulaStr)

Sets the xp calculation formula.

Parameters:

xpCalculationFormulaStr - the new xp calculation formula

See Also:

setXpCalculationFormulaStr(String), getXPCalculationFormula()

getXPCalculationFormula

CMath.CompiledFormula getXPCalculationFormula()

Returns the compiled xp calculation formula

Returns:

the compiled xp calculation formula

See Also:

setXpCalculationFormulaStr(String), getXpCalculationFormulaStr()

isDefault

boolean isDefault()

Checks if is default.

Returns:

true, if is default

See Also:

setDefault(boolean)

setDefault

void setDefault(boolean isDefault)

Sets the default.

Parameters:

isDefault - the new default

See Also:

isDefault()

getPositions

ClanPosition[] getPositions()

Gets the positions.

Returns:

the positions

See Also:

setPositions(ClanPosition[])

setPositions

void setPositions(ClanPosition[] positions)

Sets the positions.

Parameters:

positions - the new positions

See Also:

getPositions()

getAutoPromoteBy

Clan.AutoPromoteFlag getAutoPromoteBy()

Gets the auto promote by.

Returns:

the auto promote by

See Also:

setAutoPromoteBy(com.planet_ink.coffee_mud.Common.interfaces.Clan.AutoPromoteFlag)

setAutoPromoteBy

void setAutoPromoteBy(Clan.AutoPromoteFlag autoPromoteBy)

Sets the auto promote by.

Parameters:

autoPromoteBy - the new auto promote by

See Also:

getAutoPromoteBy()

getLevelProgression

int[] getLevelProgression()

Gets the level progression.

Returns:

the level progression

See Also:

setLevelProgression(int[])

setLevelProgression

void setLevelProgression(int[] levelProgression)

Sets the level progression.

Parameters:

levelProgression - the new level progression

See Also:

getLevelProgression()

getHelpStr

java.lang.String getHelpStr()

Gets the help str.

Returns:

the help str

addPosition

ClanPosition addPosition()

Adds the position.

Returns:

the clan position

See Also:

delPosition(ClanPosition), getPosition(String), findPositionRole(Integer), findPositionRole(String)

delPosition

void delPosition(ClanPosition pos)

Del position.

Parameters:

pos - the pos

See Also:

addPosition(), getPosition(String), findPositionRole(Integer), findPositionRole(String)

getPosition

ClanPosition getPosition(java.lang.String pos)

Gets the position.

Parameters:

pos - the pos

Returns:

the position

See Also:

delPosition(ClanPosition), addPosition(), findPositionRole(Integer), findPositionRole(String)

findPositionRole

ClanPosition findPositionRole(java.lang.Integer roleID)

returns clan position by the given role id

Parameters:

roleID - the role id to look for

Returns:

the position role id goes to

See Also:

delPosition(ClanPosition), addPosition(), getPosition(String), findPositionRole(String)

findPositionRole

ClanPosition findPositionRole(java.lang.String pos)

returns clan position based on role id, or some part of its id or name.

Parameters:

pos - the role id, name, or id

Returns:

the clan position the pos goes to

See Also:

delPosition(ClanPosition), addPosition(), getPosition(String), findPositionRole(Integer)

getClanLevelAbilities

SearchIDList<Ability> getClanLevelAbilities(MOB mob,
                                            Clan clan,
                                            java.lang.Integer level)

Return the list of abilities owned by someone who is part of a clan of the given level.

Parameters:

mob - the mob enabled

clan - the clan the abilities come from

level - clan level

Returns:

list of abilities

getClanLevelEffects

ChameleonList<Ability> getClanLevelEffects(MOB mob,
                                           Clan clan,
                                           java.lang.Integer level)

Return the list of effects owned by someone who is part of a clan of the given level.

Parameters:

mob - the mob affected

clan - the clan the effects come from

level - clan level

Returns:

list of abilities