com.almasb.fxgl.entity

Class Entities.GameEntityBuilder

java.lang.Object

com.almasb.fxgl.entity.Entities.GameEntityBuilder

Enclosing class:

Entities

public static class Entities.GameEntityBuilder
extends Object

Provides fluent API for building entities.

Constructor Summary

Constructors

Constructor and Description
GameEntityBuilder()

Method Summary

Modifier and Type	Method and Description
Entities.GameEntityBuilder	at(double x, double y)
Entities.GameEntityBuilder	at(javafx.geometry.Point2D position)
Entities.GameEntityBuilder	at(Vec2 position)
Entities.GameEntityBuilder	bbox(HitBox box)
GameEntity	build() Finishes building entity.
GameEntity	buildAndAttach(GameWorld world) Finishes building the entity and attaches it to given world.
Entities.GameEntityBuilder	from(SpawnData data)
Entities.GameEntityBuilder	renderLayer(RenderLayer layer)
Entities.GameEntityBuilder	rotate(double angle)
Entities.GameEntityBuilder	type(Enum<?> type)
Entities.GameEntityBuilder	viewFromNode(javafx.scene.Node view)
Entities.GameEntityBuilder	viewFromNodeWithBBox(javafx.scene.Node view)
Entities.GameEntityBuilder	viewFromTexture(String textureName)
Entities.GameEntityBuilder	viewFromTextureWithBBox(String textureName)
Entities.GameEntityBuilder	viewFromTiles(TiledMap map, String layerName) Generates view from tiles with RenderLayer.TOP.
Entities.GameEntityBuilder	viewFromTiles(TiledMap map, String layerName, RenderLayer renderLayer) Generates view from tiles.
Entities.GameEntityBuilder	with(Component... components)
Entities.GameEntityBuilder	with(Control... controls)

Methods inherited from class java.lang.Object

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

Constructor Detail

GameEntityBuilder

public GameEntityBuilder()

Method Detail

from

public Entities.GameEntityBuilder from(SpawnData data)

type

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

at

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

at

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

at

public Entities.GameEntityBuilder at(Vec2 position)

rotate

public Entities.GameEntityBuilder rotate(double angle)

bbox

public Entities.GameEntityBuilder bbox(HitBox box)

viewFromNode

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

viewFromNodeWithBBox

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

viewFromTexture

public Entities.GameEntityBuilder viewFromTexture(String textureName)

viewFromTextureWithBBox

public Entities.GameEntityBuilder viewFromTextureWithBBox(String textureName)

renderLayer

public Entities.GameEntityBuilder renderLayer(RenderLayer layer)

viewFromTiles

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

Generates view from tiles with RenderLayer.TOP.

Parameters:

map - parsed Tiled map

layerName - layer name as specified by Tiled

Returns:

builder

viewFromTiles

public Entities.GameEntityBuilder 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.GameEntityBuilder with(Component... components)

with

public Entities.GameEntityBuilder with(Control... controls)

build

public GameEntity build()

Finishes building entity.

Returns:

entity

buildAndAttach

public GameEntity buildAndAttach(GameWorld world)

Finishes building the entity and attaches it to given world.

Parameters:

world - the world to attach entity to

Returns:

entity