cleoni.adv
Class Link

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

public class Link
extends AdvObject

Implements a LINK between rooms

Field Summary

protected boolean

isBidirectional

Fields inherited from class cleoni.adv.AdvObject

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

Fields inherited from class cleoni.adv.DimxObject

contents, id, name, properties, world

Constructor Summary

Link(World aWorld, java.lang.String aName, java.lang.String anId, Room fromRoom, Room aRoom, boolean bidirect, java.lang.String aDirection, java.lang.String aDescription, java.lang.String anIcon, java.lang.String attrList)
Way constructor comment.

Method Summary

java.lang.String	getDirection(java.lang.String from)
java.lang.String	getIcon(java.lang.String from, java.lang.String facing, Skin skin)
Room	getRoom()
protected Room	getTarget(java.lang.String from) Returns the room which is reached with the current link if starting from room with the specified ID
java.lang.String	getTypePrefix()
boolean	isLink()
boolean	isOpen()
protected boolean	leadsTo(java.lang.String roomId)
protected boolean	startsFrom(java.lang.String roomId)
java.lang.String	toString()

Methods inherited from class cleoni.adv.AdvObject

afterWorldChange, attachEvent, close, contains, copyFacesInto, debug, die, getContents, getDescription, getExactImage, getFreeSpace, getIcon, getMethodArgs, getMethods, getNearestImage, getPanel, getPeopleContainer, getType, getType, getUsedSpace, go, hasImageUrl, hasSeveralFaces, hear, hide, isAccessibleFrom, isHidden, isHideable, isLockable, isLocked, isNear, isOpenable, isPeopleContainer, isPickable, isPlayer, isRobot, isVehicle, listImages, moveTo, objPlace, objRemove, open, reset, setDescription, setFacing, setHidden, setHideable, setImage, setLockable, setLocked, setOpenable, varGet, varGetIdAt, varsCount, varsSet, varsToHtmlTable, worldChange

Methods inherited from class cleoni.adv.DimxObject

display, displayRight, execMethod, getContents, getId, getName, getObjectsByName, hasMethod, isaCharacter, isanItem, isaRoom, playBackground, playSound, refreshView, sendCmd, setPanel, useView, 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

isBidirectional

protected boolean isBidirectional

Constructor Detail

Link

public Link(World aWorld,
            java.lang.String aName,
            java.lang.String anId,
            Room fromRoom,
            Room aRoom,
            boolean bidirect,
            java.lang.String aDirection,
            java.lang.String aDescription,
            java.lang.String anIcon,
            java.lang.String attrList)
     throws DimxException

Way constructor comment.

Throws:

DimxException

Method Detail

getDirection

public java.lang.String getDirection(java.lang.String from)

getRoom

public Room getRoom()

Overrides:

getRoom in class AdvObject

getTarget

protected Room getTarget(java.lang.String from)

Returns the room which is reached with the current link if starting from room with the specified ID

Parameters:

from - ROOM id from which the link is being traversed

Returns:

ROOM being reached

getTypePrefix

public java.lang.String getTypePrefix()

Overrides:

getTypePrefix in class AdvObject

isLink

public boolean isLink()

Overrides:

isLink in class AdvObject

isOpen

public boolean isOpen()

Overrides:

isOpen in class AdvObject

Returns:

true only if "open".exists() and is true;

leadsTo

protected boolean leadsTo(java.lang.String roomId)

startsFrom

protected boolean startsFrom(java.lang.String roomId)

toString

public java.lang.String toString()

Overrides:

toString in class AdvObject

getIcon

public java.lang.String getIcon(java.lang.String from,
                                java.lang.String facing,
                                Skin skin)