Class Optional<T>

Marks a component in a query as optional. Optional components do not affect archetype matching and are returned as undefined when absent.

Type Parameters

T

Hierarchy (View Summary)

QueryFilter
- Optional

Index

Constructors

Properties

typeid typeTransform

Methods

archetype isRequired

Constructors

constructor

new Optional<T>(component: Constructor<T>): Optional<T>
Type Parameters
- T
Parameters
- component: Constructor<T>
Returns Optional<T>
Overrides QueryFilter.constructor
- Defined in packages/ecs/src/query/filters/filter.js:92

Properties

typeid

typeid: TypeId

typeTransform

typeTransform: OptionalTransform<T>

Methods

archetype

archetype(_types: readonly TypeId[]): boolean
Parameters
- _types: readonly TypeId[]
Returns boolean
Overrides QueryFilter.archetype
- Defined in packages/ecs/src/query/filters/filter.js:106

isRequired

isRequired(type: TypeId): boolean
Parameters
- type: TypeId
Returns boolean
Overrides QueryFilter.isRequired
- Defined in packages/ecs/src/query/filters/filter.js:101