Class DefaultScheduler

The default interval-based scheduler.

Agents tick based on their configured interval:

interval: 1 means tick every environment tick (default)
interval: 5 means tick every 5th environment tick
probability: 0.5 means 50% chance to tick on eligible ticks

Example

// Fast agent - ticks every step
const fastAgent = new Agent({ tickInterval: 1 });

// Slow agent - ticks every 5 steps
const slowAgent = new Agent({ tickInterval: 5 });

// Stochastic agent - 30% chance per step
const randomAgent = new Agent({ tickProbability: 0.3 });

Since

0.6.0

Implements

Scheduler

Index

Constructors

constructor

Methods

getAgentsForTick getConfig nextScheduledTime onAgentAdded onAgentRemoved reset schedule setInterval setProbability unschedule

Constructors

constructor

new DefaultScheduler(): DefaultScheduler
Returns DefaultScheduler

Methods

getAgentsForTick

getAgentsForTick(time: number): Agent[]
Get all agents scheduled to tick at the given time.
Parameters
- time: number
  The current environment time
Returns Agent[]
Array of agents that should tick
Implementation of Scheduler.getAgentsForTick
- Defined in scheduling/DefaultScheduler.ts:89

getConfig

getConfig(agent: Agent): AgentScheduleConfig
Get an agent's current schedule configuration.
Parameters
- agent: Agent
Returns AgentScheduleConfig
- Defined in scheduling/DefaultScheduler.ts:81

nextScheduledTime

nextScheduledTime(): number
Get the next time at which any agent is scheduled. Used for event-driven simulation to skip empty time steps.

Returns number
The next scheduled time, or null if nothing is scheduled
Implementation of Scheduler.nextScheduledTime
- Defined in scheduling/DefaultScheduler.ts:109

onAgentAdded

onAgentAdded(agent: Agent, time: number): void
Called when an agent is added to the environment.
Parameters
- agent: Agent
  The newly added agent
- time: number
  Current environment time
Returns void
Implementation of Scheduler.onAgentAdded
- Defined in scheduling/DefaultScheduler.ts:116

onAgentRemoved

onAgentRemoved(agent: Agent): void
Called when an agent is removed from the environment.
Parameters
- agent: Agent
  The agent being removed
Returns void
Implementation of Scheduler.onAgentRemoved
- Defined in scheduling/DefaultScheduler.ts:129

reset

reset(): void
Reset the scheduler state.

Returns void
Implementation of Scheduler.reset
- Defined in scheduling/DefaultScheduler.ts:133

schedule

schedule(agent: Agent, time: number): void
Schedule an agent with interval-based timing. For DefaultScheduler, the time parameter is used as the offset.
Parameters
- agent: Agent
- time: number
Returns void
Implementation of Scheduler.schedule
- Defined in scheduling/DefaultScheduler.ts:45

setInterval

setInterval(agent: Agent, interval: number): void
Configure an agent's tick interval.
Parameters
- agent: Agent
- interval: number
Returns void
- Defined in scheduling/DefaultScheduler.ts:61

setProbability

setProbability(agent: Agent, probability: number): void
Configure an agent's tick probability.
Parameters
- agent: Agent
- probability: number
Returns void
- Defined in scheduling/DefaultScheduler.ts:71

unschedule

unschedule(agent: Agent): void
Remove an agent from the schedule entirely.
Parameters
- agent: Agent
  The agent to unschedule
Returns void
Implementation of Scheduler.unschedule
- Defined in scheduling/DefaultScheduler.ts:85

Class DefaultScheduler

Example

Since

Implements

Index

Constructors

Methods

Constructors

constructor

Returns DefaultScheduler

Methods

getAgentsForTick

Parameters

Returns Agent[]

getConfig

Parameters

Returns AgentScheduleConfig

nextScheduledTime

Returns number

onAgentAdded

Parameters

Returns void

onAgentRemoved

Parameters

Returns void

reset

Returns void

schedule

Parameters

Returns void

setInterval

Parameters

Returns void

setProbability

Parameters

Returns void

unschedule

Parameters

Returns void

Settings

On This Page