Miranda NG - User contributions [en]

User:Unsane/LuaParamsExample

2018-04-15T17:44:24Z

Unsane:

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

=== ModifyMenuItemWithTable ===
Modifies menu item.
====Parameters====
{| class="wikitable"
!Name
!Type
!Description
|-
|'''''hMenuItem'''''(required)
|'''light userdata'''
|Menu item handle
|-
|name
|'''string'''
|New menu item name or '''nil'''
|-
|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'''
====Example====
{{Content:MirLua/Example|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}

User:Unsane/LuaParamsExample

2018-04-15T17:42:48Z

Unsane: /* Parameters */

User:Unsane/LuaParamsExample

2018-04-15T17:36:11Z

Unsane:

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

=== ModifyMenuItemWithTable ===
Modifies menu item.
====Parameters====
{| class="wikitable"
!Name
!Type
!Description
|-
|'''''hMenuItem'''''
|'''light userdata'''
|Menu item handle
|-
|'''''name'''''
|'''string'''
|New menu item name or '''nil'''
|-
|'''''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'''
====Example====
{{Content:MirLua/Example|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}

User:Unsane/LuaParamsExample

2018-04-15T17:12:07Z

Unsane: Created page with "=== ModifyMenuItem === Modifies menu item. ;Parameters : '''''hMenuItem''''' :: Type: '''light userdata''' :: Menu item handle. : '''''name''''' :: Type: '''string''' :: New m..."

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

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

Plugin:MirLua/Module/m sounds/ru

2018-04-13T22:22:33Z

Unsane: Created page with "Тип: $type_string_required"

<languages/>
Allows you to work with sounds.

Include module: <code>local sounds = require('m_sounds')</code>

{{Note|Parameters written in '''''bold italics''''' are obligatory.}}

__TOC__

=== AddSound ===
Registers a sound.
;Parameters
: '''''name'''''
:: Тип: '''string'''
:: Unique name.
: '''''description'''''
:: Type: '''string'''
:: Description.
: ''section''
:: Type: '''string'''
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.
: ''path''
:: Type: '''string'''
:: Path to sound file.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was registered successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}

=== PlaySound ===
Plays sound by its unique name.

;Parameters
: '''''name'''''
:: Type: '''string'''
:: Unique name.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}

=== PlayFile ===
Plays sound from file.

;Parameters
: '''''path'''''
:: Type: '''string'''
:: Path to file.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}

[[Category:Tutorials (en)]]

Plugin:MirLua/Module/m sounds

2018-04-13T22:20:53Z

Unsane:

<languages/>
<translate>

Allows you to work with sounds.
</translate>

<translate> Include module:</translate> <code>local sounds = require('m_sounds')</code>

{{Note|Parameters written in '''''bold italics''''' are obligatory.}}

__TOC__

=== AddSound ===
<translate>

Registers a sound.
</translate>
;Parameters
: '''''name'''''
::
<translate>

Type: <tvar|type_string_required>'''string'''</>
</translate>
:: <translate> Unique name.</translate>
: '''''description'''''
:: Type: '''string'''
:: Description.
: ''section''
:: Type: '''string'''
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.
: ''path''
:: Type: '''string'''
:: Path to sound file.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was registered successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}

=== PlaySound ===
Plays sound by its unique name.

;Parameters
: '''''name'''''
::
<translate>

Type: <tvar|type_string_required>'''string'''</>
</translate>
:: Unique name.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}

=== PlayFile ===
Plays sound from file.

;Parameters
: '''''path'''''
:: Type: '''string'''
:: Path to file.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}

[[Category:Tutorials (en)]]

Plugin:MirLua/Module/m sounds

2018-04-13T22:19:34Z

Unsane:

<languages/>
<translate>

Allows you to work with sounds.
</translate>

<translate> Include module:</translate> <code>local sounds = require('m_sounds')</code>

{{Note|Parameters written in '''''bold italics''''' are obligatory.}}

__TOC__

=== AddSound ===
<translate>
Registers a sound.
</translate>
;Parameters
: '''''name'''''
:: <translate>
Type: <tvar|type_string_required>'''string'''</>
</translate>
:: <translate>Unique name.</translate>
: '''''description'''''
:: Type: '''string'''
:: Description.
: ''section''
:: Type: '''string'''
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.
: ''path''
:: Type: '''string'''
:: Path to sound file.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was registered successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}

=== PlaySound ===
Plays sound by its unique name.

;Parameters
: '''''name'''''
:: <translate>
Type: <tvar|type_string_required>'''string'''</>
</translate>
:: Unique name.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}

=== PlayFile ===
Plays sound from file.

;Parameters
: '''''path'''''
:: Type: '''string'''
:: Path to file.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}

[[Category:Tutorials (en)]]

Plugin:MirLua/Module/m sounds

2018-04-13T22:19:10Z

Unsane:

<languages/>
<translate>

Allows you to work with sounds.
</translate>

<translate> Include module:</translate> <code>local sounds = require('m_sounds')</code>

{{Note|Parameters written in '''''bold italics''''' are obligatory.}}

__TOC__

=== AddSound ===
<translate>
Registers a sound.
</translate>
;Parameters
: '''''name'''''
:: <translate>
Type: <tvar|type_string_required>'''string'''</tvar>
</translate>
:: <translate>Unique name.</translate>
: '''''description'''''
:: Type: '''string'''
:: Description.
: ''section''
:: Type: '''string'''
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.
: ''path''
:: Type: '''string'''
:: Path to sound file.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was registered successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}

=== PlaySound ===
Plays sound by its unique name.

;Parameters
: '''''name'''''
:: <translate>
Type: <tvar|type_string_required>'''string'''</tvar>
</translate>
:: Unique name.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}

=== PlayFile ===
Plays sound from file.

;Parameters
: '''''path'''''
:: Type: '''string'''
:: Path to file.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}

[[Category:Tutorials (en)]]

Plugin:MirLua/Module/m sounds

2018-04-13T22:16:07Z

Unsane:

<languages/>
<translate>

Allows you to work with sounds.
</translate>

<translate> Include module:</translate> <code>local sounds = require('m_sounds')</code>

{{Note|Parameters written in '''''bold italics''''' are obligatory.}}

__TOC__

=== AddSound ===
<translate>
Registers a sound.
</translate>
;Parameters
: '''''name'''''
:: <translate>Type:</translate> '''string'''
:: <translate>Unique name.</translate>
: '''''description'''''
:: Type: '''string'''
:: Description.
: ''section''
:: Type: '''string'''
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.
: ''path''
:: Type: '''string'''
:: Path to sound file.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was registered successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}

=== PlaySound ===
Plays sound by its unique name.

;Parameters
: '''''name'''''
:: <translate>Type:</translate> '''string'''
:: Unique name.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}

=== PlayFile ===
Plays sound from file.

;Parameters
: '''''path'''''
:: Type: '''string'''
:: Path to file.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}

[[Category:Tutorials (en)]]

Plugin:MirLua/Module/m sounds

2018-04-13T22:02:31Z

Unsane:

<languages/>
<translate>
Allows you to work with sounds.
</translate>

<translate>Include module:</translate> <code>local sounds = require('m_sounds')</code>

{{Note|Parameters written in '''''bold italics''''' are obligatory.}}

__TOC__

=== AddSound ===
Registers a sound.

;Parameters
: '''''name'''''
:: Type: '''string'''
:: Unique name.
: '''''description'''''
:: Type: '''string'''
:: Description.
: ''section''
:: Type: '''string'''
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.
: ''path''
:: Type: '''string'''
:: Path to sound file.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was registered successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}

=== PlaySound ===
Plays sound by its unique name.

;Parameters
: '''''name'''''
:: Type: '''string'''
:: Unique name.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}

=== PlayFile ===
Plays sound from file.

;Parameters
: '''''path'''''
:: Type: '''string'''
:: Path to file.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}

[[Category:Tutorials (en)]]

Plugin:MirLua/Module/m sounds

2018-04-13T22:01:08Z

Unsane:

<languages/>{{PageLang|en}}
<translate>
Allows you to work with sounds.
</translate>

Include module: <code>local sounds = require('m_sounds')</code>

{{Note|Parameters written in '''''bold italics''''' are obligatory.}}

__TOC__

=== AddSound ===
Registers a sound.

;Parameters
: '''''name'''''
:: Type: '''string'''
:: Unique name.
: '''''description'''''
:: Type: '''string'''
:: Description.
: ''section''
:: Type: '''string'''
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.
: ''path''
:: Type: '''string'''
:: Path to sound file.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was registered successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}

=== PlaySound ===
Plays sound by its unique name.

;Parameters
: '''''name'''''
:: Type: '''string'''
:: Unique name.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}

=== PlayFile ===
Plays sound from file.

;Parameters
: '''''path'''''
:: Type: '''string'''
:: Path to file.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}

[[Category:Tutorials (en)]]

Plugin:MirLua/en/m sounds

2018-04-13T21:58:53Z

Unsane: Unsane moved page Plugin:MirLua/en/m sounds to Plugin:MirLua/m sounds: for translate

#REDIRECT [[Plugin:MirLua/m sounds]]

Plugin:MirLua/Module/m sounds

2018-04-13T21:58:53Z

Unsane: Unsane moved page Plugin:MirLua/en/m sounds to Plugin:MirLua/m sounds: for translate

{{PageLang|en}}
Allows you to work with sounds.

Include module: <code>local sounds = require('m_sounds')</code>

{{Note|Parameters written in '''''bold italics''''' are obligatory.}}

__TOC__

=== AddSound ===
Registers a sound.

;Parameters
: '''''name'''''
:: Type: '''string'''
:: Unique name.
: '''''description'''''
:: Type: '''string'''
:: Description.
: ''section''
:: Type: '''string'''
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.
: ''path''
:: Type: '''string'''
:: Path to sound file.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was registered successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}

=== PlaySound ===
Plays sound by its unique name.

;Parameters
: '''''name'''''
:: Type: '''string'''
:: Unique name.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}

=== PlayFile ===
Plays sound from file.

;Parameters
: '''''path'''''
:: Type: '''string'''
:: Path to file.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}

[[Category:Tutorials (en)]]

Plugin:MirLua/Module/m core

2018-04-13T21:53:43Z

Unsane: /* CreateHookableEvent */

{{PageLang|en}}
This module is imported into global table and available in any module through variable '''m'''. It allows you to access basic features of Miranda NG core.

{{Note|Parameters written in '''''bold italics''''' are obligatory.}}

__TOC__

== Constants ==
=== NULL ===
Null pointer.
: Type: '''light userdata'''

=== INVALID_HANDLE_VALUE ===
Invalid handle.
: Type: '''light userdata'''

=== CALLSERVICE_NOTFOUND ===
Result of service call when service does not exist.
: Type: '''number'''

== Named events ==
=== CreateHookableEvent ===
Creates a hookable event.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Event name.
;Result
: Type: '''light userdata'''
: Returns event handle if event was created successfully, otherwise '''nil'''.
;Example
<pre style="overflow:auto;">
local hEvent = m.CreateHookableEvent('MyEvent')
if hEvent == m.NULL then
print('Event handle is empty!')
end
</pre>

=== HookEvent ===
Sets a callback function ("hook") to react to event call. Hooks are called one by one in the order they were added to the sequence.

Hook signature: <code>function (wParam, lParam) return 0 end</code>.

Correct result for a hook is 0. When 1 is returned, the following hooks in a sequence won't be called.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Event name.
: '''''hook'''''
:: Type: '''function'''
:: Hook function to be called when event occurs.
;Result
: Type: '''light userdata'''
: Returns hook handle if hook was created successfully, otherwise '''nil'''.
;Example
{{Content:MirLua/Example|code=local hHook = m.HookEvent('MyEvent', function(w, l)
print('MyEvent is raised!')
end)
}}

=== UnhookEvent ===
Removes hook from event call sequence.
;Parameters
: '''''hEvent'''''
:: Type: '''light userdata'''
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.
;Result
: Type: '''boolean'''
: Returns '''true''' if hook function was removed successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=m.UnhookEvent(hHook)}}

=== NotifyEventHooks ===
Calls all hooks of event call sequence one by one.
;Parameters
: '''''hEvent'''''
:: Type: '''light userdata'''
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.
: ''wParam''
: ''lParam''
;Result
: Type: '''boolean'''
: Returns '''true''' if all hooks were called, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=m.NotifyEventHooks(hEvent)}}

== Named service functions ==
=== CreateServiceFunction ===
Creates a service function ("service")
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Service name.
;Result
: Type: '''light userdata'''
: Returns service handle if service was created successfully, otherwise '''nil'''.
;Example
{{Content:MirLua/Example|code=local hService = m.CreateServiceFunction('MyService', function(w, l)
print('MyServiceis called!')
end)
}}

=== CallService ===
Calls service with parameters.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Service name.
: ''wParam''
: ''lParam''
;Result
: Type: '''number'''
: Returns result of service execution or [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]
;Example
{{Content:MirLua/Example|code=
local result = m.CallService('MyService')
if result == m.CALLSERVICE_NOTFOUND then
print('Service is not found!')
end
}}

=== ServiceExists ===
Checks if service exists by its name.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Service name.
;Result
: Type: '''boolean'''
: Returns '''true''' if service exists, otherwise '''false'''
;Example
{{Content:MirLua/Example|code=if m.ServiceExists('MyService') then
m.CallService('MyService')
end}}

=== DestroyServiceFunction ===
Destroys a service function.
;Parameters
: '''''hService'''''
:: Type: '''light userdata'''
:: Service handle received on [[#CreateServiceFunction|CreateServiceFunction]] call.
;Example
{{Content:MirLua/Example|code=m.DestroyServiceFunction(hService)}}

== Others ==
=== IsPluginLoaded ===
Checks if plugin is loaded by its UUID.
;Parameters
: '''''uuid'''''
:: Type: '''string'''
:: Plugin UUID in format ''xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx''.
;Result
: Type: '''boolean'''
: Returns '''true''' if plugin is loaded, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=if m.IsPluginLoaded('{F0FDF73A-753D-499d-8DBA-336DB79CDD41}') then
print('Advanced auto away plugin is loaded!')
end
}}

=== Translate ===
Translates a string into the language of the current langpack.
: '''''text'''''
:: Type: '''string'''
;Result
: Type: '''string'''
;Example
{{Content:MirLua/Example|code=m.Translate('Exit')}}

=== Parse ===
Replaces Miranda NG variables in a string.
: '''''text'''''
;Result
: Type: '''string'''
;Example
{{Content:MirLua/Example|code=local profileName = m.ReplaceVariables('%miranda_profilename%')}}

[[Category:Tutorials (en)]]

Plugin:MirLua/Module/m core

2018-04-13T21:50:16Z

Unsane: /* ReplaceVariables */

{{PageLang|en}}
This module is imported into global table and available in any module through variable '''m'''. It allows you to access basic features of Miranda NG core.

{{Note|Parameters written in '''''bold italics''''' are obligatory.}}

__TOC__

== Constants ==
=== NULL ===
Null pointer.
: Type: '''light userdata'''

=== INVALID_HANDLE_VALUE ===
Invalid handle.
: Type: '''light userdata'''

=== CALLSERVICE_NOTFOUND ===
Result of service call when service does not exist.
: Type: '''number'''

== Named events ==
=== CreateHookableEvent ===
Creates a hookable event.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Event name.
;Result
: Type: '''light userdata'''
: Returns event handle if event was created successfully, otherwise '''nil'''.
;Example
{{Content:MirLua/Example|code=
local hEvent = m.CreateHookableEvent('MyEvent')
if hEvent == m.NULL then
print('Event handle is empty!')
end
}}

=== HookEvent ===
Sets a callback function ("hook") to react to event call. Hooks are called one by one in the order they were added to the sequence.

Hook signature: <code>function (wParam, lParam) return 0 end</code>.

Correct result for a hook is 0. When 1 is returned, the following hooks in a sequence won't be called.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Event name.
: '''''hook'''''
:: Type: '''function'''
:: Hook function to be called when event occurs.
;Result
: Type: '''light userdata'''
: Returns hook handle if hook was created successfully, otherwise '''nil'''.
;Example
{{Content:MirLua/Example|code=local hHook = m.HookEvent('MyEvent', function(w, l)
print('MyEvent is raised!')
end)
}}

=== UnhookEvent ===
Removes hook from event call sequence.
;Parameters
: '''''hEvent'''''
:: Type: '''light userdata'''
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.
;Result
: Type: '''boolean'''
: Returns '''true''' if hook function was removed successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=m.UnhookEvent(hHook)}}

=== NotifyEventHooks ===
Calls all hooks of event call sequence one by one.
;Parameters
: '''''hEvent'''''
:: Type: '''light userdata'''
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.
: ''wParam''
: ''lParam''
;Result
: Type: '''boolean'''
: Returns '''true''' if all hooks were called, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=m.NotifyEventHooks(hEvent)}}

== Named service functions ==
=== CreateServiceFunction ===
Creates a service function ("service")
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Service name.
;Result
: Type: '''light userdata'''
: Returns service handle if service was created successfully, otherwise '''nil'''.
;Example
{{Content:MirLua/Example|code=local hService = m.CreateServiceFunction('MyService', function(w, l)
print('MyServiceis called!')
end)
}}

=== CallService ===
Calls service with parameters.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Service name.
: ''wParam''
: ''lParam''
;Result
: Type: '''number'''
: Returns result of service execution or [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]
;Example
{{Content:MirLua/Example|code=
local result = m.CallService('MyService')
if result == m.CALLSERVICE_NOTFOUND then
print('Service is not found!')
end
}}

=== ServiceExists ===
Checks if service exists by its name.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Service name.
;Result
: Type: '''boolean'''
: Returns '''true''' if service exists, otherwise '''false'''
;Example
{{Content:MirLua/Example|code=if m.ServiceExists('MyService') then
m.CallService('MyService')
end}}

=== DestroyServiceFunction ===
Destroys a service function.
;Parameters
: '''''hService'''''
:: Type: '''light userdata'''
:: Service handle received on [[#CreateServiceFunction|CreateServiceFunction]] call.
;Example
{{Content:MirLua/Example|code=m.DestroyServiceFunction(hService)}}

== Others ==
=== IsPluginLoaded ===
Checks if plugin is loaded by its UUID.
;Parameters
: '''''uuid'''''
:: Type: '''string'''
:: Plugin UUID in format ''xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx''.
;Result
: Type: '''boolean'''
: Returns '''true''' if plugin is loaded, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=if m.IsPluginLoaded('{F0FDF73A-753D-499d-8DBA-336DB79CDD41}') then
print('Advanced auto away plugin is loaded!')
end
}}

=== Translate ===
Translates a string into the language of the current langpack.
: '''''text'''''
:: Type: '''string'''
;Result
: Type: '''string'''
;Example
{{Content:MirLua/Example|code=m.Translate('Exit')}}

=== Parse ===
Replaces Miranda NG variables in a string.
: '''''text'''''
;Result
: Type: '''string'''
;Example
{{Content:MirLua/Example|code=local profileName = m.ReplaceVariables('%miranda_profilename%')}}

[[Category:Tutorials (en)]]

Plugin:MirLua/Module/m core

2018-04-13T21:49:24Z

Unsane:

{{PageLang|en}}
This module is imported into global table and available in any module through variable '''m'''. It allows you to access basic features of Miranda NG core.

{{Note|Parameters written in '''''bold italics''''' are obligatory.}}

__TOC__

== Constants ==
=== NULL ===
Null pointer.
: Type: '''light userdata'''

=== INVALID_HANDLE_VALUE ===
Invalid handle.
: Type: '''light userdata'''

=== CALLSERVICE_NOTFOUND ===
Result of service call when service does not exist.
: Type: '''number'''

== Named events ==
=== CreateHookableEvent ===
Creates a hookable event.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Event name.
;Result
: Type: '''light userdata'''
: Returns event handle if event was created successfully, otherwise '''nil'''.
;Example
{{Content:MirLua/Example|code=
local hEvent = m.CreateHookableEvent('MyEvent')
if hEvent == m.NULL then
print('Event handle is empty!')
end
}}

=== HookEvent ===
Sets a callback function ("hook") to react to event call. Hooks are called one by one in the order they were added to the sequence.

Hook signature: <code>function (wParam, lParam) return 0 end</code>.

Correct result for a hook is 0. When 1 is returned, the following hooks in a sequence won't be called.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Event name.
: '''''hook'''''
:: Type: '''function'''
:: Hook function to be called when event occurs.
;Result
: Type: '''light userdata'''
: Returns hook handle if hook was created successfully, otherwise '''nil'''.
;Example
{{Content:MirLua/Example|code=local hHook = m.HookEvent('MyEvent', function(w, l)
print('MyEvent is raised!')
end)
}}

=== UnhookEvent ===
Removes hook from event call sequence.
;Parameters
: '''''hEvent'''''
:: Type: '''light userdata'''
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.
;Result
: Type: '''boolean'''
: Returns '''true''' if hook function was removed successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=m.UnhookEvent(hHook)}}

=== NotifyEventHooks ===
Calls all hooks of event call sequence one by one.
;Parameters
: '''''hEvent'''''
:: Type: '''light userdata'''
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.
: ''wParam''
: ''lParam''
;Result
: Type: '''boolean'''
: Returns '''true''' if all hooks were called, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=m.NotifyEventHooks(hEvent)}}

== Named service functions ==
=== CreateServiceFunction ===
Creates a service function ("service")
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Service name.
;Result
: Type: '''light userdata'''
: Returns service handle if service was created successfully, otherwise '''nil'''.
;Example
{{Content:MirLua/Example|code=local hService = m.CreateServiceFunction('MyService', function(w, l)
print('MyServiceis called!')
end)
}}

=== CallService ===
Calls service with parameters.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Service name.
: ''wParam''
: ''lParam''
;Result
: Type: '''number'''
: Returns result of service execution or [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]
;Example
{{Content:MirLua/Example|code=
local result = m.CallService('MyService')
if result == m.CALLSERVICE_NOTFOUND then
print('Service is not found!')
end
}}

=== ServiceExists ===
Checks if service exists by its name.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Service name.
;Result
: Type: '''boolean'''
: Returns '''true''' if service exists, otherwise '''false'''
;Example
{{Content:MirLua/Example|code=if m.ServiceExists('MyService') then
m.CallService('MyService')
end}}

=== DestroyServiceFunction ===
Destroys a service function.
;Parameters
: '''''hService'''''
:: Type: '''light userdata'''
:: Service handle received on [[#CreateServiceFunction|CreateServiceFunction]] call.
;Example
{{Content:MirLua/Example|code=m.DestroyServiceFunction(hService)}}

== Others ==
=== IsPluginLoaded ===
Checks if plugin is loaded by its UUID.
;Parameters
: '''''uuid'''''
:: Type: '''string'''
:: Plugin UUID in format ''xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx''.
;Result
: Type: '''boolean'''
: Returns '''true''' if plugin is loaded, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=if m.IsPluginLoaded('{F0FDF73A-753D-499d-8DBA-336DB79CDD41}') then
print('Advanced auto away plugin is loaded!')
end
}}

=== Translate ===
Translates a string into the language of the current langpack.
: '''''text'''''
:: Type: '''string'''
;Result
: Type: '''string'''
;Example
{{Content:MirLua/Example|code=m.Translate('Exit')}}

=== ReplaceVariables ===
Replaces Miranda NG variables in a string.
: '''''text'''''
;Result
: Type: '''string'''
;Example
{{Content:MirLua/Example|code=local profileName = m.ReplaceVariables('%miranda_profilename%')}}

[[Category:Tutorials (en)]]

Plugin:MirLua/ru

2018-04-13T21:45:51Z

Unsane: Created page with "Обеспечивает более читаемый и удобный синтаксис для форматирования вывода строки."

<languages/>{{PluginCard}}
Расширяет функциональность Miranda NG с помощью скриптов на языке Lua.

== Lua ==
Плагин использует Lua 5.3.4, поставляемый в виде библиотеки lua53.dll.

== Дополнительные возможности ==

=== toansi ===
Перекодирует строку из utf-8 в ansi. Полезен, когда требуется передать строку в качестве параметра ansi-функции.

<code>m.CallService('mRadio/Import', 0, toansi(m.Parse('%miranda_path%\\Plugins\\mradio.ini')))</code>

Имеет краткую версию '''a'''.

<code>m.CallService('DB/Ini/ImportFile', 0, a'import\\autoexec.ini')</code>

=== toucs2 ===
Аналогичен '''toansi''', но предназначен для utf-16. Тоже имеет краткую версию - '''u'''.

=== tonumber ===
If it receives '''light userdata''' parameter then returns it address as number, otherwise uses standard lua '''tonumber''' behavior.

=== topointer ===
Преобразует lua-типы '''bool''', '''number''', '''string''' в '''light userdata'''.

=== string.interpolate ===
Обеспечивает более читаемый и удобный синтаксис для форматирования вывода строки.

<code>
local h = 'Hello'
print('{h}, {w}!' % {w = 'World'})
</code>

== Модули ==

* EN
** [[Plugin:MirLua/en/m_core|m_core]]
** [[Plugin:MirLua/en/m_database|m_database]]
** [[Plugin:MirLua/en/m_genmenu|m_genmenu]]
** [[Plugin:MirLua/en/m_hotkeys|m_hotkeys]]
** [[Plugin:MirLua/en/m_icolib|m_icolib]]
** [[Plugin:MirLua/en/m_sounds|m_sounds]]

* RU
** [[Plugin:MirLua/ru/m_clist|m_clist]]
** [[Plugin:MirLua/ru/m_core|m_core]]
** [[Plugin:MirLua/ru/m_database|m_database]]
** [[Plugin:MirLua/ru/m_genmenu|m_genmenu]]
** [[Plugin:MirLua/ru/m_hotkeys|m_hotkeys]]
** [[Plugin:MirLua/ru/m_icolib|m_icolib]]
** [[Plugin:MirLua/ru/m_sounds|m_sounds]]

== Примеры ==

{{Content:MirLua/Examples}}

== Ссылки ==

* [https://forum.miranda-ng.org/index.php?topic=4161.0 Примеры скриптов в теме на форуме]{{RefLang|ru}}
* [https://www.lua.org Веб-сайт Lua]
* [[wikipedia:en:Lua_(programming_language)|Lua в Википедии]]

{{PluginGroups}}

Translations:Plugin:MirLua/15/ru

2018-04-13T21:45:51Z

Unsane: Created page with "Обеспечивает более читаемый и удобный синтаксис для форматирования вывода строки."

Обеспечивает более читаемый и удобный синтаксис для форматирования вывода строки.

Plugin:MirLua/Module/m core

2018-04-05T18:43:01Z

Unsane:

{{PageLang|en}}
This module is imported into global table and available in any module through variable '''m'''. It allows you to access basic features of Miranda NG core.

{{Note|Parameters written in '''''bold italics''''' are obligatory.}}

__TOC__

== Constants ==
=== NULL ===
Null pointer.
: Type: '''light userdata'''

=== INVALID_HANDLE_VALUE ===
Invalid handle.
: Type: '''light userdata'''

=== CALLSERVICE_NOTFOUND ===
Result of service call when service does not exist.
: Type: '''number'''

== Named events ==
=== CreateHookableEvent ===
Creates a hookable event.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Event name.
;Result
: Type: '''light userdata'''
: Returns event handle if event was created successfully, otherwise '''nil'''.
;Example
{{Content:MirLua/Example|code=
local hEvent = m.CreateHookableEvent('MyEvent')
if hEvent == m.NULL then
print('Event handle is empty!')
end
}}

=== HookEvent ===
Sets a callback function ("hook") to react to event call. Hooks are called one by one in the order they were added to the sequence.

Hook signature: <code>function (wParam, lParam) return 0 end</code>.

Correct result for a hook is 0. When 1 is returned, the following hooks in a sequence won't be called.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Event name.
: '''''hook'''''
:: Type: '''function'''
:: Hook function to be called when event occurs.
;Result
: Type: '''light userdata'''
: Returns hook handle if hook was created successfully, otherwise '''nil'''.
;Example
{{Content:MirLua/Example|code=local hHook = m.HookEvent('MyEvent', function(w, l)
print('MyEvent is raised!')
end)
}}

=== UnhookEvent ===
Removes hook from event call sequence.
;Parameters
: '''''hEvent'''''
:: Type: '''light userdata'''
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.
;Result
: Type: '''boolean'''
: Returns '''true''' if hook function was removed successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=m.UnhookEvent(hHook)}}

=== NotifyEventHooks ===
Calls all hooks of event call sequence one by one.
;Parameters
: '''''hEvent'''''
:: Type: '''light userdata'''
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.
: ''wParam''
: ''lParam''
;Result
: Type: '''boolean'''
: Returns '''true''' if all hooks were called, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=m.NotifyEventHooks(hEvent)}}

== Named service functions ==
=== CreateServiceFunction ===
Creates a service function ("service")
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Service name.
;Result
: Type: '''light userdata'''
: Returns service handle if service was created successfully, otherwise '''nil'''.
;Example
{{Content:MirLua/Example|code=local hService = m.CreateServiceFunction('MyService', function(w, l)
print('MyServiceis called!')
end)
}}

=== CallService ===
Calls service with parameters.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Service name.
: ''wParam''
: ''lParam''
;Result
: Type: '''number'''
: Returns result of service execution or [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]
;Example
{{Content:MirLua/Example|code=
local result = m.CallService('MyService')
if result == m.CALLSERVICE_NOTFOUND then
print('Service is not found!')
end
}}

=== ServiceExists ===
Checks if service exists by its name.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Service name.
;Result
: Type: '''boolean'''
: Returns '''true''' if service exists, otherwise '''false'''
;Example
{{Content:MirLua/Example|code=if m.ServiceExists('MyService') then
m.CallService('MyService')
end}}

=== DestroyServiceFunction ===
Destroys a service function.
;Parameters
: '''''hService'''''
:: Type: '''light userdata'''
:: Service handle received on [[#CreateServiceFunction|CreateServiceFunction]] call.
;Example
{{Content:MirLua/Example|code=m.DestroyServiceFunction(hService)}}

== Others ==
=== IsPluginLoaded ===
Checks if plugin is loaded by its UUID.
;Parameters
: '''''uuid'''''
:: Type: '''string'''
:: Plugin UUID in format ''xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx''.
;Result
: Type: '''boolean'''
: Returns '''true''' if plugin is loaded, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=if m.IsPluginLoaded('{F0FDF73A-753D-499d-8DBA-336DB79CDD41}') then
print('Advanced auto away plugin is loaded!')
end
}}

=== Utf8DecodeA ===
Converts Lua string contents to ANSI (codepage of the current langpack is used).
: '''''text'''''
:: Type: '''string'''
;Result
: Type: '''string'''
;Example
{{Content:MirLua/Example|code=m.CallService("Quotes/Import", 0, Utf8DecodeA('c:\\quotes.xml'))}}

=== Utf8DecodeW ===
Converts Lua string contents to Unicode (UTF-16).
: '''''text'''''
:: Type: '''string'''
;Result
: Type: '''string'''
;Example
{{Content:MirLua/Example|code=m.CallService("Popup/ShowMessageW", m.Utf8DecodeW('Hello, World!'), 2)}}

=== Translate ===
Translates a string into the language of the current langpack.
: '''''text'''''
:: Type: '''string'''
;Result
: Type: '''string'''
;Example
{{Content:MirLua/Example|code=m.Translate('Exit')}}

=== ReplaceVariables ===
Replaces Miranda NG variables in a string.
: '''''text'''''
;Result
: Type: '''string'''
;Example
{{Content:MirLua/Example|code=local profileName = m.ReplaceVariables('%miranda_profilename%')}}

[[Category:Tutorials (en)]]

Plugin:MirLua/Module/m core

2018-04-05T18:42:47Z

Unsane:

<languages/>{{PageLang|en}}
This module is imported into global table and available in any module through variable '''m'''. It allows you to access basic features of Miranda NG core.

{{Note|Parameters written in '''''bold italics''''' are obligatory.}}

__TOC__

== Constants ==
=== NULL ===
Null pointer.
: Type: '''light userdata'''

=== INVALID_HANDLE_VALUE ===
Invalid handle.
: Type: '''light userdata'''

=== CALLSERVICE_NOTFOUND ===
Result of service call when service does not exist.
: Type: '''number'''

== Named events ==
=== CreateHookableEvent ===
Creates a hookable event.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Event name.
;Result
: Type: '''light userdata'''
: Returns event handle if event was created successfully, otherwise '''nil'''.
;Example
{{Content:MirLua/Example|code=
local hEvent = m.CreateHookableEvent('MyEvent')
if hEvent == m.NULL then
print('Event handle is empty!')
end
}}

=== HookEvent ===
Sets a callback function ("hook") to react to event call. Hooks are called one by one in the order they were added to the sequence.

Hook signature: <code>function (wParam, lParam) return 0 end</code>.

Correct result for a hook is 0. When 1 is returned, the following hooks in a sequence won't be called.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Event name.
: '''''hook'''''
:: Type: '''function'''
:: Hook function to be called when event occurs.
;Result
: Type: '''light userdata'''
: Returns hook handle if hook was created successfully, otherwise '''nil'''.
;Example
{{Content:MirLua/Example|code=local hHook = m.HookEvent('MyEvent', function(w, l)
print('MyEvent is raised!')
end)
}}

=== UnhookEvent ===
Removes hook from event call sequence.
;Parameters
: '''''hEvent'''''
:: Type: '''light userdata'''
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.
;Result
: Type: '''boolean'''
: Returns '''true''' if hook function was removed successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=m.UnhookEvent(hHook)}}

=== NotifyEventHooks ===
Calls all hooks of event call sequence one by one.
;Parameters
: '''''hEvent'''''
:: Type: '''light userdata'''
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.
: ''wParam''
: ''lParam''
;Result
: Type: '''boolean'''
: Returns '''true''' if all hooks were called, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=m.NotifyEventHooks(hEvent)}}

== Named service functions ==
=== CreateServiceFunction ===
Creates a service function ("service")
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Service name.
;Result
: Type: '''light userdata'''
: Returns service handle if service was created successfully, otherwise '''nil'''.
;Example
{{Content:MirLua/Example|code=local hService = m.CreateServiceFunction('MyService', function(w, l)
print('MyServiceis called!')
end)
}}

=== CallService ===
Calls service with parameters.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Service name.
: ''wParam''
: ''lParam''
;Result
: Type: '''number'''
: Returns result of service execution or [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]
;Example
{{Content:MirLua/Example|code=
local result = m.CallService('MyService')
if result == m.CALLSERVICE_NOTFOUND then
print('Service is not found!')
end
}}

=== ServiceExists ===
Checks if service exists by its name.
;Parameters
: '''''name'''''
:: Type: '''string'''
:: Service name.
;Result
: Type: '''boolean'''
: Returns '''true''' if service exists, otherwise '''false'''
;Example
{{Content:MirLua/Example|code=if m.ServiceExists('MyService') then
m.CallService('MyService')
end}}

=== DestroyServiceFunction ===
Destroys a service function.
;Parameters
: '''''hService'''''
:: Type: '''light userdata'''
:: Service handle received on [[#CreateServiceFunction|CreateServiceFunction]] call.
;Example
{{Content:MirLua/Example|code=m.DestroyServiceFunction(hService)}}

== Others ==
=== IsPluginLoaded ===
Checks if plugin is loaded by its UUID.
;Parameters
: '''''uuid'''''
:: Type: '''string'''
:: Plugin UUID in format ''xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx''.
;Result
: Type: '''boolean'''
: Returns '''true''' if plugin is loaded, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=if m.IsPluginLoaded('{F0FDF73A-753D-499d-8DBA-336DB79CDD41}') then
print('Advanced auto away plugin is loaded!')
end
}}

=== Utf8DecodeA ===
Converts Lua string contents to ANSI (codepage of the current langpack is used).
: '''''text'''''
:: Type: '''string'''
;Result
: Type: '''string'''
;Example
{{Content:MirLua/Example|code=m.CallService("Quotes/Import", 0, Utf8DecodeA('c:\\quotes.xml'))}}

=== Utf8DecodeW ===
Converts Lua string contents to Unicode (UTF-16).
: '''''text'''''
:: Type: '''string'''
;Result
: Type: '''string'''
;Example
{{Content:MirLua/Example|code=m.CallService("Popup/ShowMessageW", m.Utf8DecodeW('Hello, World!'), 2)}}

=== Translate ===
Translates a string into the language of the current langpack.
: '''''text'''''
:: Type: '''string'''
;Result
: Type: '''string'''
;Example
{{Content:MirLua/Example|code=m.Translate('Exit')}}

=== ReplaceVariables ===
Replaces Miranda NG variables in a string.
: '''''text'''''
;Result
: Type: '''string'''
;Example
{{Content:MirLua/Example|code=local profileName = m.ReplaceVariables('%miranda_profilename%')}}

[[Category:Tutorials (en)]]

Plugin:MirLua

2018-04-04T23:01:07Z

Unsane:

<languages/>{{PluginCard}}
<translate>

Extends Miranda NG functionality with Lua scripts.
</translate>

<translate>
== Lua == 
The plugin uses Lua 5.3.4 which shipped as shared library lua53.dll.
</translate>

<translate>
== Additional functions == 
</translate>
<translate>
=== toansi===
Encodes lua utf-8 string to ansi. It can be usefull for passing string as parameter to ansi function.
<code>m.CallService('mRadio/Import', 0, toansi(m.Parse('%miranda_path%\\Plugins\\mradio.ini')))</code>
Also it has a short version '''a'''.
<code>m.CallService('DB/Ini/ImportFile', 0, a'import\\autoexec.ini')</code>
</translate>
<translate>
=== toucs2 ===
Same as '''toansi''' but for utf-16. Also it has a short version '''u'''.
</translate>
<translate>
=== tonumber ===
If it receives '''light userdata''' parameter then returns it address as number, otherwise uses standard lua '''tonumber''' behaviour.
</translate>
<translate>
=== topointer ===
Converts lua types '''bool''', '''number''', '''string''' to '''light userdata'''.
</translate>
<translate>
=== string.interpolate ===
Provides a more readable and convenient syntax to format string output.
<code>
local h = 'Hello'
print('{h}, {w}!' % {w = 'World'})
</code>
</translate>

<translate>
== Internal modules == 
</translate>

* [[Plugin:MirLua/ru/m_clist|m_clist]]
* [[Plugin:MirLua/en/m_core|m_core]]
* [[Plugin:MirLua/en/m_database|m_database]]
* [[Plugin:MirLua/en/m_genmenu|m_genmenu]]
* [[Plugin:MirLua/en/m_hotkeys|m_hotkeys]]
* [[Plugin:MirLua/en/m_icolib|m_icolib]]
* [[Plugin:MirLua/en/m_sounds|m_sounds]]

<translate>
== Examples == 
</translate>

{{Content:MirLua/Examples}}

<translate>
== External links == 
</translate>

* [https://forum.miranda-ng.org/index.php?topic=4161.0 <translate> Forum topic dedicated to script examples</translate>]{{RefLang|ru}}
* [https://www.lua.org <translate> Lua website</translate>]
* [[wikipedia:en:Lua_(programming_language)|<translate> Lua in Wikipedia</translate>]]

{{PluginGroups}}

Content:MirLua/Examples/json

2017-10-05T20:20:48Z

Unsane: Created page with "{{Content:MirLua/Example|code= local json = require('m_json') local value = json.Decode('[ true, { "foo": "bar" } ]') print( json.Encode(nil), json.Encode(true), j..."

{{Content:MirLua/Example|code=
local json = require('m_json')
local value = json.Decode('[ true, { "foo": "bar" } ]')
print(
json.Encode(nil),
json.Encode(true),
json.Encode(123),
json.Encode(3.21),
json.Encode('test'),
json.Encode({ true, { foo = "bar" } }),
json.Encode(value))
}}

Plugin:MirLua/ru

2017-09-26T21:53:20Z

Unsane: /* Примеры */

{{PluginCard}}
Расширяет функциональность Miranda NG с помощью скриптов на языке Lua.

== Модули ==
* [[Plugin:MirLua/ru/m_clist|m_clist]]
* [[Plugin:MirLua/ru/m_core|m_core]]
* [[Plugin:MirLua/ru/m_database|m_database]]
* [[Plugin:MirLua/ru/m_genmenu|m_genmenu]]
* [[Plugin:MirLua/ru/m_hotkeys|m_hotkeys]]
* [[Plugin:MirLua/ru/m_icolib|m_icolib]]
* [[Plugin:MirLua/ru/m_sounds|m_sounds]]

== Примеры ==

* [[Content:MirLua/Examples/database|database]]
* [[Content:MirLua/Examples/icons|icons]]
* [[Content:MirLua/Examples/menus|menus]]
* [[Content:MirLua/Examples/srmm|srmm]]
* [[Content:MirLua/Examples/popup|popup]]
* [[Content:MirLua/Examples/variables|variables]]

== Ссылки ==
* [https://forum.miranda-ng.org/index.php?topic=4161.0 Примеры скриптов в теме на форуме]
* [https://www.lua.org Веб-сайт Lua]{{RefLang|en}}
* [[wikipedia:ru:Lua|Lua в Википедии]]

{{PluginGroups}}

Content:MirLua/Examples/srmm

2017-09-26T21:51:37Z

Unsane:

Send files button in SRMM's:
{{Content:MirLua/Example|code=
local srmm = require('m_srmm')
local icolib = require('m_icolib')

local moduleName = 'SendFiles'
local buttonId = 1

local BBBF_ISIMBUTTON = 32
local BBBF_ISRSIDEBUTTON = 128

m.HookTemporaryEvent("SRMM/ButtonsBar/ModuleLoaded", function()
srmm.AddButton{
Module = moduleName,
ButtonId = buttonId,
Flags = BBBF_ISIMBUTTON | BBBF_ISRSIDEBUTTON,
Tooltip = m.Translate('Send File'),
Icon = icolib.AddIcon(moduleName, 'Send File')
}
end)

m.HookEvent("SRMM/ButtonsBar/ButtonPressed", function(w, l)
local bcd = CustomButtonClickData(l)
if bcd.Module == moduleName and bcd.ButtonId == buttonId then
print(bcd.hContact)
m.CallService('SRFile/SendCommand', bcd.hContact)
end
end)
}}

Open received files folder button in SRMM's:
{{Content:MirLua/Example|code=
local srmm = require('m_srmm')
local icolib = require('m_icolib')

local moduleName = 'MyReceivedFiles'
local buttonId = 1

local BBBF_ISIMBUTTON = 32
local BBBF_ISRSIDEBUTTON = 128

m.HookTemporaryEvent("SRMM/ButtonsBar/ModuleLoaded", function()
srmm.AddButton{
Module = moduleName,
ButtonId = buttonId,
Flags = BBBF_ISIMBUTTON | BBBF_ISRSIDEBUTTON,
Tooltip = m.Translate('My received files'),
Icon = icolib.AddIcon(moduleName, 'My received files')
}
end)

m.HookEvent("SRMM/ButtonsBar/ButtonPressed", function(w, l)
local bcd = CustomButtonClickData(l)
if bcd.Module == moduleName and bcd.ButtonId == buttonId then
m.CallService('SRFile/OpenContRecDir', bcd.hContact, 0)
end
end)

}}

Content:MirLua/Examples/protocols

2017-09-26T21:46:19Z

Unsane: Created page with "Switch all protocols statuses to online: {{Content:MirLua/Example|code= local protos = require('m_protocols') local ID_STATUS_OFFLINE = 40071 local ID_STATUS_ONLINE = 40072..."

Switch all protocols statuses to online:
{{Content:MirLua/Example|code=
local protos = require('m_protocols')

local ID_STATUS_OFFLINE = 40071
local ID_STATUS_ONLINE = 40072

m.HookEvent('Miranda/System/ModulesLoaded', function()
for acc in protos.Accounts() do
if acc.IsEnabled and not acc.IsVirtual then
local status = acc:CallService('/GetStatus')
if (status == ID_STATUS_OFFLINE) then
acc:CallService('/SetStatus', ID_STATUS_ONLINE)
end
end
end
end)
}}

Content:MirLua/Examples/database

2017-09-26T21:41:20Z

Unsane:

An [[Plugin:Msg_Export|Msg_Export]] analogue:
{{Content:MirLua/Example|code=
local db = require('m_database')

m.HookEvent("DB/Event/Added", function(w, l)
local hContact = tonumber(w)
-- note that path to file should be exists
local path = m.Parse('%miranda_userdata%\\History\\')
.. db.GetContactInfo(hContact, 'Uid')
.. '.log'
local contactName = db.GetContactInfo(hContact, 'DisplayName')
local message = GetMessage(tonumber(l), contactName)
print(message)
if message then
local file = io.open(path, 'a+')
if file then
file:write(message)
file:close()
print('ok')
end
end
end)

function GetMessage(hDbEvent, contactName)
local event = DBEVENTINFO(hDbEvent)
if event.Type == 0 then
local isSent = event.Flags & 2 == 2
local nick = isSent and 'me' or contactName
local date = os.date("%d.%m.%Y %H:%M:%S", event.Timestamp)
local text = toutf8(event.Blob)
return string.interpolate('{1} {2}:\t{3}\n', nick, date, text)
end
return nil
end

function toutf8(bytes)
local bytearr = {}
for i = 1, #bytes do
local v = bytes[i]
local utf8byte = v < 0 and (0xff + v + 1) or v
table.insert(bytearr, string.char(utf8byte))
end
return table.concat(bytearr)
end
}}

Content:MirLua/Examples/menus

2017-09-26T21:06:22Z

Unsane:

Add restart menu item to main menu
{{Content:MirLua/Example|code=
local clist = require("m_clist")
local icolib = require("m_icolib")

m.CreateServiceFunction("Lua/Restart", function()
m.CallService("Miranda/System/Restart", 1)
end)

clist.AddMainMenuItem{
Name = "Restart",
Service = "Lua/Restart",
Uid = '9FC57A01-FAC6-41AC-A009-52F1C6594095',
Icon = icolib.AddIcon('restart', 'Restart')
}
}}

Content:MirLua/Examples/srmm

2017-09-26T21:03:22Z

Unsane: Created page with "Open received files folder button in SRMM's: {{Content:MirLua/Example|code= local srmm = require('m_srmm') local icolib = require('m_icolib') local moduleName = 'MyReceivedFi..."

Open received files folder button in SRMM's:
{{Content:MirLua/Example|code=
local srmm = require('m_srmm')
local icolib = require('m_icolib')

local moduleName = 'MyReceivedFiles'
local buttonId = 1

local BBBF_ISIMBUTTON = 32
local BBBF_ISRSIDEBUTTON = 128

m.HookTemporaryEvent("SRMM/ButtonsBar/ModuleLoaded", function()
srmm.AddButton{
Module = moduleName,
ButtonId = buttonId,
Flags = BBBF_ISIMBUTTON {{!}} BBBF_ISRSIDEBUTTON,
Tooltip = m.Translate('My received files'),
Icon = icolib.AddIcon(moduleName, 'My received files')
}
end)

m.HookEvent("SRMM/ButtonsBar/ButtonPressed", function(w, l)
local bcd = CustomButtonClickData(l)
if bcd.Module == moduleName and bcd.ButtonId == buttonId then
m.CallService('SRFile/OpenContRecDir', bcd.hContact)
end
end)
}}

Plugin:MirLua

2017-09-11T21:55:38Z

Unsane:

Plugin:MirLua/ru/m database

2017-09-11T21:53:45Z

Unsane: /* GetContactInfo */

{{PageLang|ru}}
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.

Подключение модуля: <code>local db = require('m_database')</code>

{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}

__TOC__

== Контакты ==
=== Contacts ===
Итератор для списка контактов
;Параметры
: ''name''
:: Тип: '''string'''
:: Имя протокола
;Результат
: Тип: '''function'''
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hContact in db.Contacts('JABBER_1') do
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))
end
}}

=== GetContactInfo ===
Контактная информация
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
:'''''field'''''
::
{| class="wikitable"
!Тип
|'''number'''
|'''string'''
|-
!Описание
|тип поля
|название поля
|-
!Значения
|1-16
|FirstName, LastName, Nick, CustomNick, Email, City, State, Country, Phone, Homepage, About, Gender, Age, FullName, Uid, DisplayName
|}
;Результат
: Тип: '''string'''
: Значение поля или '''nil'''
;Пример
{{Content:MirLua/Example|code=local email = db.GetContactInfo(hContact, 'Email')
}}

== События ==
=== GetEventCount ===
Количество событий для контакта
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает количество событий
;Пример
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}

=== Events ===
Итератор для списка событий контакта от первого к последнему
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hEvent in db.Events(hContact) do
local event = DBEVENTINFO.new(hEvent)
print(event.Timestamp, event.Blob)
end
}}

=== EventsFromEnd ===
Итератор для списка событий контакта от последнего к первому
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hEvent in db.EventsFromEnd(hContact) do
local event = DBEVENTINFO.new(hEvent)
print(event.Timestamp, event.Blob)
end
}}

== Настройки ==
=== GetSetting ===
Возвращает значение настройки
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название модуля
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: ''value''
:: Тип: ''any''
:: Значание по умолчаниию
;Результат
: Тип: '''number'''
: Возвращает значение настройки или значание по умолчаниию или '''nil'''
;Пример
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}

=== Settings ===
Итератор для секции настроек
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''number'''
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for setting in db.Settings(nil, 'CList') do
local message = string.format("%s/%s = ", 'CList', setting, ...)
.. db.GetSetting(nil, 'CList', setting)
print(message)
end
}}

