Entity (fxgl 0.3.7 API)

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

Direct Known Subclasses:

GameEntity
```
public class Entity
extends Object
```
A generic entity in the Entity-Component-System (Control) model. During update (or control update) it is not allowed to:
- Add control
- Remove control
Author:

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

Property Summary

All Methods Instance Methods Concrete Methods
Type Property and Description

javafx.beans.property.ReadOnlyBooleanProperty active

All Methods Instance Methods Concrete Methods
Type	Property and Description
`javafx.beans.property.ReadOnlyBooleanProperty`	`active`

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)`
`Entity`	`copy()` Creates a new instance, which is a copy of this entity.
`<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.
`<T> T`	`getProperty(String key)`
`GameWorld`	`getWorld()`
`boolean`	`hasComponent(Class<? extends Component> type)`
`boolean`	`hasControl(Class<? extends Control> type)`
`boolean`	`isActive()` Entity is "active" from the moment it is added to the world and until it is removed from the world.
`void`	`load(Bundle bundle)` Load entity state from a bundle.
`void`	`removeAllComponents()`
`void`	`removeAllControls()`
`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`	`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`	`setProperty(String key, Object value)`
`String`	`toString()`

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

- Property Detail
  - 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);
  - 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 be executed immediately 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 be executed immediately 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
  - 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
    
    Throws:
    
    IllegalArgumentException - if key doesn't exist
  - 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. Cannot add controls within update() of another control.
    
    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
  - removeControl
```
public final boolean removeControl(Class<? extends Control> type)
```
    Parameters:
    
    type - the control type to remove
    
    Returns:
    
    true if removed, false if not found
  - removeAllControls
```
public final void removeAllControls()
```
  - 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.
    
    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
  - removeAllComponents
```
public final void removeAllComponents()
```
  - addModuleListener
```
public void addModuleListener(ModuleListener listener)
```
  - removeModuleListener
```
public void removeModuleListener(ModuleListener listener)
```
  - 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

active

Constructor Detail

Entity

Method Detail

getWorld

removeFromWorld

activeProperty

isActive

setOnActive

setOnNotActive

setControlsEnabled

setProperty

getProperty

hasControl

getControlOptional

getControl

getControls

addControl

removeControl

removeAllControls

hasComponent

getComponentOptional

getComponent

getComponents

addComponent

removeComponent

removeAllComponents

addModuleListener

removeModuleListener

copy

save

load

toString