All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class key.Player

java.lang.Object
   |
   +----key.Atom
           |
           +----key.Container
                   |
                   +----key.AnimatedContainer
                           |
                           +----key.Player

public final class Player

extends AnimatedContainer

implements LatentlyCached, Targetable, CommandContainer

commandList

Commands that are specific for this particular atom.

DEFAULT_MAX_FRIENDS

DEFAULT_MAX_INFORM

DEFAULT_MAX_MAIL

DEFAULT_MAX_OBJECTS

DEFAULT_MAX_PREFER

discard

FAIL_PASSWORD_LOG

findAction

friendAction

lagAmount

lagOnce

MAX_IDLE_TICKS

MAX_NAME

MIN_NAME

seePrivateInfoAction

SHOWCHARS

SHOWFLAG_DIRECTED

SHOWFLAG_ENTER

SHOWFLAG_FRIENDS

SHOWFLAG_LEAVE

SHOWFLAG_LOGIN

SHOWFLAG_LOGOUT

SHOWFLAG_ROOM

SHOWFLAG_SHOUTS

SHOWNAMES

staticActions

staticCommandList

This is a reference to some sort of 'standard' command list for this _type_ of atom.

summonAction

tellAction

Player()

Constructs a player

addGenderProperty(String, int)

Adds a new gender property to the player.

addMail(Letter)

afk(boolean)

aspect()

A players aspect is its description when looked at

assignInitialOwner()

Players always own themselves

authenticate(InteractiveConnection)

Called when a password entry is required

beginConnect()

brief()

canMakeFriend(Player)

canSave()

canSwap()

command(String, InteractiveConnection)

This routine kind of doubles up with ModalCommand, but searches many more places than ModalCommand does.

connected()

true if the player is connected

connectTo(InteractiveConnection)

Called to connect a player to an interactive connection.

containsAction(Action)

Returns true if the action is supported by this class.

countRooms()

Returns the number of rooms the player has

deallocate()

disconnect()

Called to terminate a players connection.

dispose()

This is a method that should be called only once.

endConnect()

enrolIntoClan(Clan)

evalReadOnlyProperty(ReadOnlyProperty)

override to return the correct value for the supplied property make sure you call super.evalReadOnlyProperty if you don't understand it before returning null

finalize()

findCommand(CommandContainer, String)

getAction(String)

Returns the action corresponding to the supplied name.

getActions()

Returns a list of the actions supported by this class.

getBlockingMsg()

getBlockMsg()

getClan()

getCodes()

getCommandList()

A shortcut, since matching it from the string could be prohibitively slow

getConnection()

getContext()

Returns the current players context

getCookie(Atom)

getExpert()

getFriends()

getFullName()

getHome()

getId()

getIdle(DateTime)

getIdleMsg()

getInform()

getLastPublicRoom()

getLocation()

Gets the players location

getPossessiveName()

eg: "subtle's"

getPrefer()

getQualifierList()

getRank()

getRepeated()

getShowFlags()

getStaticCommandList()

A shortcut, since matching it from the string could be prohibitively slow

getTerminal()

getTimezone()

getTitledName()

getTotalPlayers()

giveFlorins(int)

Transaction based checking here would ensure that the system couldn't be cheated, given that it was a read only property, which it isn't.

hasPassword()

HeShe()

heShe()

himHer()

HisHer()

hisHer()

isAfk()

isBanished()

isBeyond()

isCitizen()

isHiding()

isIdle()

isLiberated()

if the player can't be put into a clan

isOutRankedBy(Rank)

You can target a player if you can target any of the ranks that they're in.

isOwner(Atom)

I hereby declare each player to be a soverign state, owned by no other.

isStaff()

linkToScape(Scape)

loadFrom(DataInput)

located()

true if the player has a location

maleFemale()

maybeSetBeyond()

modified()

moveTo(Room)

moveTo(Room, Effect, Effect)

putCode(Character, String)

ranks()

recalculateIdlePrompt()

recieveFlorins(int)

resetModify()

resetTerminal()

roomLook()

run()

The main thread of a player - simply starts the parser

scapes()

sendError(String)

This function is used when the user makes some sort of error in typing - *not* if a command can't be executed because of a failure.

sendFailure(String)

sendFeedback(String)

This function is used to output direct, *successful* feedback of a players command.

sendSystem(String)

sendText(String)

Meant to be used to send part of what would normally be a paragraph.

setCanPage(boolean)

setContext(Atom)

setCookie(Atom, Object)

setGender(Gender)

setHome(Room)

setLag(int, boolean)

setPassword(String)

setSaved()

setTerminal(String)

