com.artemis

Class BaseSystem

java.lang.Object

com.artemis.BaseSystem

Direct Known Subclasses:

AspectSubscriptionManager, BaseEntitySystem, ComponentManager, EntityManager, GroupManager, Manager, TagManager

public abstract class BaseSystem
extends Object

Most basic system. Upon calling world.process(), your systems are processed in sequence. Flow: initialize() - Initialize your system, on top of the dependency injection. begin() - Called before the entities are processed. processSystem() - Called once per cycle. end() - Called after the entities have been processed.

See Also:

Wire

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
BaseSystem()

Method Summary

Modifier and Type	Method and Description
protected void	begin() Called before system processing begins.
protected boolean	checkProcessing() Does the system desire processing.
protected void	dispose() see World.dispose()
protected void	end() Called after the systems has finished processing.
protected World	getWorld() Get the world associated with the manager.
protected void	initialize() Override to implement code that gets executed when systems are initialized.
boolean	isEnabled() Check if the system is enabled.
void	process() Process system.
protected abstract void	processSystem() Process the system.
void	setEnabled(boolean enabled) Enabled systems run during process().
protected void	setWorld(World world) Set the world this system works on.

Methods inherited from class java.lang.Object

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

Field Detail

world

@SkipWire
protected World world

The world this system belongs to.

Constructor Detail

BaseSystem

public BaseSystem()

Method Detail

begin

protected void begin()

Called before system processing 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 begins, whichever comes first.

process

public final void process()

Process system. Does nothing if checkProcessing() is false or the system is disabled.

See Also:

InvocationStrategy

processSystem

protected abstract void processSystem()

Process the system.

end

protected void end()

Called after the systems has finished processing.

checkProcessing

protected boolean checkProcessing()

Does the system desire processing. Useful when the system is enabled, but only occasionally needs to process. This only affects processing, and does not affect events or subscription lists.

Returns:

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

See Also:

both must be true before the system will process.

initialize

protected void initialize()

Override to implement code that gets executed when systems are initialized. Note that artemis native types like systems, factories and component mappers are automatically injected by artemis.

isEnabled

public boolean isEnabled()

Check if the system is enabled.

Returns:

true if enabled, otherwise false

setEnabled

public void setEnabled(boolean enabled)

Enabled systems run during process(). This only affects processing, and does not affect events or subscription lists. Systems are enabled by default.

Parameters:

enabled - system will not run when set to false

See Also:

both must be true before the system will process.

setWorld

protected void setWorld(World world)

Set the world this system works on.

Parameters:

world - the world to set

getWorld

protected World getWorld()

Get the world associated with the manager.

Returns:

the associated world

dispose

protected void dispose()

see World.dispose()