cleoni.adv
Class Player

java.lang.Object
  cleoni.adv.ManageableObject
      cleoni.adv.DimxObject
          cleoni.adv.AdvObject
              cleoni.adv.Character
                  cleoni.adv.Player

public class Player
extends Character

data and functions for the human player. It is a subclass of CHARACTER - see class hierarchy in the JavaDoc

Field Summary

AdvObject	focus
static int[]	methodArgs
static java.lang.String[]	methods
java.lang.String	password
java.lang.String	prevPanelIds
Skin	skin
Page	view

Fields inherited from class cleoni.adv.Character

accepting

Fields inherited from class cleoni.adv.AdvObject

capacity, container, defContainer, facing, images, showfor, showmode, volume

Fields inherited from class cleoni.adv.DimxObject

contents, id, name, properties, world

Constructor Summary

Player(World aWorld, java.lang.String aName, java.lang.String anId, Skin aSkin, java.lang.String anIcon, int aCapacity, java.lang.String attrList, java.lang.String aDefContainer, Client aClient)
Player constructor comment.

Method Summary

void	afterWorldChange() Does any final operations after world change (typically calls reset() )
boolean	display(java.lang.String msg)
boolean	displayh(java.lang.String msg)
boolean	displayRight(java.lang.String msg)
Token	execMethod(java.lang.String mname, Dict params)
Client	getClient()
java.lang.String	getDescription()
java.lang.String	getExtras()
Image	getImageAndCorrectFacing(PeopleContainer container)
int	getMethodArgs(java.lang.String mname)
java.lang.String[]	getMethods()
Panel	getPanel()
boolean	go(java.lang.String wayId) Moves the object along a Link.
boolean	hear(DimxObject from, java.lang.String msg)
boolean	isaCharacter()
boolean	isPlayer()
boolean	isRobot()
boolean	look(AdvObject o, DictSorted input)
boolean	objectOpen(AdvObject o)
boolean	playBackground(java.lang.String soundfile, boolean loop)
boolean	playSound(java.lang.String soundfile)
void	printXYZ(int x, int y, int z, java.lang.String stuff, int stuffheight)
java.lang.String	restoreContents(java.lang.String contentsString) Restores player's inventory at login
void	restoreEvents(java.lang.String propsString)
void	restoreProperties(java.lang.String propsString)
boolean	saveGame(boolean exiting)
void	say(java.lang.String msg, DimxObject destination)
boolean	sendCmd(java.lang.String cmd)
boolean	setPanel(java.lang.String panelId)
void	updMapPos()
boolean	useView(Page aView)
void	worldChange(World toWorld, java.lang.String newid, java.lang.String defContainer) See AdvObject.WorldChange

Methods inherited from class cleoni.adv.Character

accepts, getTypePrefix, itemDrop, itemGive, itemPick, itemPut, itemUse, itemUse, look, objectClose, objectHide, objectHide, objectSearch, rotate, varGet

Methods inherited from class cleoni.adv.AdvObject

attachEvent, close, contains, copyFacesInto, debug, die, getContents, getDescription, getExactImage, getFreeSpace, getIcon, getNearestImage, getPeopleContainer, getRoom, getType, getType, getUsedSpace, hasImageUrl, hasSeveralFaces, hide, isAccessibleFrom, isHidden, isHideable, isLink, isLockable, isLocked, isNear, isOpen, isOpenable, isPeopleContainer, isPickable, isVehicle, listImages, moveTo, objPlace, objRemove, open, reset, setDescription, setFacing, setHidden, setHideable, setImage, setLockable, setLocked, setOpenable, toString, varGetIdAt, varsCount, varsSet, varsToHtmlTable

Methods inherited from class cleoni.adv.DimxObject

getContents, getId, getName, getObjectsByName, hasMethod, isanItem, isaRoom, refreshView, varExists, varGetAdvObj, varGetBool, varGetDimxObj, varGetInt, varGetStr, varSet, varSet, varSet, varSet, varSet

Methods inherited from class cleoni.adv.ManageableObject

varGet

Methods inherited from class java.lang.Object

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

Field Detail

skin

public Skin skin

password

public java.lang.String password

prevPanelIds

public java.lang.String prevPanelIds

focus

public AdvObject focus

view

public Page view

methods

public static java.lang.String[] methods

methodArgs

public static int[] methodArgs

Constructor Detail

Player

public Player(World aWorld,
              java.lang.String aName,
              java.lang.String anId,
              Skin aSkin,
              java.lang.String anIcon,
              int aCapacity,
              java.lang.String attrList,
              java.lang.String aDefContainer,
              Client aClient)
       throws DimxException

Player constructor comment.

Parameters:

