Package dev.prozilla.pine.core.entity

Interface EntityProvider

All Superinterfaces:

EntityContext

All Known Subinterfaces:

TileProvider

All Known Implementing Classes:

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

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@ProviderOf(Entity.class)
@FunctionalInterface
public interface EntityProvider
extends EntityContext

Interface with utility methods for finding certain entities in the current context.

Method Summary

Modifier and Type	Method	Description
default Entity	getChild(int i)
default Entity	getChildWithTag(String tag)	Gets a child entity with a given tag.
Entity	getEntity()
default Entity	getFirstChild()
default Entity	getLastChild()
default Entity	getParentWithTag(String tag)	Gets a parent entity with a given tag.
default Transform	getTransform()
default boolean	isDescendantOf(Transform parent)

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

isDescendantOf

Method Details

getEntity

Entity getEntity()

getTransform

default Transform getTransform()

getFirstChild

default Entity getFirstChild()

Specified by:

getFirstChild in interface EntityContext

getLastChild

default Entity getLastChild()

Specified by:

getLastChild in interface EntityContext

getChild

default Entity getChild(int i)

Specified by:

getChild in interface EntityContext

isDescendantOf

default boolean isDescendantOf(Transform parent)

Specified by:

isDescendantOf in interface EntityContext

getChildWithTag

default 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

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