Class ComponentRegistry<ECS_TYPE>

java.lang.Object

com.hypixel.hytale.component.ComponentRegistry<ECS_TYPE>

Type Parameters:

ECS_TYPE - The type of ECS instance the registry is associated with.

All Implemented Interfaces:

IComponentRegistry<ECS_TYPE>

public class ComponentRegistry<ECS_TYPE>
extends Object
implements IComponentRegistry<ECS_TYPE>

Contains registered components and systems, and stores for this registry

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ComponentRegistry.Data<ECS_TYPE>	A versioned immutable copy of registry data needed by Store's.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_INITIAL_SIZE
static final int	UNASSIGNED_INDEX

Constructor Summary

Constructors

Constructor	Description
ComponentRegistry()	Default Constructor for a ComponentRegistry instance.

Method Summary

Modifier and Type	Method	Description
ComponentRegistry.Data<ECS_TYPE>	_internal_getData()	Allows for direct access to data from internal system when we already have validated the thread we are on.
Store<ECS_TYPE>	addStore(ECS_TYPE externalData, IResourceStorage resourceStorage)
Store<ECS_TYPE>	addStore(ECS_TYPE externalData, IResourceStorage resourceStorage, Consumer<Store<ECS_TYPE>> consumer)
void	assertInStoreThread()
<T extends Component<ECS_TYPE>> T	createComponent(ComponentType<ECS_TYPE,T> componentType)
Holder<ECS_TYPE>	deserialize(org.bson.BsonDocument entityDocument)
Holder<ECS_TYPE>	deserialize(org.bson.BsonDocument entityDocument, int version)	Deprecated.
SystemType<ECS_TYPE, ArchetypeTickingSystem<ECS_TYPE>>	getArchetypeTickingSystemType()
ComponentRegistry.Data<ECS_TYPE>	getData()
ReadWriteLock	getDataUpdateLock()
BuilderCodec<Holder<ECS_TYPE>>	getEntityCodec()
<T extends EcsEvent> EntityEventType<ECS_TYPE,T>	getEntityEventTypeForClass(Class<T> eClass)
<T extends EcsEvent> EntityHolderEventType<ECS_TYPE,T>	getEntityHolderEventTypeForClass(Class<T> eClass)
SystemType<ECS_TYPE, HolderSystem<ECS_TYPE>>	getHolderSystemType()
ComponentType<ECS_TYPE, NonSerialized<ECS_TYPE>>	getNonSerializedComponentType()
ComponentType<ECS_TYPE, NonTicking<ECS_TYPE>>	getNonTickingComponentType()
SystemType<ECS_TYPE, QuerySystem<ECS_TYPE>>	getQuerySystemType()
SystemType<ECS_TYPE, RefChangeSystem<ECS_TYPE,?>>	getRefChangeSystemType()
SystemType<ECS_TYPE, RefSystem<ECS_TYPE>>	getRefSystemType()
SystemType<ECS_TYPE, RunWhenPausedSystem<ECS_TYPE>>	getRunWhenPausedSystemType()
SystemType<ECS_TYPE, TickableSystem<ECS_TYPE>>	getTickableSystemType()
SystemType<ECS_TYPE, TickingSystem<ECS_TYPE>>	getTickingSystemType()
ComponentType<ECS_TYPE, UnknownComponents<ECS_TYPE>>	getUnknownComponentType()
<T extends EcsEvent> WorldEventType<ECS_TYPE,T>	getWorldEventTypeForClass(Class<T> eClass)
boolean	hasSystem(ISystem<ECS_TYPE> system)
<T extends ISystem<ECS_TYPE>> boolean	hasSystemClass(Class<T> systemClass)
boolean	hasSystemGroup(SystemGroup<ECS_TYPE> group)
<T extends ISystem<ECS_TYPE>> boolean	hasSystemType(SystemType<ECS_TYPE,T> systemType)
boolean	isShutdown()
Holder<ECS_TYPE>	newHolder()
Holder<ECS_TYPE>	newHolder(Archetype<ECS_TYPE> archetype, Component<ECS_TYPE>[] components)
<T extends Component<ECS_TYPE>> ComponentType<ECS_TYPE,T>	registerComponent(Class<? super T> tClass, String id, BuilderCodec<T> codec)	Called to register a new component, providing the given class, id and codec.
<T extends Component<ECS_TYPE>> ComponentType<ECS_TYPE,T>	registerComponent(Class<? super T> tClass, String id, BuilderCodec<T> codec, boolean skipValidation)	Deprecated. Used to bypass validation for legacy components
<T extends Component<ECS_TYPE>> ComponentType<ECS_TYPE,T>	registerComponent(Class<? super T> tClass, Supplier<T> supplier)	Called to register a new component, providing the given class and constructor supplier.
<T extends EcsEvent> EntityEventType<ECS_TYPE,T>	registerEntityEventType(Class<? super T> eventTypeClass)	Called to register a new entity event type, providing the given class.
<T extends Resource<ECS_TYPE>> ResourceType<ECS_TYPE,T>	registerResource(Class<? super T> tClass, String id, BuilderCodec<T> codec)	Called to register a new resource, providing the given class, id and codec.
<T extends Resource<ECS_TYPE>> ResourceType<ECS_TYPE,T>	registerResource(Class<? super T> tClass, Supplier<T> supplier)	Called to register a new resource, providing the given class and constructor supplier.
ResourceType<ECS_TYPE, SpatialResource<Ref<ECS_TYPE>, ECS_TYPE>>	registerSpatialResource(Supplier<SpatialStructure<Ref<ECS_TYPE>>> supplier)	Registers a spatial resource with the given supplier for creating spatial structures.
void	registerSystem(ISystem<ECS_TYPE> system)	Called to register a new system, providing the given system instance.
void	registerSystem(ISystem<ECS_TYPE> system, boolean bypassClassCheck)	Deprecated, for removal: This API element is subject to removal in a future version.
SystemGroup<ECS_TYPE>	registerSystemGroup()
SystemGroup<ECS_TYPE>	registerSystemGroup(Set<Dependency<ECS_TYPE>> dependencies)
<T extends ISystem<ECS_TYPE>> SystemType<ECS_TYPE,T>	registerSystemType(Class<? super T> systemTypeClass)	Called to register a new system type, providing the given class.
<T extends EcsEvent> WorldEventType<ECS_TYPE,T>	registerWorldEventType(Class<? super T> eventTypeClass)	Called to register a new world event type, providing the given class.
void	removeStore(Store<ECS_TYPE> store)
org.bson.BsonDocument	serialize(Holder<ECS_TYPE> holder)
void	shutdown()
String	toString()
<T extends Component<ECS_TYPE>> void	unregisterComponent(ComponentType<ECS_TYPE,T> componentType)
<T extends EcsEvent> void	unregisterEntityEventType(EntityEventType<ECS_TYPE,T> eventType)
<T extends EcsEvent> void	unregisterEntityHolderEventType(EntityHolderEventType<ECS_TYPE,T> eventType)
<T extends Resource<ECS_TYPE>> void	unregisterResource(ResourceType<ECS_TYPE,T> resourceType)
void	unregisterSystem(Class<? extends ISystem<ECS_TYPE>> systemClass)
void	unregisterSystemGroup(SystemGroup<ECS_TYPE> systemGroup)
<T extends ISystem<ECS_TYPE>> void	unregisterSystemType(SystemType<ECS_TYPE,T> systemType)
<T extends EcsEvent> void	unregisterWorldEventType(WorldEventType<ECS_TYPE,T> eventType)

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