aWorld - leoni.adv.World

aName - java.lang.String

anId - java.lang.String

isRobot - boolean

msgListSize - int

aDescription - java.lang.String

anIcon - java.lang.String

aCapacity - int

position - java.lang.String

Throws:

DimxException

Method Detail

getMethods

public java.lang.String[] getMethods()

Overrides:

getMethods in class Character

getImageAndCorrectFacing

public Image getImageAndCorrectFacing(PeopleContainer container)
                               throws DimxException

Throws:

DimxException

getMethodArgs

public int getMethodArgs(java.lang.String mname)

Overrides:

getMethodArgs in class Character

execMethod

public Token execMethod(java.lang.String mname,
                        Dict params)
                 throws DimxException

Overrides:

execMethod in class Character

Throws:

DimxException

printXYZ

public void printXYZ(int x,
                     int y,
                     int z,
                     java.lang.String stuff,
                     int stuffheight)
              throws DimxException

Throws:

DimxException

getClient

public Client getClient()

getDescription

public java.lang.String getDescription()

getExtras

public java.lang.String getExtras()

display

public boolean display(java.lang.String msg)
                throws DimxException

Overrides:

display in class Character

Throws:

DimxException

displayRight

public boolean displayRight(java.lang.String msg)
                     throws DimxException

Overrides:

displayRight in class DimxObject

Throws:

DimxException

displayh

public boolean displayh(java.lang.String msg)
                 throws DimxException

Overrides:

displayh in class Character

Throws:

DimxException

getPanel

public Panel getPanel()

Overrides:

getPanel in class AdvObject

go

public boolean go(java.lang.String wayId)
           throws DimxException

Description copied from class: AdvObject

Moves the object along a Link. Should be used only on Character and Vehicle objects.

Overrides:

go in class AdvObject

Returns:

Throws:

DimxException

hear

public boolean hear(DimxObject from,
                    java.lang.String msg)
             throws DimxException

Overrides:

hear in class AdvObject

Throws:

DimxException

isaCharacter

public boolean isaCharacter()

Overrides:

isaCharacter in class Character

isPlayer

public boolean isPlayer()

Overrides:

isPlayer in class AdvObject

isRobot

public boolean isRobot()

Overrides:

isRobot in class Character

look

public boolean look(AdvObject o,
                    DictSorted input)
             throws DimxException

Throws:

DimxException

objectOpen

public boolean objectOpen(AdvObject o)
                   throws DimxException

Overrides:

objectOpen in class Character

Throws:

DimxException

playBackground

public boolean playBackground(java.lang.String soundfile,
                              boolean loop)
                       throws DimxException

Overrides:

playBackground in class DimxObject

Throws:

DimxException

playSound

public boolean playSound(java.lang.String soundfile)
                  throws DimxException

Overrides:

playSound in class DimxObject

Throws:

DimxException

restoreContents

public java.lang.String restoreContents(java.lang.String contentsString)
                                 throws DimxException

Restores player's inventory at login

Parameters:

contentsString - List of items to be restored

Returns:

List of items to be restored: it will be the same list as input, in which the saveInfo/restoreInfo part will be cleared if the item has been reconstructed

Throws:

DimxException

restoreEvents

public void restoreEvents(java.lang.String propsString)
                   throws DimxException

Throws:

DimxException

restoreProperties

public void restoreProperties(java.lang.String propsString)
                       throws DimxException

Throws:

DimxException

saveGame

public boolean saveGame(boolean exiting)
                 throws DimxException

Throws:

DimxException

say

public void say(java.lang.String msg,
                DimxObject destination)
         throws DimxException

Throws:

DimxException

sendCmd

public boolean sendCmd(java.lang.String cmd)
                throws DimxException

Overrides:

sendCmd in class DimxObject

Throws:

DimxException

updMapPos

public void updMapPos()

useView

public boolean useView(Page aView)
                throws DimxException

Overrides:

useView in class DimxObject

Throws:

DimxException

worldChange

public void worldChange(World toWorld,
                        java.lang.String newid,
                        java.lang.String defContainer)
                 throws DimxException

See AdvObject.WorldChange

Overrides:

worldChange in class Character

Parameters:

See - AdvObject.WorldChange

See - AdvObject.WorldChange

Throws:

DimxException - in case of problems

afterWorldChange

public void afterWorldChange()
                      throws DimxException

Description copied from class: AdvObject

Does any final operations after world change (typically calls reset() )

Overrides:

afterWorldChange in class AdvObject

Throws:

DimxException - if problems

setPanel

public boolean setPanel(java.lang.String panelId)
                 throws DimxException

Overrides:

setPanel in class DimxObject

Throws:

DimxException