com.kauridev.lunarbase.ComponentMapper 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;

/**
 * A mapper which retrieves a specific component associated with an entity.
 *
 * @author Eric Fritz
 */
public class ComponentMapper
{
	/**
	 * The component manager.
	 */
	private ComponentManager manager;

	/**
	 * The target component type.
	 */
	private Class type;

	/**
	 * Creates a new ComponentMapper.
	 *
	 * @param componentManager The component manager.
	 * @param type             The target component type.
	 */
	public ComponentMapper(ComponentManager componentManager, Class type) {
		this.manager = componentManager;
		this.type = type;
	}

	/**
	 * Returns the component of the target type associated with an entity.
	 *
	 * @param entity The entity.
	 *
	 * @return The component or null if it does not exist.
	 */
	public E get(Entity entity) {
		return manager.getComponent(entity, type);
	}
}