Callbacks
This details a list of callbacks you can use to be notified of certain events occurring. See storageObj:NewCallback for details on how to register for a callback. All callback functions are called as
callbackFunc(storageObj, callbackKey, ...)
ENCODE_PROGRESS
Fires every time the encoding coroutine yields (every frame that encoding happens on).
Arguments
- encodedKeys
- The number of table entries that has already been encoded
- totalKeys
- The total number of table entries that needs to be encoded.
ENCODE_COMPLETE
Fires when the encoding and saving of a value is complete.
Arguments
- totalKeys
- The number of table entries that was encoded
DECODE_PROGRESS
Fires every time the decoding coroutine yields (every frame that decoding happens on).
Arguments
- decodedChars
- The number of characters that has already been decoded.
- totalChars
- The total number of characters the encoded string has
DECODE_COMPLETE
Fires when decoding of a table is complete.
Arguments
- totalChars
- The total number of characters that have been decoded
- decodedTable
- The table that was requested
Comments