EPD Wiki

AINB: Difference between revisions

Browse history interactively
← Older edit
VisualWikitext
Dt12345 (talk | contribs)
34 edits
mNo edit summary
Watertoon (talk | contribs)
60 edits
m Multi-Input corrections.
 
(23 intermediate revisions by 4 users not shown)
Line 1: Line 1:
'''AINB''' ('''AI''' '''N'''ode '''B'''inary) is a file format used for AI and logic on ''Tears of the Kingdom'' as well as other recent Nintendo EPD games. This article is primarily aimed at the version that appears in ''Tears of the Kingdom'' and ''Super Mario Bros. Wonder'' (v0x0407). AINB files can be found in the AI, Logic, and Sequence folders of the romfs as well as within various packs.
'''AINB''' ('''AI''' '''N'''ode '''B'''inary) is a file format implementing behavior trees for game-specific code. At time of writing it has only appeared in titles on the ModuleSystem game engine. This article is primarily aimed at the version that appears in ''Tears of the Kingdom,'' ''Super Mario Bros. Wonder, Mario vs Donkey Kong,'' and the original October 2024 version of ''Nintendo Switch Online: Playtest Program'' (v0x407). ModuleSystem provides 3 built-in file categories that appear in their own dedicated folders in a title's romfs, being "AI" for actor behavior, "Logic" for actor ai group behavior, and "Sequence" for scene behavior, individual games are free to create their own file categories.


=== File Structure ===
=== Version Table ===
AINB is a little endian format similar to most Switch file formats. An AINB file consists of a set of interconnected nodes which act like a syntax tree and control the behavior of actors. These nodes can also be calls to external AINB files, allowing AINB files to form entire trees of files. The root file of the tree will have <code>.root.ainb</code> as their extension while each module in the tree will have the extension <code>.module.ainb</code>. There are three primary categories of AINB files in ''TotK'': AI, Logic, and Sequence. For AI and Sequence files, the file's entry point is one or more commands which is linked to one or two child nodes. All nodes are accessed by their index (references to precondition nodes will use their precondition node index which is local to the amount of precondition nodes in the file).
{| class="wikitable"
|+
!Version
!Applications
!Differences From Previous
|-
|0x404
|''Nintendo Switch Sports, Splatoon 3''
|
|-
|0x407
|''The Legend of Zelda: Tears of the Kingdom, Super Mario Bros. Wonder, Mario Vs Donkey Kong, Nintendo Switch Online: Playtest Program (010)''
|
|-
|0x408
|''Nintendo Switch Online: Playtest Program (021)''
|>Now uses exb version 3 (u32 support)
>Added u32 type to blackboard
|}


== File Structure ==
AINB assumes little endian. Hashes can be assumed to be 32-bit Murmur3 unless otherwise specified.


All string offsets in the file are relative to the beginning of the string pool and name hashes are 32-bit murmur3 hashes. There are six possible types for AINB parameters: int (signed 32-bit integer), bool, float (32-bit), vector3f, and pointer. Pointer parameters are pointers to objects.
An AINB file defines a set of commands to evaluate a tree of built-in or game-specific node classes. The built-in "Element_ModuleCaller" node and supporting structures allow a "root" AINB file to call out to an external "module" AINB file, module's can call further modules, allowing AINB files to form a tree of tree's. An AINB's file extension typically designates whether it is a root <code>.root.ainb</code> or module <code>.module.ainb</code>. For AI and Sequence files, the file's entry point is one or more commands which is linked to one or two child nodes. All nodes are accessed by their index (references to query nodes will use their query node index which is local to the amount of query nodes in the file).


==== Section Order ====
All string offsets in the file are relative to the beginning of the string pool and name hashes are 32-bit murmur3 hashes. There are six possible data types for AINB parameters: int (signed 32-bit integer), bool, float (32-bit), vector3f, and pointer. Pointer parameters are pointers to objects.


# 0x74-Byte File Header
=== Section Order ===
# Commands
 
# Nodes
==== Version 0x407 ====
# Local Blackboard Parameters
# File Header (0x74)
# Node Bodies
# Command Array
# Element Array
# Blackboard
# Element Param Region
# Attachment Parameters
# Attachment Parameters
# Immediate Parameters
# Property Parameters
# Input/Output Parameters
# Input/Output Parameters
# Multi-Parameters
# Multi-Inputs
# Resident Update Array
# Jump Array
# 0x50 Section (Unused in ''TotK'')
# 0x50 Section (Unused in ''TotK'')
# Precondition Nodes
# Query Id Array
# Expression Binary
# Expression Binary
# Embedded AINB Files
# AINB Modules
# Entry Strings
# External Action Array
# File Hashes
# File Hashes
# Child Replacement Table
# Child Replacement Table
Line 30: Line 53:
# String Pool
# String Pool


==== File Header ====
== Structures ==
 
=== Helpers ===
 
==== AinbString ====
Represents a u32 offset relative to a null-terminated string from the start of the file's string pool.
 
==== AinbPtr<T> ====
Represents a u32 absolute offset from the start of the file to the struct of type "T" enclosed by <>.
 
==== AinbArray<T> ====
Represents a u32 absolute offset from the start of the file to:
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Count
|-
|0x4
|
|T[Count]
|Array of struct of type T. Note; asb files only use 32-bit aligned types.
|}
 
