RU/Resource:Helpmanager - Revision history

Ccw: Reverted edits by Bonzo (talk) to last revision by Vincent

2016-04-01T03:05:56Z

Reverted edits by Bonzo (talk) to last revision by Vincent

← Older revision	Revision as of 03:05, 1 April 2016
Line 1:	Line 1:
		{{RU/Resource page}}
		Help manager ("менеджер помощи") - централизованный скрипт, целью которого является предоставить простой способ для создания GUI помощи, предоставляющих инструкции игрокам сервера. Пользователи могут быть предупреждены всплывающим окном при загрузке страницы помощи ресурса в первый раз.

		==Использование==
		===Простой GUI===
		Если вы просто хотите добавить текст, добавления '''именно''' (ничего вообще не меняйте) этой строки в meta.xml вашего ресурса будет достаточно:
		<syntaxhighlight lang="xml">
		<config src="help.xml" type="client"/>
		</syntaxhighlight>
		Указанное ниже - "костяк" вашего файла '''help.xml''', содержимое которого будет показано под вкладкой ресурса в окне помощи (без самого костяка, конечно же). Кстати, дополнительное указание popup="no" в "костяке" отвечает за то, чтобы страница помощи не открывалась всякий раз, когда она доступна (т.е., например, она не будет открываться всякий раз при перезаходе на сервер, где к опредленному ресурсу имеется справка).

		Пример:
		<syntaxhighlight lang="xml">
		<help popup="no">
		Тут ваша справка
		</help>
		</syntaxhighlight>

		Текст справки, как правило, объясняет сущность мода, дополнительные клавиши и консольные команды. Эта справка создается для рядового пользователя, а не разработчика, так что не переусложняйте ее.

		===Собственный GUI===
		Вы можете добавить свой собсвтенный GUI помощи через добавление вкладки вручную, внутри клиентского скрипта:
		<syntaxhighlight lang="lua">
		myHelpTab = call(getResourceFromName("helpmanager"), "addHelpTab", getThisResource(), true)
		</syntaxhighlight>
		Вы можете добавлять содержимое через использование возвращенного элемента GUI в качесвте главного (parent GUI) для своих виджетов. Необязательно стирать их при удалении страницы / остановке ресурса, так как менеджер сам за этим следит.

		==Клавиши==
		'''F9''': вызывает окно справки.

		==Команды==
		'''gamehelp''': вызывает окно справки.

		==Экспортируемые функции==
		===Сервер===
		<syntaxhighlight lang="lua">bool showHelp ( element showTo )</syntaxhighlight>
		Показывает окно справки для элемента showTo, распространяясь вниз по древу.
		<syntaxhighlight lang="lua">bool hideHelp ( element hideTo )</syntaxhighlight>
		Скрывает окно справки для элемента hideTo, распространяясь вниз по древу.

		===Клиент===
		<syntaxhighlight lang="lua">bool showHelp ()</syntaxhighlight>
		Показывает окно справки local player (локальному игроку).
		<syntaxhighlight lang="lua">bool hideHelp ()</syntaxhighlight>
		Скрывает окно спарвки от local player (локального игрока).
		<syntaxhighlight lang="lua">gui-tab addHelpTab ( resource forResource, [bool showPopup = true] )</syntaxhighlight>
		Добавялет gui-вкладку с именем указанного ресурса в окно помощи local player. Если значение showPopup - false, всплывающее окно "page available" не показывается.
		<syntaxhighlight lang="lua">bool removeHelpTab ( resource forResource )</syntaxhighlight>
		Добавляет gui-вкладку с именем указанного ресурса в окно помощи local player.

		==Срабатывающие события==
		===Клиент===
		''(Для всех событий "source" - local player.)''
		<syntaxhighlight lang="lua">onHelpShown ()</syntaxhighlight>
		<syntaxhighlight lang="lua">onHelpHidden ()</syntaxhighlight>

		[[en:Resource:Helpmanager]]

Bonzo: Blanked the page

2016-03-31T16:12:55Z

Blanked the page

