api

Interface ILevel

All Superinterfaces:

ISerializable, java.io.Serializable

All Known Subinterfaces:

ISystem

All Known Implementing Classes:

BasicRMIServer, Level

public interface ILevel
extends ISerializable

The interface for an Level, which holds all the entities.

Author:

Rhondu Smithwick, Tom Wu

Method Summary

Modifier and Type	Method and Description
default java.util.List<IEntity>	addEntities(IEntity... entities) Add array/varargs of entities.
default java.util.List<IEntity>	addEntities(java.util.List<IEntity> entities) Add list of entities.
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
default void	clear() Annihilate everything as our good friend Tom puts it.
default boolean	containsEntity(IEntity entity) Check if system contains this entity.
boolean	containsID(java.lang.String id) Check whether this system contains an entity with provided ID.
IEntity	createEntity() Creates an entity.
default IEntity	createEntityFromDefault(java.lang.String defaultFileName) Create an entity from a file of components.
default IEntity	createEntityFromLoad(java.lang.String fileName) Created an entity from a file containing an entity.
default java.util.List<IComponent>	getAllComponents() Get all the components in this entity system.
default <T extends IComponent> java.util.Collection<T>	getAllComponentsOfType(java.lang.Class<T> componentType) Get all the components of a type.
java.util.Collection<IEntity>	getAllEntities() Get all entites in the system.
default java.util.Collection<java.lang.String>	getAllIDS() Get all IDs in this system.
default java.util.Collection<java.lang.String>	getAllNames() Get all entity names in this system.
default <T extends IComponent> java.util.List<T>	getComponentOfEntity(java.lang.String id, java.lang.Class<T> componentType) Get component using an id
default <T extends IComponent> java.util.Set<IEntity>	getEntitiesWithComponent(java.lang.Class<T> componentType) Get all the entities with this component Type.
default java.util.Set<IEntity>	getEntitiesWithComponents(java.lang.Class<? extends IComponent>... componentClasses) Get entities with all these components (array or varargs).
default java.util.Set<IEntity>	getEntitiesWithComponents(java.util.List<java.lang.Class<? extends IComponent>> componentClasses) Get entities with all these components (list).
default java.util.List<IEntity>	getEntitiesWithName(java.lang.String name) Get all the entities with provided name.
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.
default void	removeAllBindingsFromComponents() Remove all the Bindings from all the components in this Entity 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 interface api.ISerializable

clone, serialize, serializeToString

Method Detail

setName

void setName(java.lang.String name)

Names the entity System

Parameters:

name - with the name

getName

java.lang.String getName()

Gets the Entity Systems name

Returns:

string entity system name

getMetadata

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

Gets the metadata about this level

Returns:

Metadata in the form of a map

addMetadata

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

Add a piece of metadata to this level

Parameters:

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

value - the field value

setMetadata

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

Sets the metadata

Parameters:

metadata -

init

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

update

void update(double dt)

getEventSystem

IEventSystem getEventSystem()

Returns:

event system

getPhysicsEngine

IPhysicsEngine getPhysicsEngine()

Returns:

physics engine

getEventSystemPath

java.lang.String getEventSystemPath()

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

Returns:

string of event system file path

setEventSystemPath

void setEventSystemPath(java.lang.String eventSystemPath)

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

Parameters:

eventSystemPath - string of event system file path

createEntity

IEntity createEntity()

Creates an entity.

Returns:

the entity created

addEntity

IEntity addEntity(IEntity entity)

Adds an entity.

Parameters:

entity - the entity to be added

Returns:

the added entity

getEntity

IEntity getEntity(java.lang.String id)

Get an entity based on its id.

Parameters:

id - of the entity

Returns:

entity with provided id

getAllEntities

java.util.Collection<IEntity> getAllEntities()

Get all entites in the system.

Returns:

collection of entities

getAllComponents

default java.util.List<IComponent> getAllComponents()

Get all the components in this entity system.

Returns:

all the components in this entity system