=== File Header ===
AINB files begin with a 0x74 byte header. If the offset for a given section is empty, that section is not present in the file.
AINB files begin with a 0x74 byte header. If the offset for a given section is empty, that section is not present in the file.
{| class="wikitable"
{| class="wikitable"
Line 47: Line 100:
|0x04
|0x04
|u32
|u32
|Version (0x0407 in TotK, 0x0404 in S3 and NSS)
|Version
|-
|-
|0x08
|0x08
|0x04
|0x04
|u32
|AinbString
|Filename Offset
|Filename
|-
|-
|0x0C
|0x0C
Line 62: Line 115:
|0x04
|0x04
|u32
|u32
|Node Count
|Element Count
|-
|-
|0x14
|0x14
|0x04
|0x04
|u32
|u32
|Precondition Node Count
|Query Element Count
|-
|-
|0x18
|0x18
|0x04
|0x04
|u32
|u32
|Attachment Parameter Count
|Attachment Count
|-
|-
|0x1C
|0x1C
|0x04
|0x04
|u32
|u32
|Output Node Count
|Output Element Count
|-
|-
|0x20
|0x20
|0x04
|0x04
|u32
|AinbPtr<Blackboard>
|Local Blackboard Parameters Offset
|Blackboard
|-
|-
|0x24
|0x24
|0x04
|0x04
|u32
|AinbPtr<char>
|String Pool Offset
|String Pool
|-
|-
|0x28
|0x28
|0x04
|0x04
|u32
|AinbPtr<AinbArray<Enum Relocation>>
|Enum Resolve Array Offset
|Enum Relocation Array
|-
|-
|0x2C
|0x2C
|0x04
|0x04
|u32
|AinbPtr<Property Table>
|Immediate Parameters Offset
|Property Table
|-
|-
|0x30
|0x30
|0x04
|0x04
|u32
|AinbPtr<Jump[]>
|Resident Update Array Offset
|Jump Table
|-
|-
|0x34
|0x34
|0x04
|0x04
|u32
|AinbPtr<Input Output Table>
|Input/Output Parameters Offset
|Input/Output Table
|-
|-
|0x38
|0x38
|0x04
|0x04
|u32
|AinbPtr<Multi Input[]>
|Multi-Parameters Array Offset
|Multi-Input Array
|-
|-
|0x3C
|0x3C
|0x04
|0x04
|u32
|AinbPtr<Attachment[Attachment Count]>
|Attachment Parameters Offset
|Attachment Array
|-
|-
|0x40
|0x40
|0x04
|0x04
|u32
|AinbPtr<u32[]>
|Attachment Parameters Index Array Offset
|Attachment Id Array
|-
|-
|0x44
|0x44
|0x04
|0x04
|u32
|AinbPtr<Exb>
|Expression Binary Section Offset
|Expression Binary
|-
|-
|0x48
|0x48
|0x04
|0x04
|u32
|u32
|Child Replacement Table Offset
|Child Replacement Table
|-
|-
|0x4C
|0x4C
|0x04
|0x04
|u32
|AinbPtr<u32[]>
|Precondition Node Array Offset
|Query Element Id Array
|-
|-
|0x50
|0x50
|0x04
|0x04
|u32
|u32
|Unknown (unused in ''TotK'', always the same as the Resident Update Array Offset)
|Unknown (unused in ''TotK'', always the same as the Active Node Update Array Offset)
|-
|-
|0x54
|0x54
Line 156: Line 209:
|0x5C
|0x5C
|0x04
|0x04
|u32
|AinbPtr<AinbArray<Module Caller>>
|Embedded AINB Files Offset
|Module Caller Array
|-
|-
|0x60
|0x60
|0x04
|0x04
|u32
|AinbString
|File Category Name Offset
|File Category Name
|-
|-
|0x64
|0x64
|0x04
|0x04
|u32
|u32
|File Category (0 = AI, 1 = Logic, 2 = Sequence) - only ''TotK''
|File Category? (0 = AI, 1 = Logic, 2 = Sequence) (''Splatoon 3'' game specific, 3 = UniqueSequenceSPL)
|-
|-
|0x68
|0x68
|0x04
|0x04
|u32
|AinbPtr<AinbArray<External Action>>
|Entry Strings Offset (purpose unknown)
|External Action Array
|-
|-
|0x6C
|0x6C
Line 181: Line 234:
|0x70
|0x70
|0x04
|0x04
|u32
|AinbPtr<Module Caller Link>
|File Identification Hashes Offset (Purpose Unknown)
|Module Caller Link
|}
|}


==== Command Array ====
=== Command Array ===
The command array immediately follows the file header and is an array of all commands in the file.
The command array immediately follows the file header and is an array of all commands in the file.
{| class="wikitable"
{| class="wikitable"
Line 196: Line 249:
|0x00
|0x00
|0x04
|0x04
|AinbString
|Name
|-
|0x04
|0x10
|Guid
|Guid
|-
|0x14
|0x02
|u16
|Main Element Id
|-
|0x16
|0x02
|u16
|Secondary Element Id (value offset by 1, 0 is reserved for invalid)
|}
Unlike asb, command GUIDs only appear to be used for debug messages. Secondary Element Id will be -1 if the command only has one child element.
=== Property Table ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|AsbPtr<Property<s32>[]>
|Property Array
|-
|0x04
|0x04
|AsbPtr<Property<bool>[]>
|Property Array
|-
|0x08
|0x04
|AsbPtr<Property<float>[]>
|Property Array
|-
|0x0c
|0x04
|AsbPtr<Property<AinbString>[]>
|Property Array
|-
|0x10
|0x04
|AsbPtr<Property<Vector3f>[]>
|Property Array
|-
|0x14
|0x04
|AsbPtr<PropertyPointer[]>
|Property Array
|}
==== Property<T> ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString
|Name
|-
|0x4
|0x4
|Property Flags
|Flags
|-
|0x8
|0x4, or 0xc
|T
|Immediate Value
|}
===== Property Flags =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32 : 16
|Index
|-
|
|
|u32 : 1
|Is Use Index
|-
|
|
|u32 : 1
|Is Not Local Blackboard Index
|-
|
|
|u32 : 1
|
|-
|
|
|u32 : 1
|
|-
|
|
|u32 : 1
|
|-
|
|
|u32 : 1
|
|-
|
|
|u32 : 1
|Is EXB Index
|-
|
|
|u32 : 1
|Pulse Thread Local Storage
|-
|
|
|u32 : 1
|Set Pointer Flag Bit Zero
|-
|
|
|u32 : 7
|
|}
==== PropertyPointer ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString
|Name
|-
|0x4
|0x4
|AinbString
|Class Name
|-
|0x8
|0x4
|Property Flags
|Flags
|}
==== Property Entries ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x8
|Property Type Entry
|S32 Entries
|-
|0x8
|0x8
|Property Type Entry
|Bool Entries
|-
|0x10
|0x8
|Property Type Entry
|Float Entries
|-
|0x18
|0x8
|Property Type Entry
|String Entries
|-
|0x20
|0x8
|Property Type Entry
|Vector3f Entries
|-
|0x28
|0x8
|Property Type Entry
|Pointer Entries
|}
===== Property Type Entry =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|u32
|Command Name Offset
|Base Index - base index into the Property Table's Property Array for the specified type
|-
|-
| rowspan="5" |0x04
|0x4
| rowspan="5" |0x10
|0x4
|u32
|u32
| rowspan="5" |GUID
|Count
|}
 
