Entity (fxgl 0.4.1 API)

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

```
public class Entity
extends Object
```
A generic entity in the Entity-Component-Control model. During update (or control update) it is not allowed to:
- Add control
- Remove control
Entity is guaranteed to have Type, Position, Rotation, BBox, View components. The best practice is to add all component and controls to an entity before attaching the entity to the world and pause the (immediately) unused controls.
Author:

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

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`javafx.beans.property.ReadOnlyBooleanProperty`	`active`
`javafx.beans.property.DoubleProperty`	`angle`
`javafx.beans.property.ReadOnlyDoubleProperty`	`height`
`javafx.beans.property.ObjectProperty<Serializable>`	`type`
`javafx.beans.property.ReadOnlyDoubleProperty`	`width`
`javafx.beans.property.DoubleProperty`	`x`
`javafx.beans.property.DoubleProperty`	`y`

Constructor Summary

Constructors
Constructor and Description

Entity()

Constructors
Constructor and Description
`Entity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javafx.beans.property.ReadOnlyBooleanProperty`	`activeProperty()`
`void`	`addComponent(Component component)` Adds given component to this entity.
`void`	`addControl(Control control)` Adds behavior to entity.
`void`	`addModuleListener(ModuleListener listener)`
`javafx.beans.property.DoubleProperty`	`angleProperty()`
`Entity`	`copy()` Creates a new instance, which is a copy of this entity.
`double`	`distance(Entity other)`
`double`	`getBottomY()`
`BoundingBoxComponent`	`getBoundingBoxComponent()`
`javafx.geometry.Point2D`	`getCenter()`
`<T extends Component> T`	`getComponent(Class<T> type)` Returns component of given type, or null if type not registered.
`<T extends Component> Optional<T>`	`getComponentOptional(Class<T> type)` Returns component of given type, or `Optional.empty()` if type not registered.
`Array<Component>`	`getComponents()` Warning: object allocation.
`<T extends Control> T`	`getControl(Class<T> type)` Returns control of given type or null if no such type is registered.
`<T extends Control> Optional<T>`	`getControlOptional(Class<T> type)` Returns control of given type or `Optional.empty()` if no such type is registered on this entity.
`Array<Control>`	`getControls()` Warning: object allocation.
`double`	`getHeight()`
`javafx.geometry.Point2D`	`getPosition()`
`PositionComponent`	`getPositionComponent()`
`ObjectMap<String,Object>`	`getProperties()`
`<T> T`	`getProperty(String key)`
`<T> Optional<T>`	`getPropertyOptional(String key)`
`RenderLayer`	`getRenderLayer()`
`double`	`getRightX()`
`double`	`getRotation()`
`RotationComponent`	`getRotationComponent()`
`Optional<JavaScriptParser>`	`getScriptHandler(String scriptType)`
`Serializable`	`getType()` Gets the value of the property type.
`TypeComponent`	`getTypeComponent()`
`EntityView`	`getView()`
`ViewComponent`	`getViewComponent()`
`double`	`getWidth()`
`GameWorld`	`getWorld()`
`double`	`getX()`
`double`	`getY()`
`boolean`	`hasComponent(Class<? extends Component> type)`
`boolean`	`hasControl(Class<? extends Control> type)`
`javafx.beans.property.ReadOnlyDoubleProperty`	`heightProperty()`
`boolean`	`isActive()` Entity is "active" from the moment it is added to the world and until it is removed from the world.
`boolean`	`isColliding(Entity other)`
`boolean`	`isType(Object type)` Example: entity.isType(Type.PLAYER);
`boolean`	`isWithin(javafx.geometry.Rectangle2D bounds)`
`void`	`load(Bundle bundle)` Load entity state from a bundle.
`boolean`	`removeComponent(Class<? extends Component> type)` Remove a component with given type from this entity.
`boolean`	`removeControl(Class<? extends Control> type)`
`void`	`removeFromWorld()` Equivalent to world?.removeEntity(this);
`void`	`removeModuleListener(ModuleListener listener)`
`void`	`rotateBy(double angle)` Rotate entity view by given angle clockwise.
`void`	`rotateToVector(javafx.geometry.Point2D vector)` Set absolute rotation of the entity view to angle between vector and positive X axis.
`void`	`save(Bundle bundle)` Save entity state into bundle.
`void`	`setControlsEnabled(boolean b)` Setting this to false will disable each control's update until this has been set back to true.
`void`	`setOnActive(Runnable action)` Set a callback for when entity is added to world.
`void`	`setOnNotActive(Runnable action)` Set a callback for when entity is removed from world.
`void`	`setPosition(double x, double y)` Set top left position of this entity in world coordinates.
`void`	`setPosition(javafx.geometry.Point2D position)` Set top left position of this entity in world coordinates.
`void`	`setProperty(String key, Object value)`
`void`	`setRenderLayer(RenderLayer layer)`
`void`	`setRotation(double angle)` Set absolute rotation angle.
`void`	`setScaleX(double scaleX)` Scale view x.
`void`	`setScaleY(double scaleY)` Scale view y.
`void`	`setType(Serializable type)` Sets the value of the property type.
`void`	`setView(javafx.scene.Node view)`
`void`	`setViewFromTexture(String textureName)` Set view from texture.
`void`	`setViewFromTextureWithBBox(String textureName)` Set view from texture and generate bbox from it.
`void`	`setViewWithBBox(javafx.scene.Node view)` Set view and generate bounding boxes from view.
`void`	`setX(double x)` Set position top left x of this entity.
`void`	`setY(double y)` Set position top left y of this entity.
`String`	`toString()`
`void`	`translate(double dx, double dy)` Translate x and y by given vector.
`void`	`translate(javafx.geometry.Point2D vector)` Translate x and y by given vector.
`void`	`translate(Vec2 vector)` Translate x and y by given vector.
`void`	`translateTowards(javafx.geometry.Point2D point, double distance)` Instantly moves this entity distance units towards given point.
`void`	`translateX(double dx)` Translate x by given value.
`void`	`translateY(double dy)` Translate y by given value.
`javafx.beans.property.ObjectProperty<Serializable>`	`typeProperty()`
`javafx.beans.property.ReadOnlyDoubleProperty`	`widthProperty()`
`javafx.beans.property.DoubleProperty`	`xProperty()`
`javafx.beans.property.DoubleProperty`	`yProperty()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Property Detail
  - type
```
public final javafx.beans.property.ObjectProperty<Serializable> typeProperty
```
    See Also:
    
    getType(), setType(Serializable)
  - x
```
public final javafx.beans.property.DoubleProperty xProperty
```
    See Also:
    
    getX(), setX(double)
  - y
```
public final javafx.beans.property.DoubleProperty yProperty
```
    See Also:
    
    getY(), setY(double)
  - angle
```
public final javafx.beans.property.DoubleProperty angleProperty
```
  - width
```
public final javafx.beans.property.ReadOnlyDoubleProperty widthProperty
```
    See Also:
    
    getWidth()
  - height
```
public final javafx.beans.property.ReadOnlyDoubleProperty heightProperty
```
    See Also:
    
    getHeight()
  - active
```
public final javafx.beans.property.ReadOnlyBooleanProperty activeProperty
```
    See Also:
    
    isActive()
- Constructor Detail
  - Entity
```
public Entity()
```
- Method Detail
  - getWorld
```
public GameWorld getWorld()
```
    Returns:
    
    the world this entity is attached to
  - removeFromWorld
```
public final void removeFromWorld()
```
    Equivalent to world?.removeEntity(this);
  - getTypeComponent
```
public final TypeComponent getTypeComponent()
```
  - getPositionComponent
```
public final PositionComponent getPositionComponent()
```
  - getRotationComponent
```
public final RotationComponent getRotationComponent()
```
  - getBoundingBoxComponent
```
public final BoundingBoxComponent getBoundingBoxComponent()
```
  - getViewComponent
```
public final ViewComponent getViewComponent()
```
  - getType
```
public final Serializable getType()
```
    Gets the value of the property type.
  - setType
```
public final void setType(Serializable type)
```
    Sets the value of the property type.
  - isType
```
public final boolean isType(Object type)
```
```
     Example:
     entity.isType(Type.PLAYER);
 
