com.almasb.fxgl.entity

Class GameWorld

java.lang.Object

com.almasb.fxgl.ecs.EntityWorld

com.almasb.fxgl.entity.GameWorld

All Implemented Interfaces:

UpdateEventListener

public final class GameWorld
extends EntityWorld
implements UpdateEventListener

Represents pure logical state of game. Manages all entities and their state.

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<Entity>	selectedEntity

Field Summary

Fields inherited from class com.almasb.fxgl.ecs.EntityWorld

entities

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GameWorld()

Method Summary

Modifier and Type	Method and Description
void	addEventTrigger(<any> trigger) Add event trigger to the world.
Optional<Entity>	getClosestEntity(Entity entity, Predicate<Entity> filter) Returns the closest entity to the given entity with given filter.
void	getCollidingEntities(Array<Entity> result, Entity entity) GC-friendly version of getCollidingEntities(Entity).
List<Entity>	getCollidingEntities(Entity entity) Returns a list of entities which colliding with given entity.
void	getEntitiesAt(Array<Entity> result, javafx.geometry.Point2D position) GC-friendly version of getEntitiesAt(Point2D).
List<Entity>	getEntitiesAt(javafx.geometry.Point2D position) Returns a list of entities at given position.
void	getEntitiesByLayer(Array<Entity> result, RenderLayer layer) GC-friendly version of getEntitiesByLayer(RenderLayer).
List<Entity>	getEntitiesByLayer(RenderLayer layer) Returns a list of entities which have the given render layer index.
void	getEntitiesByType(Array<Entity> result, Enum<?>... types) GC-friendly version of getEntitiesByType(Enum[]).
List<Entity>	getEntitiesByType(Enum<?>... types) This query only works on entities with TypeComponent.
void	getEntitiesFiltered(Array<Entity> result, Predicate<Entity> predicate) GC-friendly version of getEntitiesFiltered(Predicate).
List<Entity>	getEntitiesFiltered(Predicate<Entity> predicate) Returns a list of entities which are filtered by given predicate.
void	getEntitiesInRange(Array<Entity> result, double minX, double minY, double maxX, double maxY) GC-friendly version of getEntitiesInRange(Rectangle2D).
List<Entity>	getEntitiesInRange(javafx.geometry.Rectangle2D selection) Returns a list of entities which are partially or entirely in the specified rectangular selection.
Optional<Entity>	getEntityByID(String name, int id) Returns an entity whose IDComponent matches given name and id.
<T extends EntityFactory> T	getEntityFactory()
Optional<Entity>	getSelectedEntity() Returns last selected (clicked on by mouse) entity.
void	onUpdateEvent(UpdateEvent event) Called on each update tick.
void	removeEventTrigger(<any> trigger) Remove event trigger from the world.
void	reset()
javafx.beans.property.ObjectProperty<Entity>	selectedEntityProperty()
void	setEntityFactory(EntityFactory entityFactory) Set main entity factory to be used via spawn(String, SpawnData).
void	setLevel(Level level) Set level to given.
void	setLevelFromMap(TiledMap map)
Entity	spawn(String entityName)
Entity	spawn(String entityName, double x, double y) Creates an entity with given name at x, y using specified entity factory.
Entity	spawn(String entityName, javafx.geometry.Point2D position) Creates an entity with given name at x, y using specified entity factory.
Entity	spawn(String entityName, SpawnData data) Creates an entity with given name and data using specified entity factory.

Methods inherited from class com.almasb.fxgl.ecs.EntityWorld

addEntities, addEntity, addWorldListener, getEntities, getEntitiesByComponent, getEntitiesCopy, removeEntities, removeEntity, removeWorldListener, update

Methods inherited from class java.lang.Object

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

Property Detail

selectedEntity

public javafx.beans.property.ObjectProperty<Entity> selectedEntityProperty

See Also:

getSelectedEntity()

Constructor Detail

GameWorld

@Inject
protected GameWorld()

Method Detail

onUpdateEvent

public void onUpdateEvent(UpdateEvent event)

Description copied from interface: UpdateEventListener

Called on each update tick.

Specified by:

onUpdateEvent in interface UpdateEventListener

Parameters:

event - the event data

reset

public void reset()

Overrides:

reset in class EntityWorld

addEventTrigger

public void addEventTrigger(<any> trigger)

Add event trigger to the world.

Parameters:

trigger - the event trigger

removeEventTrigger

public void removeEventTrigger(<any> trigger)

Remove event trigger from the world.

Parameters:

trigger - the event trigger

getSelectedEntity

public Optional<Entity> getSelectedEntity()

Returns last selected (clicked on by mouse) entity.

Returns:

selected entity

selectedEntityProperty

public javafx.beans.property.ObjectProperty<Entity> selectedEntityProperty()

See Also:

getSelectedEntity()

setLevel

public void setLevel(Level level)

Set level to given. Resets the world. Adds all level entities to the world.

Parameters:

level - the level

setLevelFromMap

public void setLevelFromMap(TiledMap map)

getEntityFactory

