Leunsel: Class Template Implementation.

2026-06-23T18:22:05Z

Class Template Implementation.

Leunsel: Initial page creation.

2026-06-21T17:07:11Z

Initial page creation.

New page

[[Category:Lua]]
{{CodeBox|'''class''' CustomType ''':''' Object}}

The CustomType class represents a converter that translates raw data into a human-readable interpretation.

Custom types can be registered through Lua functions or through an Auto Assembler script. Once registered, the CustomType object can convert byte tables to values and values back to byte tables.

===Inheritance===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Class
!align="left"|Inherits From
!style="width: 80%;background-color:white;" align="left"|Description
|-
|CustomType
|Object
|A converter for interpreting raw data as human-readable values.
|}

===Global Functions===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Function
!align="left"|Return Type
!style="width: 80%;background-color:white;" align="left"|Description
|-
|registerCustomTypeLua(typename, bytecount, bytestovaluefunction, valuetobytesfunction, isFloat)
|CustomType
|Registers a custom type based on Lua functions.
|-
|registerCustomTypeAutoAssembler(script)
|CustomType
|Registers a custom type based on an Auto Assembler script. The script must allocate ConvertRoutine and ConvertBackRoutine.
|-
|getCustomType(typename)
|CustomType or nil
|Returns the custom type object with the specified name, or nil if it could not be found.
|}

===Properties===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Property
!align="left"|Type
!style="width: 80%;background-color:white;" align="left"|Description
|-
|name
|String
|The name of the custom type.
|-
|functiontypename
|String
|The function type name of the custom type.
|-
|CustomTypeType
|TCustomTypeType
|The type of script used by the custom type.
|-
|script
|String
|The custom type script.
|-
|scriptUsesFloat
|Boolean
|True if the script interprets user-side values as floating-point values.
|}

===Methods===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Method
!align="left"|Return Type
!style="width: 80%;background-color:white;" align="left"|Description
|-
|byteTableToValue({bytetable}, Address)
|Integer or Number
|Converts a table of bytes into the interpreted value. Address is optional.
|-
|valueToByteTable(value, Address)
|Table
|Converts a value into a table of bytes. Address is optional.
|}

===registerCustomTypeLua===
{{CodeBox|'''function''' registerCustomTypeLua(''typename'', ''bytecount'', ''bytestovaluefunction'', ''valuetobytesfunction'', ''isFloat'') ''':''' CustomType}}

Registers a custom type based on Lua functions.

The bytes-to-value function should be defined as a function that receives the bytes as separate parameters and returns an integer value.

The value-to-bytes function should be defined as a function that receives an integer value and returns the bytes that should be written.

===registerCustomTypeLua Parameters===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Parameter
!align="left"|Type
!style="width: 80%;background-color:white;" align="left"|Description
|-
|typename
|String
|The name of the custom type to register.
|-
|bytecount
|Integer
|The number of bytes used by this custom type.
|-
|bytestovaluefunction
|Function
|The function that converts raw bytes into a value.
|-
|valuetobytesfunction
|Function
|The function that converts a value into the bytes that should be written.
|-
|isFloat
|Boolean
|If true, the custom type interprets user-side values as floating-point values.
|}

===registerCustomTypeAutoAssembler===
{{CodeBox|'''function''' registerCustomTypeAutoAssembler(''script'') ''':''' CustomType}}

Registers a custom type based on an Auto Assembler script.

The script must allocate and define both ''ConvertRoutine'' and ''ConvertBackRoutine''.

===registerCustomTypeAutoAssembler Parameters===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Parameter
!align="left"|Type
!style="width: 80%;background-color:white;" align="left"|Description
|-
|script
|String
|The Auto Assembler script used to define the custom type. The script must allocate ConvertRoutine and ConvertBackRoutine.
|}

===getCustomType===
{{CodeBox|'''function''' getCustomType(''typename'') ''':''' CustomType}}

Returns the custom type object with the specified name, or nil if it could not be found.

===getCustomType Parameters===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Parameter
!align="left"|Type
!style="width: 80%;background-color:white;" align="left"|Description
|-
|typename
|String
|The name of the custom type to retrieve.
|}

===Examples===
<pre>
local function bytesToValue(b1, b2, b3, b4)
return b1 + (b2 * 0x100) + (b3 * 0x10000) + (b4 * 0x1000000)
end

local function valueToBytes(value)
local b1 = value % 0x100
local b2 = math.floor(value / 0x100) % 0x100
local b3 = math.floor(value / 0x10000) % 0x100
local b4 = math.floor(value / 0x1000000) % 0x100

return b1, b2, b3, b4
end

local customType = registerCustomTypeLua(
"Lua Integer Example",
4,
bytesToValue,
valueToBytes,
false
)

print("Registered custom type: " .. tostring(customType))
</pre>

<pre>
local customType = getCustomType("Lua Integer Example")

if customType ~= nil then
local value = customType.byteTableToValue({0x78, 0x56, 0x34, 0x12})
print("Value: " .. tostring(value))

local bytes = customType.valueToByteTable(value)

for i = 1, #bytes do
print("Byte " .. i .. ": " .. string.format("%02X", bytes[i]))
end
else
print("Custom type not found")
end
</pre>

<pre>
local script = [[
alloc(ConvertRoutine, 1024)
alloc(ConvertBackRoutine, 1024)

ConvertRoutine:
// Add conversion code here
ret

ConvertBackRoutine:
// Add conversion-back code here
ret
]]

local customType = registerCustomTypeAutoAssembler(script)

print("Registered custom type: " .. tostring(customType))
</pre>

{{LuaSeeAlso}}

@@ Line 1: / Line 1: @@
 [[Category:Lua]]
-{{CodeBox|'''class''' CustomType ''':''' Object}}
+{{Class|'''class''' CustomType ''':''' Object}}
 The CustomType class represents a converter that translates raw data into a human-readable interpretation.

Lua:Class:CustomType - Revision history

Leunsel: Class Template Implementation.

Leunsel: Initial page creation.