```
    Parameters:
    
    type - entity type
    
    Returns:
    
    true iff this type component is of given type
  - typeProperty
```
public final javafx.beans.property.ObjectProperty<Serializable> typeProperty()
```
    See Also:
    
    getType(), setType(Serializable)
  - getPosition
```
public final javafx.geometry.Point2D getPosition()
```
    Returns:
    
    top left point of this entity in world coordinates
  - setPosition
```
public final void setPosition(javafx.geometry.Point2D position)
```
    Set top left position of this entity in world coordinates.
  - setPosition
```
public final void setPosition(double x,
                              double y)
```
    Set top left position of this entity in world coordinates.
  - getX
```
public final double getX()
```
    Returns:
    
    top left x
  - getY
```
public final double getY()
```
    Returns:
    
    top left y
  - setX
```
public final void setX(double x)
```
    Set position top left x of this entity.
  - setY
```
public final void setY(double y)
```
    Set position top left y of this entity.
  - xProperty
```
public final javafx.beans.property.DoubleProperty xProperty()
```
    See Also:
    
    getX(), setX(double)
  - yProperty
```
public final javafx.beans.property.DoubleProperty yProperty()
```
    See Also:
    
    getY(), setY(double)
  - translate
```
public final void translate(javafx.geometry.Point2D vector)
```
    Translate x and y by given vector.
  - translate
```
public final void translate(Vec2 vector)
```
    Translate x and y by given vector.
  - translate
```
public final void translate(double dx,
                            double dy)
