Package com.tameif.tame.element

Class TWorld

java.lang.Object

com.tameif.tame.element.TElement

com.tameif.tame.element.TWorld

All Implemented Interfaces:

ObjectContainer, Saveable

public class TWorld
extends TElement
implements ObjectContainer

Contains immutable World data.

Author:

Matthew Tropiano

Constructor Summary

Constructors

Constructor and Description
TWorld() Constructs an instance of a game world.

Method Summary

Modifier and Type	Method and Description
static TWorld	create(java.io.InputStream in) Creates this object from an input stream, expecting its byte representation.
TWorld	getParent() Gets this object's parent.
boolean	isValidEntryType(BlockEntryType type) Checks if this element handles a particular entry type.
Block	resolveBlock(BlockEntry blockEntry) Resolves a block using a block entry on this element by going backwards through its lineage.
FunctionEntry	resolveFunction(java.lang.String functionName) Resolves a function entry using a function name on this element by going backwards through its lineage.
void	setArchetype(boolean archetype) Sets if this element is an Archetype.
void	setParent(TElement parent) Sets a parent on this object.

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, setIdentity, setIdentityForced, toBytes, toString, writeBytes

Constructor Detail

TWorld

public TWorld()

Constructs an instance of a game world.

Method Detail

create

public static TWorld 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.

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.

setParent

public void setParent(TElement parent)

Description copied from class: TElement

Sets a parent on this object.

Overrides:

setParent in class TElement

Parameters:

parent - the parent object to set.

setArchetype

public void setArchetype(boolean archetype)

Description copied from class: TElement

Sets if this element is an Archetype. Archetypes do not hold state nor have contexts - they only define code. Archetypes can be inherited from, but can never be owned, nor own things, nor be in expressions nor operations.

Overrides:

setArchetype in class TElement

Parameters:

archetype - true if so, false if not.

getParent

public TWorld 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)

resolveBlock

public Block resolveBlock(BlockEntry blockEntry)

Description copied from class: TElement

Resolves a block using a block entry on this element by going backwards through its lineage.

Overrides:

resolveBlock in class TElement

Parameters:

blockEntry - the block entry to use.

Returns:

an associated block, or null if no associated block.

resolveFunction

public FunctionEntry resolveFunction(java.lang.String functionName)

Description copied from class: TElement

Resolves a function entry using a function name on this element by going backwards through its lineage.

Overrides:

resolveFunction in class TElement

Parameters:

functionName - the function name to use.

Returns:

an associated entry, or null if no associated entry.