Package dev.prozilla.pine.core.entity

Class Entity

java.lang.Object

dev.prozilla.pine.common.event.EventDispatcher<Entity.EventType,Entity,Event<Entity.EventType,Entity>>

dev.prozilla.pine.common.event.SimpleEventDispatcher<Entity.EventType,Entity>

dev.prozilla.pine.core.entity.Entity

All Implemented Interfaces:

EventDispatcherContext<Entity.EventType,Entity,Event<Entity.EventType,Entity>>, Destructible, Printable, ApplicationContext, ApplicationProvider, ComponentsContext, EntityContext, SceneContext, SceneProvider

public class Entity
extends SimpleEventDispatcher<Entity.EventType,Entity>
implements Destructible, Printable, EntityContext, ComponentsContext, ApplicationProvider, SceneProvider

Represents a unique entity in the world with a list of components.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Entity.EventType

Nested classes/interfaces inherited from interface dev.prozilla.pine.common.event.EventDispatcherContext

EventDispatcherContext.EphemeralEventListener<EventType extends Enum<EventType>,E extends Event<EventType,?>>

Field Summary

Fields

Modifier and Type	Field	Description
protected final Application	application
final List<Component>	components	Components of this entity
final int	id
protected boolean	isActive
protected final Scene	scene
String	tag
final Transform	transform
protected final World	world

Fields inherited from class dev.prozilla.pine.common.event.EventDispatcher

logger

Constructor Summary

Constructors

Constructor	Description
Entity(World world)	Creates an entity at the position (0, 0)
Entity(World world, float x, float y)	Creates an entity at the position (x, y)
Entity(World world, String name)	Creates an entity at the position (0, 0)
Entity(World world, String name, float x, float y)	Creates an entity at the position (x, y)

Method Summary

Modifier and Type	Method	Description
Entity	addChild(Entity child)	Adds a child to this entity.
Entity	addChild(Prefab prefab)	Instantiates a prefab and adds the instance as a child of this entity
void	addChildren(Entity... children)	Adds children to this entity.
<C extends Component> C	addComponent(C component)	Adds a component to this entity.
void	destroy()	Destroys this entity at the end of the game loop.
void	destroyChildren()
void	destroyComponents()
boolean	equals(Entity entity)	Checks whether two entities are equal.
Application	getApplication()
Entity	getChild(int i)
Entity	getChildWithTag(String tag)	Gets a child entity with a given tag.
<ComponentType extends Component> ComponentType	getComponent(Class<ComponentType> componentClass)	Returns a component of a given class or null of there isn't one.
<ComponentType extends Component> ComponentType	getComponentInParent(Class<ComponentType> componentClass)
<ComponentType extends Component> ComponentType	getComponentInParent(Class<ComponentType> componentClass, boolean includeAncestors)
<ComponentType extends Component> List<ComponentType>	getComponents(Class<ComponentType> componentClass)	Returns all components of a given class.
<ComponentType extends Component> List<ComponentType>	getComponentsInChildren(Class<ComponentType> componentClass)
Entity	getFirstChild()
Entity	getLastChild()
Logger	getLogger()
String	getName()
String	getName(String defaultName)
Entity	getParentWithTag(String tag)	Gets a parent entity with a given tag.
Scene	getScene()
<ComponentType extends Component> boolean	hasComponent(Class<ComponentType> componentClass)	Checks if this entity has a component of a given class.
int	hashCode()
boolean	hasTag(String tag)	Checks whether this entity has a given tag.
protected void	invoke(Event<Entity.EventType,Entity> event)	Invokes an event.
void	invoke(Entity.EventType eventType)	Invokes an event of a given type without a target.
boolean	isActive()
boolean	isDescendantOf(Transform parent)
boolean	isRegistered()	Checks whether this entity is registered in the entity manager.
void	printHierarchy()	Formats and prints the names of this entity's parents.
protected void	propagate(Event<Entity.EventType,Entity> event)	Propagates the event to other objects in relation to the target object.
void	removeAllChildren()
void	removeChild(Entity child)	Detaches a child from this entity without removing it from the world.
void	removeChildren(Entity... children)	Detaches children from this entity without removing them from the world.
void	removeComponent(Component component)	Removes a component from this entity.
void	setActive(boolean active)	Sets the active state of this entity.
void	setParent(Entity parent)	Setter for the parent entity.
protected boolean	shouldInvoke(Entity.EventType eventType)
protected boolean	shouldPropagate(Entity.EventType eventType)
boolean	toggleActive()	Toggles the active state of this entity.
@NotNull String	toString()	Returns a string representation of this object.