=== WriteSetting ===
Сохраняет значение в БД
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: '''''value'''''
:: Тип: '''boolean''', '''number''', '''string''', '''table''' (массив байт)
:: Значение настройки
: ''type''
:: Тип: '''number'''
:: Тип настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}

=== DeleteSetting ===
Удаляет настройку
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}

=== DeleteModule ===
Удаляет секцию
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}

== Структуры ==
=== DBEVENTINFO ===
Таблица, описывающая событие в БД
;Поля
: '''''Module'''''
:: Тип: '''string'''
:: Название аккаунта
: '''''Timestamp'''''
:: Тип: '''number'''
:: Отметка времени
: '''''Type'''''
:: Тип: '''number'''
:: Тип события
: '''''Flags'''''
:: Тип: '''number'''
:: Флаги

[[Category:Руководства]]

Plugin:MirLua/ru/m database

2017-09-11T21:53:26Z

Unsane: /* GetContactInfo */

{{PageLang|ru}}
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.

Подключение модуля: <code>local db = require('m_database')</code>

{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}

__TOC__

== Контакты ==
=== Contacts ===
Итератор для списка контактов
;Параметры
: ''name''
:: Тип: '''string'''
:: Имя протокола
;Результат
: Тип: '''function'''
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hContact in db.Contacts('JABBER_1') do
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))
end
}}