splash(Effect, SuppressionList)

When an effect occurs, people within its "splash" range are notified (that is, they can choose to notice or ignore it).

swapout()

Similar to dispose(), the swapout() method prepares a Atom to be swapped out non-destructively You should probably sync() before doing this...

sync()

unIdle()

Called by the interactive connection to reset the players idletime to 0

unlinkFromScape(Scape)

willSync()

writeTo(DataOutput)

 public static final String FAIL_PASSWORD_LOG

 public static final int DEFAULT_MAX_OBJECTS

 public static final int DEFAULT_MAX_MAIL

 public static final int DEFAULT_MAX_FRIENDS

 public static final int DEFAULT_MAX_PREFER

 public static final int DEFAULT_MAX_INFORM

 public static final int MAX_NAME

 public static final int MIN_NAME

 public static final int SHOWFLAG_DIRECTED

 public static final int SHOWFLAG_FRIENDS

 public static final int SHOWFLAG_ROOM

 public static final int SHOWFLAG_SHOUTS

 public static final int SHOWFLAG_ENTER

 public static final int SHOWFLAG_LEAVE

 public static final int SHOWFLAG_LOGIN

 public static final int SHOWFLAG_LOGOUT

 public static final char SHOWCHARS[]

 public static final String SHOWNAMES[]

 protected AtomicProperty commandList

Commands that are specific for this particular atom. Examples might be custom commands in rooms, such as 'look' (if its overridden to give different messages each time you type it)

 protected ReferenceProperty staticCommandList

This is a reference to some sort of 'standard' command list for this _type_ of atom. It will generally be set when the atom is created or loaded, and left to its own devices after that.

 public static final int MAX_IDLE_TICKS

 protected int lagAmount

 protected boolean lagOnce

 protected boolean discard

 protected static StringKeyCollection staticActions

 public static Action tellAction

 public static Action findAction

 public static Action friendAction

 public static Action summonAction

 public static Action seePrivateInfoAction

 public Player()

Constructs a player

 protected void assignInitialOwner()

Players always own themselves

Overrides:

assignInitialOwner in class Atom

 public final void putCode(Character c,
                           String value)

 public final Hashtable getCodes()

 public boolean brief()

 public boolean isBeyond()

 public synchronized boolean setTerminal(String name)

 public synchronized void resetTerminal()

 public Terminal getTerminal()

 public Repeated getRepeated()

 public void addMail(Letter l) throws NonUniqueKeyException, BadKeyException

 public QualifierList getQualifierList()

 public final Clan getClan()

 public void setCanPage(boolean v)

 public String getIdleMsg()

 public String getBlockMsg()

 public String getBlockingMsg()

 public final boolean isCitizen()

 public final boolean getExpert()

 public final Duration getTimezone()

 public boolean isHiding()

 public boolean isLiberated()

if the player can't be put into a clan

 public Room getLastPublicRoom()

 public Room getHome()

 public void setHome(Room r)

 public Friends getFriends()

 public Group getPrefer()

 public InformList getInform()

 public void setPassword(String newValue)

 public void linkToScape(Scape s)

 public void unlinkFromScape(Scape s)

 public Enumeration scapes()

 public Enumeration ranks()

 public boolean isOutRankedBy(Rank rank)

You can target a player if you can target any of the ranks that they're in. That means that most staff members will _not_ be in the 'resident' rank (so they can't hurt each other.

 public final String getPossessiveName()

eg: "subtle's"

 public final Room getLocation()

Gets the players location

 public boolean modified()

 public void resetModify()

 public void deallocate()

 public final void unIdle()

Called by the interactive connection to reset the players idletime to 0

 public final Duration getIdle(DateTime now)

 public Paragraph aspect()

A players aspect is its description when looked at

Overrides:

aspect in class Atom

 public boolean authenticate(InteractiveConnection ic) throws IOException, PlayerDoesntWantThisNameException

Called when a password entry is required

 public void beginConnect()

 public void endConnect()

 public void setContext(Atom r)

 public Atom getContext()

Returns the current players context

 public void setLag(int amount,
                    boolean continual)

 public void run()

The main thread of a player - simply starts the parser

Overrides:

run in class AnimatedContainer

 public final void recalculateIdlePrompt()

 public final boolean isIdle()

 public final void afk(boolean v)

 public final boolean isAfk()

 public Object findCommand(CommandContainer search,
                           String command)

 public void command(String fullLine,
                     InteractiveConnection ic)

This routine kind of doubles up with ModalCommand, but searches many more places than ModalCommand does. Searches the current context + others

 public boolean connected()

true if the player is connected

 public InteractiveConnection getConnection()

 public boolean located()

