com.almasb.fxgl.entity.component

Class TypeComponent

java.lang.Object

com.almasb.fxgl.ecs.Module

com.almasb.fxgl.ecs.Component

com.almasb.fxgl.ecs.component.ObjectComponent<Serializable>

com.almasb.fxgl.entity.component.TypeComponent

All Implemented Interfaces:

CopyableComponent<TypeComponent>, SerializableComponent

public class TypeComponent
extends ObjectComponent<Serializable>
implements SerializableComponent, CopyableComponent<TypeComponent>

Represents an entity type.

Author:

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

Property Summary

Properties inherited from class com.almasb.fxgl.ecs.component.ObjectComponent

valueProperty

Constructor Summary

Constructors

Constructor and Description
TypeComponent() Constructs a component with no type.
TypeComponent(Serializable type) Constructs a component with given type.

Method Summary

Modifier and Type	Method and Description
TypeComponent	copy() Copies this component.
boolean	isType(Object type) Example: entity.getTypeComponent().isType(Type.PLAYER);
void	read(Bundle bundle)
String	toString()
void	write(Bundle bundle)

Methods inherited from class com.almasb.fxgl.ecs.component.ObjectComponent

getValue, setValue, valueProperty

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

Constructor Detail

TypeComponent

public TypeComponent()

Constructs a component with no type.

TypeComponent

public TypeComponent(Serializable type)

Constructs a component with given type. Note: although the type could be any object, it is recommended that an enum is used to represent types.

Parameters:

type - entity type

Method Detail

isType

public boolean isType(Object type)

     Example:
     entity.getTypeComponent().isType(Type.PLAYER);
 

Parameters:

type - entity type

Returns:

true iff this type component is of given type

toString

public String toString()

Overrides:

toString in class ObjectComponent<Serializable>

write

public void write(@NotNull
                  Bundle bundle)

read

public void read(@NotNull
                 Bundle bundle)

copy

public TypeComponent copy()

Description copied from interface: CopyableComponent

Copies this component. The general contract should be similar to Object.clone(). The 'depth' of the copy should be determined by the user.

Specified by:

copy in interface CopyableComponent<TypeComponent>

Returns:

new instance (copy) of the component with copied values