Class Index | File Index

Classes


Class ROT.EventQueue

Generic event queue: stores events and retrieves them based on their time
Defined in: <rot.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
add(event, time)
 
Clear all scheduled events
 
get()
Locates the nearest event, advances time if necessary.
 
 
remove(event)
Remove an event from the queue
Class Detail
ROT.EventQueue()
Method Detail
add(event, time)
Parameters:
{?} event
{number} time

clear()
Clear all scheduled events

{? || null} get()
Locates the nearest event, advances time if necessary. Returns that event and removes it from the queue.
Returns:
{? || null} The event previously added by addEvent, null if no event available

{number} getTime()
Returns:
{number} Elapsed time

{bool} remove(event)
Remove an event from the queue
Parameters:
{?} event
Returns:
{bool} success?

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Jun 13 2016 11:14:41 GMT+0200 (CEST)