AlliedModders Wiki - User contributions [en]

Installing Metamod:Source/ru

2021-07-20T14:09:49Z

Kleiner:

{{Languages|Installing Metamod:Source}}

В этой статье вы узнаете, как установить [[Metamod:Source/ru|Metamod:Source]].

=Обычная установка=

Valve иногда вносит изменения в свои игры, которые нарушают SourceMod между выпусками. Когда это происходит, вам может потребоваться установить новую версию Metamod и SourceMod. Вы можете узнать, требуется ли это, на странице [[Required Versions (SourceMod)|необходимых версий]].

<ol>
<li>[http://www.metamodsource.net/ Скачайте] Metamod:Source.</li>
<li>Распакуйте архив в папку вашей игры. Например, для Counter-Strike:Source после извлечения у вас будет <tt>cstrike/addons/metamod</tt>. Если вы загружаете файлы на FTP, распакуйте их локально, прежде чем переносить в папку игры вашего сервера.</li>
<li>Перезапустите свой сервер.</li>
<li>Введите "meta version" в консоли вашего сервера (или RCON). Вы должны увидеть строку вида: "Loaded As: Valve Server Plugin". Если команда не распознана, обратитесь к разделам ниже.</li>
</ol>

==Пользовательский VDF-файл==
Metamod:Source 1.10.0 и более поздние версии включают файл <tt>metamod.vdf</tt> для облегчения установки на большинство игр. Если у вас возникли проблемы с его загрузкой, [http://www.metamodsource.net/?go=vdf перейдите сюда], чтобы получить VDF-файл, специфичный для вашей игры. Этот файл должен быть помещён в папку <tt>addons</tt> вашего сервера.

Известные установки, требующие выполнения этого шага:
<ol>
<li>Left 4 Dead 1</li>
<li>Моды сторонних разработчиков, использующие Source SDK Base.</li>
<li>Локальные серверы (созданные с помощью внутриигровой опции "Создать сервер") для неанглоязычных клиентов игры.</li>
</ol>

=GameInfo=
'''Примечание: Обычно это не требуется - если вы не понимаете, что это такое, НЕ делайте этого, если нет инструкций. Приведённых выше инструкций достаточно для установки Metamod:Source на 99% серверов.'''

Metamod:Source версии 1.4.2 и ниже использовал более старый метод загрузки. Преимуществом этого метода было то, что Metamod:Source мог быть загружен до собственно игрового мода, что давало ему небольшую дополнительную функциональность. Эта функциональность никогда не использовалась разработчиками плагинов, а обновления Steam продолжали перезаписывать файлы <tt>gameinfo.txt</tt>, поэтому мы перешли на другой механизм загрузки.

Однако этот механизм загрузки всё ещё может быть выбран, если вы столкнулись с проблемами обратной совместимости, или у вас есть плагин, который использует преимущества механизма ранней загрузки. Если это ваш случай, то ниже приведены указания <tt>gameinfo.txt</tt>:

<ul>
<li>Откройте файл в папке мода под названием "gameinfo.txt". Внизу вы увидите несколько строк следующего содержания:
<pre>
SearchPaths
{
Game |gameinfo_path|.
Game cstrike
Game hl2
}
</pre></li>
<li>Добавьте строку после знака "{", но перед всеми записями "Game", которая выглядит следующим образом:<pre>GameBin |gameinfo_path|addons/metamod/bin
</pre>
</li>
<li>Если вы используете Windows, вам может понадобиться использовать обратную косую черту (\).
<li>Всё готово! Чтобы проверить, сработало ли это, перезапустите ваш игровой сервер и введите "meta version" в консоли сервера. Вы должны увидеть строку с надписью "Loaded as: GameDLL (gameinfo.txt)". Если команда не распознаётся, вероятно, установка не удалась. Если в строке "Loaded as:" написано что-то другое, <tt>gameinfo.txt</tt>, вероятно, был изменён неправильно.</li>
<li>Для получения дополнительной информации или документации см. [[:Category:Metamod:Source Documentation]]</li>
</ul>

Метод загрузки <tt>gameinfo.txt</tt> поддерживается только как унаследованная функция. Инструмент patcher больше не предоставляется. Вы можете пометить <tt>gameinfo.txt</tt>, если хотите защитить его от перезаписи.

Мы будем продолжать следить за тем, чтобы Metamod:Source мог загружаться этим методом до тех пор, пока движок Source позволяет это делать. Однако мы будем больше концентрироваться на поддержке нового механизма загрузки для общего использования.

[[Category:Metamod:Source Documentation]]

Installing Metamod:Source/ru

2021-07-20T14:08:58Z

Kleiner: Created page with "В этой статье вы узнаете, как установить Metamod:Source/ru. =Обычная установка= Valve иногда вносит изме..."

В этой статье вы узнаете, как установить [[Metamod:Source/ru]].

=Обычная установка=

Valve иногда вносит изменения в свои игры, которые нарушают SourceMod между выпусками. Когда это происходит, вам может потребоваться установить новую версию Metamod и SourceMod. Вы можете узнать, требуется ли это, на странице [[Required Versions (SourceMod)|необходимых версий]].

<ol>
<li>[http://www.metamodsource.net/ Скачайте] Metamod:Source.</li>
<li>Распакуйте архив в папку вашей игры. Например, для Counter-Strike:Source после извлечения у вас будет <tt>cstrike/addons/metamod</tt>. Если вы загружаете файлы на FTP, распакуйте их локально, прежде чем переносить в папку игры вашего сервера.</li>
<li>Перезапустите свой сервер.</li>
<li>Введите "meta version" в консоли вашего сервера (или RCON). Вы должны увидеть строку вида: "Loaded As: Valve Server Plugin". Если команда не распознана, обратитесь к разделам ниже.</li>
</ol>

==Пользовательский VDF-файл==
Metamod:Source 1.10.0 и более поздние версии включают файл <tt>metamod.vdf</tt> для облегчения установки на большинство игр. Если у вас возникли проблемы с его загрузкой, [http://www.metamodsource.net/?go=vdf перейдите сюда], чтобы получить VDF-файл, специфичный для вашей игры. Этот файл должен быть помещён в папку <tt>addons</tt> вашего сервера.

Известные установки, требующие выполнения этого шага:
<ol>
<li>Left 4 Dead 1</li>
<li>Моды сторонних разработчиков, использующие Source SDK Base.</li>
<li>Локальные серверы (созданные с помощью внутриигровой опции "Создать сервер") для неанглоязычных клиентов игры.</li>
</ol>

=GameInfo=
'''Примечание: Обычно это не требуется - если вы не понимаете, что это такое, НЕ делайте этого, если нет инструкций. Приведённых выше инструкций достаточно для установки Metamod:Source на 99% серверов.'''

Metamod:Source версии 1.4.2 и ниже использовал более старый метод загрузки. Преимуществом этого метода было то, что Metamod:Source мог быть загружен до собственно игрового мода, что давало ему небольшую дополнительную функциональность. Эта функциональность никогда не использовалась разработчиками плагинов, а обновления Steam продолжали перезаписывать файлы <tt>gameinfo.txt</tt>, поэтому мы перешли на другой механизм загрузки.

Однако этот механизм загрузки всё ещё может быть выбран, если вы столкнулись с проблемами обратной совместимости, или у вас есть плагин, который использует преимущества механизма ранней загрузки. Если это ваш случай, то ниже приведены указания <tt>gameinfo.txt</tt>:

<ul>
<li>Откройте файл в папке мода под названием "gameinfo.txt". Внизу вы увидите несколько строк следующего содержания:
<pre>
SearchPaths
{
Game |gameinfo_path|.
Game cstrike
Game hl2
}
</pre></li>
<li>Добавьте строку после знака "{", но перед всеми записями "Game", которая выглядит следующим образом:<pre>GameBin |gameinfo_path|addons/metamod/bin
</pre>
</li>
<li>Если вы используете Windows, вам может понадобиться использовать обратную косую черту (\).
<li>Всё готово! Чтобы проверить, сработало ли это, перезапустите ваш игровой сервер и введите "meta version" в консоли сервера. Вы должны увидеть строку с надписью "Loaded as: GameDLL (gameinfo.txt)". Если команда не распознаётся, вероятно, установка не удалась. Если в строке "Loaded as:" написано что-то другое, <tt>gameinfo.txt</tt>, вероятно, был изменён неправильно.</li>
<li>Для получения дополнительной информации или документации см. [[:Category:Metamod:Source Documentation]]</li>
</ul>

Метод загрузки <tt>gameinfo.txt</tt> поддерживается только как унаследованная функция. Инструмент patcher больше не предоставляется. Вы можете пометить <tt>gameinfo.txt</tt>, если хотите защитить его от перезаписи.

Мы будем продолжать следить за тем, чтобы Metamod:Source мог загружаться этим методом до тех пор, пока движок Source позволяет это делать. Однако мы будем больше концентрироваться на поддержке нового механизма загрузки для общего использования.

[[Category:Metamod:Source Documentation]]

Installing SourceMod/ru

2021-07-20T13:54:34Z

Kleiner:

{{Languages|Installing_SourceMod}}

Установка SourceMod очень проста, и он может быть добавлен практически без изменений конфигурации.

=Требования=
Веб-браузер с графическим интерфейсом для получения сжатых архивов Metamod и SourceMod.
Инструмент для копирования архива на ваш выделенный сервер.

SourceMod требует [[Metamod:Source/ru|Metamod:Source]] 1.9.0 или выше (рекомендуется использовать последнюю версию). [http://www.metamodsource.net/ Нажмите здесь], чтобы посетить главную страницу Metamod:Source. Инструкции по установке SourceMM вручную можно найти [[Installing Metamod:Source/ru|здесь]].

SourceMod будет работать практически с любым модом, созданным с использованием Source SDK.

Valve иногда вносит изменения в свои игры, которые нарушают SourceMod между выпусками.
Когда это происходит, вам может потребоваться установить новую версию Metamod и SourceMod. Вы можете узнать, требуется ли это, на странице [[Required Versions (SourceMod)/ru|необходимых версий]].

=Загрузка/установка=
==Локальный сервер==
Чтобы установить [http://www.sourcemod.net/downloads.php SourceMod] в локальное хранилище, просто извлеките архив <tt>.zip</tt> (Windows) или <tt>.tar.gz</tt> (Linux) в папку вашего мода (например, <tt>cstrike</tt> для Counter-Strike, <tt>dod</tt> для Day of Defeat и так далее).

==Выделенный сервер==
Чтобы установить SourceMod на выделенный сервер, сначала распакуйте архив <tt>.zip</tt> (Windows) или <tt>.tar.gz</tt> (Linux) на локальный компьютер (например, на рабочий стол). Вы увидите папку <tt>addons</tt>.

Используя такой инструмент, как
[https://encrypted.google.com/#q=FTP FTP], найдите папку вашего мода (например, <tt>cstrike</tt> для Counter-Strike:Source, <tt>dod</tt> для Day of Defeat:Source и так далее). Под этой папкой должна находиться папка <tt>addons</tt> (если это не так, Metamod:Source, вероятно, не установлен). Из локальной папки <tt>addons</tt> загрузите всё содержимое в папку выделенного сервера <tt>addons</tt>. После этого в папке выделенного сервера <tt>addons</tt> должна появиться папка <tt>sourcemod</tt>.

Если у вас возникли трудности с этими шагами, вам необходимо ознакомиться с FTP и управлением сервером. Однако вы также можете обратиться за помощью к своему провайдеру сервера. Некоторые провайдеры также имеют веб-интерфейсы для управления вашим сервером.

В качестве альтернативы, если вы скопировали tar.gz в папку srcds, выполните следующие действия из подпапки cstrike:
tar -xzf ../sourcemod-1.1.0.tar.gz

=Проверка установки=
Расположение папок должно выглядеть следующим образом:
*<tt>[мод]</tt> - Папка вашего мода
**<tt>addons</tt>
***<tt>metamod</tt> - Metamod:Source
***<tt>sourcemod</tt> - SourceMod

После загрузки/копирования SourceMod и настройки Metamod:Source полностью перезапустите ваш сервер. Если он локальный, выключите его и перезапустите. Если сервер выделенный, вам может понадобиться обратиться за помощью к провайдеру. Тем не менее, часто безопасно отдать команду "quit" через [[rcon]], поскольку большинство провайдеров автоматически перезапустят ваш сервер.

Сначала в [[server console/ru|консоль сервера]] (не клиентской консоли) введите:
<pre>meta list</pre>

Если установка прошла успешно, вы увидите что-то вроде:
<pre>] meta list
Найден 1 плагин:
[01] SourceMod (1.1.0.2489) от AlliedModders LLC</pre>

После этого вы должны иметь возможность использовать корневую команду консоли SourceMod, которая вызывается просто:
<pre>sm</pre>

Пример:
<pre>] sm version
Информация о версии SourceMod:
SourceMod версии: 1.1.0.2489
Движок SourcePawn: SourcePawn 1.1, jit-x86 (сборка 1.1.0-svn)
SourcePawn API: вер.1 = 4, вер.2 = 2
Составлено на: 5 сентября 2008 02:02:12
http://www.sourcemod.net/
</pre>

Наконец, если вы уже настроили административного пользователя (если нет, то прочтите [[Adding Admins (SourceMod)/ru|эту страницу]]), вы можете протестировать игровое меню, присоединившись к серверу, и в клиентской консоли наберите следующее:
<pre>sm_admin</pre>
Должно появиться всплывающее меню со всеми опциями.

=Устранение проблем=
Если установка не удалась, обычно вы увидите одну из четырёх причин.

==Metamod сообщает NOFILE или FAILED==
Если "meta list" ответит что-то вроде:
<pre>] meta list
Найден 1 плагин:
[01] <NOFILE></pre>

Скорее всего, либо файлы расположены в неправильном месте, либо файл не удалось загрузить. Для получения дополнительной информации используйте следующую команду (за исключением использования правильного номера списка):
<pre>meta info 1</pre>

==В списке Metamod нет плагинов==
Если "meta list" ответит что-то вроде:
<pre>] meta list
Найдено 0 плагинов:</pre>

Существует несколько причин этой ошибки.

# Наиболее распространённой причиной является то, что файл sourcemod.vdf не может быть расположен в папке addons/metamod. Убедитесь, что файл sourcemod.vdf присутствует в этой папке.
# Если файл sourcemod.vdf присутствует, убедитесь, что вы используете правильную сборку Sourcemod (zip = windows, tar.gz = linux).

==Metamod ничего не пишет==
Если "meta list" вообще не имеет ответа, значит Metamod:Source установлен неправильно. [[Installing Metamod:Source/ru|Эта страница вики]] может подсказать вам, как решить эту проблему.

[[Category:SourceMod Documentation]]

Menu API (SourceMod)=ru

2021-07-20T13:48:00Z

Kleiner: Redirected page to Menu API (SourceMod)/ru

#REDIRECT [[Menu API (SourceMod)/ru]]

Ru:Menu API (SourceMod)

2021-07-20T13:47:59Z

Kleiner: Redirected page to Menu API (SourceMod)/ru

#REDIRECT [[Menu API (SourceMod)/ru]]

Menu API (SourceMod)/ru

2021-07-20T13:47:58Z

Kleiner: Removed redirect to Ru:Menu API (SourceMod)

{{Languages|Menu API (SourceMod)}}
SourceMod обладает большим API для создания и отображений меню для клиентов. В отличии от AMX Mod X, API SourceMod'a обладает широким функционалом. Меню базируются на обратных вызовах (callbacks), которые гарантированно будут вызваны.

Для C++, API меню может быть найдено в <tt>public/IMenuManager.h</tt>. Для SourcePawn - <tt>scripting/include/menus.inc</tt>.

=Объекты=
Система меню SourceMod основана на объектно ориентированной иерархии. Понимание этой иерархии, даже для скриптинга, является ключевым моментом для эффективного использования меню.

==Стили==
Высший уровень объектов называется ''MenuStyle'' (<tt>IMenuStyle</tt> в C++). Стили описывают уникальную систему меню. Всего есть два стиля, встроенных в SourceMod:
*Valve Styly, так же называемым "ESC" меню; 8 пунктов на странице, нельзя добавить текст без занятия слота или спрятать (отключить) текст.
*Radio Style, так же называемый "AMX" меню; 10 пунктов на странице, можно добавить любой текст.

Каждый MenuStyle обладает своими правилами и свойствами. Вы можете считать, что каждый из них существует на раздельных "каналах". Например, два разных меню могут быть на экране игрока, будучи Valve и Radio меню одновременно, и SourceMod сможет обработать их обоих без всяких проблем. Это всё возможно благодаря тому, что каждый стиль отслеживает свои меню отдельно.

==Панели==
Меню низшего уровня называется ''Панелью'' (<tt>IMenuPanel</tt> в C++). Панель - один ''''кусок'''' текста. Пункты и текст могут добавляться к панели столько раз, сколько поддерживает родительский стиль. Например, Valve стиль не поддерживает отображение текста без занятия слота или отключенных пунктов. Однако с Radio стилем панели это становится возможным, и вы можете отобразить большое количество текста так, как вам это захочется.

Панель считается временным объектом. Она создается, рендерится, отображается, и затем удаляется. Хотя она может быть сохранена на неопределенное время, если в этом есть необходимость.

Правила и ограничения Vavle стиля:
*Максимум пунктов на странице: 8
*Отключенный текст не отображается.
*Нельзя написать текст, не заняв слота.
*Пробелы не добавляются к пробелам\новым линиям, добавляя чувство "ограниченности".
*Пользователь должен нажать "ESC" или быть в своей консоли, чтобы увидеть меню.

Правила и ограничения Radio стиля:
*10 пунктов на странице
*Заглавия белые; пункты желтые, если не отключены. Если отключены, то белого цвета.
*Нулевой элемент всегда белый. Для согласованности это значит, что навигационное управление всегда белое и находится в следующей секции, и просто не отрисовывается, если отсутствует.

==Меню==
Наконец, есть просто ''Меню'' (<tt>IBaseMenu</tt> in C++). Это вспомогательный объект, созданный для хранения базированных на меню выбираемых пунктов. В отличии от низкоуровневых панелей, меню содержит '''пункты''', и может содержать только те пункты, которые можно выбрать (т.е. занимающие слоты). Они делятся на две категории:
*Не нумерованные: эти меню могут иметь определенное число пунктов, и не имеют навигационных опций, кроме кнопки "Выход", которая всегда добавляется на последнюю позицию, поддерживаемую стилем.
**Valve Стиль: максимум пунктов: 8
**Radio Стиль: максимум пунктов: 10
*Нумерованные: такие меню могут содержать сколь угодно пунктов. Во время отображения будет показано только определенное число пунктов. Автоматически будут добавлены навигационные пункты, таким образом, игроки легко могут возвращаться назад и вперед к определенным "страницам" пунктов меню.
**"Назад" всегда отображается как первый навигационный пункт, третий с конца поддерживаемых позиций. Не будет добавлен, если меню содержит только одну страницу. Если нет никаких предыдущих страниц, текст никогда не будет отображен, ни в каком стиле. Если возможно, то меню будет дополнено необходимыми пробелами.
***Valve Стиль, позиция: 6
***Radio Стиль, позиция: 8
**"Вперед" всегда отображается как второй навигационный пункт, второй с конца из доступных позиций. Не отображается, если меню состоит из одной страницы. Если нет следующих страниц, то текс не будет отображен при любом стиле. Если возможно, то меню будет дополнено необходимыми пробелами.
***Valve Стиль, позиция: 7
***Radio Стиль, позиция: 9
**"Выход" отображается, если у меню включена кнопка "выход". Всегда занимает последнюю из возможных позиций
***Valve Стиль, позиция: 8
***Radio Стиль, позиция: 10

Цель меню - упростить процедуру хранения, отображения, и вычисления выбранного пункта. Таким образом, меню не позволяет добавлять пустой текст, так как это значительно усложняет алгоритм отображения.

Внутренне, меню отображается через ''RenderMenu'' алогритм. Этот алгоритм создает временную панель и заполняет её пунктами из меню. Эта панель отображается клиенту. Алгоритм пытается создать свободное перемещение по всем меню, и по всем стилям. Таким образом, все меню отображаются через <tt>IBaseMenu</tt> класс, или <tt>Menu</tt> дескрипторы (Handles), и будет выглядеть и действовать так же, как и меню API, основанное на панельном API.

=Обратные вызовы (callbacks)=
==Краткий обзор==
Меню базируются на системе обратных вызовов. Каждый обратный вызов предоставляет собой действие, которые происходят во время ''цикла отображения меню''. Цикл состоит из множества уведомлений:
*Начало уведомления.
**Уведомление об отображении, если меню может быть отображено клиенту.
**Уведомление о выборе пункта или кнопки отмены.
*Конец уведомления.

Так как ''End'' обозначает конец полного цикла отображения, то обычно его используют для уничтожения временных меню.

==Спецификация==
Детальное объяснение этих событий ниже. Для C++, <tt>IBaseMenu</tt> указатель всегда доступен. Для SourcePawn, <tt>Menu</tt> хандл и <tt>MenuAction</tt> всегда установлены в <tt>MenuHandler</tt> callback. В отличии от C++, SourcePawn API позволяет вызвать лишь некоторые действия, если они были запрошены во время создания меню. Это сделано в целях оптимизации. Однако, эти действия не могут быть не вызваны.

*'''Start'''. Меню было признано. Это не означает, что меню будет отображено; однако, это гарантирует, что событие "OnMenuEnd" будет вызвано.
**<tt>OnMenuStart()</tt> в C++.
**<tt>MenuAction_Start</tt> в SourcePawn. Не будет вызвано, если не было запрошено.
***<tt>param1</tt>: Игнорируется (всегда 0).
***<tt>param2</tt>: Игнорируется (всегда 0).
*'''Display'''. Меню отобразилось клиенту.
**<tt>OnMenuDisplay()</tt> в C++. <tt>IMenuPanel</tt> доступны указатель и индекс клиента.
**<tt>MenuAction_Display</tt> в SourcePawn. Не будет вызвано, если не было запрошено.
***<tt>param1</tt>: Индекс клиента.
***<tt>param2</tt>: Хандл меню.
*'''Select'''. Пункт был выбран. Будет дана позиция пункта в меню, а не нажатая кнопка (если меню не является панелью)
**<tt>OnMenuSelect()</tt> в C++. Передаются индекс клиента и позиция пункта.
**<tt>MenuAction_Select</tt> в SourcePawn. Это действие всегда вызывается, вне зависимости от запроса.
***<tt>param1</tt>: Индекс клиента.
***<tt>param2</tt>: Позиция пункта.
*'''Cancel'''. Отображение меню у одного из клиентов было закрыто.
**<tt>OnMenuCancel()</tt> в C++. Доступна причина закрытия.
**<tt>MenuAction_Cancel</tt> в SourcePawn. Это действие всегда вызывается, вне зависимости от запроса.
***<tt>param1</tt>: Индекс клиента.
***<tt>param2</tt>: Код причины закрытия меню.
*'''End'''. Цикл отображения меню закончился; это означает, что "Start" действие было, и одно из действий "Select" или "Cancel" так же произошло. Обычно в этом месте отчищаются ресурсы меню или само меню удаляется.
**<tt>OnMenuEnd()</tt> в C++.
**<tt>MenuAction_End</tt> в SourcePawn. Это действие всегда вызывается, вне зависимости от запроса.
***<tt>param1</tt>: Причина завершения меню.
***<tt>param2</tt>: если param1 == MenuEnd_Cancelled, то здесь содержится код причины закрытия меню.

==Панели==
Для панелей цикл жизни другой. Панели могут вызывать лишь два callback'а из написанных выше, и гарантируется, что один из них точно будет вызван для данного цикла отображения. Для C++, <tt>IBaseMenu</tt> указатель будет всегда <tt>NULL</tt>. Для SourcePawn, меню Handle будет всегда <tt>INVALID_HANDLE</tt>.

*'''Select'''. Кнопка была нажата. Этой кнопкой может быть любое число. Например, если в панели у вас 2 пункта, то клиент может вызвать это событие, нажав "43".
**<tt>OnMenuSelect()</tt> в C++. Передаются индекс клиента и нажатая кнопка.
**<tt>MenuAction_Select</tt> в SourcePawn.
***<tt>param1</tt>: Индекс клиента.
***<tt>param2</tt>: Номер нажатой клавиши.
*'''Cancel'''. Отображение меню у одного из клиентов было закрыто.
**<tt>OnMenuCancel()</tt> в C++. Доступна причина закрытия.
**<tt>MenuAction_Cancel</tt> в SourcePawn.
***<tt>param1</tt>: Индекс клиента.
***<tt>param2</tt>: Код причины закрытия меню.

=Примеры=
Для начала попробуем сделать очень простое меню:

<pre>Вы любите яблоки?
1. Да
2. Нет</pre>

Сделаем это как меню и как панель, чтобы увидеть различия в их API.

==Простое меню==
Сперва напишем наш пример через API Меню. Для пошагового руководства смотрите [[Menus Step By Step (SourceMod Scripting)]].

<pawn>public void OnPluginStart()
{
// зарегистрировали консольную команду menu_test1 для открытия меню.
RegConsoleCmd("menu_test1", Menu_Test1);
}

// хандл меню
int MenuHandler1(Menu menu, MenuAction action, int param1, int param2)
{
/* Если был выбран какой-либо пункт, то сообщим клиенту о его выборе. */
if (action == MenuAction_Select)
{
char info[32]; // переменная для хранения выбора
bool found = GetMenuItem(menu, param2, info, sizeof(info)); // получаем информацию о выбранном в меню пункте
PrintToConsole(param1, "Вы нажали: %d (найдено? %d информация: %s)", param2, found, info); // пишем клиенту в консоль
}
/* Если меню было отменено, то сообщим об этом серверу. */
else if (action == MenuAction_Cancel)
{
PrintToServer("Клиент %d' закрыл меню. Причина: %d", param1, param2);
}
/* Если меню "закончилось", то удалим его из памяти */
else if (action == MenuAction_End)
{
delete menu;
}
}

Action Menu_Test1(int client, int args)
{
new Handle:menu = CreateMenu(MenuHandler1);
SetMenuTitle(menu, "Вы любите яблоки?");
AddMenuItem(menu, "да", "да");
AddMenuItem(menu, "нет", "нет");
SetMenuExitButton(menu, false);
DisplayMenu(menu, client, 20);

return Plugin_Handled;
}</pawn>

Несколько очень важных замечаний о этом примере:
*Одно из <tt>Select</tt> или <tt>Cancel</tt> событий всегда будет отослано обработчику действий (action handler).
*<tt>End</tt> всегда будет отослано обработчику действий (action handler).
*Мы удаляем наше меню в <tt>End</tt> действии, потому что наш дескриптор (Handle) нам больше не нужен. Если бы мы удалили его после <tt>DisplayMenu</tt>, это бы отменило отображение меню клиенту.
*Меню по умолчанию имеет кнопку выхода. В нашем примере мы его отключили.
*Наше меню будет отображаться 20 секунд. Это означает, что если клиент ничего не выбрал в течении 20 секунд, то меню будет закрыто. Это обычно необходимо для меню с голосованиями. В отличии от AMX Mod X, вам не нужно создавать таймер, чтобы быть увереным, что меню "закончилось".
*Мы создали и уничтожили новый дескриптор меню (Menu Handle), однако мы можем этого и не делать. Вполне допустимо создать дескриптор (Handle) один раз для всего времени жизни плагина.
*Чтобы нормально отображались русские буквы, кодировка файла должна быть UTF-8 (без BOOM), иначе будут квадратики вместо русских букв.

Наше законченное меню и приложенный вывод в консоли выглядит как на картинке ниже (был выбран ответ "Да", и картинка взята с англ вики, прим. переводчика).

[[Image:Basic_menu_1.PNG]]

==Базовая панель==
Теперь давайте перепишем наш пример с использованием Панели вместо Меню.

<pawn>public OnPluginStart()
{
// зарегистрировали консольную команду panel_test1 для открытия меню.
RegConsoleCmd("panel_test1", Panel_Test1);
}

public PanelHandler1(Handle:menu, MenuAction:action, param1, param2)
{
if (action == MenuAction_Select)
{
PrintToConsole(param1, "Вы выбрали: %d", param2);
} else if (action == MenuAction_Cancel) {
PrintToServer("Клиент %d' закрыл панель. Причина: %d", param1, param2);
}
}

public Action:Panel_Test1(client, args)
{
new Handle:panel = CreatePanel();
SetPanelTitle(panel, "Вы любите яблоки?");
DrawPanelItem(panel, "Да");
DrawPanelItem(panel, "Нет");

SendPanelToClient(panel, client, PanelHandler1, 20);

CloseHandle(panel);

return Plugin_Handled;
}</pawn>

Как вы можете заметить, Панели сильно отличаются от Меню:
*Мы можем удалить Панель как только закончим его отображать. Мы можем создать Панель один раз, и продолжать использовать его много раз, однако мы можем удалить его в любой момент, без нарушения цикла отображения клиентского меню.
*Обработчик Панели (Handler) получает гораздо меньше информации. Так как Панели разрабатывались как грубый вывод текста, была сохранена возможность добавления информации без занятия слота. Поэтому обработчик может знать лишь об отмене или о нажатии любой клавиши с номером.
*Отсутствует автоматизация. Вы не можете добавить больше определенного числа выбираемых пунктов и добавить нумерацию. Автоматический контроль требует использования тяжелого объектного API Меню.

Наше законченная панель и приложеный вывод в консоли выглядит как на картинке ниже (был выбран ответ "Да", и картинка взята с англ вики, прим. переводчика):

[[Image:Basic_panel_1.PNG]]

==Базовое меню с нумерацией==
Теперь сделаем пример с большим функционалом -- нумерацией. Попробуем сделать меню для смены карты. Самый простой путь - прочесть <tt>maplist.txt</tt> файл в начале плагина и создать меню по этому файла.

Так как чтение и парсинг файла довольно долгая операция, мы будем делать это только раз за карту. Поэтому мы построим меню в <tt>OnMapStart</tt>, и мы не будем вызывать <tt>CloseHandle</tt> до события <tt>OnMapEnd</tt>.

Исходный код:
<pawn>new Handle:g_MapMenu = INVALID_HANDLE

public OnPluginStart()
{
RegConsoleCmd("menu_changemap", Command_ChangeMap);
}

public OnMapStart()
{
g_MapMenu = BuildMapMenu();
}

public OnMapEnd()
{
if (g_MapMenu != INVALID_HANDLE)
{
CloseHandle(g_MapMenu);
g_MapMenu = INVALID_HANDLE;
}
}

Handle:BuildMapMenu()
{
/* открываем файл */
new Handle:file = OpenFile("maplist.txt", "rt");
if (file == INVALID_HANDLE)
{
return INVALID_HANDLE;
}

/* создаем хандл меню */
new Handle:menu = CreateMenu(Menu_ChangeMap);
new String:mapname[255];
while (!IsEndOfFile(file) && ReadFileLine(file, mapname, sizeof(mapname)))
{
if (mapname[0] == ';' || !IsCharAlpha(mapname[0]))
{
continue;
}
/* выбрасываем все пробелы из названия */
new len = strlen(mapname);
for (new i=0; i<len; i++)
{
if (IsCharSpace(mapname[i]))
{
mapname[i] = '\0';
break;
}
}
/* проверяем карту на валидность */
if (!IsMapValid(mapname))
{
continue;
}
/* добавляем карту в меню */
AddMenuItem(menu, mapname, mapname);
}
/* не забываем закрыть файл! */
CloseHandle(file);

/* наконец, устанавливаем заглавие меню */
SetMenuTitle(menu, "Выберите карту:");

return menu;
}

public Menu_ChangeMap(Handle:menu, MenuAction:action, param1, param2)
{
if (action == MenuAction_Select)
{
new String:info[32];

/* получаем информацию о пункте */
new bool:found = GetMenuItem(menu, param2, info, sizeof(info));

/* говорим об этом клиенту */
PrintToConsole(param1, "Вы выбрали: %d (найдено? %d информация: %s)", param2, found, info);

/* меняем карту */
ServerCommand("changelevel %s", info);
}
}

public Action:Command_ChangeMap(client, args)
{
if (g_MapMenu == INVALID_HANDLE)
{
PrintToConsole(client, "Файл maplist.txt не был найден!");
return Plugin_Handled;
}

DisplayMenu(g_MapMenu, client, MENU_TIME_FOREVER);

return Plugin_Handled;
}</pawn>

Результатом такого меню будет множество пунктов (<tt>maplist.txt</tt> файл содержал примерно 18 карт). Таким образом, конечное меню содержит три страницы, которые идут друг за другом, и выглядят вот так:

[[Image:Basic_menu_2_page1.PNG]]
[[Image:Basic_menu_2_page2.PNG]]
[[Image:Basic_menu_2_page3.PNG]]

Сообщение в консоль будет выведено до смены карты, например, если выбрали <tt>cs_office</tt>:
<pre>Вы выбрали: 8 (найдено? 1 информация: cs_office)</pre>

Отображение и разработка этого меню через <tt>ShowMenu</tt> сообщение или <tt>Панельный</tt> API занимает много времени и является довольно сложной задачей. Придется отслеживать все пункты в массиве большого размера, страницы, которые пользователь просматривает, и написать функцию, которая будет вычислять, на основе текущей странице, пункт, который был выбран и какую кнопку нажали. Меню системы это всё делает за вас.

'''Заметки:'''
*Пункты управления, которые не доступны, не рисуются. Например, на первой странице вы не можете нажать "назад", а на последней странице вы не можете нажать "вперед". Несмотря на это, меню пытается удерживать каждый интерфейс последовательно. Таким образом, визуально, каждая навигационная клавиша всегда на одной и той же позиции.
*Если указать таймаут меню, то переключение между страницами не воздействует на общее время открытия меню. Например, если мы установим таймаут на 20 секунд, то каждое листание страницы будет устанавливать таймайт равный (20 - время, уже затраченное на просмотр). Только переоткрытие меню позволит вернуть таймаут времени на 20 секунд.
*Если отключить кнопку выхода, то не смотря на это, пункты 8 и 9 будут всё так же "назад" и вперед, соответственно.
*Мы не освобождаем дескриптор (Handle) меню в <tt>MenuAction_End</tt>, потому что наше меню глобальное/статическое, и нам не нужно пересоздавать его каждый раз.
*На изображении отображена кнопка "Назад". В SourceMod версии 1011 и выше, кнопка "Назад" была переименована в "Предыдующая", и "Назад" зарезервированно для "ExitBack" функциональности. (актуально для ENG версии, на ру вроде бы оба пункта "назад". прим. переводчик)

=Голосование=
SourceMod также имеет API для отображения меню как голосования для больше чем одного клиента. SourceMod автоматически обрабатываем выбранные пункты and randomly picking a tie-breaker (не знаю как перевести. прим. переводчика). Так же API голосования добавляет два новых значения для <tt>MenuAction</tt>, которые во время отображения меню всегда вызываются.

*<tt>MenuAction_VoteStart</tt>: Вызывается после <tt>MenuAction_Start</tt>, когда голосование оффициально началось.
*<tt>MenuAction_VoteEnd</tt>: Вызывается после того, как все клиенты проголосовали или отменили свои меню голосований. Выбранный предмет может быть получен через <tt>param1</tt>. Вызывается '''перед''' <tt>MenuAction_End</tt>. Важно заметить, что это не замена <tt>MenuAction_End</tt>, это разные вещи. Нельзя освобождать меню в <tt>MenuAction_VoteEnd</tt>. '''Заметка:''' не вызывается, если используется <tt>SetVoteResultCallback</tt>().
*<tt>MenuAction_VoteCancel</tt>: Вызывается, если меню было отмеено в процессе голосования. Если вызвалось, то <tt>MenuAction_VoteEnd</tt> или обратный вызов (callback) для результата голосований не будет вызваны, но <tt>MenuAction_End</tt> будет после этого. Причина отмены голосования находится в <tt>param1</tt>.

Система меню - это то же самое меню, только с двумя дополнительными свойствами:
*Только одно голосование может быть активно. Вы должны проверять, не запущено ли голосование (<tt>IsVoteInProgress</tt>()), иначе <tt>VoteMenu</tt>() не сработает.
*Если клиент во время голосования отключится, то его голос будет недействительным.

Пример внизу показывает, как создать функцию <tt>DoVoteMenu()</tt>, которая будет спрашивать, хотят ли они сменить карту на предложенную.

==Простое Голосование==
<pawn>public Handle_VoteMenu(Handle:menu, MenuAction:action, param1, param2)
{
if (action == MenuAction_End)
{
/* Вызывается после VoteEnd */
CloseHandle(menu);
} else if (action == MenuAction_VoteEnd) {
/* 0=да, 1=нет */
if (param1 == 0)
{
new String:map[64];
GetMenuItem(menu, param1, map, sizeof(map));
ServerCommand("changelevel %s", map);
}
}
}

DoVoteMenu(const String:map[])
{
if (IsVoteInProgress())
{
return;
}

new Handle:menu = CreateMenu(Handle_VoteMenu);
SetMenuTitle(menu, "Сменить карту на: %s?", map);
AddMenuItem(menu, map, "да");
AddMenuItem(menu, "no", "нет");
SetMenuExitButton(menu, false);
VoteMenuToAll(menu, 20);
}</pawn>

==Продвинутое Голосование==
Если вам нужно больше информации о результатах голосовании, чем вам дает <tt>MenuAction_VoteEnd</tt>, вы можете указать отдельный обратный вызов (callback). Новый обратный вызов будет давать больше информации, но за опреденную цену: <tt>MenuAction_VoteEnd</tt> не будет вызвано, и вам придется самим решать, как обработать результат. Это делается с помощью <tt>SetVoteResultCallback</tt>().

Пример:
<pawn>public Handle_VoteMenu(Handle:menu, MenuAction:action, param1, param2)
{
if (action == MenuAction_End)
{
/* Вызывается после VoteEnd */
CloseHandle(menu);
}
}

public Handle_VoteResults(Handle:menu,
num_votes,
num_clients,
const client_info[][2],
num_items,
const item_info[][2])
{
/* Проверяем, нет ли сразу двух победителей */
new winner = 0;
if (num_items > 1
&& (item_info[0][VOTEINFO_ITEM_VOTES] == item_info[1][VOTEINFO_ITEM_VOTES]))
{
winner = GetRandomInt(0, 1);
}

new String:map[64];
GetMenuItem(menu, item_info[winner][VOTEINFO_ITEM_INDEX], map, sizeof(map));
ServerCommand("changelevel %s", map);
}

DoVoteMenu(const String:map[])
{
if (IsVoteInProgress())
{
return;
}

new Handle:menu = CreateMenu(Handle_VoteMenu);
SetVoteResultCallback(menu, Handle_VoteResults);
SetMenuTitle(menu, "Сменить карту на: %s?", map);
AddMenuItem(menu, map, "Yes");
AddMenuItem(menu, "no", "No");
SetMenuExitButton(menu, false);
VoteMenuToAll(menu, 20);
}</pawn>

=ExitBack=
ExitBack - специальный термин для обозначения "ExitBack Кнопки". По умолчанию эта кнопка отключена. Обычно нумерованные меню не имеют пункта "Назад" для первой страници. Если "ExitBack" кнопка включена, появится кнопка "Назад".

Выбор опции "ExitBack" для меню в обратном вызове будет в действии <tt>MenuCancel_ExitBack</tt> и <tt>MenuEnd_ExitBack</tt>. Функциональность этого такая же, как и у простого выхода из меню; дополнительная функциональность должна быть определена через обратный вызов.

=Освобождение Дескрипторов (Handle) меню=
Важно закрывать дескриптор меню в <tt>MenuAction_End</tt>. <tt>MenuAction_End</tt> вызывается когда меню закрылось и больше не нужно.

=Переводы=
Есть возможность динамически переводить меню для каждого игрока через <tt>MenuAction_DisplayItem</tt> callback. Специальный натив, <tt>RedrawMenuItem</tt>, используется чтобы преобразовать текст внутри вызова. Давайте переделаем наш пример голосования с переводами.

<pawn>public Handle_VoteMenu(Handle:menu, MenuAction:action, param1, param2)
{
if (action == MenuAction_End)
{
/* Вызывается после VoteEnd */
CloseHandle(menu);
} else if (action == MenuAction_VoteEnd) {
/* 0=да, 1=нет */
if (param1 == 0)
{
new String:map[64];
GetMenuItem(menu, param1, map, sizeof(map));
ServerCommand("changelevel %s", map);
}
} else if (action == MenuAction_DisplayItem) {
/* Получаем отображаемую строку, будем использовать как фразу перевода */
decl String:display[64];
GetMenuItem(menu, param2, "", 0, _, display, sizeof(display));

/* Переводим строку на язык клиента */
decl String:buffer[255];
Format(buffer, sizeof(buffer), "%T", display, param1);

/* Перерисовываем текст */
return RedrawMenuItem(buffer);
} else if (action == MenuAction_Display) {
/* Дескриптор панели будет вторым параметром */
new Handle:panel = Handle:param2;

/* Получаем название карты, на которую меняем, из первого пункта */
decl String:map[64];
GetMenuItem(menu, 0, map, sizeof(map));

/* Переводим нашу фразу */
decl String:buffer[255];
Format(buffer, sizeof(buffer), "%T", "Change map to?", client, map);

SetPanelTitle(panel, buffer);
}
}

DoVoteMenu(const String:map[])
{
if (IsVoteInProgress())
{
return;
}

new Handle:menu = CreateMenu(Handle_VoteMenu, MenuAction_DisplayItem|MenuAction_Display);
SetMenuTitle(menu, "Сменить карту на: %s?", map);
AddMenuItem(menu, map, "Yes");
AddMenuItem(menu, "no", "No");
SetMenuExitButton(menu, false);
VoteMenuToAll(menu, 20);
}</pawn>

[[Category:SourceMod Development]]
[[Category:SourceMod Scripting]]

Ru:Menu API (SourceMod)

2021-07-20T13:42:22Z

Kleiner: Blanked the page

Menu API (SourceMod)=ru

2021-07-20T13:41:00Z

Kleiner: Kleiner moved page Ru:Menu API (SourceMod) to Menu API (SourceMod)=ru: testing

Ru:Menu API (SourceMod)

2021-07-20T13:41:00Z

Kleiner: Kleiner moved page Ru:Menu API (SourceMod) to Menu API (SourceMod)=ru: testing

#REDIRECT [[Menu API (SourceMod)=ru]]

Menu API (SourceMod)=ru

2021-07-20T13:40:21Z

Kleiner:

Menu API (SourceMod)=ru

2021-07-20T13:38:17Z

Kleiner: Kleiner moved page Menu API (SourceMod)/ru to Ru:Menu API (SourceMod) over redirect: sorry

Menu API (SourceMod)/ru

2021-07-20T13:38:17Z

Kleiner: Kleiner moved page Menu API (SourceMod)/ru to Ru:Menu API (SourceMod) over redirect: sorry

#REDIRECT [[Ru:Menu API (SourceMod)]]

Menu API (SourceMod)=ru

2021-07-20T13:37:53Z

Kleiner:

Menu API (SourceMod)

2021-07-20T13:35:23Z

Kleiner:

{{Languages|Menu API (SourceMod)}}
SourceMod has an extensive API for building and displaying menus to clients. Unlike AMX Mod X, this API is highly state driven. Menus are based on callbacks which are guaranteed to be fired.

For C++, the Menu API can be found in <tt>public/IMenuManager.h</tt>. For SourcePawn, it is in <tt>scripting/include/menus.inc</tt>.

=Objects=
The SourceMod Menu System is based on an object oriented hierarchy. Understanding this hierarchy, even for scripting, is critical to using menus effectively.

==Styles==
The top level object is a ''MenuStyle'' (<tt>IMenuStyle</tt> in C++). Styles describe a unique menu system. There are two such styles built into SourceMod:
*Valve Style, also called "ESC" menus; 8 items per page, no raw/disabled text can be rendered
*Radio Style, also called "AMX" menus; 10 items per page, raw/disabled text can be rendered

Each MenuStyle has its own rules and properties. You can think of them as existing on separate "channels." For example, two different menus can exist on a player's screen as both a Valve menu and a Radio menu at the same time, and SourceMod will be able to manage both without any problems. This is because each style keeps track of its own menus separately.

==Panels==
Menu displays are drawn with a lower level interface called ''Panels'' (<tt>IMenuPanel</tt> in C++). Panels describe exactly one chunk of display text. Both selectable items and raw text can be added to a panel as long as its parent style supports the contents you're trying to draw. For example, the Valve style does not support drawing raw text or disabled items. But with a Radio-style Panel, you can display a large amount of on-screen data in your own format.

Panels are considered temporary objects. They are created, rendered, displayed, and destroyed. Although they can be saved indefinitely, it is not necessary to do so.

Valve Style drawing rules/limitations:
*Max items per page is 8.
*Disabled items cannot be drawn.
*Raw text cannot be drawn.
*Spacers do not add a space/newline, giving a "cramped" feel.
*Users must press "ESC" or be at their console to view the menu.

Radio Style drawing rules/limitations:
*Max items per page is 10.
*Titles appear white; items appear yellow, unless disabled, in which case they are white.
*The 0th item is always white. For consistency, this means navigational controls explained in the next section are always white, and simply not drawn if disabled.

==Menus==
Lastly, there are plain ''Menus'' (<tt>IBaseMenu</tt> in C++). These are helper objects designed for storing a menu based on selectable items. Unlike low-level panels, menus are containers for '''items''', and can only contain items which are selectable (i.e., do not contain raw text). They fall into two categories:
*Non-paginated: The menu can only have a certain number of items on it, and no control/navigation options will be added, except for an "Exit" button which will always be in the last position supported by the style.
**Valve Style maximum items: 8
**Radio Style maximum items: 10
*Paginated: The menu can have any number of items. When displayed, only a certain number of items will be drawn at a time. Automatic navigation controls are added so players can easily move back and forth to different "pages" of items in the menu.
**"Previous" is always drawn as the first navigation item, third from the last supported position. This will not be drawn if the menu only contains one page. If there are no previous pages, the text will not be drawn on either style; if possible, the menu will be padded so spacing is consistent.
***Valve Style position: 6
***Radio Style position: 8
**"Next" is always drawn as the second navigation item, second from the last supported position. This will not be drawn if the menu only contains one page. If there are no further pages, the text will not be drawn on either style; if possible, the menu will be padded so spacing is consistent.
***Valve Style position: 7
***Radio Style position: 9
**"Exit" is drawn if the menu has the exit button property set. It is always the last supported item position.
***Valve Style position: 8
***Radio Style position: 10

The purpose of Menus is to simplify the procedure of storing, drawing, and calculating the selection of items. Thus, menus do not allow for adding raw text, as that would considerably complicate the drawing algorithm. ''Note: The C++ API supports hooking <tt>IBaseMenu</tt> drawing procedures and adding raw text; this will be added to the scripting API soon.''

Internally, Menus are drawn via a ''RenderMenu'' algorithm. This algorithm creates a temporary panel and fills it with items from menus. This panel is then displayed to a client. The algorithm attempts to create a consistent feel across all menus, and across all styles. Thus any menu displayed via the <tt>IBaseMenu</tt> class, or <tt>Menu</tt> Handles, will look and act the same, and the Menu API is based off the Panel API.

=Callbacks=
==Overview==
Menus are a callback based system. Each callback represents an action that occurs during a ''menu display cycle''. A cycle consists of a number of notifications:
*Start notification.
**Display notification if the menu can be displayed to the client.
**Either an item select or menu cancel notification.
*End notification.

Since ''End'' signifies the end of a full display cycle, it is usually used to destroy temporary menus.

==Specification==
A detailed explanation of these events is below. For C++, an <tt>IBaseMenu</tt> pointer is always available. For SourcePawn, a <tt>Menu</tt> Handle and a <tt>MenuAction</tt> are always set in the <tt>MenuHandler</tt> callback. Unlike C++, the SourcePawn API allows certain actions to only be called if they are requested at menu creation time. This is an optimization. However, certain actions cannot be prevented from being called.

*'''Start'''. The menu has been acknowledged. This does not mean it will be displayed; however, it guarantees that "OnMenuEnd" will be called.
**<tt>OnMenuStart()</tt> in C++.
**<tt>MenuAction_Start</tt> in SourcePawn. This action is not triggered unless requested.
***<tt>param1</tt>: Ignored (always 0).
***<tt>param2</tt>: Ignored (always 0).
*'''Display'''. The menu is being displayed to a client.
**<tt>OnMenuDisplay()</tt> in C++. An <tt>IMenuPanel</tt> pointer and client index are available.
**<tt>MenuAction_Display</tt> in SourcePawn. This action is not triggered unless requested.
***<tt>param1</tt>: A client index.
***<tt>param2</tt>: A Handle to a menu panel.
*'''Select'''. An item on the menu has been selected. The item position given will be the position in the menu, rather than the key pressed (unless the menu is a raw panel).
**<tt>OnMenuSelect()</tt> in C++. A client index and item position are passed.
**<tt>MenuAction_Select</tt> in SourcePawn. This action is always triggerable, whether requested or not.
***<tt>param1</tt>: A client index.
***<tt>param2</tt>: An item position.
*'''Cancel'''. The menu's display to one client has been cancelled.
**<tt>OnMenuCancel()</tt> in C++. A reason for cancellation is provided.
**<tt>MenuAction_Cancel</tt> in SourcePawn. This action is always triggerable, whether requested or not.
***<tt>param1</tt>: A client index.
***<tt>param2</tt>: A menu cancellation reason code.
*'''End'''. The menu's display cycle has finished; this means that the "Start" action has occurred, and either "Select" or "Cancel" has occurred thereafter. This is typically where menu resources are removed/deleted.
**<tt>OnMenuEnd()</tt> in C++.
**<tt>MenuAction_End</tt> in SourcePawn. This action is always triggered, whether requested or not.
***<tt>param1</tt>: A menu end reason code.
***<tt>param2</tt>: If param1 was MenuEnd_Cancelled, this contains a menu cancellation reason code.

==Panels==
For panels, the callback rules change. Panels only receive two of the above callbacks, and it is guaranteed that only one of them will be called for a given display cycle. For C++, the <tt>IBaseMenu</tt> pointer will always be <tt>NULL</tt>. For SourcePawn, the menu Handle will always be <tt>INVALID_HANDLE</tt> or <tt>null</tt>.

*'''Select'''. A key has been pressed. This can be any number and should not be considered as reliably in bounds. For example, even if you only had 2 items in your panel, a client could trigger a key press of "43."
**<tt>OnMenuSelect()</tt> in C++. A client index and key number pressed are passed.
**<tt>MenuAction_Select</tt> in SourcePawn.
***<tt>param1</tt>: A client index.
***<tt>param2</tt>: Number of the key pressed.
*'''Cancel'''. The menu's display to one client has been cancelled.
**<tt>OnMenuCancel()</tt> in C++. A reason for cancellation is provided.
**<tt>MenuAction_Cancel</tt> in SourcePawn.
***<tt>param1</tt>: A client index.
***<tt>param2</tt>: A menu cancellation reason code.

=Examples=
First, let's start off with a very basic menu. We want the menu to look like this:

<pre>Do you like apples?
1. Yes
2. No</pre>

We'll draw this menu with both a basic Menu and a Panel to show the API differences.

==Basic Menu==
First, let's write our example using the Menu building API. For a more in-depth guide, see [[Menus Step By Step (SourceMod Scripting)]].

<sourcepawn>public void OnPluginStart()
{
RegConsoleCmd("menu_test1", Menu_Test1);
}

public int MenuHandler1(Menu menu, MenuAction action, int param1, int param2)
{
/* If an option was selected, tell the client about the item. */
if (action == MenuAction_Select)
{
char info[32];
bool found = menu.GetItem(param2, info, sizeof(info));
PrintToConsole(param1, "You selected item: %d (found? %d info: %s)", param2, found, info);
}
/* If the menu was cancelled, print a message to the server about it. */
else if (action == MenuAction_Cancel)
{
PrintToServer("Client %d's menu was cancelled. Reason: %d", param1, param2);
}
/* If the menu has ended, destroy it */
else if (action == MenuAction_End)
{
delete menu;
}
}

public Action Menu_Test1(int client, int args)
{
Menu menu = new Menu(MenuHandler1);
menu.SetTitle("Do you like apples?");
menu.AddItem("yes", "Yes");
menu.AddItem("no", "No");
menu.ExitButton = false;
menu.Display(client, 20);

return Plugin_Handled;
}</sourcepawn>

Note a few very important points from this example:
*One of either <tt>Select</tt> or <tt>Cancel</tt> will always be sent to the action handler.
*<tt>End</tt> will always be sent to the action handler.
*We destroy our Menu in the <tt>End</tt> action, because our Handle is no longer needed. If we had destroyed the Menu after <tt>DisplayMenu</tt>, it would have canceled the menu's display to the client.
*Menus, by default, have an exit button. We disabled this in our example.
*Our menu is set to display for 20 seconds. That means that if the client does not select an item within 20 seconds, the menu will be canceled. This is usually desired for menus that are for voting. Note that unlike AMX Mod X, you do not need to set a timer to make sure the menu will be ended.
*Although we created and destroyed a new Menu Handle, we didn't need to. It is perfectly acceptable to create the Handle once for the lifetime of the plugin.

Our finished menu and attached console output looks like this (I selected "Yes"):

[[Image:Basic_menu_1.PNG]]

==Basic Panel==
Now, let's rewrite our example to use Panels instead.

<sourcepawn>public void OnPluginStart()
{
RegConsoleCmd("panel_test1", Panel_Test1);
}

public int PanelHandler1(Menu menu, MenuAction action, int param1, int param2)
{
if (action == MenuAction_Select)
{
PrintToConsole(param1, "You selected item: %d", param2);
}
else if (action == MenuAction_Cancel)
{
PrintToServer("Client %d's menu was cancelled. Reason: %d", param1, param2);
}
}

public Action Panel_Test1(int client, int args)
{
Panel panel = new Panel();
panel.SetTitle("Do you like apples?");
panel.DrawItem("Yes");
panel.DrawItem("No");

panel.Send(client, PanelHandler1, 20);

delete panel;

return Plugin_Handled;
}</sourcepawn>

As you can see, Panels are significantly different.
*We can destroy the Panel as soon as we're done displaying it. We can create the Panel once and keep re-using it, but we can destroy it at any time without interrupting client menus.
*The Handler function gets much less data. Since panels are designed as a raw display, no "item" information is saved internally. Thus, the handler function only knows whether the display was canceled or whether (and what) numerical key was pressed.
*There is no automation. You cannot add more than a certain amount of selectable items to a Panel and get pagination. Automated control functionality requires using the heftier Menu object API.

Our finished display and console output looks like this (I selected "Yes"):

[[Image:Basic_panel_1.PNG]]

==Basic Paginated Menu==
Now, let's take a more advanced example -- pagination. Let's say we want to build a menu for changing the map. An easy way to do this is to read the <tt>maplist.txt</tt> file at the start of a plugin and build a menu out of it.

Since reading and parsing a file is an expensive operation, we only want to do this once per map. Thus we'll build the menu in <tt>OnMapStart</tt>, and we won't call <tt>CloseHandle</tt> until <tt>OnMapEnd</tt>.

Source code:
<sourcepawn>Menu g_MapMenu = null;

public void OnPluginStart()
{
RegConsoleCmd("menu_changemap", Command_ChangeMap);
}

public void OnMapStart()
{
g_MapMenu = BuildMapMenu();
}

public void OnMapEnd()
{
delete g_MapMenu;
}

Menu BuildMapMenu()
{
/* Open the file */
File file = OpenFile("maplist.txt", "rt");
if (file == null)
{
return null;
}

/* Create the menu Handle */
Menu menu = new Menu(Menu_ChangeMap);
char mapname[255];
while (!file.EndOfFile() && file.ReadLine(mapname, sizeof(mapname)))
{
if (mapname[0] == ';' || !IsCharAlpha(mapname[0]))
{
continue;
}

/* Cut off the name at any whitespace */
int len = strlen(mapname);
for (int i = 0; i < len; i++)
{
if (IsCharSpace(mapname[i]))
{
mapname[i] = '\0';
break;
}
}

/* Check if the map is valid */
if (!IsMapValid(mapname))
{
continue;
}

/* Add it to the menu */
menu.AddItem(mapname, mapname);
}

/* Make sure we close the file! */
file.Close();

/* Finally, set the title */
menu.SetTitle("Please select a map:");

return menu;
}

public int Menu_ChangeMap(Menu menu, MenuAction action, int param1, int param2)
{
if (action == MenuAction_Select)
{
char info[32];

/* Get item info */
bool found = menu.GetItem(param2, info, sizeof(info));

/* Tell the client */
PrintToConsole(param1, "You selected item: %d (found? %d info: %s)", param2, found, info);

/* Change the map */
ServerCommand("changelevel %s", info);
}
}

public Action Command_ChangeMap(int client, int args)
{
if (g_MapMenu == null)
{
PrintToConsole(client, "The maplist.txt file was not found!");
return Plugin_Handled;
}

g_MapMenu.Display(client, MENU_TIME_FOREVER);

return Plugin_Handled;
}</sourcepawn>

This menu results in many selections (my <tt>maplist.txt</tt> file had around 18 maps). So, our final menu has 3 pages, which side by side, look like:

[[Image:Basic_menu_2_page1.PNG]]
[[Image:Basic_menu_2_page2.PNG]]
[[Image:Basic_menu_2_page3.PNG]]

Finally, the console output printed this before the map changed to my selection, <tt>cs_office</tt>:
<pre>You selected item: 8 (found? 1 info: cs_office)</pre>

Displaying and designing this Menu with a raw <tt>ShowMenu</tt> message or <tt>Panel</tt> API would be very time consuming and difficult. We would have to keep track of all the items in an array of hardcoded size, pages which the user is viewing, and write a function which calculated item selection based on current page and key press. The Menu system, thankfully, handles all of this for you.

'''Notes:'''
*Control options which are not available are not drawn. For example, in the first page, you cannot go "back," and in the last page, you cannot go "next." Despite this, the menu API tries to keep each the interface as consistent as possible. Thus, visually, each navigational control is always in the same position.
*Although we specified no time out for our menu, if we had placed a timeout, flipping through pages does not affect the overall time. For example, if we had a timeout of 20, each successive page flip would continue to detract from the overall display time, rather than restart the allowed hold time back to 20.
*If we had disabled the Exit button, options 8 and 9 would still be "Back" and "Next," respectively.
*Again, we did not free the Menu Handle in <tt>MenuAction_End</tt>. This is because our menu is global/static, and we don't want to rebuild it every time.
*These images show "Back." In SourceMod revisions 1011 and higher, "Back" is changed to "Previous," and "Back" is reserved for the special "ExitBack" functionality.

=Voting=
SourceMod also has API for displaying menus as votable choices to more than one client. SourceMod automatically handles selecting an item and randomly picking a tie-breaker. The voting API adds two new <tt>MenuAction</tt> values, which for vote displays, are '''always''' passed:

*<tt>MenuAction_VoteStart</tt>: Fired after <tt>MenuAction_Start</tt> when the voting has officially started.
*<tt>MenuAction_VoteEnd</tt>: Fired when all clients have either voted or cancelled their vote menu. The chosen item is passed through <tt>param1</tt>. This is fired '''before''' <tt>MenuAction_End</tt>. It is important to note that it does not supercede <tt>MenuAction_End</tt>, nor is it the same thing. Menus should never be destroyed in <tt>MenuAction_VoteEnd</tt>. '''Note:''' This is not called if <tt>SetVoteResultCallback</tt>() is used.
*<tt>MenuAction_VoteCancel</tt>: Fired if the menu is cancelled while the vote is in progress. If this is called, <tt>MenuAction_VoteEnd</tt> or the result callback will not be called, but <tt>MenuAction_End</tt> will be afterwards. A vote cancellation reason is passed in <tt>param1</tt>.

The voting system extends overall menus with two additional properties:
*Only one vote can be active at a time. You must call <tt>IsVoteInProgress</tt>() or else <tt>VoteMenu</tt>() will fail.
*If a client votes and then disconnects while the vote is still active, the client's vote will be invalidated.

The example below shows has to create a function called <tt>DoVoteMenu()</tt> which will ask all clients whether or not they would like to change to the given map.

==Simple Vote==
<sourcepawn>public int Handle_VoteMenu(Menu menu, MenuAction action, int param1, int param2)
{
if (action == MenuAction_End)
{
/* This is called after VoteEnd */
delete menu;
}
else if (action == MenuAction_VoteEnd)
{
/* 0=yes, 1=no */
if (param1 == 0)
{
char map[64];
menu.GetItem(param1, map, sizeof(map));
ServerCommand("changelevel %s", map);
}
}
}

void DoVoteMenu(const char[] map)
{
if (IsVoteInProgress())
{
return;
}

Menu menu = new Menu(Handle_VoteMenu);
menu.SetTitle("Change map to: %s?", map);
menu.AddItem(map, "Yes");
menu.AddItem("no", "No");
menu.ExitButton = false;
menu.DisplayVoteToAll(20);
}</sourcepawn>

==Advanced Voting==
If you need more information about voting results than <tt>MenuAction_VoteEnd</tt> gives you, you can choose to have a different callback invoked. The new callback will provide much more information, but at a price: <tt>MenuAction_VoteEnd</tt> will not be called, and you will have to decide how to interpret the results. This is done via <tt>SetVoteResultCallback</tt>().

Example:
<sourcepawn>public int Handle_VoteMenu(Menu menu, MenuAction action, int param1, int param2)
{
if (action == MenuAction_End)
{
/* This is called after VoteEnd */
delete menu;
}
}

public void Handle_VoteResults(Menu menu,
int num_votes,
int num_clients,
const int[][] client_info,
int num_items,
const int[][] item_info)
{
/* See if there were multiple winners */
int winner = 0;
if (num_items > 1
&& (item_info[0][VOTEINFO_ITEM_VOTES] == item_info[1][VOTEINFO_ITEM_VOTES]))
{
winner = GetRandomInt(0, 1);
}

char map[64];
menu.GetItem(item_info[winner][VOTEINFO_ITEM_INDEX], map, sizeof(map));
ServerCommand("changelevel %s", map);
}

void DoVoteMenu(const char[] map)
{
if (IsVoteInProgress())
{
return;
}

Menu menu = new Menu(Handle_VoteMenu);
menu.VoteResultCallback = Handle_VoteResults;
menu.SetTitle("Change map to: %s?", map);
menu.AddItem(map, "Yes");
menu.AddItem("no", "No");
menu.ExitButton = false;
menu.DisplayVoteToAll(20);
}</sourcepawn>

=ExitBack=
ExitBack is a special term to refer to the "ExitBack Button." This button is disabled by default. Normally, paginated menus have no "Previous" item for the first page. If the "ExitBack" button is enabled, the "Previous" item will show up as "Back."

Selecting the "ExitBack" option will exit the menu with <tt>MenuCancel_ExitBack</tt> and <tt>MenuEnd_ExitBack</tt>. The functionality of this is the same as a normal menu exit internally; extra functionality must be defined through the callbacks.

=Closing Menu Handles=
It is only necessary to close a menu handle on <tt>MenuAction_End</tt>. The <tt>MenuAction_End</tt> is done every time a menu is closed and no longer needed.

=Translations=
It is possible to dynamically translate menus to each player through the <tt>MenuAction_DisplayItem</tt> callback. A special native, <tt>RedrawMenuItem</tt>, is used to transform the text while inside the callback. Let's redo the vote example from earlier to be translated:

<sourcepawn>public int Handle_VoteMenu(Menu menu, MenuAction action, int param1, int param2)
{
if (action == MenuAction_End)
{
/* This is called after VoteEnd */
delete menu;
}
else if (action == MenuAction_VoteEnd)
{
/* 0=yes, 1=no */
if (param1 == 0)
{
char map[64];
menu.GetItem(param1, map, sizeof(map));
ServerCommand("changelevel %s", map);
}
}
else if (action == MenuAction_DisplayItem)
{
/* Get the display string, we'll use it as a translation phrase */
char display[64];
menu.GetItem(param2, "", 0, _, display, sizeof(display));

/* Translate the string to the client's language */
char buffer[255];
Format(buffer, sizeof(buffer), "%T", display, param1);

/* Override the text */
return RedrawMenuItem(buffer);
}
else if (action == MenuAction_Display)
{
/* Panel Handle is the second parameter */
Panel panel = view_as<Panel>(param2);

/* Get the map name we're changing to from the first item */
char map[64];
menu.GetItem(0, map, sizeof(map));

/* Translate to our phrase */
char buffer[255];
Format(buffer, sizeof(buffer), "%T", "Change map to?", client, map);

panel.SetTitle(buffer);
}
}

void DoVoteMenu(const char[] map)
{
if (IsVoteInProgress())
{
return;
}

Menu menu = new Menu(Handle_VoteMenu,MenuAction_DisplayItem|MenuAction_Display);
menu.SetTitle("Change map to: %s?", map);
menu.AddItem(map, "Yes");
menu.AddItem("no", "No");
menu.ExitButton = false;
menu.DisplayVoteToAll(20);
}</sourcepawn>

[[Category:SourceMod Development]]
[[Category:SourceMod Scripting]]

{{LanguageSwitch}}

Menu API (SourceMod)=ru

2021-07-20T13:30:44Z

Kleiner: Kleiner moved page Ru:Menu API (SourceMod) to Menu API (SourceMod)/ru: Language change support

SourceMod обладает большим API для создания и отображений меню для клиентов. В отличии от AMX Mod X, API SourceMod'a обладает широким функционалом. Меню базируются на обратных вызовах (callbacks), которые гарантированно будут вызваны.

Для C++, API меню может быть найдено в <tt>public/IMenuManager.h</tt>. Для SourcePawn - <tt>scripting/include/menus.inc</tt>.

=Объекты=
Система меню SourceMod основана на объектно ориентированной иерархии. Понимание этой иерархии, даже для скриптинга, является ключевым моментом для эффективного использования меню.

==Стили==
Высший уровень объектов называется ''MenuStyle'' (<tt>IMenuStyle</tt> в C++). Стили описывают уникальную систему меню. Всего есть два стиля, встроенных в SourceMod:
*Valve Styly, так же называемым "ESC" меню; 8 пунктов на странице, нельзя добавить текст без занятия слота или спрятать (отключить) текст.
*Radio Style, так же называемый "AMX" меню; 10 пунктов на странице, можно добавить любой текст.

Каждый MenuStyle обладает своими правилами и свойствами. Вы можете считать, что каждый из них существует на раздельных "каналах". Например, два разных меню могут быть на экране игрока, будучи Valve и Radio меню одновременно, и SourceMod сможет обработать их обоих без всяких проблем. Это всё возможно благодаря тому, что каждый стиль отслеживает свои меню отдельно.

==Панели==
Меню низшего уровня называется ''Панелью'' (<tt>IMenuPanel</tt> в C++). Панель - один ''''кусок'''' текста. Пункты и текст могут добавляться к панели столько раз, сколько поддерживает родительский стиль. Например, Valve стиль не поддерживает отображение текста без занятия слота или отключенных пунктов. Однако с Radio стилем панели это становится возможным, и вы можете отобразить большое количество текста так, как вам это захочется.

Панель считается временным объектом. Она создается, рендерится, отображается, и затем удаляется. Хотя она может быть сохранена на неопределенное время, если в этом есть необходимость.

Правила и ограничения Vavle стиля:
*Максимум пунктов на странице: 8
*Отключенный текст не отображается.
*Нельзя написать текст, не заняв слота.
*Пробелы не добавляются к пробелам\новым линиям, добавляя чувство "ограниченности".
*Пользователь должен нажать "ESC" или быть в своей консоли, чтобы увидеть меню.

Правила и ограничения Radio стиля:
*10 пунктов на странице
*Заглавия белые; пункты желтые, если не отключены. Если отключены, то белого цвета.
*Нулевой элемент всегда белый. Для согласованности это значит, что навигационное управление всегда белое и находится в следующей секции, и просто не отрисовывается, если отсутствует.

==Меню==
Наконец, есть просто ''Меню'' (<tt>IBaseMenu</tt> in C++). Это вспомогательный объект, созданный для хранения базированных на меню выбираемых пунктов. В отличии от низкоуровневых панелей, меню содержит '''пункты''', и может содержать только те пункты, которые можно выбрать (т.е. занимающие слоты). Они делятся на две категории:
*Не нумерованные: эти меню могут иметь определенное число пунктов, и не имеют навигационных опций, кроме кнопки "Выход", которая всегда добавляется на последнюю позицию, поддерживаемую стилем.
**Valve Стиль: максимум пунктов: 8
**Radio Стиль: максимум пунктов: 10
*Нумерованные: такие меню могут содержать сколь угодно пунктов. Во время отображения будет показано только определенное число пунктов. Автоматически будут добавлены навигационные пункты, таким образом, игроки легко могут возвращаться назад и вперед к определенным "страницам" пунктов меню.
**"Назад" всегда отображается как первый навигационный пункт, третий с конца поддерживаемых позиций. Не будет добавлен, если меню содержит только одну страницу. Если нет никаких предыдущих страниц, текст никогда не будет отображен, ни в каком стиле. Если возможно, то меню будет дополнено необходимыми пробелами.
***Valve Стиль, позиция: 6
***Radio Стиль, позиция: 8
**"Вперед" всегда отображается как второй навигационный пункт, второй с конца из доступных позиций. Не отображается, если меню состоит из одной страницы. Если нет следующих страниц, то текс не будет отображен при любом стиле. Если возможно, то меню будет дополнено необходимыми пробелами.
***Valve Стиль, позиция: 7
***Radio Стиль, позиция: 9
**"Выход" отображается, если у меню включена кнопка "выход". Всегда занимает последнюю из возможных позиций
***Valve Стиль, позиция: 8
***Radio Стиль, позиция: 10

Цель меню - упростить процедуру хранения, отображения, и вычисления выбранного пункта. Таким образом, меню не позволяет добавлять пустой текст, так как это значительно усложняет алгоритм отображения.

Внутренне, меню отображается через ''RenderMenu'' алогритм. Этот алгоритм создает временную панель и заполняет её пунктами из меню. Эта панель отображается клиенту. Алгоритм пытается создать свободное перемещение по всем меню, и по всем стилям. Таким образом, все меню отображаются через <tt>IBaseMenu</tt> класс, или <tt>Menu</tt> дескрипторы (Handles), и будет выглядеть и действовать так же, как и меню API, основанное на панельном API.

=Обратные вызовы (callbacks)=
==Краткий обзор==
Меню базируются на системе обратных вызовов. Каждый обратный вызов предоставляет собой действие, которые происходят во время ''цикла отображения меню''. Цикл состоит из множества уведомлений:
*Начало уведомления.
**Уведомление об отображении, если меню может быть отображено клиенту.
**Уведомление о выборе пункта или кнопки отмены.
*Конец уведомления.

Так как ''End'' обозначает конец полного цикла отображения, то обычно его используют для уничтожения временных меню.

==Спецификация==
Детальное объяснение этих событий ниже. Для C++, <tt>IBaseMenu</tt> указатель всегда доступен. Для SourcePawn, <tt>Menu</tt> хандл и <tt>MenuAction</tt> всегда установлены в <tt>MenuHandler</tt> callback. В отличии от C++, SourcePawn API позволяет вызвать лишь некоторые действия, если они были запрошены во время создания меню. Это сделано в целях оптимизации. Однако, эти действия не могут быть не вызваны.

*'''Start'''. Меню было признано. Это не означает, что меню будет отображено; однако, это гарантирует, что событие "OnMenuEnd" будет вызвано.
**<tt>OnMenuStart()</tt> в C++.
**<tt>MenuAction_Start</tt> в SourcePawn. Не будет вызвано, если не было запрошено.
***<tt>param1</tt>: Игнорируется (всегда 0).
***<tt>param2</tt>: Игнорируется (всегда 0).
*'''Display'''. Меню отобразилось клиенту.
**<tt>OnMenuDisplay()</tt> в C++. <tt>IMenuPanel</tt> доступны указатель и индекс клиента.
**<tt>MenuAction_Display</tt> в SourcePawn. Не будет вызвано, если не было запрошено.
***<tt>param1</tt>: Индекс клиента.
***<tt>param2</tt>: Хандл меню.
*'''Select'''. Пункт был выбран. Будет дана позиция пункта в меню, а не нажатая кнопка (если меню не является панелью)
**<tt>OnMenuSelect()</tt> в C++. Передаются индекс клиента и позиция пункта.
**<tt>MenuAction_Select</tt> в SourcePawn. Это действие всегда вызывается, вне зависимости от запроса.
***<tt>param1</tt>: Индекс клиента.
***<tt>param2</tt>: Позиция пункта.
*'''Cancel'''. Отображение меню у одного из клиентов было закрыто.
**<tt>OnMenuCancel()</tt> в C++. Доступна причина закрытия.
**<tt>MenuAction_Cancel</tt> в SourcePawn. Это действие всегда вызывается, вне зависимости от запроса.
***<tt>param1</tt>: Индекс клиента.
***<tt>param2</tt>: Код причины закрытия меню.
*'''End'''. Цикл отображения меню закончился; это означает, что "Start" действие было, и одно из действий "Select" или "Cancel" так же произошло. Обычно в этом месте отчищаются ресурсы меню или само меню удаляется.
**<tt>OnMenuEnd()</tt> в C++.
**<tt>MenuAction_End</tt> в SourcePawn. Это действие всегда вызывается, вне зависимости от запроса.
***<tt>param1</tt>: Причина завершения меню.
***<tt>param2</tt>: если param1 == MenuEnd_Cancelled, то здесь содержится код причины закрытия меню.

==Панели==
Для панелей цикл жизни другой. Панели могут вызывать лишь два callback'а из написанных выше, и гарантируется, что один из них точно будет вызван для данного цикла отображения. Для C++, <tt>IBaseMenu</tt> указатель будет всегда <tt>NULL</tt>. Для SourcePawn, меню Handle будет всегда <tt>INVALID_HANDLE</tt>.

*'''Select'''. Кнопка была нажата. Этой кнопкой может быть любое число. Например, если в панели у вас 2 пункта, то клиент может вызвать это событие, нажав "43".
**<tt>OnMenuSelect()</tt> в C++. Передаются индекс клиента и нажатая кнопка.
**<tt>MenuAction_Select</tt> в SourcePawn.
***<tt>param1</tt>: Индекс клиента.
***<tt>param2</tt>: Номер нажатой клавиши.
*'''Cancel'''. Отображение меню у одного из клиентов было закрыто.
**<tt>OnMenuCancel()</tt> в C++. Доступна причина закрытия.
**<tt>MenuAction_Cancel</tt> в SourcePawn.
***<tt>param1</tt>: Индекс клиента.
***<tt>param2</tt>: Код причины закрытия меню.

=Примеры=
Для начала попробуем сделать очень простое меню:

<pre>Вы любите яблоки?
1. Да
2. Нет</pre>

Сделаем это как меню и как панель, чтобы увидеть различия в их API.

==Простое меню==
Сперва напишем наш пример через API Меню. Для пошагового руководства смотрите [[Menus Step By Step (SourceMod Scripting)]].

<pawn>public void OnPluginStart()
{
// зарегистрировали консольную команду menu_test1 для открытия меню.
RegConsoleCmd("menu_test1", Menu_Test1);
}

// хандл меню
int MenuHandler1(Menu menu, MenuAction action, int param1, int param2)
{
/* Если был выбран какой-либо пункт, то сообщим клиенту о его выборе. */
if (action == MenuAction_Select)
{
char info[32]; // переменная для хранения выбора
bool found = GetMenuItem(menu, param2, info, sizeof(info)); // получаем информацию о выбранном в меню пункте
PrintToConsole(param1, "Вы нажали: %d (найдено? %d информация: %s)", param2, found, info); // пишем клиенту в консоль
}
/* Если меню было отменено, то сообщим об этом серверу. */
else if (action == MenuAction_Cancel)
{
PrintToServer("Клиент %d' закрыл меню. Причина: %d", param1, param2);
}
/* Если меню "закончилось", то удалим его из памяти */
else if (action == MenuAction_End)
{
delete menu;
}
}

Action Menu_Test1(int client, int args)
{
new Handle:menu = CreateMenu(MenuHandler1);
SetMenuTitle(menu, "Вы любите яблоки?");
AddMenuItem(menu, "да", "да");
AddMenuItem(menu, "нет", "нет");
SetMenuExitButton(menu, false);
DisplayMenu(menu, client, 20);

return Plugin_Handled;
}</pawn>

Несколько очень важных замечаний о этом примере:
*Одно из <tt>Select</tt> или <tt>Cancel</tt> событий всегда будет отослано обработчику действий (action handler).
*<tt>End</tt> всегда будет отослано обработчику действий (action handler).
*Мы удаляем наше меню в <tt>End</tt> действии, потому что наш дескриптор (Handle) нам больше не нужен. Если бы мы удалили его после <tt>DisplayMenu</tt>, это бы отменило отображение меню клиенту.
*Меню по умолчанию имеет кнопку выхода. В нашем примере мы его отключили.
*Наше меню будет отображаться 20 секунд. Это означает, что если клиент ничего не выбрал в течении 20 секунд, то меню будет закрыто. Это обычно необходимо для меню с голосованиями. В отличии от AMX Mod X, вам не нужно создавать таймер, чтобы быть увереным, что меню "закончилось".
*Мы создали и уничтожили новый дескриптор меню (Menu Handle), однако мы можем этого и не делать. Вполне допустимо создать дескриптор (Handle) один раз для всего времени жизни плагина.
*Чтобы нормально отображались русские буквы, кодировка файла должна быть UTF-8 (без BOOM), иначе будут квадратики вместо русских букв.

Наше законченное меню и приложенный вывод в консоли выглядит как на картинке ниже (был выбран ответ "Да", и картинка взята с англ вики, прим. переводчика).

[[Image:Basic_menu_1.PNG]]

==Базовая панель==
Теперь давайте перепишем наш пример с использованием Панели вместо Меню.

<pawn>public OnPluginStart()
{
// зарегистрировали консольную команду panel_test1 для открытия меню.
RegConsoleCmd("panel_test1", Panel_Test1);
}

public PanelHandler1(Handle:menu, MenuAction:action, param1, param2)
{
if (action == MenuAction_Select)
{
PrintToConsole(param1, "Вы выбрали: %d", param2);
} else if (action == MenuAction_Cancel) {
PrintToServer("Клиент %d' закрыл панель. Причина: %d", param1, param2);
}
}

public Action:Panel_Test1(client, args)
{
new Handle:panel = CreatePanel();
SetPanelTitle(panel, "Вы любите яблоки?");
DrawPanelItem(panel, "Да");
DrawPanelItem(panel, "Нет");

SendPanelToClient(panel, client, PanelHandler1, 20);

CloseHandle(panel);

return Plugin_Handled;
}</pawn>

Как вы можете заметить, Панели сильно отличаются от Меню:
*Мы можем удалить Панель как только закончим его отображать. Мы можем создать Панель один раз, и продолжать использовать его много раз, однако мы можем удалить его в любой момент, без нарушения цикла отображения клиентского меню.
*Обработчик Панели (Handler) получает гораздо меньше информации. Так как Панели разрабатывались как грубый вывод текста, была сохранена возможность добавления информации без занятия слота. Поэтому обработчик может знать лишь об отмене или о нажатии любой клавиши с номером.
*Отсутствует автоматизация. Вы не можете добавить больше определенного числа выбираемых пунктов и добавить нумерацию. Автоматический контроль требует использования тяжелого объектного API Меню.

Наше законченная панель и приложеный вывод в консоли выглядит как на картинке ниже (был выбран ответ "Да", и картинка взята с англ вики, прим. переводчика):

[[Image:Basic_panel_1.PNG]]

==Базовое меню с нумерацией==
Теперь сделаем пример с большим функционалом -- нумерацией. Попробуем сделать меню для смены карты. Самый простой путь - прочесть <tt>maplist.txt</tt> файл в начале плагина и создать меню по этому файла.

Так как чтение и парсинг файла довольно долгая операция, мы будем делать это только раз за карту. Поэтому мы построим меню в <tt>OnMapStart</tt>, и мы не будем вызывать <tt>CloseHandle</tt> до события <tt>OnMapEnd</tt>.

Исходный код:
<pawn>new Handle:g_MapMenu = INVALID_HANDLE

public OnPluginStart()
{
RegConsoleCmd("menu_changemap", Command_ChangeMap);
}

public OnMapStart()
{
g_MapMenu = BuildMapMenu();
}

public OnMapEnd()
{
if (g_MapMenu != INVALID_HANDLE)
{
CloseHandle(g_MapMenu);
g_MapMenu = INVALID_HANDLE;
}
}

Handle:BuildMapMenu()
{
/* открываем файл */
new Handle:file = OpenFile("maplist.txt", "rt");
if (file == INVALID_HANDLE)
{
return INVALID_HANDLE;
}

/* создаем хандл меню */
new Handle:menu = CreateMenu(Menu_ChangeMap);
new String:mapname[255];
while (!IsEndOfFile(file) && ReadFileLine(file, mapname, sizeof(mapname)))
{
if (mapname[0] == ';' || !IsCharAlpha(mapname[0]))
{
continue;
}
/* выбрасываем все пробелы из названия */
new len = strlen(mapname);
for (new i=0; i<len; i++)
{
if (IsCharSpace(mapname[i]))
{
mapname[i] = '\0';
break;
}
}
/* проверяем карту на валидность */
if (!IsMapValid(mapname))
{
continue;
}
/* добавляем карту в меню */
AddMenuItem(menu, mapname, mapname);
}
/* не забываем закрыть файл! */
CloseHandle(file);

/* наконец, устанавливаем заглавие меню */
SetMenuTitle(menu, "Выберите карту:");

return menu;
}

public Menu_ChangeMap(Handle:menu, MenuAction:action, param1, param2)
{
if (action == MenuAction_Select)
{
new String:info[32];

/* получаем информацию о пункте */
new bool:found = GetMenuItem(menu, param2, info, sizeof(info));

/* говорим об этом клиенту */
PrintToConsole(param1, "Вы выбрали: %d (найдено? %d информация: %s)", param2, found, info);

/* меняем карту */
ServerCommand("changelevel %s", info);
}
}

public Action:Command_ChangeMap(client, args)
{
if (g_MapMenu == INVALID_HANDLE)
{
PrintToConsole(client, "Файл maplist.txt не был найден!");
return Plugin_Handled;
}

DisplayMenu(g_MapMenu, client, MENU_TIME_FOREVER);

return Plugin_Handled;
}</pawn>

Результатом такого меню будет множество пунктов (<tt>maplist.txt</tt> файл содержал примерно 18 карт). Таким образом, конечное меню содержит три страницы, которые идут друг за другом, и выглядят вот так:

[[Image:Basic_menu_2_page1.PNG]]
[[Image:Basic_menu_2_page2.PNG]]
[[Image:Basic_menu_2_page3.PNG]]

Сообщение в консоль будет выведено до смены карты, например, если выбрали <tt>cs_office</tt>:
<pre>Вы выбрали: 8 (найдено? 1 информация: cs_office)</pre>

Отображение и разработка этого меню через <tt>ShowMenu</tt> сообщение или <tt>Панельный</tt> API занимает много времени и является довольно сложной задачей. Придется отслеживать все пункты в массиве большого размера, страницы, которые пользователь просматривает, и написать функцию, которая будет вычислять, на основе текущей странице, пункт, который был выбран и какую кнопку нажали. Меню системы это всё делает за вас.

'''Заметки:'''
*Пункты управления, которые не доступны, не рисуются. Например, на первой странице вы не можете нажать "назад", а на последней странице вы не можете нажать "вперед". Несмотря на это, меню пытается удерживать каждый интерфейс последовательно. Таким образом, визуально, каждая навигационная клавиша всегда на одной и той же позиции.
*Если указать таймаут меню, то переключение между страницами не воздействует на общее время открытия меню. Например, если мы установим таймаут на 20 секунд, то каждое листание страницы будет устанавливать таймайт равный (20 - время, уже затраченное на просмотр). Только переоткрытие меню позволит вернуть таймаут времени на 20 секунд.
*Если отключить кнопку выхода, то не смотря на это, пункты 8 и 9 будут всё так же "назад" и вперед, соответственно.
*Мы не освобождаем дескриптор (Handle) меню в <tt>MenuAction_End</tt>, потому что наше меню глобальное/статическое, и нам не нужно пересоздавать его каждый раз.
*На изображении отображена кнопка "Назад". В SourceMod версии 1011 и выше, кнопка "Назад" была переименована в "Предыдующая", и "Назад" зарезервированно для "ExitBack" функциональности. (актуально для ENG версии, на ру вроде бы оба пункта "назад". прим. переводчик)

=Голосование=
SourceMod также имеет API для отображения меню как голосования для больше чем одного клиента. SourceMod автоматически обрабатываем выбранные пункты and randomly picking a tie-breaker (не знаю как перевести. прим. переводчика). Так же API голосования добавляет два новых значения для <tt>MenuAction</tt>, которые во время отображения меню всегда вызываются.

*<tt>MenuAction_VoteStart</tt>: Вызывается после <tt>MenuAction_Start</tt>, когда голосование оффициально началось.
*<tt>MenuAction_VoteEnd</tt>: Вызывается после того, как все клиенты проголосовали или отменили свои меню голосований. Выбранный предмет может быть получен через <tt>param1</tt>. Вызывается '''перед''' <tt>MenuAction_End</tt>. Важно заметить, что это не замена <tt>MenuAction_End</tt>, это разные вещи. Нельзя освобождать меню в <tt>MenuAction_VoteEnd</tt>. '''Заметка:''' не вызывается, если используется <tt>SetVoteResultCallback</tt>().
*<tt>MenuAction_VoteCancel</tt>: Вызывается, если меню было отмеено в процессе голосования. Если вызвалось, то <tt>MenuAction_VoteEnd</tt> или обратный вызов (callback) для результата голосований не будет вызваны, но <tt>MenuAction_End</tt> будет после этого. Причина отмены голосования находится в <tt>param1</tt>.

Система меню - это то же самое меню, только с двумя дополнительными свойствами:
*Только одно голосование может быть активно. Вы должны проверять, не запущено ли голосование (<tt>IsVoteInProgress</tt>()), иначе <tt>VoteMenu</tt>() не сработает.
*Если клиент во время голосования отключится, то его голос будет недействительным.

Пример внизу показывает, как создать функцию <tt>DoVoteMenu()</tt>, которая будет спрашивать, хотят ли они сменить карту на предложенную.

==Простое Голосование==
<pawn>public Handle_VoteMenu(Handle:menu, MenuAction:action, param1, param2)
{
if (action == MenuAction_End)
{
/* Вызывается после VoteEnd */
CloseHandle(menu);
} else if (action == MenuAction_VoteEnd) {
/* 0=да, 1=нет */
if (param1 == 0)
{
new String:map[64];
GetMenuItem(menu, param1, map, sizeof(map));
ServerCommand("changelevel %s", map);
}
}
}

DoVoteMenu(const String:map[])
{
if (IsVoteInProgress())
{
return;
}

new Handle:menu = CreateMenu(Handle_VoteMenu);
SetMenuTitle(menu, "Сменить карту на: %s?", map);
AddMenuItem(menu, map, "да");
AddMenuItem(menu, "no", "нет");
SetMenuExitButton(menu, false);
VoteMenuToAll(menu, 20);
}</pawn>

==Продвинутое Голосование==
Если вам нужно больше информации о результатах голосовании, чем вам дает <tt>MenuAction_VoteEnd</tt>, вы можете указать отдельный обратный вызов (callback). Новый обратный вызов будет давать больше информации, но за опреденную цену: <tt>MenuAction_VoteEnd</tt> не будет вызвано, и вам придется самим решать, как обработать результат. Это делается с помощью <tt>SetVoteResultCallback</tt>().

Пример:
<pawn>public Handle_VoteMenu(Handle:menu, MenuAction:action, param1, param2)
{
if (action == MenuAction_End)
{
/* Вызывается после VoteEnd */
CloseHandle(menu);
}
}

public Handle_VoteResults(Handle:menu,
num_votes,
num_clients,
const client_info[][2],
num_items,
const item_info[][2])
{
/* Проверяем, нет ли сразу двух победителей */
new winner = 0;
if (num_items > 1
&& (item_info[0][VOTEINFO_ITEM_VOTES] == item_info[1][VOTEINFO_ITEM_VOTES]))
{
winner = GetRandomInt(0, 1);
}

new String:map[64];
GetMenuItem(menu, item_info[winner][VOTEINFO_ITEM_INDEX], map, sizeof(map));
ServerCommand("changelevel %s", map);
}

DoVoteMenu(const String:map[])
{
if (IsVoteInProgress())
{
return;
}

new Handle:menu = CreateMenu(Handle_VoteMenu);
SetVoteResultCallback(menu, Handle_VoteResults);
SetMenuTitle(menu, "Сменить карту на: %s?", map);
AddMenuItem(menu, map, "Yes");
AddMenuItem(menu, "no", "No");
SetMenuExitButton(menu, false);
VoteMenuToAll(menu, 20);
}</pawn>

=ExitBack=
ExitBack - специальный термин для обозначения "ExitBack Кнопки". По умолчанию эта кнопка отключена. Обычно нумерованные меню не имеют пункта "Назад" для первой страници. Если "ExitBack" кнопка включена, появится кнопка "Назад".

Выбор опции "ExitBack" для меню в обратном вызове будет в действии <tt>MenuCancel_ExitBack</tt> и <tt>MenuEnd_ExitBack</tt>. Функциональность этого такая же, как и у простого выхода из меню; дополнительная функциональность должна быть определена через обратный вызов.

=Освобождение Дескрипторов (Handle) меню=
Важно закрывать дескриптор меню в <tt>MenuAction_End</tt>. <tt>MenuAction_End</tt> вызывается когда меню закрылось и больше не нужно.

=Переводы=
Есть возможность динамически переводить меню для каждого игрока через <tt>MenuAction_DisplayItem</tt> callback. Специальный натив, <tt>RedrawMenuItem</tt>, используется чтобы преобразовать текст внутри вызова. Давайте переделаем наш пример голосования с переводами.

<pawn>public Handle_VoteMenu(Handle:menu, MenuAction:action, param1, param2)
{
if (action == MenuAction_End)
{
/* Вызывается после VoteEnd */
CloseHandle(menu);
} else if (action == MenuAction_VoteEnd) {
/* 0=да, 1=нет */
if (param1 == 0)
{
new String:map[64];
GetMenuItem(menu, param1, map, sizeof(map));
ServerCommand("changelevel %s", map);
}
} else if (action == MenuAction_DisplayItem) {
/* Получаем отображаемую строку, будем использовать как фразу перевода */
decl String:display[64];
GetMenuItem(menu, param2, "", 0, _, display, sizeof(display));

/* Переводим строку на язык клиента */
decl String:buffer[255];
Format(buffer, sizeof(buffer), "%T", display, param1);

/* Перерисовываем текст */
return RedrawMenuItem(buffer);
} else if (action == MenuAction_Display) {
/* Дескриптор панели будет вторым параметром */
new Handle:panel = Handle:param2;

/* Get the map name we're changing to from the first item */
/* Получаем название карты, на которую меняем, из первого пункта */
decl String:map[64];
GetMenuItem(menu, 0, map, sizeof(map));

/* Переводим нашу фразу */
decl String:buffer[255];
Format(buffer, sizeof(buffer), "%T", "Change map to?", client, map);

SetPanelTitle(panel, buffer);
}
}

DoVoteMenu(const String:map[])
{
if (IsVoteInProgress())
{
return;
}

new Handle:menu = CreateMenu(Handle_VoteMenu, MenuAction_DisplayItem|MenuAction_Display);
SetMenuTitle(menu, "Сменить карту на: %s?", map);
AddMenuItem(menu, map, "Yes");
AddMenuItem(menu, "no", "No");
SetMenuExitButton(menu, false);
VoteMenuToAll(menu, 20);
}</pawn>

[[Category:SourceMod Development]]
[[Category:SourceMod Scripting]]

{{LanguageSwitch}}

Template talk:Languages:ru

2021-07-20T13:23:42Z

Kleiner: Created page with ""Language:" Won't localize when changing language :["

"Language:"
Won't localize when changing language :[

Installing SourceMod/ru

2021-07-19T17:19:08Z

Kleiner:

{{Languages|Installing_SourceMod}}

Установка SourceMod очень проста, и он может быть добавлен практически без изменений конфигурации.

=Требования=
Веб-браузер с графическим интерфейсом для получения сжатых архивов Metamod и SourceMod.
Инструмент для копирования архива на ваш выделенный сервер.

SourceMod требует [[Metamod:Source]] 1.9.0 или выше (рекомендуется использовать последнюю версию). [http://www.metamodsource.net/ Нажмите здесь], чтобы посетить главную страницу Metamod:Source. Инструкции по установке SourceMM вручную можно найти [[Installing Metamod:Source|здесь]].

SourceMod будет работать практически с любым модом, созданным с использованием Source SDK.

Valve иногда вносит изменения в свои игры, которые нарушают SourceMod между выпусками.
Когда это происходит, вам может потребоваться установить новую версию Metamod и SourceMod. Вы можете узнать, требуется ли это, на странице [[Required Versions (SourceMod)|необходимых версий]].

=Загрузка/установка=
==Локальный сервер==
Чтобы установить [http://www.sourcemod.net/downloads.php SourceMod] в локальное хранилище, просто извлеките архив <tt>.zip</tt> (Windows) или <tt>.tar.gz</tt> (Linux) в папку вашего мода (например, <tt>cstrike</tt> для Counter-Strike, <tt>dod</tt> для Day of Defeat и так далее).

==Выделенный сервер==
Чтобы установить SourceMod на выделенный сервер, сначала распакуйте архив <tt>.zip</tt> (Windows) или <tt>.tar.gz</tt> (Linux) на локальный компьютер (например, на рабочий стол). Вы увидите папку <tt>addons</tt>.

Используя такой инструмент, как
[https://encrypted.google.com/#q=FTP FTP], найдите папку вашего мода (например, <tt>cstrike</tt> для Counter-Strike:Source, <tt>dod</tt> для Day of Defeat:Source и так далее). Под этой папкой должна находиться папка <tt>addons</tt> (если это не так, Metamod:Source, вероятно, не установлен). Из локальной папки <tt>addons</tt> загрузите всё содержимое в папку выделенного сервера <tt>addons</tt>. После этого в папке выделенного сервера <tt>addons</tt> должна появиться папка <tt>sourcemod</tt>.

Если у вас возникли трудности с этими шагами, вам необходимо ознакомиться с FTP и управлением сервером. Однако вы также можете обратиться за помощью к своему провайдеру сервера. Некоторые провайдеры также имеют веб-интерфейсы для управления вашим сервером.

В качестве альтернативы, если вы скопировали tar.gz в папку srcds, выполните следующие действия из подпапки cstrike:
tar -xzf ../sourcemod-1.1.0.tar.gz

=Проверка установки=
Расположение папок должно выглядеть следующим образом:
*<tt>[мод]</tt> - Папка вашего мода
**<tt>addons</tt>
***<tt>metamod</tt> - Metamod:Source
***<tt>sourcemod</tt> - SourceMod

После загрузки/копирования SourceMod и настройки Metamod:Source полностью перезапустите ваш сервер. Если он локальный, выключите его и перезапустите. Если сервер выделенный, вам может понадобиться обратиться за помощью к провайдеру. Тем не менее, часто безопасно отдать команду "quit" через [[rcon]], поскольку большинство провайдеров автоматически перезапустят ваш сервер.

Сначала в [[консоль сервера]] (не клиентской консоли) введите:
<pre>meta list</pre>

Если установка прошла успешно, вы увидите что-то вроде:
<pre>] meta list
Найден 1 плагин:
[01] SourceMod (1.1.0.2489) от AlliedModders LLC</pre>

После этого вы должны иметь возможность использовать корневую команду консоли SourceMod, которая вызывается просто:
<pre>sm</pre>

Пример:
<pre>] sm version
Информация о версии SourceMod:
SourceMod версии: 1.1.0.2489
Движок SourcePawn: SourcePawn 1.1, jit-x86 (сборка 1.1.0-svn)
SourcePawn API: вер.1 = 4, вер.2 = 2
Составлено на: 5 сентября 2008 02:02:12
http://www.sourcemod.net/
</pre>

Наконец, если вы уже настроили административного пользователя (если нет, то прочтите [[Adding Admins (SourceMod)|эту страницу]]), вы можете протестировать игровое меню, присоединившись к серверу, и в клиентской консоли наберите следующее:
<pre>sm_admin</pre>
Должно появиться всплывающее меню со всеми опциями.

=Устранение проблем=
Если установка не удалась, обычно вы увидите одну из четырёх причин.

==Metamod сообщает NOFILE или FAILED==
Если "meta list" ответит что-то вроде:
<pre>] meta list
Найден 1 плагин:
[01] <NOFILE></pre>

Скорее всего, либо файлы расположены в неправильном месте, либо файл не удалось загрузить. Для получения дополнительной информации используйте следующую команду (за исключением использования правильного номера списка):
<pre>meta info 1</pre>

==В списке Metamod нет плагинов==
Если "meta list" ответит что-то вроде:
<pre>] meta list
Найдено 0 плагинов:</pre>

Существует несколько причин этой ошибки.

# Наиболее распространённой причиной является то, что файл sourcemod.vdf не может быть расположен в папке addons/metamod. Убедитесь, что файл sourcemod.vdf присутствует в этой папке.
# Если файл sourcemod.vdf присутствует, убедитесь, что вы используете правильную сборку Sourcemod (zip = windows, tar.gz = linux).

==Metamod ничего не пишет==
Если "meta list" вообще не имеет ответа, значит Metamod:Source установлен неправильно. [[Installing Metamod:Source|Эта страница вики]] может подсказать вам, как решить эту проблему.

[[Category:SourceMod Documentation]]

Installing SourceMod/ru

2021-07-19T16:14:25Z

Kleiner: Created page with "{{Languages|Installing_SourceMod}}"

User:Kleiner

2021-07-19T14:58:49Z

Kleiner: Created page with "English-Russian Translator <br> Steam:http://steamcommunity.com/profiles/76561198158864042 <br>"

English-Russian Translator
<br>
Steam:http://steamcommunity.com/profiles/76561198158864042
<br>