UNASSIGNED_INDEX

public static final int UNASSIGNED_INDEX

See Also:

• Constant Field Values

DEFAULT_INITIAL_SIZE

public static final int DEFAULT_INITIAL_SIZE

See Also:

• Constant Field Values

Constructor Details

ComponentRegistry

public ComponentRegistry()

Default Constructor for a ComponentRegistry instance.

Method Details

isShutdown

public boolean isShutdown()

shutdown

public void shutdown()

getDataUpdateLock

@Nonnull
public ReadWriteLock getDataUpdateLock()

getUnknownComponentType

@Nonnull
public ComponentType<ECS_TYPE, UnknownComponents<ECS_TYPE>> getUnknownComponentType()

getNonTickingComponentType

@Nonnull
public ComponentType<ECS_TYPE, NonTicking<ECS_TYPE>> getNonTickingComponentType()

getNonSerializedComponentType

@Nonnull
public ComponentType<ECS_TYPE, NonSerialized<ECS_TYPE>> getNonSerializedComponentType()

getHolderSystemType

@Nonnull
public SystemType<ECS_TYPE, HolderSystem<ECS_TYPE>> getHolderSystemType()

getRefSystemType

@Nonnull
public SystemType<ECS_TYPE, RefSystem<ECS_TYPE>> getRefSystemType()

