Package dev.prozilla.pine.core.entity

Class EntityChunk

java.lang.Object

dev.prozilla.pine.core.entity.EntityChunk

All Implemented Interfaces:

Printable

public class EntityChunk
extends Object
implements Printable

A wrapper for an entity and its components that match a system's query. Provides quick access to the matching components of the entity.

Constructor Summary

Constructors

Constructor	Description
EntityChunk(Class<? extends Component>... componentTypes)

Method Summary

Modifier and Type	Method	Description
void	checkStatus()
void	destroy()	Destroys the entity.
boolean	equals(EntityChunk entityChunk)
boolean	equals(Object object)
<C extends Component> C	getComponent(int index)	Retrieves a component at a given index.
<C extends Component> C	getComponent(Class<C> type)	Retrieves a component of the specified type.
Entity	getEntity()
Transform	getTransform()
int	hashCode()
boolean	isActive()
void	setComponent(int index, Component component)	Sets a component at the given index.
void	setComponents(Component[] components)	Sets all components in this group.
int	size()	Returns the amount of components in this match.
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

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

print, print

Constructor Details

EntityChunk

@SafeVarargs
public EntityChunk(Class<? extends Component>... componentTypes)

Method Details

setComponents

public void setComponents(Component[] components)
                   throws IllegalArgumentException

Sets all components in this group.

Throws:

IllegalArgumentException - If the components are not attached to the same entity.

setComponent

public void setComponent(int index,
 Component component)
                  throws IllegalArgumentException

Sets a component at the given index.

Throws:

IllegalArgumentException - If the component is not an instance of the right component class.

getComponent

public <C extends Component> C getComponent(Class<C> type)
                                     throws IllegalArgumentException

Retrieves a component of the specified type.

Throws:

IllegalArgumentException - If no component is found.

getComponent

public <C extends Component> C getComponent(int index)

Retrieves a component at a given index.

destroy

public void destroy()

Destroys the entity.

getEntity

public Entity getEntity()
                 throws IllegalStateException

Throws:

IllegalStateException

getTransform

public Transform getTransform()

isActive

public boolean isActive()

checkStatus

public void checkStatus()

size

public int size()

Returns the amount of components in this match.

equals

public boolean equals(Object object)

Overrides:

equals in class Object

equals

public boolean equals(EntityChunk entityChunk)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

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