=== GetContactInfo ===
Контактная информация
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
:'''''field'''''
::
{| class="wikitable"
!Тип
|'''number'''
|'''string'''
|-
!Описание
|тип поля
|название поля
|-
!Значения
|1-16
|FirstName, LastName, Nick, CustomNick, Email, City, State, Country, Phone, Homepage, About, Gender, Age, FullName, Uid, DisplayName
|}
;Результат
: Тип: '''string'''
: Значение поля или '''nil'''
;Пример
{{Content:MirLua/Example|code=
local email = db.GetContactInfo(hContact, 'Email')
print(email)
}}

== События ==
=== GetEventCount ===
Количество событий для контакта
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает количество событий
;Пример
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}

=== Events ===
Итератор для списка событий контакта от первого к последнему
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hEvent in db.Events(hContact) do
local event = DBEVENTINFO.new(hEvent)
print(event.Timestamp, event.Blob)
end
}}

=== EventsFromEnd ===
Итератор для списка событий контакта от последнего к первому
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hEvent in db.EventsFromEnd(hContact) do
local event = DBEVENTINFO.new(hEvent)
print(event.Timestamp, event.Blob)
end
}}

== Настройки ==
=== GetSetting ===
Возвращает значение настройки
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название модуля
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: ''value''
:: Тип: ''any''
:: Значание по умолчаниию
;Результат
: Тип: '''number'''
: Возвращает значение настройки или значание по умолчаниию или '''nil'''
;Пример
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}

