FuzzyBot: Updating to match new version of source page

2022-02-09T23:03:46Z

Updating to match new version of source page

New page

<languages/>
Allows you to access menu subsystem.

{{Ls|MirLua/Modules/include_info}} <code>local genmenu = require('m_genmenu')</code>

__TOC__

== Functions ==

=== ModifyMenuItem ===
Modifies menu item.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | hMenuItem
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| Menu item handle.
|-
! scope="row" class="MirLuaParametersTable-parameter" | name
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| New menu item name or <code>nil</code>.
|-
! scope="row" class="MirLuaParametersTable-parameter" | icon
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| [[Special:MyLanguage/Plugin:MirLua/Module/m_icolib#AddIcon|Icon handle]] or <code>[[Special:MyLanguage/Plugin:MirLua/Module/m_core#INVALID_HANDLE_VALUE|INVALID_HANDLE_VALUE]]</code>.
|-
! scope="row" class="MirLuaParametersTable-parameter" | flags
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>number</code>
| Additional flags or <code>-1</code>.
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>

{{nbsp|5}}Returns <code>true</code> on success, otherwise <code>false</code>.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=local hMenuItem = genmenu.ModifyMenuItem(hMenuItem, 'New name', m.INVALID_HANDLE_VALUE)}}
----

=== ConfigureMenuItem ===
Дополнительная настройка пункта меню.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | hMenuItem
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| Menu item handle.
|-
! scope="row" class="MirLuaParametersTable-parameter" | option
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>number</code>
|
|-
! scope="row" class="MirLuaParametersTable-parameter" | value
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| Value of the option.
|}

: '''''hMenuItem'''''
:: Тип: '''light userdata'''
:: Дескриптор пункта меню.
: '''''option'''''
:: Тип: ''''''number''''''
:: изменяемая настройка (1 - название; 2 - горячие клавиши; 3 - параметр для исполнения; 4 - UUID).
: '''''value'''''
:: Тип: '''light userdata'''
:: значение.

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>light userdata</code>

{{nbsp|5}}Returns <code>true</code> on success, otherwise <code>false</code>.
----

=== ShowMenuItem ===
Shows/hides menu item.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | hMenuItem
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| Menu item handle.
|-
! scope="row" class="MirLuaParametersTable-parameter" | isShown
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>boolean</code>
| Pass <code>true</code> to show menu item, <code>false</code> to hide it.
|}

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=genmenu.ShowMenuItem(hMenuItem, true)}}
----

=== EnableMenuItem ===
Enables/disables menu item.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | hMenuItem
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| Menu item handle.
|-
! scope="row" class="MirLuaParametersTable-parameter" | isEnabled
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>boolean</code>
| Pass <code>true</code> to enable menu item, <code>false</code> to disable it.
|}

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=genmenu.EnableMenuItem(hMenuItem, false)}}
----

=== CheckMenuItem ===
Checks/unchecks menu item.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | hMenuItem
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| Menu item handle.
|-
! scope="row" class="MirLuaParametersTable-parameter" | isChecked
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>boolean</code>
| Pass <code>true</code> to check menu item, <code>false</code> to uncheck it.
|}

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=genmenu.CheckMenuItem(hMenuItem, true)}}
----

=== RemoveMenuItem ===
Removes menu item.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | hMenuItem
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>light userdata</code>
| Menu item handle.
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>

{{nbsp|5}}Returns <code>true</code> on success, otherwise <code>false</code>.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=genmenu.RemoveMenuItem(hMenuItem)}}

== Structures ==

=== MenuItem ===
A table describing menu parameters.

==== {{Ls|MirLua/Modules/fields}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/field_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | Name
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Menu item name (automatically translated by Core).
|-
! scope="row" class="MirLuaParametersTable-parameter" | Uid
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>string</code>
| Plugin UUID in format ''<code>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</code>''.
|-
! scope="row" class="MirLuaParametersTable-parameter" | Service
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>string</code>
| [[Special:MyLanguage/Plugin:MirLua/Module/m_core#CreateServiceFunction|Service name.]]
|-
! scope="row" class="MirLuaParametersTable-parameter" | Position
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>number</code>
| Menu item position.
|-
! scope="row" class="MirLuaParametersTable-parameter" | Parent
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>light userdata</code>
| Parent menu handle.
|-
! scope="row" class="MirLuaParametersTable-parameter" | Icon
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>light userdata</code>
| [[Special:MyLanguage/Plugin:MirLua/Module/m_icolib#AddIcon|Icon handle.]]
|-
! scope="row" class="MirLuaParametersTable-parameter" | Flags
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>number</code>
| Additional flags.
|}

Plugin:MirLua/Module/m genmenu/en - Revision history

FuzzyBot: Updating to match new version of source page