String.unpack

Available since: Gideros 2022.1
Class: string

Description

Extracts the values packed in the provided binary string based on the description in the first argument. The description should match the one originally used to pack the string. The optional third parameter determines the byte at which the reading starts. <syntaxhighlight lang="lua"> (string) = string.unpack(format,data,start) </source>

Parameters

format: (string) format matching the one originally used to pack the string
data: (string) the packed strings
start: (string) byte at which the reading starts (optional, default = "1")

Return values

Returns (tuple) the values packed into the provided binary string, plus the index of the first unread byte

---

• String
• String.byte
• String.char
• String.dump
• String.find
• String.format
• String.gmatch
• String.gsub
• String.len
• String.lower
• String.match
• String.pack
• String.packsize
• String.rep
• String.reverse
• String.split
• String.sub
• String.unpack
• String.upper

---

---

• Main Page
• Lua API
• Main API
• Plugins