true if the player has a location

 public synchronized void connectTo(InteractiveConnection connection) throws NonUniqueKeyException, BadKeyException

Called to connect a player to an interactive connection.

• splashes everyone on the program, letting them know this person has connected.
• tells the Key object to link this player into the online players
• locks this players soul into memory
• updates the players statistics (tells the loginStatistics to begin
• tells the interactive connection which player to unidle (this) when a command is entered.

 public void dispose()

This is a method that should be called only once.

Overrides:

dispose in class Container

 public void swapout()

Similar to dispose(), the swapout() method prepares a Atom to be swapped out non-destructively You should probably sync() before doing this...

Overrides:

swapout in class Container

 public synchronized void disconnect()

Called to terminate a players connection.

• stops time recording
• takes the player out of the room that they're in
• removes the player from the online list of players in Key
• splashes everyone that the player is disconnecting
• closese the interactive connection
• stops the thread

 public void setSaved()

 public boolean willSync()

 public boolean hasPassword()

 public boolean canSave()

 public boolean isStaff()

 public String getRank()

 public void sync() throws IOException

Overrides:

sync in class Atom

 public void moveTo(Room newLocation,
                    Effect leave,
                    Effect enter)

 public void roomLook()

 protected void moveTo(Room newLocation)

 public void giveFlorins(int amount)

Transaction based checking here would ensure that the system couldn't be cheated, given that it was a read only property, which it isn't.

 public boolean[] getShowFlags()

 public final String himHer()

 public final String HisHer()

 public final String hisHer()

 public final String HeShe()

 public final String heShe()

 public final String maleFemale()

 public final void setGender(Gender ng)

 public synchronized void enrolIntoClan(Clan newClan)

 public void recieveFlorins(int amount)

 public boolean canMakeFriend(Player p)

 public String getTitledName()

 public String getFullName()

 public Object evalReadOnlyProperty(ReadOnlyProperty p)

override to return the correct value for the supplied property make sure you call super.evalReadOnlyProperty if you don't understand it before returning null

Overrides:

evalReadOnlyProperty in class Container

 public synchronized void loadFrom(DataInput from) throws IOException

Overrides:

loadFrom in class Container

 public synchronized void writeTo(DataOutput to) throws IOException

Overrides:

writeTo in class Container

 public String getId()

Overrides:

getId in class Atom

 public boolean isOwner(Atom potential)

I hereby declare each player to be a soverign state, owned by no other. ;p~

Overrides:

isOwner in class Atom

 protected DataProperty addGenderProperty(String name,
                                          int value)

Adds a new gender property to the player. Probably best if the player only has one ;). Value should be one of: Gender.MALE, Gender.FEMALE or Gender.NEUTER

 public void splash(Effect e,
                    SuppressionList s)

When an effect occurs, people within its "splash" range are notified (that is, they can choose to notice or ignore it).

Overrides:

splash in class Atom

 public void sendSystem(String message)

 public void sendFeedback(String message)

This function is used to output direct, *successful* feedback of a players command. It is important that this feedback is normal and expected by the player, since it generally won't be hilited in any way. Please try to restrict this output to a single line.

this command does start a new line

Examples:

You tell name 'hi'

Parameters:

message - the text to be displayed

 public void sendError(String message)

This function is used when the user makes some sort of error in typing - *not* if a command can't be executed because of a failure. So, Command not found would go here, but 'Not enough privs to nuke snapper' wouldn't.

this command does start a new line

 public void sendFailure(String message)

 public void sendText(String message)

Meant to be used to send part of what would normally be a paragraph.

 public final void maybeSetBeyond()

 public final int countRooms()

Returns the number of rooms the player has

 public final CommandList getCommandList()

A shortcut, since matching it from the string could be prohibitively slow

 public final CommandList getStaticCommandList()

A shortcut, since matching it from the string could be prohibitively slow

 public Enumeration getActions()

Returns a list of the actions supported by this class.

Overrides:

getActions in class Container

 public boolean containsAction(Action a)

Returns true if the action is supported by this class.

Overrides:

containsAction in class Container

 public Action getAction(String name)

Returns the action corresponding to the supplied name. This routine will need to be overriden by sub-classes using actions.

Overrides:

getAction in class Container

 public static int getTotalPlayers()

 protected void finalize() throws Throwable

Overrides:

finalize in class Container

 public boolean canSwap()

Overrides:

canSwap in class AnimatedContainer

 public boolean isBanished()

 public void setCookie(Atom key,
                       Object value)

 public Object getCookie(Atom key)

All Packages  Class Hierarchy  This Package  Previous  Next  Index