Plugin:MirLua/Module/m sounds - Revision history

Goraf: import correct table headers; remove untranslatable colons

2018-06-02T10:59:25Z

import correct table headers; remove untranslatable colons

← Older revision		Revision as of 13:59, 2 June 2018
Line 5:		Line 5:
	</translate>		</translate>

	{{Ls\|MirLua/Modules/include_info}}: <code>local sounds = require('m_sounds')</code>		{{Ls\|MirLua/Modules/include_info}} <code>local sounds = require('m_sounds')</code>

	__TOC__		__TOC__
Line 19:		Line 19:
	! scope="col" \| {{Ls\|MirLua/Modules/param_name}}		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
	! scope="col" \| {{Ls\|MirLua/Modules/required_param}}		! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
	! scope="col" \| {{Ls\|~~MirLua~~/~~Modules~~/type}}		! scope="col" \| {{Ls\|Content/TableHeaders/type}}
	! scope="col" \| {{Ls\|Content/TableHeaders/description}}		! scope="col" \| {{Ls\|Content/TableHeaders/description}}
	\|-		\|-
Line 44:		Line 44:

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

	{{nbsp\|5}}<translate><!--T:8--> Returns <tvar\|return_on_success><code>true</code></> if sound was registered successfully, otherwise <tvar\|return_on_fail><code>false</code></>.</translate>		{{nbsp\|5}}<translate><!--T:8--> Returns <tvar\|return_on_success><code>true</code></> if sound was registered successfully, otherwise <tvar\|return_on_fail><code>false</code></>.</translate>
Line 60:		Line 60:
	! scope="col" \| {{Ls\|MirLua/Modules/param_name}}		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
	! scope="col" \| {{Ls\|MirLua/Modules/required_param}}		! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
	! scope="col" \| {{Ls\|~~MirLua~~/~~Modules~~/type}}		! scope="col" \| {{Ls\|Content/TableHeaders/type}}
	! scope="col" \| {{Ls\|Content/TableHeaders/description}}		! scope="col" \| {{Ls\|Content/TableHeaders/description}}
	\|-		\|-
Line 70:		Line 70:

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

	{{nbsp\|5}}<translate><!--T:11--> Returns <tvar\|return_on_success><code>true</code></> if sound was played successfully, otherwise <tvar\|return_on_fail><code>false</code></>.</translate>		{{nbsp\|5}}<translate><!--T:11--> Returns <tvar\|return_on_success><code>true</code></> if sound was played successfully, otherwise <tvar\|return_on_fail><code>false</code></>.</translate>
Line 86:		Line 86:
	! scope="col" \| {{Ls\|MirLua/Modules/param_name}}		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
	! scope="col" \| {{Ls\|MirLua/Modules/required_param}}		! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
	! scope="col" \| {{Ls\|~~MirLua~~/~~Modules~~/type}}		! scope="col" \| {{Ls\|Content/TableHeaders/type}}
	! scope="col" \| {{Ls\|Content/TableHeaders/description}}		! scope="col" \| {{Ls\|Content/TableHeaders/description}}
	\|-		\|-
Line 96:		Line 96:

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

	{{nbsp\|5}}<translate><!--T:14--> Returns <tvar\|return_on_success><code>true</code></> if sound was played successfully, otherwise <tvar\|return_on_fail><code>false</code></>.</translate>		{{nbsp\|5}}<translate><!--T:14--> Returns <tvar\|return_on_success><code>true</code></> if sound was played successfully, otherwise <tvar\|return_on_fail><code>false</code></>.</translate>

Goraf: turn all parameters list into tables

2018-06-01T18:55:24Z

turn all parameters list into tables

