Class EntityPulseScheduler

Represents a PulseScheduler that processes entities matching a query.

Hierarchy (View Summary)

PulseScheduler<Entity>
- EntityPulseScheduler

Index

Constructors

Properties

items processor

Methods

add addAll getItems pop push remove removeIf shift splice start stop unshift

Constructors

constructor

new EntityPulseScheduler(
    processor: (t: Entity) => void,
    period: number,
    queryOptions: EntityQueryOptions,
): EntityPulseScheduler
Creates a new EntityPulseScheduler instance.
Parameters
- processor: (t: Entity) => void
- period: number
  The period of the scheduler.
- queryOptions: EntityQueryOptions
  The query options to use when querying for entities.
Returns EntityPulseScheduler
Overrides PulseScheduler.constructor
- Defined in index.d.ts:1144

Properties

`Protected`items

items: Entity[]

processor

processor: (t: Entity) => void

Methods

add

add(item: Entity): void
Adds an item to the schedule.
Parameters
- item: Entity
  The item to be added.
Returns void
Deprecated
Use push instead.
Inherited from PulseScheduler.add
- Defined in index.d.ts:1065

addAll

addAll(items: Entity[]): void
Adds multiple items to the schedule.
Parameters
- items: Entity[]
  The items to be added.
Returns void
Deprecated
Use push instead.
Inherited from PulseScheduler.addAll
- Defined in index.d.ts:1072

getItems

getItems(): readonly Entity[]
Returns a list of the items in the schedule.

Returns readonly Entity[]
Inherited from PulseScheduler.getItems
- Defined in index.d.ts:1087

pop

pop(): undefined | Entity
Returns undefined | Entity
Inherited from PulseScheduler.pop
- Defined in index.d.ts:1099

push

push(...items: Entity[]): number
Parameters
- ...items: Entity[]
Returns number
Overrides PulseScheduler.push
- Defined in index.d.ts:1152

remove

remove(index: number): void
Removes an item from the schedule at the specified index.
Parameters
- index: number
  The index of the item to remove.
Returns void
Inherited from PulseScheduler.remove
- Defined in index.d.ts:1077

removeIf

removeIf(predicate: (t: Entity) => boolean): void
Removes items from the schedule that satisfy the given predicate.
Parameters
- predicate: (t: Entity) => boolean
  The predicate function used to determine if an item should be removed.
Returns void
Inherited from PulseScheduler.removeIf
- Defined in index.d.ts:1083

shift

shift(): undefined | Entity
Returns undefined | Entity
Inherited from PulseScheduler.shift
- Defined in index.d.ts:1100

splice

splice(start: number, deleteCount?: number): Entity[]
Parameters
- start: number
- OptionaldeleteCount: number
Returns Entity[]
Overrides PulseScheduler.splice
- Defined in index.d.ts:1154
splice(start: number, deleteCount: number, ...items: Entity[]): Entity[]
Parameters
- start: number
- deleteCount: number
- ...items: Entity[]
Returns Entity[]
Overrides PulseScheduler.splice
- Defined in index.d.ts:1155

start

start(): void
Starts the schedule.

Returns void
Overrides PulseScheduler.start
- Defined in index.d.ts:1146

stop

stop(): void
Stops the schedule.

Returns void
Inherited from PulseScheduler.stop
- Defined in index.d.ts:1095

unshift

unshift(...items: Entity[]): number
Parameters
- ...items: Entity[]
Returns number
Overrides PulseScheduler.unshift
- Defined in index.d.ts:1153