Class EntityPulseScheduler

Represents a PulseScheduler that processes entities matching a query.

Hierarchy

PulseScheduler<Entity>
- EntityPulseScheduler

Index

Constructors

Properties

addIfMatchesWithRetry compareEntities items processor queryOptions logger

Methods

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

Constructors

constructor

new EntityPulseScheduler(processor, period, queryOptions): EntityPulseScheduler
Creates a new EntityPulseScheduler instance.
Parameters
- processor: ((t) => void)
  - - (t): void
    - Parameters
      
      t: Entity
      
      Returns 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:1153

Properties

`Private` addIfMatchesWithRetry

addIfMatchesWithRetry: any

Adds an entity to the scheduler if it matches the query options. In case the entity is not valid, it will retry a tick later.

Param

The entity to add.

`Private` compareEntities

compareEntities: any

`Protected` items

items: Entity[]

processor

processor: ((t) => void)

Type declaration

- (t): void
- Parameters
  - t: Entity
  Returns void

`Private` queryOptions

queryOptions: any

`Static` `Private` `Readonly` logger

logger: any

Methods

add

add(item): 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:1074

addAll

addAll(items): 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:1081

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:1096

pop

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

push

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

remove

remove(index): 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:1086

removeIf

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

shift

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

splice

splice(start, deleteCount?): Entity[]
Parameters
- start: number
- Optional deleteCount: number
Returns Entity[]
Overrides PulseScheduler.splice
- Defined in index.d.ts:1163
splice(start, deleteCount, ...items): Entity[]
Parameters
- start: number
- deleteCount: number
- Rest ...items: Entity[]
Returns Entity[]
Overrides PulseScheduler.splice
- Defined in index.d.ts:1164

start

start(): void
Starts the schedule.

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

stop

stop(): void
Stops the schedule.

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

unshift

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