com.planet_ink.coffee_mud.Common
Class DefaultClan

java.lang.Object
  com.planet_ink.coffee_mud.Common.DefaultClan

All Implemented Interfaces:

Clan, CMCommon, CMModifiable, CMObject, Tickable, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class DefaultClan
extends java.lang.Object
implements Clan

Portions Copyright (c) 2003 Jeremy Vyska

Portions Copyright (c) 2004-2008 Bo Zimmerman

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Common.interfaces.Clan

Clan.ClanVote

Field Summary

protected java.lang.String	AcceptanceSettings
protected int	autoPosition
protected java.lang.String	clanClass
protected java.lang.String	clanDonationRoom
protected java.util.Vector	clanKills
protected java.lang.String	clanMorgue
protected java.lang.String	clanName
protected java.lang.String	clanPremise
protected java.lang.String	clanRecall
protected int	ClanStatus
protected int	clanTrophies
protected int	clanType
protected long	exp
int	government
protected java.lang.String	lastClanKillRecord
java.util.Hashtable	relations
protected double	taxRate
protected java.util.Vector	voteList

Fields inherited from interface com.planet_ink.coffee_mud.Common.interfaces.Clan

CLAN_STATS, CLANSTATUS_ACTIVE, CLANSTATUS_DESC, CLANSTATUS_FADING, CLANSTATUS_PENDING, FUNC_CLANACCEPT, FUNC_CLANASSIGN, FUNC_CLANCANORDERCONQUERED, FUNC_CLANCANORDERUNDERLINGS, FUNC_CLANDECLARE, FUNC_CLANDEPOSITLIST, FUNC_CLANDONATESET, FUNC_CLANENCHANT, FUNC_CLANEXILE, FUNC_CLANHOMESET, FUNC_CLANPREMISE, FUNC_CLANPROPERTYOWNER, FUNC_CLANREJECT, FUNC_CLANTAX, FUNC_CLANVOTEASSIGN, FUNC_CLANVOTEOTHER, FUNC_CLANWITHDRAW, FUNC_PROCEDURE, GVT_DEMOCRACY, GVT_DESCS, GVT_DICTATORSHIP, GVT_FAMILY, GVT_OLIGARCHY, GVT_REPUBLIC, GVT_THEOCRACY, POS_APPLICANT, POS_BOSS, POS_ENCHANTER, POS_LEADER, POS_MEMBER, POS_STAFF, POS_TREASURER, POSORDER, REL_ALLY, REL_DESCS, REL_FRIENDLY, REL_HOSTILE, REL_NEUTRAL, REL_NEUTRALITYGAUGE, REL_STATES, REL_WAR, RELATIONSHIP_VECTOR, ROL_DESCS, ROL_MAX, topRanks, TROPHY_AREA, TROPHY_CONTROL, TROPHY_DESCS, TROPHY_DESCS_SHORT, TROPHY_EXP, TROPHY_PK, TYPE_CLAN, VSTAT_DESCS, VSTAT_FAILED, VSTAT_PASSED, VSTAT_STARTED

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_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_EMAIL, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MOB, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SPELL_AFFECT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET, TICKMASK_SOLITARY, TICKS_PER_RLMIN, TIME_MILIS_PER_MUDHOUR, TIME_TICK, TIME_TICK_DOUBLE

Constructor Summary

DefaultClan()

Method Summary

