RU/Resource:Helpmanager: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Blanked the page)
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]]

Revision as of 16:12, 31 March 2016

Retrieved from "https://wiki.multitheftauto.com/wiki/RU/Resource:Helpmanager?oldid=47104"