com.kauridev.lunarbase.GroupManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lunar-base Show documentation
Lunar Base is a simple game framework written in Java. It is written using an entity-component-system architecture.
The newest version!
/*
 * This file is part of the lunar-base package.
 *
 * Copyright (c) 2014 Eric Fritz
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
 * and associated documentation files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or
 * substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package com.kauridev.lunarbase;

import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;

/**
 * A manager that handles associations between entities and groups. Entities can be grouped into
 * similar units by a string identifier, which may be useful for a system that operates on every
 * "enemy" entity or every "particle" entity. Entities may belong to more than one group.
 *
 * @author Eric Fritz
 */
public class GroupManager implements EntityRemovedEventListener
{
	/**
	 * The event manager.
	 */
	private EventManager eventManager;

	/**
	 * A map of groups indexed by entity.
	 */
	private Map> groups = new HashMap<>();

	/**
	 * Creates a new GroupManager.
	 *
	 * @param eventManager The event manager.
	 */
	public GroupManager(EventManager eventManager) {
		this.eventManager = eventManager;

		eventManager.addListener(EntityRemovedEvent.class, this);
	}

	/**
	 * Returns true if the entity belongs to the specified group.
	 *
	 * @param entity The entity.
	 * @param group  The group.
	 *
	 * @return true if the entity belongs to the specified group.
	 */
	public boolean hasGroup(Entity entity, String group) {
		return getAllGroups(entity).contains(group);
	}

	/**
	 * Adds a group associated with an entity. This method fires the {@link EntityChangedEvent}
	 * event.
	 *
	 * @param entity The entity.
	 * @param group  The group.
	 */
	public void addGroup(Entity entity, String group) {
		getAllGroups(entity).add(group);
		eventManager.dispatch(new EntityChangedEvent(entity));
	}

	/**
	 * Removes a group associated with an entity. This method fires the {@link EntityChangedEvent}
	 * event.
	 *
	 * @param entity The entity.
	 * @param group  The group.
	 */
	public void removeGroup(Entity entity, String group) {
		getAllGroups(entity).remove(group);
		eventManager.dispatch(new EntityChangedEvent(entity));
	}

	@Override
	public EntityRemovedEvent onEntityRemoved(EntityRemovedEvent event) {
		getAllGroups(event.getEntity()).clear();
		return event;
	}

	/**
	 * Returns a list of groups associated with the entity.
	 *
	 * @param entity The entity.
	 *
	 * @return A list of groups.
	 */
	private Set getAllGroups(Entity entity) {
		if (groups.get(entity.getId()) == null) {
			groups.put(entity.getId(), new LinkedHashSet());
		}

		return groups.get(entity.getId());
	}
}