Methods inherited from class dev.prozilla.pine.common.event.SimpleEventDispatcher

createEvent

Methods inherited from class dev.prozilla.pine.common.event.EventDispatcher

addListener, dispatchEvent, invoke, off, on, once, removeListener, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface dev.prozilla.pine.core.ApplicationProvider

getAudioDevice, getConfig, getInput, getLocalStorage, getModManager, getRenderer, getTimer, getTracker, getWindow

Methods inherited from interface dev.prozilla.pine.core.entity.EntityContext

isDescendantOf

Methods inherited from interface dev.prozilla.pine.common.event.EventDispatcherContext

addListener, addTargetedListener

Methods inherited from interface dev.prozilla.pine.common.Printable

print, print

Methods inherited from interface dev.prozilla.pine.core.scene.SceneProvider

getCameraData, getWorld

Field Details

id

public final int id

tag

public String tag

isActive

protected boolean isActive

transform

public final Transform transform

world

protected final World world

application

protected final Application application

scene

protected final Scene scene

components

public final List<Component> components

Components of this entity

Constructor Details

Entity

public Entity(World world)

Creates an entity at the position (0, 0)

Entity

public Entity(World world,
 String name)

Creates an entity at the position (0, 0)

Entity

public Entity(World world,
 float x,
 float y)

Creates an entity at the position (x, y)

Entity

public Entity(World world,
 String name,
 float x,
 float y)

Creates an entity at the position (x, y)

Method Details

destroy

public void destroy()

Destroys this entity at the end of the game loop.

Specified by:

destroy in interface Destructible

Overrides:

destroy in class EventDispatcher<Entity.EventType,Entity,Event<Entity.EventType,Entity>>

destroyChildren

public void destroyChildren()

destroyComponents

public void destroyComponents()

addChild

public Entity addChild(Prefab prefab)
                throws IllegalStateException,
IllegalArgumentException

Instantiates a prefab and adds the instance as a child of this entity

Parameters:

prefab - Prefab for the child entity

Returns:

Child entity

Throws:

IllegalStateException

IllegalArgumentException

addChild

public Entity addChild(Entity child)
                throws IllegalStateException,
IllegalArgumentException

Adds a child to this entity. Also adds the child to the world if this entity is inside the world.

Parameters:

child - Entity to add as a child

Returns:

Child entity

Throws:

IllegalStateException

IllegalArgumentException

addChildren

public void addChildren(Entity... children)
                 throws IllegalStateException,
IllegalArgumentException

Adds children to this entity.

Parameters:

children - Child objects

Throws:

IllegalStateException

IllegalArgumentException

removeChild

public void removeChild(Entity child)
                 throws IllegalStateException,
IllegalArgumentException

Detaches a child from this entity without removing it from the world.

Parameters:

child - Child object

Throws:

IllegalStateException

IllegalArgumentException

removeChildren

public void removeChildren(Entity... children)
                    throws IllegalStateException,
IllegalArgumentException

Detaches children from this entity without removing them from the world.

Parameters:

children - Child entities

Throws:

IllegalStateException

IllegalArgumentException

removeAllChildren

public void removeAllChildren()

getFirstChild

public Entity getFirstChild()

Specified by:

getFirstChild in interface EntityContext

getLastChild

public Entity getLastChild()

Specified by:

getLastChild in interface EntityContext

getChild

public Entity getChild(int i)

Specified by:

getChild in interface EntityContext

isDescendantOf

public boolean isDescendantOf(Transform parent)

Specified by:

isDescendantOf in interface EntityContext

getChildWithTag

public Entity getChildWithTag(String tag)

Description copied from interface: EntityContext

Gets a child entity with a given tag.

Specified by:

getChildWithTag in interface EntityContext

Parameters:

tag - Tag of the child entity.

Returns:

The child entity with the given tag, or null if there isn't one.

getParentWithTag

public Entity getParentWithTag(String tag)

Description copied from interface: EntityContext

Gets a parent entity with a given tag.

Specified by:

getParentWithTag in interface EntityContext

Parameters:

tag - Tag of the parent entity.

Returns:

The parent entity with the given tag, or null if there isn't one.

setParent

public void setParent(Entity parent)

Setter for the parent entity.

Parameters:

parent - Parent entity

