IIndexedComponent_TValue_.md

Friflo.Engine.ECS

Friflo.Engine.ECS

IIndexedComponent Interface

Is used to define a component type having a single indexed field / property.
Indexed component values can be queried with HasValue() or ValueInRange() in a Query().

public interface IIndexedComponent<out TValue> :
Friflo.Engine.ECS.IComponent

Type parameters

TValue

Derived
↳ ILinkComponent

Implements IComponent

Remarks

This component type enables:

• Add an index component to an entity using AddComponent<T>().
• Return all entities with a component field of a specific value.
  See this[TValue].
• Return a collection of all unique component values.
  See Values.
• Filter entities in a query having a specific component value.
  See HasValue<TComponent,TValue>(TValue).
• Filter entities in a query with a component value in a specific range.
  See ValueInRange<TComponent,TValue>(TValue, TValue).

Methods
GetIndexedValue()	Returns the value of the indexed component field.