model.entity

Class Level

java.lang.Object

model.entity.Level

All Implemented Interfaces:

ILevel, ISerializable, java.io.Serializable

public class Level
extends java.lang.Object
implements ILevel

Implementation of a Level. This implementation is focused on the IDs. It spawns entities based on the next available ID and adds them to the system.

Author:

Rhondu Smithwick

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Level()
Level(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
IEntity	addEntity(IEntity entity) Adds an entity.
void	addMetadata(java.lang.String key, java.lang.String value) Add a piece of metadata to this level
boolean	containsID(java.lang.String id) Check whether this system contains an entity with provided ID.
IEntity	createEntity() Creates an entity.
java.util.Collection<IEntity>	getAllEntities() Get all entites in the system.
IEntity	getEntity(java.lang.String id) Get an entity based on its id.
IEventSystem	getEventSystem()
java.lang.String	getEventSystemPath() Gets the Entity System's event system's XML path
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Gets the metadata about this level
java.lang.String	getName() Gets the Entity Systems name
IPhysicsEngine	getPhysicsEngine()
java.lang.String	init(groovy.lang.GroovyShell shell, ISystemManager game)
boolean	isEmpty() Checks if any entities are in this system.
boolean	removeEntity(java.lang.String id) Remove entity with this ID.
void	setEventSystemPath(java.lang.String eventSystemPath) Sets the Entity System's event system's XML path
void	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata) Sets the metadata
void	setName(java.lang.String name) Names the entity System
void	update(double dt)

Methods inherited from class java.lang.Object

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

Methods inherited from interface api.ILevel

addEntities, addEntities, clear, containsEntity, createEntityFromDefault, createEntityFromLoad, getAllComponents, getAllComponentsOfType, getAllIDS, getAllNames, getComponentOfEntity, getEntitiesWithComponent, getEntitiesWithComponents, getEntitiesWithComponents, getEntitiesWithName, removeAllBindingsFromComponents

Methods inherited from interface api.ISerializable

clone, serialize, serializeToString

Constructor Detail

Level

public Level()

Level

public Level(java.lang.String name)

Method Detail

setName

public void setName(java.lang.String name)

Description copied from interface: ILevel

Names the entity System

Specified by:

setName in interface ILevel

Parameters:

name - with the name

getName

public java.lang.String getName()

Description copied from interface: ILevel

Gets the Entity Systems name

Specified by:

getName in interface ILevel

Returns:

string entity system name

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Description copied from interface: ILevel

Gets the metadata about this level

Specified by:

getMetadata in interface ILevel

Returns:

Metadata in the form of a map

setMetadata

public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

Description copied from interface: ILevel

Sets the metadata

Specified by:

setMetadata in interface ILevel

addMetadata

public void addMetadata(java.lang.String key,
                        java.lang.String value)

Description copied from interface: ILevel

Add a piece of metadata to this level

Specified by:

addMetadata in interface ILevel

Parameters:

key - the field name (e.g. "Description")

value - the field value

init

public java.lang.String init(groovy.lang.GroovyShell shell,
                             ISystemManager game)

Specified by:

init in interface ILevel

update

public void update(double dt)

Specified by:

update in interface ILevel

getEventSystem

public IEventSystem getEventSystem()

Specified by:

getEventSystem in interface ILevel

Returns:

event system

getPhysicsEngine

public IPhysicsEngine getPhysicsEngine()

Specified by:

getPhysicsEngine in interface ILevel

Returns:

physics engine

getEventSystemPath

public java.lang.String getEventSystemPath()

Description copied from interface: ILevel

Gets the Entity System's event system's XML path

Specified by:

getEventSystemPath in interface ILevel

Returns:

string of event system file path

setEventSystemPath

public void setEventSystemPath(java.lang.String eventSystemPath)

Description copied from interface: ILevel

Sets the Entity System's event system's XML path

Specified by:

setEventSystemPath in interface ILevel

Parameters:

eventSystemPath - string of event system file path

createEntity

public IEntity createEntity()

Description copied from interface: ILevel

Creates an entity.

Specified by:

createEntity in interface ILevel

Returns:

the entity created

addEntity

public IEntity addEntity(IEntity entity)

Description copied from interface: ILevel

Adds an entity.

Specified by:

addEntity in interface ILevel

Parameters:

entity - the entity to be added

Returns:

the added entity

getEntity

public IEntity getEntity(java.lang.String id)

Description copied from interface: ILevel

Get an entity based on its id.

Specified by:

getEntity in interface ILevel

Parameters:

id - of the entity

Returns:

entity with provided id

getAllEntities

public java.util.Collection<IEntity> getAllEntities()

Description copied from interface: ILevel

Get all entites in the system.

Specified by:

getAllEntities in interface ILevel

Returns:

collection of entities

containsID

public boolean containsID(java.lang.String id)

Description copied from interface: ILevel

Check whether this system contains an entity with provided ID.

Specified by:

containsID in interface ILevel

Parameters:

id - to check

Returns:

true if system contains this entity

removeEntity

public boolean removeEntity(java.lang.String id)

Description copied from interface: ILevel

Remove entity with this ID.

Specified by:

removeEntity in interface ILevel

Parameters:

id - to remove

Returns:

true if removed

isEmpty

public boolean isEmpty()

Description copied from interface: ILevel

Checks if any entities are in this system.

Specified by:

isEmpty in interface ILevel

Returns:

true if system contains no entities