Package com.tameif.tame.element

Class TRoom

java.lang.Object

com.tameif.tame.element.TElement

com.tameif.tame.element.TRoom

All Implemented Interfaces:

ObjectContainer, Saveable

public class TRoom
extends TElement
implements ObjectContainer

Environmental instance of every adventure game. Adventure games have rooms. It is where the game takes place and players interact with things. Objects can be contained in this. Players can travel from room to room freely, provided that the world allows them to.

Author:

Matthew Tropiano

Constructor Summary

Constructors

Constructor and Description
TRoom(java.lang.String identity) Creates an empty room.
TRoom(java.lang.String identity, TRoom parent) Creates an empty room.

Method Summary

Modifier and Type	Method and Description
static TRoom	create(java.io.InputStream in) Creates this object from an input stream, expecting its byte representation.
TRoom	getParent() Gets this object's parent.
boolean	isValidEntryType(BlockEntryType type) Checks if this element handles a particular entry type.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class com.tameif.tame.element.TElement

addBlock, addFunction, equals, equals, fromBytes, getBlock, getBlockEntries, getFunction, getFunctionEntries, getIdentity, hashCode, isArchetype, readBytes, resolveBlock, resolveFunction, setArchetype, setIdentity, setIdentityForced, setParent, toBytes, toString, writeBytes

Constructor Detail

TRoom

public TRoom(java.lang.String identity)

Creates an empty room.

Parameters:

identity - its main identity.

TRoom

public TRoom(java.lang.String identity,
             TRoom parent)

Creates an empty room.

Parameters:

identity - its main identity.

parent - the room's parent object.

Method Detail

isValidEntryType

public final boolean isValidEntryType(BlockEntryType type)

Description copied from class: TElement

Checks if this element handles a particular entry type.

Specified by:

isValidEntryType in class TElement

Parameters:

type - the entry type to check.

Returns:

true if so, false if not.

create

public static TRoom create(java.io.InputStream in)
                    throws java.io.IOException

Creates this object from an input stream, expecting its byte representation.

Parameters:

in - the input stream to read from.

Returns:

the read object.

Throws:

java.io.IOException - if a read error occurs.

getParent

public TRoom getParent()

Description copied from class: TElement

Gets this object's parent. The ordering is in the order they were added.

Overrides:

getParent in class TElement

Returns:

an iterator for this object's lineage.

See Also:

TElement.setParent(TElement)