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
This commit is contained in:
John S 2024-12-22 06:40:54 -05:00 committed by GitHub
parent 8da73663aa
commit 16e78ee36a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 3 additions and 3 deletions

View file

@ -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

View file

@ -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)`

View file

@ -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);