com.artemis.managers

Class TagManager

java.lang.Object

com.artemis.BaseSystem

com.artemis.managers.TagManager

public class TagManager
extends BaseSystem

If you need to tag any entity, use this.

A typical usage would be to tag entities such as "PLAYER", "BOSS" or something that is very unique.

Author:

Arni Arent

Field Summary

Fields inherited from class com.artemis.BaseSystem

world

Constructor Summary

Constructors

Constructor and Description
TagManager() Creates a new TagManager.

Method Summary

Modifier and Type	Method and Description
Entity	getEntity(String tag) Get the entity tagged with the given tag.
int	getEntityId(String tag)
Collection<String>	getRegisteredTags() Get all used tags.
String	getTag(Entity entity) Get the tag the given entity is tagged with.
String	getTag(int entityId)
protected void	initialize() Override to implement code that gets executed when systems are initialized.
boolean	isRegistered(String tag) Check if a tag is in use.
protected void	processSystem() Process the system.
void	register(String tag, Entity e) Tag an entity.
void	register(String tag, int entityId)
void	unregister(String tag) Remove a tag from the entity being tagged with it.

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

TagManager

public TagManager()

Creates a new TagManager.

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

register

public void register(String tag,
                     Entity e)

Tag an entity.

Each tag can only be given to one entity at a time.

Parameters:

tag - the tag

e - the entity to get tagged

register

public void register(String tag,
                     int entityId)

unregister

public void unregister(String tag)

Remove a tag from the entity being tagged with it.

Parameters:

tag - the tag to remove

isRegistered

public boolean isRegistered(String tag)

Check if a tag is in use.

Parameters:

tag - the tag to check

Returns:

true if the tag is in use

getEntity

public Entity getEntity(String tag)

Get the entity tagged with the given tag.

Parameters:

tag - the tag the entity is tagged with

Returns:

the tagged entity

getEntityId

public int getEntityId(String tag)

getTag

public String getTag(Entity entity)

Get the tag the given entity is tagged with.

Parameters:

entity - the entity

Returns:

the tag

getTag

public String getTag(int entityId)

getRegisteredTags

public Collection<String> getRegisteredTags()

Get all used tags.

Returns:

all used tags as collection