Package dev.prozilla.pine.core.component

Class Component

java.lang.Object

dev.prozilla.pine.core.component.Component

All Implemented Interfaces:

Destructible, Printable, ApplicationContext, ApplicationProvider, ComponentsContext, ComponentsProvider, EntityContext, EntityProvider, SceneContext, SceneProvider

Direct Known Subclasses:

AnimationData, AudioEffectPlayer, AudioPlayer, BorderImage, ButtonNode, CameraControlData, CameraData, DevConsoleData, DynamicText, FrameNode, GridGroup, ImageNode, LayoutNode, MultiTileRenderer, Node, NodeRoot, NodeStyleBase, ParticleEmitter, ParticleRenderer, RectRenderer, SpriteRenderer, TextInputNode, TextNode, TileRenderer, TooltipNode, Transform

public abstract class Component
extends Object
implements Printable, Destructible, EntityProvider, ComponentsProvider, ApplicationProvider, SceneProvider

Contains a partition of the data of an entity.

Field Summary

Fields

Modifier and Type	Field	Description
Entity	entity	The entity that this component is attached to.
final int	id
boolean	isActive

Constructor Summary

Constructors

Constructor	Description
Component()

Method Summary

Modifier and Type	Method	Description
void	destroy()	Removes this component from its entity.
boolean	equals(Component component)
Application	getApplication()
Entity	getEntity()	Getter for the entity this component is attached to.
String	getName()
Scene	getScene()
int	hashCode()
protected void	onEntityChange(Entity oldEntity, Entity newEntity)
void	setActive(boolean active)	Enables or disables this component.
void	setEntity(Entity entity)
@NotNull String	toString()	Returns a string representation of this object.

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, getLogger, getModManager, getRenderer, getTimer, getTracker, getWindow

Methods inherited from interface dev.prozilla.pine.core.component.ComponentsProvider

getComponent, getComponentInParent, getComponentInParent, getComponents, getComponentsInChildren

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

isDescendantOf

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

getChild, getChildWithTag, getFirstChild, getLastChild, getParentWithTag, getTransform, isDescendantOf

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

isActive

public boolean isActive

entity

public Entity entity

The entity that this component is attached to.

Constructor Details

Component

public Component()

Method Details

destroy

public void destroy()

Removes this component from its entity.

Specified by:

destroy in interface Destructible

setEntity

public void setEntity(Entity entity)

onEntityChange

protected void onEntityChange(Entity oldEntity,
 Entity newEntity)

setActive

public void setActive(boolean active)

Enables or disables this component.

Parameters:

active - True enables this component, false disables it.

getEntity

public Entity getEntity()

Getter for the entity this component is attached to.

Specified by:

getEntity in interface ComponentsProvider

Specified by:

getEntity in interface EntityProvider

Returns:

Entity

getApplication

public Application getApplication()

Specified by:

getApplication in interface ApplicationProvider

getScene

public Scene getScene()

Specified by:

getScene in interface SceneProvider

getName

public String getName()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Component component)

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.