Package com.tameif.tame.element

Class TPlayer

java.lang.Object

com.tameif.tame.element.TElement

com.tameif.tame.element.TPlayer

All Implemented Interfaces:

ObjectContainer, Saveable

public class TPlayer
extends TElement
implements ObjectContainer

The viewpoint inside a world. The viewpoint can travel to different rooms, changing view aspects.

Author:

Matthew Tropiano

Constructor Summary

Constructors

Constructor and Description
TPlayer(java.lang.String identity) Creates an empty player.
TPlayer(java.lang.String identity, TPlayer parent) Creates an empty player.

Method Summary

Modifier and Type	Method and Description
static TPlayer	create(java.io.InputStream in) Creates this object from an input stream, expecting its byte representation.
TPlayer	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

TPlayer

public TPlayer(java.lang.String identity)

Creates an empty player.

Parameters:

identity - its main identity.

TPlayer

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

Creates an empty player.

Parameters:

identity - its main identity.

parent - the player'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 TPlayer 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 TPlayer 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)