From 86c53786da4848dbc175fb409bb43620a7cb2694 Mon Sep 17 00:00:00 2001 From: EmeraldLockdown <86802223+EmeraldLoc@users.noreply.github.com> Date: Mon, 15 Jun 2026 16:55:36 -0500 Subject: [PATCH] (Ty cooliokid956) Minor changes in C docs for smlua --- docs/c/sections/smlua.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/c/sections/smlua.md b/docs/c/sections/smlua.md index 38d2a1607..c6fe834e8 100644 --- a/docs/c/sections/smlua.md +++ b/docs/c/sections/smlua.md @@ -10,14 +10,12 @@ Autogen is the system in place to allow C functions to be generated into Lua fun Autogen can be ran by running `autogen/autogen.sh` in the root directory of your project. -Autogen needs to be ran for a variety of reasons: - -- Anytime a function's name, parameter, or description is changed -- Anytime a struct's name, or variable is changed -- Anytime a enum's name, or contents is changed -- Anytime a new function or struct is added -- Anytime a hook event is added or modified -- And much more +Autogen may need a rerun when changes are made to: +- Functions +- Structs +- Enums +- Hooks +- etc. ## Adding functions, structs, and constants to autogen @@ -128,4 +126,4 @@ smlua_call_event_hooks(HOOK_ALLOW_HAZARD_SURFACE, m, HAZARD_TYPE_LAVA_WALL, &all - The output should be a reference so the function can properly set the variable. - If Lua doesn't return anything, the output passed into the function stays as what it was originally, so it serves as a default value. That's why `allowHazard` is set to true. -After all these changes, remember to rerun autogen. Once that's done, you should have your hook into the game, test it and make sure everything works! \ No newline at end of file +After all these changes, remember to rerun autogen. Once that's done, you should have your hook into the game, test it and make sure everything works!