Regular API function

simPackWords

Description Packs a table of word numbers into a string. See also simUnpackWords and the other packing/unpacking functions.
C synopsis -
C parameters
-
C return value
-
Lua synopsis string data=simPackWords(table wordNumbers,number startWordIndex=0,number wordCount=0)
Lua parameters
wordNumbers: a table containing word numbers. Invalid word numbers will be packed in an undefined manner.
startWordIndex: the zero-based index from which on data should be packed. Can be omitted in which case 0 is used
wordCount: the amount of words that should be packed. Can be omitted in which case 0 is used (which indicates that the maximum available words should be packed from the indicated startWordIndex)
Lua return values
data: a string (values between 0 and 255) that contains packed word numbers from the table if operation was successful, nil otherwise

All regular API functions on one page