Package com.tameif.tame

Class TAMEModuleContext

java.lang.Object

com.tameif.tame.TAMEModuleContext

All Implemented Interfaces:

Saveable, TAMEConstants

public class TAMEModuleContext
extends java.lang.Object
implements TAMEConstants, Saveable

A mutable context for a module.

The "get" methods are lenient, as they will not throw errors on a bad state. The "resolve" methods are less so, since they are used for when good return is expected, and throw errors otherwise.

Author:

Matthew Tropiano

Field Summary

Fields inherited from interface com.tameif.tame.TAMEConstants

CUE_ERROR, CUE_FATAL, CUE_PAUSE, CUE_QUIT, CUE_TEXT, CUE_TEXTF, CUE_TRACE, CUE_WAIT, DEFAULT_FUNCTION_DEPTH, DEFAULT_RUNAWAY_THRESHOLD, HEADER_AUTHOR, HEADER_COUNTRY, HEADER_EMAIL, HEADER_LANGUAGE, HEADER_TAME_FUNCDEPTH_MAX, HEADER_TAME_RUNAWAY_MAX, HEADER_TITLE, HEADER_TWITTER, HEADER_VERSION, HEADER_WEBSITE, IDENTITY_ARCHETYPE_CONTAINER, IDENTITY_CURRENT_PLAYER, IDENTITY_CURRENT_ROOM, IDENTITY_CURRENT_WORLD, RETURN_VARIABLE

Constructor Summary

Constructors

Constructor and Description
TAMEModuleContext(TAMEModule module) Creates a new module context.

Method Summary

Modifier and Type	Method and Description
int	getAccessibleObjectsByName(java.lang.String name, TObject[] outputArray, int arrayOffset) Returns all objects in the accessible area by an object name read from the interpreter.
java.lang.String[]	getAvailableActionNames() Reflection method - get available action names according to current context and filtered by a prefix.
TContainerContext	getContainerContext(TContainer container) Gets an container context by container.
TContainerContext	getContainerContextByIdentity(java.lang.String identity) Gets a container context by object name.
java.util.Collection<TContainerContext>	getContainerContexts() Get the container contexts.
TElementContext<?>	getContextByIdentity(java.lang.String identity) Gets an element context by element name.
TPlayer	getCurrentPlayer() Gets the current player.
TPlayerContext	getCurrentPlayerContext() Gets the current player context.
TRoom	getCurrentRoom() Gets the current room.
TRoomContext	getCurrentRoomContext() Gets the current room context.
long	getFunctionDepthMax()
TAMEModule	getModule() Gets the encapsulated module.
TObjectContext	getObjectContext(TObject object) Gets an object context by object.
TObjectContext	getObjectContextByIdentity(java.lang.String identity) Gets an object context by object name.
java.util.Collection<TObjectContext>	getObjectContexts() Get the object contexts.
long	getOperationRunawayMax()
TOwnershipMap	getOwnershipMap()
TPlayerContext	getPlayerContext(TPlayer player) Gets a player context by player.
TPlayerContext	getPlayerContextByIdentity(java.lang.String identity) Gets a player context by player name.
java.util.Collection<TPlayerContext>	getPlayerContexts() Get the player contexts.
java.util.Random	getRandom() Gets the context random number generator.
TRoomContext	getRoomContext(TRoom room) Gets a room context by room.
TRoomContext	getRoomContextByIdentity(java.lang.String identity) Gets a room context by room name.
java.util.Collection<TRoomContext>	getRoomContexts() Get the room contexts.
TWorldContext	getWorldContext() Gets this module's world context.
void	readBytes(java.io.InputStream in) Imports this object from bytes.
TAction	resolveAction(java.lang.String actionIdentity) Resolves an action by its identity.
TContainer	resolveContainer(java.lang.String containerIdentity) Resolves a container.
TContainerContext	resolveContainerContext(java.lang.String containerIdentity) Resolves a container context.
TElement	resolveElement(Value varElement) Resolves an element by a value.
TElementContext<?>	resolveElementContext(Value varElement) Resolves an element context by a value.
TObject	resolveObject(java.lang.String objectIdentity) Resolves an object.
TObjectContext	resolveObjectContext(java.lang.String objectIdentity) Resolves an object context.
java.lang.Iterable<TObject>	resolveObjectList(Value varObjectContainer) Resolves a list of all objects contained by an object container.
TPlayer	resolvePlayer(java.lang.String playerIdentity) Resolves a player.
TPlayerContext	resolvePlayerContext(java.lang.String playerIdentity) Resolves a player context.
TRoom	resolveRoom(java.lang.String roomIdentity) Resolves a room.
TRoomContext	resolveRoomContext(java.lang.String roomIdentity) Resolves a room context.
TWorld	resolveWorld() Resolves a world (or THE world).
TWorldContext	resolveWorldContext() Resolves a world context.
void	writeBytes(java.io.OutputStream out) Exports this object to bytes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tameif.tame.lang.Saveable

