This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revision | |||
| smutbook:classes:util:start [2023/08/06 20:30] – lee | smutbook:classes:util:start [2023/08/06 20:31] (current) – lee | ||
|---|---|---|---|
| Line 2: | Line 2: | ||
| Miscellaneous internal utility functions that don't seem to fit anywhere else. You probably won't ever need to directly use any of these, except maybe String.capitalize(). | Miscellaneous internal utility functions that don't seem to fit anywhere else. You probably won't ever need to directly use any of these, except maybe String.capitalize(). | ||
| - | |||
| - | ===== LibEcho.Util.MessageQueue ===== | ||
| - | |||
| - | A global message queue system to allow the story author to more easily hook into the Inventory and Apparel UIs and display various flavor texts and do other processing while a player is fooling around with Inventory and Apparel. | ||
| - | |||
| - | FIXME Not fully implemented. | ||
| - | |||
| - | ==== MessageQueue.push( message ) ==== | ||
| - | |||
| - | If the queue is enabled, push a message into the top of the queue.\\ | ||
| - | **Returns: | ||
| - | |||
| - | ==== MessageQueue.shift() ==== | ||
| - | |||
| - | If the queue is enabled, shift a message off the bottom of the queue.\\ | ||
| - | **Returns: | ||
| - | |||
| - | ==== MessageQueue.dump( separator=" | ||
| - | |||
| - | Dump the whole queue as a string, using the given separator. | ||
| - | **Returns: | ||
| - | |||
| - | ==== MessageQueue.on( queue=[] ) ==== | ||
| - | |||
| - | If the queue is already enabled, to nothing. | ||
| - | **Returns: | ||
| - | |||
| - | ==== MessageQueue.off() ==== | ||
| - | |||
| - | Disable and clear the queue. | ||
| - | **Returns: | ||