← Older revision		Revision as of 16:12, 31 March 2016
Line 1:		Line 1:
	~~{{RU/Resource page}}~~
	Help manager ("менеджер помощи") - централизованный скрипт, целью которого является предоставить простой способ для создания GUI помощи, предоставляющих инструкции игрокам сервера. Пользователи могут быть предупреждены всплывающим окном при загрузке страницы помощи ресурса в первый раз.

	~~==Использование==~~
	~~===Простой GUI===~~
	Если вы просто хотите добавить текст, добавления '''именно''' (ничего вообще не меняйте) этой строки в meta.xml вашего ресурса будет достаточно:
	~~<syntaxhighlight lang="xml">~~
	~~<config src="help.xml" type="client"/>~~
	~~</syntaxhighlight>~~
	Указанное ниже - "костяк" вашего файла '''help.xml''', содержимое которого будет показано под вкладкой ресурса в окне помощи (без самого костяка, конечно же). Кстати, дополнительное указание popup="no" в "костяке" отвечает за то, чтобы страница помощи не открывалась всякий раз, когда она доступна (т.е., например, она не будет открываться всякий раз при перезаходе на сервер, где к опредленному ресурсу имеется справка).

	~~Пример:~~
	~~<syntaxhighlight lang="xml">~~
	~~<help popup="no">~~
	~~Тут ваша справка~~
	~~</help>~~
	~~</syntaxhighlight>~~

	Текст справки, как правило, объясняет сущность мода, дополнительные клавиши и консольные команды. Эта справка создается для рядового пользователя, а не разработчика, так что не переусложняйте ее.

	~~===Собственный GUI===~~
	~~Вы можете добавить свой собсвтенный GUI помощи через добавление вкладки вручную, внутри клиентского скрипта:~~
	~~<syntaxhighlight lang="lua">~~
	~~myHelpTab = call(getResourceFromName("helpmanager"), "addHelpTab", getThisResource(), true)~~
	~~</syntaxhighlight>~~
	Вы можете добавлять содержимое через использование возвращенного элемента GUI в качесвте главного (parent GUI) для своих виджетов. Необязательно стирать их при удалении страницы / остановке ресурса, так как менеджер сам за этим следит.

	~~==Клавиши==~~
	~~'''F9''': вызывает окно справки.~~

	~~==Команды==~~
	~~'''gamehelp''': вызывает окно справки.~~

	~~==Экспортируемые функции==~~
	~~===Сервер===~~
	~~<syntaxhighlight lang="lua">bool showHelp ( element showTo )</syntaxhighlight>~~
	~~Показывает окно справки для элемента showTo, распространяясь вниз по древу.~~
	~~<syntaxhighlight lang="lua">bool hideHelp ( element hideTo )</syntaxhighlight>~~
	~~Скрывает окно справки для элемента hideTo, распространяясь вниз по древу.~~

	~~===Клиент===~~
	~~<syntaxhighlight lang="lua">bool showHelp ()</syntaxhighlight>~~
	~~Показывает окно справки local player (локальному игроку).~~
	~~<syntaxhighlight lang="lua">bool hideHelp ()</syntaxhighlight>~~
	~~Скрывает окно спарвки от local player (локального игрока).~~
	~~<syntaxhighlight lang="lua">gui-tab addHelpTab ( resource forResource, [bool showPopup = true] )</syntaxhighlight>~~
	Добавялет gui-вкладку с именем указанного ресурса в окно помощи local player. Если значение showPopup - false, всплывающее окно "page available" не показывается.
	~~<syntaxhighlight lang="lua">bool removeHelpTab ( resource forResource )</syntaxhighlight>~~
	~~Добавляет gui-вкладку с именем указанного ресурса в окно помощи local player.~~

	~~==Срабатывающие события==~~
	~~===Клиент===~~
	~~''(Для всех событий "source" - local player.)''~~
	~~<syntaxhighlight lang="lua">onHelpShown ()</syntaxhighlight>~~
	~~<syntaxhighlight lang="lua">onHelpHidden ()</syntaxhighlight>~~

	~~[[en:Resource:Helpmanager]]~~