=== Input Output Table ===
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|AsbPtr<Input<s32>[]>
|Input Array
|-
|-
|u16
|0x04
|0x04
|AsbPtr<Output<s32>[]>
|Output Array
|-
|-
|u16
|0x08
|0x04
|AsbPtr<Input<bool>[]>
|Input Array
|-
|-
|u16
|0x0c
|0x04
|AsbPtr<Output<bool[]>
|Output Array
|-
|-
|u8[6]
|0x10
|0x04
|AsbPtr<Input<float>[]>
|Input Array
|-
|-
|0x14
|0x14
|0x02
|0x04
|u16
|AsbPtr<Output<float>[]>
|Left Node Index
|Output Array
|-
|0x18
|0x04
|AsbPtr<Input<AinbString>[]>
|Input Array
|-
|0x1c
|0x04
|AsbPtr<Output<AinbString>[]>
|Output Array
|-
|0x20
|0x04
|AsbPtr<Input<Vector3f>[]>
|Input Array
|-
|0x24
|0x04
|AsbPtr<Output<Vector3f>[]>
|Output Array
|-
|0x28
|0x04
|AsbPtr<InputPointer[]>
|Input Array
|-
|0x2c
|0x04
|AsbPtr<OutputPointer[]>
|Output Array
|}
 
==== Input<T> ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString
|Name
|-
|0x4
|0x2
|s16
|Input Element Id or Base Multi-Input Id
|-
|0x6
|0x2
|s16
|Input Element Output Plug Id or Multi-Input Count
|-
|0x8
|0x4
|Property Flags
|Flags
|-
|0xc
|0x4, or 0xc
|T
|Immediate Value
|}
If the input element id is between -32768 and -100, then the input uses a multi-input. The multi-input id can be calculated as follows: <code>BaseMultiInputIndex = -100 - Index</code>.
 
==== InputPointer ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString
|Name
|-
|0x4
|0x4
|AinbString
|Class Name
|-
|0x8
|0x2
|s16
|Input Element Id or Base Multi-Input Id
|-
|0xa
|0x2
|s16
|Input Element Output Plug Id or Multi-Input Count
|-
|0xc
|0x4
|Property Flags
|Flags
|-
|0x10
|0x4
|u32
|
|}
 
==== Output<T> ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString : 31
|Name
|-
|
|
|u32 : 1
|
|}
 
==== OutputPointer ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|AinbString : 31
|Name
|-
|
|
|u32 : 1
|
|-
|0x4
|0x4
|AinbString
|Class Name
|}
 
==== Input Output Entries ====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x10
|Input Output Type Entry
|S32 Entries
|-
|0x10
|0x10
|Input Output Type Entry
|Bool Entries
|-
|0x20
|0x10
|Input Output Type Entry
|Float Entries
|-
|0x30
|0x10
|Input Output Type Entry
|String Entries
|-
|0x40
|0x10
|Input Output Type Entry
|Vector3f Entries
|-
|0x50
|0x10
|Input Output Type Entry
|Pointer Entries
|}
 
===== Input Output Type Entry =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x4
|u32
|Input Base Index - base index into the Input Output Table's Input<T> array for the specified type
|-
|0x4
|0x4
|u32
|Input Count
|-
|0x8
|0x4
|u32
|Output Base Index - base index into the Input Output Table's Output<T> array for the specified type
|-
|-
|0x16
|0x10
|0x02
|0x4
|u16
|u32
|Right Node Index (one greater than the corresponding node index)
|Output Count
|}
|}
Command GUIDs are only used for debug messages. Right Node Index will be -1 if the command only has one child node.


