com.artemis.managers

Class GroupManager

java.lang.Object

com.artemis.BaseSystem

com.artemis.managers.GroupManager

public class GroupManager
extends BaseSystem

If you need to group your entities together, e.g tanks going into "units" group or explosions into "effects", then use this manager.

You must retrieve it using world instance.

A entity can be assigned to more than one group.

Author:

Arni Arent

Field Summary

Fields inherited from class com.artemis.BaseSystem

world

Constructor Summary

Constructors

Constructor and Description
GroupManager() Creates a new GroupManager instance.

Method Summary

Modifier and Type	Method and Description
void	add(Entity e, String group) Set the group of the entity.
ImmutableBag<Entity>	getEntities(String group) Get all entities that belong to the provided group.
ImmutableBag<String>	getGroups(Entity e) Get all groups the entity belongs to.
protected void	initialize() Override to implement code that gets executed when systems are initialized.
boolean	isInAnyGroup(Entity e) Checks if the entity belongs to any group.
boolean	isInGroup(Entity e, String group) Check if the entity is in the supplied group.
protected void	processSystem() Process the system.
void	remove(Entity e, String group) Remove the entity from the specified group.
void	removeFromAllGroups(Entity e) Remove the entity from all groups.

Methods inherited from class com.artemis.BaseSystem

begin, checkProcessing, dispose, end, getWorld, isEnabled, process, setEnabled, setWorld

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupManager

public GroupManager()

Creates a new GroupManager instance.

Method Detail

processSystem

protected void processSystem()

Description copied from class: BaseSystem

Process the system.

Specified by:

processSystem in class BaseSystem

initialize

protected void initialize()

Description copied from class: BaseSystem

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.

Overrides:

initialize in class BaseSystem

add

public void add(Entity e,
                String group)

Set the group of the entity.

Parameters:

group - group to add the entity into

e - entity to add into the group

remove

public void remove(Entity e,
                   String group)

Remove the entity from the specified group.

Parameters:

e - entity to remove from group

group - group to remove the entity from

removeFromAllGroups

public void removeFromAllGroups(Entity e)

Remove the entity from all groups.

Parameters:

e - the entity to remove

getEntities

public ImmutableBag<Entity> getEntities(String group)

Get all entities that belong to the provided group.

Parameters:

group - name of the group

Returns:

read-only bag of entities belonging to the group

getGroups

public ImmutableBag<String> getGroups(Entity e)

Get all groups the entity belongs to. An empty Bag is returned if the entity doesn't belong to any groups.

Parameters:

e - the entity

Returns:

the groups the entity belongs to.

isInAnyGroup

public boolean isInAnyGroup(Entity e)

Checks if the entity belongs to any group.

Parameters:

e - the entity to check

Returns:

true. if it is in any group, false if none

isInGroup

public boolean isInGroup(Entity e,
                         String group)

Check if the entity is in the supplied group.

Parameters:

group - the group to check in

e - the entity to check for

Returns:

true if the entity is in the supplied group, false if not