com.artemis

Class EntitySystem

java.lang.Object

com.artemis.EntitySystem

All Implemented Interfaces:

EntityObserver

Direct Known Subclasses:

DelayedEntityProcessingSystem, EntityProcessingSystem, IntervalEntitySystem, VoidEntitySystem

public abstract class EntitySystem
extends Object
implements EntityObserver

The most raw entity system.

It should not typically be used, but you can create your own entity system handling by extending this.

Author:

Arni Arent

Field Summary

Fields

Modifier and Type	Field and Description
protected World	world The world this system belongs to.

Constructor Summary

Constructors

Constructor and Description
EntitySystem(Aspect aspect) Creates an entity system that uses the specified aspect as a matcher against entities.

Method Summary

Methods

Modifier and Type	Method and Description
void	added(Entity e) Call when an entity interesting to the system is added to the world.
void	added(ImmutableBag<Entity> entities)
protected void	begin() Called before processing of entities begins.
void	changed(Entity e) Call when an entity interesting to the system has changed in the world.
void	changed(ImmutableBag<Entity> entities)
protected void	check(Entity e) Will check if the entity is of interest to this system.
protected boolean	checkProcessing() Check if the system should be processed.
void	deleted(Entity e) Call when an entity interesting to the system was deleted from the world.
void	deleted(ImmutableBag<Entity> entities)
void	disabled(Entity e) Call when an entity interesting to the system was disabled.
protected void	dispose() see World.dispose()
void	enabled(Entity e) Call when an entity interesting to the system was (re)enabled.
protected void	end() Called after the processing of entities ends.
ImmutableBag<Entity>	getActives() Get all entities being processed by this system.
protected void	initialize() Override to implement code that gets executed when systems are initialized.
protected void	inserted(Entity e) Called if the system has received a entity it is interested in, e.g created or a component was added to it.
boolean	isEnabled() Returns true if the system is enabled.
boolean	isPassive() Check if this system is passive.
void	process() Process all entities this system is interested in.
protected abstract void	processEntities(ImmutableBag<Entity> entities) Any implementing entity system must implement this method and the logic to process the given entities of the system.
protected void	removed(Entity e) Called if a entity was removed from this system, e.g deleted or had one of it's components removed.
void	setEnabled(boolean enabled) Enabled systems are run during process().
protected void	setPassive(boolean passive) Set if the system is passive or not.
protected void	setWorld(World world) Set the world this manager works on.

Methods inherited from class java.lang.Object

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

Field Detail

world

protected World world

The world this system belongs to.

Constructor Detail

EntitySystem

public EntitySystem(Aspect aspect)

Creates an entity system that uses the specified aspect as a matcher against entities.

Parameters:

aspect - to match against entities

Method Detail

begin

protected void begin()

Called before processing of entities begins.

Nota Bene: Any entities created in this method won't become active until the next system starts processing or when a new processing rounds beings, whichever comes first.

process

public final void process()

Process all entities this system is interested in.

end

protected void end()

Called after the processing of entities ends.

processEntities

protected abstract void processEntities(ImmutableBag<Entity> entities)

Any implementing entity system must implement this method and the logic to process the given entities of the system.

Parameters:

entities - the entities this system contains.

checkProcessing

protected boolean checkProcessing()

Check if the system should be processed.

Returns:

true if the system should be processed, false if not.

initialize

protected void initialize()

Override to implement code that gets executed when systems are initialized.

inserted

protected void inserted(Entity e)

Called if the system has received a entity it is interested in, e.g created or a component was added to it.

Parameters:

e - the entity that was added to this system

removed

protected void removed(Entity e)

Called if a entity was removed from this system, e.g deleted or had one of it's components removed.

Parameters:

e - the entity that was removed from this system

isEnabled

public boolean isEnabled()

Returns true if the system is enabled.

Returns:

true if enabled, otherwise false

setEnabled

public void setEnabled(boolean enabled)

Enabled systems are run during process().

Systems are enabled by default.

Parameters:

enabled - system will not run when set to false

check

protected final void check(Entity e)

Will check if the entity is of interest to this system.

Parameters:

e - entity to check

added

public final void added(Entity e)

Call when an entity interesting to the system is added to the world.

Checks if the system is interested in the added entity, if so, will insert it in to the system.

Specified by:

added in interface EntityObserver

Parameters:

e - the added entity

added

public final void added(ImmutableBag<Entity> entities)

Specified by:

added in interface EntityObserver

changed

public final void changed(ImmutableBag<Entity> entities)

Specified by:

changed in interface EntityObserver

deleted

public final void deleted(ImmutableBag<Entity> entities)

Specified by:

deleted in interface EntityObserver

changed

public final void changed(Entity e)

Call when an entity interesting to the system has changed in the world.

Checks if the system is still interested after the entity has changed, e.g a component was removed.

Specified by:

changed in interface EntityObserver

Parameters:

e - the changed entity

deleted

public final void deleted(Entity e)

Call when an entity interesting to the system was deleted from the world.

If the deleted entity is in this system, it will be removed.

Specified by:

deleted in interface EntityObserver

Parameters:

e - the deleted entity

disabled

public final void disabled(Entity e)

Call when an entity interesting to the system was disabled.

If the disabled entity is in this system it will be removed

Specified by:

disabled in interface EntityObserver

Parameters:

e - the disabled entity

enabled

public final void enabled(Entity e)

Call when an entity interesting to the system was (re)enabled.

If the enabled entity is of interest, in will be (re)inserted.

Specified by:

enabled in interface EntityObserver

Parameters:

e - the (re)enabled entity

setWorld

protected final void setWorld(World world)

Set the world this manager works on.

Parameters:

world - the world to set

isPassive

public boolean isPassive()

Check if this system is passive.

A passive system will not process when World.process() is called.

Returns:

true if the system is passive

setPassive

protected void setPassive(boolean passive)

Set if the system is passive or not.

A passive system will not process when World.process() is called.

Parameters:

passive - true if passive, false if not

getActives

public ImmutableBag<Entity> getActives()

Get all entities being processed by this system.

Returns:

a bag containing all active entities of the system

dispose

protected void dispose()

see World.dispose()