com.artemis.managers

Class TagManager

java.lang.Object

com.artemis.Manager

com.artemis.managers.TagManager

All Implemented Interfaces:

EntityObserver

public class TagManager
extends Manager

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.Manager

world

Constructor Summary

Constructors

Constructor and Description
TagManager() Creates a new TagManager.

Method Summary

Methods

Modifier and Type	Method and Description
void	deleted(Entity e) If the entity gets deleted, remove the tag used by it.
Entity	getEntity(String tag) Get the entity tagged with the given tag.
Collection<String>	getRegisteredTags() Get all used tags.
protected void	initialize() Called when the world initializes.
boolean	isRegistered(String tag) Check if a tag is in use.
void	register(String tag, Entity e) Tag an entity.
void	unregister(String tag) Remove a tag from the entity being tagged with it.

Methods inherited from class com.artemis.Manager

added, added, changed, changed, deleted, disabled, dispose, enabled, getWorld, 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

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

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

getRegisteredTags

public Collection<String> getRegisteredTags()

Get all used tags.

Returns:

all used tags as collection

deleted

public void deleted(Entity e)

If the entity gets deleted, remove the tag used by it.

Specified by:

deleted in interface EntityObserver

Overrides:

deleted in class Manager

Parameters:

e - the deleted entity

initialize

protected void initialize()

Description copied from class: Manager

Called when the world initializes.

Override to implement custom behavior at initialization.

Overrides:

initialize in class Manager