=== Settings ===
Итератор для секции настроек
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''number'''
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for setting in db.Settings(nil, 'CList') do
local message = string.format("%s/%s = ", 'CList', setting, ...)
.. db.GetSetting(nil, 'CList', setting)
print(message)
end
}}

=== WriteSetting ===
Сохраняет значение в БД
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: '''''value'''''
:: Тип: '''boolean''', '''number''', '''string''', '''table''' (массив байт)
:: Значение настройки
: ''type''
:: Тип: '''number'''
:: Тип настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}

=== DeleteSetting ===
Удаляет настройку
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}

=== DeleteModule ===
Удаляет секцию
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}

== Структуры ==
=== DBEVENTINFO ===
Таблица, описывающая событие в БД
;Поля
: '''''Module'''''
:: Тип: '''string'''
:: Название аккаунта
: '''''Timestamp'''''
:: Тип: '''number'''
:: Отметка времени
: '''''Type'''''
:: Тип: '''number'''
:: Тип события
: '''''Flags'''''
:: Тип: '''number'''
:: Флаги

[[Category:Руководства]]

Plugin:MirLua/ru/m database

2017-09-11T21:51:41Z

Unsane: /* Контакты */

{{PageLang|ru}}
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.

Подключение модуля: <code>local db = require('m_database')</code>

{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}

__TOC__

== Контакты ==
=== Contacts ===
Итератор для списка контактов
;Параметры
: ''name''
:: Тип: '''string'''
:: Имя протокола
;Результат
: Тип: '''function'''
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hContact in db.Contacts('JABBER_1') do
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))
end
}}

=== GetContactInfo ===
Контактная информация
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
:'''''field'''''
::
{| class="wikitable"
!Тип
|'''number'''
|'''string'''
|-
!Описание
|тип поля
|название поля
|-
!Значения
|1-16
|FirstName, LastName, Nick, CustomNick, Email, City, State, Country, Phone, Homepage, About, Gender, Age, FullName, Uid, DisplayName
|}
;Результат
: Тип: '''function'''
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hContact in db.Contacts('JABBER_1') do
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))
end
}}

== События ==
=== GetEventCount ===
Количество событий для контакта
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает количество событий
;Пример
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}

=== Events ===
Итератор для списка событий контакта от первого к последнему
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hEvent in db.Events(hContact) do
local event = DBEVENTINFO.new(hEvent)
print(event.Timestamp, event.Blob)
end
}}

=== EventsFromEnd ===
Итератор для списка событий контакта от последнего к первому
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hEvent in db.EventsFromEnd(hContact) do
local event = DBEVENTINFO.new(hEvent)
print(event.Timestamp, event.Blob)
end
}}

== Настройки ==
=== GetSetting ===
Возвращает значение настройки
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название модуля
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: ''value''
:: Тип: ''any''
:: Значание по умолчаниию
;Результат
: Тип: '''number'''
: Возвращает значение настройки или значание по умолчаниию или '''nil'''
;Пример
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}

=== Settings ===
Итератор для секции настроек
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''number'''
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for setting in db.Settings(nil, 'CList') do
local message = string.format("%s/%s = ", 'CList', setting, ...)
.. db.GetSetting(nil, 'CList', setting)
print(message)
end
}}