==== Node Array ====
=== Element Array ===
The node array immediately follows the command array and is an array of all nodes in the file.
The node array immediately follows the command array and is an array of all nodes in the file.
{| class="wikitable"
{| class="wikitable"
Line 236: Line 744:
|0x02
|0x02
|u16
|u16
|Node Type Enum (see below)
|Element Type
|-
|-
|0x02
|0x02
|0x02
|0x02
|u16
|u16
|Node Index
|Element Id - Index of this element within the element array
|-
|-
|0x04
|0x04
|0x02
|0x02
|u16
|u16
|Attachment Parameters Count
|Attachment Count
|-
|-
|0x06
|0x06
|0x01
|0x01
|bitfield
|bitfield
|Node Flags
|Element Flags
|-
|-
|0x07
|0x07
Line 260: Line 768:
|0x08
|0x08
|0x04
|0x04
|u32
|AinbString
|Node Type Name Offset (for UserDefined nodes)
|Element Type Name (for ApplicationDefined nodes)
|-
|-
|0x0C
|0x0C
|0x04
|0x04
|u32
|u32
|Name Hash (version 0x407 only)
|Name Hash (version 0x407+)
|-
|-
|0x10
|0x10
Line 275: Line 783:
|0x14
|0x14
|0x04
|0x04
|u32
|AinbPtr<ElementParam<Element Type>>
|Node Body Offset (relative to the start of the file)
|Element Param
|-
|-
|0x18
|0x18
Line 291: Line 799:
|0x02
|0x02
|u16
|u16
|Multi-Param Count
|Multi-Input Count
|-
|-
|0x1E
|0x1E
Line 301: Line 809:
|0x04
|0x04
|u32
|u32
|Base Attachment Parameter Index
|Base Attachment Id
|-
|-
|0x24
|0x24
|0x02
|0x02
|u16
|u16
|Base Precondition Node
|Base Query Element Id
|-
|-
|0x26
|0x26
|0x02
|0x02
|u16
|u16
|Precondition Node Count
|Query Element Count
|-
|-
|0x28
|0x28
Line 323: Line 831:
|
|
|-
|-
| rowspan="5" |0x2C
|0x2C
| rowspan="5" |0x10
|0x10
|u32
|Guid
| rowspan="5" |GUID
|Guid
|-
|u16
|-
|u16
|-
|u16
|-
|u8[6]
|}
|}
Just like with commands, node GUIDs are only used for debug messages. The 0x58 section entry offset will be empty if unused.
Just like with commands, node GUIDs are only used for debug messages. The 0x58 section entry offset will be empty if unused.
==== Element Type ====
{| class="wikitable"
{| class="wikitable"
|+Node Types
|+Element Types
!Value (Hex)
!Value (Hex)
!Value (Dec)
!Value (Dec)
Line 345: Line 847:
|0x00
|0x00
|0
|0
|UserDefined
|Application Defined
|-
|-
|0x01
|0x01
Line 451: Line 953:
|Element_SplitTiming
|Element_SplitTiming
|}
|}
Node type names are official. For UserDefined nodes, node definitions can be found in a node definition files. This file is located at <code>NodeDefinition/Node.Product.[ver].aidefn.byml.zs</code> in the corresponding file category folder.
Element type names are official (outside ApplicationDefined). For ApplicationDefined elements, definitions can be found in a node definition file for the respective file category. This file is located at <code>NodeDefinition/Node.Product.[ver].aidefn.byml.zs</code> in the corresponding file category folder.
{| class="wikitable"
{| class="wikitable"
|+Node Type Descriptions
|+Node Type Descriptions
Line 482: Line 984:
|-
|-
|Element_Fork
|Element_Fork
|See Resident Update Array
|See Active Node Update Array
|-
|-
|Element_Join
|Element_Join
|See Resident Update Array
|See Active Node Update Array
|-
|-
|Element_Alert
|Element_Alert
Line 494: Line 996:
|-
|-
|Element_ModuleIF_Input_S32
|Element_ModuleIF_Input_S32
|Passes a signed int as output to another node as input
|Receives a signed int input from the calling AINB file
|-
|-
|Element_ModuleIF_Input_F32
|Element_ModuleIF_Input_F32
|Passes a 32-bit float as output to another node as input
|Receives a 32-bit float input from the calling AINB file
|-
|-
|Element_ModuleIF_Input_Vec3f
|Element_ModuleIF_Input_Vec3f
|Passes a vector3f as output to another node as input
|Receives a vector3f input from the calling AINB file
|-
|-
|Element_ModuleIF_Input_String
|Element_ModuleIF_Input_String
|Passes a string as output to another node as input
|Receives a string input from the calling AINB file
|-
|-
|Element_ModuleIF_Input_Bool
|Element_ModuleIF_Input_Bool
|Passes a boolean int as output to another node as input
|Receives a bool input from the calling AINB file
|-
|-
|Element_ModuleIF_Input_Ptr
|Element_ModuleIF_Input_Ptr
|Passes a pointer as output to another node as input
|Receives an object pointer input from the calling AINB file
|-
|-
|Element_ModuleIF_Output_S32
|Element_ModuleIF_Output_S32
|Passes a signed int as output to another node as output
|Returns a signed int output from the module to the calling AINB file
|-
|-
|Element_ModuleIF_Output_F32
|Element_ModuleIF_Output_F32
|Passes a 32-bit float as output to another node as output
|Returns a 32-bit float output from the module to the calling AINB file
|-
|-
|Element_ModuleIF_Output_Vec3f
|Element_ModuleIF_Output_Vec3f
|Passes a vector3f as output to another node as output
|Returns a vector3f output from the module to the calling AINB file
|-
|-
|Element_ModuleIF_Output_String
|Element_ModuleIF_Output_String
|Passes a string as output to another node as output
|Returns a string output from the module to the calling AINB file
|-
|-
|Element_ModuleIF_Output_Bool
|Element_ModuleIF_Output_Bool
|Passes a boolean int as output to another node as output
|Returns a bool output from the module to the calling AINB file
|-
|-
|Element_ModuleIF_Output_Ptr
|Element_ModuleIF_Output_Ptr
|Passes a pointer as output to another node as output
|Returns an object pointer output from the module to the calling AINB file
|-
|-
|Element_ModuleIF_Child
|Element_ModuleIF_Child
|Unsure, appears to just be a node connected to a ModuleIF node as a child node
|Returns the node connection name from the module to the calling AINB file
|-
|-
|Element_StateEnd
|Element_StateEnd
|Termination node
|Termination node, specifies what resident node to return to in the calling AINB file
|-
|-
|Element_SplitTiming
|Element_SplitTiming
|Changes when child nodes are run (Enter - first time visiting a node, Update - every frame, Leave - ran upon leaving the node)
|Changes when child nodes are run (Enter - first time visiting a node, Update - every frame, Leave - ran upon leaving the node)
|}
|}
==== Element Flags ====
{| class="wikitable"
{| class="wikitable"
|+Node Flags
|+Element Flags
!Bits
!Bits
!Description
!Description
|-
|-
|1
|1
|Is Precondition Node
|Is Query Element
|-
|1
|Is Module Caller
|-
|-
|1
|1
|Is External AINB File
|Is Resident Initialized
|-
|-
|1
|1
|Is Resident Node
|Is Query Multi-Input
|-
|4
|
|}
 
==== ElementParam<T> ====
Each element contains a table into the 4 parameter types, properties, inputs, outputs, and plugs. The child plugs inform the structure of the element tree.
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x30
|Property Entries
|Entries into the Property Table.
|-
|0x30
|0x60
|Input Output Entries
|Entries into the Input Output Table.
|-
|0x90
|0x14
|Plug Entries
|Entries into the following plug pointer array.
|-
|0xa4
|AsbPtr<>[Total Plug Count]
|Plug Data
|Plug Data Pointer Array.
|}
 
