SDK 6.3/PAWN/Save
Jump to navigation
Jump to search
Official WOWCube SDK documentation. SDK 6.3, PAWN API. Generated from the canonical SDK headers — do not edit by hand; regenerate from source.
Pawn works with cells which has a size of 4 bytes. Native interfaces handling generic data like application state have size limits for that data. If application does not need to work with a large numbers, several values can be packed into a single cell. This library provides some convenient functions to pack and unpack such values from array of cells which can be saved or loaded on/from flash.
Contents
Functions
SaveReset
Syntax:
SaveReset()
Description:
- Reset state before storing new data to pack.
SaveWriteValue
Syntax:
SaveWriteValue(value, bits)
Description:
- Store specified number of bits from some unsigned value.
Arguments:
- value
- a value to store data from
- bits
- a number of bits to store
SaveWriteSignedValue
Syntax:
SaveWriteSignedValue(value, bits)
Description:
- Store specified number of bits from some signed value.
Arguments:
- value
- a value to store data from
- bits
- a number of bits to store
SaveReadValue
Syntax:
SaveReadValue(bits)
Description:
- Read specified number of bits of packed unsigned value.
Arguments:
- bits
- a number of bits to get
Return values:
- Unpacked unsigned value.
SaveReadSignedValue
Syntax:
SaveReadSignedValue(bits)
Description:
- Read specified number of bits of packed signed value.
Arguments:
- bits
- a number of bits to get
Return values:
- Unpacked signed value.
SaveSetData
Syntax:
SaveSetData(const pkt[], size)
Description:
- Populate state with a new data to unpack.
Arguments:
- pkt
- application state data to unpack
See also: ON_Init(), ON_Load()
SaveGetData
Syntax:
SaveGetData()
Description:
- Get packed data to store on flash.
Return values:
- Packed data to store.
See also: saveState()