=== WriteSetting ===
Сохраняет значение в БД
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: '''''value'''''
:: Тип: '''boolean''', '''number''', '''string''', '''table''' (массив байт)
:: Значение настройки
: ''type''
:: Тип: '''number'''
:: Тип настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}

=== DeleteSetting ===
Удаляет настройку
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}

=== DeleteModule ===
Удаляет секцию
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}

== Структуры ==
=== DBEVENTINFO ===
Таблица, описывающая событие в БД
;Поля
: '''''Module'''''
:: Тип: '''string'''
:: Название аккаунта
: '''''Timestamp'''''
:: Тип: '''number'''
:: Отметка времени
: '''''Type'''''
:: Тип: '''number'''
:: Тип события
: '''''Flags'''''
:: Тип: '''number'''
:: Флаги

[[Category:Руководства]]

Plugin:MirLua/ru/m database

2017-09-11T21:38:00Z

Unsane:

{{PageLang|ru}}
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.

Подключение модуля: <code>local db = require('m_database')</code>

{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}

__TOC__

== Контакты ==
=== Contacts ===
Итератор для списка контактов
;Параметры
: ''name''
:: Тип: '''string'''
:: Имя протокола
;Результат
: Тип: '''function'''
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hContact in db.Contacts('JABBER_1') do
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))
end
}}

== События ==
=== GetEventCount ===
Количество событий для контакта
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает количество событий
;Пример
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}

=== Events ===
Итератор для списка событий контакта от первого к последнему
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hEvent in db.Events(hContact) do
local event = DBEVENTINFO.new(hEvent)
print(event.Timestamp, event.Blob)
end
}}

=== EventsFromEnd ===
Итератор для списка событий контакта от последнего к первому
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hEvent in db.EventsFromEnd(hContact) do
local event = DBEVENTINFO.new(hEvent)
print(event.Timestamp, event.Blob)
end
}}

== Настройки ==
=== GetSetting ===
Возвращает значение настройки
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название модуля
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: ''value''
:: Тип: ''any''
:: Значание по умолчаниию
;Результат
: Тип: '''number'''
: Возвращает значение настройки или значание по умолчаниию или '''nil'''
;Пример
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}

=== Settings ===
Итератор для секции настроек
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''number'''
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for setting in db.Settings(nil, 'CList') do
local message = string.format("%s/%s = ", 'CList', setting, ...)
.. db.GetSetting(nil, 'CList', setting)
print(message)
end
}}

=== WriteSetting ===
Сохраняет значение в БД
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: '''''value'''''
:: Тип: '''boolean''', '''number''', '''string''', '''table''' (массив байт)
:: Значение настройки
: ''type''
:: Тип: '''number'''
:: Тип настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}

=== DeleteSetting ===
Удаляет настройку
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}

=== DeleteModule ===
Удаляет секцию
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}

== Структуры ==
=== DBEVENTINFO ===
Таблица, описывающая событие в БД
;Поля
: '''''Module'''''
:: Тип: '''string'''
:: Название аккаунта
: '''''Timestamp'''''
:: Тип: '''number'''
:: Отметка времени
: '''''Type'''''
:: Тип: '''number'''
:: Тип события
: '''''Flags'''''
:: Тип: '''number'''
:: Флаги

[[Category:Руководства]]

Plugin:MirLua/ru/m database

2017-09-11T21:29:02Z

Unsane: /* Events */

{{PageLang|ru}}
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.

Подключение модуля: <code>local db = require('m_database')</code>

{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}

__TOC__

== Контакты ==
=== Contacts ===
Итератор для списка контактов
;Параметры
: ''name''
:: Тип: '''string'''
:: Имя протокола
;Результат
: Тип: '''function'''
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hContact in db.Contacts('JABBER_1') do
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))
end
}}

== События ==
=== GetEventCount ===
Количество событий для контакта
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает количество событий
;Пример
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}

=== Events ===
Итератор для списка событий контакта от первого к последнему
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hEvent in db.Events(hContact) do
local event = DBEVENTINFO.new(hEvent)
print(event.Timestamp, event.Blob)
end
}}

=== EventsFromEnd ===
Итератор для списка событий контакта от последнего к первому
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hEvent in db.EventsFromEnd(hContact) do
local event = DBEVENTINFO.new(hEvent)
print(event.Timestamp, event.Blob)
end
}}

== Настройки ==
=== GetSetting ===
Возвращает значение настройки
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название модуля
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: ''value''
:: Тип: ''any''
:: Значание по умолчаниию
;Результат
: Тип: '''number'''
: Возвращает значение настройки или значание по умолчаниию или '''nil'''
;Пример
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}

=== Settings ===
Итератор для секции настроек
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''number'''
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for setting in db.Settings(nil, 'CList') do
local message = string.format("%s/%s = ", 'CList', setting, ...)
.. db.GetSetting(nil, 'CList', setting)
print(message)
end
}}

=== WriteSetting ===
Сохраняет значение в БД
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: '''''value'''''
:: Тип: '''boolean''', '''number''', '''string''', '''table''' (массив байт)
:: Значение настройки
: ''type''
:: Тип: '''number'''
:: Тип настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}

=== DeleteSetting ===
Удаляет настройку
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}

=== DeleteModule ===
Удаляет секцию
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}

[[Category:Руководства]]

Plugin:MirLua/ru/m database

2017-09-11T21:28:35Z

Unsane: /* EventsFromEnd */

{{PageLang|ru}}
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.

Подключение модуля: <code>local db = require('m_database')</code>

{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}

__TOC__

== Контакты ==
=== Contacts ===
Итератор для списка контактов
;Параметры
: ''name''
:: Тип: '''string'''
:: Имя протокола
;Результат
: Тип: '''function'''
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hContact in db.Contacts('JABBER_1') do
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))
end
}}

== События ==
=== GetEventCount ===
Количество событий для контакта
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает количество событий
;Пример
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}

=== Events ===
Итератор для списка событий контакта от первого к последнему
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=for hEvent in db.Events(hContact) do
local event = totable(hEvent, "DBEVENTINFO")
print(event.Timestamp, event.Blob)
end
}}

=== EventsFromEnd ===
Итератор для списка событий контакта от последнего к первому
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hEvent in db.EventsFromEnd(hContact) do
local event = DBEVENTINFO.new(hEvent)
print(event.Timestamp, event.Blob)
end
}}

== Настройки ==
=== GetSetting ===
Возвращает значение настройки
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название модуля
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: ''value''
:: Тип: ''any''
:: Значание по умолчаниию
;Результат
: Тип: '''number'''
: Возвращает значение настройки или значание по умолчаниию или '''nil'''
;Пример
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}