===== Plug Entries =====
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x2
|Plug Type Entry
|Bool/float Input Source/Output Source
|-
|0x2
|0x2
|Plug Type Entry
|
|-
|0x4
|0x2
|Plug Type Entry
|Child Plugs
|-
|0x6
|0x2
|Plug Type Entry
|Jump Plugs
|-
|0x8
|0x2
|Plug Type Entry
|String Input Source
|-
|0xa
|0x2
|Plug Type Entry
|Int Input Source
|-
|0xc
|0x2
|Plug Type Entry
|
|-
|0xe
|0x2
|Plug Type Entry
|
|-
|0x10
|0x2
|Plug Type Entry
|
|-
|-
|5
|0x12
|0x2
|Plug Type Entry
|
|
|}
|}


==== Local Blackboard Parameters ====
====== Plug Type Entry ======
{| class="wikitable"
|+
!Offset
!Size
!Type
!Description
|-
|0x0
|0x1
|u8
|Count
|-
|0x1
|0x1
|u8
|Base Index - base index into Plug Pointer Array
|}
 
====== Plugs ======
{| class="wikitable"
|+
Typical Plug Data
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Element Id
|-
|0x04
|0x04
|u32
|Value
|}
The interpretation of the value depends on the connection type. For input or output connections, the value is a string of the parameter name. For standard connections, the value is a string of the connection name. For jump connections, the value is an id into the Jump Table. Elements are free to extend the plug data with their own element specific values. For built-in element selector-types, excluding <code>Element_BoolSelector</code> and <code>Element_F32Selector</code>, an extra four bytes stores data used to select the child plug. For <code>Element_S32Selector</code>, this is an immediate value. For <code>Element_RandomSelector</code>, this is a weight and for <code>Element_StringSelector</code> it is a string. The condition for  <code>Element_BoolSelector</code> is the entry's value string. <code>Element_F32Selector</code> adds 24 bytes to each entry, consisting of four eight-byte sub-entries.
{| class="wikitable"
|+<code>Element_F32Selector Condition Entry</code>
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Local Blackboard Parameter Index and Flags
|-
|0x04
|0x04
|float
|Condition Value
|}
The first two bytes of the four bytes at offset 0x00 are the blackboard parameter index while the last bit is whether or not the index is used or not. The first entry for <code>Element_F32Selector</code> is the minimum value condition while the second entry is the maximum value condition. The last two entries appear to be unused. The last child element entry for Selector-type nodes is the default case. The condition for this case is either the string その他 ("Other") or 0 (in the case of <code>Element_S32Selector</code>). Input elements that are Selector-type elements also appear to have an additional eight bytes (purpose unknown). <code>Element_Expression</code> has an additional eight bytes per input element (16 bytes in the case of vector3f entries). The purpose of these bytes is unknown.
 
=== Blackboard ===
This section contains an array of the Blackboard parameters used by file. These parameters may be sourced from external Blackboards or parameter files. The section begins with a 0x30 byte section header followed by the array of parameters, an array of default values of said parameters, and an array of file references if applicable. The order of parameters is in the order of string, int, float, bool, vector3f, and pointer. The section header contains six entries, one for each type.
This section contains an array of the Blackboard parameters used by file. These parameters may be sourced from external Blackboards or parameter files. The section begins with a 0x30 byte section header followed by the array of parameters, an array of default values of said parameters, and an array of file references if applicable. The order of parameters is in the order of string, int, float, bool, vector3f, and pointer. The section header contains six entries, one for each type.
{| class="wikitable"
{| class="wikitable"
Line 622: Line 1,276:
|Is File Reference Valid
|Is File Reference Valid
|}
|}
The default value entries vary based on the parameter's data type. For int and float parameters, the entry is a four byte immediate value. String entries are a four byte string value offset. Bool entries are a single byte immediate value and vector3f entries are 12 bytes. Note that pointer parameters do not have default value entries and do not have default values.
The default value entries vary based on the parameter's data type. For int, float, and bool parameters, the entry is a four byte immediate value. String entries are a four byte string value offset. Vector3f entries are 12 bytes. Note that pointer parameters do not have default value entries and do not have default values.
{| class="wikitable"
{| class="wikitable"
|+File Reference Entry
|+File Reference Entry
Line 643: Line 1,297:
|0x04
|0x04
|u32
|u32
|Unknown Hash
|Filename Hash (no extension)
|-
|-
|0x0C
|0x0C
|0x04
|0x04
|u32
|u32
|Unknown Hash
|File Extension Hash (no .)
|}
|}


