Help

JS-CLAN

For immortals Also: JAVASCRIPT-CLAN

The Clan object represents clans.

Class Methods:

get( n )            Returns the clan object for the given clan name.

Properties:

agenda              The agenda for this clan.
gold                The clan gold that this clan possesses.
history             The history for this clan.
keyName             The key name for this clan.
killPool            The kill points this clan has in its pool.
killPoints          The total kill points this clan has.
platform            The platform for this clan.
shortDesc           The name of this zone.
topic               The current topic for the clan.
topicBy             The name of the person who set the current topic.
tournamentPool      The tournament points this clan has in its pool.
tournamentPoints    The total tournament points this clan has.
type                Returns the type of clan, either 'pacifist' or 'war'.

Methods:

isAlliedWith( c )   Returns true if this clan is allied with clan c
                    or character c's clan.
isAtWarWith( c )    Returns true if this clan is at war with clan c
                    or character c's clan.
hasPlayers()        Returns true if the clan has any players online.
msg( string )       Sends a message to players in this clan.  See
                    JS-MSG for more information.
randomPlayer()      This picks a random player from the clan among the
                    players online.
visitPlayers( f )   Applies the passed in function or array to all of the players
                    in this clan who are online.  See JS-VISIT for more
                    information.
toString()          Returns the name of the clan.
valueOf()           Returns the name of the clan.