← Older revision		Revision as of 21:55, 1 June 2018
Line 16:		Line 16:
	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	{\| class="wikitable"		{\| class="wikitable"
	~~\|+ {{Ls\|MirLua/Modules/parameters}}~~
	\|-		\|-
	! scope="col" \| {{Ls\|MirLua/Modules/param_name}}		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
Line 57:		Line 56:

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{~~nbsp~~\|5}}~~''name''~~ {{~~Nobold~~\|({{Ls\|MirLua/Modules/~~required_param~~}})}}		{\| class="wikitable"
	:: {{Ls\|~~MirLua/Modules~~/~~type~~}}: <code>string</code>		\|-
	:: <translate><!--T:10--> Unique name.</translate>		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
			! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
			! scope="col" \| {{Ls\|MirLua/Modules/type}}
			! scope="col" \| {{Ls\|Content/TableHeaders/description}}
			\|-
			! scope="row" class="MirLuaParametersTable-parameter" \| name
			\| style="text-align:center" \| {{Ls\|YesNo/yes}}
			\| style="text-align:center" \| <code>string</code>
			\| <translate><!--T:10--> Unique name.</translate>
			\|}

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
Line 74:		Line 82:

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{~~nbsp~~\|5}}~~''path''~~ {{~~Nobold~~\|({{Ls\|MirLua/Modules/~~required_param~~}})}}		{\| class="wikitable"
	:: {{Ls\|~~MirLua/Modules~~/~~type~~}}: <code>string</code>		\|-
	:: <translate><!--T:13--> Path to file.</translate>		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
			! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
			! scope="col" \| {{Ls\|MirLua/Modules/type}}
			! scope="col" \| {{Ls\|Content/TableHeaders/description}}
			\|-
			! scope="row" class="MirLuaParametersTable-parameter" \| path
			\| style="text-align:center" \| {{Ls\|YesNo/yes}}
			\| style="text-align:center" \| <code>string</code>
			\| <translate><!--T:13--> Path to file.</translate>
			\|}

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====

Goraf: turning AddSound parameters into table - fully localize headers, use CSS class for parameters (final iteration)

2018-06-01T18:32:15Z

turning AddSound parameters into table - fully localize headers, use CSS class for parameters (final iteration)

Goraf: use localized yes/no in parameters table

2018-06-01T16:17:04Z

use localized yes/no in parameters table

Goraf: turning AddSound parameters into table - first iteration

2018-05-31T14:50:49Z

turning AddSound parameters into table - first iteration

← Older revision		Revision as of 17:50, 31 May 2018
Line 15:		Line 15:

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{~~nbsp~~\|5}}~~''name''~~ {{~~Nobold~~\|({{Ls\|MirLua/Modules/required_param~~}})~~}}		{\| class="wikitable"
	:: {{Ls\|MirLua/Modules/type}}: <code>string</code>		\|+ {{Ls\|MirLua/Modules/parameters}}
	:: <translate><!--T:4--> Unique name.</translate>		\|-
			! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
	~~; {{nbsp~~\|~~5}}''~~description~~'' {{Nobold~~\|~~({{Ls~~\|~~MirLua/Modules/required_param}})}}~~		! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
	:~~: {{Ls~~\|~~MirLua/Modules/type}}:~~ <code>string</code>		! scope="col" \| {{Ls\|MirLua/Modules/type}}
	:: <translate><!--T:5--> Description.</translate>		! scope="col" \| Description
			\|-
	~~; {{nbsp~~\|~~5}}''~~section''		! scope="row" style="text-align:left" \| name
	:: ~~{{Ls~~\|~~MirLua/Modules/type}}:~~ <code>string</code>		\| style="text-align:center" \| yes
	:: <translate><!--T:6--> Section name in Miranda sound settings. By default plugin name (<tvar\|default_name>''MirLua''</>) is used.</translate>		\| style="text-align:center" \| <code>string</code>
			\| <translate><!--T:4--> Unique name.</translate>
	~~; {{nbsp~~\|~~5}}''~~path''		\|-
	:: ~~{{Ls~~\|~~MirLua/Modules/type}}:~~ <code>string</code>		! scope="row" style="text-align:left" \| description
	:: <translate><!--T:7--> Path to sound file.</translate>		\| style="text-align:center" \| yes
			\| style="text-align:center" \| <code>string</code>
			\| <translate><!--T:5--> Description.</translate>
			\|-
			! scope="row" style="text-align:left" \| section
			\| style="text-align:center" \| no
			\| style="text-align:center" \| <code>string</code>
			\| <translate><!--T:6--> Section name in Miranda sound settings. By default plugin name (<tvar\|default_name>''MirLua''</>) is used.</translate>
			\|-
			! scope="row" style="text-align:left" \| path
			\| style="text-align:center" \| no
			\| style="text-align:center" \| <code>string</code>
			\| <translate><!--T:7--> Path to sound file.</translate>
			\|}

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====

Goraf: correct target of localized string after change (to be 'required_param' now)

2018-04-17T16:16:11Z

correct target of localized string after change (to be 'required_param' now)

Goraf: wrap language keywords with code tags

2018-04-15T15:50:10Z

