Interface ReadWriteArchetypeQuery<ECS_TYPE>

All Superinterfaces:

Query<ECS_TYPE>

All Known Implementing Classes:

ReadWriteQuery

public interface ReadWriteArchetypeQuery<ECS_TYPE>
extends Query<ECS_TYPE>

Since:

2020/08/14

Method Summary

Modifier and Type	Method	Description
Archetype<ECS_TYPE>	getReadArchetype()	The component types that are read from
Archetype<ECS_TYPE>	getWriteArchetype()	The component types that are modified
default boolean	requiresComponentType(ComponentType<ECS_TYPE,?> componentType)	Controls if the system should be automatically unregistered if a component type is removed.
default boolean	test(Archetype<ECS_TYPE> archetype)	Controls if this query should processes the provided Archetype.
default void	validate()	Validates the internal state of this query.
default void	validateRegistry(ComponentRegistry<ECS_TYPE> registry)	Validates that the provided ComponentRegistry is compatible with this query.

Method Details

getReadArchetype

Archetype<ECS_TYPE> getReadArchetype()

The component types that are read from

getWriteArchetype

Archetype<ECS_TYPE> getWriteArchetype()

The component types that are modified

test

default boolean test(@Nonnull
 Archetype<ECS_TYPE> archetype)

Controls if this query should processes the provided Archetype.

Specified by:

test in interface Query<ECS_TYPE>

Returns:

true if the archetype param contains both getReadArchetype() and getWriteArchetype().

requiresComponentType

default boolean requiresComponentType(@Nonnull
 ComponentType<ECS_TYPE,?> componentType)

Controls if the system should be automatically unregistered if a component type is removed.

Specified by:

requiresComponentType in interface Query<ECS_TYPE>

Returns:

true if the componentType param is in either getReadArchetype() or getWriteArchetype().

validateRegistry

default void validateRegistry(@Nonnull
 ComponentRegistry<ECS_TYPE> registry)

Description copied from interface: Query

Validates that the provided ComponentRegistry is compatible with this query.

Specified by:

validateRegistry in interface Query<ECS_TYPE>

Parameters:

registry - The component registry to validate against.

validate

default void validate()

Description copied from interface: Query

Validates the internal state of this query.

Specified by:

validate in interface Query<ECS_TYPE>