=== Settings ===
Итератор для секции настроек
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''number'''
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for setting in db.Settings(nil, 'CList') do
local message = string.format("%s/%s = ", 'CList', setting, ...)
.. db.GetSetting(nil, 'CList', setting)
print(message)
end
}}

=== WriteSetting ===
Сохраняет значение в БД
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: '''''value'''''
:: Тип: '''boolean''', '''number''', '''string''', '''table''' (массив байт)
:: Значение настройки
: ''type''
:: Тип: '''number'''
:: Тип настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}

=== DeleteSetting ===
Удаляет настройку
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}

=== DeleteModule ===
Удаляет секцию
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}

[[Category:Руководства]]

Plugin:MirLua/ru/m database

2017-09-11T21:27:34Z

Unsane: /* GetSetting */

{{PageLang|ru}}
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.

Подключение модуля: <code>local db = require('m_database')</code>

{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}

__TOC__

== Контакты ==
=== Contacts ===
Итератор для списка контактов
;Параметры
: ''name''
:: Тип: '''string'''
:: Имя протокола
;Результат
: Тип: '''function'''
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hContact in db.Contacts('JABBER_1') do
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))
end
}}

== События ==
=== GetEventCount ===
Количество событий для контакта
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает количество событий
;Пример
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}

=== Events ===
Итератор для списка событий контакта от первого к последнему
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=for hEvent in db.Events(hContact) do
local event = totable(hEvent, "DBEVENTINFO")
print(event.Timestamp, event.Blob)
end
}}

=== EventsFromEnd ===
Итератор для списка событий контакта от последнего к первому
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hEvent in db.EventsFromEnd(hContact) do
local event = totable(hEvent, "DBEVENTINFO")
print(event.Timestamp, event.Blob)
end
}}

== Настройки ==
=== GetSetting ===
Возвращает значение настройки
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название модуля
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: ''value''
:: Тип: ''any''
:: Значание по умолчаниию
;Результат
: Тип: '''number'''
: Возвращает значение настройки или значание по умолчаниию или '''nil'''
;Пример
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}

=== Settings ===
Итератор для секции настроек
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''number'''
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for setting in db.Settings(nil, 'CList') do
local message = string.format("%s/%s = ", 'CList', setting, ...)
.. db.GetSetting(nil, 'CList', setting)
print(message)
end
}}

=== WriteSetting ===
Сохраняет значение в БД
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: '''''value'''''
:: Тип: '''boolean''', '''number''', '''string''', '''table''' (массив байт)
:: Значение настройки
: ''type''
:: Тип: '''number'''
:: Тип настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}

=== DeleteSetting ===
Удаляет настройку
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}

=== DeleteModule ===
Удаляет секцию
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}

[[Category:Руководства]]

Plugin:MirLua/ru/m database

2017-09-11T21:26:11Z

Unsane: /* WriteSetting */

{{PageLang|ru}}
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.

Подключение модуля: <code>local db = require('m_database')</code>

{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}

__TOC__

== Контакты ==
=== Contacts ===
Итератор для списка контактов
;Параметры
: ''name''
:: Тип: '''string'''
:: Имя протокола
;Результат
: Тип: '''function'''
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hContact in db.Contacts('JABBER_1') do
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))
end
}}

== События ==
=== GetEventCount ===
Количество событий для контакта
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает количество событий
;Пример
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}

=== Events ===
Итератор для списка событий контакта от первого к последнему
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=for hEvent in db.Events(hContact) do
local event = totable(hEvent, "DBEVENTINFO")
print(event.Timestamp, event.Blob)
end
}}

=== EventsFromEnd ===
Итератор для списка событий контакта от последнего к первому
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hEvent in db.EventsFromEnd(hContact) do
local event = totable(hEvent, "DBEVENTINFO")
print(event.Timestamp, event.Blob)
end
}}

== Настройки ==
=== GetSetting ===
Возвращает значение настройки
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название модуля
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: ''value''
:: Тип: '''number''', '''string'''
:: Значание по умолчаниию
;Результат
: Тип: '''number'''
: Возвращает значение настройки или значание по умолчаниию или '''nil'''
;Пример
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}

=== Settings ===
Итератор для секции настроек
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''number'''
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for setting in db.Settings(nil, 'CList') do
local message = string.format("%s/%s = ", 'CList', setting, ...)
.. db.GetSetting(nil, 'CList', setting)
print(message)
end
}}

=== WriteSetting ===
Сохраняет значение в БД
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: '''''value'''''
:: Тип: '''boolean''', '''number''', '''string''', '''table''' (массив байт)
:: Значение настройки
: ''type''
:: Тип: '''number'''
:: Тип настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}

=== DeleteSetting ===
Удаляет настройку
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}

=== DeleteModule ===
Удаляет секцию
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}

[[Category:Руководства]]

Plugin:MirLua/ru/m database

2017-09-11T21:24:23Z

Unsane: /* WriteSetting */

{{PageLang|ru}}
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.

Подключение модуля: <code>local db = require('m_database')</code>

{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}

__TOC__

== Контакты ==
=== Contacts ===
Итератор для списка контактов
;Параметры
: ''name''
:: Тип: '''string'''
:: Имя протокола
;Результат
: Тип: '''function'''
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hContact in db.Contacts('JABBER_1') do
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))
end
}}

== События ==
=== GetEventCount ===
Количество событий для контакта
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает количество событий
;Пример
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}

=== Events ===
Итератор для списка событий контакта от первого к последнему
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=for hEvent in db.Events(hContact) do
local event = totable(hEvent, "DBEVENTINFO")
print(event.Timestamp, event.Blob)
end
}}

=== EventsFromEnd ===
Итератор для списка событий контакта от последнего к первому
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hEvent in db.EventsFromEnd(hContact) do
local event = totable(hEvent, "DBEVENTINFO")
print(event.Timestamp, event.Blob)
end
}}

== Настройки ==
=== GetSetting ===
Возвращает значение настройки
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название модуля
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: ''value''
:: Тип: '''number''', '''string'''
:: Значание по умолчаниию
;Результат
: Тип: '''number'''
: Возвращает значение настройки или значание по умолчаниию или '''nil'''
;Пример
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}

=== Settings ===
Итератор для секции настроек
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''number'''
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for setting in db.Settings(nil, 'CList') do
local message = string.format("%s/%s = ", 'CList', setting, ...)
.. db.GetSetting(nil, 'CList', setting)
print(message)
end
}}

=== WriteSetting ===
Сохраняет значение в БД
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: '''''value'''''
:: Тип: '''boolean'''/'''number'''/'''string'''/'''table'''
:: Значение настройки
: ''type''
:: Тип: '''number'''
:: Тип настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}

=== DeleteSetting ===
Удаляет настройку
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}

=== DeleteModule ===
Удаляет секцию
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}

[[Category:Руководства]]

Plugin:MirLua/ru/m database

2017-09-11T21:17:06Z

Unsane: /* WriteSetting */

{{PageLang|ru}}
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.

Подключение модуля: <code>local db = require('m_database')</code>

{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}

__TOC__

== Контакты ==
=== Contacts ===
Итератор для списка контактов
;Параметры
: ''name''
:: Тип: '''string'''
:: Имя протокола
;Результат
: Тип: '''function'''
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hContact in db.Contacts('JABBER_1') do
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))
end
}}

== События ==
=== GetEventCount ===
Количество событий для контакта
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает количество событий
;Пример
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}

=== Events ===
Итератор для списка событий контакта от первого к последнему
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=for hEvent in db.Events(hContact) do
local event = totable(hEvent, "DBEVENTINFO")
print(event.Timestamp, event.Blob)
end
}}

=== EventsFromEnd ===
Итератор для списка событий контакта от последнего к первому
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hEvent in db.EventsFromEnd(hContact) do
local event = totable(hEvent, "DBEVENTINFO")
print(event.Timestamp, event.Blob)
end
}}

== Настройки ==
=== GetSetting ===
Возвращает значение настройки
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название модуля
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: ''value''
:: Тип: '''number''', '''string'''
:: Значание по умолчаниию
;Результат
: Тип: '''number'''
: Возвращает значение настройки или значание по умолчаниию или '''nil'''
;Пример
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}

=== Settings ===
Итератор для секции настроек
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''number'''
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for setting in db.Settings(nil, 'CList') do
local message = string.format("%s/%s = ", 'CList', setting, ...)
.. db.GetSetting(nil, 'CList', setting)
print(message)
end
}}

=== WriteSetting ===
Сохраняет значение в БД
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: '''''value'''''
:: Тип: '''boolean'''/'''number'''/'''string'''/'''table'''(byte array)
:: Значение настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}

=== DeleteSetting ===
Удаляет настройку
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}

=== DeleteModule ===
Удаляет секцию
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}

[[Category:Руководства]]

Plugin:MirLua/ru/m protocols

2017-09-11T18:38:17Z

Unsane: /* Структуры */

{{PageLang|ru}}
Предоставляет функционал для работы с протоколами.

Подключение модуля: <code>local protos = require('m_protocols')</code>

{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}

__TOC__

== Протоколы ==
=== GetProtocol ===
Получает протокол
;Параметры
: '''''mixed'''''
::
{| class="wikitable"
!Тип
|'''number'''
|'''string'''
|-
!Описание
|номер контакта
|название протокола
|}
;Результат
: Тип: '''userdata'''
: Возвращает мета-таблицу [[#PROTOCOLDESCRIPTOR|PROTOCOLDESCRIPTOR]]
;Пример
{{Content:MirLua/Example|code=local proto = protos.GetProtocol({ Name = 'JABBER' })}}

=== Protocols ===
Итератор для протоколов
;Параметры
;Результат
: Тип: '''function'''
: Возвращает функцию-итератор для перебора протоколов. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for proto in protos.Protocols() do
print(proto.Name)
end
}}

=== CallSendChain ===
Вызывает цепочку обработки для исходящего события (фильтрация, шифрование и т.п.)
; Параметры
: '''''name'''''
:: Тип: '''string'''
:: Имя сервиса
: ''wParam''
: ''lParam''
{{Content:MirLua/Example|code=protos.CallSendChain(hContact, '/SendMsg', 0, a'Hello!')}}

=== CallReceiveChain ===
Вызывает цепочку обработки для входящего события (игнорирование, запись в бд и т.п.)
; Параметры
: '''''name'''''
:: Тип: '''string'''
:: Имя сервиса
: ''wParam''
: ''lParam''

== Аккаунты ==
=== GetAccount ===
Получает аккаунт протокола
;Параметры
: '''''mixed'''''
::
{| class="wikitable"
!Тип
|'''number'''
|'''string'''
|-
!Описание
|номер контакта
|название аккаунта (внутреннее)
|}
;Результат
: Тип: '''userdata'''
: Возвращает мета-таблицу [[#PROTOACCOUNT|PROTOACCOUNT ]]
;Пример
{{Content:MirLua/Example|code=local proto = protos.GetProtocol({ Name = 'JABBER' })}}

=== Accounts ===
Итератор для аккаунтов
;Параметры
: '''''mixed'''''
::
{| class="wikitable"
!Тип
|'''none'''
|'''string'''
|'''[[#PROTOCOLDESCRIPTOR|userdata]]'''
|-
!Описание
|без параметра
|название аккаунта (внутреннее)
|протокол
|}
;Результат
: Тип: '''function'''
: Возвращает функцию-итератор для перебора аккаунтов. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for proto in protos.Protocols() do
print(proto.Name)
end
}}

== Структуры ==
=== PROTOCOLDESCRIPTOR ===
Таблица, описывающая протокол
;Поля
: '''''Name'''''
:: Тип: '''string'''
:: Название протокола
: '''''Type'''''
:: Тип: '''number'''
:: Тип протокола
:: Значения:
::: ''PROTOTYPE_IGNORE'' = 50
::: ''PROTOTYPE_PROTOCOL'' = 1000
::: ''PROTOTYPE_VIRTUAL'' = 1001
::: ''PROTOTYPE_ENCRYPTION'' = 2000
::: ''PROTOTYPE_FILTER'' = 3000
::: ''PROTOTYPE_TRANSLATION'' = 4000
::: ''PROTOTYPE_OTHER'' = 10000
;Методы
: '''''Accounts'''''
:: Параметры
:: Результат
::: Тип: '''function'''
::: Возвращает функцию-итератор для перебора списка аккаунтов. Список оканчивается элементом со значением '''nil'''

=== PROTOACCOUNT ===
Таблица, описывающая аккаунт протокола
;Поля
: '''''ProtoName'''''
:: Тип: '''string'''
:: Название протокола
: '''''ModuleName'''''
:: Тип: '''string'''
:: Название аккаунта (внутреннее)
: '''''AccountName'''''
:: Тип: '''string'''
:: Название аккаунта (пользовательское)
: '''''IsEnabled'''''
:: Тип: '''boolean'''
:: Аккаунт включен?
: '''''IsVisible'''''
:: Тип: '''boolean'''
:: Аккаунт отображается?
: '''''IsVirtual'''''
:: Тип: '''boolean'''
:: Аккаунт виртуальный?
: '''''IsOldProto'''''
:: Тип: '''boolean'''
:: Протокол поддерживает аккаунты?
;Методы
: '''''CallService'''''
:: Параметры
::: '''''name'''''
:::: Тип: '''string'''
:::: Имя сервиса
::: ''wParam''
::: ''lParam''
:: Результат
::: Тип: '''number'''
::: Возвращает результат выполнения сервиса или [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]