toggleActive

public boolean toggleActive()

Toggles the active state of this entity.

Returns:

true if the entity is now active.

setActive

public void setActive(boolean active)

Sets the active state of this entity.

isActive

public boolean isActive()

addComponent

public <C extends Component> C addComponent(C component)

Adds a component to this entity.

Parameters:

component - Component

removeComponent

public void removeComponent(Component component)

Removes a component from this entity.

Parameters:

component - Component

getComponentInParent

public <ComponentType extends Component>
ComponentType getComponentInParent(Class<ComponentType> componentClass)

Specified by:

getComponentInParent in interface ComponentsContext

getComponentInParent

public <ComponentType extends Component>
ComponentType getComponentInParent(Class<ComponentType> componentClass,
 boolean includeAncestors)

Specified by:

getComponentInParent in interface ComponentsContext

getComponentsInChildren

public <ComponentType extends Component>
List<ComponentType> getComponentsInChildren(Class<ComponentType> componentClass)

Specified by:

getComponentsInChildren in interface ComponentsContext

hasComponent

public <ComponentType extends Component> boolean hasComponent(Class<ComponentType> componentClass)

Checks if this entity has a component of a given class.

Parameters:

componentClass - Class of the component.

Returns:

True if this entity has a component of type componentClass.

getComponent

public <ComponentType extends Component>
ComponentType getComponent(Class<ComponentType> componentClass)

Returns a component of a given class or null of there isn't one.

Specified by:

getComponent in interface ComponentsContext

Parameters:

componentClass - Class of the component.

Returns:

An instance of componentClass that is attached to this entity.

getComponents

public <ComponentType extends Component>
List<ComponentType> getComponents(Class<ComponentType> componentClass)

Returns all components of a given class.

Specified by:

getComponents in interface ComponentsContext

Parameters:

componentClass - Class of the components.

Returns:

An ArrayList of instance of componentClass that are attached to this entity.

invoke

public void invoke(Entity.EventType eventType)

Description copied from class: SimpleEventDispatcher

Invokes an event of a given type without a target.

Overrides:

invoke in class SimpleEventDispatcher<Entity.EventType,Entity>

Parameters:

eventType - The type of event to invoke

invoke

protected void invoke(Event<Entity.EventType,Entity> event)

Description copied from class: EventDispatcher

Invokes an event.

Overrides:

invoke in class EventDispatcher<Entity.EventType,Entity,Event<Entity.EventType,Entity>>

Parameters:

event - The event to invoke

shouldInvoke

protected boolean shouldInvoke(Entity.EventType eventType)

Overrides:

shouldInvoke in class EventDispatcher<Entity.EventType,Entity,Event<Entity.EventType,Entity>>

shouldPropagate

protected boolean shouldPropagate(Entity.EventType eventType)

Overrides:

shouldPropagate in class EventDispatcher<Entity.EventType,Entity,Event<Entity.EventType,Entity>>

propagate

protected void propagate(Event<Entity.EventType,Entity> event)

Description copied from class: EventDispatcher

Propagates the event to other objects in relation to the target object. This method is called after the event has been invoked, unless the propagation was stopped.

The default implementation does nothing.

Overrides:

propagate in class EventDispatcher<Entity.EventType,Entity,Event<Entity.EventType,Entity>>

Parameters:

event - The event to propagate

getName

public String getName()

getName

public String getName(String defaultName)

hasTag

public boolean hasTag(String tag)

Checks whether this entity has a given tag.

getApplication

public Application getApplication()

Specified by:

getApplication in interface ApplicationProvider

getLogger

public Logger getLogger()

Specified by:

getLogger in interface ApplicationContext

Specified by:

getLogger in interface ApplicationProvider

Overrides:

getLogger in class EventDispatcher<Entity.EventType,Entity,Event<Entity.EventType,Entity>>

getScene

public Scene getScene()

Specified by:

getScene in interface SceneProvider

isRegistered

public boolean isRegistered()

Checks whether this entity is registered in the entity manager.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Entity entity)

Checks whether two entities are equal.

Parameters:

entity - Other entity

Returns:

True if the entities are equal

printHierarchy

public void printHierarchy()

Formats and prints the names of this entity's parents.

toString

@NotNull
public @NotNull String toString()

Description copied from interface: Printable

Returns a string representation of this object.

Specified by:

toString in interface Printable

Overrides:

toString in class Object

Returns:

String representation of this object.