com.tenio.engine.ecs.basis.Entity Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tenio-engine Show documentation

TenIO is a java NIO (Non-blocking I/O) based server specifically designed for multiplayer games. It supports UDP and TCP transports which are handled by Netty for high-speed network transmission. This is the engine module for the game related handlers of the framework.

There is a newer version: 0.6.0

Show newest version

/*
The MIT License

Copyright (c) 2016-2021 kong 

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.tenio.engine.ecs.basis;

import com.tenio.common.pool.ElementPool;
import com.tenio.engine.ecs.basis.implement.ContextInfo;
import com.tenio.engine.ecs.pool.ComponentPool;

/**
 * An entity is something that exists in your game world. Again, an entity is
 * little more than a list of components. Because they are so simple, most
 * implementations won't define an entity as a concrete piece of data. Instead,
 * an entity is a unique ID, and all components that make up an entity will be
 * tagged with that ID.
 */
public interface Entity {

  /**
   * Retrieves the entity's id.
   *
   * @return entity's id
   */
  String getId();

  /**
   * Set new id.
   *
   * @param id the desired id
   */
  void setId(String id);

  /**
   * Retrieves the list of component pools.
   *
   * @return an array of {@link ComponentPool}
   */
  ElementPool[] getComponentPools();

  /**
   * Set list of component pools, each component pool manages specific component
   * type.
   *
   * @param componentPools an array of {@link ComponentPool}
   */
  void setComponentPools(ElementPool[] componentPools);

  /**
   * Retrieves the context information.
   *
   * @return see {@link ContextInfo}
   */
  ContextInfo getContextInfo();

  /**
   * Set context information.
   *
   * @param contextInfo see {@link ContextInfo}
   */
  void setContextInfo(ContextInfo contextInfo);

  /**
   * Set new component.
   *
   * @param index     the component index
   * @param component the component object
   */
  void setComponent(int index, Component component);

  /**
   * Remove component by index.
   *
   * @param index the component index
   */
  void removeComponent(int index);

  /**
   * Replace old component by new component by index.
   *
   * @param index     the component index
   * @param component the component object
   */
  void replaceComponent(int index, Component component);

  /**
   * Retrieves the component by index.
   *
   * @param index the component index
   * @return the corresponding component
   */
  Component getComponent(int index);

  /**
   * Retrieves a list of the current entity.
   *
   * @return list of components
   */
  Component[] getComponents();

  /**
   * Check if the component is existed or not.
   *
   * @param index component index
   * @return true if the component is existed, false otherwise
   */
  boolean hasComponent(int index);

  /**
   * Check if all the components in list are existed or not.
   *
   * @param indices list of component indices
   * @return true if the all components are existed, false otherwise
   */
  boolean hasComponents(int... indices);

  /**
   * Check if one of components in list are existed or not.
   *
   * @param indices list of component indices
   * @return true if the one of components in list is existed, false otherwise
   */
  boolean hasAnyComponent(int... indices);

  /**
   * Remove all components.
   */
  void removeAllComponents();

  /**
   * Reset entity.
   */
  void reset();
}