GameWorld (fxgl 0.4.3 API)

java.lang.Object
- com.almasb.fxgl.entity.GameWorld

```
public final class GameWorld
extends Object
```
Represents pure logical state of the game. Manages all entities and allows queries.

Author:

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

Property Summary

All Methods Instance Methods Concrete Methods
Type Property and Description

javafx.beans.property.ObjectProperty<Entity> selectedEntity

All Methods Instance Methods Concrete Methods
Type	Property and Description
`javafx.beans.property.ObjectProperty<Entity>`	`selectedEntity`

Constructor Summary

Constructors
Constructor and Description

GameWorld()
Constructs the world with initial entity capacity = 32.

GameWorld(int initialCapacity)

Constructors
Constructor and Description
`GameWorld()` Constructs the world with initial entity capacity = 32.
`GameWorld(int initialCapacity)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEntities(Entity... entitiesToAdd)`
`void`	`addEntity(Entity entity)` The entity will be added to update list in the next tick.
`void`	`addWorldListener(EntityWorldListener listener)`
`void`	`clear()` Removes all (including with IrremovableComponent) entities.
`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.
`List<Entity>`	`getEntities()`
`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.
`List<Entity>`	`getEntitiesByComponent(Class<? extends Component> type)`
`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)` If called with no arguments, all entities are returned.
`List<Entity>`	`getEntitiesCopy()`
`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()`
`<T extends Entity> <any>`	`getGroup(Enum<?>... types)`
`Optional<Entity>`	`getRandom(Enum<?> type)`
`Optional<Entity>`	`getRandom(Predicate<Entity> predicate)`
`Optional<Entity>`	`getSelectedEntity()`
`Optional<Entity>`	`getSingleton(Enum<?> type)` Useful for singleton type entities, e.g.
`Optional<Entity>`	`getSingleton(Predicate<Entity> predicate)`
`void`	`onUpdate(double tpf)`
`void`	`removeEntities(Entity... entitiesToRemove)`
`void`	`removeEntity(Entity entity)` Entity will be removed from world and parties notified of removal in the same frame.
`void`	`removeWorldListener(EntityWorldListener listener)`
`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(String mapFileName)`
`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 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
```
public GameWorld()
```
    Constructs the world with initial entity capacity = 32.
  - GameWorld
```
public GameWorld(int initialCapacity)
```
    Parameters:
    
    initialCapacity - initial entity capacity
- Method Detail
  - addEntity
```
public void addEntity(Entity entity)
```
    The entity will be added to update list in the next tick.
    
    Parameters:
    
    entity - the entity to add to world
  - addEntities
```
public void addEntities(Entity... entitiesToAdd)
```
  - removeEntity
```
public void removeEntity(Entity entity)
```
    Entity will be removed from world and parties notified of removal in the same frame. The components and controls of entity will be removed in the next frame to avoid concurrency issues.
  - removeEntities
```
public void removeEntities(Entity... entitiesToRemove)
```
  - clear
```
public void clear()
```
    Removes all (including with IrremovableComponent) entities. Does NOT clear state listeners. Do NOT call this method manually. It is called automatically by FXGL during initGame().
  - addWorldListener
```
public void addWorldListener(EntityWorldListener listener)
```
  - removeWorldListener
```
public void removeWorldListener(EntityWorldListener listener)
```
  - getEntities
```
public List<Entity> getEntities()
```
    Returns:
    
    direct list of entities in the world (do NOT modify)
  - getEntitiesCopy
```
public List<Entity> getEntitiesCopy()
```
    Returns:
    
    shallow copy of the entities list (new list)
  - onUpdate
```
public void onUpdate(double tpf)
```
  - getSelectedEntity
```
public Optional<Entity> getSelectedEntity()
```
    Returns:
    
    last selected (clicked on by mouse) 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(String mapFileName)
```
    Parameters:
    
    mapFileName - name of the .json file or the .tmx file
  - 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
  - getGroup
```
public <T extends Entity> <any> getGroup(Enum<?>... types)
```
  - getSingleton
```
public Optional<Entity> getSingleton(Enum<?> type)
```
    Useful for singleton type entities, e.g. Player.
    
    Returns:
    
    first occurrence matching given type
  - getSingleton
```
public Optional<Entity> getSingleton(Predicate<Entity> predicate)
```
    Returns:
    
    first occurrence matching given predicate
  - getRandom
```
public Optional<Entity> getRandom(Enum<?> type)
```
    Parameters:
    
    type - entity type
    
    Returns:
    
    a random entity with given type
  - getRandom
```
public Optional<Entity> getRandom(Predicate<Entity> predicate)
```
  - getEntitiesByComponent
```
public List<Entity> getEntitiesByComponent(Class<? extends Component> type)
```
    Parameters:
    
    type - component type
    
    Returns:
    
    array of entities that have given component
  - 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)
```
    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. 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.
    
    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.
    
    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.
    
    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()

Class GameWorld

Property Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

selectedEntity

Constructor Detail

GameWorld

GameWorld

Method Detail

addEntity

addEntities

removeEntity

removeEntities

clear

addWorldListener

removeWorldListener

getEntities

getEntitiesCopy

onUpdate

getSelectedEntity

selectedEntityProperty

setLevel

setLevelFromMap

setLevelFromMap

getEntityFactory

setEntityFactory

spawn

spawn

spawn

spawn

getGroup

getSingleton

getSingleton

getRandom

getRandom

getEntitiesByComponent

getEntitiesFiltered

getEntitiesFiltered

getEntitiesByType

getEntitiesByType

getEntitiesInRange

getEntitiesInRange

getCollidingEntities

getCollidingEntities

getEntitiesByLayer

getEntitiesByLayer

getEntitiesAt

getEntitiesAt

getClosestEntity

getEntityByID