public <T extends EntityFactory> T getEntityFactory()

Returns:

entity factory or null if not set

setEntityFactory

public void setEntityFactory(EntityFactory entityFactory)

Set main entity factory to be used via spawn(String, SpawnData).

Parameters:

entityFactory - factory for creating entities

spawn

public Entity spawn(String entityName)

spawn

public Entity spawn(String entityName,
                    javafx.geometry.Point2D position)

Creates an entity with given name at x, y using specified entity factory. Adds created entity to this game world.

Parameters:

entityName - name of entity as specified by Spawns

position - spawn location

Returns:

spawned entity

spawn

public Entity spawn(String entityName,
                    double x,
                    double y)

Creates an entity with given name at x, y using specified entity factory. Adds created entity to this game world.

Parameters:

entityName - name of entity as specified by Spawns

x - x position

y - y position

Returns:

spawned entity

spawn

public Entity spawn(String entityName,
                    SpawnData data)

Creates an entity with given name and data using specified entity factory. Adds created entity to this game world.

Parameters:

entityName - name of entity as specified by Spawns

data - spawn data, such as x, y and any extra info

Returns:

spawned entity

getEntitiesFiltered

public List<Entity> getEntitiesFiltered(Predicate<Entity> predicate)

Returns a list of entities which are filtered by given predicate. Warning: object allocation.

Parameters:

predicate - filter

Returns:

new list containing entities that satisfy query filters

getEntitiesFiltered

public void getEntitiesFiltered(Array<Entity> result,
                                Predicate<Entity> predicate)

GC-friendly version of getEntitiesFiltered(Predicate).

Parameters:

result - the array to collect entities

predicate - filter

getEntitiesByType

public List<Entity> getEntitiesByType(Enum<?>... types)

This query only works on entities with TypeComponent. If called with no arguments, all entities are returned. Warning: object allocation.

Parameters:

types - entity types

Returns:

new list containing entities that satisfy query filters

getEntitiesByType

public void getEntitiesByType(Array<Entity> result,
                              Enum<?>... types)

GC-friendly version of getEntitiesByType(Enum[]).

Parameters:

result - the array to collect entities

types - entity types

getEntitiesInRange

public List<Entity> getEntitiesInRange(javafx.geometry.Rectangle2D selection)

Returns a list of entities which are partially or entirely in the specified rectangular selection. This query only works on entities with BoundingBoxComponent. Warning: object allocation.

Parameters:

selection - Rectangle2D that describes the selection box

Returns:

new list containing entities that satisfy query filters

getEntitiesInRange

public void getEntitiesInRange(Array<Entity> result,
                               double minX,
                               double minY,
                               double maxX,
                               double maxY)

GC-friendly version of getEntitiesInRange(Rectangle2D).

Parameters:

result - the array to collect entities

minX - min x

minY - min y

maxX - max x

maxY - max y

getCollidingEntities

public List<Entity> getCollidingEntities(Entity entity)

Returns a list of entities which colliding with given entity. Note: CollidableComponent is not considered. This query only works on entities with BoundingBoxComponent.

Parameters:

entity - the entity

Returns:

new list containing entities that satisfy query filters

getCollidingEntities

public void getCollidingEntities(Array<Entity> result,
                                 Entity entity)

GC-friendly version of getCollidingEntities(Entity).

Parameters:

result - the array to collect entities

entity - the entity

getEntitiesByLayer

public List<Entity> getEntitiesByLayer(RenderLayer layer)

Returns a list of entities which have the given render layer index. This query only works on entities with ViewComponent.

Parameters:

layer - render layer

Returns:

new list containing entities that satisfy query filters

getEntitiesByLayer

public void getEntitiesByLayer(Array<Entity> result,
                               RenderLayer layer)

GC-friendly version of getEntitiesByLayer(RenderLayer).

Parameters:

result - the array to collect entities

layer - render layer

getEntitiesAt

public List<Entity> getEntitiesAt(javafx.geometry.Point2D position)

Returns a list of entities at given position. The position x and y must equal to entity's position x and y. This query only works on entities with PositionComponent.

Parameters:

position - point in the world

Returns:

entities at given point

getEntitiesAt

public void getEntitiesAt(Array<Entity> result,
                          javafx.geometry.Point2D position)

GC-friendly version of getEntitiesAt(Point2D).

Parameters:

result - the array to collect entities

position - point in the world

getClosestEntity

public Optional<Entity> getClosestEntity(Entity entity,
                                         Predicate<Entity> filter)

Returns the closest entity to the given entity with given filter. The given entity itself is never returned.

If there no entities satisfying the requirement, Optional.empty() is returned. Warning: object allocation.

Parameters:

entity - selected entity

filter - requirements

Returns:

closest entity to selected entity with type

getEntityByID

public Optional<Entity> getEntityByID(String name,
                                      int id)

Returns an entity whose IDComponent matches given name and id.

Returns Optional.empty() if no entity was found with such combination. This query only works on entities with IDComponent.

Parameters:

name - entity name

id - entity id

Returns:

entity that matches the query or Optional.empty()