getAllIDS

default java.util.Collection<java.lang.String> getAllIDS()

Get all IDs in this system.

Returns:

all the IDs in this system

clear

default void clear()

Annihilate everything as our good friend Tom puts it.

See Also:

getAllIDS(), removeEntity(String)

containsID

boolean containsID(java.lang.String id)

Check whether this system contains an entity with provided ID.

Parameters:

id - to check

Returns:

true if system contains this entity

containsEntity

default boolean containsEntity(IEntity entity)

Check if system contains this entity.

Parameters:

entity - to check

Returns:

true if system contains this entity

See Also:

containsID(String), IEntity.getID()

addEntities

default java.util.List<IEntity> addEntities(java.util.List<IEntity> entities)

Add list of entities.

Parameters:

entities - list of entities to add

Returns:

list of entities

See Also:

addEntity(IEntity)

addEntities

default java.util.List<IEntity> addEntities(IEntity... entities)

Add array/varargs of entities.

Parameters:

entities - to add

Returns:

list of entities

See Also:

addEntities(List)

removeEntity

boolean removeEntity(java.lang.String id)

Remove entity with this ID.

Parameters:

id - to remove

Returns:

true if removed

isEmpty

boolean isEmpty()

Checks if any entities are in this system.

Returns:

true if system contains no entities

createEntityFromLoad

default IEntity createEntityFromLoad(java.lang.String fileName)

Created an entity from a file containing an entity.

Parameters:

fileName - of file with the entity

Returns:

the entity loaded

See Also:

IDataReader.readSingleFromFile(String)

createEntityFromDefault

default IEntity createEntityFromDefault(java.lang.String defaultFileName)

Create an entity from a file of components.

Parameters:

defaultFileName - of the file

Returns:

entity with components in this file

See Also:

IDataReader.readFromFile(String)

getAllComponentsOfType

default <T extends IComponent> java.util.Collection<T> getAllComponentsOfType(java.lang.Class<T> componentType)

Get all the components of a type.

Type Parameters:

T - the type of component

Parameters:

componentType - class to get

Returns:

all the components of the type

See Also:

IEntity.getComponentList(Class)

getEntitiesWithComponent

default <T extends IComponent> java.util.Set<IEntity> getEntitiesWithComponent(java.lang.Class<T> componentType)

Get all the entities with this component Type.

Type Parameters:

T - the type of component

Parameters:

componentType - the component type

Returns:

all the entities with this component type

See Also:

IEntity.hasComponent(Class)

getEntitiesWithComponents

default java.util.Set<IEntity> getEntitiesWithComponents(java.util.List<java.lang.Class<? extends IComponent>> componentClasses)

Get entities with all these components (list).

Parameters:

componentClasses - components to check

Returns:

all entities with these components

See Also:

IEntity.hasComponents(List)

getEntitiesWithComponents

default java.util.Set<IEntity> getEntitiesWithComponents(java.lang.Class<? extends IComponent>... componentClasses)

Get entities with all these components (array or varargs).

Parameters:

componentClasses - components to check

Returns:

all entities with these components

See Also:

getEntitiesWithComponents(List)

getComponentOfEntity

default <T extends IComponent> java.util.List<T> getComponentOfEntity(java.lang.String id,
                                                                      java.lang.Class<T> componentType)

Get component using an id

Type Parameters:

T - type of component

Parameters:

id - of the entity

componentType - the type of component

Returns:

component with type T of entity with id id

See Also:

IEntity.getComponentList(Class)

getEntitiesWithName

default java.util.List<IEntity> getEntitiesWithName(java.lang.String name)

Get all the entities with provided name.

Parameters:

name - provided name

Returns:

list of entities with this name

getAllNames

default java.util.Collection<java.lang.String> getAllNames()

Get all entity names in this system.

Returns:

all names in this system

removeAllBindingsFromComponents

default void removeAllBindingsFromComponents()

Remove all the Bindings from all the components in this Entity System.