More lua doc fixes

This commit is contained in:
MysterD 2022-03-04 22:38:43 -08:00
parent d3b9163507
commit 18a5ebafae
5 changed files with 281 additions and 237 deletions

View File

@ -276,6 +276,7 @@ def doc_file(processed_file):
for c in constants:
s += doc_constant(c)
s += '\n[:arrow_up_small:](#)\n'
s += '\n<br />\n\n'
return s

View File

@ -451,7 +451,7 @@ def doc_function(function):
s += "\n### Lua Example\n"
if rtype != None:
s += "`local %sValue = %s(%s)`\n" % (rtype, fid, param_str)
s += "`local %sValue = %s(%s)`\n" % (rtype.replace('`', ''), fid, param_str)
else:
s += "`%s(%s)`\n" % (fid, param_str)

View File

@ -515,6 +515,8 @@
- SOUND_TERRAIN_WATER
- SOUND_VIBRATO
[:arrow_up_small:](#)
<br />
## [behavior_table.h](#behavior_table.h)
@ -1038,6 +1040,8 @@
| id_bhvIntroScene | 513 |
| id_bhv_max_count | 514 |
[:arrow_up_small:](#)
<br />
## [camera.h](#camera.h)
@ -1220,6 +1224,8 @@
- SHAKE_SHOCK
- SHAKE_SMALL_DAMAGE
[:arrow_up_small:](#)
<br />
## [characters.h](#characters.h)
@ -1282,6 +1288,8 @@
| CT_WARIO | 4 |
| CT_MAX | 5 |
[:arrow_up_small:](#)
<br />
## [djui_hud_utils.h](#djui_hud_utils.h)
@ -1301,6 +1309,8 @@
| RESOLUTION_N64 | 1 |
| RESOLUTION_COUNT | 2 |
[:arrow_up_small:](#)
<br />
## [graph_node.h](#graph_node.h)
@ -1344,6 +1354,8 @@
- GRAPH_RENDER_PLAYER
- GRAPH_RENDER_Z_BUFFER
[:arrow_up_small:](#)
<br />
## [interaction.c](#interaction.c)
@ -1364,6 +1376,8 @@
| INT_HIT_FROM_ABOVE | (1 << 6) |
| INT_HIT_FROM_BELOW | (1 << 7) |
[:arrow_up_small:](#)
<br />
## [interaction.h](#interaction.h)
@ -1442,6 +1456,8 @@
| INTERACT_IGLOO_BARRIER | (1 << 30) |
| INTERACT_PLAYER | (1 << 31) |
[:arrow_up_small:](#)
<br />
## [mario_animation_ids.h](#mario_animation_ids.h)
@ -1659,6 +1675,8 @@
| MARIO_ANIM_FORWARD_SPINNING_FLIP | 207 |
| MARIO_ANIM_TRIPLE_JUMP_FLY | 208 |
[:arrow_up_small:](#)
<br />
## [mario_geo_switch_case_ids.h](#mario_geo_switch_case_ids.h)
@ -1702,6 +1720,8 @@
| MARIO_HAND_HOLDING_WING_CAP | 4 |
| MARIO_HAND_RIGHT_OPEN | 5 |
[:arrow_up_small:](#)
<br />
## [network_player.h](#network_player.h)
@ -1719,6 +1739,8 @@
| NPT_SERVER | 2 |
| NPT_CLIENT | 3 |
[:arrow_up_small:](#)
<br />
## [object_constants.h](#object_constants.h)
@ -1797,6 +1819,8 @@
- RESPAWN_INFO_TYPE_32
- RESPAWN_INFO_TYPE_NULL
[:arrow_up_small:](#)
<br />
## [object_list_processor.h](#object_list_processor.h)
@ -1827,6 +1851,8 @@
| OBJ_LIST_UNIMPORTANT | 12 |
| NUM_OBJ_LISTS | 13 |
[:arrow_up_small:](#)
<br />
## [os_cont.h](#os_cont.h)
@ -1880,6 +1906,8 @@
- Y_BUTTON
- Z_TRIG
[:arrow_up_small:](#)
<br />
## [sm64.h](#sm64.h)
@ -2237,6 +2265,8 @@
- WATER_STEP_HIT_WALL
- WATER_STEP_NONE
[:arrow_up_small:](#)
<br />
## [smlua_hooks.h](#smlua_hooks.h)
@ -2256,6 +2286,8 @@
| HOOK_ON_INTERACT | 9 |
| HOOK_MAX | 10 |
[:arrow_up_small:](#)
<br />
## [smlua_model_utils.h](#smlua_model_utils.h)
@ -2640,6 +2672,8 @@
| E_MODEL_WARIOS_WINGED_METAL_CAP | 374 |
| E_MODEL_MAX | 375 |
[:arrow_up_small:](#)
<br />
## [types.h](#types.h)
@ -2674,5 +2708,7 @@
| SPTASK_STATE_FINISHED | 3 |
| SPTASK_STATE_FINISHED_DP | 4 |
[:arrow_up_small:](#)
<br />

File diff suppressed because it is too large Load Diff

View File

@ -37,6 +37,13 @@ The `gTextures` table contains references to textures. Listed in [GlobalTextures
<br />
## [gObjectAnimations](#gObjectAnimations)
The `gObjectAnimations` table contains references to object animations. Listed in [GlobalObjectAnimations](structs.md#GlobalObjectAnimations).
[:arrow_up_small:](#)
<br />
## [gGlobalSyncTable](#gGlobalSyncTable)
The `gGlobalSyncTable` is a table used for networking. Any field set inside of this table is automatically synchronized with all other clients. Do not use this table for player-specific variables, keep those in [gPlayerSyncTable](#gPlayerSyncTable). Player-specific variable will desynchronize within this table since it doesn't automatically translate `playerIndex`.