com.almasb.fxgl.entity

Class Entities.EntityBuilder

java.lang.Object

com.almasb.fxgl.entity.Entities.EntityBuilder

Enclosing class:

Entities

public static class Entities.EntityBuilder
extends Object

Provides fluent API for building entities.

Method Summary

Modifier and Type	Method and Description
Entities.EntityBuilder	at(double x, double y)
Entities.EntityBuilder	at(javafx.geometry.Point2D position)
Entities.EntityBuilder	at(Vec2 position)
Entities.EntityBuilder	bbox(HitBox box)
Entity	build() Finishes building entity.
Entity	buildAndAttach() Finishes building the entity and attaches it to default game world.
Entity	buildAndAttach(GameWorld world) Finishes building the entity and attaches it to given world.
Entities.EntityBuilder	from(SpawnData data)
Entities.EntityBuilder	renderLayer(RenderLayer layer)
Entities.EntityBuilder	rotate(double angle)
Entities.EntityBuilder	type(Enum<?> type)
Entities.EntityBuilder	viewFromAnimatedTexture(AnimatedTexture texture)
Entities.EntityBuilder	viewFromAnimatedTexture(AnimatedTexture texture, boolean loop)
Entities.EntityBuilder	viewFromAnimatedTexture(AnimatedTexture texture, boolean loop, boolean removeEntityOnFinish)
Entities.EntityBuilder	viewFromAnimatedTexture(String textureName, int numFrames, javafx.util.Duration duration)
Entities.EntityBuilder	viewFromAnimatedTexture(String textureName, int numFrames, javafx.util.Duration duration, boolean loop)
Entities.EntityBuilder	viewFromAnimatedTexture(String textureName, int numFrames, javafx.util.Duration duration, boolean loop, boolean removeEntityOnFinish)
Entities.EntityBuilder	viewFromNode(javafx.scene.Node view)
Entities.EntityBuilder	viewFromNodeWithBBox(javafx.scene.Node view)
Entities.EntityBuilder	viewFromTexture(String textureName)
Entities.EntityBuilder	viewFromTextureWithBBox(String textureName)
Entities.EntityBuilder	viewFromTiles(TiledMap map, String layerName) Generates view from tiles with RenderLayer.DEFAULT.
Entities.EntityBuilder	viewFromTiles(TiledMap map, String layerName, RenderLayer renderLayer) Generates view from tiles.
Entities.EntityBuilder	with(Component... components)
Entities.EntityBuilder	with(String propertyKey, Object propertyValue) Add a property to entity being built.

Methods inherited from class java.lang.Object

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

Method Detail

from

public Entities.EntityBuilder from(SpawnData data)

type

public Entities.EntityBuilder type(Enum<?> type)

at

public Entities.EntityBuilder at(double x,
                                 double y)

at

public Entities.EntityBuilder at(javafx.geometry.Point2D position)

at

public Entities.EntityBuilder at(Vec2 position)

rotate

public Entities.EntityBuilder rotate(double angle)

bbox

public Entities.EntityBuilder bbox(HitBox box)

viewFromNode

public Entities.EntityBuilder viewFromNode(javafx.scene.Node view)

viewFromNodeWithBBox

public Entities.EntityBuilder viewFromNodeWithBBox(javafx.scene.Node view)

viewFromTexture

public Entities.EntityBuilder viewFromTexture(String textureName)

viewFromTextureWithBBox

public Entities.EntityBuilder viewFromTextureWithBBox(String textureName)

viewFromAnimatedTexture

public Entities.EntityBuilder viewFromAnimatedTexture(AnimatedTexture texture)

viewFromAnimatedTexture

public Entities.EntityBuilder viewFromAnimatedTexture(AnimatedTexture texture,
                                                      boolean loop)

viewFromAnimatedTexture

public Entities.EntityBuilder viewFromAnimatedTexture(AnimatedTexture texture,
                                                      boolean loop,
                                                      boolean removeEntityOnFinish)

viewFromAnimatedTexture

public Entities.EntityBuilder viewFromAnimatedTexture(String textureName,
                                                      int numFrames,
                                                      javafx.util.Duration duration)

viewFromAnimatedTexture

public Entities.EntityBuilder viewFromAnimatedTexture(String textureName,
                                                      int numFrames,
                                                      javafx.util.Duration duration,
                                                      boolean loop)

viewFromAnimatedTexture

public Entities.EntityBuilder viewFromAnimatedTexture(String textureName,
                                                      int numFrames,
                                                      javafx.util.Duration duration,
                                                      boolean loop,
                                                      boolean removeEntityOnFinish)

renderLayer

public Entities.EntityBuilder renderLayer(RenderLayer layer)

viewFromTiles

public Entities.EntityBuilder viewFromTiles(TiledMap map,
                                            String layerName)

Generates view from tiles with RenderLayer.DEFAULT.

Parameters:

map - parsed Tiled map

layerName - layer name as specified by Tiled

Returns:

builder

viewFromTiles

public Entities.EntityBuilder viewFromTiles(TiledMap map,
                                            String layerName,
                                            RenderLayer renderLayer)

Generates view from tiles.

Parameters:

map - parsed Tiled map

layerName - layer name as specified by Tiled

renderLayer - created view will use this render layer

Returns:

builder

with

public Entities.EntityBuilder with(Component... components)

with

public Entities.EntityBuilder with(String propertyKey,
                                   Object propertyValue)

Add a property to entity being built.

build

public Entity build()

Finishes building entity.

Returns:

entity

buildAndAttach

public Entity buildAndAttach()

Finishes building the entity and attaches it to default game world.

Returns:

entity

buildAndAttach

public Entity buildAndAttach(GameWorld world)

Finishes building the entity and attaches it to given world.

Parameters:

world - the world to attach entity to

Returns:

entity