Plugin:MirLua/ru/m protocols

2017-09-04T20:35:13Z

Unsane:

{{PageLang|ru}}
Предоставляет функционал для работы с протоколами.

Подключение модуля: <code>local protos = require('m_protocols')</code>

{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}

__TOC__

== Протоколы ==
=== GetProtocol ===
Получает протокол
;Параметры
: '''''mixed'''''
::
{| class="wikitable"
!Тип
|'''number'''
|'''string'''
|-
!Описание
|номер контакта
|название протокола
|}
;Результат
: Тип: '''userdata'''
: Возвращает мета-таблицу [[#PROTOCOLDESCRIPTOR|PROTOCOLDESCRIPTOR]]
;Пример
{{Content:MirLua/Example|code=local proto = protos.GetProtocol({ Name = 'JABBER' })}}

=== Protocols ===
Итератор для протоколов
;Параметры
;Результат
: Тип: '''function'''
: Возвращает функцию-итератор для перебора протоколов. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for proto in protos.Protocols() do
print(proto.Name)
end
}}

=== CallSendChain ===
Вызывает цепочку обработки для исходящего события (фильтрация, шифрование и т.п.)
; Параметры
: '''''name'''''
:: Тип: '''string'''
:: Имя сервиса
: ''wParam''
: ''lParam''
{{Content:MirLua/Example|code=protos.CallSendChain(hContact, '/SendMsg', 0, a'Hello!')}}

=== CallReceiveChain ===
Вызывает цепочку обработки для входящего события (игнорирование, запись в бд и т.п.)
; Параметры
: '''''name'''''
:: Тип: '''string'''
:: Имя сервиса
: ''wParam''
: ''lParam''

== Аккаунты ==
=== GetAccount ===
Получает аккаунт протокола
;Параметры
: '''''mixed'''''
::
{| class="wikitable"
!Тип
|'''number'''
|'''string'''
|-
!Описание
|номер контакта
|название аккаунта (внутреннее)
|}
;Результат
: Тип: '''userdata'''
: Возвращает мета-таблицу [[#PROTOACCOUNT|PROTOACCOUNT ]]
;Пример
{{Content:MirLua/Example|code=local proto = protos.GetProtocol({ Name = 'JABBER' })}}

=== Accounts ===
Итератор для аккаунтов
;Параметры
: '''''mixed'''''
::
{| class="wikitable"
!Тип
|'''none'''
|'''string'''
|'''[[#PROTOCOLDESCRIPTOR|userdata]]'''
|-
!Описание
|без параметра
|название аккаунта (внутреннее)
|протокол
|}
;Результат
: Тип: '''function'''
: Возвращает функцию-итератор для перебора аккаунтов. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for proto in protos.Protocols() do
print(proto.Name)
end
}}

== Структуры ==
=== PROTOCOLDESCRIPTOR ===
Таблица, описывающая протокол
;Поля
: '''''Name'''''
:: Тип: '''string'''
:: Название протокола
: '''''Type'''''
:: Тип: '''number'''
:: Тип протокола
:: Значения:
::: ''PROTOTYPE_IGNORE'' = 50
::: ''PROTOTYPE_PROTOCOL'' = 1000
::: ''PROTOTYPE_VIRTUAL'' = 1001
::: ''PROTOTYPE_ENCRYPTION'' = 2000
::: ''PROTOTYPE_FILTER'' = 3000
::: ''PROTOTYPE_TRANSLATION'' = 4000
::: ''PROTOTYPE_OTHER'' = 10000
;Методы
: '''''CallService'''''
:: Параметры
::: '''''name'''''
:::: Тип: '''string'''
:::: Имя сервиса
::: ''wParam''
::: ''lParam''
:: Результат
::: Тип: '''number'''
::: Возвращает результат выполнения сервиса или [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]
: '''''Accounts'''''
:: Параметры
:: Результат
::: Тип: '''function'''
::: Возвращает функцию-итератор для перебора списка аккаунтов. Список оканчивается элементом со значением '''nil'''

=== PROTOACCOUNT ===
Таблица, описывающая аккаунт протокола
;Поля
: '''''ProtoName'''''
:: Тип: '''string'''
:: Название протокола
: '''''ModuleName'''''
:: Тип: '''string'''
:: Название аккаунта (внутреннее)
: '''''AccountName'''''
:: Тип: '''string'''
:: Название аккаунта (пользовательское)
: '''''IsEnabled'''''
:: Тип: '''boolean'''
:: Аккаунт включен?
: '''''IsVisible'''''
:: Тип: '''boolean'''
:: Аккаунт отображается?
: '''''IsVirtual'''''
:: Тип: '''boolean'''
:: Аккаунт виртуальный?
: '''''IsOldProto'''''
:: Тип: '''boolean'''
:: Протокол поддерживает аккаунты?

Plugin:MirLua/ru/m protocols

2017-09-04T20:16:33Z

Unsane:

Plugin:MirLua/ru/m protocols

2017-09-04T20:04:45Z

Unsane:

Plugin:MirLua/ru/m database

2017-09-04T20:02:17Z

Unsane: /* Contacts */

{{PageLang|ru}}
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.

Подключение модуля: <code>local db = require('m_database')</code>

{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}

__TOC__

== Контакты ==
=== Contacts ===
Итератор для списка контактов
;Параметры
: ''name''
:: Тип: '''string'''
:: Имя протокола
;Результат
: Тип: '''function'''
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hContact in db.Contacts('JABBER_1') do
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))
end
}}

== События ==
=== GetEventCount ===
Количество событий для контакта
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает количество событий
;Пример
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}

=== Events ===
Итератор для списка событий контакта от первого к последнему
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=for hEvent in db.Events(hContact) do
local event = totable(hEvent, "DBEVENTINFO")
print(event.Timestamp, event.Blob)
end
}}

=== EventsFromEnd ===
Итератор для списка событий контакта от последнего к первому
;Параметры
: '''''hContact'''''
:: Тип: '''number'''
:: Номер контакта
;Результат
: Тип: '''number'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for hEvent in db.EventsFromEnd(hContact) do
local event = totable(hEvent, "DBEVENTINFO")
print(event.Timestamp, event.Blob)
end
}}

== Настройки ==
=== GetSetting ===
Возвращает значение настройки
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название модуля
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
: ''value''
:: Тип: '''number''', '''string'''
:: Значание по умолчаниию
;Результат
: Тип: '''number'''
: Возвращает значение настройки или значание по умолчаниию или '''nil'''
;Пример
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}

=== Settings ===
Итератор для секции настроек
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''number'''
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''
;Пример
{{Content:MirLua/Example|code=
for setting in db.Settings(nil, 'CList') do
local message = string.format("%s/%s = ", 'CList', setting, ...)
.. db.GetSetting(nil, 'CList', setting)
print(message)
end
}}

=== WriteSetting ===
Сохраняет значение в БД
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}

=== DeleteSetting ===
Удаляет настройку
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
: '''''setting'''''
:: Тип: '''string'''
:: Название настройки
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}

=== DeleteModule ===
Удаляет секцию
;Параметры
: ''hContact''
:: Тип: '''number'''
:: Номер контакта или '''nil'''
: '''''module'''''
:: Тип: '''string'''
:: Название секции
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}

[[Category:Руководства]]

Plugin:MirLua/ru/m protocols

2017-09-04T20:00:54Z

Unsane: Created page with "{{PageLang|ru}} Предоставляет функционал для работы с протоколами. Подключение модуля: <code>local protos = requi..."

Plugin:MirLua/ru/m hotkeys

2017-09-02T18:26:36Z

Unsane: /* MakeHotkey */

{{PageLang|ru}}
Предоставляет функционал для работы с комбинациями клавиш.

Подключение модуля: <code>local hotkeys = require('m_hotkeys')</code>

{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}

__TOC__

