cleoni.adv
Class DimxObject

java.lang.Object
  cleoni.adv.ManageableObject
      cleoni.adv.DimxObject

Direct Known Subclasses:

AdvObject, World

public class DimxObject
extends ManageableObject

Represents *any* DimensioneX object: WORLD, ITEM, CHARACTER, LINK, ROOM excludes Dictionary objects and Images Base of object of DimensioneX. Like AdvObject, but includes also WORLD itself.

Field Summary

Dict	contents
java.lang.String	id
static int[]	methodArgs
static java.lang.String[]	methods
Token	name
DictSorted	properties
World	world

Constructor Summary

DimxObject()
DimxObject constructor comment.

Method Summary

void	debug(java.lang.String s)
boolean	display(java.lang.String msg)
boolean	displayRight(java.lang.String msg)
Token	execMethod(java.lang.String mname, Dict params)
Dict	getContents()
java.lang.String	getId()
int	getMethodArgs(java.lang.String mname)
java.lang.String[]	getMethods()
java.lang.String	getName()
Dict	getObjectsByName(java.lang.String name, Dict found)
boolean	hasMethod(java.lang.String mname)
boolean	hear(DimxObject from, java.lang.String msg)
boolean	isaCharacter()
boolean	isanItem()
boolean	isaRoom()
boolean	isLink()
boolean	playBackground(java.lang.String soundfile, boolean loop)
boolean	playSound(java.lang.String soundfile)
boolean	refreshView()
boolean	sendCmd(java.lang.String cmd)
boolean	setPanel(java.lang.String panelId)
boolean	useView(Page view)
boolean	varExists(java.lang.String feature)
Token	varGet(java.lang.String varId, boolean getReference) Gets a property
AdvObject	varGetAdvObj(java.lang.String varId)
boolean	varGetBool(java.lang.String varId)
DimxObject	varGetDimxObj(java.lang.String varId)
int	varGetInt(java.lang.String varId)
java.lang.String	varGetStr(java.lang.String varId)
Token	varSet(java.lang.String varId, boolean tokenValue)
Token	varSet(java.lang.String varId, DimxObject tokenValue)
Token	varSet(java.lang.String varId, int tokenValue)
Token	varSet(java.lang.String varId, java.lang.String tokenValue)
void	varSet(java.lang.String varId, Token token) Set a property (variable) to the specified Token (value).

Methods inherited from class cleoni.adv.ManageableObject

toString, varGet

Methods inherited from class java.lang.Object

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

Field Detail

id

public java.lang.String id

world

public World world

name

public Token name

properties

public DictSorted properties

contents

public Dict contents

methods

public static java.lang.String[] methods

methodArgs

public static int[] methodArgs

Constructor Detail

DimxObject

public DimxObject()

DimxObject constructor comment.

Method Detail

debug

public void debug(java.lang.String s)

display

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

Throws:

DimxException

displayRight

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

Throws:

DimxException

getObjectsByName

public Dict getObjectsByName(java.lang.String name,
                             Dict found)

Parameters:

name -

Returns:

getMethods

public java.lang.String[] getMethods()

Overrides:

getMethods in class ManageableObject

getMethodArgs

public int getMethodArgs(java.lang.String mname)

Overrides:

getMethodArgs in class ManageableObject

hasMethod

public boolean hasMethod(java.lang.String mname)

Overrides:

hasMethod in class ManageableObject

hear

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

Throws:

DimxException

isanItem

public boolean isanItem()

isaCharacter

public boolean isaCharacter()

isLink

public boolean isLink()

isaRoom

public boolean isaRoom()

playBackground

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

Throws:

DimxException

playSound

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

Throws:

DimxException

refreshView

public boolean refreshView()
                    throws DimxException

Throws:

DimxException

sendCmd

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

Throws:

DimxException

setPanel

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

Throws:

DimxException

useView

public boolean useView(Page view)
                throws DimxException

Throws:

DimxException

varExists

public boolean varExists(java.lang.String feature)

Overrides:

varExists in class ManageableObject

varSet

public void varSet(java.lang.String varId,
                   Token token)
            throws DimxException

Set a property (variable) to the specified Token (value). Cannot be used to change the name, id, or world of the object.

Parameters:

varId - -- cannot be null.

token - -- will replace existing Token, if present. Can be null.

Throws:

DimxException

varSet

public Token varSet(java.lang.String varId,
                    boolean tokenValue)
             throws DimxException

Throws:

DimxException

varSet

public Token varSet(java.lang.String varId,
                    int tokenValue)
             throws DimxException

Throws:

DimxException

varSet

public Token varSet(java.lang.String varId,
                    java.lang.String tokenValue)
             throws DimxException

Throws:

DimxException

varSet

public Token varSet(java.lang.String varId,
                    DimxObject tokenValue)
             throws DimxException

Throws:

DimxException

varGet

public Token varGet(java.lang.String varId,
                    boolean getReference)
             throws DimxException

Gets a property

Overrides:

varGet in class ManageableObject

Parameters:

varId - Id of the property to be found

getReference - Do you need its reference?

Returns:

always returns a valid Token

Throws:

DimxException

varGetBool

public boolean varGetBool(java.lang.String varId)
                   throws DimxException

Throws:

DimxException

varGetInt

public int varGetInt(java.lang.String varId)
              throws DimxException

Throws:

DimxException

varGetStr

public java.lang.String varGetStr(java.lang.String varId)
                           throws DimxException

Throws:

DimxException

varGetDimxObj

public DimxObject varGetDimxObj(java.lang.String varId)
                         throws DimxException

Throws:

DimxException

varGetAdvObj

public AdvObject varGetAdvObj(java.lang.String varId)
                       throws DimxException

Throws:

DimxException

getContents

public Dict getContents()

getId

public java.lang.String getId()

Overrides:

getId in class ManageableObject

getName

public java.lang.String getName()

Overrides:

getName in class ManageableObject

execMethod

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

Overrides:

execMethod in class ManageableObject

Throws:

DimxException