Skip to content

Latest commit

 

History

History
52 lines (38 loc) · 6.82 KB

AEntitySortedSetSystem_TState,TComponent_.md

File metadata and controls

52 lines (38 loc) · 6.82 KB

DefaultEcs

DefaultEcs.System

AEntitySortedSetSystem<TState,TComponent> Class

Represents a base class to process updates on a given EntitySortedSet<TComponent> instance.
Only Get<T>() operations on already present component type are safe.
Any other operation maybe change the inner EntitySortedSet<TComponent> and should be done either by using setting "useBuffer" of the available constructors to true or using an EntityCommandRecorder.

public abstract class AEntitySortedSetSystem<TState,TComponent> :
DefaultEcs.System.ISystem<TState>,
System.IDisposable

Type parameters

TState

The type of the object used as state to update the system.

TComponent

The type of the component to sort Entity by.

Inheritance System.Object 🡒 AEntitySortedSetSystem<TState,TComponent>

Implements DefaultEcs.System.ISystem<TState>, System.IDisposable

Constructors
AEntitySortedSetSystem(EntitySortedSet<TComponent>, bool) Initialise a new instance of the AEntitySortedSetSystem<TState,TComponent> class with the given EntitySortedSet<TComponent>.
AEntitySortedSetSystem(World, bool) Initialise a new instance of the AEntitySortedSetSystem<TState,TComponent> class with the given World and factory.
To create the inner EntitySet, WithAttribute and WithoutAttribute attributes will be used.
AEntitySortedSetSystem(World, Func<object,World,EntitySortedSet<TComponent>>, bool) Initialise a new instance of the AEntitySortedSetSystem<TState,TComponent> class with the given World and factory.
To create the inner EntitySet, WithAttribute and WithoutAttribute attributes will be used.
Properties
IsEnabled Gets or sets whether the current AEntitySortedSetSystem<TState,TComponent> instance should update or not.
SortedSet Gets the EntitySortedSet<TComponent> instance on which this system operates.
World Gets the World instance on which this system operates.
Methods
Dispose() Disposes of the inner EntitySortedSet<TComponent> instance.
PostUpdate(TState) Performs a post-update treatment.
PreUpdate(TState) Performs a pre-update treatment.
Update(TState) Updates the system once.
Does nothing if IsEnabled is false or if the inner EntitySortedSet<TComponent> is empty.
Update(TState, Entity) Update the given Entity instance once.
Update(TState, ReadOnlySpan<Entity>) Update the given Entity instances once.