void	addMember(MOB M, int role) Adds a new member to this clan
void	addVote(java.lang.Object CV) Adds a new ClanVote object to the list of ongoing votes for this clan.
void	adjExp(int howMuch) Adjusts the amount of experience earned by this clan.
int	allowedToDoThis(MOB mob, int function) Returns whether the given mob is allowed to perform the given function.
int	applyExpMods(int exp) Adjusts the amount of experience earned by a player based on the tax rate.
long	calculateMapPoints() Returns the total control points earned by this clan
long	calculateMapPoints(java.util.Vector controlledAreas) Returns the total control points represented by the list of controlled areas given.
boolean	canBeAssigned(MOB mob, int role)
void	clanAnnounce(java.lang.String msg) Sends a message to all members of all clans.
java.lang.String	clanID() Returns the unique identifying ID of the clan for reference elsewhere.
int	compareTo(CMObject o)
CMObject	copyOf() Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
void	create() Orders the system to create this clan in the database.
void	delMember(MOB M) Del a member from this clan
void	delVote(java.lang.Object CV) Removes a new ClanVote object from the list of ongoing votes for this clan.
void	destroyClan() Orders the system to destroy this clan in the database.
java.lang.String	getAcceptanceSettings() Returns a mask used to identify whether a player is allowed to join a particular clan.
int	getAutoPosition() Returns whether membership is automatically approved to this clan.
java.lang.String	getClanClass() Retrieves this Clan's enforced character class.
protected CharClass	getClanClassC()
int	getClanRelations(java.lang.String id) Returns a Clan.REL_* constant denoting the relationship between this clan and the clan of the given name.
java.util.Vector	getControlledAreas() Returns all the areas on the map controlled by this clan.
int	getCurrentClanKills() Returns the number of other-clan kills this clan has recorded.
java.lang.String	getDetail(MOB mob) Creates the string for the 'clandetail' command, based on the security of the given mob who will view the details.
java.lang.String	getDonation() Returns the roomID of this clans donation room
long	getExp() Gets the amount of experience earned by this clan.
int	getGovernment() Returns the Clan.GVT_* constant representing the government type of this clan.
long	getLastRelationChange(java.lang.String id) Returns the time/date stamp when this clan last changed its relations with the given clan.
DVector	getMemberList() Returns the set of members, where each row represents a member, and the columns are name, role, last login date
DVector	getMemberList(int PosFilter) Returns the set of members, where each row represents a member, and the columns are name, role, last login date.
java.lang.String	getMorgue() Returns the roomID of this clans morgue room
java.lang.String	getName() Returns the name of the clan, which is almost always the same as the ID, which is why clans can't change their names.
int	getNumVoters(int function) Returns the number of members allowed to vote on the given function.
java.lang.String	getPolitics() Returns an XML string used to identify the political relations between this clan and others.
java.lang.String	getPremise() Retrieves this Clan's basic story.
DVector	getRealMemberList(int PosFilter)
java.lang.String	getRecall() Returns the roomID of this clans recall room (their clan home)
MOB	getResponsibleMember() Returns the highest ranking member of this clan.
int	getSaveStatIndex() Returns the index into the stat codes array where extra savable fields begins.
int	getSize() Returns the number of members of this clan.
int	getSize(java.util.Vector members)
java.lang.String	getStat(java.lang.String code) An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders.
java.lang.String[]	getStatCodes() Returns an array of the string names of those fields which are modifiable on this object at run-time by builders.
int	getStatus() Returns one of the CLANSTAT_* constants describing the pending status of this clan for acceptable, or whether its one its way out.
double	getTaxes() Gets the tax rate for this clan.
long	getTickStatus() A coded status for this object during the period where its tick method is being called.
int	getTopRank(MOB mob) Returns the Clan.POS_* constant representing the highest rank in this clan type.
int	getTrophies() Returns a bitmap representing the trophies won by this clan.
int	getType() Returns the clan type, a meaningless variable.
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
void	initializeClass() Called ONCE after all objects are loaded, but before the map is read in during initialization.
boolean	isStat(java.lang.String code) An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders.
java.lang.String	name() The nice displayable name of this instance of this object
CMObject	newInstance() return a new instance of the object
void	recordClanKill() Called when a member of this clan kills a member of another clan.
void	setAcceptanceSettings(java.lang.String newSettings) Sets a mask used to identify whether a player is allowed to join a particular clan.
void	setAutoPosition(int pos) Sets whether membership is automatically approved to this clan.
void	setClanClass(java.lang.String newClass) Sets this Clan's enforced character class.
void	setClanRelations(java.lang.String id, int rel, long time) Sets a new relationship between this clan and the clan with the given id.
void	setDonation(java.lang.String newDonation) Sets the roomID of this clans donation room
void	setExp(long newexp) Sets the amount of experience earned by this clan.
void	setGovernment(int type) Returns the Clan.GVT_* constant representing the government type of this clan.
void	setMorgue(java.lang.String newMorgue) Sets the roomID of this clans morgue room
void	setName(java.lang.String newName) Sets a new name for this clan.
void	setPolitics(java.lang.String politics) Sets an XML string used to identify the political relations between this clan and others.
void	setPremise(java.lang.String newPremise) Sets this Clan's basic story.
void	setRecall(java.lang.String newRecall) Sets the roomID of this clans recall room (their clan home)
void	setStat(java.lang.String code, java.lang.String val) An alternative means of setting the values of those fields on this object which are modifiable at run-time by builders.
void	setStatus(int newStatus) Sets one of the CLANSTAT_* constants describing the pending status of this clan for acceptable, or whether its one its way out.
void	setTaxes(double rate) Sets the tax rate for this clan.
void	setTrophies(int trophyFlag) Sets a bitmap representing the trophies won by this clan.
boolean	tick(Tickable ticking, int tickID) this is the method which is called periodically by the threading engine.
java.lang.String	typeName() Returns Clan, Republic, or another one of the clan government types defined by Clan.GVT_DESC
void	update() Orders the system to update this clan in the database.
boolean	updateClanPrivileges(MOB M) This method is called when a given mobs clan status changes, for instance if they are added to the clan, removed from it, or change their rank.
void	updateVotes() Orders the system to save any changes to existing ongoing votes for this clan.
java.util.Enumeration	votes() If the clan type allows voting, this returns a series of Clan.ClanVote objects

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clanName

