Retro Modding Wiki - User contributions [en]

AFSM (File Format)

2015-01-26T12:36:58Z

Skysurf3000: condition names are zeo terminated

The '''AFSM format''' controls AI behavior; it stands for '''A'''I '''F'''inite '''S'''tate '''M'''achine. AI-controlled creatures have a limited number of possible states they can be in. The AFSM file defines those states, and what triggers can cause it to advance to another state.

{{researchminor|reason=We should have a list of possible states and trigger conditions and a short explanation of what they generally do on this page somewhere. Also, the float settings on conditions is unknown.}}

__TOC__

== Format ==

=== Header ===

The format first defines a list of states, then defines each trigger attached to each state. There are no state/trigger type IDs; rather, the name string itself is used as an identifier to fetch the corresponding AI function. It starts with a short header listing each state and then providing a trigger count. Note that the trigger count isn't actually used to parse the file; it's present merely because the game uses it to allocate space for each trigger ahead of time.

{| class="wikitable"
! Type
! Count
! Description
|-
| long
| 1
| '''State count''' (SC)
|-
| string
| SC
| '''State names''' (each zero-terminated)
|-
| long
| 1
| '''Condition count'''
|}

=== State Triggers ===

Following that, it iterates through each state, defining the triggers associated with each one. Triggers are composed of a target state index and a number of conditions; when all the conditions associated with a trigger are satisfied, it advances to the targeted state. The state trigger definitions are structured like this:

{| class="wikitable"
! Type
! Count
! Description
|-
| long
| 1
| '''Trigger count''' (TC)
|-
| Trigger
| TC
| '''Triggers'''
|}

=== Trigger ===

{| class="wikitable"
! Type
! Count
! Description
|-
| long
| 1
| '''Condition count''' (CC)
|-
| Trigger condition
| CC
| '''Conditions'''
|}

=== Condition ===

{| class="wikitable"
! Type
! Count
! Description
|-
| string
| 1
| '''Condition name''' (zero terminated)
|-
| float
| 1
| {{unknown|'''Unknown''' (possibly AI function parameter)}}
|-
| long
| 1
| '''Target state index''' (note: this is ONLY present on the first condition for each trigger!)
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

AFSM (File Format)

2015-01-26T12:35:27Z

Skysurf3000: The "trigger count" at the end of the header is actually a "condition count"

The '''AFSM format''' controls AI behavior; it stands for '''A'''I '''F'''inite '''S'''tate '''M'''achine. AI-controlled creatures have a limited number of possible states they can be in. The AFSM file defines those states, and what triggers can cause it to advance to another state.

{{researchminor|reason=We should have a list of possible states and trigger conditions and a short explanation of what they generally do on this page somewhere. Also, the float settings on conditions is unknown.}}

__TOC__

== Format ==

=== Header ===

The format first defines a list of states, then defines each trigger attached to each state. There are no state/trigger type IDs; rather, the name string itself is used as an identifier to fetch the corresponding AI function. It starts with a short header listing each state and then providing a trigger count. Note that the trigger count isn't actually used to parse the file; it's present merely because the game uses it to allocate space for each trigger ahead of time.

{| class="wikitable"
! Type
! Count
! Description
|-
| long
| 1
| '''State count''' (SC)
|-
| string
| SC
| '''State names''' (each zero-terminated)
|-
| long
| 1
| '''Condition count'''
|}

=== State Triggers ===

Following that, it iterates through each state, defining the triggers associated with each one. Triggers are composed of a target state index and a number of conditions; when all the conditions associated with a trigger are satisfied, it advances to the targeted state. The state trigger definitions are structured like this:

{| class="wikitable"
! Type
! Count
! Description
|-
| long
| 1
| '''Trigger count''' (TC)
|-
| Trigger
| TC
| '''Triggers'''
|}

=== Trigger ===

{| class="wikitable"
! Type
! Count
! Description
|-
| long
| 1
| '''Condition count''' (CC)
|-
| Trigger condition
| CC
| '''Conditions'''
|}

=== Condition ===

{| class="wikitable"
! Type
! Count
! Description
|-
| string
| 1
| '''Condition name'''
|-
| float
| 1
| {{unknown|'''Unknown''' (possibly AI function parameter)}}
|-
| long
| 1
| '''Target state index''' (note: this is ONLY present on the first condition for each trigger!)
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]