== Функции ==
=== Register ===
Регистрирует комбинацию клавиш.
;Параметры
: '''''data'''''
:: Тип: '''table'''
:: Таблица [[#HotkeyItem|HotkeyItem]].
;Результат
: Тип: '''boolean'''
: Возвращает '''true''', если комбинация клавиш зарегистрирована, иначе '''false'''.
;Пример
{{Content:MirLua/Example|code=
local hIcon = hotkeys.Register({ Name = 'hkUniqueName' })
}}

=== Unregister ===
Удаляет комбинацию клавиш.
;Параметры
: '''''name'''''
:: Тип: '''string'''
:: Имя комбинации клавиш.
;Результат
: Тип: '''boolean'''
: Возвращает '''true''', если комбинация клавиш удалена, иначе '''false'''.
;Пример
{{Content:MirLua/Example|code=
hotkeys.Unregister('hkUniqueName')
}}

=== MakeHotkey ===
Создает комбинацию клавиш.
;Параметры
:'''''modifier'''''
::
{| class="wikitable"
!Тип
|'''number'''||'''string'''||'''table'''
|-
!Описание
|код клавиш-модификаторов
|название клавиши-модификатора
|список названий клавиш-модификаторов
|-
!Значения
|
*shift = 0x01
*control = 0x02
*alt = 0x04
*win = 0x08
|colspan="2"|
*ctrl
*shift
*alt
*ext
|}
: '''''key'''''
:: Тип: '''string'''
:: Символ.
;Результат
: Тип: '''number'''
: Возвращает комбинацию клавиш.
;Примеры
{{Content:MirLua/Example|code=
local HOTKEYF_SHIFT = 0x01
local HOTKEYF_ALT = 0x04
local hk = hotkeys.MakeHotkey(HOTKEYF_SHIFT {{!}} HOTKEYF_ALT, 'A')
}}
{{Content:MirLua/Example|code=
local hk = hotkeys.MakeHotkey('ctrl', 'A')
}}
{{Content:MirLua/Example|code=
local hk = hotkeys.MakeHotkey({ 'ctrl', 'alt' }, 'A')
}}

== Структуры ==
=== HotkeyItem ===
Таблица, описывающая параметры комбинации клавиш.
;Поля
: '''''Name'''''
:: Тип: '''string'''
:: Имя комбинации клавиш (автоматически переводится ядром).
: ''Description''
:: Тип: '''string'''
:: Описание комбинации клавиш (автоматически переводится ядром).
: ''Section''
:: Тип: '''string'''
:: Название секции для группировки в настройках. По умолчанию в качестве секции используется название плагина (''MirLua'').
: ''Hotkey''
:: Тип: '''number'''
:: [[Plugin:MirLua/ru/m_hotkeys#MakeHotkey|Комбинация клавиш]] по умолчанию.
: ''Service''
:: Тип: '''string'''
:: Имя [[Plugin:MirLua/ru/m_core#CreateServiceFunction|сервиса]].
: ''Flags''
:: Тип: '''number'''
:: Дополнительные флаги.

[[Category:Руководства]]

Plugin:MirLua/ru/m hotkeys

2017-09-02T18:23:54Z

Unsane: /* MakeHotkey */

{{PageLang|ru}}
Предоставляет функционал для работы с комбинациями клавиш.

Подключение модуля: <code>local hotkeys = require('m_hotkeys')</code>

{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}

__TOC__

== Функции ==
=== Register ===
Регистрирует комбинацию клавиш.
;Параметры
: '''''data'''''
:: Тип: '''table'''
:: Таблица [[#HotkeyItem|HotkeyItem]].
;Результат
: Тип: '''boolean'''
: Возвращает '''true''', если комбинация клавиш зарегистрирована, иначе '''false'''.
;Пример
{{Content:MirLua/Example|code=
local hIcon = hotkeys.Register({ Name = 'hkUniqueName' })
}}

=== Unregister ===
Удаляет комбинацию клавиш.
;Параметры
: '''''name'''''
:: Тип: '''string'''
:: Имя комбинации клавиш.
;Результат
: Тип: '''boolean'''
: Возвращает '''true''', если комбинация клавиш удалена, иначе '''false'''.
;Пример
{{Content:MirLua/Example|code=
hotkeys.Unregister('hkUniqueName')
}}

=== MakeHotkey ===
Создает комбинацию клавиш.
;Параметры
:'''''modifier'''''
::
{| class="wikitable"
!Тип
|'''number'''||'''string'''||'''table'''
|-
!Описание
|код клавиш-модификаторов||название клавиши-модификатора||список названий клавиш-модификаторов
|-
!Допустимые значения
|
*shift = 0x01
*control = 0x02
*alt = 0x04
*win = 0x08
|
*ctrl
*shift
*alt
*ext
|
*ctrl
*shift
*alt
*ext
|}
: '''''key'''''
:: Тип: '''string'''
:: Символ.
;Результат
: Тип: '''number'''
: Возвращает комбинацию клавиш.
;Примеры
{{Content:MirLua/Example|code=
local HOTKEYF_SHIFT = 0x01
local HOTKEYF_ALT = 0x04
local hk = hotkeys.MakeHotkey(HOTKEYF_SHIFT {{!}} HOTKEYF_ALT, 'A')
}}
{{Content:MirLua/Example|code=
local hk = hotkeys.MakeHotkey('ctrl', 'A')
}}
{{Content:MirLua/Example|code=
local hk = hotkeys.MakeHotkey({ 'ctrl', 'alt' }, 'A')
}}

== Структуры ==
=== HotkeyItem ===
Таблица, описывающая параметры комбинации клавиш.
;Поля
: '''''Name'''''
:: Тип: '''string'''
:: Имя комбинации клавиш (автоматически переводится ядром).
: ''Description''
:: Тип: '''string'''
:: Описание комбинации клавиш (автоматически переводится ядром).
: ''Section''
:: Тип: '''string'''
:: Название секции для группировки в настройках. По умолчанию в качестве секции используется название плагина (''MirLua'').
: ''Hotkey''
:: Тип: '''number'''
:: [[Plugin:MirLua/ru/m_hotkeys#MakeHotkey|Комбинация клавиш]] по умолчанию.
: ''Service''
:: Тип: '''string'''
:: Имя [[Plugin:MirLua/ru/m_core#CreateServiceFunction|сервиса]].
: ''Flags''
:: Тип: '''number'''
:: Дополнительные флаги.

[[Category:Руководства]]

Plugin:MirLua/ru/m hotkeys

2017-09-02T18:22:59Z

Unsane: /* MakeHotkey */

{{PageLang|ru}}
Предоставляет функционал для работы с комбинациями клавиш.

Подключение модуля: <code>local hotkeys = require('m_hotkeys')</code>

{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}

__TOC__

== Функции ==
=== Register ===
Регистрирует комбинацию клавиш.
;Параметры
: '''''data'''''
:: Тип: '''table'''
:: Таблица [[#HotkeyItem|HotkeyItem]].
;Результат
: Тип: '''boolean'''
: Возвращает '''true''', если комбинация клавиш зарегистрирована, иначе '''false'''.
;Пример
{{Content:MirLua/Example|code=
local hIcon = hotkeys.Register({ Name = 'hkUniqueName' })
}}

=== Unregister ===
Удаляет комбинацию клавиш.
;Параметры
: '''''name'''''
:: Тип: '''string'''
:: Имя комбинации клавиш.
;Результат
: Тип: '''boolean'''
: Возвращает '''true''', если комбинация клавиш удалена, иначе '''false'''.
;Пример
{{Content:MirLua/Example|code=
hotkeys.Unregister('hkUniqueName')
}}

=== MakeHotkey ===
Создает комбинацию клавиш.
;Параметры
:'''''modifier'''''
::
{| class="wikitable"
!Тип
|'''number'''||'''string'''||'''table'''
|-
!Описание
|код клавиш-модификаторов||название клавиши-модификатора||список названий клавиш-модификаторов
|-
!Допустимые значения
|
*shift = 0x01
*control = 0x02
*alt = 0x04
*win = 0x08
|
*'ctrl'
*'shift'
*'alt'
*'ext'
|
*'ctrl'
*'shift'
*'alt'
*'ext'
|}
: '''''key'''''
:: Тип: '''string'''
:: Символ.
;Результат
: Тип: '''number'''
: Возвращает комбинацию клавиш.
;Примеры
{{Content:MirLua/Example|code=
local HOTKEYF_SHIFT = 0x01
local HOTKEYF_ALT = 0x04
local hk = hotkeys.MakeHotkey(HOTKEYF_SHIFT {{!}} HOTKEYF_ALT, 'A')
}}
{{Content:MirLua/Example|code=
local hk = hotkeys.MakeHotkey('ctrl', 'A')
}}
{{Content:MirLua/Example|code=
local hk = hotkeys.MakeHotkey({ 'ctrl', 'alt' }, 'A')
}}

== Структуры ==
=== HotkeyItem ===
Таблица, описывающая параметры комбинации клавиш.
;Поля
: '''''Name'''''
:: Тип: '''string'''
:: Имя комбинации клавиш (автоматически переводится ядром).
: ''Description''
:: Тип: '''string'''
:: Описание комбинации клавиш (автоматически переводится ядром).
: ''Section''
:: Тип: '''string'''
:: Название секции для группировки в настройках. По умолчанию в качестве секции используется название плагина (''MirLua'').
: ''Hotkey''
:: Тип: '''number'''
:: [[Plugin:MirLua/ru/m_hotkeys#MakeHotkey|Комбинация клавиш]] по умолчанию.
: ''Service''
:: Тип: '''string'''
:: Имя [[Plugin:MirLua/ru/m_core#CreateServiceFunction|сервиса]].
: ''Flags''
:: Тип: '''number'''
:: Дополнительные флаги.

[[Category:Руководства]]

Plugin:MirLua/ru/m clist

2017-09-02T17:48:32Z

Unsane: Created page with "{{PageLang|ru}} Предоставляет функционал для работы с меню списка контактов. Подключение модуля: <code>lo..."

{{PageLang|ru}}
Предоставляет функционал для работы с меню списка контактов.

Подключение модуля: <code>local clist = require('m_clist')</code>

{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}

__TOC__

== Главное меню ==
=== AddMainMenuRoot ===
Создает корневой пункт в главном меню

;Параметры
: '''''name'''''
:: Тип: '''string'''
:: Название пункта меню
: ''position''
:: Тип: '''number'''
:: Позиция пункта меню
: ''hIcon''
:: Тип: '''light userdata'''
:: Дескриптор [[Plugin:MirLua/ru/m_icolib#AddIcon|значка]]
;Результат
: Тип: '''light userdata'''
: Возвращает дескриптор пункта меню в случае успеха, иначе '''nil'''
;Пример
{{Content:MirLua/Example|code=local hRootMenuItem = m.AddMainMenuRoot('My root menu item')}}

=== AddMainMenuItem ===
Создает пункт в главном меню

;Параметры
: '''''data'''''
:: Тип: '''table'''
:: Таблица [[Plugin:MirLua/ru/m_genmenu#MenuItem|MenuItem]]
;Результат
: Тип: '''light userdata'''
: Возвращает дескриптор пункта меню в случае успеха, иначе '''nil'''
;Пример
{{Content:MirLua/Example|code=local hMenuItem = m.AddMainMenuItem({ Name ='My menu item' })}}

== Меню контакта ==
=== AddContactMenuRoot ===
Создает корневой пункт в меню контакта

;Параметры
: '''''name'''''
:: Тип: '''string'''
:: Название пункта меню
: ''position''
:: Тип: '''number'''
:: Позиция пункта меню
: ''hIcon''
:: Тип: '''light userdata'''
:: Дескриптор [[Plugin:MirLua/ru/m_icolib#AddIcon|значка]]
;Результат
: Тип: '''light userdata'''
: Возвращает дескриптор пункта меню в случае успеха, иначе '''nil'''
;Пример
{{Content:MirLua/Example|code=local hRootMenuItem = m.AddContactMenuRoot('My contact menu item')}}

=== AddContactMenuItem ===
Создает пункт в меню контакта

;Параметры
: '''''data'''''
:: Тип: '''table'''
:: Таблица [[Plugin:MirLua/ru/m_genmenu#MenuItem|MenuItem]]

;Результат
: Тип: '''light userdata'''
: Возвращает дескриптор пункта меню в случае успеха, иначе '''nil'''
;Пример
{{Content:MirLua/Example|code=local hMenuItem = m.AddContactMenuItem ({ Name ='My menu item' })}}

== Меню трея ==
=== AddTrayMenuItem ===
Создает пункт в меню трея

;Параметры
: '''''data'''''
:: Тип: '''table'''
:: Таблица [[Plugin:MirLua/ru/m_genmenu#MenuItem|MenuItem]]
;Результат
: Тип: '''light userdata'''
: Возвращает дескриптор пункта меню в случае успеха, иначе '''nil'''
;Пример
{{Content:MirLua/Example|code=local hMenuItem = m.AddTrayMenuItem ({ Name ='My menu item' })}}

[[Category:Руководства]]

Plugin:MirLua/ru/m genmenu

2017-09-02T17:26:21Z

Unsane:

{{PageLang|ru}}
Предоставляет доступ к подсистеме меню.

Подключение модуля: <code>local genmenu = require('m_genmenu')</code>

{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}

__TOC__

== Функции ==


=== ModifyMenuItem ===
Изменяет пункт меню
;Параметры
: '''''hMenuItem'''''
:: Тип: '''light userdata'''
:: Дескриптор пункта меню
: '''''name'''''
:: Тип: '''string'''
:: Новое название пункта меню или '''nil'''
: '''''icon'''''
:: Тип: '''light userdata'''
:: Дескриптор [[Plugin:MirLua/ru/m_icolib#AddIcon|значка]] или ''[[Plugin:MirLua/ru/m_core#INVALID_HANDLE_VALUE|INVALID_HANDLE_VALUE]]''
: '''''flags'''''
:: Тип: '''number'''
:: Дополнительные флаги или ''-1''
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=local hMenuItem = genmenu.ModifyMenuItem(hMenuItem, 'New name', m.INVALID_HANDLE_VALUE)}}

=== ConfigureMenuItem ===
Дополнительная настройка пункта меню
;Параметры
: '''''hMenuItem'''''
:: Тип: '''light userdata'''
:: Дескриптор пункта меню
: '''''option'''''
:: Тип: ''''''number''''''
:: изменяемая настройка (1 - название; 2 - горячие клавиши; 3 - параметр для исполнения; 4 - UUID)
: '''''value'''''
:: Тип: '''light userdata'''
:: значение
;Результат
: Тип: '''light userdata'''
: Возвращает '''true''' случае успеха, иначе '''false'''

=== ShowMenuItem ===
Показывает/скрывает пункт меню
;Параметры
: '''''hMenuItem'''''
:: Тип: '''light userdata'''
:: Дескриптор пункта меню
: '''''isShown'''''
:: Тип: '''boolean'''
:: '''true''' для отображения пункта меню, '''false''' для скрытия
;Пример
{{Content:MirLua/Example|code=genmenu.ShowMenuItem(hMenuItem, true)}}

=== EnableMenuItem ===
Включает/отключает пункт меню
;Параметры
: '''''hMenuItem'''''
:: Тип: '''light userdata'''
:: Дескриптор пункта меню
: '''''isEnabled'''''
:: Тип: '''boolean'''
:: '''true''' для включения пункта меню, '''false''' для отключения
;Пример
{{Content:MirLua/Example|code=genmenu.EnableMenuItem(hMenuItem, false)}}

=== CheckMenuItem ===
Отмечает/снимает отметку с пункта меню
;Параметры
: '''''hMenuItem'''''
:: Тип: '''light userdata'''
:: Дескриптор пункта меню
: '''''isChecked'''''
:: Тип: '''boolean'''
:: '''true''' для включения пункта меню, '''false''' для отключения
;Пример
{{Content:MirLua/Example|code=genmenu.CheckMenuItem(hMenuItem, true)}}

=== RemoveMenuItem ===
Удаляет пункт меню
;Параметры
: '''''hMenuItem'''''
:: Тип: '''light userdata'''
:: Дескриптор пункта меню
;Результат
: Тип: '''boolean'''
: Возвращает '''true''' случае успеха, иначе '''false'''
;Пример
{{Content:MirLua/Example|code=genmenu.RemoveMenuItem(hMenuItem)}}

== Структуры ==
=== MenuItem ===
Таблица, описывающая параметры меню
;Поля
: '''''Name'''''
:: Тип: '''string'''
:: Название пункта меню (автоматически переводится ядром)
: ''Uid''
:: Тип: '''string'''
:: UUID пункта меню в формате ''xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx''
: ''Service''
:: Тип: '''string'''
:: Имя [[Plugin:MirLua/ru/m_core#CreateServiceFunction|сервиса]]
: ''Position''
:: Тип: '''number'''
:: Позиция пункта меню
: ''Parent''
:: Тип: '''light userdata'''
:: Дескриптор родительского меню
: ''Icon''
:: Тип: '''light userdata'''
:: Дескриптор [[Plugin:MirLua/ru/m_icolib#AddIcon|значка]]
: ''Flags''
:: Тип: '''number'''
:: Дополнительные флаги

[[Category:Руководства]]