getRefChangeSystemType

@Nonnull
public SystemType<ECS_TYPE, RefChangeSystem<ECS_TYPE,?>> getRefChangeSystemType()

getQuerySystemType

@Nonnull
public SystemType<ECS_TYPE, QuerySystem<ECS_TYPE>> getQuerySystemType()

getTickingSystemType

@Nonnull
public SystemType<ECS_TYPE, TickingSystem<ECS_TYPE>> getTickingSystemType()

getTickableSystemType

@Nonnull
public SystemType<ECS_TYPE, TickableSystem<ECS_TYPE>> getTickableSystemType()

getRunWhenPausedSystemType

@Nonnull
public SystemType<ECS_TYPE, RunWhenPausedSystem<ECS_TYPE>> getRunWhenPausedSystemType()

getArchetypeTickingSystemType

@Nonnull
public SystemType<ECS_TYPE, ArchetypeTickingSystem<ECS_TYPE>> getArchetypeTickingSystemType()

registerComponent

@Nonnull
public <T extends Component<ECS_TYPE>>
ComponentType<ECS_TYPE,T> registerComponent(@Nonnull
 Class<? super T> tClass,
 @Nonnull
 Supplier<T> supplier)

Description copied from interface: IComponentRegistry

Called to register a new component, providing the given class and constructor supplier.

Specified by:

registerComponent in interface IComponentRegistry<ECS_TYPE>

Type Parameters:

T - The type of the component.

Parameters:

tClass - The class of the component to register.

supplier - The supplier to use to create new instances of the component.

Returns:

The registered component type.

registerComponent

@Nonnull
public <T extends Component<ECS_TYPE>>
ComponentType<ECS_TYPE,T> registerComponent(@Nonnull
 Class<? super T> tClass,
 @Nonnull
 String id,
 @Nonnull
 BuilderCodec<T> codec)

Description copied from interface: IComponentRegistry

Called to register a new component, providing the given class, id and codec.

The codec allows for serialization and deserialization of the component, enabling it to be saved and loaded as needed.

Specified by:

registerComponent in interface IComponentRegistry<ECS_TYPE>

Type Parameters:

T - The type of the component.

Parameters:

tClass - The class of the component to register.

id - The unique identifier for the component.

codec - The codec used for serialization and deserialization of the component.

Returns:

The registered component type.

registerComponent

@Deprecated
@Nonnull
public <T extends Component<ECS_TYPE>>
ComponentType<ECS_TYPE,T> registerComponent(@Nonnull
 Class<? super T> tClass,
 @Nonnull
 String id,
 @Nonnull
 BuilderCodec<T> codec,
 boolean skipValidation)

Deprecated.

Used to bypass validation for legacy components

Type Parameters:

T -

Returns:

unregisterComponent

public <T extends Component<ECS_TYPE>> void unregisterComponent(@Nonnull
 ComponentType<ECS_TYPE,T> componentType)

registerResource

@Nonnull
public <T extends Resource<ECS_TYPE>>
ResourceType<ECS_TYPE,T> registerResource(@Nonnull
 Class<? super T> tClass,
 @Nonnull
 Supplier<T> supplier)

Description copied from interface: IComponentRegistry

Called to register a new resource, providing the given class and constructor supplier.

Specified by:

registerResource in interface IComponentRegistry<ECS_TYPE>

Type Parameters:

T - The type of the resource.

Parameters:

tClass - The class of the resource to register.

supplier - The supplier to use to create new instances of the resource.

Returns:

The registered resource type.

registerResource

@Nonnull
public <T extends Resource<ECS_TYPE>>
ResourceType<ECS_TYPE,T> registerResource(@Nonnull
 Class<? super T> tClass,
 @Nonnull
 String id,
 @Nonnull
 BuilderCodec<T> codec)

Description copied from interface: IComponentRegistry

Called to register a new resource, providing the given class, id and codec.

Specified by:

registerResource in interface IComponentRegistry<ECS_TYPE>

Type Parameters:

T - The type of the resource.

Parameters:

tClass - The class of the resource to register.

id - The unique identifier for the resource.

codec - The codec used for serialization and deserialization of the resource.

Returns:

The registered resource type.

unregisterResource

public <T extends Resource<ECS_TYPE>> void unregisterResource(@Nonnull
 ResourceType<ECS_TYPE,T> resourceType)

registerSystemType

@Nonnull
public <T extends ISystem<ECS_TYPE>>
SystemType<ECS_TYPE,T> registerSystemType(@Nonnull
 Class<? super T> systemTypeClass)

Description copied from interface: IComponentRegistry

Called to register a new system type, providing the given class.

Specified by:

registerSystemType in interface IComponentRegistry<ECS_TYPE>

Type Parameters:

T - The type of the system.

Parameters:

systemTypeClass - The class of the system type to register.

Returns:

The registered system type.

unregisterSystemType

public <T extends ISystem<ECS_TYPE>> void unregisterSystemType(@Nonnull
 SystemType<ECS_TYPE,T> systemType)

registerEntityEventType

@Nonnull
public <T extends EcsEvent>
EntityEventType<ECS_TYPE,T> registerEntityEventType(@Nonnull
 Class<? super T> eventTypeClass)

Description copied from interface: IComponentRegistry

Called to register a new entity event type, providing the given class.

Specified by:

registerEntityEventType in interface IComponentRegistry<ECS_TYPE>

Type Parameters:

T - The type of the event.

Parameters:

eventTypeClass - The class of the event type to register.

Returns:

The registered entity event type.

registerWorldEventType

@Nonnull
public <T extends EcsEvent>
WorldEventType<ECS_TYPE,T> registerWorldEventType(@Nonnull
 Class<? super T> eventTypeClass)

Description copied from interface: IComponentRegistry

Called to register a new world event type, providing the given class.

Specified by:

registerWorldEventType in interface IComponentRegistry<ECS_TYPE>

Type Parameters:

T - The type of the event.

Parameters:

eventTypeClass - The class of the event type to register.

Returns:

The registered world event type.

unregisterEntityEventType

public <T extends EcsEvent> void unregisterEntityEventType(@Nonnull
 EntityEventType<ECS_TYPE,T> eventType)

unregisterEntityHolderEventType

public <T extends EcsEvent> void unregisterEntityHolderEventType(@Nonnull
 EntityHolderEventType<ECS_TYPE,T> eventType)

unregisterWorldEventType

public <T extends EcsEvent> void unregisterWorldEventType(@Nonnull
 WorldEventType<ECS_TYPE,T> eventType)

registerSystemGroup

@Nonnull
public SystemGroup<ECS_TYPE> registerSystemGroup()

Specified by:

registerSystemGroup in interface IComponentRegistry<ECS_TYPE>

Returns:

A newly created system group instance.

registerSystemGroup

@Nonnull
public SystemGroup<ECS_TYPE> registerSystemGroup(Set<Dependency<ECS_TYPE>> dependencies)

unregisterSystemGroup

public void unregisterSystemGroup(@Nonnull
 SystemGroup<ECS_TYPE> systemGroup)

registerSystem

public void registerSystem(@Nonnull
 ISystem<ECS_TYPE> system)

Description copied from interface: IComponentRegistry

Called to register a new system, providing the given system instance.

Specified by:

registerSystem in interface IComponentRegistry<ECS_TYPE>

Parameters:

system - The system instance to register.

registerSystem

@Deprecated(forRemoval=true)
public void registerSystem(@Nonnull
 ISystem<ECS_TYPE> system,
 boolean bypassClassCheck)

Deprecated, for removal: This API element is subject to removal in a future version.

unregisterSystem

public void unregisterSystem(@Nonnull
 Class<? extends ISystem<ECS_TYPE>> systemClass)

registerSpatialResource

@Nonnull
public ResourceType<ECS_TYPE, SpatialResource<Ref<ECS_TYPE>, ECS_TYPE>> registerSpatialResource(@Nonnull
 Supplier<SpatialStructure<Ref<ECS_TYPE>>> supplier)

Description copied from interface: IComponentRegistry

Registers a spatial resource with the given supplier for creating spatial structures.

Specified by:

registerSpatialResource in interface IComponentRegistry<ECS_TYPE>

Parameters:

supplier - The supplier that provides instances of SpatialStructure.

Returns:

The registered spatial resource type.

addStore

@Nonnull
public Store<ECS_TYPE> addStore(@Nonnull
 ECS_TYPE externalData,
 @Nonnull
 IResourceStorage resourceStorage)

addStore

@Nonnull
public Store<ECS_TYPE> addStore(@Nonnull
 ECS_TYPE externalData,
 @Nonnull
 IResourceStorage resourceStorage,
 Consumer<Store<ECS_TYPE>> consumer)

removeStore

public void removeStore(@Nonnull
 Store<ECS_TYPE> store)

newHolder

@Nonnull
public Holder<ECS_TYPE> newHolder()

newHolder

@Nonnull
public Holder<ECS_TYPE> newHolder(@Nonnull
 Archetype<ECS_TYPE> archetype,
 @Nonnull
 Component<ECS_TYPE>[] components)

_internal_getData

public ComponentRegistry.Data<ECS_TYPE> _internal_getData()

Allows for direct access to data from internal system when we already have validated the thread we are on.

getData

public ComponentRegistry.Data<ECS_TYPE> getData()

Returns:

getEntityCodec

@Nonnull
public BuilderCodec<Holder<ECS_TYPE>> getEntityCodec()

assertInStoreThread

public void assertInStoreThread()

Throws:

AssertionError - if the current thread isn't one of the registered store threads.

deserialize

@Nullable
public Holder<ECS_TYPE> deserialize(@Nonnull
 org.bson.BsonDocument entityDocument)

deserialize

@Nullable
@Deprecated
public Holder<ECS_TYPE> deserialize(@Nonnull
 org.bson.BsonDocument entityDocument,
 int version)

Deprecated.

serialize

public org.bson.BsonDocument serialize(@Nonnull
 Holder<ECS_TYPE> holder)

hasSystem

public boolean hasSystem(@Nonnull
 ISystem<ECS_TYPE> system)

hasSystemClass

public <T extends ISystem<ECS_TYPE>> boolean hasSystemClass(@Nonnull
 Class<T> systemClass)

hasSystemType

public <T extends ISystem<ECS_TYPE>> boolean hasSystemType(@Nonnull
 SystemType<ECS_TYPE,T> systemType)

hasSystemGroup

public boolean hasSystemGroup(@Nonnull
 SystemGroup<ECS_TYPE> group)

getEntityEventTypeForClass

@Nullable
public <T extends EcsEvent>
EntityEventType<ECS_TYPE,T> getEntityEventTypeForClass(Class<T> eClass)

getEntityHolderEventTypeForClass

@Nullable
public <T extends EcsEvent>
EntityHolderEventType<ECS_TYPE,T> getEntityHolderEventTypeForClass(Class<T> eClass)

getWorldEventTypeForClass

@Nullable
public <T extends EcsEvent>
WorldEventType<ECS_TYPE,T> getWorldEventTypeForClass(Class<T> eClass)

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

createComponent

public <T extends Component<ECS_TYPE>> T createComponent(@Nonnull
 ComponentType<ECS_TYPE,T> componentType)