Class PlayerPulseScheduler

Represents a PulseScheduler that processes players.

Hierarchy (View Summary)

PulseScheduler<Player>
- PlayerPulseScheduler

Index

Constructors

Properties

items processor

Methods

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

Constructors

constructor

new PlayerPulseScheduler(
processor: (t: Player) => void,
period: number,
): PlayerPulseScheduler
Creates a new EntityPulseScheduler instance.
Parameters
- processor: (t: Player) => void
- period: number
  The period of the scheduler.
Returns PlayerPulseScheduler
Overrides PulseScheduler.constructor
- Defined in index.d.ts:1168

Properties

`Protected`items

items: Player[]

processor

processor: (t: Player) => void

Methods

add

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

addAll

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

getItems

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

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

pop

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

push

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

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: Player) => boolean): void
Removes items from the schedule that satisfy the given predicate.
Parameters
- predicate: (t: Player) => 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 | Player
Returns undefined | Player
Inherited from PulseScheduler.shift
- Defined in index.d.ts:1100

splice

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

start

start(): void
Starts the schedule.

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

stop

stop(): void
Stops the schedule.

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

unshift

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