188
edits
Action: Difference between revisions
Jump to navigation
Jump to search
Expand on interactions
mNo edit summary |
Icecream17 (talk | contribs) (Expand on interactions) |
||
| (10 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
An '''action''' is a particular state that Mario can be in. [[ | An '''action''' is a particular state that Mario can be in. [[Long Jump|Long jumping]], [[crouching]], and [[walking]] are examples of actions. Each action has code controlling high-level behavior such as Mario's movement while in the action, as well as transitions to other actions. Mario can only be in one action at a time. | ||
It is likely the game developers referred to actions as "states", as evidenced by the "STA" label on one of the debug menus. The name "action" was chosen by the community as a less ambiguous alternative. | It is likely the game developers referred to actions as "states", as evidenced by the "STA" label on one of the debug menus. The name "action" was chosen by the community as a less ambiguous alternative. | ||
If Mario's current action is hacked to be an invalid action value, the game will either freeze or softlock, since such an action lacks associated code. There are 230 valid actions in the game, but some of these are accessible only through hacking. In addition to these, there are two "pseudo-actions", 0x050 and 0x051, that immediately transition to another action. Specifically, they are "begin sliding" actions, and they transition into either butt slide or stomach slide, depending on whether Mario is facing uphill or downhill. There is evidence of one action, action 0x00E, that was defined but whose code was never implemented. | If Mario's current action is hacked to be an invalid action value, the game will either freeze or softlock, since such an action lacks associated code. There are 230 valid actions in the game, but some of these are accessible only through hacking. In addition to these, there are two "pseudo-actions", 0x050 and 0x051, that immediately transition to another action. Specifically, they are "begin sliding" actions, and they transition into either butt slide or stomach slide, depending on whether Mario is facing uphill or downhill. There is evidence of one action, action 0x00E, that was defined but whose code was never implemented. | ||
== Action groups == | == Action groups == | ||
An action is represented as a 32-bit value. The lowest nine bits are a unique ID for the action, ranging in value from 0x000 to 0x192. Not all action IDs in this range are used by an action. | An action is represented as a 32-bit value. The lowest nine bits are a unique ID for the action, ranging in value from 0x000 to 0x192. Not all action IDs in this range are used by an action. | ||
These IDs are divided into seven ranges, called action groups. These roughly categorize the behavior of each action, but are primarily used for organizational purposes in the code. | These IDs are divided into seven ranges, called action groups. These roughly categorize the behavior of each action, but are primarily used for organizational purposes in the code. | ||
{| class="wikitable" | {| class="wikitable" | ||
! Name !! Range start !! Range end !! Number of actions !! Description | ! Name !! Range start !! Range end !! Number of actions !! Description | ||
| Line 29: | Line 26: | ||
| object || 0x180 || 0x1BF || 10 || relating to picking up or releasing objects | | object || 0x180 || 0x1BF || 10 || relating to picking up or releasing objects | ||
|} | |} | ||
The "uninitialized" action with ID 0x000 is not considered to be a part of any group. Despite being a valid action, it overrides much of Mario's behavior and is implemented differently than regular actions. | The "uninitialized" action with ID 0x000 is not considered to be a part of any group. Despite being a valid action, it overrides much of Mario's behavior and is implemented differently than regular actions. | ||
Action groups, while largely used for organization, do sometimes define shared properties of the actions contained in them. For example, the code for dying in quicksand is shared among the stationary, moving, and object action groups, so it is impossible to die from quicksand while in one of the other action groups. | Action groups, while largely used for organization, do sometimes define shared properties of the actions contained in them. For example, the code for dying in quicksand is shared among the stationary, moving, and object action groups, so it is impossible to die from quicksand while in one of the other action groups. | ||
== Action flags == | == Action flags == | ||
Most properties of actions are defined by action flags, which make up the remaining bits of the 32-bit action value. While there are 23 bits left after excluding the 9-bit ID, bit 30 is both unused by the game and unset by any action, so there are effectively only 22 action flags. | Most properties of actions are defined by action flags, which make up the remaining bits of the 32-bit action value. While there are 23 bits left after excluding the 9-bit ID, bit 30 is both unused by the game and unset by any action, so there are effectively only 22 action flags. | ||
{| class="wikitable" | {| class="wikitable" | ||
! Bit !! Name !! Example properties | ! Bit !! Name !! Example properties | ||
| Line 45: | Line 38: | ||
| 10 || moving || affects buoyancy in water, push speed of horizontal wind | | 10 || moving || affects buoyancy in water, push speed of horizontal wind | ||
|- | |- | ||
| 11 || airborne || allows stomping on enemies, affects knockback behavior, disallows lava boost | | 11 || airborne || allows stomping on enemies, affects knockback behavior, disallows [[Lava Boost|lava boost]] | ||
|- | |- | ||
| 12 || intangible || disallows object interaction | | 12 || intangible || disallows object interaction | ||
| Line 85: | Line 78: | ||
| 31 || throwing || something to do with particle effects; details not yet known | | 31 || throwing || something to do with particle effects; details not yet known | ||
|} | |} | ||
Note that the first three flags have the same name as the first three action groups. While most actions in these groups have the corresponding flag set, the converse is typically not true. Actions in the cutscene group, for example, may have the airborne flag set if they take place while Mario is in the air. There also exist unintuitive cases, such as action 0x036, [[Air Throw Land|air throw landing]], which has the airborne flag set despite being a grounded stationary action, leading to strange behavior in some circumstances.<ref>[https://www.youtube.com/watch?v=c8iD58RQ1nw "Air Throw Landing (Commentated)" by bad_boot]</ref> | |||
Note that the first three flags have the same name as the first three action groups. While most actions in these groups have the corresponding flag set, the converse is typically not true. Actions in the cutscene group, for example, may have the airborne flag set if they take place while Mario is in the air. There also exist unintuitive cases, such as action 0x036, air throw landing, which has the airborne flag set despite being a grounded stationary action, leading to strange behavior in some circumstances<ref>https://www.youtube.com/watch?v=c8iD58RQ1nw</ref>. | == Frame == | ||
Whenever within a frame, <code>execute_mario_action</code> is called, and Mario's action is not "uninitialized", the following happens: | |||
# Reset Mario's model. The model animation will be updated within the action. | |||
# Why is so <code>update_mario_inputs</code> so complicated? Not even going into that. | |||
# If Mario's floor type is the death plane or... vertical wind, check warps, play SOUND_MARIO_WAAAOOOW. | |||
# If Mario's floor type is a warp, check warps. | |||
# If Mario's floor type is the [[The Princess's Secret Slide|PSS]] start or end tiles, start or end the timer. | |||
# If Mario's action does not have the (11) air or (13) swimming flags, the floor is SURFACE_BURNING (lava?), and Mario is not riding a shell and mario's is less than 10 units above the floor. | |||
## Damage if not wearing metal cap, and set action to [[Lava Boost]]. | |||
# <code>mario_process_interactions</code> '''This can change mario's action'''. | |||
## First, loop over every object's interaction handlers. | |||
### If the interactType of the handler is one of the types Mario can currently collide with... | |||
#### Unset that type. ''(Basically Mario cannot interact with two objects of the same interaction type.)'' | |||
#### If the object's interaction status is not INT_STATUS_INTERACTED, ''call the handler'' | |||
## Decrement the invincibility timer | |||
## Call <code>check_kick_or_punch_wall</code>. ''(Basically, Mario still gets speed from kicking, punching, or "tripping" (idk what this flag name means) a wall, even if the action changes.)'' | |||
## Remove the punching, kicking, and tripping flags from Mario. | |||
## If (not interacting with door) sDisplayingDoorText = FALSE | |||
## If (not interacting with warp) sJustTeleported = FALSE | |||
# '''Loop: Call the function that executes Mario's current action'''. Each action has associated code as stated above. Whenever the function is called, it can return <code>TRUE</code>, continuing the loop. Actions often call <code>set_mario_action</code>, which returns TRUE and processes yet another action. Theoretically, this could cause an infinite loop, however such a subframe transition sequence has not been found.<ref>https://github.com/n64decomp/sm64/blob/66018e9f3caaa67399218971d61366cb3f7ba7d7/src/game/mario.c#L1717-L1747</ref> | |||
# Adjust Mario's model for quicksand and squishing, adjust the camera, when submerged adjust the camera and spawn bubbles, update health, update cap hitbox and model, process wind and infinite stairs music. | |||
# Set <code>oInteractionStatus</code> to 0. | |||
== References == | == References == | ||
<references/> | |||
{{actions}} | |||
[[Category:Action Mechanics]] | |||