```
    Translate x and y by given vector.
    
    Parameters:
    
    dx - vector x
    
    dy - vector y
  - translateX
```
public final void translateX(double dx)
```
    Translate x by given value.
  - translateY
```
public final void translateY(double dy)
```
    Translate y by given value.
  - translateTowards
```
public final void translateTowards(javafx.geometry.Point2D point,
                                   double distance)
```
    Instantly moves this entity distance units towards given point.
    
    Parameters:
    
    point - the point to move towards
    
    distance - the distance to move
  - distance
```
public final double distance(Entity other)
```
    Returns:
    
    distance in pixels from this entity to the other
  - getRotation
```
public final double getRotation()
```
    Returns:
    
    rotation angle
  - setRotation
```
public final void setRotation(double angle)
```
    Set absolute rotation angle.
  - angleProperty
```
public final javafx.beans.property.DoubleProperty angleProperty()
```
  - rotateBy
```
public final void rotateBy(double angle)
```
    Rotate entity view by given angle clockwise. To rotate counter clockwise use a negative angle value. Note: this doesn't affect hit boxes. For more accurate collisions use PhysicsComponent.
    
    Parameters:
    
    angle - rotation angle in degrees
  - rotateToVector
```
public final void rotateToVector(javafx.geometry.Point2D vector)
```
    Set absolute rotation of the entity view to angle between vector and positive X axis. This is useful for projectiles (bullets, arrows, etc) which rotate depending on their current velocity. Note, this assumes that at 0 angle rotation the view is facing right.
    
    Parameters:
    
    vector - the rotation vector / velocity vector
  - getWidth
```
public final double getWidth()
```
    Returns:
    
    width of this entity based on bounding box
  - getHeight
```
public final double getHeight()
```
    Returns:
    
    height of this entity based on bounding box
  - widthProperty
```
public final javafx.beans.property.ReadOnlyDoubleProperty widthProperty()
```
    See Also:
    
    getWidth()
  - heightProperty
```
public final javafx.beans.property.ReadOnlyDoubleProperty heightProperty()
```
    See Also:
    
    getHeight()
  - getRightX
```
public final double getRightX()
```
    Returns:
    
    the rightmost x of this entity in world coordinates based on bounding box
  - getBottomY
```
public final double getBottomY()
```
    Returns:
    
    the bottom y of this entity in world coordinates based on bounding box
  - getCenter
```
public final javafx.geometry.Point2D getCenter()
```
    Returns:
    
    center point of this entity in world coordinates based on bounding box
  - isColliding
```
public final boolean isColliding(Entity other)
```
    Parameters:
    
    other - the other game entity
    
    Returns:
    
    true iff bbox of this entity is colliding with bbox of other
  - isWithin
```
public final boolean isWithin(javafx.geometry.Rectangle2D bounds)
```
    Parameters:
    
    bounds - a rectangular box that represents bounds
    
    Returns:
    
    true iff entity is partially or entirely within given bounds
  - getView
```
public final EntityView getView()
```
  - setView
```
public final void setView(javafx.scene.Node view)
```
  - setViewFromTexture
```
public final void setViewFromTexture(String textureName)
```
    Set view from texture.
    
    Parameters:
    
    textureName - name of texture
  - setViewFromTextureWithBBox
```
public final void setViewFromTextureWithBBox(String textureName)
```
    Set view from texture and generate bbox from it.
    
    Parameters:
    
    textureName - name of texture
  - setViewWithBBox
```
public final void setViewWithBBox(javafx.scene.Node view)
```
    Set view and generate bounding boxes from view.
  - getRenderLayer
```
public final RenderLayer getRenderLayer()
```
  - setRenderLayer
```
public final void setRenderLayer(RenderLayer layer)
```
  - setScaleX
```
public final void setScaleX(double scaleX)
```
    Scale view x.
  - setScaleY
```
public final void setScaleY(double scaleY)
```
    Scale view y.
  - activeProperty
```
public final javafx.beans.property.ReadOnlyBooleanProperty activeProperty()
```
    See Also:
    
    isActive()
  - isActive
```
public final boolean isActive()
```
    Entity is "active" from the moment it is added to the world and until it is removed from the world.
    
    Returns:
    
    true if entity is active, else false
  - setOnActive
```
public final void setOnActive(Runnable action)
```
    Set a callback for when entity is added to world. The callback will NOT be executed if entity is already in the world.
    
    Parameters:
    
    action - callback
  - setOnNotActive
```
public final void setOnNotActive(Runnable action)
```
    Set a callback for when entity is removed from world. The callback will NOT be executed if entity is already removed from the world.
    
    Parameters:
    
    action - callback
  - setControlsEnabled
```
public final void setControlsEnabled(boolean b)
```
    Setting this to false will disable each control's update until this has been set back to true.
    
    Parameters:
    
    b - controls enabled flag
  - getProperties
```
public ObjectMap<String,Object> getProperties()
```
  - setProperty
```
public final void setProperty(String key,
                              Object value)
```
    Parameters:
    
    key - property key
    
    value - property value
  - getProperty
```
public final <T> T getProperty(String key)
```
    Parameters:
    
    key - property key
    
    Returns:
    
    property value or null if key not present
  - getPropertyOptional
```
public final <T> Optional<T> getPropertyOptional(String key)
```
    Parameters:
    
    key - property key
    
    Returns:
    
    property value or Optional.empty() if value is null or key not present
  - hasControl
```
public final boolean hasControl(Class<? extends Control> type)
```
    Parameters:
    
    type - control type
    
    Returns:
    
    true iff entity has control of given type
  - getControlOptional
```
public final <T extends Control> Optional<T> getControlOptional(Class<T> type)
```
    Returns control of given type or Optional.empty() if no such type is registered on this entity.
    
    Parameters:
    
    type - control type
    
    Returns:
    
    control
  - getControl
```
public final <T extends Control> T getControl(Class<T> type)
```
    Returns control of given type or null if no such type is registered.
    
    Parameters:
    
    type - control type
    
    Returns:
    
    control
  - getControls
```
public final Array<Control> getControls()
```
    Warning: object allocation. Cannot be called during update.
    
    Returns:
    
    array of controls
  - addControl
```
public final void addControl(Control control)
```
    Adds behavior to entity.
    
    Parameters:
    
    control - the behavior
    
    Throws:
    
    IllegalArgumentException - if control with same type already registered or anonymous
    
    IllegalStateException - if components required by the given control are missing or if within update of another control
  - removeControl
```
public final boolean removeControl(Class<? extends Control> type)
```
    Parameters:
    
    type - the control type to remove
    
    Returns:
    
    true if removed, false if not found
    
    Throws:
    
    IllegalStateException - if within update of another control
  - hasComponent
```
public final boolean hasComponent(Class<? extends Component> type)
```
    Parameters:
    
    type - component type
    
    Returns:
    
    true iff entity has a component of given type
  - getComponentOptional
```
public final <T extends Component> Optional<T> getComponentOptional(Class<T> type)
```
    Returns component of given type, or Optional.empty() if type not registered.
    
    Parameters:
    
    type - component type
    
    Returns:
    
    component
  - getComponent
```
public final <T extends Component> T getComponent(Class<T> type)
```
    Returns component of given type, or null if type not registered.
    
    Parameters:
    
    type - component type
    
    Returns:
    
    component
  - getComponents
```
public final Array<Component> getComponents()
```
    Warning: object allocation. Cannot be called during update.
    
    Returns:
    
    array of components
  - addComponent
```
public final void addComponent(Component component)
```
    Adds given component to this entity.
    
    Parameters:
    
    component - the component
    
    Throws:
    
    IllegalArgumentException - if a component with same type already registered or anonymous
    
    IllegalStateException - if components required by the given component are missing
  - removeComponent
```
public final boolean removeComponent(Class<? extends Component> type)
```
    Remove a component with given type from this entity. Core components (type, position, rotation, bbox, view) cannot be removed.
    
    Parameters:
    
    type - type of the component to remove
    
    Returns:
    
    true if removed, false if not found
    
    Throws:
    
    IllegalArgumentException - if the component is required by other components / controls
  - addModuleListener
```
public void addModuleListener(ModuleListener listener)
```
  - removeModuleListener
```
public void removeModuleListener(ModuleListener listener)
```
  - getScriptHandler
```
public final Optional<JavaScriptParser> getScriptHandler(String scriptType)
```
  - copy
```
public Entity copy()
```
    Creates a new instance, which is a copy of this entity. For each copyable component, copy() will be invoked on the component and attached to new instance. For each copyable control, copy() will be invoked on the control and attached to new instance. Components and controls that cannot be copied, must be added manually if required.
    
    Returns:
    
    copy of this entity
  - save
```
public void save(Bundle bundle)
```
    Save entity state into bundle. Only serializable components and controls will be written.
    
    Parameters:
    
    bundle - the bundle to write to
  - load
```
public void load(Bundle bundle)
```
    Load entity state from a bundle. Only serializable components and controls will be read. If an entity has a serializable type that is not present in the bundle, a warning will be logged but no exception thrown.
    
    Parameters:
    
    bundle - bundle to read from
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Entity

Property Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

type

x

y

angle

width

height

active

Constructor Detail

Entity

Method Detail

getWorld

removeFromWorld

getTypeComponent

getPositionComponent

getRotationComponent

getBoundingBoxComponent

getViewComponent

getType

setType

isType

typeProperty

getPosition

setPosition

setPosition

getX

getY

setX

setY

xProperty

yProperty

translate

translate

translate

translateX

translateY

translateTowards

distance

getRotation

setRotation

angleProperty

rotateBy

rotateToVector

getWidth

getHeight

widthProperty

heightProperty

getRightX

getBottomY

getCenter

isColliding

isWithin

getView

setView

setViewFromTexture

setViewFromTextureWithBBox

setViewWithBBox

getRenderLayer

setRenderLayer

setScaleX

setScaleY

activeProperty

isActive

setOnActive

setOnNotActive

setControlsEnabled

getProperties

setProperty

getProperty

getPropertyOptional

hasControl

getControlOptional

getControl

getControls

addControl