Skip to content

Commit

Permalink
[Game Menu] Cleanup module and added source comment
Browse files Browse the repository at this point in the history
[Doc] Updated code source documentation
[Sample] Updated sample binaries
  • Loading branch information
aoineko-fr committed Nov 15, 2022
1 parent 0ee1a55 commit a2cb9f0
Show file tree
Hide file tree
Showing 61 changed files with 382 additions and 88 deletions.
2 changes: 1 addition & 1 deletion engine/doc/html/files/fsm-h-Summary.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion engine/doc/html/files/fsm-h-SummaryToolTips.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 14 additions & 2 deletions engine/doc/html/files/fsm-h.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,22 @@
<div class="CBody"><p>Get previous state</p><div class="CHeading">Return</div><p>The previous state</p></div>
</div>

<a name="FSM_Update"></a><a name="Topic620"></a><div class="CTopic TFunction LC last">
<a name="FSM_Update"></a><a name="Topic490"></a><div class="CTopic TFunction LC">
<div class="CTitle">FSM_Update</div>
<div id="NDPrototype620" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> FSM_Update()</div></div>
<div id="NDPrototype490" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> FSM_Update()</div></div>
<div class="CBody"><p>Update the current state</p></div>
</div>

<a name="FSM_IsPending"></a><a name="Topic799"></a><div class="CTopic TFunction LC">
<div class="CTitle">FSM_IsPending</div>
<div id="NDPrototype799" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> FSM_IsPending()</div></div>
<div class="CBody"><p>Is a new state is pending</p></div>
</div>

<a name="FSM_GetPending"></a><a name="Topic800"></a><div class="CTopic TFunction LC last">
<div class="CTitle">FSM_GetPending</div>
<div id="NDPrototype800" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> FSM_State* FSM_GetPending()</div></div>
<div class="CBody"><p>Get the pending state</p></div>
</div>

</body></html>
2 changes: 1 addition & 1 deletion engine/doc/html/files/game_menu-h-Summary.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion engine/doc/html/files/game_menu-h-SummaryToolTips.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

32 changes: 28 additions & 4 deletions engine/doc/html/files/game_menu-h.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,34 @@
<div class="CTitle">Functions</div>
</div>

<a name="Menu_SetCallback"></a><a name="Topic744"></a><div class="CTopic TFunction LC last">
<div class="CTitle">Menu_SetCallback</div>
<div id="NDPrototype744" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Menu_SetCallback(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">id,</td></tr><tr><td class="PType first">Menu_InputCB&nbsp;</td><td class="PName last">cb</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Set current</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">id<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Callback ID (see &lt;MENU_CALLBACK&gt;)</p></td></tr><tr><td class="CDLEntry">cb<div class="CDLParameterType">Menu_InputCB</div></td><td class="CDLDefinition"><p>Callback function address</p></td></tr></table></div>
<a name="Menu_Initialize"></a><a name="Topic744"></a><div class="CTopic TFunction LC">
<div class="CTitle">Menu_Initialize</div>
<div id="NDPrototype744" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Menu_Initialize(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span>&nbsp;</td><td class="PType">Menu*&nbsp;</td><td class="PName last">menus</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Initialize a menu Must be called first (will reset or set default callback)</p></div>
</div>

<a name="Menu_SetInputCallback"></a><a name="Topic805"></a><div class="CTopic TFunction LC">
<div class="CTitle">Menu_SetInputCallback</div>
<div id="NDPrototype805" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Menu_SetInputCallback(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">Menu_InputCB&nbsp;</td><td class="PName last">cb</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Set the callback function to be called to handle menu input</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">cb<div class="CDLParameterType">Menu_InputCB</div></td><td class="CDLDefinition"><p>Callback function address</p></td></tr></table></div>
</div>

<a name="Menu_SetDrawCallback"></a><a name="Topic806"></a><div class="CTopic TFunction LC">
<div class="CTitle">Menu_SetDrawCallback</div>
<div id="NDPrototype806" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Menu_SetDrawCallback(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">Menu_DrawCB&nbsp;</td><td class="PName last">cb</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Set the callback function to be called to handle menu item drawing</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">cb<div class="CDLParameterType">Menu_DrawCB</div></td><td class="CDLDefinition"><p>Callback function address</p></td></tr></table></div>
</div>

<a name="Menu_DrawPage"></a><a name="Topic809"></a><div class="CTopic TFunction LC">
<div class="CTitle">Menu_DrawPage</div>
<div id="NDPrototype809" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Menu_DrawPage(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">page</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Draw a given page by its page number</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">cb</td><td class="CDLDefinition"><p>Callback function address</p></td></tr></table></div>
</div>

<a name="Menu_Update"></a><a name="Topic810"></a><div class="CTopic TFunction LC last">
<div class="CTitle">Menu_Update</div>
<div id="NDPrototype810" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> Menu_Update()</div></div>
<div class="CBody"><p>Update the menu handler</p></div>
</div>

</body></html>
2 changes: 1 addition & 1 deletion engine/doc/html/files/print_inl-h-Summary.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit a2cb9f0

Please sign in to comment.