Steppable

Summary

The Steppable class is a base class for any classes (e.g. agents) that implement Steppers. It provides methods for managing, creating, and destroying steppers.

Parameters

# List<Stepper> steppers

List of all steppers currently on this steppable.

Methods

# public void CreateStepper( ABMU.Utilities.Del callback )

Creates a [Stepper|Stepper] from the provided callback method. Additional optional parameters that may be provided (default values in parentheses when no value is provided):

• int _stepValue (default: 1)
• int _priorityValue (default: 500) OR StepperQueueOrder _stepperQueuePrompt (default: NORMAL)
• int _delayStartByFrames (default: 0)

if _delayStartByFrames is provided, the stepper will be created after the number of specified frames have passed. (Meaning it cannot be accessed or removed before that frame).

# public void DestroyStepper( Stepper s )

Destroys the passed stepper object. This method deletes the stepper and completely removes the passed stepper from all registers, including the steppers list and the Scheduler queue.

# public void DestroyStepper( string stepperName )

Overloaded version of the DestroyStepper() method, can be used by passing in the stepper name as a string rather than the stepper object itself.

# void RegisterStepper( Stepper s )

Adds an existing stepper to the relevant stepper register lists, including the steppers list on this steppable and the Scheduler queue. It is called automatically when a new stepper is created in CreateStepper()

# void DeregisterStepper( Stepper s )

Removes the passed stepper object from all relevant stepper register lists, including the steppers list on this steppable and the Scheduler queue. It is called automatically when a stepper is destroyed in DestroyStepper()