Uses of Class
com.almasb.fxgl.ecs.Entity

Packages that use Entity

Package	Description
com.almasb.fxgl.ecs
com.almasb.fxgl.ecs.action
com.almasb.fxgl.effect
com.almasb.fxgl.entity
com.almasb.fxgl.entity.component
com.almasb.fxgl.entity.control
com.almasb.fxgl.physics
com.almasb.fxgl.scene

Uses of Entity in com.almasb.fxgl.ecs

Fields in com.almasb.fxgl.ecs with type parameters of type Entity

Modifier and Type	Field and Description
protected List<Entity>	GameWorld.entities List of entities in the world.

Methods in com.almasb.fxgl.ecs that return Entity

Modifier and Type	Method and Description
Entity	Entity.copy() Creates a new instance, which is a copy of this entity.
Entity	Module.getEntity()
Entity	GameWorld.spawn(String entityName)
Entity	GameWorld.spawn(String entityName, double x, double y) Creates an entity with given name at x, y using specified entity factory.
Entity	GameWorld.spawn(String entityName, javafx.geometry.Point2D position) Creates an entity with given name at x, y using specified entity factory.
Entity	GameWorld.spawn(String entityName, SpawnData data) Creates an entity with given name and data using specified entity factory.

Methods in com.almasb.fxgl.ecs that return types with arguments of type Entity

Modifier and Type	Method and Description
Optional<Entity>	GameWorld.getClosestEntity(Entity entity, Predicate<Entity> filter) Returns the closest entity to the given entity with given filter.
List<Entity>	GameWorld.getCollidingEntities(Entity entity) Returns a list of entities which colliding with given entity.
List<Entity>	GameWorld.getEntities()
List<Entity>	GameWorld.getEntitiesAt(javafx.geometry.Point2D position) Returns a list of entities at given position.
List<Entity>	GameWorld.getEntitiesByComponent(Class<? extends Component> type)
List<Entity>	GameWorld.getEntitiesByLayer(RenderLayer layer) Returns a list of entities which have the given render layer index.
List<Entity>	GameWorld.getEntitiesByType(Enum<?>... types) This query only works on entities with TypeComponent.
List<Entity>	GameWorld.getEntitiesCopy()
List<Entity>	GameWorld.getEntitiesFiltered(Predicate<Entity> predicate) Returns a list of entities which are filtered by given predicate.
List<Entity>	GameWorld.getEntitiesInRange(javafx.geometry.Rectangle2D selection) Returns a list of entities which are partially or entirely in the specified rectangular selection.
Optional<Entity>	GameWorld.getEntityByID(String name, int id) Returns an entity whose IDComponent matches given name and id.
Optional<Entity>	GameWorld.getSelectedEntity()
javafx.beans.property.ObjectProperty<Entity>	GameWorld.selectedEntityProperty()

Methods in com.almasb.fxgl.ecs with parameters of type Entity

Modifier and Type	Method and Description
void	GameWorld.addEntities(Entity... entitiesToAdd)
void	GameWorld.addEntity(Entity entity) The entity will be added to update list in the next tick.
Optional<Entity>	GameWorld.getClosestEntity(Entity entity, Predicate<Entity> filter) Returns the closest entity to the given entity with given filter.
void	GameWorld.getCollidingEntities(Array<Entity> result, Entity entity) GC-friendly version of GameWorld.getCollidingEntities(Entity).
List<Entity>	GameWorld.getCollidingEntities(Entity entity) Returns a list of entities which colliding with given entity.
void	Module.onAdded(Entity entity)
void	EntityWorldListener.onEntityAdded(Entity entity) Called after entity was added to the world.
void	EntityWorldListener.onEntityRemoved(Entity entity) Called after entity was removed from the world but before entity has been cleaned.
void	Module.onRemoved(Entity entity)
abstract void	Control.onUpdate(Entity entity, double tpf)
void	GameWorld.removeEntities(Entity... entitiesToRemove)
void	GameWorld.removeEntity(Entity entity)

Method parameters in com.almasb.fxgl.ecs with type arguments of type Entity

Modifier and Type	Method and Description
Optional<Entity>	GameWorld.getClosestEntity(Entity entity, Predicate<Entity> filter) Returns the closest entity to the given entity with given filter.
void	GameWorld.getCollidingEntities(Array<Entity> result, Entity entity) GC-friendly version of GameWorld.getCollidingEntities(Entity).
void	GameWorld.getEntitiesAt(Array<Entity> result, javafx.geometry.Point2D position) GC-friendly version of GameWorld.getEntitiesAt(Point2D).
void	GameWorld.getEntitiesByLayer(Array<Entity> result, RenderLayer layer) GC-friendly version of GameWorld.getEntitiesByLayer(RenderLayer).
void	GameWorld.getEntitiesByType(Array<Entity> result, Enum<?>... types) GC-friendly version of GameWorld.getEntitiesByType(Enum[]).
void	GameWorld.getEntitiesFiltered(Array<Entity> result, Predicate<Entity> predicate) GC-friendly version of GameWorld.getEntitiesFiltered(Predicate).
void	GameWorld.getEntitiesFiltered(Array<Entity> result, Predicate<Entity> predicate) GC-friendly version of GameWorld.getEntitiesFiltered(Predicate).
List<Entity>	GameWorld.getEntitiesFiltered(Predicate<Entity> predicate) Returns a list of entities which are filtered by given predicate.
void	GameWorld.getEntitiesInRange(Array<Entity> result, double minX, double minY, double maxX, double maxY) GC-friendly version of GameWorld.getEntitiesInRange(Rectangle2D).

Uses of Entity in com.almasb.fxgl.ecs.action