wrap language keywords with code tags

Goraf: add separators for better visual distinction between consecutive functions

2018-04-15T15:40:24Z

add separators for better visual distinction between consecutive functions

← Older revision		Revision as of 18:40, 15 April 2018
Line 38:		Line 38:
	==== {{Ls\|MirLua/Modules/example}} ====		==== {{Ls\|MirLua/Modules/example}} ====
	{{Content:MirLua/Example\|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}		{{Content:MirLua/Example\|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}
			----

	=== PlaySound ===		=== PlaySound ===
Line 54:		Line 55:
	==== {{Ls\|MirLua/Modules/example}} ====		==== {{Ls\|MirLua/Modules/example}} ====
	{{Content:MirLua/Example\|code=sounds.PlaySound('soundUniqueName')}}		{{Content:MirLua/Example\|code=sounds.PlaySound('soundUniqueName')}}
			----

	=== PlayFile ===		=== PlayFile ===

Goraf: Marked this version for translation

2018-04-15T15:25:25Z

Marked this version for translation

← Older revision		Revision as of 18:25, 15 April 2018
Line 9:		Line 9:
	__TOC__		__TOC__
	<translate>		<translate>
	== Functions ==		== Functions == <!--T:2-->
	</translate>		</translate>
	=== AddSound ===		=== AddSound ===
	<translate>Registers a sound.</translate>		<translate><!--T:3--> Registers a sound.</translate>

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: '''string'''		:: {{Ls\|MirLua/Modules/type}}: '''string'''
	:: <translate>Unique name.</translate>		:: <translate><!--T:4--> Unique name.</translate>

	; {{nbsp\|5}}''description'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''description'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: '''string'''		:: {{Ls\|MirLua/Modules/type}}: '''string'''
	:: <translate>Description.</translate>		:: <translate><!--T:5--> Description.</translate>

	; {{nbsp\|5}}''section''		; {{nbsp\|5}}''section''
	:: {{Ls\|MirLua/Modules/type}}: '''string'''		:: {{Ls\|MirLua/Modules/type}}: '''string'''
	:: <translate>Section name in Miranda sound settings. By default plugin name (<tvar\|default_name>''MirLua''</>) is used.</translate>		:: <translate><!--T:6--> Section name in Miranda sound settings. By default plugin name (<tvar\|default_name>''MirLua''</>) is used.</translate>

	; {{nbsp\|5}}''path''		; {{nbsp\|5}}''path''
	:: {{Ls\|MirLua/Modules/type}}: '''string'''		:: {{Ls\|MirLua/Modules/type}}: '''string'''
	:: <translate>Path to sound file.</translate>		:: <translate><!--T:7--> Path to sound file.</translate>

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: '''boolean'''		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: '''boolean'''

	{{nbsp\|5}}<translate>Returns <tvar\|return_on_success>'''true'''</> if sound was registered successfully, otherwise <tvar\|return_on_fail>'''false'''</>.</translate>		{{nbsp\|5}}<translate><!--T:8--> Returns <tvar\|return_on_success>'''true'''</> if sound was registered successfully, otherwise <tvar\|return_on_fail>'''false'''</>.</translate>

	==== {{Ls\|MirLua/Modules/example}} ====		==== {{Ls\|MirLua/Modules/example}} ====
Line 40:		Line 40:

	=== PlaySound ===		=== PlaySound ===
	<translate>Plays sound by its unique name.</translate>		<translate><!--T:9--> Plays sound by its unique name.</translate>

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: '''string'''		:: {{Ls\|MirLua/Modules/type}}: '''string'''
	:: <translate>Unique name.</translate>		:: <translate><!--T:10--> Unique name.</translate>

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: '''boolean'''		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: '''boolean'''

	{{nbsp\|5}}<translate>Returns <tvar\|return_on_success>'''true'''</> if sound was played successfully, otherwise <tvar\|return_on_fail>'''false'''</>.</translate>		{{nbsp\|5}}<translate><!--T:11--> Returns <tvar\|return_on_success>'''true'''</> if sound was played successfully, otherwise <tvar\|return_on_fail>'''false'''</>.</translate>

	==== {{Ls\|MirLua/Modules/example}} ====		==== {{Ls\|MirLua/Modules/example}} ====
Line 56:		Line 56:

	=== PlayFile ===		=== PlayFile ===
	<translate>Plays sound from file.</translate>		<translate><!--T:12--> Plays sound from file.</translate>

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''path'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''path'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: '''string'''		:: {{Ls\|MirLua/Modules/type}}: '''string'''
	:: <translate>Path to file.</translate>		:: <translate><!--T:13--> Path to file.</translate>

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: '''boolean'''		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: '''boolean'''

	{{nbsp\|5}}<translate>Returns <tvar\|return_on_success>'''true'''</> if sound was played successfully, otherwise <tvar\|return_on_fail>'''false'''</>.</translate>		{{nbsp\|5}}<translate><!--T:14--> Returns <tvar\|return_on_success>'''true'''</> if sound was played successfully, otherwise <tvar\|return_on_fail>'''false'''</>.</translate>

	==== {{Ls\|MirLua/Modules/example}} ====		==== {{Ls\|MirLua/Modules/example}} ====
	{{Content:MirLua/Example\|code=sounds.PlayFile('c:\\lambada.wav')}}		{{Content:MirLua/Example\|code=sounds.PlayFile('c:\\lambada.wav')}}

Goraf: mark translation units

2018-04-15T15:23:42Z

mark translation units

← Older revision		Revision as of 18:23, 15 April 2018
Line 8:		Line 8:

	__TOC__		__TOC__
			<translate>
	== Functions ==		== Functions ==
			</translate>
	=== AddSound ===		=== AddSound ===
	Registers a sound.		<translate>Registers a sound.</translate>

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: '''string'''		:: {{Ls\|MirLua/Modules/type}}: '''string'''
	:: Unique name.		:: <translate>Unique name.</translate>

	; {{nbsp\|5}}''description'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''description'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: '''string'''		:: {{Ls\|MirLua/Modules/type}}: '''string'''
	:: Description.		:: <translate>Description.</translate>

	; {{nbsp\|5}}''section''		; {{nbsp\|5}}''section''
	:: {{Ls\|MirLua/Modules/type}}: '''string'''		:: {{Ls\|MirLua/Modules/type}}: '''string'''
	:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.		:: <translate>Section name in Miranda sound settings. By default plugin name (<tvar\|default_name>''MirLua''</>) is used.</translate>

	; {{nbsp\|5}}''path''		; {{nbsp\|5}}''path''
	:: {{Ls\|MirLua/Modules/type}}: '''string'''		:: {{Ls\|MirLua/Modules/type}}: '''string'''
	:: Path to sound file.		:: <translate>Path to sound file.</translate>

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: '''boolean'''		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: '''boolean'''

	{{nbsp\|5}}Returns '''true''' if sound was registered successfully, otherwise '''false'''.		{{nbsp\|5}}<translate>Returns <tvar\|return_on_success>'''true'''</> if sound was registered successfully, otherwise <tvar\|return_on_fail>'''false'''</>.</translate>

	==== {{Ls\|MirLua/Modules/example}} ====		==== {{Ls\|MirLua/Modules/example}} ====
Line 40:		Line 40:

	=== PlaySound ===		=== PlaySound ===
	Plays sound by its unique name.		<translate>Plays sound by its unique name.</translate>

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: '''string'''		:: {{Ls\|MirLua/Modules/type}}: '''string'''
	:: Unique name.		:: <translate>Unique name.</translate>

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: '''boolean'''		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: '''boolean'''

	{{nbsp\|5}}Returns '''true''' if sound was played successfully, otherwise '''false'''.		{{nbsp\|5}}<translate>Returns <tvar\|return_on_success>'''true'''</> if sound was played successfully, otherwise <tvar\|return_on_fail>'''false'''</>.</translate>

	==== {{Ls\|MirLua/Modules/example}} ====		==== {{Ls\|MirLua/Modules/example}} ====
Line 56:		Line 56:

	=== PlayFile ===		=== PlayFile ===
	Plays sound from file.		<translate>Plays sound from file.</translate>

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''path'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''path'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: '''string'''		:: {{Ls\|MirLua/Modules/type}}: '''string'''
	:: Path to file.		:: <translate>Path to file.</translate>

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
	{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: '''boolean'''		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: '''boolean'''

	{{nbsp\|5}}Returns '''true''' if sound was played successfully, otherwise '''false'''.		{{nbsp\|5}}<translate>Returns <tvar\|return_on_success>'''true'''</> if sound was played successfully, otherwise <tvar\|return_on_fail>'''false'''</>.</translate>

	==== {{Ls\|MirLua/Modules/example}} ====		==== {{Ls\|MirLua/Modules/example}} ====
	{{Content:MirLua/Example\|code=sounds.PlayFile('c:\\lambada.wav')}}		{{Content:MirLua/Example\|code=sounds.PlayFile('c:\\lambada.wav')}}

← Older revision		Revision as of 13:59, 2 June 2018
Line 5:		Line 5:
	</translate>		</translate>

	{{Ls\|MirLua/Modules/include_info}}: <code>local sounds = require('m_sounds')</code>		{{Ls\|MirLua/Modules/include_info}} <code>local sounds = require('m_sounds')</code>

	__TOC__		__TOC__
Line 19:		Line 19:
	! scope="col" \| {{Ls\|MirLua/Modules/param_name}}		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
	! scope="col" \| {{Ls\|MirLua/Modules/required_param}}		! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
	! scope="col" \| {{Ls\|~~MirLua~~/~~Modules~~/type}}		! scope="col" \| {{Ls\|Content/TableHeaders/type}}
	! scope="col" \| {{Ls\|Content/TableHeaders/description}}		! scope="col" \| {{Ls\|Content/TableHeaders/description}}
	\|-		\|-
Line 44:		Line 44:

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

	{{nbsp\|5}}<translate><!--T:8--> Returns <tvar\|return_on_success><code>true</code></> if sound was registered successfully, otherwise <tvar\|return_on_fail><code>false</code></>.</translate>		{{nbsp\|5}}<translate><!--T:8--> Returns <tvar\|return_on_success><code>true</code></> if sound was registered successfully, otherwise <tvar\|return_on_fail><code>false</code></>.</translate>
Line 60:		Line 60:
	! scope="col" \| {{Ls\|MirLua/Modules/param_name}}		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
	! scope="col" \| {{Ls\|MirLua/Modules/required_param}}		! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
	! scope="col" \| {{Ls\|~~MirLua~~/~~Modules~~/type}}		! scope="col" \| {{Ls\|Content/TableHeaders/type}}
	! scope="col" \| {{Ls\|Content/TableHeaders/description}}		! scope="col" \| {{Ls\|Content/TableHeaders/description}}
	\|-		\|-
Line 70:		Line 70:

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

	{{nbsp\|5}}<translate><!--T:11--> Returns <tvar\|return_on_success><code>true</code></> if sound was played successfully, otherwise <tvar\|return_on_fail><code>false</code></>.</translate>		{{nbsp\|5}}<translate><!--T:11--> Returns <tvar\|return_on_success><code>true</code></> if sound was played successfully, otherwise <tvar\|return_on_fail><code>false</code></>.</translate>
Line 86:		Line 86:
	! scope="col" \| {{Ls\|MirLua/Modules/param_name}}		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
	! scope="col" \| {{Ls\|MirLua/Modules/required_param}}		! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
	! scope="col" \| {{Ls\|~~MirLua~~/~~Modules~~/type}}		! scope="col" \| {{Ls\|Content/TableHeaders/type}}
	! scope="col" \| {{Ls\|Content/TableHeaders/description}}		! scope="col" \| {{Ls\|Content/TableHeaders/description}}
	\|-		\|-
Line 96:		Line 96:

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

	{{nbsp\|5}}<translate><!--T:14--> Returns <tvar\|return_on_success><code>true</code></> if sound was played successfully, otherwise <tvar\|return_on_fail><code>false</code></>.</translate>		{{nbsp\|5}}<translate><!--T:14--> Returns <tvar\|return_on_success><code>true</code></> if sound was played successfully, otherwise <tvar\|return_on_fail><code>false</code></>.</translate>

← Older revision		Revision as of 21:55, 1 June 2018
Line 16:		Line 16:
	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	{\| class="wikitable"		{\| class="wikitable"
	~~\|+ {{Ls\|MirLua/Modules/parameters}}~~
	\|-		\|-
	! scope="col" \| {{Ls\|MirLua/Modules/param_name}}		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
Line 57:		Line 56:

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{~~nbsp~~\|5}}~~''name''~~ {{~~Nobold~~\|({{Ls\|MirLua/Modules/~~required_param~~}})}}		{\| class="wikitable"
	:: {{Ls\|~~MirLua/Modules~~/~~type~~}}: <code>string</code>		\|-
	:: <translate><!--T:10--> Unique name.</translate>		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
			! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
			! scope="col" \| {{Ls\|MirLua/Modules/type}}
			! scope="col" \| {{Ls\|Content/TableHeaders/description}}
			\|-
			! scope="row" class="MirLuaParametersTable-parameter" \| name
			\| style="text-align:center" \| {{Ls\|YesNo/yes}}
			\| style="text-align:center" \| <code>string</code>
			\| <translate><!--T:10--> Unique name.</translate>
			\|}

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
Line 74:		Line 82:

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{~~nbsp~~\|5}}~~''path''~~ {{~~Nobold~~\|({{Ls\|MirLua/Modules/~~required_param~~}})}}		{\| class="wikitable"
	:: {{Ls\|~~MirLua/Modules~~/~~type~~}}: <code>string</code>		\|-
	:: <translate><!--T:13--> Path to file.</translate>		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
			! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
			! scope="col" \| {{Ls\|MirLua/Modules/type}}
			! scope="col" \| {{Ls\|Content/TableHeaders/description}}
			\|-
			! scope="row" class="MirLuaParametersTable-parameter" \| path
			\| style="text-align:center" \| {{Ls\|YesNo/yes}}
			\| style="text-align:center" \| <code>string</code>
			\| <translate><!--T:13--> Path to file.</translate>
			\|}

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====

← Older revision		Revision as of 17:50, 31 May 2018
Line 15:		Line 15:

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{~~nbsp~~\|5}}~~''name''~~ {{~~Nobold~~\|({{Ls\|MirLua/Modules/required_param~~}})~~}}		{\| class="wikitable"
	:: {{Ls\|MirLua/Modules/type}}: <code>string</code>		\|+ {{Ls\|MirLua/Modules/parameters}}
	:: <translate><!--T:4--> Unique name.</translate>		\|-
			! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
	~~; {{nbsp~~\|~~5}}''~~description~~'' {{Nobold~~\|~~({{Ls~~\|~~MirLua/Modules/required_param}})}}~~		! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
	:~~: {{Ls~~\|~~MirLua/Modules/type}}:~~ <code>string</code>		! scope="col" \| {{Ls\|MirLua/Modules/type}}
	:: <translate><!--T:5--> Description.</translate>		! scope="col" \| Description
			\|-
	~~; {{nbsp~~\|~~5}}''~~section''		! scope="row" style="text-align:left" \| name
	:: ~~{{Ls~~\|~~MirLua/Modules/type}}:~~ <code>string</code>		\| style="text-align:center" \| yes
	:: <translate><!--T:6--> Section name in Miranda sound settings. By default plugin name (<tvar\|default_name>''MirLua''</>) is used.</translate>		\| style="text-align:center" \| <code>string</code>
			\| <translate><!--T:4--> Unique name.</translate>
	~~; {{nbsp~~\|~~5}}''~~path''		\|-
	:: ~~{{Ls~~\|~~MirLua/Modules/type}}:~~ <code>string</code>		! scope="row" style="text-align:left" \| description
	:: <translate><!--T:7--> Path to sound file.</translate>		\| style="text-align:center" \| yes
			\| style="text-align:center" \| <code>string</code>
			\| <translate><!--T:5--> Description.</translate>
			\|-
			! scope="row" style="text-align:left" \| section
			\| style="text-align:center" \| no
			\| style="text-align:center" \| <code>string</code>
			\| <translate><!--T:6--> Section name in Miranda sound settings. By default plugin name (<tvar\|default_name>''MirLua''</>) is used.</translate>
			\|-
			! scope="row" style="text-align:left" \| path
			\| style="text-align:center" \| no
			\| style="text-align:center" \| <code>string</code>
			\| <translate><!--T:7--> Path to sound file.</translate>
			\|}

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====

← Older revision		Revision as of 21:32, 1 June 2018
Line 21:		Line 21:
	! scope="col" \| {{Ls\|MirLua/Modules/required_param}}		! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
	! scope="col" \| {{Ls\|MirLua/Modules/type}}		! scope="col" \| {{Ls\|MirLua/Modules/type}}
	! scope="col" \| ~~Description~~		! scope="col" \| {{Ls\|Content/TableHeaders/description}}
	\|-		\|-
	! scope="row" ~~style~~="~~text~~-~~align:left~~" \| name		! scope="row" class="MirLuaParametersTable-parameter" \| name
	\| style="text-align:center" \| {{Ls\|YesNo/yes}}		\| style="text-align:center" \| {{Ls\|YesNo/yes}}
	\| style="text-align:center" \| <code>string</code>		\| style="text-align:center" \| <code>string</code>
	\| <translate><!--T:4--> Unique name.</translate>		\| <translate><!--T:4--> Unique name.</translate>
	\|-		\|-
	! scope="row" ~~style~~="~~text~~-~~align:left~~" \| description		! scope="row" class="MirLuaParametersTable-parameter" \| description
	\| style="text-align:center" \| {{Ls\|YesNo/yes}}		\| style="text-align:center" \| {{Ls\|YesNo/yes}}
	\| style="text-align:center" \| <code>string</code>		\| style="text-align:center" \| <code>string</code>
	\| <translate><!--T:5--> Description.</translate>		\| <translate><!--T:5--> Description.</translate>
	\|-		\|-
	! scope="row" ~~style~~="~~text~~-~~align:left~~" \| section		! scope="row" class="MirLuaParametersTable-parameter" \| section
	\| style="text-align:center" \| {{Ls\|YesNo/no}}		\| style="text-align:center" \| {{Ls\|YesNo/no}}
	\| style="text-align:center" \| <code>string</code>		\| style="text-align:center" \| <code>string</code>
	\| <translate><!--T:6--> Section name in Miranda sound settings. By default plugin name (<tvar\|default_name>''MirLua''</>) is used.</translate>		\| <translate><!--T:6--> Section name in Miranda sound settings. By default plugin name (<tvar\|default_name>''MirLua''</>) is used.</translate>
	\|-		\|-
	! scope="row" ~~style~~="~~text~~-~~align:left~~" \| path		! scope="row" class="MirLuaParametersTable-parameter" \| path
	\| style="text-align:center" \| {{Ls\|YesNo/no}}		\| style="text-align:center" \| {{Ls\|YesNo/no}}
	\| style="text-align:center" \| <code>string</code>		\| style="text-align:center" \| <code>string</code>

← Older revision		Revision as of 19:17, 1 June 2018
Line 24:		Line 24:
	\|-		\|-
	! scope="row" style="text-align:left" \| name		! scope="row" style="text-align:left" \| name
	\| style="text-align:center" \| yes		\| style="text-align:center" \| {{Ls\|YesNo/yes}}
	\| style="text-align:center" \| <code>string</code>		\| style="text-align:center" \| <code>string</code>
	\| <translate><!--T:4--> Unique name.</translate>		\| <translate><!--T:4--> Unique name.</translate>
	\|-		\|-
	! scope="row" style="text-align:left" \| description		! scope="row" style="text-align:left" \| description
	\| style="text-align:center" \| yes		\| style="text-align:center" \| {{Ls\|YesNo/yes}}
	\| style="text-align:center" \| <code>string</code>		\| style="text-align:center" \| <code>string</code>
	\| <translate><!--T:5--> Description.</translate>		\| <translate><!--T:5--> Description.</translate>
	\|-		\|-
	! scope="row" style="text-align:left" \| section		! scope="row" style="text-align:left" \| section
	\| style="text-align:center" \| no		\| style="text-align:center" \| {{Ls\|YesNo/no}}
	\| style="text-align:center" \| <code>string</code>		\| style="text-align:center" \| <code>string</code>
	\| <translate><!--T:6--> Section name in Miranda sound settings. By default plugin name (<tvar\|default_name>''MirLua''</>) is used.</translate>		\| <translate><!--T:6--> Section name in Miranda sound settings. By default plugin name (<tvar\|default_name>''MirLua''</>) is used.</translate>
	\|-		\|-
	! scope="row" style="text-align:left" \| path		! scope="row" style="text-align:left" \| path
	\| style="text-align:center" \| no		\| style="text-align:center" \| {{Ls\|YesNo/no}}
	\| style="text-align:center" \| <code>string</code>		\| style="text-align:center" \| <code>string</code>
	\| <translate><!--T:7--> Path to sound file.</translate>		\| <translate><!--T:7--> Path to sound file.</translate>

← Older revision		Revision as of 19:16, 17 April 2018
Line 15:		Line 15:

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/~~obligatory_param~~}})}}		; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/required_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: <code>string</code>		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: <translate><!--T:4--> Unique name.</translate>		:: <translate><!--T:4--> Unique name.</translate>

	; {{nbsp\|5}}''description'' {{Nobold\|({{Ls\|MirLua/Modules/~~obligatory_param~~}})}}		; {{nbsp\|5}}''description'' {{Nobold\|({{Ls\|MirLua/Modules/required_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: <code>string</code>		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: <translate><!--T:5--> Description.</translate>		:: <translate><!--T:5--> Description.</translate>
Line 44:		Line 44:

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/~~obligatory_param~~}})}}		; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/required_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: <code>string</code>		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: <translate><!--T:10--> Unique name.</translate>		:: <translate><!--T:10--> Unique name.</translate>
Line 61:		Line 61:

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''path'' {{Nobold\|({{Ls\|MirLua/Modules/~~obligatory_param~~}})}}		; {{nbsp\|5}}''path'' {{Nobold\|({{Ls\|MirLua/Modules/required_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: <code>string</code>		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: <translate><!--T:13--> Path to file.</translate>		:: <translate><!--T:13--> Path to file.</translate>

← Older revision		Revision as of 18:50, 15 April 2018
Line 16:		Line 16:
	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: ~~'''~~string~~'''~~		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: <translate><!--T:4--> Unique name.</translate>		:: <translate><!--T:4--> Unique name.</translate>

	; {{nbsp\|5}}''description'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''description'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: ~~'''~~string~~'''~~		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: <translate><!--T:5--> Description.</translate>		:: <translate><!--T:5--> Description.</translate>

	; {{nbsp\|5}}''section''		; {{nbsp\|5}}''section''
	:: {{Ls\|MirLua/Modules/type}}: ~~'''~~string~~'''~~		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: <translate><!--T:6--> Section name in Miranda sound settings. By default plugin name (<tvar\|default_name>''MirLua''</>) is used.</translate>		:: <translate><!--T:6--> Section name in Miranda sound settings. By default plugin name (<tvar\|default_name>''MirLua''</>) is used.</translate>

	; {{nbsp\|5}}''path''		; {{nbsp\|5}}''path''
	:: {{Ls\|MirLua/Modules/type}}: ~~'''~~string~~'''~~		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: <translate><!--T:7--> Path to sound file.</translate>		:: <translate><!--T:7--> Path to sound file.</translate>

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

	{{nbsp\|5}}<translate><!--T:8--> Returns <tvar\|return_on_success>~~'''~~true~~'''~~</> if sound was registered successfully, otherwise <tvar\|return_on_fail>~~'''~~false~~'''~~</>.</translate>		{{nbsp\|5}}<translate><!--T:8--> Returns <tvar\|return_on_success><code>true</code></> if sound was registered successfully, otherwise <tvar\|return_on_fail><code>false</code></>.</translate>

	==== {{Ls\|MirLua/Modules/example}} ====		==== {{Ls\|MirLua/Modules/example}} ====
Line 45:		Line 45:
	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: ~~'''~~string~~'''~~		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: <translate><!--T:10--> Unique name.</translate>		:: <translate><!--T:10--> Unique name.</translate>

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

	{{nbsp\|5}}<translate><!--T:11--> Returns <tvar\|return_on_success>~~'''~~true~~'''~~</> if sound was played successfully, otherwise <tvar\|return_on_fail>~~'''~~false~~'''~~</>.</translate>		{{nbsp\|5}}<translate><!--T:11--> Returns <tvar\|return_on_success><code>true</code></> if sound was played successfully, otherwise <tvar\|return_on_fail><code>false</code></>.</translate>

	==== {{Ls\|MirLua/Modules/example}} ====		==== {{Ls\|MirLua/Modules/example}} ====
Line 62:		Line 62:
	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''path'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''path'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: ~~'''~~string~~'''~~		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: <translate><!--T:13--> Path to file.</translate>		:: <translate><!--T:13--> Path to file.</translate>

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

	{{nbsp\|5}}<translate><!--T:14--> Returns <tvar\|return_on_success>~~'''~~true~~'''~~</> if sound was played successfully, otherwise <tvar\|return_on_fail>~~'''~~false~~'''~~</>.</translate>		{{nbsp\|5}}<translate><!--T:14--> Returns <tvar\|return_on_success><code>true</code></> if sound was played successfully, otherwise <tvar\|return_on_fail><code>false</code></>.</translate>

	==== {{Ls\|MirLua/Modules/example}} ====		==== {{Ls\|MirLua/Modules/example}} ====
	{{Content:MirLua/Example\|code=sounds.PlayFile('c:\\lambada.wav')}}		{{Content:MirLua/Example\|code=sounds.PlayFile('c:\\lambada.wav')}}