From 16e78ee36ad90065cc008d093db7a89318a2e41e Mon Sep 17 00:00:00 2001 From: John S <138552829+Multi-Volt@users.noreply.github.com> Date: Sun, 22 Dec 2024 06:40:54 -0500 Subject: [PATCH] Fix a capitalization issue within the interaction.h documentation (#578) * Document Interaction.h (68.23%) * Fix caps * Fix missing bracket * Make descriptions a little more clear and concise * Fix a capitalization issue --- autogen/lua_definitions/functions.lua | 2 +- docs/lua/functions-3.md | 2 +- src/game/interaction.h | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/autogen/lua_definitions/functions.lua b/autogen/lua_definitions/functions.lua index 7a5df798f..0a1975034 100644 --- a/autogen/lua_definitions/functions.lua +++ b/autogen/lua_definitions/functions.lua @@ -4408,7 +4408,7 @@ end --- @param interactType integer --- @param o Object --- @return integer ---- Handles interaction with grabbable objects (e.g., crates, small enemies, or Bowser). Checks if Mario can pick up the object and initiates the grab action if possible. Useful for course mechanics, throwing items, and bowser +--- Handles interaction with grabbable objects (e.g., crates, small enemies, or Bowser). Checks if Mario can pick up the object and initiates the grab action if possible. Useful for course mechanics, throwing items, and Bowser function interact_grabbable(m, interactType, o) -- ... end diff --git a/docs/lua/functions-3.md b/docs/lua/functions-3.md index 5ff8e314b..e27015918 100644 --- a/docs/lua/functions-3.md +++ b/docs/lua/functions-3.md @@ -4959,7 +4959,7 @@ Handles interaction with flame objects. If Mario touches a flame and is not invu ## [interact_grabbable](#interact_grabbable) ### Description -Handles interaction with grabbable objects (e.g., crates, small enemies, or Bowser). Checks if Mario can pick up the object and initiates the grab action if possible. Useful for course mechanics, throwing items, and bowser +Handles interaction with grabbable objects (e.g., crates, small enemies, or Bowser). Checks if Mario can pick up the object and initiates the grab action if possible. Useful for course mechanics, throwing items, and Bowser ### Lua Example `local integerValue = interact_grabbable(m, interactType, o)` diff --git a/src/game/interaction.h b/src/game/interaction.h index f32463a70..3f1188c3a 100644 --- a/src/game/interaction.h +++ b/src/game/interaction.h @@ -297,7 +297,7 @@ u32 interact_cap(struct MarioState *m, UNUSED u32 interactType, struct Object *o /* |description| Handles interaction with grabbable objects (e.g., crates, small enemies, or Bowser). Checks if Mario can pick up the object and initiates the grab action if possible. -Useful for course mechanics, throwing items, and bowser +Useful for course mechanics, throwing items, and Bowser |descriptionEnd| */ u32 interact_grabbable(struct MarioState *m, u32 interactType, struct Object *o);