class CIntervalManager

This object holds a number of currently-playing intervals and is responsible for advancing them each frame as needed.

There is normally only one IntervalManager object in the world, and it is the responsibility of the scripting language to call step() on this object once each frame, and to then process the events indicated by getNextEvent().

It is also possible to create multiple IntervalManager objects for special needs.

Inheritance diagram

Inheritance diagram of CIntervalManager

__init__() → None
addCInterval(interval: CInterval, external: bool) → int

Adds the interval to the manager, and returns a unique index for the interval. This index will be unique among all the currently added intervals, but not unique across all intervals ever added to the manager. The maximum index value will never exceed the maximum number of intervals added at any given time.

If the external flag is true, the interval is understood to also be stored in the scripting language data structures. In this case, it will be available for information returned by getNextEvent() and getNextRemoval(). If external is false, the interval’s index will never be returned by these two functions.

findCInterval(name: str) → int

Returns the index associated with the named interval, if there is such an interval, or -1 if there is not.

getCInterval(index: int) → CInterval

Returns the interval associated with the given index.

Return type


getEventQueue() → EventQueue

Returns the custom event queue to be used for throwing done events from intervals as they finish.

Return type


static getGlobalPtr() → CIntervalManager

Returns the pointer to the one global CIntervalManager object.

Return type


getMaxIndex() → int

Returns one more than the largest interval index number in the manager. If you walk through all the values between (0, getMaxIndex()] and call getCInterval() on each number, you will retrieve all of the managed intervals (and possibly a number of NULL pointers as well).

getNextEvent() → int

This should be called by the scripting language after each call to step(). It returns the index number of the next interval that has events requiring servicing by the scripting language, or -1 if no more intervals have any events pending.

If this function returns something other than -1, it is the scripting language’s responsibility to query the indicated interval for its next event via get_event_index(), and eventually pop_event().

Then getNextEvent() should be called again until it returns -1.

getNextRemoval() → int

This should be called by the scripting language after each call to step(). It returns the index number of an interval that was recently removed, or -1 if no intervals were removed.

If this returns something other than -1, the scripting language should clean up its own data structures accordingly, and then call getNextRemoval() again.

getNumIntervals() → int

Returns the number of currently active intervals.

interrupt() → int

Pauses or finishes (removes from the active queue) all intervals tagged with auto_pause or auto_finish set to true. These are intervals that someone fired up but won’t necessarily expect to clean up; they can be interrupted at will when necessary.

Returns the number of intervals affected.

output(out: ostream) → None
removeCInterval(index: int) → None

Removes the indicated interval from the queue immediately. It will not be returned from getNextRemoval(), and none of its pending events, if any, will be returned by getNextEvent().

setEventQueue(event_queue: EventQueue) → None

Specifies a custom event queue to be used for throwing done events from intervals as they finish. If this is not specified, the global event queue is used.

The caller maintains ownership of the EventQueue object; it is the caller’s responsibility to ensure that the supplied EventQueue does not destruct during the lifetime of the CIntervalManager.

step() → None

This should be called every frame to do the processing for all the active intervals. It will call step_play() for each interval that has been added and that has not yet been removed.

After each call to step(), the scripting language should call getNextEvent() and getNextRemoval() repeatedly to process all the high- level (e.g. Python-interval-based) events and to manage the high-level list of intervals.

write(out: ostream) → None