com.almasb.fxgl.entity.component

Class IDComponent

java.lang.Object

com.almasb.fxgl.ecs.AbstractComponent

com.almasb.fxgl.entity.component.IDComponent

All Implemented Interfaces:

Component, SerializableComponent, com.almasb.fxgl.io.serialization.SerializableType

public class IDComponent
extends AbstractComponent
implements SerializableComponent

Adds ID to an entity, so it can be uniquely identified.

Author:

Almas Baimagambetov (almaslvl@gmail.com)

Constructor Summary

Constructors

Constructor and Description
IDComponent(String name, int id) Constructs ID component with given entity name and id.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getFullID()
int	getID()
String	getName()
int	hashCode()
void	read(com.almasb.fxgl.io.serialization.Bundle bundle)
String	toString()
void	write(com.almasb.fxgl.io.serialization.Bundle bundle)

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

getEntity, onAdded, onRemoved

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IDComponent

public IDComponent(String name,
                   int id)

Constructs ID component with given entity name and id. The combination of name and id must be unique.

Parameters:

name - string representation of entity name

id - numeric id that uniquely identifies the entity with given name

Method Detail

getName

public final String getName()

Returns:

entity name / string representation

getID

public final int getID()

Returns:

numeric id

getFullID

public final String getFullID()

Returns:

full id, this must be unique

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

write

public void write(@NotNull
                  com.almasb.fxgl.io.serialization.Bundle bundle)

Specified by:

write in interface com.almasb.fxgl.io.serialization.SerializableType

read

public void read(@NotNull
                 com.almasb.fxgl.io.serialization.Bundle bundle)

Specified by:

read in interface com.almasb.fxgl.io.serialization.SerializableType