Vincent at 19:38, 15 May 2012

2012-05-15T19:38:02Z

← Older revision		Revision as of 19:38, 15 May 2012
Line 1:		Line 1:
	~~{{translate}}~~
	{{RU/Resource page}}		{{RU/Resource page}}
	~~The help~~ manager ~~centralizes script help GUIs and provides a simple way to add instructions~~. ~~Users can be notified with a popup the first time a resource's help page is loaded~~.		Help manager ("менеджер помощи") - централизованный скрипт, целью которого является предоставить простой способ для создания GUI помощи, предоставляющих инструкции игрокам сервера. Пользователи могут быть предупреждены всплывающим окном при загрузке страницы помощи ресурса в первый раз.

	==~~Usage~~==		==Использование==
	===~~Simple~~ GUI===		===Простой GUI===
	~~If you just want to add a text~~, ~~adding this~~ '''~~exact~~''' (~~don't change src nor type~~) ~~line to your~~ meta.xml ~~will be enough~~:		Если вы просто хотите добавить текст, добавления '''именно''' (ничего вообще не меняйте) этой строки в meta.xml вашего ресурса будет достаточно:
	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml">
	<config src="help.xml" type="client"/>		<config src="help.xml" type="client"/>
	</syntaxhighlight>		</syntaxhighlight>
	~~The contents below the root node of your~~ '''help.xml''' ~~file will be shown under the resource's help tab~~. ~~Also~~, ~~an optional~~ popup="no" ~~can be added to the root node to specify that you don't want the user to be notified with a popup when the page is available~~.		Указанное ниже - "костяк" вашего файла '''help.xml''', содержимое которого будет показано под вкладкой ресурса в окне помощи (без самого костяка, конечно же). Кстати, дополнительное указание popup="no" в "костяке" отвечает за то, чтобы страница помощи не открывалась всякий раз, когда она доступна (т.е., например, она не будет открываться всякий раз при перезаходе на сервер, где к опредленному ресурсу имеется справка).

	~~For example~~:		Пример:
	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml">
	<help popup="no">		<help popup="no">
	~~Help text here~~		Тут ваша справка
	</help>		</help>
	</syntaxhighlight>		</syntaxhighlight>

	~~Help text should explain how to play the gamemode~~, ~~bound keys and console commands~~. ~~The help is intended for the end user~~, ~~not the developer so keep it simple~~.		Текст справки, как правило, объясняет сущность мода, дополнительные клавиши и консольные команды. Эта справка создается для рядового пользователя, а не разработчика, так что не переусложняйте ее.

	===~~Custom~~ GUI===		===Собственный GUI===
	~~You can add your custom help~~ GUI ~~by adding the tab manually in a client script~~:		Вы можете добавить свой собсвтенный GUI помощи через добавление вкладки вручную, внутри клиентского скрипта:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	myHelpTab = call(getResourceFromName("helpmanager"), "addHelpTab", getThisResource(), true)		myHelpTab = call(getResourceFromName("helpmanager"), "addHelpTab", getThisResource(), true)
	</syntaxhighlight>		</syntaxhighlight>
	~~You can add contents by using the returned~~ GUI ~~element as~~ GUI ~~parent for your widgets~~. ~~It is not necessary to destroy them on page remove~~ / ~~resource stop~~, ~~as the manager does cleanup~~.		Вы можете добавлять содержимое через использование возвращенного элемента GUI в качесвте главного (parent GUI) для своих виджетов. Необязательно стирать их при удалении страницы / остановке ресурса, так как менеджер сам за этим следит.

	==~~Keys~~==		==Клавиши==
	'''F9''': ~~toggles the help window~~.		'''F9''': вызывает окно справки.

	==~~Commands~~==		==Команды==
	'''gamehelp''': ~~toggles the help window~~.		'''gamehelp''': вызывает окно справки.

	==~~Exported functions~~==		==Экспортируемые функции==
	===~~Server~~===		===Сервер===
	<syntaxhighlight lang="lua">bool showHelp ( element showTo )</syntaxhighlight>		<syntaxhighlight lang="lua">bool showHelp ( element showTo )</syntaxhighlight>
	~~Shows the help window for the~~ showTo ~~element~~, ~~propagating down the tree~~.		Показывает окно справки для элемента showTo, распространяясь вниз по древу.
	<syntaxhighlight lang="lua">bool hideHelp ( element hideTo )</syntaxhighlight>		<syntaxhighlight lang="lua">bool hideHelp ( element hideTo )</syntaxhighlight>
	~~Hides the help window for the~~ hideTo ~~element~~, ~~propagating down the tree~~.		Скрывает окно справки для элемента hideTo, распространяясь вниз по древу.

	===~~Client~~===		===Клиент===
	<syntaxhighlight lang="lua">bool showHelp ()</syntaxhighlight>		<syntaxhighlight lang="lua">bool showHelp ()</syntaxhighlight>
	~~Shows the help window for the~~ local player.		Показывает окно справки local player (локальному игроку).
	<syntaxhighlight lang="lua">bool hideHelp ()</syntaxhighlight>		<syntaxhighlight lang="lua">bool hideHelp ()</syntaxhighlight>
	~~Hides the help window for the~~ local player.		Скрывает окно спарвки от local player (локального игрока).
	<syntaxhighlight lang="lua">gui-tab addHelpTab ( resource forResource, [bool showPopup = true] )</syntaxhighlight>		<syntaxhighlight lang="lua">gui-tab addHelpTab ( resource forResource, [bool showPopup = true] )</syntaxhighlight>
	~~Adds a~~ gui-~~tab with the name of the passed resource to the~~ local player~~'s help GUI~~. If showPopup is false, ~~the~~ "page available" ~~popup is not shown~~.		Добавялет gui-вкладку с именем указанного ресурса в окно помощи local player. Если значение showPopup - false, всплывающее окно "page available" не показывается.
	<syntaxhighlight lang="lua">bool removeHelpTab ( resource forResource )</syntaxhighlight>		<syntaxhighlight lang="lua">bool removeHelpTab ( resource forResource )</syntaxhighlight>
	~~Adds a~~ gui-~~tab with the name of the passed resource to the~~ local player~~'s help GUI~~.		Добавляет gui-вкладку с именем указанного ресурса в окно помощи local player.

	==~~Fired events~~==		==Срабатывающие события==
	===~~Client~~===		===Клиент===
	''(~~For all events,~~ "source" ~~is the~~ local player.)''		''(Для всех событий "source" - local player.)''
	<syntaxhighlight lang="lua">onHelpShown ()</syntaxhighlight>		<syntaxhighlight lang="lua">onHelpShown ()</syntaxhighlight>
	<syntaxhighlight lang="lua">onHelpHidden ()</syntaxhighlight>		<syntaxhighlight lang="lua">onHelpHidden ()</syntaxhighlight>

	[[en:Resource:Helpmanager]]		[[en:Resource:Helpmanager]]

Divine at 14:48, 25 April 2009

2009-04-25T14:48:19Z

← Older revision		Revision as of 14:48, 25 April 2009
Line 1:		Line 1:
			{{translate}}
	{{RU/Resource page}}		{{RU/Resource page}}
	The help manager centralizes script help GUIs and provides a simple way to add instructions. Users can be notified with a popup the first time a resource's help page is loaded.		The help manager centralizes script help GUIs and provides a simple way to add instructions. Users can be notified with a popup the first time a resource's help page is loaded.
Line 54:		Line 55:
	<syntaxhighlight lang="lua">onHelpShown ()</syntaxhighlight>		<syntaxhighlight lang="lua">onHelpShown ()</syntaxhighlight>
	<syntaxhighlight lang="lua">onHelpHidden ()</syntaxhighlight>		<syntaxhighlight lang="lua">onHelpHidden ()</syntaxhighlight>

			[[en:Resource:Helpmanager]]

D0lph1n at 07:10, 12 April 2009

2009-04-12T07:10:10Z

← Older revision		Revision as of 07:10, 12 April 2009
Line 1:		Line 1:
	~~[[Category:~~RU/Resource]]		{{RU/Resource page}}
	The help manager centralizes script help GUIs and provides a simple way to add instructions. Users can be notified with a popup the first time a resource's help page is loaded.		The help manager centralizes script help GUIs and provides a simple way to add instructions. Users can be notified with a popup the first time a resource's help page is loaded.

D0lph1n: Resource:RU/Helpmanager moved to RU/Resource:Helpmanager

2009-04-12T06:57:42Z

Resource:RU/Helpmanager moved to RU/Resource:Helpmanager

← Older revision	Revision as of 06:57, 12 April 2009
(No difference)

D0lph1n at 06:57, 12 April 2009

2009-04-12T06:57:30Z

← Older revision		Revision as of 06:57, 12 April 2009
Line 1:		Line 1:
	~~{{Resource page}}~~
	[[Category:RU/Resource]]		[[Category:RU/Resource]]
	The help manager centralizes script help GUIs and provides a simple way to add instructions. Users can be notified with a popup the first time a resource's help page is loaded.		The help manager centralizes script help GUIs and provides a simple way to add instructions. Users can be notified with a popup the first time a resource's help page is loaded.

D0lph1n: new page

2009-04-12T06:47:28Z

new page

New page

{{Resource page}}
[[Category:RU/Resource]]
The help manager centralizes script help GUIs and provides a simple way to add instructions. Users can be notified with a popup the first time a resource's help page is loaded.

==Usage==
===Simple GUI===
If you just want to add a text, adding this '''exact''' (don't change src nor type) line to your meta.xml will be enough:
<syntaxhighlight lang="xml">
<config src="help.xml" type="client"/>
</syntaxhighlight>
The contents below the root node of your '''help.xml''' file will be shown under the resource's help tab. Also, an optional popup="no" can be added to the root node to specify that you don't want the user to be notified with a popup when the page is available.

For example:
<syntaxhighlight lang="xml">
<help popup="no">
Help text here
</help>
</syntaxhighlight>

Help text should explain how to play the gamemode, bound keys and console commands. The help is intended for the end user, not the developer so keep it simple.

===Custom GUI===
You can add your custom help GUI by adding the tab manually in a client script:
<syntaxhighlight lang="lua">
myHelpTab = call(getResourceFromName("helpmanager"), "addHelpTab", getThisResource(), true)
</syntaxhighlight>
You can add contents by using the returned GUI element as GUI parent for your widgets. It is not necessary to destroy them on page remove / resource stop, as the manager does cleanup.

==Keys==
'''F9''': toggles the help window.

==Commands==
'''gamehelp''': toggles the help window.

==Exported functions==
===Server===
<syntaxhighlight lang="lua">bool showHelp ( element showTo )</syntaxhighlight>
Shows the help window for the showTo element, propagating down the tree.
<syntaxhighlight lang="lua">bool hideHelp ( element hideTo )</syntaxhighlight>
Hides the help window for the hideTo element, propagating down the tree.

===Client===
<syntaxhighlight lang="lua">bool showHelp ()</syntaxhighlight>
Shows the help window for the local player.
<syntaxhighlight lang="lua">bool hideHelp ()</syntaxhighlight>
Hides the help window for the local player.
<syntaxhighlight lang="lua">gui-tab addHelpTab ( resource forResource, [bool showPopup = true] )</syntaxhighlight>
Adds a gui-tab with the name of the passed resource to the local player's help GUI. If showPopup is false, the "page available" popup is not shown.
<syntaxhighlight lang="lua">bool removeHelpTab ( resource forResource )</syntaxhighlight>
Adds a gui-tab with the name of the passed resource to the local player's help GUI.

==Fired events==
===Client===
''(For all events, "source" is the local player.)''
<syntaxhighlight lang="lua">onHelpShown ()</syntaxhighlight>
<syntaxhighlight lang="lua">onHelpHidden ()</syntaxhighlight>