User:Unsane/LuaParamsExample: Difference between revisions

Latest revision as of 20:44, 15 April 2018

Modifies menu item.

Parameters

hMenuItem

Type: light userdata

Menu item handle.

name

Type: string

New menu item name or nil.

icon

Type: light userdata

Icon handle or INVALID_HANDLE_VALUE

flags

Type: number

Additional flags or -1

Result: Type: light userdata; If success, returns menu item handle, otherwise nil.
Example

local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)

Modifies menu item.

Name	Type	Description
hMenuItem(required)	light userdata	Menu item handle
name	string	New menu item name or nil
icon	light userdata	Icon handle or INVALID_HANDLE_VALUE
flags	number	Additional flags or -1

Type: light userdata

If success, returns menu item handle, otherwise nil

local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)

@@ Line 19: / Line 19: @@
 ;Example
 {{Content:MirLua/Example|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}
 === ModifyMenuItemWithTable ===
 Modifies menu item.
-;Parameters
+====Parameters====
-: '''''hMenuItem'''''
+{| class="wikitable"
-:: Type: '''light userdata'''
+!Name
-:: Menu item handle.
+!Type
-: '''''name'''''
+!Description
-:: Type: '''string'''
+|-
-:: New menu item name or '''nil'''.
+|'''''hMenuItem'''''(required)
-: '''''icon'''''
+|'''light userdata'''
-:: Type: '''light userdata'''
+|Menu item handle
-:: [[Plugin:MirLua/en/m_icolib#AddIcon|Icon]] handle or ''[[Plugin:MirLua/en/m_core#INVALID_HANDLE_VALUE|INVALID_HANDLE_VALUE]]''
+|-
-: '''''flags'''''
+|name
-:: Type: '''number'''
+|'''string'''
-:: Additional flags or ''-1''
+|New menu item name or '''nil'''
-;Result
+|-
+|icon
+|'''light userdata'''
+|[[Plugin:MirLua/en/m_icolib#AddIcon|Icon]] handle or ''[[Plugin:MirLua/en/m_core#INVALID_HANDLE_VALUE|INVALID_HANDLE_VALUE]]''
+|-
+|flags
+|'''number'''
+|Additional flags or ''-1''
+|}
+====Result====
 : Type: '''light userdata'''
-: If success, returns menu item handle, otherwise '''nil'''.
+: If success, returns menu item handle, otherwise '''nil'''
-;Example
+====Example====
 {{Content:MirLua/Example|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}