Classes in com.almasb.fxgl.ecs.action with type parameters of type Entity

Modifier and Type	Class and Description
class	Action<T extends Entity> A single entity action.
class	ActionControl<T extends Entity>

Methods in com.almasb.fxgl.ecs.action with parameters of type Entity

Modifier and Type	Method and Description
void	ActionControl.onAdded(Entity entity)
void	ActionControl.onRemoved(Entity entity)
void	ActionControl.onUpdate(Entity entity, double tpf)

Uses of Entity in com.almasb.fxgl.effect

Methods in com.almasb.fxgl.effect with parameters of type Entity

Modifier and Type	Method and Description
void	ParticleControl.onRemoved(Entity entity)
void	ParticleControl.onUpdate(Entity entity, double tpf)

Uses of Entity in com.almasb.fxgl.entity

Subclasses of Entity in com.almasb.fxgl.entity

Modifier and Type	Class and Description
class	GameEntity Entity that guarantees to have Type, Position, Rotation, BoundingBox and View components.

Methods in com.almasb.fxgl.entity that return Entity

Modifier and Type	Method and Description
Entity	EntityEvent.getTargetEntity() Returns entity that was target of the event.
Entity	EntityEvent.getTriggerEntity()
static Entity	Entities.makeScreenBounds(double thickness) Create an entity with bounding box around the screen with given thickness.
default Entity	EntitySpawner.spawn(SpawnData data)

Methods in com.almasb.fxgl.entity with parameters of type Entity

Modifier and Type	Method and Description
static BoundingBoxComponent	Entities.getBBox(Entity e) Convenient way to obtain bbox component.
static PhysicsComponent	Entities.getPhysics(Entity e) Convenient way to obtain physics component.
static PositionComponent	Entities.getPosition(Entity e) Convenient way to obtain position component.
static RotationComponent	Entities.getRotation(Entity e) Convenient way to obtain rotation component.
static TypeComponent	Entities.getType(Entity e) Convenient way to obtain type component.
static ViewComponent	Entities.getView(Entity e) Convenient way to obtain main view component.

Constructors in com.almasb.fxgl.entity with parameters of type Entity

Constructor and Description
EntityEvent(javafx.event.EventType<? extends javafx.event.Event> eventType, Entity triggerEntity) Constructs entity event with given type and trigger entity.
EntityEvent(javafx.event.EventType<? extends javafx.event.Event> eventType, Entity triggerEntity, Entity targetEntity) Constructs entity event with given type, trigger entity and the entity being targeted by the event.

Uses of Entity in com.almasb.fxgl.entity.component

Methods in com.almasb.fxgl.entity.component with parameters of type Entity

Modifier and Type	Method and Description
void	ViewComponent.onAdded(Entity entity)
void	SelectableComponent.onAdded(Entity entity)
void	BoundingBoxComponent.onAdded(Entity entity)
void	ViewComponent.onRemoved(Entity entity)
void	SelectableComponent.onRemoved(Entity entity)
void	BoundingBoxComponent.onRemoved(Entity entity)

Constructor parameters in com.almasb.fxgl.entity.component with type arguments of type Entity

Constructor and Description
DrawableComponent(BiConsumer<javafx.scene.canvas.GraphicsContext,Entity> drawingFunction)

Uses of Entity in com.almasb.fxgl.entity.control

Methods in com.almasb.fxgl.entity.control with parameters of type Entity

Modifier and Type	Method and Description
void	ProjectileControl.onAdded(Entity entity)
void	OffscreenCleanControl.onAdded(Entity entity)
void	LiftControl.onAdded(Entity entity)
void	KeepOnScreenControl.onAdded(Entity entity)
void	ExpireCleanControl.onAdded(Entity entity)
void	CircularMovementControl.onAdded(Entity entity)
void	ProjectileControl.onUpdate(Entity entity, double tpf)
void	OffscreenCleanControl.onUpdate(Entity entity, double v)
void	LiftControl.onUpdate(Entity entity, double tpf)
void	KeepOnScreenControl.onUpdate(Entity entity, double tpf)
void	JSControl.onUpdate(Entity entity, double tpf)
void	ExpireCleanControl.onUpdate(Entity entity, double tpf)
void	CircularMovementControl.onUpdate(Entity entity, double tpf)

Uses of Entity in com.almasb.fxgl.physics

Methods in com.almasb.fxgl.physics that return types with arguments of type Entity

Modifier and Type	Method and Description
Optional<Entity>	RaycastResult.getEntity()

Methods in com.almasb.fxgl.physics with parameters of type Entity

Modifier and Type	Method and Description
void	PhysicsControl.onAdded(Entity entity)
protected void	CollisionHandler.onCollision(Entity a, Entity b) Called if entities A and B are currently colliding.
protected void	CollisionHandler.onCollisionBegin(Entity a, Entity b) Called when entities A and B have just collided and weren't colliding in the last tick.
protected void	CollisionHandler.onCollisionEnd(Entity a, Entity b) Called when entities A and B have just stopped colliding and were colliding in the last tick.
void	PhysicsWorld.onEntityAdded(Entity entity)
void	PhysicsWorld.onEntityRemoved(Entity entity)
protected void	CollisionHandler.onHitBoxTrigger(Entity a, Entity b, HitBox boxA, HitBox boxB) Called once per collision during the same tick when collision occurred.
void	PhysicsControl.onUpdate(Entity entity, double tpf)

Uses of Entity in com.almasb.fxgl.scene

Methods in com.almasb.fxgl.scene with parameters of type Entity

Modifier and Type	Method and Description
void	GameScene.onEntityAdded(Entity entity)
void	GameScene.onEntityRemoved(Entity entity)