Methods
|
|
|
|
addAccomplishment
|
addAccomplishment ( self, accomplishment )
Adds an accomplishment to the list.
arguments:
-
accomplishment
- (string)
|
|
addFingerInformation
|
addFingerInformation (
self,
identifier,
statement,
restricted=0,
)
Adds the given statement to the player's finger info.
The statement will be displayed when other players finger
this player. The statement can be a VBFC. The identifier
is not displayed, and is used to reference the statement
in other methods related to finger information. If the
optional restricted flag is set to true, only wizards will
see the added finger information.
arguments:
-
identifier
- (string) the key to file this under
-
statement
- (VBFC/string) the information
-
restricted=0
- (int) 1 if it's restricted to coders, 0 if not
|
|
createInteractive
|
createInteractive ( self )
|
|
createPlayer
|
createPlayer ( self )
|
|
destroyInteractive
|
destroyInteractive ( self )
|
|
destroyPlayer
|
destroyPlayer ( self )
|
|
getAccessLevel
|
getAccessLevel ( self )
Returns the access level of this player.
The access level is 0 if the player is not a coder
and various numbers greater than that if the player is
a coder.
returns:
(int) the access level of this player |
|
getFingerInformation
|
getFingerInformation ( self )
Returns the map of unrestricted finger information set on this player.
Each key is an identifier, and each key's value is a statement
to be displayed. The statements may be VBFCs.
returms:
(hash) |
|
getFingerInformationStatements
|
getFingerInformationStatements ( self )
Returns a list of player's unrestricted finger information statements
This method returns just the statements--not the identifiers--and is
useful for situations when only the statements to be displayed are
of concern.
returms:
(list of strings) |
|
getRestrictedFingerInformation
|
getRestrictedFingerInformation ( self )
Returns the map of restricted finger information set on this player.
Each key is an identifier, and each key's value is a statement to
be displayed. The statements may be VBFCs. Note that finger information
returned from this method should be displayed to wizards only.
returms:
(hash) |
|
getRestrictedFingerInformationStatements
|
getRestrictedFingerInformationStatements ( self )
Returns a list of player's restricted finger information statements
This method returns just the statements--not the identifiers--and is
useful for situations when only the statements to be displayed are
of concern. Statements may be VBFCs. Note that finger information
returned from this method should be displayed to wizards only.
returns:
(list of strings) |
|
getTitle
|
getTitle ( self )
Returns the title of this player in string form.
The title is composed of the access level title (if
there is one, plus the title from the Interactive
object. In the case of coders, it prints a coder
title based on their access level.
returns:
(string) |
|
hasAccomplishment
|
hasAccomplishment ( self, accomplishment )
Returns whether this player has this accomplishment.
returns:
(int) 1 if they do, 0 if they don't |
|
isLinkdead
|
isLinkdead ( self )
Returns whether this player is linkdead or not.
returns:
(int) 0 if not linkdead, 1 if linkdead. |
|
load
|
load ( self, attributes )
When a player is loaded, this function gets called to setup
the player object with the attributes from the player record
which is just a hashmap. |
|
removeFingerInformation
|
removeFingerInformation ( self, identifier )
Removes finger info from this player added with the given identifier.
arguments:
-
identifier
- (string) the item to remove
|
|
save
|
save ( self )
The stdlib.saveObject function calls this method to
return a hashmap of properties that are to be saved. |
|
savePlayer
|
savePlayer ( self )
Saves a player record to disk. The actual creation of the
record is done by the stdlib.saveObject routine. |
|
setAccessLevel
|
setAccessLevel ( self, newAccessLevel )
Sets the access level of this player.
The access level is 0 if the player is not a coder
and various numbers greater than that if the player is
a coder.
arguments:
-
newAccessLevel
- (int) the new access level for this
player
|
|
setAccomplishments
|
setAccomplishments ( self, accomplishments )
Sets the list of accomplishments.
arguments:
-
accomplishments
- (list of strings)
|
|
setIsLinkdead
|
setIsLinkdead ( self, isLinkdead )
Sets the linkdead status.
arguments:
(int) 0 if not linkead, 1 if linkdead. |