fromBytes, toBytes

Constructor Detail

TAMEModuleContext

public TAMEModuleContext(TAMEModule module)

Creates a new module context.

Parameters:

module - the module to create the context for.

Method Detail

getModule

public TAMEModule getModule()

Gets the encapsulated module.

Returns:

the module.

getRandom

public java.util.Random getRandom()

Gets the context random number generator.

Returns:

the current random generator.

getOperationRunawayMax

public long getOperationRunawayMax()

Returns:

the operation runaway detection limit.

getFunctionDepthMax

public long getFunctionDepthMax()

Returns:

the function depth detection limit.

getPlayerContexts

public java.util.Collection<TPlayerContext> getPlayerContexts()

Get the player contexts.

Returns:

the context map.

getRoomContexts

public java.util.Collection<TRoomContext> getRoomContexts()

Get the room contexts.

Returns:

the context map.

getObjectContexts

public java.util.Collection<TObjectContext> getObjectContexts()

Get the object contexts.

Returns:

the context map.

getContainerContexts

public java.util.Collection<TContainerContext> getContainerContexts()

Get the container contexts.

Returns:

the context map.

getAvailableActionNames

public java.lang.String[] getAvailableActionNames()

Reflection method - get available action names according to current context and filtered by a prefix.

Returns:

the valid action names that can be.

getWorldContext

public TWorldContext getWorldContext()

Gets this module's world context.

Returns:

the world context.

getPlayerContext

public TPlayerContext getPlayerContext(TPlayer player)

Gets a player context by player.

Parameters:

player - the player to use for the lookup.

Returns:

the matching context.

getRoomContext

public TRoomContext getRoomContext(TRoom room)

Gets a room context by room.

Parameters:

room - the room to use for the lookup.

Returns:

the matching context.

getObjectContext

public TObjectContext getObjectContext(TObject object)

Gets an object context by object.

Parameters:

object - the object to use for the lookup.

Returns:

the matching context.

getContainerContext

public TContainerContext getContainerContext(TContainer container)

Gets an container context by container.

Parameters:

container - the container to use for the lookup.

Returns:

the matching context.

getContextByIdentity

public TElementContext<?> getContextByIdentity(java.lang.String identity)

Gets an element context by element name.

Parameters:

identity - the identity to use for the lookup.

Returns:

the matching context, or null if no match.

getPlayerContextByIdentity

public TPlayerContext getPlayerContextByIdentity(java.lang.String identity)

Gets a player context by player name.

Parameters:

identity - the identity to use for the lookup.

Returns:

the matching context.

getRoomContextByIdentity

public TRoomContext getRoomContextByIdentity(java.lang.String identity)

Gets a room context by room name.

Parameters:

identity - the identity to use for the lookup.

Returns:

the matching context.

getObjectContextByIdentity

public TObjectContext getObjectContextByIdentity(java.lang.String identity)

Gets an object context by object name.

Parameters:

identity - the identity to use for the lookup.

Returns:

the matching context.

getContainerContextByIdentity

public TContainerContext getContainerContextByIdentity(java.lang.String identity)

Gets a container context by object name.

Parameters:

identity - the identity to use for the lookup.

Returns:

the matching context.

getCurrentPlayer

public TPlayer getCurrentPlayer()

Gets the current player.

Returns:

the current player, or null if not set.

getCurrentPlayerContext

public TPlayerContext getCurrentPlayerContext()

Gets the current player context.

Returns:

the current player context, or null if not set.

getCurrentRoom

public TRoom getCurrentRoom()

Gets the current room.

Returns:

the current room, or null if not set.

getCurrentRoomContext

public TRoomContext getCurrentRoomContext()

Gets the current room context.

Returns:

the current room context, or null if not set.

getOwnershipMap

public TOwnershipMap getOwnershipMap()

Returns:

the ownership map for this context.

getAccessibleObjectsByName

public int getAccessibleObjectsByName(java.lang.String name,
                                      TObject[] outputArray,
                                      int arrayOffset)

