com.badlogic.gdx.ai.sched

Class PriorityScheduler

java.lang.Object

com.badlogic.gdx.ai.sched.SchedulerBase<com.badlogic.gdx.ai.sched.PriorityScheduler.PrioritySchedulableRecord>

com.badlogic.gdx.ai.sched.PriorityScheduler

All Implemented Interfaces:

Schedulable, Scheduler

public class PriorityScheduler
extends SchedulerBase<com.badlogic.gdx.ai.sched.PriorityScheduler.PrioritySchedulableRecord>

A PriorityScheduler works like a LoadBalancingScheduler but allows different tasks to get a different share of the available time by assigning a priority to each task. The higher the priority the longer the amount of the available time dedicated to the corresponding task.

Nested Class Summary

Nested classes/interfaces inherited from class com.badlogic.gdx.ai.sched.SchedulerBase

SchedulerBase.SchedulableRecord

Field Summary

Fields

Modifier and Type	Field and Description
protected int	frame The current frame number

Fields inherited from class com.badlogic.gdx.ai.sched.SchedulerBase

dryRunFrames, phaseCounters, runList, schedulableRecords

Constructor Summary

Constructors

Constructor and Description
PriorityScheduler(int dryRunFrames) Creates a PriorityScheduler.

Method Summary

Modifier and Type	Method and Description
void	add(Schedulable schedulable, int frequency, int phase) Adds the schedulable to the list using the given frequency and phase with priority 1.
void	add(Schedulable schedulable, int frequency, int phase, float priority) Adds the schedulable to the list using the given frequency, phase and priority.
void	addWithAutomaticPhasing(Schedulable schedulable, int frequency) Adds the schedulable to the list using the given frequency, priority 1 and a phase calculated by a dry run of the scheduler.
void	addWithAutomaticPhasing(Schedulable schedulable, int frequency, float priority) Adds the schedulable to the list using the given frequency and priority while the phase is calculated by a dry run of the scheduler.
void	run(long timeToRun) Executes scheduled tasks based on their frequency and phase.

Methods inherited from class com.badlogic.gdx.ai.sched.SchedulerBase

calculatePhase

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

frame

protected int frame

The current frame number

Constructor Detail

PriorityScheduler

public PriorityScheduler(int dryRunFrames)

Creates a PriorityScheduler.

Parameters:

dryRunFrames - number of frames simulated by the dry run to calculate the phase when adding a schedulable via addWithAutomaticPhasing(Schedulable, int) and addWithAutomaticPhasing(Schedulable, int, float)

Method Detail

run

public void run(long timeToRun)

Executes scheduled tasks based on their frequency and phase. This method must be called once per frame.

Parameters:

timeToRun - the maximum time in nanoseconds this scheduler should run on the current frame.

addWithAutomaticPhasing

public void addWithAutomaticPhasing(Schedulable schedulable,
                                    int frequency)

Adds the schedulable to the list using the given frequency, priority 1 and a phase calculated by a dry run of the scheduler.

Parameters:

schedulable - the task to schedule

frequency - the frequency

addWithAutomaticPhasing

public void addWithAutomaticPhasing(Schedulable schedulable,
                                    int frequency,
                                    float priority)

Adds the schedulable to the list using the given frequency and priority while the phase is calculated by a dry run of the scheduler.

Parameters:

schedulable - the task to schedule

frequency - the frequency

priority - the priority

add

public void add(Schedulable schedulable,
                int frequency,
                int phase)

Adds the schedulable to the list using the given frequency and phase with priority 1.

Parameters:

schedulable - the task to schedule

frequency - the frequency

phase - the phase

add

public void add(Schedulable schedulable,
                int frequency,
                int phase,
                float priority)

Adds the schedulable to the list using the given frequency, phase and priority.

Parameters:

schedulable - the task to schedule

frequency - the frequency

phase - the phase

priority - the priority