protected java.lang.String clanName

clanPremise

protected java.lang.String clanPremise

clanRecall

protected java.lang.String clanRecall

clanMorgue

protected java.lang.String clanMorgue

clanClass

protected java.lang.String clanClass

clanDonationRoom

protected java.lang.String clanDonationRoom

clanTrophies

protected int clanTrophies

autoPosition

protected int autoPosition

AcceptanceSettings

protected java.lang.String AcceptanceSettings

clanType

protected int clanType

ClanStatus

protected int ClanStatus

voteList

protected java.util.Vector voteList

exp

protected long exp

clanKills

protected java.util.Vector clanKills

lastClanKillRecord

protected java.lang.String lastClanKillRecord

taxRate

protected double taxRate

relations

public java.util.Hashtable relations

government

public int government

Constructor Detail

DefaultClan

public DefaultClan()

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, MiscTech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Returns:

the name of this class

getTickStatus

public long getTickStatus()

Description copied from interface: Tickable

A coded status for this object during the period where its tick method is being called. The statis is defined, at least in part, by constants in this interface STATUS_*. STATUS_NOT should be returned when the objects tick method is not currently in execution. It should never return STATUS_NOT when the objects tick method is in execution.

Specified by:

getTickStatus in interface Tickable

Returns:

the numeric status of this object

See Also:

Tickable.tick(Tickable, int)

newInstance

public CMObject newInstance()

return a new instance of the object

Specified by:

newInstance in interface CMObject

Returns:

a new instance of this class

initializeClass

public void initializeClass()

Description copied from interface: CMObject

Called ONCE after all objects are loaded, but before the map is read in during initialization.

Specified by:

initializeClass in interface CMObject

compareTo

public int compareTo(CMObject o)

Specified by:

compareTo in interface java.lang.Comparable<CMObject>

copyOf

public CMObject copyOf()

Description copied from interface: CMObject

Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.

Specified by:

copyOf in interface CMObject

Returns:

a clone of this object

updateVotes

public void updateVotes()

Description copied from interface: Clan

Orders the system to save any changes to existing ongoing votes for this clan.

Specified by:

updateVotes in interface Clan

addVote

public void addVote(java.lang.Object CV)

Description copied from interface: Clan

Adds a new ClanVote object to the list of ongoing votes for this clan.

Specified by:

addVote in interface Clan

Parameters:

CV - the clanvote object to add

See Also:

Clan.ClanVote

delVote

public void delVote(java.lang.Object CV)

Description copied from interface: Clan

Removes a new ClanVote object from the list of ongoing votes for this clan.

Specified by:

delVote in interface Clan

Parameters:

CV - the clanvote object to remove

See Also:

Clan.ClanVote

recordClanKill

public void recordClanKill()

Description copied from interface: Clan

Called when a member of this clan kills a member of another clan. Will update the clan in the database.

Specified by:

recordClanKill in interface Clan

getCurrentClanKills

public int getCurrentClanKills()

Description copied from interface: Clan

Returns the number of other-clan kills this clan has recorded.

Specified by:

getCurrentClanKills in interface Clan

Returns:

the number of kills.

calculateMapPoints

public long calculateMapPoints()

Description copied from interface: Clan

Returns the total control points earned by this clan

Specified by:

calculateMapPoints in interface Clan

Returns:

the number of control points represented