Returns all objects in the accessible area by an object name read from the interpreter. The output stops if the size of the output array is reached.

Parameters:

name - the name from the interpreter.

outputArray - the output vector of found objects.

arrayOffset - the starting offset into the array to put them.

Returns:

the amount of objects found.

resolveAction

public TAction resolveAction(java.lang.String actionIdentity)

Resolves an action by its identity.

Parameters:

actionIdentity - the action identity.

Returns:

the element resolved.

resolveElement

public TElement resolveElement(Value varElement)
                        throws ErrorInterrupt

Resolves an element by a value.

Parameters:

varElement - the value to resolve via module context.

Returns:

the corresponding element, or null if the value does not refer to an object container.

Throws:

ErrorInterrupt - if a major error occurs.

resolveElementContext

public TElementContext<?> resolveElementContext(Value varElement)
                                         throws ErrorInterrupt

Resolves an element context by a value.

Parameters:

varElement - the value to resolve via module context.

Returns:

the corresponding element context, or null if the value does not refer to an object container.

Throws:

ErrorInterrupt - if a major error occurs.

resolveObjectList

public java.lang.Iterable<TObject> resolveObjectList(Value varObjectContainer)
                                              throws ErrorInterrupt

Resolves a list of all objects contained by an object container.

Parameters:

varObjectContainer - the value to resolve via module context.

Returns:

an iterable list of objects, or null if the value does not refer to an object container.

Throws:

ErrorInterrupt - if a major error occurs.

resolveWorldContext

public TWorldContext resolveWorldContext()

Resolves a world context.

Returns:

the context resolved.

resolveWorld

public TWorld resolveWorld()

Resolves a world (or THE world).

Returns:

the element resolved.

resolvePlayerContext

public TPlayerContext resolvePlayerContext(java.lang.String playerIdentity)

Resolves a player context.

Parameters:

playerIdentity - the player identity.

Returns:

the context resolved.

Throws:

ModuleExecutionException - if the non-current player identity cannot be found, or if no current player when requested.

resolvePlayer

public TPlayer resolvePlayer(java.lang.String playerIdentity)

Resolves a player.

Parameters:

playerIdentity - the player identity.

Returns:

the context resolved.

Throws:

ModuleExecutionException - if the non-current player identity cannot be found, or if no current player if requesed.

resolveRoomContext

public TRoomContext resolveRoomContext(java.lang.String roomIdentity)

Resolves a room context.

Parameters:

roomIdentity - the roomIdentity.

Returns:

the context resolved.

Throws:

ModuleExecutionException - if the non-current room identity cannot be found, or if no current room if requested.

resolveRoom

public TRoom resolveRoom(java.lang.String roomIdentity)

Resolves a room.

Parameters:

roomIdentity - the roomIdentity.

Returns:

the context resolved.

Throws:

ModuleExecutionException - if the non-current room identity cannot be found, or if not current room if requested.

resolveObjectContext

public TObjectContext resolveObjectContext(java.lang.String objectIdentity)

Resolves an object context.

Parameters:

objectIdentity - the object identity.

Returns:

the context resolved.

Throws:

ModuleExecutionException - if object not found.

resolveObject

public TObject resolveObject(java.lang.String objectIdentity)

Resolves an object.

Parameters:

objectIdentity - the object identity.

Returns:

the context resolved.

Throws:

ModuleExecutionException - if object not found.

resolveContainerContext

public TContainerContext resolveContainerContext(java.lang.String containerIdentity)

Resolves a container context.

Parameters:

containerIdentity - the container identity.

Returns:

the context resolved.

Throws:

ModuleExecutionException - if container not found.

resolveContainer

public TContainer resolveContainer(java.lang.String containerIdentity)

Resolves a container.

Parameters:

containerIdentity - the object identity.

Returns:

the context resolved.

Throws:

ModuleExecutionException - if object not found.

writeBytes

public void writeBytes(java.io.OutputStream out)
                throws java.io.IOException

Description copied from interface: Saveable

Exports this object to bytes.

Specified by:

writeBytes in interface Saveable

Parameters:

out - the output stream to write to.

Throws:

java.io.IOException - if a write problem occurs.

readBytes

public void readBytes(java.io.InputStream in)
               throws java.io.IOException

Description copied from interface: Saveable

Imports this object from bytes.

Specified by:

readBytes in interface Saveable

Parameters:

in - the input stream to read from.

Throws:

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