==== Node Bodies ====
=== Attachments ===
Each node body is composed of two parts: a 0x90 byte parameter section and a 0x14 child node section header followed by said section if applicable. The child node section contains information about the child node and specific connection types. The following parameter indices are indices into the parameter array for that specific type and data type.
{| class="wikitable"
{| class="wikitable"
|+
!Offset
!Offset
!Size
!Size
Line 661: Line 1,315:
|0x00
|0x00
|0x04
|0x04
|u32
|AinbString
|Int Immediate Parameter Base Index
|Name
|-
|-
|0x04
|0x04
|0x04
|0x04
|u32
|AinbPtr<Attachment Param>
|Int Immediate Parameter Count
|Parameters Entry Offset
|-
|-
|0x08
|0x08
|0x04
|0x02
|u32
|u16
|Bool Immediate Parameter Base Index
|EXB Function Count
|-
|0x0A
|0x02
|u16
|EXB Input/Output Field Size
|-
|-
|0x0C
|0x0C
|0x04
|0x04
|u32
|u32
|Bool Immediate Parameter Count
|Name Hash (version 0x407+)
|}
 
==== Attachment Param ====
{| class="wikitable"
|}
{| class="wikitable"
|+Parameter Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x1
|u8
|Unknown (possibly related to debug)
|-
|0x01
|0x3
|u24
|
|-
|0x4
|0x30
|Property Entries
|Property Entries
|}
{| class="wikitable"
|}
 
=== Multi-Input ===
{| class="wikitable"
|+Multi-Input Entry
!Offset
!Size
!Type
!Description
|-
|-
|0x10
|0x00
|0x02
|u16
|Input Element Id
|-
|0x02
|0x02
|u16
|Input Element Output Plug Id
|-
|0x04
|0x04
|0x04
|u32
|u32
|Float Immediate Parameter Base Index
|Flags
|}
 
=== Jump ===
{| class="wikitable"
|+
!Bits
!Description
|-
|8
|Is Valid Update
|-
|23
|
|-
|1
|Update Post Calc
|}
If the first byte of the flags is set to false, then the entry contains another four bytes with a string offset (purpose unknown). Otherwise, the entry is considered valid if the first byte equals 1. When evaluating the behavior trees, the game maintains an array of each root element. When a command is set, the root element of the command is set to this context. A jump will change that root element to the element specified by the jump plug's element id. This usually happens right before the next command's calculation occurs, but if the top bit is set, then it will occur immediately after the current command's calculation finishes (if the source element is an Element_Join, it will always update the root elements post current command calculation). This is primarily used for "subroutines" that run a single time then return to the main execution routine. Element_Fork and Element_Join are the main mechanism to manage multiple root elements. An Element_Fork will replace the current root elements with the element id's of it's jump plugs, possibly "forking" execution into multiple roots. The element at the end of a root element specified by an Element_Fork will optionally have a jump plug referencing a specific Element_Join. Each of these elements will push the Element_Join into the root element array. However, Element_Join has a property parameter called InFlowNum, and until that element has been pushed onto the root element array that many times in a single calculation, it will not activate and remain dormant. However, once this threshold is reached, it will begin execution (with a guard to make sure only one of the instances added to the array will execute).
 
=== 0x50 Section ===
This section is unused in ''Tears of the Kingdom''.
 
=== Query Element Id Array ===
This section is an array of entries of query element ids present in the file.
{| class="wikitable"
|+Query Node Entry
!Offset
!Size
!Type
!Description
|-
|-
|0x14
|0x00
|0x04
|0x02
|u32
|u16
|Float Immediate Parameter Count
|Query Element Id (local to number of query nodes)
|-
|-
|0x18
|0x02
|0x04
|0x02
|u32
|u16
|String Immediate Parameter Base Index
|
|}
 
=== Expression Binary ===
The '''EXB''' ('''Ex'''pression '''B'''inary) section is a completely self-contained section that stores custom instructions for a simple command processor. These instructions are grouped into functions that can be called by nodes to perform calculations. Because the section is self-contained, all offsets in this section are local to the section. The EXB section is shared with ASB files ('''A'''nimation '''S'''equence '''B'''inary).
 
===== Section Structure =====
EXB is essentially its own format and allows for the storage of custom functions in files.
 
====== Section Order ======
 
# 0x2C-Byte Header
# Command Info Table
# Instructions Table
# Parameter Region
# Signature Table
# String Pool
 
===== Sub-Sections =====
 
====== Header ======
{| class="wikitable"
|+EXB Header
!Offset
!Size
!Type
!Description
|-
|-
|0x1C
|0x00
|0x04
|0x04
|u32
|char[4]
|String Immediate Parameter Count
|Magic - “EXB “
|-
|-
|0x20
|0x04
|0x04
|u32
|Vector3f Immediate Parameter Base Index
|-
|0x24
|0x04
|0x04
|u32
|u32
|Vector3f Immediate Parameter Count
|Version (0x02)
|-
|-
|0x28
|0x08
|0x04
|0x04
|u32
|u32
|Pointer Immediate Parameter Base Index
|Static Memory Allocation Size
|-
|-
|0x2C
|0x0C
|0x04
|0x04
|u32
|u32
|Pointer Immediate Parameter Count
|Parameter EXB Field Entry Count
|-
|-
|0x30
|0x10
|0x04
|0x04
|u32
|u32
|Int Input Parameter Base Index
|32-bit Scratch Allocation Size
|-
|-
|0x34
|0x14
|0x04
|0x04
|u32
|u32
|Int Input Parameter Count
|64-bit Scratch Allocation Size
|-
|-
|0x38
|0x18
|0x04
|0x04
|u32
|u32
|Int Output Parameter Base Index
|Command Info Offset
|-
|-
|0x3C
|0x1C
|0x04
|0x04
|u32
|u32
|Int Output Parameter Count
|Command Table Offset
|-
|-
|0x40
|0x20
|0x04
|0x04
|u32
|u32
|Bool Input Parameter Base Index
|Signature Table Offset
|-
|-
|0x44
|0x24
|0x04
|0x04
|u32
|u32
|Bool Input Parameter Count
|Parameter Region Offset
|-
|-
|0x48
|0x28
|0x04
|0x04
|u32
|u32
|Bool Output Parameter Base Index
|String Pool Offset
|}
 
====== Command Info Table ======
This section contains an array of command (function) info entries. The first four bytes specify the entry count.
{| class="wikitable"
|+Command Info Entry
!Offset
!Size
!Type
!Description
|-
|-
|0x4C
|0x00
|0x04
|0x04
|u32
|s32
|Bool Output Parameter Count
|Base Index Pre-Command Entry
|-
|-
|0x50
|0x04
|0x04
|u32
|Float Input Parameter Base Index
|-
|0x54
|0x04
|0x04
|u32
|u32
|Float Input Parameter Count
|Pre-Entry Static Memory Usage
|-
|-
|0x58
|0x08
|0x04
|0x04
|u32
|u32
|Float Output Parameter Base Index
|Instruction Base Index
|-
|-
|0x5C
|0x0C
|0x04
|0x04
|u32
|u32
|Float Output Parameter Count
|Instruction Count
|-
|-
|0x60
|0x10
|0x04
|0x04
|u32
|u32
|String Input Parameter Base Index
|Static Memory Size
|-
|-
|0x64
|0x14
|0x04
|0x02
|u32
|u16
|String Input Parameter Count
|32-bit Scratch Memory Size
|-
|-
|0x68
|0x16
|0x04
|0x02
|u32
|u16
|String Output Parameter Base Index
|64-bit Scratch Memory Size
|-
|-
|0x6C
|0x18
|0x04
|0x02
|u32
|u16
|String Output Parameter Count
|Output Data Type Enum
|-
|-
|0x70
|0x1A
|0x04
|0x02
|u32
|u16
|Vector3f Input Parameter Base Index
|Input Data Type Enum
|}
{| class="wikitable"
|+Data Type Enum
!Value (Hex)
!Value (Dec)
!Data Type
|-
|-
|0x74
|0x0
|0x04
|0
|u32
|No Data
|Vector3f Input Parameter Count
|-
|-
|0x78
|0x1
|0x04
|1
|u32
|Immediate Value/From User
|Vector3f Output Parameter Base Index
|-
|-
|0x7C
|0x02
|0x04
|2
|u32
|bool
|Vector3f Output Parameter Count
|-
|-
|0x80
|0x03
|0x04
|3
|u32
|int
|Pointer Input Parameter Base Index
|-
|-
|0x84
|0x04
|0x04
|u32
|4
|Pointer Input Parameter Count
|float
|-
|-
|0x88
|0x05
|0x04
|5
|u32
|string
|Pointer Output Parameter Base Index
|-
|-
|0x8C
|0x06
|0x04
|6
|u32
|vector3f
|Pointer Output Parameter Count
|}
|}
====== Instructions Table ======
This section contains an array of instruction entries which are read by the EXB command processor. The first four bytes specify the entry count.
{| class="wikitable"
{| class="wikitable"
|+Child Node Section Header
|+Instruction Entry
!Offset
!Offset
!Size
!Size
Line 849: Line 1,613:
|0x01
|0x01
|u8
|u8
|Bool/float Input Source Node/Output Source Node Count
|Instruction Type
|-
|-
|0x01
|0x01
|0x01
|0x01
|u8
|u8
|Bool/float Input Source Node/Output Source Node Base Index
|Data Type Enum
|-
|-
|0x02
|0x02
|0x01
|0x01
|u8
|u8
|Unknown Connection Type Count (Unused in TotK)
|Left-Hand Side Parameter Source Enum
|-
|-
|0x03
|0x03
|0x01
|0x01
|u8
|u8
|Unknown Connection Type Base Index (Unused TotK)
|Right-Hand Side Parameter Source Enum
|-
|-
|0x04
|0x04
|0x02
|u16
|Left-Hand Side Parameter Value
|-
|0x06
|0x02
|u16
|Right-Hand Side Parameter Value
|}
For UserDefined type instructions, the bytes at offset 0x02-0x04 become a u16 static memory index and the bytes at 0x04-0x08 become a u32 index into the function signatures table.
{| class="wikitable"
|+Instruction Types
!Value (Hex)
!Value (Dec)
!Instruction Type
|-
|0x01
|0x01
|u8
|1
|Standard Child Node Count
|Terminator
|-
|0x02
|2
|Store
|-
|0x03
|3
|Negate
|-
|0x04
|4
|NegateBool
|-
|-
|0x05
|0x05
|0x01
|5
|u8
|Add
|Standard Child Node Base Index
|-
|-
|0x06
|0x06
|0x01
|6
|u8
|Subtract
|Resident Update Node Count
|-
|-
|0x07
|0x07
|0x01
|7
|u8
|Multiply
|Resident Update Base Index
|-
|-
|0x08
|0x08
|0x01
|8
|u8
|Divide
|String Input Source Node Count
|-
|-
|0x09
|0x09
|0x01
|9
|u8
|Modulus
|String Input Source Node Base Index
|-
|-
|0x0A
|0x0A
|0x01
|10
|u8
|Increment
|Int Input Source Node Count
|-
|-
|0x0B
|0x0B
|0x01
|11
|u8
|Decrement
|Int Input Source Node Base Index
|-
|-
|0x0C
|0x0C
|0x01
|12
|u8
|ScalarMultiplyVec3f
|Unknown Connection Type Count (Unused in ''TotK'')
|-
|-
|0x0D
|0x0D
|0x01
|13
|u8
|ScalarDivideVec3f
|Unknown Connection Type Base Index (Unused ''TotK'')
|-
|-
|0x0E
|0x0E
|0x01
|14
|u8
|LeftShift
|Unknown Connection Type Count (Unused in ''TotK'')
|-
|-
|0x0F
|0x0F
|15
|RightShift
|-
|0x10
|16
|LessThan
|-
|0x11
|17
|LessThanEqual
|-
|0x12
|18
|GreaterThan
|-
|0x13
|19
|GreaterThanEqual
|-
|0x14
|20
|Equal
|-
|0x15
|21
|NotEqual
|-
|0x16
|22
|AND
|-
|0x17
|23
|XOR
|-
|0x18
|24
|OR
|-
|0x19
|25
|LogicalAND
|-
|0x1A
|26
|LogicalOR
|-
|0x1B
|27
|UserFunction
|-
|0x1C
|28
|JumpIfLHSZero
|-
|0x1D
|29
|Jump
|}
UserFunctions are mapped to a function in the executable by function signature. There are two types of these functions: direct and object. Direct functions are straightforward functions that take up to two arguments and are matched using the function signature. Function objects can take additional arguments and are indexed at runtime.
{| class="wikitable"
|+Data Type Enum
!Value (Hex)
!Value (Dec)
!Data Type
|-
|0x0
|0
|No Data
|-
|0x1
|1
|Immediate Value/From User
|-
|0x02
|2
|bool
|-
|0x03
|3
|int
|-
|0x04
|4
|float
|-
|0x05
|5
|string
|-
|0x06
|6
|vector3f
|}
{| class="wikitable"
|+Parameter Source Enum
!Value (Hex)
!Value (Dec)
!Parameter Source
|-
|0x00
|0
|Immediate Parameters
|-
|0x01
|0x01
|u8
|1
|Unknown Connection Type Base Index (Unused ''TotK'')
|Immediate Parameters (String)
|-
|0x02
|2
|Static Memory
|-
|0x03
|3
|Parameters Region
|-
|0x04
|4
|Parameters Region (String)
|-
|0x05
|5
|Output Value
|-
|0x06
|6
|Input Value
|-
|0x07
|7
|32-bit Scratch
|-
|0x08
|8
|64-bit Scratch
|-
|0x09
|9
|UserOutput
|-
|0x0A
|10
|UserInput
|}
UserCallback is a class that contains virtual functions providing memory allocation. The input value is passed from the calling node and the output value is passed back.
 
====== Parameter Region ======
The parameter region is a region that stores the values for parameters values that are too large to fit into two bytes. Parameters that get their values from this section instead store an offset relative to the beginning of the parameter region to the start of the value.
 
====== Signatures Table ======
This section is an array of u32 string offsets for each function signature.
 
====== String Pool ======
The string pool is an array of null-terminated strings encoded with UTF-8. All string offsets in this section are relative to the beginning of the string pool.
 
=== Module Caller ===
This section contains an array of all AINB modules linked to the current AINB file. The first four bytes specify the entry count.
{| class="wikitable"
|+AINB Module Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|File Path Offset
|-
|0x04
|0x04
|u32
|File Category Offset
|-
|0x08
|0x04
|u32
|AINB File Count
|}
 
=== External Action Array ===
This section appears to interact with XLink. The first four bytes specify the entry count.
{| class="wikitable"
|+Entry String Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Node Index
|-
|0x04
|0x04
|u32
|String 1 Offset (always メインステート ("Main State"))
|-
|0x08
|0x04
|u32
|State Name Offset
|}
 
=== Module Caller Link ===
This section contains two 32-bit file hashes. The first hash is a hash for the file itself and the second hash appears to be a hash for that file's parent file. These are used by Element_ModuleCaller.
 
=== Child Replacement Table ===
This section is used to remove or replace specific elements or attachments at runtime. This is used to toggle off debug elements/attachments in release builds. The section begins with an eight-byte section header.
{| class="wikitable"
|+Child Replacement Section Header
!Offset
!Size
!Type
!Description
|-
|-
|0x10
|0x00
|0x01
|0x01
|u8
|u8
|Unknown Connection Type Count (Unused in ''TotK'')
|Initialization Guard (Is Initialized)
|-
|-
|0x11
|0x01
|0x01
|0x01
|u8
|u8
|Unknown Connection Type Base Index (Unused ''TotK'')
|
|-
|0x02
|0x02
|u16
|Replacement Count
|-
|0x04
|0x02
|s16
|Override Element Count
|-
|0x06
|0x02
|s16
|Override Attachment Parameter Count
|}
{| class="wikitable"
|+Child Replacement Table Entry
!Offset
!Size
!Type
!Description
|-
|-
|0x12
|0x00
|0x01
|0x01
|u8
|u8
|Unknown Connection Type Count (Unused in ''TotK'')
|Replacement Type Enum (0 = remove child element, 1 = replace child element, 2 = remove attachment)
|-
|-
|0x13
|0x01
|0x01
|0x01
|u8
|u8
|Unknown Connection Type Base Index (Unused ''TotK'')
|
|-
|0x02
|0x02
|u16
|Element Id
|-
|0x04
|0x02
|u16
|Child Element Id/Attachment Id
|-
|0x06
|0x02
|u16
|New Element Id (for child element replacements)
|}
 
=== 0x6C Section ===
This section is unused in ''Tears of the Kingdom''.
 
=== Enum Relocation ===
This section is used to resolve enum values at runtime. This section is unused in ''Tears of the Kingdom'' as all enum values are statically present in the file. However, in ''Splatoon 3'', this section is used extensively as all enum values are stored in the main executable. The first four bytes of this section specifies the number of entries in the section.
{| class="wikitable"
|+Enum Resolve Array Entry
!Offset
!Size
!Type
!Description
|-
|0x00
|0x04
|u32
|Enum Value Offset
|-
|0x04
|0x04
|u32
|Enum Class Name Offset
|-
|0x08
|0x04
|u32
|Enum Value Name Offset
|}
|}
// TODO: finish
 
=== String Pool ===
The string pool is an array of null-terminated strings encoded with UTF-8. All string offsets in the file are relative to the first byte of this section. Note that this section also contains some unreferenced strings which are the enums for certain parameters.
[[Category:File formats]]
[[Category:File formats]]
Retrieved from "https://epd.zeldamods.org/wiki/AINB"