See Also:

Clan.calculateMapPoints(Vector), Clan.getControlledAreas(), Conquerable

calculateMapPoints

public long calculateMapPoints(java.util.Vector controlledAreas)

Description copied from interface: Clan

Returns the total control points represented by the list of controlled areas given.

Specified by:

calculateMapPoints in interface Clan

Parameters:

controlledAreas - the areas controlled

Returns:

the number of control points represented

See Also:

Clan.calculateMapPoints(), Clan.getControlledAreas(), Conquerable

getControlledAreas

public java.util.Vector getControlledAreas()

Description copied from interface: Clan

Returns all the areas on the map controlled by this clan.

Specified by:

getControlledAreas in interface Clan

Returns:

a vector of area objects

See Also:

Conquerable, Area

votes

public java.util.Enumeration votes()

Description copied from interface: Clan

If the clan type allows voting, this returns a series of Clan.ClanVote objects

Specified by:

votes in interface Clan

Returns:

the set of clan votes

See Also:

Clan.ClanVote

getAutoPosition

public int getAutoPosition()

Description copied from interface: Clan

Returns whether membership is automatically approved to this clan. And if so, what the default position for members are.

Specified by:

getAutoPosition in interface Clan

Returns:

xml document describing the politics of this clan

See Also:

Clan.setAutoPosition(int)

setAutoPosition

public void setAutoPosition(int pos)

Description copied from interface: Clan

Sets whether membership is automatically approved to this clan. And if so, what the default position for members are.

Specified by:

setAutoPosition in interface Clan

Parameters:

pos - the positition to give to applicants

See Also:

Clan.getAutoPosition()

getExp

public long getExp()

Description copied from interface: Clan

Gets the amount of experience earned by this clan.

Specified by:

getExp in interface Clan

Returns:

the experience earned

setExp

public void setExp(long newexp)

Description copied from interface: Clan

Sets the amount of experience earned by this clan.

Specified by:

setExp in interface Clan

Parameters:

newexp - the experience earned

adjExp

public void adjExp(int howMuch)

Description copied from interface: Clan

Adjusts the amount of experience earned by this clan.

Specified by:

adjExp in interface Clan

Parameters:

howMuch - the experience adjustment, + or -

getTrophies

public int getTrophies()

Description copied from interface: Clan

Returns a bitmap representing the trophies won by this clan. The bitmap is made up of Clan.TROPHY_* constants.

Specified by:

getTrophies in interface Clan

Returns:

a bitmap of the trophies

See Also:

Clan, Clan.setTrophies(int)

setTrophies

public void setTrophies(int trophyFlag)

Description copied from interface: Clan

Sets a bitmap representing the trophies won by this clan. The bitmap is made up of Clan.TROPHY_* constants.

Specified by:

setTrophies in interface Clan

Parameters:

trophyFlag - a bitmap of the trophies

See Also:

Clan, Clan.getTrophies()

setTaxes

public void setTaxes(double rate)

Description copied from interface: Clan

Sets the tax rate for this clan.

Specified by:

setTaxes in interface Clan

Parameters:

rate - the tax rate 0-100.0

See Also:

Clan.getTaxes()

getTaxes

public double getTaxes()

Description copied from interface: Clan

Gets the tax rate for this clan.

Specified by:

getTaxes in interface Clan

Returns:

rate the tax rate 0-100.0

See Also:

Clan.setTaxes(double)

getClanRelations

public int getClanRelations(java.lang.String id)

Description copied from interface: Clan

Returns a Clan.REL_* constant denoting the relationship between this clan and the clan of the given name.

Specified by:

getClanRelations in interface Clan

Parameters:

id - the name of another clan.

Returns:

the Clan.REL_* constant

See Also:

Clan.setClanRelations(String, int, long), Clan.getLastRelationChange(String)

getLastRelationChange

public long getLastRelationChange(java.lang.String id)

Description copied from interface: Clan

Returns the time/date stamp when this clan last changed its relations with the given clan.

Specified by:

getLastRelationChange in interface Clan

Parameters:

id - the other clan

Returns:

when the last change was

See Also:

Clan.setClanRelations(String, int, long), Clan.getClanRelations(String)

setClanRelations

public void setClanRelations(java.lang.String id,
                             int rel,
                             long time)

Description copied from interface: Clan

Sets a new relationship between this clan and the clan with the given id.

Specified by:

setClanRelations in interface Clan

Parameters:

id - another clan

rel - the Clan.REL_* constant for the new relationship

time - a current date/time stamp for this change

getGovernment

public int getGovernment()

Description copied from interface: Clan

Returns the Clan.GVT_* constant representing the government type of this clan.

Specified by:

getGovernment in interface Clan

Returns:

the Clan.GVT_* constant

See Also:

Clan, Clan.setGovernment(int)

setGovernment

public void setGovernment(int type)

Description copied from interface: Clan

Returns the Clan.GVT_* constant representing the government type of this clan.

Specified by:

setGovernment in interface Clan

Parameters:

type - the Clan.GVT_* constant

See Also:

Clan, Clan.getGovernment()

create

public void create()

Description copied from interface: Clan

Orders the system to create this clan in the database.

Specified by:

create in interface Clan

update

public void update()

Description copied from interface: Clan

Orders the system to update this clan in the database.

Specified by:

update in interface Clan

addMember

public void addMember(MOB M,
                      int role)

Description copied from interface: Clan

Adds a new member to this clan

Specified by:

addMember in interface Clan

Parameters:

M - the member to add

role - the coded role number

delMember

public void delMember(MOB M)

Description copied from interface: Clan

Del a member from this clan

Specified by:

delMember in interface Clan

Parameters:

M - the member to remove

updateClanPrivileges

public boolean updateClanPrivileges(MOB M)

Description copied from interface: Clan

This method is called when a given mobs clan status changes, for instance if they are added to the clan, removed from it, or change their rank.

Specified by:

updateClanPrivileges in interface Clan

Parameters:

M - the mob whose status needs updating

Returns:

whether the update succeeded

destroyClan

public void destroyClan()

Description copied from interface: Clan

Orders the system to destroy this clan in the database.

Specified by:

destroyClan in interface Clan

getClanClassC

protected CharClass getClanClassC()

getDetail

public java.lang.String getDetail(MOB mob)

Description copied from interface: Clan

Creates the string for the 'clandetail' command, based on the security of the given mob who will view the details.

Specified by:

getDetail in interface Clan

Parameters:

mob - the one who will view the details

Returns:

the details view of this clan for the given mob

typeName

public java.lang.String typeName()

Description copied from interface: Clan

Returns Clan, Republic, or another one of the clan government types defined by Clan.GVT_DESC

Specified by:

typeName in interface Clan

Returns:

the clans government types

See Also:

Clan

canBeAssigned

public boolean canBeAssigned(MOB mob,
                             int role)

Specified by:

canBeAssigned in interface Clan

allowedToDoThis

public int allowedToDoThis(MOB mob,
                           int function)

Description copied from interface: Clan

Returns whether the given mob is allowed to perform the given function. The return value can designate that they may do it now, that they may not do it, or that it requires a vote. A return value 1 means they can do it now, 0 means it requires a vote, and -1 means they can never do it. The functions are defined in the Clan interface as FUNC_* constants.

Specified by:

allowedToDoThis in interface Clan

Parameters:

mob - the mob whose priviledges to check.

function - the Clan.FUNC_* constant to use

Returns:

either 1, 0, or -1 saying if they are allowed.

See Also:

Clan

getRealMemberList

public DVector getRealMemberList(int PosFilter)

getSize

public int getSize()

Description copied from interface: Clan

Returns the number of members of this clan.

Specified by:

getSize in interface Clan

Returns:

the membership count.

getSize

public int getSize(java.util.Vector members)

name

public java.lang.String name()

Description copied from interface: Tickable

The nice displayable name of this instance of this object

Specified by:

name in interface Tickable

Returns:

the displayable name of this object instance

getName

public java.lang.String getName()

Description copied from interface: Clan

Returns the name of the clan, which is almost always the same as the ID, which is why clans can't change their names.

Specified by:

getName in interface Clan

Returns:

the name of the clan.

See Also:

Clan.setName(String)

clanID

public java.lang.String clanID()

Description copied from interface: Clan

Returns the unique identifying ID of the clan for reference elsewhere.

Specified by:

clanID in interface Clan

Returns:

the unique identifier of the clan.

See Also:

Clan.getName()

setName

public void setName(java.lang.String newName)

Description copied from interface: Clan

Sets a new name for this clan.

Specified by:

setName in interface Clan

Parameters:

newName - the new name of this clan

