jurjen.ladeniusandClaude Opus 4.8
f3340e86c6
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
108 lines
9.4 KiB
HTML
108 lines
9.4 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>menu.h</title><link rel="stylesheet" type="text/css" href="../../styles/main.css" /><script type="text/javascript" src="../../styles/main.js"></script><script type="text/javascript">NDLoader.LoadJS("Content", "../../styles/");</script></head>
|
|
|
|
<!-- Generated by Natural Docs, version 2.2 -->
|
|
|
|
<!-- saved from url=(0016)http://localhost -->
|
|
|
|
<body onload="NDLoader.OnLoad('Content');" class="NDPage NDContentPage">
|
|
|
|
<a name="Types"></a><a name="Topic147"></a><div class="CTopic TGroup LC first">
|
|
<div class="CTitle">Types</div>
|
|
</div>
|
|
|
|
<a name="MENU_ITEM_TYPE"></a><a name="Topic148"></a><div class="CTopic TEnumeration LC">
|
|
<div class="CTitle">MENU_ITEM_TYPE</div>
|
|
<div class="CBody"><p>Menu item types</p></div>
|
|
</div>
|
|
|
|
<a name="MENU_ACTION"></a><a name="Topic149"></a><div class="CTopic TEnumeration LC">
|
|
<div class="CTitle">MENU_ACTION</div>
|
|
<div class="CBody"><p>Menu item actions</p></div>
|
|
</div>
|
|
|
|
<a name="MENU_INPUT_TYPE"></a><a name="Topic150"></a><div class="CTopic TEnumeration LC">
|
|
<div class="CTitle">MENU_INPUT_TYPE</div>
|
|
<div class="CBody"><p>Menu input value</p></div>
|
|
</div>
|
|
|
|
<a name="MENU_EVENT_CALLBACK"></a><a name="Topic151"></a><div class="CTopic TEnumeration LC">
|
|
<div class="CTitle">MENU_EVENT_CALLBACK</div>
|
|
<div class="CBody"><p>Menu event callback</p></div>
|
|
</div>
|
|
|
|
<a name="Macros"></a><a name="Topic152"></a><div class="CTopic TGroup LC">
|
|
<div class="CTitle">Macros</div>
|
|
</div>
|
|
|
|
<a name="MENU_FLAG_DIRTY"></a><a name="Topic153"></a><div class="CTopic TMacro LC">
|
|
<div class="CTitle">MENU_FLAG_DIRTY</div>
|
|
<div class="CBody"><p>Menu item actions</p></div>
|
|
</div>
|
|
|
|
<a name="Functions"></a><a name="Topic154"></a><div class="CTopic TGroup LC">
|
|
<div class="CTitle">Functions</div>
|
|
</div>
|
|
|
|
<a name="Menu_Initialize"></a><a name="Topic155"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Menu_Initialize</div>
|
|
<div id="NDPrototype155" 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> </td><td class="PType">Menu* </td><td class="PName last">menus</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Initialize all the menu pages Must be called first (will reset or set default callback)</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">menus<div class="CDLParameterType"><span class="SHKeyword">const</span> Menu*</div></td><td class="CDLDefinition"><p>Table of <Menu> structures that discribe all the menu pages</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Menu_SetInputCallback"></a><a name="Topic156"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Menu_SetInputCallback</div>
|
|
<div id="NDPrototype156" 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 </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="Topic157"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Menu_SetDrawCallback</div>
|
|
<div id="NDPrototype157" 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 </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_SetEventCallback"></a><a name="Topic158"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Menu_SetEventCallback</div>
|
|
<div id="NDPrototype158" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Menu_SetEventCallback(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">Menu_EventCB </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 when event occurs</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">cb<div class="CDLParameterType">Menu_EventCB</div></td><td class="CDLDefinition"><p>Callback function address</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Menu_SetDirty"></a><a name="Topic159"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Menu_SetDirty</div>
|
|
<div id="NDPrototype159" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Menu_SetDirty()</div></div>
|
|
<div class="CBody"><p>Set flag to force a whole menu redraw</p></div>
|
|
</div>
|
|
|
|
<a name="Menu_GetCurrentItem"></a><a name="Topic160"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Menu_GetCurrentItem</div>
|
|
<div id="NDPrototype160" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline const</span> MenuItem* Menu_GetCurrentItem()</div></div>
|
|
<div class="CBody"><p>Get the current item in the menu This value is only available for the following events: - MENU_EVENT_SET - MENU_EVENT_INC - MENU_EVENT_DEC - MENU_EVENT_DRAW_ENTRY - MENU_EVENT_DRAW_SELECTED</p><div class="CHeading">Return</div><p>Pointer to the current item in the menu</p></div>
|
|
</div>
|
|
|
|
<a name="Menu_Display"></a><a name="Topic161"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Menu_Display</div>
|
|
<div id="NDPrototype161" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Menu_Display(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </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">page<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Page index to draw (index is relative to the ist passed to <a href="../../index.html#File:game/menu.h:Menu_Initialize" target="_top" onmouseover="NDContentPage.OnLinkMouseOver(event,155);" onmouseout="NDContentPage.OnLinkMouseOut(event);" >Menu_Initialize</a> function)</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Menu_Update"></a><a name="Topic162"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Menu_Update</div>
|
|
<div id="NDPrototype162" 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>
|
|
|
|
<a name="Menu_SetScreenWidth"></a><a name="Topic163"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Menu_SetScreenWidth</div>
|
|
<div id="NDPrototype163" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Menu_SetScreenWidth(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">width</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set menu screen with</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">width<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Screen width in screen mode's unit (tiles or pixels)</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Menu_GetScreenWidth"></a><a name="Topic164"></a><div class="CTopic TFunction LC last">
|
|
<div class="CTitle">Menu_GetScreenWidth</div>
|
|
<div id="NDPrototype164" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> u8 Menu_GetScreenWidth()</div></div>
|
|
<div class="CBody"><p>Get menu screen with</p><p>Return: Screen width in screen mode's unit (tiles or pixels)</p></div>
|
|
</div>
|
|
|
|
</body></html> |