https://wiki.miranda-ng.org/api.php?action=feedcontributions&user=Unsane&feedformat=atom
Miranda NG - User contributions [en]
2024-03-29T08:30:20Z
User contributions
MediaWiki 1.39.5
https://wiki.miranda-ng.org/index.php?title=User:Unsane/LuaParamsExample&diff=28770
User:Unsane/LuaParamsExample
2018-04-15T17:44:24Z
<p>Unsane: </p>
<hr />
<div>=== ModifyMenuItem ===<br />
Modifies menu item.<br />
;Parameters<br />
: '''''hMenuItem'''''<br />
:: Type: '''light userdata'''<br />
:: Menu item handle.<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: New menu item name or '''nil'''.<br />
: '''''icon'''''<br />
:: Type: '''light userdata'''<br />
:: [[Plugin:MirLua/en/m_icolib#AddIcon|Icon]] handle or ''[[Plugin:MirLua/en/m_core#INVALID_HANDLE_VALUE|INVALID_HANDLE_VALUE]]''<br />
: '''''flags'''''<br />
:: Type: '''number'''<br />
:: Additional flags or ''-1''<br />
;Result<br />
: Type: '''light userdata'''<br />
: If success, returns menu item handle, otherwise '''nil'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}<br />
<br />
<br />
<br />
=== ModifyMenuItemWithTable ===<br />
Modifies menu item.<br />
====Parameters====<br />
{| class="wikitable"<br />
!Name<br />
!Type<br />
!Description<br />
|-<br />
|'''''hMenuItem'''''(required)<br />
|'''light userdata'''<br />
|Menu item handle<br />
|-<br />
|name<br />
|'''string'''<br />
|New menu item name or '''nil'''<br />
|-<br />
|icon<br />
|'''light userdata'''<br />
|[[Plugin:MirLua/en/m_icolib#AddIcon|Icon]] handle or ''[[Plugin:MirLua/en/m_core#INVALID_HANDLE_VALUE|INVALID_HANDLE_VALUE]]''<br />
|-<br />
|flags<br />
|'''number'''<br />
|Additional flags or ''-1''<br />
|}<br />
<br />
====Result====<br />
: Type: '''light userdata'''<br />
: If success, returns menu item handle, otherwise '''nil'''<br />
====Example====<br />
{{Content:MirLua/Example|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=User:Unsane/LuaParamsExample&diff=28769
User:Unsane/LuaParamsExample
2018-04-15T17:42:48Z
<p>Unsane: /* Parameters */</p>
<hr />
<div>=== ModifyMenuItem ===<br />
Modifies menu item.<br />
;Parameters<br />
: '''''hMenuItem'''''<br />
:: Type: '''light userdata'''<br />
:: Menu item handle.<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: New menu item name or '''nil'''.<br />
: '''''icon'''''<br />
:: Type: '''light userdata'''<br />
:: [[Plugin:MirLua/en/m_icolib#AddIcon|Icon]] handle or ''[[Plugin:MirLua/en/m_core#INVALID_HANDLE_VALUE|INVALID_HANDLE_VALUE]]''<br />
: '''''flags'''''<br />
:: Type: '''number'''<br />
:: Additional flags or ''-1''<br />
;Result<br />
: Type: '''light userdata'''<br />
: If success, returns menu item handle, otherwise '''nil'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}<br />
<br />
=== ModifyMenuItemWithTable ===<br />
Modifies menu item.<br />
====Parameters====<br />
{| class="wikitable"<br />
!Name<br />
!Type<br />
!Description<br />
|-<br />
|'''''hMenuItem'''''(required)<br />
|'''light userdata'''<br />
|Menu item handle<br />
|-<br />
|name<br />
|'''string'''<br />
|New menu item name or '''nil'''<br />
|-<br />
|icon<br />
|'''light userdata'''<br />
|[[Plugin:MirLua/en/m_icolib#AddIcon|Icon]] handle or ''[[Plugin:MirLua/en/m_core#INVALID_HANDLE_VALUE|INVALID_HANDLE_VALUE]]''<br />
|-<br />
|flags<br />
|'''number'''<br />
|Additional flags or ''-1''<br />
|}<br />
<br />
====Result====<br />
: Type: '''light userdata'''<br />
: If success, returns menu item handle, otherwise '''nil'''<br />
====Example====<br />
{{Content:MirLua/Example|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=User:Unsane/LuaParamsExample&diff=28768
User:Unsane/LuaParamsExample
2018-04-15T17:36:11Z
<p>Unsane: </p>
<hr />
<div>=== ModifyMenuItem ===<br />
Modifies menu item.<br />
;Parameters<br />
: '''''hMenuItem'''''<br />
:: Type: '''light userdata'''<br />
:: Menu item handle.<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: New menu item name or '''nil'''.<br />
: '''''icon'''''<br />
:: Type: '''light userdata'''<br />
:: [[Plugin:MirLua/en/m_icolib#AddIcon|Icon]] handle or ''[[Plugin:MirLua/en/m_core#INVALID_HANDLE_VALUE|INVALID_HANDLE_VALUE]]''<br />
: '''''flags'''''<br />
:: Type: '''number'''<br />
:: Additional flags or ''-1''<br />
;Result<br />
: Type: '''light userdata'''<br />
: If success, returns menu item handle, otherwise '''nil'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}<br />
<br />
=== ModifyMenuItemWithTable ===<br />
Modifies menu item.<br />
====Parameters====<br />
{| class="wikitable"<br />
!Name<br />
!Type<br />
!Description<br />
|-<br />
|'''''hMenuItem'''''<br />
|'''light userdata'''<br />
|Menu item handle<br />
|-<br />
|'''''name'''''<br />
|'''string'''<br />
|New menu item name or '''nil'''<br />
|-<br />
|'''''icon'''''<br />
|'''light userdata'''<br />
|[[Plugin:MirLua/en/m_icolib#AddIcon|Icon]] handle or ''[[Plugin:MirLua/en/m_core#INVALID_HANDLE_VALUE|INVALID_HANDLE_VALUE]]''<br />
|-<br />
|'''''flags'''''<br />
|'''number'''<br />
|Additional flags or ''-1''<br />
|}<br />
====Result====<br />
: Type: '''light userdata'''<br />
: If success, returns menu item handle, otherwise '''nil'''<br />
====Example====<br />
{{Content:MirLua/Example|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=User:Unsane/LuaParamsExample&diff=28763
User:Unsane/LuaParamsExample
2018-04-15T17:12:07Z
<p>Unsane: Created page with "=== ModifyMenuItem === Modifies menu item. ;Parameters : '''''hMenuItem''''' :: Type: '''light userdata''' :: Menu item handle. : '''''name''''' :: Type: '''string''' :: New m..."</p>
<hr />
<div>=== ModifyMenuItem ===<br />
Modifies menu item.<br />
;Parameters<br />
: '''''hMenuItem'''''<br />
:: Type: '''light userdata'''<br />
:: Menu item handle.<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: New menu item name or '''nil'''.<br />
: '''''icon'''''<br />
:: Type: '''light userdata'''<br />
:: [[Plugin:MirLua/en/m_icolib#AddIcon|Icon]] handle or ''[[Plugin:MirLua/en/m_core#INVALID_HANDLE_VALUE|INVALID_HANDLE_VALUE]]''<br />
: '''''flags'''''<br />
:: Type: '''number'''<br />
:: Additional flags or ''-1''<br />
;Result<br />
: Type: '''light userdata'''<br />
: If success, returns menu item handle, otherwise '''nil'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}<br />
<br />
=== ModifyMenuItemWithTable ===<br />
Modifies menu item.<br />
;Parameters<br />
: '''''hMenuItem'''''<br />
:: Type: '''light userdata'''<br />
:: Menu item handle.<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: New menu item name or '''nil'''.<br />
: '''''icon'''''<br />
:: Type: '''light userdata'''<br />
:: [[Plugin:MirLua/en/m_icolib#AddIcon|Icon]] handle or ''[[Plugin:MirLua/en/m_core#INVALID_HANDLE_VALUE|INVALID_HANDLE_VALUE]]''<br />
: '''''flags'''''<br />
:: Type: '''number'''<br />
:: Additional flags or ''-1''<br />
;Result<br />
: Type: '''light userdata'''<br />
: If success, returns menu item handle, otherwise '''nil'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/Module/m_sounds/ru&diff=28580
Plugin:MirLua/Module/m sounds/ru
2018-04-13T22:22:33Z
<p>Unsane: Created page with "Тип: $type_string_required"</p>
<hr />
<div><languages/><br />
Allows you to work with sounds.<br />
<br />
Include module: <code>local sounds = require('m_sounds')</code><br />
<br />
{{Note|Parameters written in '''''bold italics''''' are obligatory.}}<br />
<br />
<br />
__TOC__<br />
<br />
=== AddSound ===<br />
Registers a sound.<br />
;Parameters<br />
: '''''name'''''<br />
:: Тип: '''string'''<br />
:: Unique name.<br />
: '''''description'''''<br />
:: Type: '''string'''<br />
:: Description.<br />
: ''section''<br />
:: Type: '''string'''<br />
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.<br />
: ''path''<br />
:: Type: '''string'''<br />
:: Path to sound file.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was registered successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}<br />
<br />
<br />
=== PlaySound ===<br />
Plays sound by its unique name.<br />
<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Unique name.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was played successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}<br />
<br />
<br />
=== PlayFile ===<br />
Plays sound from file.<br />
<br />
;Parameters<br />
: '''''path'''''<br />
:: Type: '''string'''<br />
:: Path to file.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was played successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}<br />
<br />
[[Category:Tutorials (en)]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/Module/m_sounds&diff=28577
Plugin:MirLua/Module/m sounds
2018-04-13T22:20:53Z
<p>Unsane: </p>
<hr />
<div><languages/><br />
<translate><br />
<!--T:1--><br />
Allows you to work with sounds.<br />
</translate><br />
<br />
<translate><!--T:2--> Include module:</translate> <code>local sounds = require('m_sounds')</code><br />
<br />
{{Note|Parameters written in '''''bold italics''''' are obligatory.}}<br />
<br />
<br />
__TOC__<br />
<br />
=== AddSound ===<br />
<translate><br />
<!--T:3--><br />
Registers a sound.<br />
</translate><br />
;Parameters<br />
: '''''name'''''<br />
:: <br />
<translate><br />
<!--T:4--><br />
Type: <tvar|type_string_required>'''string'''</><br />
</translate><br />
:: <translate><!--T:5--> Unique name.</translate><br />
: '''''description'''''<br />
:: Type: '''string'''<br />
:: Description.<br />
: ''section''<br />
:: Type: '''string'''<br />
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.<br />
: ''path''<br />
:: Type: '''string'''<br />
:: Path to sound file.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was registered successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}<br />
<br />
<br />
=== PlaySound ===<br />
Plays sound by its unique name.<br />
<br />
;Parameters<br />
: '''''name'''''<br />
:: <br />
<translate><br />
<!--T:6--><br />
Type: <tvar|type_string_required>'''string'''</><br />
</translate><br />
:: Unique name.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was played successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}<br />
<br />
<br />
=== PlayFile ===<br />
Plays sound from file.<br />
<br />
;Parameters<br />
: '''''path'''''<br />
:: Type: '''string'''<br />
:: Path to file.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was played successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}<br />
<br />
[[Category:Tutorials (en)]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/Module/m_sounds&diff=28571
Plugin:MirLua/Module/m sounds
2018-04-13T22:19:34Z
<p>Unsane: </p>
<hr />
<div><languages/><br />
<translate><br />
<!--T:1--><br />
Allows you to work with sounds.<br />
</translate><br />
<br />
<translate><!--T:2--> Include module:</translate> <code>local sounds = require('m_sounds')</code><br />
<br />
{{Note|Parameters written in '''''bold italics''''' are obligatory.}}<br />
<br />
<br />
__TOC__<br />
<br />
=== AddSound ===<br />
<translate><br />
Registers a sound.<br />
</translate><br />
;Parameters<br />
: '''''name'''''<br />
:: <translate><br />
Type: <tvar|type_string_required>'''string'''</><br />
</translate><br />
:: <translate>Unique name.</translate><br />
: '''''description'''''<br />
:: Type: '''string'''<br />
:: Description.<br />
: ''section''<br />
:: Type: '''string'''<br />
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.<br />
: ''path''<br />
:: Type: '''string'''<br />
:: Path to sound file.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was registered successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}<br />
<br />
<br />
=== PlaySound ===<br />
Plays sound by its unique name.<br />
<br />
;Parameters<br />
: '''''name'''''<br />
:: <translate><br />
Type: <tvar|type_string_required>'''string'''</><br />
</translate><br />
:: Unique name.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was played successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}<br />
<br />
<br />
=== PlayFile ===<br />
Plays sound from file.<br />
<br />
;Parameters<br />
: '''''path'''''<br />
:: Type: '''string'''<br />
:: Path to file.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was played successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}<br />
<br />
[[Category:Tutorials (en)]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/Module/m_sounds&diff=28570
Plugin:MirLua/Module/m sounds
2018-04-13T22:19:10Z
<p>Unsane: </p>
<hr />
<div><languages/><br />
<translate><br />
<!--T:1--><br />
Allows you to work with sounds.<br />
</translate><br />
<br />
<translate><!--T:2--> Include module:</translate> <code>local sounds = require('m_sounds')</code><br />
<br />
{{Note|Parameters written in '''''bold italics''''' are obligatory.}}<br />
<br />
<br />
__TOC__<br />
<br />
=== AddSound ===<br />
<translate><br />
Registers a sound.<br />
</translate><br />
;Parameters<br />
: '''''name'''''<br />
:: <translate><br />
Type: <tvar|type_string_required>'''string'''</tvar><br />
</translate><br />
:: <translate>Unique name.</translate><br />
: '''''description'''''<br />
:: Type: '''string'''<br />
:: Description.<br />
: ''section''<br />
:: Type: '''string'''<br />
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.<br />
: ''path''<br />
:: Type: '''string'''<br />
:: Path to sound file.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was registered successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}<br />
<br />
<br />
=== PlaySound ===<br />
Plays sound by its unique name.<br />
<br />
;Parameters<br />
: '''''name'''''<br />
:: <translate><br />
Type: <tvar|type_string_required>'''string'''</tvar><br />
</translate><br />
:: Unique name.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was played successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}<br />
<br />
<br />
=== PlayFile ===<br />
Plays sound from file.<br />
<br />
;Parameters<br />
: '''''path'''''<br />
:: Type: '''string'''<br />
:: Path to file.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was played successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}<br />
<br />
[[Category:Tutorials (en)]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/Module/m_sounds&diff=28569
Plugin:MirLua/Module/m sounds
2018-04-13T22:16:07Z
<p>Unsane: </p>
<hr />
<div><languages/><br />
<translate><br />
<!--T:1--><br />
Allows you to work with sounds.<br />
</translate><br />
<br />
<translate><!--T:2--> Include module:</translate> <code>local sounds = require('m_sounds')</code><br />
<br />
{{Note|Parameters written in '''''bold italics''''' are obligatory.}}<br />
<br />
<br />
__TOC__<br />
<br />
=== AddSound ===<br />
<translate><br />
Registers a sound.<br />
</translate><br />
;Parameters<br />
: '''''name'''''<br />
:: <translate>Type:</translate> '''string'''<br />
:: <translate>Unique name.</translate><br />
: '''''description'''''<br />
:: Type: '''string'''<br />
:: Description.<br />
: ''section''<br />
:: Type: '''string'''<br />
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.<br />
: ''path''<br />
:: Type: '''string'''<br />
:: Path to sound file.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was registered successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}<br />
<br />
<br />
=== PlaySound ===<br />
Plays sound by its unique name.<br />
<br />
;Parameters<br />
: '''''name'''''<br />
:: <translate>Type:</translate> '''string'''<br />
:: Unique name.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was played successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}<br />
<br />
<br />
=== PlayFile ===<br />
Plays sound from file.<br />
<br />
;Parameters<br />
: '''''path'''''<br />
:: Type: '''string'''<br />
:: Path to file.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was played successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}<br />
<br />
[[Category:Tutorials (en)]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/Module/m_sounds&diff=28564
Plugin:MirLua/Module/m sounds
2018-04-13T22:02:31Z
<p>Unsane: </p>
<hr />
<div><languages/><br />
<translate><br />
Allows you to work with sounds.<br />
</translate><br />
<br />
<translate>Include module:</translate> <code>local sounds = require('m_sounds')</code><br />
<br />
{{Note|Parameters written in '''''bold italics''''' are obligatory.}}<br />
<br />
<br />
__TOC__<br />
<br />
=== AddSound ===<br />
Registers a sound.<br />
<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Unique name.<br />
: '''''description'''''<br />
:: Type: '''string'''<br />
:: Description.<br />
: ''section''<br />
:: Type: '''string'''<br />
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.<br />
: ''path''<br />
:: Type: '''string'''<br />
:: Path to sound file.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was registered successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}<br />
<br />
<br />
=== PlaySound ===<br />
Plays sound by its unique name.<br />
<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Unique name.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was played successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}<br />
<br />
<br />
=== PlayFile ===<br />
Plays sound from file.<br />
<br />
;Parameters<br />
: '''''path'''''<br />
:: Type: '''string'''<br />
:: Path to file.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was played successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}<br />
<br />
[[Category:Tutorials (en)]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/Module/m_sounds&diff=28563
Plugin:MirLua/Module/m sounds
2018-04-13T22:01:08Z
<p>Unsane: </p>
<hr />
<div><languages/>{{PageLang|en}}<br />
<translate><br />
Allows you to work with sounds.<br />
</translate><br />
<br />
Include module: <code>local sounds = require('m_sounds')</code><br />
<br />
{{Note|Parameters written in '''''bold italics''''' are obligatory.}}<br />
<br />
<br />
__TOC__<br />
<br />
=== AddSound ===<br />
Registers a sound.<br />
<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Unique name.<br />
: '''''description'''''<br />
:: Type: '''string'''<br />
:: Description.<br />
: ''section''<br />
:: Type: '''string'''<br />
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.<br />
: ''path''<br />
:: Type: '''string'''<br />
:: Path to sound file.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was registered successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}<br />
<br />
<br />
=== PlaySound ===<br />
Plays sound by its unique name.<br />
<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Unique name.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was played successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}<br />
<br />
<br />
=== PlayFile ===<br />
Plays sound from file.<br />
<br />
;Parameters<br />
: '''''path'''''<br />
:: Type: '''string'''<br />
:: Path to file.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was played successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}<br />
<br />
[[Category:Tutorials (en)]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/en/m_sounds&diff=28562
Plugin:MirLua/en/m sounds
2018-04-13T21:58:53Z
<p>Unsane: Unsane moved page Plugin:MirLua/en/m sounds to Plugin:MirLua/m sounds: for translate</p>
<hr />
<div>#REDIRECT [[Plugin:MirLua/m sounds]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/Module/m_sounds&diff=28561
Plugin:MirLua/Module/m sounds
2018-04-13T21:58:53Z
<p>Unsane: Unsane moved page Plugin:MirLua/en/m sounds to Plugin:MirLua/m sounds: for translate</p>
<hr />
<div>{{PageLang|en}}<br />
Allows you to work with sounds.<br />
<br />
Include module: <code>local sounds = require('m_sounds')</code><br />
<br />
{{Note|Parameters written in '''''bold italics''''' are obligatory.}}<br />
<br />
<br />
__TOC__<br />
<br />
=== AddSound ===<br />
Registers a sound.<br />
<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Unique name.<br />
: '''''description'''''<br />
:: Type: '''string'''<br />
:: Description.<br />
: ''section''<br />
:: Type: '''string'''<br />
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.<br />
: ''path''<br />
:: Type: '''string'''<br />
:: Path to sound file.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was registered successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}<br />
<br />
<br />
=== PlaySound ===<br />
Plays sound by its unique name.<br />
<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Unique name.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was played successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}<br />
<br />
<br />
=== PlayFile ===<br />
Plays sound from file.<br />
<br />
;Parameters<br />
: '''''path'''''<br />
:: Type: '''string'''<br />
:: Path to file.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if sound was played successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}<br />
<br />
[[Category:Tutorials (en)]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/Module/m_core&diff=28560
Plugin:MirLua/Module/m core
2018-04-13T21:53:43Z
<p>Unsane: /* CreateHookableEvent */</p>
<hr />
<div>{{PageLang|en}}<br />
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.<br />
<br />
{{Note|Parameters written in '''''bold italics''''' are obligatory.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Constants ==<br />
=== NULL ===<br />
Null pointer.<br />
: Type: '''light userdata'''<br />
<br />
=== INVALID_HANDLE_VALUE ===<br />
Invalid handle.<br />
: Type: '''light userdata'''<br />
<br />
=== CALLSERVICE_NOTFOUND ===<br />
Result of service call when service does not exist.<br />
: Type: '''number'''<br />
<br />
<br />
== Named events ==<br />
=== CreateHookableEvent ===<br />
Creates a hookable event.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Event name.<br />
;Result<br />
: Type: '''light userdata'''<br />
: Returns event handle if event was created successfully, otherwise '''nil'''.<br />
;Example<br />
<pre style="overflow:auto;"><br />
local hEvent = m.CreateHookableEvent('MyEvent')<br />
if hEvent == m.NULL then<br />
print('Event handle is empty!')<br />
end<br />
</pre><br />
<br />
=== HookEvent ===<br />
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.<br />
<br />
Hook signature: <code>function (wParam, lParam) return 0 end</code>.<br />
<br />
Correct result for a hook is 0. When 1 is returned, the following hooks in a sequence won't be called.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Event name.<br />
: '''''hook'''''<br />
:: Type: '''function'''<br />
:: Hook function to be called when event occurs.<br />
;Result<br />
: Type: '''light userdata'''<br />
: Returns hook handle if hook was created successfully, otherwise '''nil'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hHook = m.HookEvent('MyEvent', function(w, l)<br />
print('MyEvent is raised!')<br />
end)<br />
}}<br />
<br />
=== UnhookEvent ===<br />
Removes hook from event call sequence.<br />
;Parameters<br />
: '''''hEvent'''''<br />
:: Type: '''light userdata'''<br />
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if hook function was removed successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=m.UnhookEvent(hHook)}}<br />
<br />
=== NotifyEventHooks ===<br />
Calls all hooks of event call sequence one by one.<br />
;Parameters<br />
: '''''hEvent'''''<br />
:: Type: '''light userdata'''<br />
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.<br />
: ''wParam''<br />
: ''lParam''<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if all hooks were called, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=m.NotifyEventHooks(hEvent)}}<br />
<br />
<br />
== Named service functions ==<br />
=== CreateServiceFunction ===<br />
Creates a service function ("service")<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Service name.<br />
;Result<br />
: Type: '''light userdata'''<br />
: Returns service handle if service was created successfully, otherwise '''nil'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hService = m.CreateServiceFunction('MyService', function(w, l)<br />
print('MyServiceis called!')<br />
end)<br />
}}<br />
<br />
=== CallService ===<br />
Calls service with parameters.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Service name.<br />
: ''wParam''<br />
: ''lParam''<br />
;Result<br />
: Type: '''number'''<br />
: Returns result of service execution or [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]<br />
;Example<br />
{{Content:MirLua/Example|code=<br />
local result = m.CallService('MyService')<br />
if result == m.CALLSERVICE_NOTFOUND then<br />
print('Service is not found!')<br />
end<br />
}}<br />
<br />
=== ServiceExists ===<br />
Checks if service exists by its name.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Service name.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if service exists, otherwise '''false'''<br />
;Example<br />
{{Content:MirLua/Example|code=if m.ServiceExists('MyService') then<br />
m.CallService('MyService')<br />
end}}<br />
<br />
=== DestroyServiceFunction ===<br />
Destroys a service function.<br />
;Parameters<br />
: '''''hService'''''<br />
:: Type: '''light userdata'''<br />
:: Service handle received on [[#CreateServiceFunction|CreateServiceFunction]] call.<br />
;Example<br />
{{Content:MirLua/Example|code=m.DestroyServiceFunction(hService)}}<br />
<br />
<br />
== Others ==<br />
=== IsPluginLoaded ===<br />
Checks if plugin is loaded by its UUID.<br />
;Parameters<br />
: '''''uuid'''''<br />
:: Type: '''string'''<br />
:: Plugin UUID in format ''xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx''.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if plugin is loaded, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=if m.IsPluginLoaded('{F0FDF73A-753D-499d-8DBA-336DB79CDD41}') then<br />
print('Advanced auto away plugin is loaded!')<br />
end<br />
}}<br />
<br />
=== Translate ===<br />
Translates a string into the language of the current langpack.<br />
: '''''text'''''<br />
:: Type: '''string'''<br />
;Result<br />
: Type: '''string'''<br />
;Example<br />
{{Content:MirLua/Example|code=m.Translate('Exit')}}<br />
<br />
=== Parse ===<br />
Replaces Miranda NG variables in a string.<br />
: '''''text'''''<br />
;Result<br />
: Type: '''string'''<br />
;Example<br />
{{Content:MirLua/Example|code=local profileName = m.ReplaceVariables('%miranda_profilename%')}}<br />
<br />
[[Category:Tutorials (en)]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/Module/m_core&diff=28559
Plugin:MirLua/Module/m core
2018-04-13T21:50:16Z
<p>Unsane: /* ReplaceVariables */</p>
<hr />
<div>{{PageLang|en}}<br />
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.<br />
<br />
{{Note|Parameters written in '''''bold italics''''' are obligatory.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Constants ==<br />
=== NULL ===<br />
Null pointer.<br />
: Type: '''light userdata'''<br />
<br />
=== INVALID_HANDLE_VALUE ===<br />
Invalid handle.<br />
: Type: '''light userdata'''<br />
<br />
=== CALLSERVICE_NOTFOUND ===<br />
Result of service call when service does not exist.<br />
: Type: '''number'''<br />
<br />
<br />
== Named events ==<br />
=== CreateHookableEvent ===<br />
Creates a hookable event.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Event name.<br />
;Result<br />
: Type: '''light userdata'''<br />
: Returns event handle if event was created successfully, otherwise '''nil'''.<br />
;Example<br />
{{Content:MirLua/Example|code=<br />
local hEvent = m.CreateHookableEvent('MyEvent')<br />
if hEvent == m.NULL then<br />
print('Event handle is empty!')<br />
end<br />
}}<br />
<br />
=== HookEvent ===<br />
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.<br />
<br />
Hook signature: <code>function (wParam, lParam) return 0 end</code>.<br />
<br />
Correct result for a hook is 0. When 1 is returned, the following hooks in a sequence won't be called.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Event name.<br />
: '''''hook'''''<br />
:: Type: '''function'''<br />
:: Hook function to be called when event occurs.<br />
;Result<br />
: Type: '''light userdata'''<br />
: Returns hook handle if hook was created successfully, otherwise '''nil'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hHook = m.HookEvent('MyEvent', function(w, l)<br />
print('MyEvent is raised!')<br />
end)<br />
}}<br />
<br />
=== UnhookEvent ===<br />
Removes hook from event call sequence.<br />
;Parameters<br />
: '''''hEvent'''''<br />
:: Type: '''light userdata'''<br />
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if hook function was removed successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=m.UnhookEvent(hHook)}}<br />
<br />
=== NotifyEventHooks ===<br />
Calls all hooks of event call sequence one by one.<br />
;Parameters<br />
: '''''hEvent'''''<br />
:: Type: '''light userdata'''<br />
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.<br />
: ''wParam''<br />
: ''lParam''<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if all hooks were called, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=m.NotifyEventHooks(hEvent)}}<br />
<br />
<br />
== Named service functions ==<br />
=== CreateServiceFunction ===<br />
Creates a service function ("service")<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Service name.<br />
;Result<br />
: Type: '''light userdata'''<br />
: Returns service handle if service was created successfully, otherwise '''nil'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hService = m.CreateServiceFunction('MyService', function(w, l)<br />
print('MyServiceis called!')<br />
end)<br />
}}<br />
<br />
=== CallService ===<br />
Calls service with parameters.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Service name.<br />
: ''wParam''<br />
: ''lParam''<br />
;Result<br />
: Type: '''number'''<br />
: Returns result of service execution or [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]<br />
;Example<br />
{{Content:MirLua/Example|code=<br />
local result = m.CallService('MyService')<br />
if result == m.CALLSERVICE_NOTFOUND then<br />
print('Service is not found!')<br />
end<br />
}}<br />
<br />
=== ServiceExists ===<br />
Checks if service exists by its name.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Service name.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if service exists, otherwise '''false'''<br />
;Example<br />
{{Content:MirLua/Example|code=if m.ServiceExists('MyService') then<br />
m.CallService('MyService')<br />
end}}<br />
<br />
=== DestroyServiceFunction ===<br />
Destroys a service function.<br />
;Parameters<br />
: '''''hService'''''<br />
:: Type: '''light userdata'''<br />
:: Service handle received on [[#CreateServiceFunction|CreateServiceFunction]] call.<br />
;Example<br />
{{Content:MirLua/Example|code=m.DestroyServiceFunction(hService)}}<br />
<br />
<br />
== Others ==<br />
=== IsPluginLoaded ===<br />
Checks if plugin is loaded by its UUID.<br />
;Parameters<br />
: '''''uuid'''''<br />
:: Type: '''string'''<br />
:: Plugin UUID in format ''xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx''.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if plugin is loaded, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=if m.IsPluginLoaded('{F0FDF73A-753D-499d-8DBA-336DB79CDD41}') then<br />
print('Advanced auto away plugin is loaded!')<br />
end<br />
}}<br />
<br />
=== Translate ===<br />
Translates a string into the language of the current langpack.<br />
: '''''text'''''<br />
:: Type: '''string'''<br />
;Result<br />
: Type: '''string'''<br />
;Example<br />
{{Content:MirLua/Example|code=m.Translate('Exit')}}<br />
<br />
=== Parse ===<br />
Replaces Miranda NG variables in a string.<br />
: '''''text'''''<br />
;Result<br />
: Type: '''string'''<br />
;Example<br />
{{Content:MirLua/Example|code=local profileName = m.ReplaceVariables('%miranda_profilename%')}}<br />
<br />
[[Category:Tutorials (en)]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/Module/m_core&diff=28558
Plugin:MirLua/Module/m core
2018-04-13T21:49:24Z
<p>Unsane: </p>
<hr />
<div>{{PageLang|en}}<br />
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.<br />
<br />
{{Note|Parameters written in '''''bold italics''''' are obligatory.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Constants ==<br />
=== NULL ===<br />
Null pointer.<br />
: Type: '''light userdata'''<br />
<br />
=== INVALID_HANDLE_VALUE ===<br />
Invalid handle.<br />
: Type: '''light userdata'''<br />
<br />
=== CALLSERVICE_NOTFOUND ===<br />
Result of service call when service does not exist.<br />
: Type: '''number'''<br />
<br />
<br />
== Named events ==<br />
=== CreateHookableEvent ===<br />
Creates a hookable event.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Event name.<br />
;Result<br />
: Type: '''light userdata'''<br />
: Returns event handle if event was created successfully, otherwise '''nil'''.<br />
;Example<br />
{{Content:MirLua/Example|code=<br />
local hEvent = m.CreateHookableEvent('MyEvent')<br />
if hEvent == m.NULL then<br />
print('Event handle is empty!')<br />
end<br />
}}<br />
<br />
=== HookEvent ===<br />
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.<br />
<br />
Hook signature: <code>function (wParam, lParam) return 0 end</code>.<br />
<br />
Correct result for a hook is 0. When 1 is returned, the following hooks in a sequence won't be called.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Event name.<br />
: '''''hook'''''<br />
:: Type: '''function'''<br />
:: Hook function to be called when event occurs.<br />
;Result<br />
: Type: '''light userdata'''<br />
: Returns hook handle if hook was created successfully, otherwise '''nil'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hHook = m.HookEvent('MyEvent', function(w, l)<br />
print('MyEvent is raised!')<br />
end)<br />
}}<br />
<br />
=== UnhookEvent ===<br />
Removes hook from event call sequence.<br />
;Parameters<br />
: '''''hEvent'''''<br />
:: Type: '''light userdata'''<br />
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if hook function was removed successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=m.UnhookEvent(hHook)}}<br />
<br />
=== NotifyEventHooks ===<br />
Calls all hooks of event call sequence one by one.<br />
;Parameters<br />
: '''''hEvent'''''<br />
:: Type: '''light userdata'''<br />
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.<br />
: ''wParam''<br />
: ''lParam''<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if all hooks were called, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=m.NotifyEventHooks(hEvent)}}<br />
<br />
<br />
== Named service functions ==<br />
=== CreateServiceFunction ===<br />
Creates a service function ("service")<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Service name.<br />
;Result<br />
: Type: '''light userdata'''<br />
: Returns service handle if service was created successfully, otherwise '''nil'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hService = m.CreateServiceFunction('MyService', function(w, l)<br />
print('MyServiceis called!')<br />
end)<br />
}}<br />
<br />
=== CallService ===<br />
Calls service with parameters.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Service name.<br />
: ''wParam''<br />
: ''lParam''<br />
;Result<br />
: Type: '''number'''<br />
: Returns result of service execution or [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]<br />
;Example<br />
{{Content:MirLua/Example|code=<br />
local result = m.CallService('MyService')<br />
if result == m.CALLSERVICE_NOTFOUND then<br />
print('Service is not found!')<br />
end<br />
}}<br />
<br />
=== ServiceExists ===<br />
Checks if service exists by its name.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Service name.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if service exists, otherwise '''false'''<br />
;Example<br />
{{Content:MirLua/Example|code=if m.ServiceExists('MyService') then<br />
m.CallService('MyService')<br />
end}}<br />
<br />
=== DestroyServiceFunction ===<br />
Destroys a service function.<br />
;Parameters<br />
: '''''hService'''''<br />
:: Type: '''light userdata'''<br />
:: Service handle received on [[#CreateServiceFunction|CreateServiceFunction]] call.<br />
;Example<br />
{{Content:MirLua/Example|code=m.DestroyServiceFunction(hService)}}<br />
<br />
<br />
== Others ==<br />
=== IsPluginLoaded ===<br />
Checks if plugin is loaded by its UUID.<br />
;Parameters<br />
: '''''uuid'''''<br />
:: Type: '''string'''<br />
:: Plugin UUID in format ''xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx''.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if plugin is loaded, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=if m.IsPluginLoaded('{F0FDF73A-753D-499d-8DBA-336DB79CDD41}') then<br />
print('Advanced auto away plugin is loaded!')<br />
end<br />
}}<br />
<br />
=== Translate ===<br />
Translates a string into the language of the current langpack.<br />
: '''''text'''''<br />
:: Type: '''string'''<br />
;Result<br />
: Type: '''string'''<br />
;Example<br />
{{Content:MirLua/Example|code=m.Translate('Exit')}}<br />
<br />
=== ReplaceVariables ===<br />
Replaces Miranda NG variables in a string.<br />
: '''''text'''''<br />
;Result<br />
: Type: '''string'''<br />
;Example<br />
{{Content:MirLua/Example|code=local profileName = m.ReplaceVariables('%miranda_profilename%')}}<br />
<br />
[[Category:Tutorials (en)]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru&diff=28557
Plugin:MirLua/ru
2018-04-13T21:45:51Z
<p>Unsane: Created page with "Обеспечивает более читаемый и удобный синтаксис для форматирования вывода строки."</p>
<hr />
<div><languages/>{{PluginCard}}<br />
Расширяет функциональность Miranda NG с помощью скриптов на языке Lua.<br />
<br />
== Lua ==<br />
Плагин использует Lua 5.3.4, поставляемый в виде библиотеки lua53.dll.<br />
<br />
== Дополнительные возможности ==<br />
<br />
=== toansi ===<br />
Перекодирует строку из utf-8 в ansi. Полезен, когда требуется передать строку в качестве параметра ansi-функции.<br />
<br />
<code>m.CallService('mRadio/Import', 0, toansi(m.Parse('%miranda_path%\\Plugins\\mradio.ini')))</code><br />
<br />
Имеет краткую версию '''a'''.<br />
<br />
<code>m.CallService('DB/Ini/ImportFile', 0, a'import\\autoexec.ini')</code><br />
<br />
=== toucs2 ===<br />
Аналогичен '''toansi''', но предназначен для utf-16. Тоже имеет краткую версию - '''u'''.<br />
<br />
=== tonumber ===<br />
If it receives '''light userdata''' parameter then returns it address as number, otherwise uses standard lua '''tonumber''' behavior. <br />
<br />
=== topointer ===<br />
Преобразует lua-типы '''bool''', '''number''', '''string''' в '''light userdata'''.<br />
<br />
=== string.interpolate ===<br />
Обеспечивает более читаемый и удобный синтаксис для форматирования вывода строки.<br />
<br />
<code><br />
local h = 'Hello'<br />
print('{h}, {w}!' % {w = 'World'})<br />
</code><br />
<br />
== Модули ==<br />
<br />
* EN<br />
** [[Plugin:MirLua/en/m_core|m_core]]<br />
** [[Plugin:MirLua/en/m_database|m_database]]<br />
** [[Plugin:MirLua/en/m_genmenu|m_genmenu]]<br />
** [[Plugin:MirLua/en/m_hotkeys|m_hotkeys]]<br />
** [[Plugin:MirLua/en/m_icolib|m_icolib]]<br />
** [[Plugin:MirLua/en/m_sounds|m_sounds]]<br />
<br />
* RU<br />
** [[Plugin:MirLua/ru/m_clist|m_clist]]<br />
** [[Plugin:MirLua/ru/m_core|m_core]]<br />
** [[Plugin:MirLua/ru/m_database|m_database]]<br />
** [[Plugin:MirLua/ru/m_genmenu|m_genmenu]]<br />
** [[Plugin:MirLua/ru/m_hotkeys|m_hotkeys]]<br />
** [[Plugin:MirLua/ru/m_icolib|m_icolib]]<br />
** [[Plugin:MirLua/ru/m_sounds|m_sounds]]<br />
<br />
== Примеры ==<br />
<br />
{{Content:MirLua/Examples}}<br />
<br />
== Ссылки ==<br />
<br />
* [https://forum.miranda-ng.org/index.php?topic=4161.0 Примеры скриптов в теме на форуме]{{RefLang|ru}}<br />
* [https://www.lua.org Веб-сайт Lua]<br />
* [[wikipedia:en:Lua_(programming_language)|Lua в Википедии]]<br />
<br />
{{PluginGroups}}</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Translations:Plugin:MirLua/15/ru&diff=28556
Translations:Plugin:MirLua/15/ru
2018-04-13T21:45:51Z
<p>Unsane: Created page with "Обеспечивает более читаемый и удобный синтаксис для форматирования вывода строки."</p>
<hr />
<div>Обеспечивает более читаемый и удобный синтаксис для форматирования вывода строки.</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/Module/m_core&diff=27785
Plugin:MirLua/Module/m core
2018-04-05T18:43:01Z
<p>Unsane: </p>
<hr />
<div>{{PageLang|en}}<br />
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.<br />
<br />
{{Note|Parameters written in '''''bold italics''''' are obligatory.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Constants ==<br />
=== NULL ===<br />
Null pointer.<br />
: Type: '''light userdata'''<br />
<br />
=== INVALID_HANDLE_VALUE ===<br />
Invalid handle.<br />
: Type: '''light userdata'''<br />
<br />
=== CALLSERVICE_NOTFOUND ===<br />
Result of service call when service does not exist.<br />
: Type: '''number'''<br />
<br />
<br />
== Named events ==<br />
=== CreateHookableEvent ===<br />
Creates a hookable event.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Event name.<br />
;Result<br />
: Type: '''light userdata'''<br />
: Returns event handle if event was created successfully, otherwise '''nil'''.<br />
;Example<br />
{{Content:MirLua/Example|code=<br />
local hEvent = m.CreateHookableEvent('MyEvent')<br />
if hEvent == m.NULL then<br />
print('Event handle is empty!')<br />
end<br />
}}<br />
<br />
=== HookEvent ===<br />
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.<br />
<br />
Hook signature: <code>function (wParam, lParam) return 0 end</code>.<br />
<br />
Correct result for a hook is 0. When 1 is returned, the following hooks in a sequence won't be called.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Event name.<br />
: '''''hook'''''<br />
:: Type: '''function'''<br />
:: Hook function to be called when event occurs.<br />
;Result<br />
: Type: '''light userdata'''<br />
: Returns hook handle if hook was created successfully, otherwise '''nil'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hHook = m.HookEvent('MyEvent', function(w, l)<br />
print('MyEvent is raised!')<br />
end)<br />
}}<br />
<br />
=== UnhookEvent ===<br />
Removes hook from event call sequence.<br />
;Parameters<br />
: '''''hEvent'''''<br />
:: Type: '''light userdata'''<br />
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if hook function was removed successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=m.UnhookEvent(hHook)}}<br />
<br />
=== NotifyEventHooks ===<br />
Calls all hooks of event call sequence one by one.<br />
;Parameters<br />
: '''''hEvent'''''<br />
:: Type: '''light userdata'''<br />
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.<br />
: ''wParam''<br />
: ''lParam''<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if all hooks were called, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=m.NotifyEventHooks(hEvent)}}<br />
<br />
<br />
== Named service functions ==<br />
=== CreateServiceFunction ===<br />
Creates a service function ("service")<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Service name.<br />
;Result<br />
: Type: '''light userdata'''<br />
: Returns service handle if service was created successfully, otherwise '''nil'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hService = m.CreateServiceFunction('MyService', function(w, l)<br />
print('MyServiceis called!')<br />
end)<br />
}}<br />
<br />
=== CallService ===<br />
Calls service with parameters.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Service name.<br />
: ''wParam''<br />
: ''lParam''<br />
;Result<br />
: Type: '''number'''<br />
: Returns result of service execution or [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]<br />
;Example<br />
{{Content:MirLua/Example|code=<br />
local result = m.CallService('MyService')<br />
if result == m.CALLSERVICE_NOTFOUND then<br />
print('Service is not found!')<br />
end<br />
}}<br />
<br />
=== ServiceExists ===<br />
Checks if service exists by its name.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Service name.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if service exists, otherwise '''false'''<br />
;Example<br />
{{Content:MirLua/Example|code=if m.ServiceExists('MyService') then<br />
m.CallService('MyService')<br />
end}}<br />
<br />
=== DestroyServiceFunction ===<br />
Destroys a service function.<br />
;Parameters<br />
: '''''hService'''''<br />
:: Type: '''light userdata'''<br />
:: Service handle received on [[#CreateServiceFunction|CreateServiceFunction]] call.<br />
;Example<br />
{{Content:MirLua/Example|code=m.DestroyServiceFunction(hService)}}<br />
<br />
<br />
== Others ==<br />
=== IsPluginLoaded ===<br />
Checks if plugin is loaded by its UUID.<br />
;Parameters<br />
: '''''uuid'''''<br />
:: Type: '''string'''<br />
:: Plugin UUID in format ''xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx''.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if plugin is loaded, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=if m.IsPluginLoaded('{F0FDF73A-753D-499d-8DBA-336DB79CDD41}') then<br />
print('Advanced auto away plugin is loaded!')<br />
end<br />
}}<br />
<br />
=== Utf8DecodeA ===<br />
Converts Lua string contents to ANSI (codepage of the current langpack is used).<br />
: '''''text'''''<br />
:: Type: '''string'''<br />
;Result<br />
: Type: '''string'''<br />
;Example<br />
{{Content:MirLua/Example|code=m.CallService("Quotes/Import", 0, Utf8DecodeA('c:\\quotes.xml'))}}<br />
<br />
=== Utf8DecodeW ===<br />
Converts Lua string contents to Unicode (UTF-16).<br />
: '''''text'''''<br />
:: Type: '''string'''<br />
;Result<br />
: Type: '''string'''<br />
;Example<br />
{{Content:MirLua/Example|code=m.CallService("Popup/ShowMessageW", m.Utf8DecodeW('Hello, World!'), 2)}}<br />
<br />
=== Translate ===<br />
Translates a string into the language of the current langpack.<br />
: '''''text'''''<br />
:: Type: '''string'''<br />
;Result<br />
: Type: '''string'''<br />
;Example<br />
{{Content:MirLua/Example|code=m.Translate('Exit')}}<br />
<br />
=== ReplaceVariables ===<br />
Replaces Miranda NG variables in a string.<br />
: '''''text'''''<br />
;Result<br />
: Type: '''string'''<br />
;Example<br />
{{Content:MirLua/Example|code=local profileName = m.ReplaceVariables('%miranda_profilename%')}}<br />
<br />
[[Category:Tutorials (en)]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/Module/m_core&diff=27784
Plugin:MirLua/Module/m core
2018-04-05T18:42:47Z
<p>Unsane: </p>
<hr />
<div><languages/>{{PageLang|en}}<br />
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.<br />
<br />
{{Note|Parameters written in '''''bold italics''''' are obligatory.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Constants ==<br />
=== NULL ===<br />
Null pointer.<br />
: Type: '''light userdata'''<br />
<br />
=== INVALID_HANDLE_VALUE ===<br />
Invalid handle.<br />
: Type: '''light userdata'''<br />
<br />
=== CALLSERVICE_NOTFOUND ===<br />
Result of service call when service does not exist.<br />
: Type: '''number'''<br />
<br />
<br />
== Named events ==<br />
=== CreateHookableEvent ===<br />
Creates a hookable event.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Event name.<br />
;Result<br />
: Type: '''light userdata'''<br />
: Returns event handle if event was created successfully, otherwise '''nil'''.<br />
;Example<br />
{{Content:MirLua/Example|code=<br />
local hEvent = m.CreateHookableEvent('MyEvent')<br />
if hEvent == m.NULL then<br />
print('Event handle is empty!')<br />
end<br />
}}<br />
<br />
=== HookEvent ===<br />
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.<br />
<br />
Hook signature: <code>function (wParam, lParam) return 0 end</code>.<br />
<br />
Correct result for a hook is 0. When 1 is returned, the following hooks in a sequence won't be called.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Event name.<br />
: '''''hook'''''<br />
:: Type: '''function'''<br />
:: Hook function to be called when event occurs.<br />
;Result<br />
: Type: '''light userdata'''<br />
: Returns hook handle if hook was created successfully, otherwise '''nil'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hHook = m.HookEvent('MyEvent', function(w, l)<br />
print('MyEvent is raised!')<br />
end)<br />
}}<br />
<br />
=== UnhookEvent ===<br />
Removes hook from event call sequence.<br />
;Parameters<br />
: '''''hEvent'''''<br />
:: Type: '''light userdata'''<br />
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if hook function was removed successfully, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=m.UnhookEvent(hHook)}}<br />
<br />
=== NotifyEventHooks ===<br />
Calls all hooks of event call sequence one by one.<br />
;Parameters<br />
: '''''hEvent'''''<br />
:: Type: '''light userdata'''<br />
:: Event handle received on [[#CreateHookableEvent|CreateHookableEvent]] call.<br />
: ''wParam''<br />
: ''lParam''<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if all hooks were called, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=m.NotifyEventHooks(hEvent)}}<br />
<br />
<br />
== Named service functions ==<br />
=== CreateServiceFunction ===<br />
Creates a service function ("service")<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Service name.<br />
;Result<br />
: Type: '''light userdata'''<br />
: Returns service handle if service was created successfully, otherwise '''nil'''.<br />
;Example<br />
{{Content:MirLua/Example|code=local hService = m.CreateServiceFunction('MyService', function(w, l)<br />
print('MyServiceis called!')<br />
end)<br />
}}<br />
<br />
=== CallService ===<br />
Calls service with parameters.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Service name.<br />
: ''wParam''<br />
: ''lParam''<br />
;Result<br />
: Type: '''number'''<br />
: Returns result of service execution or [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]<br />
;Example<br />
{{Content:MirLua/Example|code=<br />
local result = m.CallService('MyService')<br />
if result == m.CALLSERVICE_NOTFOUND then<br />
print('Service is not found!')<br />
end<br />
}}<br />
<br />
=== ServiceExists ===<br />
Checks if service exists by its name.<br />
;Parameters<br />
: '''''name'''''<br />
:: Type: '''string'''<br />
:: Service name.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if service exists, otherwise '''false'''<br />
;Example<br />
{{Content:MirLua/Example|code=if m.ServiceExists('MyService') then<br />
m.CallService('MyService')<br />
end}}<br />
<br />
=== DestroyServiceFunction ===<br />
Destroys a service function.<br />
;Parameters<br />
: '''''hService'''''<br />
:: Type: '''light userdata'''<br />
:: Service handle received on [[#CreateServiceFunction|CreateServiceFunction]] call.<br />
;Example<br />
{{Content:MirLua/Example|code=m.DestroyServiceFunction(hService)}}<br />
<br />
<br />
== Others ==<br />
=== IsPluginLoaded ===<br />
Checks if plugin is loaded by its UUID.<br />
;Parameters<br />
: '''''uuid'''''<br />
:: Type: '''string'''<br />
:: Plugin UUID in format ''xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx''.<br />
;Result<br />
: Type: '''boolean'''<br />
: Returns '''true''' if plugin is loaded, otherwise '''false'''.<br />
;Example<br />
{{Content:MirLua/Example|code=if m.IsPluginLoaded('{F0FDF73A-753D-499d-8DBA-336DB79CDD41}') then<br />
print('Advanced auto away plugin is loaded!')<br />
end<br />
}}<br />
<br />
=== Utf8DecodeA ===<br />
Converts Lua string contents to ANSI (codepage of the current langpack is used).<br />
: '''''text'''''<br />
:: Type: '''string'''<br />
;Result<br />
: Type: '''string'''<br />
;Example<br />
{{Content:MirLua/Example|code=m.CallService("Quotes/Import", 0, Utf8DecodeA('c:\\quotes.xml'))}}<br />
<br />
=== Utf8DecodeW ===<br />
Converts Lua string contents to Unicode (UTF-16).<br />
: '''''text'''''<br />
:: Type: '''string'''<br />
;Result<br />
: Type: '''string'''<br />
;Example<br />
{{Content:MirLua/Example|code=m.CallService("Popup/ShowMessageW", m.Utf8DecodeW('Hello, World!'), 2)}}<br />
<br />
=== Translate ===<br />
Translates a string into the language of the current langpack.<br />
: '''''text'''''<br />
:: Type: '''string'''<br />
;Result<br />
: Type: '''string'''<br />
;Example<br />
{{Content:MirLua/Example|code=m.Translate('Exit')}}<br />
<br />
=== ReplaceVariables ===<br />
Replaces Miranda NG variables in a string.<br />
: '''''text'''''<br />
;Result<br />
: Type: '''string'''<br />
;Example<br />
{{Content:MirLua/Example|code=local profileName = m.ReplaceVariables('%miranda_profilename%')}}<br />
<br />
[[Category:Tutorials (en)]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua&diff=27719
Plugin:MirLua
2018-04-04T23:01:07Z
<p>Unsane: </p>
<hr />
<div><languages/>{{PluginCard}}<br />
<translate><br />
<!--T:1--><br />
Extends Miranda NG functionality with Lua scripts.<br />
</translate><br />
<br />
<translate><br />
== Lua == <!--T:2--><br />
The plugin uses Lua 5.3.4 which shipped as shared library lua53.dll.<br />
</translate><br />
<br />
<translate><br />
== Additional functions == <!--T:2--><br />
</translate><br />
<translate><br />
=== toansi===<br />
Encodes lua utf-8 string to ansi. It can be usefull for passing string as parameter to ansi function.<br />
<code>m.CallService('mRadio/Import', 0, toansi(m.Parse('%miranda_path%\\Plugins\\mradio.ini')))</code><br />
Also it has a short version '''a'''.<br />
<code>m.CallService('DB/Ini/ImportFile', 0, a'import\\autoexec.ini')</code><br />
</translate><br />
<translate><br />
=== toucs2 ===<br />
Same as '''toansi''' but for utf-16. Also it has a short version '''u'''.<br />
</translate><br />
<translate><br />
=== tonumber ===<br />
If it receives '''light userdata''' parameter then returns it address as number, otherwise uses standard lua '''tonumber''' behaviour. <br />
</translate><br />
<translate><br />
=== topointer ===<br />
Converts lua types '''bool''', '''number''', '''string''' to '''light userdata'''.<br />
</translate><br />
<translate><br />
=== string.interpolate ===<br />
Provides a more readable and convenient syntax to format string output.<br />
<code><br />
local h = 'Hello'<br />
print('{h}, {w}!' % {w = 'World'})<br />
</code><br />
</translate><br />
<br />
<translate><br />
== Internal modules == <!--T:2--><br />
</translate><br />
<br />
* [[Plugin:MirLua/ru/m_clist|m_clist]]<br />
* [[Plugin:MirLua/en/m_core|m_core]]<br />
* [[Plugin:MirLua/en/m_database|m_database]]<br />
* [[Plugin:MirLua/en/m_genmenu|m_genmenu]]<br />
* [[Plugin:MirLua/en/m_hotkeys|m_hotkeys]]<br />
* [[Plugin:MirLua/en/m_icolib|m_icolib]]<br />
* [[Plugin:MirLua/en/m_sounds|m_sounds]]<br />
<br />
<translate><br />
== Examples == <!--T:3--><br />
</translate><br />
<br />
{{Content:MirLua/Examples}}<br />
<br />
<translate><br />
== External links == <!--T:4--><br />
</translate><br />
<br />
* [https://forum.miranda-ng.org/index.php?topic=4161.0 <translate><!--T:5--> Forum topic dedicated to script examples</translate>]{{RefLang|ru}}<br />
* [https://www.lua.org <translate><!--T:6--> Lua website</translate>]<br />
* [[wikipedia:en:Lua_(programming_language)|<translate><!--T:7--> Lua in Wikipedia</translate>]]<br />
<br />
{{PluginGroups}}</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Content:MirLua/Examples/json&diff=20018
Content:MirLua/Examples/json
2017-10-05T20:20:48Z
<p>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..."</p>
<hr />
<div>{{Content:MirLua/Example|code=<br />
local json = require('m_json')<br />
local value = json.Decode('[ true, { "foo": "bar" } ]')<br />
print(<br />
json.Encode(nil),<br />
json.Encode(true),<br />
json.Encode(123),<br />
json.Encode(3.21),<br />
json.Encode('test'),<br />
json.Encode({ true, { foo = "bar" } }),<br />
json.Encode(value))<br />
}}</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru&diff=19984
Plugin:MirLua/ru
2017-09-26T21:53:20Z
<p>Unsane: /* Примеры */</p>
<hr />
<div>{{PluginCard}}<br />
Расширяет функциональность Miranda NG с помощью скриптов на языке Lua.<br />
<br />
== Модули ==<br />
* [[Plugin:MirLua/ru/m_clist|m_clist]]<br />
* [[Plugin:MirLua/ru/m_core|m_core]]<br />
* [[Plugin:MirLua/ru/m_database|m_database]]<br />
* [[Plugin:MirLua/ru/m_genmenu|m_genmenu]]<br />
* [[Plugin:MirLua/ru/m_hotkeys|m_hotkeys]]<br />
* [[Plugin:MirLua/ru/m_icolib|m_icolib]]<br />
* [[Plugin:MirLua/ru/m_sounds|m_sounds]]<br />
<br />
== Примеры ==<br />
<!--{{Content:MirLua/Examples}}--><br />
* [[Content:MirLua/Examples/database|database]]<br />
* [[Content:MirLua/Examples/icons|icons]]<br />
* [[Content:MirLua/Examples/menus|menus]]<br />
* [[Content:MirLua/Examples/srmm|srmm]]<br />
* [[Content:MirLua/Examples/popup|popup]]<br />
* [[Content:MirLua/Examples/variables|variables]]<br />
<br />
== Ссылки ==<br />
* [https://forum.miranda-ng.org/index.php?topic=4161.0 Примеры скриптов в теме на форуме]<br />
* [https://www.lua.org Веб-сайт Lua]{{RefLang|en}}<br />
* [[wikipedia:ru:Lua|Lua в Википедии]]<br />
<br />
{{PluginGroups}}</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Content:MirLua/Examples/srmm&diff=19983
Content:MirLua/Examples/srmm
2017-09-26T21:51:37Z
<p>Unsane: </p>
<hr />
<div>Send files button in SRMM's:<br />
{{Content:MirLua/Example|code=<br />
local srmm = require('m_srmm')<br />
local icolib = require('m_icolib')<br />
<br />
local moduleName = 'SendFiles'<br />
local buttonId = 1<br />
<br />
local BBBF_ISIMBUTTON = 32<br />
local BBBF_ISRSIDEBUTTON = 128<br />
<br />
m.HookTemporaryEvent("SRMM/ButtonsBar/ModuleLoaded", function()<br />
srmm.AddButton{<br />
Module = moduleName,<br />
ButtonId = buttonId,<br />
Flags = BBBF_ISIMBUTTON | BBBF_ISRSIDEBUTTON,<br />
Tooltip = m.Translate('Send File'),<br />
Icon = icolib.AddIcon(moduleName, 'Send File')<br />
}<br />
end)<br />
<br />
m.HookEvent("SRMM/ButtonsBar/ButtonPressed", function(w, l)<br />
local bcd = CustomButtonClickData(l)<br />
if bcd.Module == moduleName and bcd.ButtonId == buttonId then<br />
print(bcd.hContact)<br />
m.CallService('SRFile/SendCommand', bcd.hContact)<br />
end<br />
end)<br />
}}<br />
<br />
<br />
<br />
Open received files folder button in SRMM's:<br />
{{Content:MirLua/Example|code=<br />
local srmm = require('m_srmm')<br />
local icolib = require('m_icolib')<br />
<br />
local moduleName = 'MyReceivedFiles'<br />
local buttonId = 1<br />
<br />
local BBBF_ISIMBUTTON = 32<br />
local BBBF_ISRSIDEBUTTON = 128<br />
<br />
m.HookTemporaryEvent("SRMM/ButtonsBar/ModuleLoaded", function()<br />
srmm.AddButton{<br />
Module = moduleName,<br />
ButtonId = buttonId,<br />
Flags = BBBF_ISIMBUTTON | BBBF_ISRSIDEBUTTON,<br />
Tooltip = m.Translate('My received files'),<br />
Icon = icolib.AddIcon(moduleName, 'My received files')<br />
}<br />
end)<br />
<br />
m.HookEvent("SRMM/ButtonsBar/ButtonPressed", function(w, l)<br />
local bcd = CustomButtonClickData(l)<br />
if bcd.Module == moduleName and bcd.ButtonId == buttonId then<br />
m.CallService('SRFile/OpenContRecDir', bcd.hContact, 0)<br />
end<br />
end)<br />
<br />
}}</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Content:MirLua/Examples/protocols&diff=19982
Content:MirLua/Examples/protocols
2017-09-26T21:46:19Z
<p>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..."</p>
<hr />
<div>Switch all protocols statuses to online:<br />
{{Content:MirLua/Example|code=<br />
local protos = require('m_protocols')<br />
<br />
local ID_STATUS_OFFLINE = 40071<br />
local ID_STATUS_ONLINE = 40072<br />
<br />
m.HookEvent('Miranda/System/ModulesLoaded', function()<br />
for acc in protos.Accounts() do<br />
if acc.IsEnabled and not acc.IsVirtual then<br />
local status = acc:CallService('/GetStatus')<br />
if (status == ID_STATUS_OFFLINE) then<br />
acc:CallService('/SetStatus', ID_STATUS_ONLINE)<br />
end<br />
end<br />
end<br />
end)<br />
}}</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Content:MirLua/Examples/database&diff=19981
Content:MirLua/Examples/database
2017-09-26T21:41:20Z
<p>Unsane: </p>
<hr />
<div>An [[Plugin:Msg_Export|Msg_Export]] analogue:<br />
{{Content:MirLua/Example|code=<br />
local db = require('m_database')<br />
<br />
m.HookEvent("DB/Event/Added", function(w, l)<br />
local hContact = tonumber(w)<br />
-- note that path to file should be exists<br />
local path = m.Parse('%miranda_userdata%\\History\\')<br />
.. db.GetContactInfo(hContact, 'Uid')<br />
.. '.log'<br />
local contactName = db.GetContactInfo(hContact, 'DisplayName')<br />
local message = GetMessage(tonumber(l), contactName)<br />
print(message)<br />
if message then<br />
local file = io.open(path, 'a+')<br />
if file then<br />
file:write(message)<br />
file:close()<br />
print('ok')<br />
end<br />
end<br />
end)<br />
<br />
function GetMessage(hDbEvent, contactName)<br />
local event = DBEVENTINFO(hDbEvent)<br />
if event.Type == 0 then<br />
local isSent = event.Flags & 2 == 2<br />
local nick = isSent and 'me' or contactName<br />
local date = os.date("%d.%m.%Y %H:%M:%S", event.Timestamp)<br />
local text = toutf8(event.Blob)<br />
return string.interpolate('{1} {2}:\t{3}\n', nick, date, text)<br />
end<br />
return nil<br />
end<br />
<br />
function toutf8(bytes)<br />
local bytearr = {}<br />
for i = 1, #bytes do<br />
local v = bytes[i]<br />
local utf8byte = v < 0 and (0xff + v + 1) or v<br />
table.insert(bytearr, string.char(utf8byte))<br />
end<br />
return table.concat(bytearr)<br />
end<br />
}}<br />
<br />
<!--{{Content:MirLua/Example|code=<br />
--- include m_database module<br />
local db = require('m_database')<br />
<br />
--- Iterate all contact stored in db<br />
-- @param protoName The name of protocol account or nothing<br />
for hContact in db.AllContacts() do<br />
--print(hContact)<br />
end<br />
<br />
local hContact = 15<br />
<br />
--- Iterate all contact events stored in db<br />
-- param hContact The handle of contact<br />
for hEvent in db.AllEvents(hContact) do<br />
--print(hEvent)<br />
end<br />
<br />
--- Iterate all setting names stored in db<br />
-- param module The name of module<br />
-- param hContact The handle of contact or nothing<br />
for setting in db.AllSettings('CList') do<br />
--print(setting)<br />
end<br />
<br />
--- Save value to database<br />
-- @param hContact The handle of contact (can be NULL)<br />
-- @param module The name of section<br />
-- @param setting The name of setting<br />
-- @return value The value<br />
db.WriteSetting(nil, 'MirLua', 'testNum', -2342)<br />
<br />
--- Return value from database<br />
-- @param hContact The handle of contact (can be NULL)<br />
-- @param module The name of section<br />
-- @param setting The name of setting<br />
-- @param default The value which will be returned if setting doesn't not exists<br />
local bValue = db.GetSetting(nil, 'MirLua', 'testByte');<br />
<br />
-- print string value if bool value is true<br />
if bValue then<br />
local sValue = db.GetSetting(nil, 'MirLua', 'testString', 'Hello!')<br />
print(sValue)<br />
end<br />
<br />
--- Delete value from database<br />
-- @param hContact The handle of contact (can be NULL)<br />
-- @param module The name of section<br />
-- @param setting The name of setting<br />
db.DeleteSetting(nil, 'MirLua', 'testNum');<br />
}}<br />
--></div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Content:MirLua/Examples/menus&diff=19979
Content:MirLua/Examples/menus
2017-09-26T21:06:22Z
<p>Unsane: </p>
<hr />
<div>Add restart menu item to main menu<br />
{{Content:MirLua/Example|code=<br />
local clist = require("m_clist")<br />
local icolib = require("m_icolib")<br />
<br />
m.CreateServiceFunction("Lua/Restart", function()<br />
m.CallService("Miranda/System/Restart", 1)<br />
end)<br />
<br />
clist.AddMainMenuItem{<br />
Name = "Restart",<br />
Service = "Lua/Restart",<br />
Uid = '9FC57A01-FAC6-41AC-A009-52F1C6594095',<br />
Icon = icolib.AddIcon('restart', 'Restart')<br />
}<br />
}}<br />
<br />
<!--{{Content:MirLua/Example|code=<br />
--- include m_clist module<br />
local clist = require('m_clist')<br />
--- include m_genmenu module<br />
local genmenu = require('m_genmenu')<br />
--- include m_icolib module<br />
local icolib = require('m_icolib')<br />
<br />
local menuItem =<br />
{<br />
-- required field<br />
Name = "Menu item",<br />
Flags = 0,<br />
Position = 0,<br />
Icon = nil,<br />
Service = nil,<br />
Parent = nil<br />
}<br />
<br />
--- Add icon for menu items<br />
local hIcon = icolib.AddIcon('testMenuIcon', 'Lua icon for menus')<br />
<br />
--- Add menu item to main menu<br />
menuItem.Name = "Main menu item"<br />
menuItem.Icon = hIcon<br />
menuItem.Service = "Srv/MMI"<br />
clist.AddMainMenuItem(menuItem)<br />
<br />
--- Add menu item to main menu<br />
menuItem.Name = "Tray menu item"<br />
menuItem.Service = "Srv/TMI"<br />
clist.AddTrayMenuItem(menuItem)<br />
<br />
--- Add menu item to contact menu<br />
menuItem.Name = "Contact menu item"<br />
menuItem.Service = "Srv/CMI"<br />
clist.AddContactMenuItem(menuItem)<br />
<br />
--- Create the contact menu item which will be deleted below<br />
menuItem.Name = "testRemove"<br />
menuItem.Service = "Srv/TestRemove"<br />
local hMenuItem = clist.AddContactMenuItem(menuItem)<br />
<br />
--- Remove menu item from parent menu<br />
genmenu.RemoveMenuItem(hMenuItem)<br />
<br />
--- Add root menu item<br />
local hRoot = clist.AddMainMenuItem({ Name = "Main menu root" })<br />
<br />
--- Add child menu item<br />
menuItem.Name = "Main menu child wierd"<br />
menuItem.Service = 'Srv/SMI'<br />
menuItem.Parent = hRoot<br />
local hChild = clist.AddMainMenuItem(menuItem)<br />
<br />
--- Modify menu item<br />
local CMIM_NAME = tonumber("80000000", 16)<br />
genmenu.ModifyMenuItem(hChild, "Main menu child", hIcon, CMIM_NAME)<br />
<br />
local hDisabledMenuItem = clist.AddMainMenuItem({ Name = "Disabled main menu item" })<br />
genmenu.EnableMenuItem(hDisabledMenuItem, false)<br />
<br />
local hHiddenMenuItem = clist.AddMainMenuItem({ Name = "Hidden main menu item" })<br />
genmenu.ShowMenuItem(hHiddenMenuItem, false)<br />
<br />
local hCheckedMenuItem = clist.AddMainMenuItem({ Name = "Checked main menu item" })<br />
genmenu.CheckMenuItem(hCheckedMenuItem, true)<br />
}}<br />
--></div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Content:MirLua/Examples/srmm&diff=19978
Content:MirLua/Examples/srmm
2017-09-26T21:03:22Z
<p>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..."</p>
<hr />
<div>Open received files folder button in SRMM's:<br />
{{Content:MirLua/Example|code=<br />
local srmm = require('m_srmm')<br />
local icolib = require('m_icolib')<br />
<br />
local moduleName = 'MyReceivedFiles'<br />
local buttonId = 1<br />
<br />
local BBBF_ISIMBUTTON = 32<br />
local BBBF_ISRSIDEBUTTON = 128<br />
<br />
m.HookTemporaryEvent("SRMM/ButtonsBar/ModuleLoaded", function()<br />
srmm.AddButton{<br />
Module = moduleName,<br />
ButtonId = buttonId,<br />
Flags = BBBF_ISIMBUTTON {{!}} BBBF_ISRSIDEBUTTON,<br />
Tooltip = m.Translate('My received files'),<br />
Icon = icolib.AddIcon(moduleName, 'My received files')<br />
}<br />
end)<br />
<br />
m.HookEvent("SRMM/ButtonsBar/ButtonPressed", function(w, l)<br />
local bcd = CustomButtonClickData(l)<br />
if bcd.Module == moduleName and bcd.ButtonId == buttonId then<br />
m.CallService('SRFile/OpenContRecDir', bcd.hContact)<br />
end<br />
end)<br />
}}</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua&diff=19913
Plugin:MirLua
2017-09-11T21:55:38Z
<p>Unsane: </p>
<hr />
<div><!--<br />
{{Resolve Language}}<br />
* Do not edit this article. You should edit subpages of the article instead.<br />
* Не редактируйте этот файл, вам нужно править подстраницы этой статьи.<br />
--></div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_database&diff=19912
Plugin:MirLua/ru/m database
2017-09-11T21:53:45Z
<p>Unsane: /* GetContactInfo */</p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.<br />
<br />
Подключение модуля: <code>local db = require('m_database')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Контакты ==<br />
=== Contacts ===<br />
Итератор для списка контактов<br />
;Параметры<br />
: ''name''<br />
:: Тип: '''string'''<br />
:: Имя протокола<br />
;Результат<br />
: Тип: '''function'''<br />
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hContact in db.Contacts('JABBER_1') do<br />
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))<br />
end<br />
}}<br />
<br />
=== GetContactInfo ===<br />
Контактная информация<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
:'''''field'''''<br />
::<br />
{| class="wikitable"<br />
!Тип<br />
|'''number'''<br />
|'''string'''<br />
|-<br />
!Описание<br />
|тип поля<br />
|название поля<br />
|-<br />
!Значения<br />
|1-16<br />
|FirstName, LastName, Nick, CustomNick, Email, City, State, Country, Phone, Homepage, About, Gender, Age, FullName, Uid, DisplayName<br />
|}<br />
;Результат<br />
: Тип: '''string'''<br />
: Значение поля или '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=local email = db.GetContactInfo(hContact, 'Email')<br />
}}<br />
<br />
== События ==<br />
=== GetEventCount ===<br />
Количество событий для контакта<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает количество событий<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}<br />
<br />
=== Events ===<br />
Итератор для списка событий контакта от первого к последнему<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hEvent in db.Events(hContact) do<br />
local event = DBEVENTINFO.new(hEvent)<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
=== EventsFromEnd ===<br />
Итератор для списка событий контакта от последнего к первому<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hEvent in db.EventsFromEnd(hContact) do<br />
local event = DBEVENTINFO.new(hEvent)<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
== Настройки ==<br />
=== GetSetting ===<br />
Возвращает значение настройки<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название модуля<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: ''value''<br />
:: Тип: ''any''<br />
:: Значание по умолчаниию<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает значение настройки или значание по умолчаниию или '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}<br />
<br />
=== Settings ===<br />
Итератор для секции настроек<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for setting in db.Settings(nil, 'CList') do<br />
local message = string.format("%s/%s = ", 'CList', setting, ...)<br />
.. db.GetSetting(nil, 'CList', setting)<br />
print(message)<br />
end<br />
}}<br />
<br />
=== WriteSetting ===<br />
Сохраняет значение в БД<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: '''''value'''''<br />
:: Тип: '''boolean''', '''number''', '''string''', '''table''' (массив байт)<br />
:: Значение настройки<br />
: ''type''<br />
:: Тип: '''number'''<br />
:: Тип настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}<br />
<br />
=== DeleteSetting ===<br />
Удаляет настройку<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}<br />
<br />
=== DeleteModule ===<br />
Удаляет секцию<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}<br />
<br />
<br />
== Структуры ==<br />
=== DBEVENTINFO ===<br />
Таблица, описывающая событие в БД<br />
;Поля<br />
: '''''Module'''''<br />
:: Тип: '''string'''<br />
:: Название аккаунта<br />
: '''''Timestamp'''''<br />
:: Тип: '''number'''<br />
:: Отметка времени<br />
: '''''Type'''''<br />
:: Тип: '''number'''<br />
:: Тип события<br />
: '''''Flags'''''<br />
:: Тип: '''number'''<br />
:: Флаги<br />
<br />
[[Category:Руководства]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_database&diff=19911
Plugin:MirLua/ru/m database
2017-09-11T21:53:26Z
<p>Unsane: /* GetContactInfo */</p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.<br />
<br />
Подключение модуля: <code>local db = require('m_database')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Контакты ==<br />
=== Contacts ===<br />
Итератор для списка контактов<br />
;Параметры<br />
: ''name''<br />
:: Тип: '''string'''<br />
:: Имя протокола<br />
;Результат<br />
: Тип: '''function'''<br />
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hContact in db.Contacts('JABBER_1') do<br />
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))<br />
end<br />
}}<br />
<br />
=== GetContactInfo ===<br />
Контактная информация<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
:'''''field'''''<br />
::<br />
{| class="wikitable"<br />
!Тип<br />
|'''number'''<br />
|'''string'''<br />
|-<br />
!Описание<br />
|тип поля<br />
|название поля<br />
|-<br />
!Значения<br />
|1-16<br />
|FirstName, LastName, Nick, CustomNick, Email, City, State, Country, Phone, Homepage, About, Gender, Age, FullName, Uid, DisplayName<br />
|}<br />
;Результат<br />
: Тип: '''string'''<br />
: Значение поля или '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
local email = db.GetContactInfo(hContact, 'Email')<br />
print(email)<br />
}}<br />
<br />
== События ==<br />
=== GetEventCount ===<br />
Количество событий для контакта<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает количество событий<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}<br />
<br />
=== Events ===<br />
Итератор для списка событий контакта от первого к последнему<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hEvent in db.Events(hContact) do<br />
local event = DBEVENTINFO.new(hEvent)<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
=== EventsFromEnd ===<br />
Итератор для списка событий контакта от последнего к первому<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hEvent in db.EventsFromEnd(hContact) do<br />
local event = DBEVENTINFO.new(hEvent)<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
== Настройки ==<br />
=== GetSetting ===<br />
Возвращает значение настройки<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название модуля<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: ''value''<br />
:: Тип: ''any''<br />
:: Значание по умолчаниию<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает значение настройки или значание по умолчаниию или '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}<br />
<br />
=== Settings ===<br />
Итератор для секции настроек<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for setting in db.Settings(nil, 'CList') do<br />
local message = string.format("%s/%s = ", 'CList', setting, ...)<br />
.. db.GetSetting(nil, 'CList', setting)<br />
print(message)<br />
end<br />
}}<br />
<br />
=== WriteSetting ===<br />
Сохраняет значение в БД<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: '''''value'''''<br />
:: Тип: '''boolean''', '''number''', '''string''', '''table''' (массив байт)<br />
:: Значение настройки<br />
: ''type''<br />
:: Тип: '''number'''<br />
:: Тип настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}<br />
<br />
=== DeleteSetting ===<br />
Удаляет настройку<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}<br />
<br />
=== DeleteModule ===<br />
Удаляет секцию<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}<br />
<br />
<br />
== Структуры ==<br />
=== DBEVENTINFO ===<br />
Таблица, описывающая событие в БД<br />
;Поля<br />
: '''''Module'''''<br />
:: Тип: '''string'''<br />
:: Название аккаунта<br />
: '''''Timestamp'''''<br />
:: Тип: '''number'''<br />
:: Отметка времени<br />
: '''''Type'''''<br />
:: Тип: '''number'''<br />
:: Тип события<br />
: '''''Flags'''''<br />
:: Тип: '''number'''<br />
:: Флаги<br />
<br />
[[Category:Руководства]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_database&diff=19910
Plugin:MirLua/ru/m database
2017-09-11T21:51:41Z
<p>Unsane: /* Контакты */</p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.<br />
<br />
Подключение модуля: <code>local db = require('m_database')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Контакты ==<br />
=== Contacts ===<br />
Итератор для списка контактов<br />
;Параметры<br />
: ''name''<br />
:: Тип: '''string'''<br />
:: Имя протокола<br />
;Результат<br />
: Тип: '''function'''<br />
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hContact in db.Contacts('JABBER_1') do<br />
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))<br />
end<br />
}}<br />
<br />
=== GetContactInfo ===<br />
Контактная информация<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
:'''''field'''''<br />
::<br />
{| class="wikitable"<br />
!Тип<br />
|'''number'''<br />
|'''string'''<br />
|-<br />
!Описание<br />
|тип поля<br />
|название поля<br />
|-<br />
!Значения<br />
|1-16<br />
|FirstName, LastName, Nick, CustomNick, Email, City, State, Country, Phone, Homepage, About, Gender, Age, FullName, Uid, DisplayName<br />
|}<br />
;Результат<br />
: Тип: '''function'''<br />
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hContact in db.Contacts('JABBER_1') do<br />
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))<br />
end<br />
}}<br />
<br />
== События ==<br />
=== GetEventCount ===<br />
Количество событий для контакта<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает количество событий<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}<br />
<br />
=== Events ===<br />
Итератор для списка событий контакта от первого к последнему<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hEvent in db.Events(hContact) do<br />
local event = DBEVENTINFO.new(hEvent)<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
=== EventsFromEnd ===<br />
Итератор для списка событий контакта от последнего к первому<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hEvent in db.EventsFromEnd(hContact) do<br />
local event = DBEVENTINFO.new(hEvent)<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
== Настройки ==<br />
=== GetSetting ===<br />
Возвращает значение настройки<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название модуля<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: ''value''<br />
:: Тип: ''any''<br />
:: Значание по умолчаниию<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает значение настройки или значание по умолчаниию или '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}<br />
<br />
=== Settings ===<br />
Итератор для секции настроек<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for setting in db.Settings(nil, 'CList') do<br />
local message = string.format("%s/%s = ", 'CList', setting, ...)<br />
.. db.GetSetting(nil, 'CList', setting)<br />
print(message)<br />
end<br />
}}<br />
<br />
=== WriteSetting ===<br />
Сохраняет значение в БД<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: '''''value'''''<br />
:: Тип: '''boolean''', '''number''', '''string''', '''table''' (массив байт)<br />
:: Значение настройки<br />
: ''type''<br />
:: Тип: '''number'''<br />
:: Тип настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}<br />
<br />
=== DeleteSetting ===<br />
Удаляет настройку<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}<br />
<br />
=== DeleteModule ===<br />
Удаляет секцию<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}<br />
<br />
<br />
== Структуры ==<br />
=== DBEVENTINFO ===<br />
Таблица, описывающая событие в БД<br />
;Поля<br />
: '''''Module'''''<br />
:: Тип: '''string'''<br />
:: Название аккаунта<br />
: '''''Timestamp'''''<br />
:: Тип: '''number'''<br />
:: Отметка времени<br />
: '''''Type'''''<br />
:: Тип: '''number'''<br />
:: Тип события<br />
: '''''Flags'''''<br />
:: Тип: '''number'''<br />
:: Флаги<br />
<br />
[[Category:Руководства]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_database&diff=19909
Plugin:MirLua/ru/m database
2017-09-11T21:38:00Z
<p>Unsane: </p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.<br />
<br />
Подключение модуля: <code>local db = require('m_database')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Контакты ==<br />
=== Contacts ===<br />
Итератор для списка контактов<br />
;Параметры<br />
: ''name''<br />
:: Тип: '''string'''<br />
:: Имя протокола<br />
;Результат<br />
: Тип: '''function'''<br />
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hContact in db.Contacts('JABBER_1') do<br />
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))<br />
end<br />
}}<br />
<br />
== События ==<br />
=== GetEventCount ===<br />
Количество событий для контакта<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает количество событий<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}<br />
<br />
=== Events ===<br />
Итератор для списка событий контакта от первого к последнему<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hEvent in db.Events(hContact) do<br />
local event = DBEVENTINFO.new(hEvent)<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
=== EventsFromEnd ===<br />
Итератор для списка событий контакта от последнего к первому<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hEvent in db.EventsFromEnd(hContact) do<br />
local event = DBEVENTINFO.new(hEvent)<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
== Настройки ==<br />
=== GetSetting ===<br />
Возвращает значение настройки<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название модуля<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: ''value''<br />
:: Тип: ''any''<br />
:: Значание по умолчаниию<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает значение настройки или значание по умолчаниию или '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}<br />
<br />
=== Settings ===<br />
Итератор для секции настроек<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for setting in db.Settings(nil, 'CList') do<br />
local message = string.format("%s/%s = ", 'CList', setting, ...)<br />
.. db.GetSetting(nil, 'CList', setting)<br />
print(message)<br />
end<br />
}}<br />
<br />
=== WriteSetting ===<br />
Сохраняет значение в БД<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: '''''value'''''<br />
:: Тип: '''boolean''', '''number''', '''string''', '''table''' (массив байт)<br />
:: Значение настройки<br />
: ''type''<br />
:: Тип: '''number'''<br />
:: Тип настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}<br />
<br />
=== DeleteSetting ===<br />
Удаляет настройку<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}<br />
<br />
=== DeleteModule ===<br />
Удаляет секцию<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}<br />
<br />
<br />
== Структуры ==<br />
=== DBEVENTINFO ===<br />
Таблица, описывающая событие в БД<br />
;Поля<br />
: '''''Module'''''<br />
:: Тип: '''string'''<br />
:: Название аккаунта<br />
: '''''Timestamp'''''<br />
:: Тип: '''number'''<br />
:: Отметка времени<br />
: '''''Type'''''<br />
:: Тип: '''number'''<br />
:: Тип события<br />
: '''''Flags'''''<br />
:: Тип: '''number'''<br />
:: Флаги<br />
<br />
[[Category:Руководства]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_database&diff=19908
Plugin:MirLua/ru/m database
2017-09-11T21:29:02Z
<p>Unsane: /* Events */</p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.<br />
<br />
Подключение модуля: <code>local db = require('m_database')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Контакты ==<br />
=== Contacts ===<br />
Итератор для списка контактов<br />
;Параметры<br />
: ''name''<br />
:: Тип: '''string'''<br />
:: Имя протокола<br />
;Результат<br />
: Тип: '''function'''<br />
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hContact in db.Contacts('JABBER_1') do<br />
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))<br />
end<br />
}}<br />
<br />
== События ==<br />
=== GetEventCount ===<br />
Количество событий для контакта<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает количество событий<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}<br />
<br />
=== Events ===<br />
Итератор для списка событий контакта от первого к последнему<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hEvent in db.Events(hContact) do<br />
local event = DBEVENTINFO.new(hEvent)<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
=== EventsFromEnd ===<br />
Итератор для списка событий контакта от последнего к первому<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hEvent in db.EventsFromEnd(hContact) do<br />
local event = DBEVENTINFO.new(hEvent)<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
== Настройки ==<br />
=== GetSetting ===<br />
Возвращает значение настройки<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название модуля<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: ''value''<br />
:: Тип: ''any''<br />
:: Значание по умолчаниию<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает значение настройки или значание по умолчаниию или '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}<br />
<br />
=== Settings ===<br />
Итератор для секции настроек<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for setting in db.Settings(nil, 'CList') do<br />
local message = string.format("%s/%s = ", 'CList', setting, ...)<br />
.. db.GetSetting(nil, 'CList', setting)<br />
print(message)<br />
end<br />
}}<br />
<br />
=== WriteSetting ===<br />
Сохраняет значение в БД<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: '''''value'''''<br />
:: Тип: '''boolean''', '''number''', '''string''', '''table''' (массив байт)<br />
:: Значение настройки<br />
: ''type''<br />
:: Тип: '''number'''<br />
:: Тип настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}<br />
<br />
=== DeleteSetting ===<br />
Удаляет настройку<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}<br />
<br />
=== DeleteModule ===<br />
Удаляет секцию<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}<br />
<br />
[[Category:Руководства]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_database&diff=19907
Plugin:MirLua/ru/m database
2017-09-11T21:28:35Z
<p>Unsane: /* EventsFromEnd */</p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.<br />
<br />
Подключение модуля: <code>local db = require('m_database')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Контакты ==<br />
=== Contacts ===<br />
Итератор для списка контактов<br />
;Параметры<br />
: ''name''<br />
:: Тип: '''string'''<br />
:: Имя протокола<br />
;Результат<br />
: Тип: '''function'''<br />
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hContact in db.Contacts('JABBER_1') do<br />
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))<br />
end<br />
}}<br />
<br />
== События ==<br />
=== GetEventCount ===<br />
Количество событий для контакта<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает количество событий<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}<br />
<br />
=== Events ===<br />
Итератор для списка событий контакта от первого к последнему<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=for hEvent in db.Events(hContact) do<br />
local event = totable(hEvent, "DBEVENTINFO")<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
=== EventsFromEnd ===<br />
Итератор для списка событий контакта от последнего к первому<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hEvent in db.EventsFromEnd(hContact) do<br />
local event = DBEVENTINFO.new(hEvent)<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
== Настройки ==<br />
=== GetSetting ===<br />
Возвращает значение настройки<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название модуля<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: ''value''<br />
:: Тип: ''any''<br />
:: Значание по умолчаниию<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает значение настройки или значание по умолчаниию или '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}<br />
<br />
=== Settings ===<br />
Итератор для секции настроек<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for setting in db.Settings(nil, 'CList') do<br />
local message = string.format("%s/%s = ", 'CList', setting, ...)<br />
.. db.GetSetting(nil, 'CList', setting)<br />
print(message)<br />
end<br />
}}<br />
<br />
=== WriteSetting ===<br />
Сохраняет значение в БД<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: '''''value'''''<br />
:: Тип: '''boolean''', '''number''', '''string''', '''table''' (массив байт)<br />
:: Значение настройки<br />
: ''type''<br />
:: Тип: '''number'''<br />
:: Тип настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}<br />
<br />
=== DeleteSetting ===<br />
Удаляет настройку<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}<br />
<br />
=== DeleteModule ===<br />
Удаляет секцию<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}<br />
<br />
[[Category:Руководства]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_database&diff=19906
Plugin:MirLua/ru/m database
2017-09-11T21:27:34Z
<p>Unsane: /* GetSetting */</p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.<br />
<br />
Подключение модуля: <code>local db = require('m_database')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Контакты ==<br />
=== Contacts ===<br />
Итератор для списка контактов<br />
;Параметры<br />
: ''name''<br />
:: Тип: '''string'''<br />
:: Имя протокола<br />
;Результат<br />
: Тип: '''function'''<br />
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hContact in db.Contacts('JABBER_1') do<br />
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))<br />
end<br />
}}<br />
<br />
== События ==<br />
=== GetEventCount ===<br />
Количество событий для контакта<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает количество событий<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}<br />
<br />
=== Events ===<br />
Итератор для списка событий контакта от первого к последнему<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=for hEvent in db.Events(hContact) do<br />
local event = totable(hEvent, "DBEVENTINFO")<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
=== EventsFromEnd ===<br />
Итератор для списка событий контакта от последнего к первому<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hEvent in db.EventsFromEnd(hContact) do<br />
local event = totable(hEvent, "DBEVENTINFO")<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
== Настройки ==<br />
=== GetSetting ===<br />
Возвращает значение настройки<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название модуля<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: ''value''<br />
:: Тип: ''any''<br />
:: Значание по умолчаниию<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает значение настройки или значание по умолчаниию или '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}<br />
<br />
=== Settings ===<br />
Итератор для секции настроек<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for setting in db.Settings(nil, 'CList') do<br />
local message = string.format("%s/%s = ", 'CList', setting, ...)<br />
.. db.GetSetting(nil, 'CList', setting)<br />
print(message)<br />
end<br />
}}<br />
<br />
=== WriteSetting ===<br />
Сохраняет значение в БД<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: '''''value'''''<br />
:: Тип: '''boolean''', '''number''', '''string''', '''table''' (массив байт)<br />
:: Значение настройки<br />
: ''type''<br />
:: Тип: '''number'''<br />
:: Тип настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}<br />
<br />
=== DeleteSetting ===<br />
Удаляет настройку<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}<br />
<br />
=== DeleteModule ===<br />
Удаляет секцию<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}<br />
<br />
[[Category:Руководства]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_database&diff=19905
Plugin:MirLua/ru/m database
2017-09-11T21:26:11Z
<p>Unsane: /* WriteSetting */</p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.<br />
<br />
Подключение модуля: <code>local db = require('m_database')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Контакты ==<br />
=== Contacts ===<br />
Итератор для списка контактов<br />
;Параметры<br />
: ''name''<br />
:: Тип: '''string'''<br />
:: Имя протокола<br />
;Результат<br />
: Тип: '''function'''<br />
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hContact in db.Contacts('JABBER_1') do<br />
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))<br />
end<br />
}}<br />
<br />
== События ==<br />
=== GetEventCount ===<br />
Количество событий для контакта<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает количество событий<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}<br />
<br />
=== Events ===<br />
Итератор для списка событий контакта от первого к последнему<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=for hEvent in db.Events(hContact) do<br />
local event = totable(hEvent, "DBEVENTINFO")<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
=== EventsFromEnd ===<br />
Итератор для списка событий контакта от последнего к первому<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hEvent in db.EventsFromEnd(hContact) do<br />
local event = totable(hEvent, "DBEVENTINFO")<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
== Настройки ==<br />
=== GetSetting ===<br />
Возвращает значение настройки<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название модуля<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: ''value''<br />
:: Тип: '''number''', '''string'''<br />
:: Значание по умолчаниию<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает значение настройки или значание по умолчаниию или '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}<br />
<br />
=== Settings ===<br />
Итератор для секции настроек<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for setting in db.Settings(nil, 'CList') do<br />
local message = string.format("%s/%s = ", 'CList', setting, ...)<br />
.. db.GetSetting(nil, 'CList', setting)<br />
print(message)<br />
end<br />
}}<br />
<br />
=== WriteSetting ===<br />
Сохраняет значение в БД<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: '''''value'''''<br />
:: Тип: '''boolean''', '''number''', '''string''', '''table''' (массив байт)<br />
:: Значение настройки<br />
: ''type''<br />
:: Тип: '''number'''<br />
:: Тип настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}<br />
<br />
=== DeleteSetting ===<br />
Удаляет настройку<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}<br />
<br />
=== DeleteModule ===<br />
Удаляет секцию<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}<br />
<br />
[[Category:Руководства]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_database&diff=19904
Plugin:MirLua/ru/m database
2017-09-11T21:24:23Z
<p>Unsane: /* WriteSetting */</p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.<br />
<br />
Подключение модуля: <code>local db = require('m_database')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Контакты ==<br />
=== Contacts ===<br />
Итератор для списка контактов<br />
;Параметры<br />
: ''name''<br />
:: Тип: '''string'''<br />
:: Имя протокола<br />
;Результат<br />
: Тип: '''function'''<br />
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hContact in db.Contacts('JABBER_1') do<br />
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))<br />
end<br />
}}<br />
<br />
== События ==<br />
=== GetEventCount ===<br />
Количество событий для контакта<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает количество событий<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}<br />
<br />
=== Events ===<br />
Итератор для списка событий контакта от первого к последнему<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=for hEvent in db.Events(hContact) do<br />
local event = totable(hEvent, "DBEVENTINFO")<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
=== EventsFromEnd ===<br />
Итератор для списка событий контакта от последнего к первому<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hEvent in db.EventsFromEnd(hContact) do<br />
local event = totable(hEvent, "DBEVENTINFO")<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
== Настройки ==<br />
=== GetSetting ===<br />
Возвращает значение настройки<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название модуля<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: ''value''<br />
:: Тип: '''number''', '''string'''<br />
:: Значание по умолчаниию<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает значение настройки или значание по умолчаниию или '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}<br />
<br />
=== Settings ===<br />
Итератор для секции настроек<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for setting in db.Settings(nil, 'CList') do<br />
local message = string.format("%s/%s = ", 'CList', setting, ...)<br />
.. db.GetSetting(nil, 'CList', setting)<br />
print(message)<br />
end<br />
}}<br />
<br />
=== WriteSetting ===<br />
Сохраняет значение в БД<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: '''''value'''''<br />
:: Тип: '''boolean'''/'''number'''/'''string'''/'''table'''<br />
:: Значение настройки<br />
: ''type''<br />
:: Тип: '''number'''<br />
:: Тип настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}<br />
<br />
=== DeleteSetting ===<br />
Удаляет настройку<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}<br />
<br />
=== DeleteModule ===<br />
Удаляет секцию<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}<br />
<br />
[[Category:Руководства]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_database&diff=19903
Plugin:MirLua/ru/m database
2017-09-11T21:17:06Z
<p>Unsane: /* WriteSetting */</p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.<br />
<br />
Подключение модуля: <code>local db = require('m_database')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Контакты ==<br />
=== Contacts ===<br />
Итератор для списка контактов<br />
;Параметры<br />
: ''name''<br />
:: Тип: '''string'''<br />
:: Имя протокола<br />
;Результат<br />
: Тип: '''function'''<br />
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hContact in db.Contacts('JABBER_1') do<br />
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))<br />
end<br />
}}<br />
<br />
== События ==<br />
=== GetEventCount ===<br />
Количество событий для контакта<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает количество событий<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}<br />
<br />
=== Events ===<br />
Итератор для списка событий контакта от первого к последнему<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=for hEvent in db.Events(hContact) do<br />
local event = totable(hEvent, "DBEVENTINFO")<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
=== EventsFromEnd ===<br />
Итератор для списка событий контакта от последнего к первому<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hEvent in db.EventsFromEnd(hContact) do<br />
local event = totable(hEvent, "DBEVENTINFO")<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
== Настройки ==<br />
=== GetSetting ===<br />
Возвращает значение настройки<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название модуля<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: ''value''<br />
:: Тип: '''number''', '''string'''<br />
:: Значание по умолчаниию<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает значение настройки или значание по умолчаниию или '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}<br />
<br />
=== Settings ===<br />
Итератор для секции настроек<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for setting in db.Settings(nil, 'CList') do<br />
local message = string.format("%s/%s = ", 'CList', setting, ...)<br />
.. db.GetSetting(nil, 'CList', setting)<br />
print(message)<br />
end<br />
}}<br />
<br />
=== WriteSetting ===<br />
Сохраняет значение в БД<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: '''''value'''''<br />
:: Тип: '''boolean'''/'''number'''/'''string'''/'''table'''(byte array)<br />
:: Значение настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}<br />
<br />
=== DeleteSetting ===<br />
Удаляет настройку<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}<br />
<br />
=== DeleteModule ===<br />
Удаляет секцию<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}<br />
<br />
[[Category:Руководства]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_protocols&diff=19902
Plugin:MirLua/ru/m protocols
2017-09-11T18:38:17Z
<p>Unsane: /* Структуры */</p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет функционал для работы с протоколами.<br />
<br />
Подключение модуля: <code>local protos = require('m_protocols')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Протоколы ==<br />
=== GetProtocol ===<br />
Получает протокол<br />
;Параметры<br />
: '''''mixed'''''<br />
::<br />
{| class="wikitable"<br />
!Тип<br />
|'''number'''<br />
|'''string'''<br />
|-<br />
!Описание<br />
|номер контакта<br />
|название протокола<br />
|}<br />
;Результат<br />
: Тип: '''userdata'''<br />
: Возвращает мета-таблицу [[#PROTOCOLDESCRIPTOR|PROTOCOLDESCRIPTOR]]<br />
;Пример<br />
{{Content:MirLua/Example|code=local proto = protos.GetProtocol({ Name = 'JABBER' })}}<br />
<br />
<br />
=== Protocols ===<br />
Итератор для протоколов<br />
;Параметры<br />
;Результат<br />
: Тип: '''function'''<br />
: Возвращает функцию-итератор для перебора протоколов. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for proto in protos.Protocols() do<br />
print(proto.Name)<br />
end<br />
}}<br />
<br />
<br />
=== CallSendChain ===<br />
Вызывает цепочку обработки для исходящего события (фильтрация, шифрование и т.п.)<br />
; Параметры<br />
: '''''name'''''<br />
:: Тип: '''string'''<br />
:: Имя сервиса<br />
: ''wParam''<br />
: ''lParam''<br />
{{Content:MirLua/Example|code=protos.CallSendChain(hContact, '/SendMsg', 0, a'Hello!')}}<br />
<br />
<br />
=== CallReceiveChain ===<br />
Вызывает цепочку обработки для входящего события (игнорирование, запись в бд и т.п.)<br />
; Параметры<br />
: '''''name'''''<br />
:: Тип: '''string'''<br />
:: Имя сервиса<br />
: ''wParam''<br />
: ''lParam''<br />
<br />
<br />
<br />
== Аккаунты ==<br />
=== GetAccount ===<br />
Получает аккаунт протокола<br />
;Параметры<br />
: '''''mixed'''''<br />
::<br />
{| class="wikitable"<br />
!Тип<br />
|'''number'''<br />
|'''string'''<br />
|-<br />
!Описание<br />
|номер контакта<br />
|название аккаунта (внутреннее)<br />
|}<br />
;Результат<br />
: Тип: '''userdata'''<br />
: Возвращает мета-таблицу [[#PROTOACCOUNT|PROTOACCOUNT ]]<br />
;Пример<br />
{{Content:MirLua/Example|code=local proto = protos.GetProtocol({ Name = 'JABBER' })}}<br />
<br />
<br />
=== Accounts ===<br />
Итератор для аккаунтов<br />
;Параметры<br />
: '''''mixed'''''<br />
::<br />
{| class="wikitable"<br />
!Тип<br />
|'''none'''<br />
|'''string'''<br />
|'''[[#PROTOCOLDESCRIPTOR|userdata]]'''<br />
|-<br />
!Описание<br />
|без параметра<br />
|название аккаунта (внутреннее)<br />
|протокол<br />
|}<br />
;Результат<br />
: Тип: '''function'''<br />
: Возвращает функцию-итератор для перебора аккаунтов. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for proto in protos.Protocols() do<br />
print(proto.Name)<br />
end<br />
}}<br />
<br />
<br />
== Структуры ==<br />
=== PROTOCOLDESCRIPTOR ===<br />
Таблица, описывающая протокол<br />
;Поля<br />
: '''''Name'''''<br />
:: Тип: '''string'''<br />
:: Название протокола<br />
: '''''Type'''''<br />
:: Тип: '''number'''<br />
:: Тип протокола<br />
:: Значения:<br />
::: ''PROTOTYPE_IGNORE'' = 50<br />
::: ''PROTOTYPE_PROTOCOL'' = 1000<br />
::: ''PROTOTYPE_VIRTUAL'' = 1001<br />
::: ''PROTOTYPE_ENCRYPTION'' = 2000<br />
::: ''PROTOTYPE_FILTER'' = 3000<br />
::: ''PROTOTYPE_TRANSLATION'' = 4000<br />
::: ''PROTOTYPE_OTHER'' = 10000<br />
;Методы<br />
: '''''Accounts'''''<br />
:: Параметры<br />
:: Результат<br />
::: Тип: '''function'''<br />
::: Возвращает функцию-итератор для перебора списка аккаунтов. Список оканчивается элементом со значением '''nil'''<br />
<br />
=== PROTOACCOUNT ===<br />
Таблица, описывающая аккаунт протокола<br />
;Поля<br />
: '''''ProtoName'''''<br />
:: Тип: '''string'''<br />
:: Название протокола<br />
: '''''ModuleName'''''<br />
:: Тип: '''string'''<br />
:: Название аккаунта (внутреннее)<br />
: '''''AccountName'''''<br />
:: Тип: '''string'''<br />
:: Название аккаунта (пользовательское)<br />
: '''''IsEnabled'''''<br />
:: Тип: '''boolean'''<br />
:: Аккаунт включен?<br />
: '''''IsVisible'''''<br />
:: Тип: '''boolean'''<br />
:: Аккаунт отображается?<br />
: '''''IsVirtual'''''<br />
:: Тип: '''boolean'''<br />
:: Аккаунт виртуальный?<br />
: '''''IsOldProto'''''<br />
:: Тип: '''boolean'''<br />
:: Протокол поддерживает аккаунты?<br />
;Методы<br />
: '''''CallService'''''<br />
:: Параметры<br />
::: '''''name'''''<br />
:::: Тип: '''string'''<br />
:::: Имя сервиса<br />
::: ''wParam''<br />
::: ''lParam''<br />
:: Результат<br />
::: Тип: '''number'''<br />
::: Возвращает результат выполнения сервиса или [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_protocols&diff=19884
Plugin:MirLua/ru/m protocols
2017-09-04T20:35:13Z
<p>Unsane: </p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет функционал для работы с протоколами.<br />
<br />
Подключение модуля: <code>local protos = require('m_protocols')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Протоколы ==<br />
=== GetProtocol ===<br />
Получает протокол<br />
;Параметры<br />
: '''''mixed'''''<br />
::<br />
{| class="wikitable"<br />
!Тип<br />
|'''number'''<br />
|'''string'''<br />
|-<br />
!Описание<br />
|номер контакта<br />
|название протокола<br />
|}<br />
;Результат<br />
: Тип: '''userdata'''<br />
: Возвращает мета-таблицу [[#PROTOCOLDESCRIPTOR|PROTOCOLDESCRIPTOR]]<br />
;Пример<br />
{{Content:MirLua/Example|code=local proto = protos.GetProtocol({ Name = 'JABBER' })}}<br />
<br />
<br />
=== Protocols ===<br />
Итератор для протоколов<br />
;Параметры<br />
;Результат<br />
: Тип: '''function'''<br />
: Возвращает функцию-итератор для перебора протоколов. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for proto in protos.Protocols() do<br />
print(proto.Name)<br />
end<br />
}}<br />
<br />
<br />
=== CallSendChain ===<br />
Вызывает цепочку обработки для исходящего события (фильтрация, шифрование и т.п.)<br />
; Параметры<br />
: '''''name'''''<br />
:: Тип: '''string'''<br />
:: Имя сервиса<br />
: ''wParam''<br />
: ''lParam''<br />
{{Content:MirLua/Example|code=protos.CallSendChain(hContact, '/SendMsg', 0, a'Hello!')}}<br />
<br />
<br />
=== CallReceiveChain ===<br />
Вызывает цепочку обработки для входящего события (игнорирование, запись в бд и т.п.)<br />
; Параметры<br />
: '''''name'''''<br />
:: Тип: '''string'''<br />
:: Имя сервиса<br />
: ''wParam''<br />
: ''lParam''<br />
<br />
<br />
<br />
== Аккаунты ==<br />
=== GetAccount ===<br />
Получает аккаунт протокола<br />
;Параметры<br />
: '''''mixed'''''<br />
::<br />
{| class="wikitable"<br />
!Тип<br />
|'''number'''<br />
|'''string'''<br />
|-<br />
!Описание<br />
|номер контакта<br />
|название аккаунта (внутреннее)<br />
|}<br />
;Результат<br />
: Тип: '''userdata'''<br />
: Возвращает мета-таблицу [[#PROTOACCOUNT|PROTOACCOUNT ]]<br />
;Пример<br />
{{Content:MirLua/Example|code=local proto = protos.GetProtocol({ Name = 'JABBER' })}}<br />
<br />
<br />
=== Accounts ===<br />
Итератор для аккаунтов<br />
;Параметры<br />
: '''''mixed'''''<br />
::<br />
{| class="wikitable"<br />
!Тип<br />
|'''none'''<br />
|'''string'''<br />
|'''[[#PROTOCOLDESCRIPTOR|userdata]]'''<br />
|-<br />
!Описание<br />
|без параметра<br />
|название аккаунта (внутреннее)<br />
|протокол<br />
|}<br />
;Результат<br />
: Тип: '''function'''<br />
: Возвращает функцию-итератор для перебора аккаунтов. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for proto in protos.Protocols() do<br />
print(proto.Name)<br />
end<br />
}}<br />
<br />
<br />
== Структуры ==<br />
=== PROTOCOLDESCRIPTOR ===<br />
Таблица, описывающая протокол<br />
;Поля<br />
: '''''Name'''''<br />
:: Тип: '''string'''<br />
:: Название протокола<br />
: '''''Type'''''<br />
:: Тип: '''number'''<br />
:: Тип протокола<br />
:: Значения:<br />
::: ''PROTOTYPE_IGNORE'' = 50<br />
::: ''PROTOTYPE_PROTOCOL'' = 1000<br />
::: ''PROTOTYPE_VIRTUAL'' = 1001<br />
::: ''PROTOTYPE_ENCRYPTION'' = 2000<br />
::: ''PROTOTYPE_FILTER'' = 3000<br />
::: ''PROTOTYPE_TRANSLATION'' = 4000<br />
::: ''PROTOTYPE_OTHER'' = 10000<br />
;Методы<br />
: '''''CallService'''''<br />
:: Параметры<br />
::: '''''name'''''<br />
:::: Тип: '''string'''<br />
:::: Имя сервиса<br />
::: ''wParam''<br />
::: ''lParam''<br />
:: Результат<br />
::: Тип: '''number'''<br />
::: Возвращает результат выполнения сервиса или [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]<br />
: '''''Accounts'''''<br />
:: Параметры<br />
:: Результат<br />
::: Тип: '''function'''<br />
::: Возвращает функцию-итератор для перебора списка аккаунтов. Список оканчивается элементом со значением '''nil'''<br />
<br />
=== PROTOACCOUNT ===<br />
Таблица, описывающая аккаунт протокола<br />
;Поля<br />
: '''''ProtoName'''''<br />
:: Тип: '''string'''<br />
:: Название протокола<br />
: '''''ModuleName'''''<br />
:: Тип: '''string'''<br />
:: Название аккаунта (внутреннее)<br />
: '''''AccountName'''''<br />
:: Тип: '''string'''<br />
:: Название аккаунта (пользовательское)<br />
: '''''IsEnabled'''''<br />
:: Тип: '''boolean'''<br />
:: Аккаунт включен?<br />
: '''''IsVisible'''''<br />
:: Тип: '''boolean'''<br />
:: Аккаунт отображается?<br />
: '''''IsVirtual'''''<br />
:: Тип: '''boolean'''<br />
:: Аккаунт виртуальный?<br />
: '''''IsOldProto'''''<br />
:: Тип: '''boolean'''<br />
:: Протокол поддерживает аккаунты?</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_protocols&diff=19883
Plugin:MirLua/ru/m protocols
2017-09-04T20:16:33Z
<p>Unsane: </p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет функционал для работы с протоколами.<br />
<br />
Подключение модуля: <code>local protos = require('m_protocols')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Протоколы ==<br />
=== GetProtocol ===<br />
Получает протокол<br />
;Параметры<br />
: '''''data'''''<br />
::<br />
{| class="wikitable"<br />
!Тип<br />
|'''number'''<br />
|'''string'''<br />
|-<br />
!Описание<br />
|номер контакта<br />
|название протокола<br />
|}<br />
;Результат<br />
: Тип: '''userdata'''<br />
: Возвращает таблицу [[#PROTOCOLDESCRIPTOR|PROTOCOLDESCRIPTOR]].<br />
;Пример<br />
{{Content:MirLua/Example|code=local proto = protos.GetProtocol({ Name = 'JABBER' })}}<br />
<br />
<br />
=== Protocols ===<br />
Итератор для протоколов<br />
;Параметры<br />
;Результат<br />
: Тип: '''function'''<br />
: Возвращает функцию-итератор для перебора протоколов. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for proto in protos.Protocols() do<br />
print(proto.Name)<br />
end<br />
}}<br />
<br />
<br />
=== CallSendChain ===<br />
Вызывает цепочку обработки для исходящего события (фильтрация, шифрование и т.п.)<br />
; Параметры<br />
: '''''name'''''<br />
:: Тип: '''string'''<br />
:: Имя сервиса<br />
: ''wParam''<br />
: ''lParam''<br />
; Результат<br />
: Тип: '''number'''<br />
: Возвращает результат выполнения сервиса или [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]<br />
; Пример<br />
{{Content:MirLua/Example|code=protos.CallSendChain(hContact, '/SendMsg', 0, a'Hello!')}}<br />
<br />
<br />
<br />
== Аккаунты ==<br />
<br />
<br />
== Структуры ==<br />
=== PROTOCOLDESCRIPTOR ===<br />
Мета-таблица для работы с C-типом PROTOCOLDESCRIPTOR<br />
;Поля<br />
: '''''Name'''''<br />
:: Тип: '''string'''<br />
:: Название протокола<br />
: '''''Type'''''<br />
:: Тип: '''number'''<br />
:: Тип протокола<br />
:: Значения:<br />
::: ''PROTOTYPE_IGNORE'' = 50<br />
::: ''PROTOTYPE_PROTOCOL'' = 1000<br />
::: ''PROTOTYPE_VIRTUAL'' = 1001<br />
::: ''PROTOTYPE_ENCRYPTION'' = 2000<br />
::: ''PROTOTYPE_FILTER'' = 3000<br />
::: ''PROTOTYPE_TRANSLATION'' = 4000<br />
::: ''PROTOTYPE_OTHER'' = 10000<br />
;Методы<br />
: '''''CallService'''''<br />
:: Параметры<br />
::: '''''name'''''<br />
:::: Тип: '''string'''<br />
:::: Имя сервиса<br />
::: ''wParam''<br />
::: ''lParam''<br />
:: Результат<br />
::: Тип: '''number'''<br />
::: Возвращает результат выполнения сервиса или [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]<br />
: '''''Accounts'''''<br />
:: Параметры<br />
:: Результат<br />
::: Тип: '''function'''<br />
::: Возвращает функцию-итератор для перебора списка аккаунтов. Список оканчивается элементом со значением '''nil'''</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_protocols&diff=19882
Plugin:MirLua/ru/m protocols
2017-09-04T20:04:45Z
<p>Unsane: </p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет функционал для работы с протоколами.<br />
<br />
Подключение модуля: <code>local protos = require('m_protocols')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Протоколы ==<br />
=== GetProtocol ===<br />
Получает протокол<br />
;Параметры<br />
: '''''data'''''<br />
::<br />
{| class="wikitable"<br />
!Тип<br />
|'''number'''<br />
|'''string'''<br />
|-<br />
!Описание<br />
|номер контакта<br />
|название протокола<br />
|}<br />
;Результат<br />
: Тип: '''userdata'''<br />
: Возвращает таблицу [[#PROTOCOLDESCRIPTOR|PROTOCOLDESCRIPTOR]].<br />
;Пример<br />
{{Content:MirLua/Example|code=local proto = protos.GetProtocol({ Name = 'JABBER' })}}<br />
<br />
=== Protocols ===<br />
Итератор для протоколов<br />
;Параметры<br />
;Результат<br />
: Тип: '''function'''<br />
: Возвращает функцию-итератор для перебора протоколов. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for proto in protos.Protocols() do<br />
print(proto.Name)<br />
end<br />
}}<br />
<br />
<br />
== Структуры ==<br />
=== PROTOCOLDESCRIPTOR ===<br />
Мета-таблица для работы с C-типом PROTOCOLDESCRIPTOR<br />
;Поля<br />
: '''''Name'''''<br />
:: Тип: '''string'''<br />
:: Название протокола<br />
: '''''Type'''''<br />
:: Тип: '''number'''<br />
:: Тип протокола<br />
:: Значения:<br />
::: ''PROTOTYPE_IGNORE'' = 50<br />
::: ''PROTOTYPE_PROTOCOL'' = 1000<br />
::: ''PROTOTYPE_VIRTUAL'' = 1001<br />
::: ''PROTOTYPE_ENCRYPTION'' = 2000<br />
::: ''PROTOTYPE_FILTER'' = 3000<br />
::: ''PROTOTYPE_TRANSLATION'' = 4000<br />
::: ''PROTOTYPE_OTHER'' = 10000<br />
;Методы<br />
: '''''CallService'''''<br />
:: Параметры<br />
::: '''''name'''''<br />
:::: Тип: '''string'''<br />
:::: Имя сервиса<br />
::: ''wParam''<br />
::: ''lParam''<br />
:: Результат<br />
::: Тип: '''number'''<br />
::: Возвращает результат выполнения сервиса или [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]<br />
: '''''Accounts'''''<br />
:: Параметры<br />
:: Результат<br />
::: Тип: '''function'''<br />
::: Возвращает функцию-итератор для перебора списка аккаунтов. Список оканчивается элементом со значением '''nil'''</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_database&diff=19881
Plugin:MirLua/ru/m database
2017-09-04T20:02:17Z
<p>Unsane: /* Contacts */</p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет доступ к данным и контактам в базе данных профиля пользователя.<br />
<br />
Подключение модуля: <code>local db = require('m_database')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Контакты ==<br />
=== Contacts ===<br />
Итератор для списка контактов<br />
;Параметры<br />
: ''name''<br />
:: Тип: '''string'''<br />
:: Имя протокола<br />
;Результат<br />
: Тип: '''function'''<br />
: Возвращает функцию-итератор для перебора номеров контактов. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hContact in db.Contacts('JABBER_1') do<br />
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))<br />
end<br />
}}<br />
<br />
== События ==<br />
=== GetEventCount ===<br />
Количество событий для контакта<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает количество событий<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}<br />
<br />
=== Events ===<br />
Итератор для списка событий контакта от первого к последнему<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=for hEvent in db.Events(hContact) do<br />
local event = totable(hEvent, "DBEVENTINFO")<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
=== EventsFromEnd ===<br />
Итератор для списка событий контакта от последнего к первому<br />
;Параметры<br />
: '''''hContact'''''<br />
:: Тип: '''number'''<br />
:: Номер контакта<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for hEvent in db.EventsFromEnd(hContact) do<br />
local event = totable(hEvent, "DBEVENTINFO")<br />
print(event.Timestamp, event.Blob)<br />
end<br />
}}<br />
<br />
== Настройки ==<br />
=== GetSetting ===<br />
Возвращает значение настройки<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название модуля<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
: ''value''<br />
:: Тип: '''number''', '''string'''<br />
:: Значание по умолчаниию<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает значение настройки или значание по умолчаниию или '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}<br />
<br />
=== Settings ===<br />
Итератор для секции настроек<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
for setting in db.Settings(nil, 'CList') do<br />
local message = string.format("%s/%s = ", 'CList', setting, ...)<br />
.. db.GetSetting(nil, 'CList', setting)<br />
print(message)<br />
end<br />
}}<br />
<br />
=== WriteSetting ===<br />
Сохраняет значение в БД<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}<br />
<br />
=== DeleteSetting ===<br />
Удаляет настройку<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
: '''''setting'''''<br />
:: Тип: '''string'''<br />
:: Название настройки<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}<br />
<br />
=== DeleteModule ===<br />
Удаляет секцию<br />
;Параметры<br />
: ''hContact''<br />
:: Тип: '''number'''<br />
:: Номер контакта или '''nil'''<br />
: '''''module'''''<br />
:: Тип: '''string'''<br />
:: Название секции<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' в случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}<br />
<br />
[[Category:Руководства]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_protocols&diff=19880
Plugin:MirLua/ru/m protocols
2017-09-04T20:00:54Z
<p>Unsane: Created page with "{{PageLang|ru}} Предоставляет функционал для работы с протоколами. Подключение модуля: <code>local protos = requi..."</p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет функционал для работы с протоколами.<br />
<br />
Подключение модуля: <code>local protos = require('m_protocols')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Протоколы ==<br />
=== GetProtocol ===<br />
Получает протокол<br />
;Параметры<br />
: '''''data'''''<br />
::<br />
{| class="wikitable"<br />
!Тип<br />
|'''number'''<br />
|'''string'''<br />
|-<br />
!Описание<br />
|номер контакта<br />
|название протокола<br />
|}<br />
;Результат<br />
: Тип: '''userdata'''<br />
: Возвращает таблицу [[#PROTOCOLDESCRIPTOR|PROTOCOLDESCRIPTOR]].<br />
;Пример<br />
{{Content:MirLua/Example|code=local proto = protos.GetProtocol({ Name = 'JABBER' })}}<br />
<br />
== Структуры ==<br />
=== PROTOCOLDESCRIPTOR ===<br />
Мета-таблица для работы с C-типом PROTOCOLDESCRIPTOR<br />
;Поля<br />
: '''''Name'''''<br />
:: Тип: '''string'''<br />
:: Название протокола<br />
: '''''Type'''''<br />
:: Тип: '''number'''<br />
:: Тип протокола<br />
:: Значения:<br />
::: ''PROTOTYPE_IGNORE'' = 50<br />
::: ''PROTOTYPE_PROTOCOL'' = 1000<br />
::: ''PROTOTYPE_VIRTUAL'' = 1001<br />
::: ''PROTOTYPE_ENCRYPTION'' = 2000<br />
::: ''PROTOTYPE_FILTER'' = 3000<br />
::: ''PROTOTYPE_TRANSLATION'' = 4000<br />
::: ''PROTOTYPE_OTHER'' = 10000<br />
;Методы<br />
: '''''CallService'''''<br />
:: Параметры<br />
::: '''''name'''''<br />
:::: Тип: '''string'''<br />
:::: Имя сервиса<br />
::: ''wParam''<br />
::: ''lParam''<br />
:: Результат<br />
::: Тип: '''number'''<br />
::: Возвращает результат выполнения сервиса или [[#CALLSERVICE_NOTFOUND|CALLSERVICE_NOTFOUND]]<br />
: '''''Accounts'''''<br />
:: Параметры<br />
:: Результат<br />
::: Тип: '''function'''<br />
::: Возвращает функцию-итератор для перебора списка аккаунтов</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_hotkeys&diff=19876
Plugin:MirLua/ru/m hotkeys
2017-09-02T18:26:36Z
<p>Unsane: /* MakeHotkey */</p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет функционал для работы с комбинациями клавиш.<br />
<br />
Подключение модуля: <code>local hotkeys = require('m_hotkeys')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Функции ==<br />
=== Register ===<br />
Регистрирует комбинацию клавиш.<br />
;Параметры<br />
: '''''data'''''<br />
:: Тип: '''table'''<br />
:: Таблица [[#HotkeyItem|HotkeyItem]].<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''', если комбинация клавиш зарегистрирована, иначе '''false'''.<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
local hIcon = hotkeys.Register({ Name = 'hkUniqueName' })<br />
}}<br />
<br />
=== Unregister ===<br />
Удаляет комбинацию клавиш.<br />
;Параметры<br />
: '''''name'''''<br />
:: Тип: '''string'''<br />
:: Имя комбинации клавиш.<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''', если комбинация клавиш удалена, иначе '''false'''.<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
hotkeys.Unregister('hkUniqueName')<br />
}}<br />
<br />
=== MakeHotkey ===<br />
Создает комбинацию клавиш.<br />
;Параметры<br />
:'''''modifier'''''<br />
::<br />
{| class="wikitable"<br />
!Тип<br />
|'''number'''||'''string'''||'''table'''<br />
|-<br />
!Описание<br />
|код клавиш-модификаторов<br />
|название клавиши-модификатора<br />
|список названий клавиш-модификаторов<br />
|-<br />
!Значения<br />
|<br />
*shift = 0x01<br />
*control = 0x02<br />
*alt = 0x04<br />
*win = 0x08<br />
|colspan="2"|<br />
*ctrl<br />
*shift<br />
*alt<br />
*ext<br />
|}<br />
: '''''key'''''<br />
:: Тип: '''string'''<br />
:: Символ.<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает комбинацию клавиш.<br />
;Примеры<br />
{{Content:MirLua/Example|code=<br />
local HOTKEYF_SHIFT = 0x01<br />
local HOTKEYF_ALT = 0x04<br />
local hk = hotkeys.MakeHotkey(HOTKEYF_SHIFT {{!}} HOTKEYF_ALT, 'A')<br />
}}<br />
{{Content:MirLua/Example|code=<br />
local hk = hotkeys.MakeHotkey('ctrl', 'A')<br />
}}<br />
{{Content:MirLua/Example|code=<br />
local hk = hotkeys.MakeHotkey({ 'ctrl', 'alt' }, 'A')<br />
}}<br />
<br />
== Структуры ==<br />
=== HotkeyItem ===<br />
Таблица, описывающая параметры комбинации клавиш.<br />
;Поля<br />
: '''''Name'''''<br />
:: Тип: '''string'''<br />
:: Имя комбинации клавиш (автоматически переводится ядром).<br />
: ''Description''<br />
:: Тип: '''string'''<br />
:: Описание комбинации клавиш (автоматически переводится ядром).<br />
: ''Section''<br />
:: Тип: '''string'''<br />
:: Название секции для группировки в настройках. По умолчанию в качестве секции используется название плагина (''MirLua'').<br />
: ''Hotkey''<br />
:: Тип: '''number'''<br />
:: [[Plugin:MirLua/ru/m_hotkeys#MakeHotkey|Комбинация клавиш]] по умолчанию.<br />
: ''Service''<br />
:: Тип: '''string'''<br />
:: Имя [[Plugin:MirLua/ru/m_core#CreateServiceFunction|сервиса]].<br />
: ''Flags''<br />
:: Тип: '''number'''<br />
:: Дополнительные флаги.<br />
<br />
[[Category:Руководства]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_hotkeys&diff=19875
Plugin:MirLua/ru/m hotkeys
2017-09-02T18:23:54Z
<p>Unsane: /* MakeHotkey */</p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет функционал для работы с комбинациями клавиш.<br />
<br />
Подключение модуля: <code>local hotkeys = require('m_hotkeys')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Функции ==<br />
=== Register ===<br />
Регистрирует комбинацию клавиш.<br />
;Параметры<br />
: '''''data'''''<br />
:: Тип: '''table'''<br />
:: Таблица [[#HotkeyItem|HotkeyItem]].<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''', если комбинация клавиш зарегистрирована, иначе '''false'''.<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
local hIcon = hotkeys.Register({ Name = 'hkUniqueName' })<br />
}}<br />
<br />
=== Unregister ===<br />
Удаляет комбинацию клавиш.<br />
;Параметры<br />
: '''''name'''''<br />
:: Тип: '''string'''<br />
:: Имя комбинации клавиш.<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''', если комбинация клавиш удалена, иначе '''false'''.<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
hotkeys.Unregister('hkUniqueName')<br />
}}<br />
<br />
=== MakeHotkey ===<br />
Создает комбинацию клавиш.<br />
;Параметры<br />
:'''''modifier'''''<br />
::<br />
{| class="wikitable"<br />
!Тип<br />
|'''number'''||'''string'''||'''table'''<br />
|-<br />
!Описание<br />
|код клавиш-модификаторов||название клавиши-модификатора||список названий клавиш-модификаторов<br />
|-<br />
!Допустимые значения<br />
|<br />
*shift = 0x01<br />
*control = 0x02<br />
*alt = 0x04<br />
*win = 0x08<br />
|<br />
*ctrl<br />
*shift<br />
*alt<br />
*ext<br />
|<br />
*ctrl<br />
*shift<br />
*alt<br />
*ext<br />
|}<br />
: '''''key'''''<br />
:: Тип: '''string'''<br />
:: Символ.<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает комбинацию клавиш.<br />
;Примеры<br />
{{Content:MirLua/Example|code=<br />
local HOTKEYF_SHIFT = 0x01<br />
local HOTKEYF_ALT = 0x04<br />
local hk = hotkeys.MakeHotkey(HOTKEYF_SHIFT {{!}} HOTKEYF_ALT, 'A')<br />
}}<br />
{{Content:MirLua/Example|code=<br />
local hk = hotkeys.MakeHotkey('ctrl', 'A')<br />
}}<br />
{{Content:MirLua/Example|code=<br />
local hk = hotkeys.MakeHotkey({ 'ctrl', 'alt' }, 'A')<br />
}}<br />
<br />
== Структуры ==<br />
=== HotkeyItem ===<br />
Таблица, описывающая параметры комбинации клавиш.<br />
;Поля<br />
: '''''Name'''''<br />
:: Тип: '''string'''<br />
:: Имя комбинации клавиш (автоматически переводится ядром).<br />
: ''Description''<br />
:: Тип: '''string'''<br />
:: Описание комбинации клавиш (автоматически переводится ядром).<br />
: ''Section''<br />
:: Тип: '''string'''<br />
:: Название секции для группировки в настройках. По умолчанию в качестве секции используется название плагина (''MirLua'').<br />
: ''Hotkey''<br />
:: Тип: '''number'''<br />
:: [[Plugin:MirLua/ru/m_hotkeys#MakeHotkey|Комбинация клавиш]] по умолчанию.<br />
: ''Service''<br />
:: Тип: '''string'''<br />
:: Имя [[Plugin:MirLua/ru/m_core#CreateServiceFunction|сервиса]].<br />
: ''Flags''<br />
:: Тип: '''number'''<br />
:: Дополнительные флаги.<br />
<br />
[[Category:Руководства]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_hotkeys&diff=19874
Plugin:MirLua/ru/m hotkeys
2017-09-02T18:22:59Z
<p>Unsane: /* MakeHotkey */</p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет функционал для работы с комбинациями клавиш.<br />
<br />
Подключение модуля: <code>local hotkeys = require('m_hotkeys')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Функции ==<br />
=== Register ===<br />
Регистрирует комбинацию клавиш.<br />
;Параметры<br />
: '''''data'''''<br />
:: Тип: '''table'''<br />
:: Таблица [[#HotkeyItem|HotkeyItem]].<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''', если комбинация клавиш зарегистрирована, иначе '''false'''.<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
local hIcon = hotkeys.Register({ Name = 'hkUniqueName' })<br />
}}<br />
<br />
=== Unregister ===<br />
Удаляет комбинацию клавиш.<br />
;Параметры<br />
: '''''name'''''<br />
:: Тип: '''string'''<br />
:: Имя комбинации клавиш.<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''', если комбинация клавиш удалена, иначе '''false'''.<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
hotkeys.Unregister('hkUniqueName')<br />
}}<br />
<br />
=== MakeHotkey ===<br />
Создает комбинацию клавиш.<br />
;Параметры<br />
:'''''modifier'''''<br />
::<br />
{| class="wikitable"<br />
!Тип<br />
|'''number'''||'''string'''||'''table'''<br />
|-<br />
!Описание<br />
|код клавиш-модификаторов||название клавиши-модификатора||список названий клавиш-модификаторов<br />
|-<br />
!Допустимые значения<br />
|<br />
*shift = 0x01<br />
*control = 0x02<br />
*alt = 0x04<br />
*win = 0x08<br />
|<br />
*'ctrl'<br />
*'shift'<br />
*'alt'<br />
*'ext'<br />
|<br />
*'ctrl'<br />
*'shift'<br />
*'alt'<br />
*'ext'<br />
|}<br />
: '''''key'''''<br />
:: Тип: '''string'''<br />
:: Символ.<br />
;Результат<br />
: Тип: '''number'''<br />
: Возвращает комбинацию клавиш.<br />
;Примеры<br />
{{Content:MirLua/Example|code=<br />
local HOTKEYF_SHIFT = 0x01<br />
local HOTKEYF_ALT = 0x04<br />
local hk = hotkeys.MakeHotkey(HOTKEYF_SHIFT {{!}} HOTKEYF_ALT, 'A')<br />
}}<br />
{{Content:MirLua/Example|code=<br />
local hk = hotkeys.MakeHotkey('ctrl', 'A')<br />
}}<br />
{{Content:MirLua/Example|code=<br />
local hk = hotkeys.MakeHotkey({ 'ctrl', 'alt' }, 'A')<br />
}}<br />
<br />
== Структуры ==<br />
=== HotkeyItem ===<br />
Таблица, описывающая параметры комбинации клавиш.<br />
;Поля<br />
: '''''Name'''''<br />
:: Тип: '''string'''<br />
:: Имя комбинации клавиш (автоматически переводится ядром).<br />
: ''Description''<br />
:: Тип: '''string'''<br />
:: Описание комбинации клавиш (автоматически переводится ядром).<br />
: ''Section''<br />
:: Тип: '''string'''<br />
:: Название секции для группировки в настройках. По умолчанию в качестве секции используется название плагина (''MirLua'').<br />
: ''Hotkey''<br />
:: Тип: '''number'''<br />
:: [[Plugin:MirLua/ru/m_hotkeys#MakeHotkey|Комбинация клавиш]] по умолчанию.<br />
: ''Service''<br />
:: Тип: '''string'''<br />
:: Имя [[Plugin:MirLua/ru/m_core#CreateServiceFunction|сервиса]].<br />
: ''Flags''<br />
:: Тип: '''number'''<br />
:: Дополнительные флаги.<br />
<br />
[[Category:Руководства]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_clist&diff=19871
Plugin:MirLua/ru/m clist
2017-09-02T17:48:32Z
<p>Unsane: Created page with "{{PageLang|ru}} Предоставляет функционал для работы с меню списка контактов. Подключение модуля: <code>lo..."</p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет функционал для работы с меню списка контактов.<br />
<br />
Подключение модуля: <code>local clist = require('m_clist')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Главное меню ==<br />
=== AddMainMenuRoot ===<br />
Создает корневой пункт в главном меню<br />
<br />
;Параметры<br />
: '''''name'''''<br />
:: Тип: '''string'''<br />
:: Название пункта меню<br />
: ''position''<br />
:: Тип: '''number'''<br />
:: Позиция пункта меню<br />
: ''hIcon''<br />
:: Тип: '''light userdata'''<br />
:: Дескриптор [[Plugin:MirLua/ru/m_icolib#AddIcon|значка]]<br />
;Результат<br />
: Тип: '''light userdata'''<br />
: Возвращает дескриптор пункта меню в случае успеха, иначе '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=local hRootMenuItem = m.AddMainMenuRoot('My root menu item')}}<br />
<br />
=== AddMainMenuItem ===<br />
Создает пункт в главном меню<br />
<br />
;Параметры<br />
: '''''data'''''<br />
:: Тип: '''table'''<br />
:: Таблица [[Plugin:MirLua/ru/m_genmenu#MenuItem|MenuItem]]<br />
;Результат<br />
: Тип: '''light userdata'''<br />
: Возвращает дескриптор пункта меню в случае успеха, иначе '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=local hMenuItem = m.AddMainMenuItem({ Name ='My menu item' })}}<br />
<br />
== Меню контакта ==<br />
=== AddContactMenuRoot ===<br />
Создает корневой пункт в меню контакта<br />
<br />
;Параметры<br />
: '''''name'''''<br />
:: Тип: '''string'''<br />
:: Название пункта меню<br />
: ''position''<br />
:: Тип: '''number'''<br />
:: Позиция пункта меню<br />
: ''hIcon''<br />
:: Тип: '''light userdata'''<br />
:: Дескриптор [[Plugin:MirLua/ru/m_icolib#AddIcon|значка]]<br />
;Результат<br />
: Тип: '''light userdata'''<br />
: Возвращает дескриптор пункта меню в случае успеха, иначе '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=local hRootMenuItem = m.AddContactMenuRoot('My contact menu item')}}<br />
<br />
=== AddContactMenuItem ===<br />
Создает пункт в меню контакта<br />
<br />
;Параметры<br />
: '''''data'''''<br />
:: Тип: '''table'''<br />
:: Таблица [[Plugin:MirLua/ru/m_genmenu#MenuItem|MenuItem]]<br />
<!--<br />
: ''protocol''<br />
:: Тип: '''string'''<br />
:: Название протокола (префикс для названия сервиса)<br />
--><br />
;Результат<br />
: Тип: '''light userdata'''<br />
: Возвращает дескриптор пункта меню в случае успеха, иначе '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=local hMenuItem = m.AddContactMenuItem ({ Name ='My menu item' })}}<br />
<br />
== Меню трея ==<br />
=== AddTrayMenuItem ===<br />
Создает пункт в меню трея<br />
<br />
;Параметры<br />
: '''''data'''''<br />
:: Тип: '''table'''<br />
:: Таблица [[Plugin:MirLua/ru/m_genmenu#MenuItem|MenuItem]]<br />
;Результат<br />
: Тип: '''light userdata'''<br />
: Возвращает дескриптор пункта меню в случае успеха, иначе '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=local hMenuItem = m.AddTrayMenuItem ({ Name ='My menu item' })}}<br />
<br />
[[Category:Руководства]]</div>
Unsane
https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_genmenu&diff=19870
Plugin:MirLua/ru/m genmenu
2017-09-02T17:26:21Z
<p>Unsane: </p>
<hr />
<div>{{PageLang|ru}}<br />
Предоставляет доступ к подсистеме меню.<br />
<br />
Подключение модуля: <code>local genmenu = require('m_genmenu')</code><br />
<br />
{{Note|Параметры, выделенные '''''жирным курсивом''''', являются обязательными.}}<br />
<br />
<br />
__TOC__<br />
<br />
== Функции ==<br />
<!--<br />
=== CreateRoot ===<br />
Создает корневой пункт меню<br />
;Параметры<br />
: '''''hMenuObject'''''<br />
:: Тип: '''number'''<br />
:: Дескриптор глобального меню<br />
: '''''name'''''<br />
:: Тип: '''string'''<br />
:: Название пункта меню<br />
: ''position''<br />
:: Тип: '''number'''<br />
:: Позиция пункта меню<br />
: ''icon''<br />
:: Тип: '''light userdata'''<br />
:: Дескриптор [[Plugin:MirLua/ru/m_icolib#AddIcon|значка]]<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=local hMenuItem = genmenu.CreateRoot(genmenu.MO_MAIN)}}<br />
<br />
=== AddMenuItem ===<br />
Создает пункт меню<br />
;Параметры<br />
: '''''hMenuObject'''''<br />
:: Тип: '''number'''<br />
:: Дескриптор глобального меню<br />
: '''''menuItem'''''<br />
:: Тип: '''table'''<br />
:: Таблица [[#MenuItem|MenuItem]]<br />
;Результат<br />
: Тип: '''light userdata'''<br />
: Возвращает дескриптор пункта меню в случае успеха, иначе '''nil'''<br />
;Пример<br />
{{Content:MirLua/Example|code=<br />
local hMenuItem = genmenu.AddMenuItem(genmenu.MO_MAIN, { Name = 'MyMenuItem'})<br />
}}<br />
--><br />
<br />
=== ModifyMenuItem ===<br />
Изменяет пункт меню<br />
;Параметры<br />
: '''''hMenuItem'''''<br />
:: Тип: '''light userdata'''<br />
:: Дескриптор пункта меню<br />
: '''''name'''''<br />
:: Тип: '''string'''<br />
:: Новое название пункта меню или '''nil'''<br />
: '''''icon'''''<br />
:: Тип: '''light userdata'''<br />
:: Дескриптор [[Plugin:MirLua/ru/m_icolib#AddIcon|значка]] или ''[[Plugin:MirLua/ru/m_core#INVALID_HANDLE_VALUE|INVALID_HANDLE_VALUE]]''<br />
: '''''flags'''''<br />
:: Тип: '''number'''<br />
:: Дополнительные флаги или ''-1''<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=local hMenuItem = genmenu.ModifyMenuItem(hMenuItem, 'New name', m.INVALID_HANDLE_VALUE)}}<br />
<br />
<br />
=== ConfigureMenuItem ===<br />
Дополнительная настройка пункта меню<br />
;Параметры<br />
: '''''hMenuItem'''''<br />
:: Тип: '''light userdata'''<br />
:: Дескриптор пункта меню<br />
: '''''option'''''<br />
:: Тип: ''''''number''''''<br />
:: изменяемая настройка (1 - название; 2 - горячие клавиши; 3 - параметр для исполнения; 4 - UUID)<br />
: '''''value'''''<br />
:: Тип: '''light userdata'''<br />
:: значение<br />
;Результат<br />
: Тип: '''light userdata'''<br />
: Возвращает '''true''' случае успеха, иначе '''false'''<br />
<br />
=== ShowMenuItem ===<br />
Показывает/скрывает пункт меню<br />
;Параметры<br />
: '''''hMenuItem'''''<br />
:: Тип: '''light userdata'''<br />
:: Дескриптор пункта меню<br />
: '''''isShown'''''<br />
:: Тип: '''boolean'''<br />
:: '''true''' для отображения пункта меню, '''false''' для скрытия<br />
;Пример<br />
{{Content:MirLua/Example|code=genmenu.ShowMenuItem(hMenuItem, true)}}<br />
<br />
=== EnableMenuItem ===<br />
Включает/отключает пункт меню<br />
;Параметры<br />
: '''''hMenuItem'''''<br />
:: Тип: '''light userdata'''<br />
:: Дескриптор пункта меню<br />
: '''''isEnabled'''''<br />
:: Тип: '''boolean'''<br />
:: '''true''' для включения пункта меню, '''false''' для отключения<br />
;Пример<br />
{{Content:MirLua/Example|code=genmenu.EnableMenuItem(hMenuItem, false)}}<br />
<br />
=== CheckMenuItem ===<br />
Отмечает/снимает отметку с пункта меню<br />
;Параметры<br />
: '''''hMenuItem'''''<br />
:: Тип: '''light userdata'''<br />
:: Дескриптор пункта меню<br />
: '''''isChecked'''''<br />
:: Тип: '''boolean'''<br />
:: '''true''' для включения пункта меню, '''false''' для отключения<br />
;Пример<br />
{{Content:MirLua/Example|code=genmenu.CheckMenuItem(hMenuItem, true)}}<br />
<br />
=== RemoveMenuItem ===<br />
Удаляет пункт меню<br />
;Параметры<br />
: '''''hMenuItem'''''<br />
:: Тип: '''light userdata'''<br />
:: Дескриптор пункта меню<br />
;Результат<br />
: Тип: '''boolean'''<br />
: Возвращает '''true''' случае успеха, иначе '''false'''<br />
;Пример<br />
{{Content:MirLua/Example|code=genmenu.RemoveMenuItem(hMenuItem)}}<br />
<br />
<br />
== Структуры ==<br />
=== MenuItem ===<br />
Таблица, описывающая параметры меню<br />
;Поля<br />
: '''''Name'''''<br />
:: Тип: '''string'''<br />
:: Название пункта меню (автоматически переводится ядром)<br />
: ''Uid''<br />
:: Тип: '''string'''<br />
:: UUID пункта меню в формате ''xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx''<br />
: ''Service''<br />
:: Тип: '''string'''<br />
:: Имя [[Plugin:MirLua/ru/m_core#CreateServiceFunction|сервиса]]<br />
: ''Position''<br />
:: Тип: '''number'''<br />
:: Позиция пункта меню<br />
: ''Parent''<br />
:: Тип: '''light userdata'''<br />
:: Дескриптор родительского меню<br />
: ''Icon''<br />
:: Тип: '''light userdata'''<br />
:: Дескриптор [[Plugin:MirLua/ru/m_icolib#AddIcon|значка]]<br />
: ''Flags''<br />
:: Тип: '''number'''<br />
:: Дополнительные флаги<br />
<br />
[[Category:Руководства]]</div>
Unsane