Echo Hollow

Gender-Bending Interactive Stories! :D

User Tools

Site Tools


smutbook:classes:util:messagequeue

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
smutbook:classes:util:messagequeue [2023/08/06 20:33] leesmutbook:classes:util:messagequeue [2023/08/06 20:33] (current) lee
Line 7: Line 7:
 ===== MessageQueue.push( message ) ===== ===== MessageQueue.push( message ) =====
  
-If the queue is enabled, push a message into the top of the queue.\\+If the queue is enabled, push a message into the top of the queue. 
 **Returns:** void **Returns:** void
  
 ===== MessageQueue.shift() ===== ===== MessageQueue.shift() =====
  
-If the queue is enabled, shift a message off the bottom of the queue.\\+If the queue is enabled, shift a message off the bottom of the queue. 
 **Returns:** the message being shifted off, or null if the queue is disabled. **Returns:** the message being shifted off, or null if the queue is disabled.
  
 ===== MessageQueue.dump( separator="\n" ) ===== ===== MessageQueue.dump( separator="\n" ) =====
  
-Dump the whole queue as a string, using the given separator.  Clear the queue.\\+Dump the whole queue as a string, using the given separator.  Clear the queue. 
 **Returns:** the whole queue as a single string **Returns:** the whole queue as a single string
  
 ===== MessageQueue.on( queue=[] ) ===== ===== MessageQueue.on( queue=[] ) =====
  
-If the queue is already enabled, to nothing.  Otherwise enable the queue, filling it with the given array of strings.\\+If the queue is already enabled, to nothing.  Otherwise enable the queue, filling it with the given array of strings. 
 **Returns:** void **Returns:** void
  
 ===== MessageQueue.off() ===== ===== MessageQueue.off() =====
  
-Disable and clear the queue.\\+Disable and clear the queue. 
 **Returns:** the contents of the queue before it was cleared. **Returns:** the contents of the queue before it was cleared.
  
smutbook/classes/util/messagequeue.1691379194.txt.gz · Last modified: 2023/08/06 20:33 by lee