Regular API function


Description Unpacks a string (or part of it) into a table of word numbers. See also simPackWords and the other packing/unpacking functions.
C synopsis -
C parameters
C return value
Lua synopsis table wordNumbers=simUnpackWords(string data,number starWordtIndex=0,number wordCount=0,number additionalCharOffset)
Lua parameters
data: a string (values between 0 and 255) that contains packed word numbers
startWordIndex: the zero-based index from which on data should be unpacked (from data[2*startWordIndex+1+additionalCharOffset]). Can be omitted in which case 0 is used.
wordCount: the amount of words that should be unpacked. Can be omitted in which case 0 is used (which indicates that the maximum of words should be unpacked from the indicated startWordIndex).
additionalCharOffset: a char offset that will be added before reading the words. Can be omitted, in which case 0 is used.
Lua return values
wordNumbers: a table containing unpacked word numbers if operation was successful, nil otherwise

All regular API functions on one page