See Also:

Clan.getName(), Clan.clanID()

getType

public int getType()

Description copied from interface: Clan

Returns the clan type, a meaningless variable.

Specified by:

getType in interface Clan

Returns:

always returns TYPE_CLAN

getPremise

public java.lang.String getPremise()

Description copied from interface: Clan

Retrieves this Clan's basic story. This is to make the Clan's more RP based and so we can provide up-to-date information on Clans on the web server.

Specified by:

getPremise in interface Clan

Returns:

the story of this clan

See Also:

Clan.setPremise(String)

setPremise

public void setPremise(java.lang.String newPremise)

Description copied from interface: Clan

Sets this Clan's basic story.

Specified by:

setPremise in interface Clan

See Also:

Clan.getPremise()

getAcceptanceSettings

public java.lang.String getAcceptanceSettings()

Description copied from interface: Clan

Returns a mask used to identify whether a player is allowed to join a particular clan.

Specified by:

getAcceptanceSettings in interface Clan

Returns:

the mask used to identify prospects

See Also:

MaskingLibrary, Clan.setAcceptanceSettings(String)

setAcceptanceSettings

public void setAcceptanceSettings(java.lang.String newSettings)

Description copied from interface: Clan

Sets a mask used to identify whether a player is allowed to join a particular clan.

Specified by:

setAcceptanceSettings in interface Clan

Parameters:

newSettings - the mask used to identify prospects

See Also:

MaskingLibrary, Clan.getAcceptanceSettings()

getClanClass

public java.lang.String getClanClass()

Description copied from interface: Clan

Retrieves this Clan's enforced character class. All players who join this clan become this class.

Specified by:

getClanClass in interface Clan

Returns:

the class of this clan

See Also:

Clan.setClanClass(String)

setClanClass

public void setClanClass(java.lang.String newClass)

Description copied from interface: Clan

Sets this Clan's enforced character class.

Specified by:

setClanClass in interface Clan

See Also:

Clan.getClanClass()

getPolitics

public java.lang.String getPolitics()

Description copied from interface: Clan

Returns an XML string used to identify the political relations between this clan and others.

Specified by:

getPolitics in interface Clan

Returns:

xml document describing the politics of this clan

See Also:

Clan.setPolitics(String)

setPolitics

public void setPolitics(java.lang.String politics)

Description copied from interface: Clan

Sets an XML string used to identify the political relations between this clan and others.

Specified by:

setPolitics in interface Clan

Parameters:

politics - xml document describing the politics of this clan

See Also:

Clan.getPolitics()

getStatus

public int getStatus()

Description copied from interface: Clan

Returns one of the CLANSTAT_* constants describing the pending status of this clan for acceptable, or whether its one its way out.

Specified by:

getStatus in interface Clan

Returns:

a Clan.CLANSTAT_* constant

See Also:

Clan, Clan.setStatus(int)

setStatus

public void setStatus(int newStatus)

Description copied from interface: Clan

Sets one of the CLANSTAT_* constants describing the pending status of this clan for acceptable, or whether its one its way out.

Specified by:

setStatus in interface Clan

Parameters:

newStatus - a Clan.CLANSTAT_* constant

See Also:

Clan, Clan.getStatus()

getRecall

public java.lang.String getRecall()

Description copied from interface: Clan

Returns the roomID of this clans recall room (their clan home)

Specified by:

getRecall in interface Clan

Returns:

the roomid of this clans clan home

See Also:

Clan.setRecall(String)

setRecall

public void setRecall(java.lang.String newRecall)

Description copied from interface: Clan

Sets the roomID of this clans recall room (their clan home)

Specified by:

setRecall in interface Clan

Parameters:

newRecall - the roomid of this clans clan home

See Also:

Clan.getRecall()

getMorgue

public java.lang.String getMorgue()

Description copied from interface: Clan

Returns the roomID of this clans morgue room

Specified by:

getMorgue in interface Clan

Returns:

the roomID of this clans morgue room

See Also:

Clan.setMorgue(String)

setMorgue

public void setMorgue(java.lang.String newMorgue)

Description copied from interface: Clan

Sets the roomID of this clans morgue room

Specified by:

setMorgue in interface Clan

Parameters:

newMorgue - the roomID of this clans morgue room

See Also:

Clan.getMorgue()

getDonation

public java.lang.String getDonation()

Description copied from interface: