com.almasb.fxgl.ecs.component

Class BooleanComponent

java.lang.Object

com.almasb.fxgl.ecs.Module

com.almasb.fxgl.ecs.Component

com.almasb.fxgl.ecs.component.BooleanComponent

All Implemented Interfaces:

SerializableComponent

Direct Known Subclasses:

CollidableComponent, SelectableComponent

public abstract class BooleanComponent
extends Component
implements SerializableComponent

Represents a boolean value based component.

 Example:

 public class GravityComponent extends BooleanComponent {
      public GravityComponent(boolean initialValue) {
          super(initialValue);
      }
 }

 Entity player = ...
 player.addComponent(new GravityComponent(true));

 boolean gravityEnabled = player.getComponent(GravityComponent.class).getValue();

 

Author:

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

Property Summary

Type	Property and Description
javafx.beans.property.BooleanProperty	value

Constructor Summary

Constructors

Constructor and Description
BooleanComponent() No-arg ctor, initializes the value to false.
BooleanComponent(boolean initialValue) Constructs a boolean value component with given initial value.

Method Summary

Modifier and Type	Method and Description
boolean	getValue()
void	read(Bundle bundle)
void	setValue(boolean value) Set value of this component.
String	toString()
javafx.beans.property.BooleanProperty	valueProperty()
void	write(Bundle bundle)

Methods inherited from class com.almasb.fxgl.ecs.Module

getEntity, onAdded, onRemoved

Methods inherited from class java.lang.Object

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

Property Detail

value

public final javafx.beans.property.BooleanProperty valueProperty

See Also:

getValue(), setValue(boolean)

Constructor Detail

BooleanComponent

public BooleanComponent()

No-arg ctor, initializes the value to false.

BooleanComponent

public BooleanComponent(boolean initialValue)

Constructs a boolean value component with given initial value.

Parameters:

initialValue - initial value

Method Detail

valueProperty

public final javafx.beans.property.BooleanProperty valueProperty()

See Also:

getValue(), setValue(boolean)

getValue

public final boolean getValue()

Returns:

value held by this component

setValue

public final void setValue(boolean value)

Set value of this component.

Parameters:

value - new value

write

public void write(@NotNull
                  Bundle bundle)

read

public void read(@NotNull
                 Bundle bundle)

toString

public String toString()

Overrides:

toString in class Object