com.almasb.fxgl.ecs.component

Class StringComponent

java.lang.Object

com.almasb.fxgl.ecs.Module

com.almasb.fxgl.ecs.Component

com.almasb.fxgl.ecs.component.StringComponent

All Implemented Interfaces:

SerializableComponent

public abstract class StringComponent
extends Component
implements SerializableComponent

Represents a String value based component.

 Example:

 public class NameComponent extends StringComponent {
      public NameComponent(String initialValue) {
          super(initialValue);
      }
 }

 Entity player = ...
 player.addComponent(new NameComponent("PlayerName"));

 String name = player.getComponent(NameComponent.class).getValue();

 

Author:

Almas Baimagambetov (AlmasB) ([email protected])

Property Summary

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

Constructor Summary

Constructors

Constructor and Description
StringComponent() No-arg ctor, initializes the value to empty string.
StringComponent(String initialValue) Constructs a string value component with given initial value.

Method Summary

Modifier and Type	Method and Description
String	getValue()
void	read(Bundle bundle)
void	setValue(String value) Set value to this component.
String	toString()
javafx.beans.property.StringProperty	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.StringProperty valueProperty

See Also:

getValue(), setValue(String)

Constructor Detail

StringComponent

public StringComponent()

No-arg ctor, initializes the value to empty string.

StringComponent

public StringComponent(String initialValue)

Constructs a string value component with given initial value.

Parameters:

initialValue - the initial value

Method Detail

valueProperty

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

See Also:

getValue(), setValue(String)

getValue

public final String getValue()

Returns:

value held by this component

setValue

public final void setValue(String value)

Set value to 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