AlliedModders Wiki - User contributions [en]

Menu API (SourceMod)=ru

2013-11-20T15:15:22Z

Reiko1231: added ru translation

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 OnPluginStart()
{
// зарегистрировали консольную команду menu_test1 для открытия меню.
RegConsoleCmd("menu_test1", Menu_Test1);
}

// хандл меню
public MenuHandler1(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); // пишем клиенту в консоль
}
/* Если меню было отменено, то сообщим об этом серверу. */
else if (action == MenuAction_Cancel)
{
PrintToServer("Клиент %d' закрыл меню. Причина: %d", param1, param2);
}
/* Если меню "закончилось", то удалим его из памяти */
else if (action == MenuAction_End)
{
CloseHandle(menu);
}
}

public Action:Menu_Test1(client, 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}}

Admin Menu Configuration (SourceMod)/ru

2013-09-02T11:07:14Z

Reiko1231: little misprint

В меню администратора SourceMod'а можно менять порядок пунктов. Пункты не могут быть перемещены из одной категории в другую, но они могут изменить свой порядок (расположение) внутри категории. Пункты, которые не были отсортированы, будут отображены ''после'' сортированных пунктов, и их сортировка будет определяться их трансляционной фразой.

Сортировка контролируется файлом ''addons/sourcemod/configs/adminmenu_sorting.txt''. Каждая секция обозначает имя категории. Порядок секций определяет порядок категорий (категории тоже можно сортировать). Каждая секция содержит список уникальных имен пунктов, которые будут сортироваться.

Помните, что пункты ''не'' команды. Они являются уникальными названиями, связанными с каждым пунктом меню. Сторонние плагины могут добавлять новые пукнты в меню администратора, и эти пункты будут иметь своё собственное уникальное имя, несмотря на то, есть ли такая команда или нет.

=Пример=
Данный пример делает меню похожим на меню администратора Mani Admin Plugin.

<pre>
"Menu"
{
"PlayerCommands"
{
"item" "sm_slay"
"item" "sm_kick"
"item" "sm_ban"
"item" "sm_gag"
"item" "sm_burn"
}

"ServerCommands"
{
"item" "sm_map"
"item" "sm_execcfg"
"item" "sm_reloadadmins"
}

"VotingCommands"
{
"item" "sm_cancelvote"
"item" "sm_votemap"
"item" "sm_votekick"
"item" "sm_voteban"
}
}</pre>

Для файла, приведенного выше, меню администратора будет выглядить следующим образом:
*Открыв его, будет три категории в следующем порядке: управление игроками, управление сервером, управление голосованиями
*Управление игроками будет содержать в следующем порядке: убить, кикнуть, забанить, отключить чат, поджечь. Дальше будут идти все пункты, которые не перечислены, но относятся к этой категории.
*Управление сервером будет содержать в следующем порядке: сменить карту, выполнить cfg, перезагрузить список администраторов. Дальше будут идти все пункты, которые не перечислены, но относятся к этой категории.
*Управление голосованием будет содержать в следующем порядке: отменить голосование, начать голосование за смену карты, начать голосование за кик, начать голосование за бан. Дальше будут идти все пункты, которые не перечислены, но относятся к этой категории.

[[Category:SourceMod Documentation]]

Admin Menu Configuration (SourceMod)/ru

2013-09-02T11:06:54Z

Reiko1231: Created page with "В меню администратора SourceMod'а можно менять порядок пунктов. Пункты не могут быть перемещены из о..."

В меню администратора SourceMod'а можно менять порядок пунктов. Пункты не могут быть перемещены из одной категории в другую, но они могут изменить свой порядок (расположение) внутри категории. Пункты, которые не были отсортированы, будут отображены ''после'' сортированных пунктов, и их сортировка будет определяться их трасляционной фразой.

Сортировка контролируется файлом ''addons/sourcemod/configs/adminmenu_sorting.txt''. Каждая секция обозначает имя категории. Порядок секций определяет порядок категорий (категории тоже можно сортировать). Каждая секция содержит список уникальных имен пунктов, которые будут сортироваться.

Помните, что пункты ''не'' команды. Они являются уникальными названиями, связанными с каждым пунктом меню. Сторонние плагины могут добавлять новые пукнты в меню администратора, и эти пункты будут иметь своё собственное уникальное имя, несмотря на то, есть ли такая команда или нет.

=Пример=
Данный пример делает меню похожим на меню администратора Mani Admin Plugin.

<pre>
"Menu"
{
"PlayerCommands"
{
"item" "sm_slay"
"item" "sm_kick"
"item" "sm_ban"
"item" "sm_gag"
"item" "sm_burn"
}

"ServerCommands"
{
"item" "sm_map"
"item" "sm_execcfg"
"item" "sm_reloadadmins"
}

"VotingCommands"
{
"item" "sm_cancelvote"
"item" "sm_votemap"
"item" "sm_votekick"
"item" "sm_voteban"
}
}</pre>

Для файла, приведенного выше, меню администратора будет выглядить следующим образом:
*Открыв его, будет три категории в следующем порядке: управление игроками, управление сервером, управление голосованиями
*Управление игроками будет содержать в следующем порядке: убить, кикнуть, забанить, отключить чат, поджечь. Дальше будут идти все пункты, которые не перечислены, но относятся к этой категории.
*Управление сервером будет содержать в следующем порядке: сменить карту, выполнить cfg, перезагрузить список администраторов. Дальше будут идти все пункты, которые не перечислены, но относятся к этой категории.
*Управление голосованием будет содержать в следующем порядке: отменить голосование, начать голосование за смену карты, начать голосование за кик, начать голосование за бан. Дальше будут идти все пункты, которые не перечислены, но относятся к этой категории.

[[Category:SourceMod Documentation]]

Admin Menu Configuration (SourceMod)

2013-09-02T11:06:21Z

Reiko1231: added LanguageSwitch, added RU translation

SourceMod's administration menu can be configured to change the ordering of items. Items cannot be moved from one category to another, however, they can be re-ordered within categories. Items that are not explicitly sorted are displayed ''after'' the sorted items, and they are sorted by their translated phrase in the client's language.

Sorting is controlled via ''addons/sourcemod/configs/adminmenu_sorting.txt''. Each section specifies the name of a category. The order of the sections determines the order the categories are sorted. Each section contains a list of unique item names that specify item sorting.

Note that the items are ''not'' commands. They are the unique names associated with each item on the menu. Third party plugins may add new items to the admin menu, and those items will have their own unique names, whether there is an associated command or not.

=Sample Layout=
This layout is designed to look similar to Mani Admin Plugin's admin menu.

<pre>
"Menu"
{
"PlayerCommands"
{
"item" "sm_slay"
"item" "sm_kick"
"item" "sm_ban"
"item" "sm_gag"
"item" "sm_burn"
}

"ServerCommands"
{
"item" "sm_map"
"item" "sm_execcfg"
"item" "sm_reloadadmins"
}

"VotingCommands"
{
"item" "sm_cancelvote"
"item" "sm_votemap"
"item" "sm_votekick"
"item" "sm_voteban"
}
}</pre>

[[Category:SourceMod Documentation]]

{{LanguageSwitch}}

Adding Admins (SourceMod)/ru

2013-09-01T09:57:38Z

Reiko1231:

__FORCETOC__
SourceMod обладает детальной и гибкой системой администрирования, и это может быть сложным для некоторых пользователей. Чтобы упростить вещи, были введены "флаги", которые определяют права администраторов.

На данный момент есть два пути добавления администратора. Один из них через admin-flatfile.smx плагин, который по умолчанию включен. Этот файл обеспечивает два файла: упрощенный файл, и другой, более сложный древообразный файл. Другой путь добавления администратора - использование [[SQL Admins (SourceMod)|SQL]].

SourceMod обладает тремя методами идентификации:
*''Steam ID'' (уникален для каждого Steam аккаунта)
*''IP Address'' (полу-уникален для данного компьютера, лучше для локальных сетей)
*''Name'' (требует пароля для идентификации)

=Быстрый Старт=
Зайдите в корневую папку сервера. Откройте [папка мода (для CSS это cstrike, для tf2 это tf, и так далее)]/addons/sourcemod/configs/admins_simple.ini

С новой строки добавьте следующий текст, заменив yoursteamid на ваш Steam ID (используйте клиентскую консольную команду '''status''', чтобы узнать ваш Steam ID - он выглядит как STEAM_n:o:p)

'''"yoursteamid" "99:z"'''

Сохраните файл, затем напишите в консоль сервера sm_reloadadmins. Подключитесь к серверу с помощью игрового клиента. Напишите sm_admin в консоль игры, а затем вернитесь к игре. Вы должны увидеть меню администратора.

=Уровни Доступа=
Для начала давайте быстро пробежимся через предоставленные уровни доступа:
:{| cellpadding="5"
|- class="t2th"
| Название Флага
| Флаг
| Для чего предназначен
|- class="t2td"
| reservation
| a
| Доступ к резервному слоту.
|- class="t2td"
| generic
| b
| Обычная админка, требуется для администраторов.
|- class="t2td"
| kick
| c
| Кикать других игроков.
|- class="t2td"
| ban
| d
| Банить других игроков.
|- class="t2td"
| unban
| e
| Удалять баны.
|- class="t2td"
| slay
| f
| Убивать/вредить другим игрокам.
|- class="t2td"
| changemap
| g
| Менять карту или другие воздействия на игровой процесс.
|- class="t2td"
| cvar
| h
| Изменять большинство консольных переменных (конваров, cvars, ConVars).
|- class="t2td"
| config
| i
| Выполнять конфиг файлы.
|- class="t2td"
| chat
| j
| Специальные привилегии чата.
|- class="t2td"
| vote
| k
| Запускать или создавать голосования.
|- class="t2td"
| password
| l
| Устанавливать пароль на сервер.
|- class="t2td"
| rcon
| m
| Использование RCON команд.
|- class="t2td"
| cheats
| n
| Изменять sv_cheats или использовать читерские команды.
|- class="t2td"
| root
| z
| Волшебным образом включает все флаги.

|- class="t2td"
| custom1
| o
| Настраиваемая Группа 1.
|- class="t2td"
| custom2
| p
| Настраиваемая Группа 2.
|- class="t2td"
| custom3
| q
| Настраиваемая Группа 3.
|- class="t2td"
| custom4
| r
| Настраиваемая Группа 4.
|- class="t2td"
| custom5
| s
| Настраиваемая Группа 5.
|- class="t2td"
| custom6
| t
| Настраиваемая Группа 6.
|}

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

Например, Админстратор #1 обладает "3" уровнем иммунитета, а Админстратор #2 обладает уровнем иммунитета "10". Админстратор #2 может производить действия над Админстратором #1, а Админстратор #1 не может произвести действия над Админстратором #2. Уровни иммунитета могут быть совершенно произвольными, могут быть равны любому числу, которое больше нуля. Помните, что "0" значит отсутствие иммунитета.

По умолчанию администраторы с одинаковым уровнем иммунитета могут воздействовать друг на друга. Это может быть изменено через <tt>sm_immunity_mode</tt> в файле <tt>cfg/sourcemod.cfg</tt>.

=Пароли=
Чтобы пароли работали, серверный администратор должен изменить строку "PassInfoVar" в файле <tt>addons/sourcemod/configs/core.cfg</tt>. Например:
<pre>"PassInfoVar" "_sm1337"</pre>

Дальше, если администратор имеет пароль, он или она должен ввести пароль через команду ''setinfo'' в консоль клиента. Например, используя пример выше, <tt>BAILOPAN</tt> должен прописать следующее:
<pre>setinfo "_sm1337" "Gab3n"</pre>

Для автоматизации этого процесса (ввода пароля через setinfo), вы можете создать "autoexec.cfg" файл в вашей папке игрового клиента. Этот файл расположен по пути <tt>SteamApps\ACCOUNT\[игра]\[папка мода]\cfg</tt>. Например:
*<tt>C:\Program Files\Steam\steamapps\bailopan\Counter-Strike Source\cstrike\cfg</tt>

Вы так же можете ввести пароль перед соединением с сервером. Для Steam ID и IP идентификации, ваши привилегии администратора будут автоматически выданы вам, если пароль правильный. Для идентификации по имени, ваш пароль должен быть правильным при смене имени, иначе вы будете кикнуты с сервера.

=Простое Добавление Администратора=
Самый простой путь добавить администратора - редактирование файла <tt>configs/admins_simple.ini</tt>. Этот файл содержит два параметра на линии: идентификационная информация, и флаги. Строка флагов - нечто гибкое и может содержать следующую информацию:
*Опционально: уровень иммунитета, разделенный двоеточием (':');
*Строчно флаг, '''или''';
*Имя группы, начинающееся с символа '@'

Три примера:
<pre>
"STEAM_0:1:16" "bce" //админка, кик и разбан по данном SteamID. Без иммунитета.
"!127.0.0.1" "5:z" //все права для этого ip, уровень иммунитета = 5
"BAILOPAN" "abc" "Gab3n" //имя BAILOPAN, пароль "Gab3n": обладает резервным слотом, доступом к админке, кик
</pre>

=Детальная Настройка Администратора=
Вы так же можете добавить администратора через <tt>configs/admins.cfg</tt>, настраиваемый файл в формате KeyValues. Каждый администратор обладает своим собственным блоком внутри блока администратора. Вы можете создавать и / или модифицировать <tt>admins.cfg</tt> файл с помощью [http://forums.alliedmods.net/showthread.php?t=81160 KVManager]. Формат файла следующий:

<pre>Admins
{
"Имя администратора"
{
"auth" "[steam|name|ip]"
"identity" "[unique id]"
"[option1]" "[value1]"
"[option2]" "[value2]"
/* .... */
}
}</pre>

Доступные опции:
*<tt>auth</tt>: Требуется. Должен быть: <tt>steam</tt>, <tt>name</tt>, или <tt>ip</tt> (если нет специального метода идентификации), говорит SourceMod'у, чем является <tt>идентификационное</tt> значение.
*<tt>identity</tt>: Требуется. Уникальное значение, которое позволяет SourceMod'у найти этого администратора по аудентификационному методу и полученному значению.
*<tt>password</tt>: Опционально. Пароль, который должен ввести администратор (смотрите раздел выше про пароли).
*<tt>group</tt>: Опционально. Имя группы, к которой должен принадлежать администратор. Может быть объявлено больше чем одна "group" линия. Здесь не нужно ставить символ '@' перед именем группы.
*<tt>flags</tt>: Опционально. Флаг доступа.
*<tt>immunity</tt>: Опционально. Уровень иммунитета.

Имя администратора опционально (оно может быть пустым). Оно не используется и присутствует только для удобства сторонним программам.

Пример:
<pre>Admins
{
"BAILOPAN"
{
"auth" "steam"
"identity" "STEAM_0:1:2345"
"flags" "abcdef"
"immunity" "5"
"group" "Awesome Admins"
}

"Blue Crab"
{
"auth" "steam"
"identity" "STEAM_0:1:666666"
"flags" "z"
"immunity" "99"
}
}</pre>

=Смотрите Также=
*[[Adding Groups (SourceMod)]]
*[[Ru:Overriding Command Access (SourceMod)|Переопределение Доступа к командам]]

[[Category:SourceMod Documentation]]

Adding Admins (SourceMod)/ru

2013-09-01T09:53:33Z

Reiko1231: Created page with "__FORCETOC__ SourceMod обладает детальной и гибкой системой администрирования, и это может быть сложным д..."

Adding Admins (SourceMod)

2013-09-01T09:53:23Z

Reiko1231: added LanguageSwitch, added RU translation

__FORCETOC__
SourceMod has as very detailed and flexible administration system, and it can be quite daunting to users. To simplify things, there are a number of "flags" which specify generic permissions administrators can have.

There are currently two provided ways of storing admins. One is via the admin-flatfile.smx plugin that is enabled by default. This plugin provides two files: a simplified flat file, and another more complex tree-based file. The other way to store admins is using [[SQL Admins (SourceMod)|SQL]].

SourceMod provides three methods of authentication:
*''Steam ID'' (unique to a Steam account)
*''IP Address'' (semi-unique to a given computer, better for LANs)
*''Name'' (requires a password)

=Quick Start=
On the server, open [modfolder]/addons/sourcemod/configs/admins_simple.ini

In a new line, add the following, replacing yoursteamid (use your client's console '''status''' command to retrieve your Steam ID - formatted as STEAM_n:o:p)

'''"yoursteamid" "99:z"'''

Save the file, then type sm_reloadadmins in the server console. Connect to the server with the game client. Enter sm_admin in the client console, and then return to the game. You should see the admin menu.

=Levels=
First, let's quickly run down the provided levels:
:{| cellpadding="5"
|- class="t2th"
| Name
| Flag
| Purpose
|- class="t2td"
| reservation
| a
| Reserved slot access.
|- class="t2td"
| generic
| b
| Generic admin; required for admins.
|- class="t2td"
| kick
| c
| Kick other players.
|- class="t2td"
| ban
| d
| Ban other players.
|- class="t2td"
| unban
| e
| Remove bans.
|- class="t2td"
| slay
| f
| Slay/harm other players.
|- class="t2td"
| changemap
| g
| Change the map or major gameplay features.
|- class="t2td"
| cvar
| h
| Change most cvars.
|- class="t2td"
| config
| i
| Execute config files.
|- class="t2td"
| chat
| j
| Special chat privileges.
|- class="t2td"
| vote
| k
| Start or create votes.
|- class="t2td"
| password
| l
| Set a password on the server.
|- class="t2td"
| rcon
| m
| Use RCON commands.
|- class="t2td"
| cheats
| n
| Change sv_cheats or use cheating commands.
|- class="t2td"
| root
| z
| Magically enables all flags.

|- class="t2td"
| custom1
| o
| Custom Group 1.
|- class="t2td"
| custom2
| p
| Custom Group 2.
|- class="t2td"
| custom3
| q
| Custom Group 3.
|- class="t2td"
| custom4
| r
| Custom Group 4.
|- class="t2td"
| custom5
| s
| Custom Group 5.
|- class="t2td"
| custom6
| t
| Custom Group 6.
|}

=Immunity=
In SourceMod, immunity is a flexible system based on ''immunity levels''. Every admin can have an arbitrary immunity value assigned to them. Whether an admin can target another admin depends on who has a higher immunity value.

For example, say Admin #1 has an immunity level of "3" and Admin #2 has an immunity level of "10." Admin #2 can target Admin #1, but Admin #1 cannot target Admin #2. The numbers are completely arbitrary, and they can be any number equal to or higher than 0. Note that 0 always implies no immunity.

By default, admins with the same immunity value can target each other. This can be changed via <tt>sm_immunity_mode</tt> in <tt>cfg/sourcemod.cfg</tt>.

=Passwords=
For passwords to work, the server administrator must change the "PassInfoVar" line in <tt>addons/sourcemod/configs/core.cfg</tt>. For example:
<pre>"PassInfoVar" "_sm1337"</pre>

Next, if an admin has a password, he or she must set the password via the ''setinfo'' command in the client console. For example, using the examples above, <tt>BAILOPAN</tt> would need to type:
<pre>setinfo "_sm1337" "Gab3n"</pre>

To automate this upon connecting to a server, you can create an "autoexec.cfg" file in your client game folder. This will be located under <tt>SteamApps\ACCOUNT\[game]\[gameabbr]\cfg</tt>. For example:
*<tt>C:\Program Files\Steam\steamapps\bailopan\Counter-Strike Source\cstrike\cfg</tt>

You can also set the password upon connecting. For Steam and IP authentication, your admin privileges will be automatically assigned if the password is correct. For name based authentication, your password must be correct before you change your name, or else you will be kicked from the server.

=Simple Admins=
The easiest way to add administrators is through <tt>configs/admins_simple.ini</tt>. This is a flat file which requires two parameters per line: authentication info, and flags. The flag string is somewhat flexible and can have the following information:
*An optional immunity level value, followed by a colon (':');
*A flag string, '''or''';
*A group name, preceded by an '@' symbol

Three examples are provided:
<pre>
"STEAM_0:1:16" "bce" //generic, kick, unban for this steam ID. no immunity
"!127.0.0.1" "5:z" //all permissions for this ip, immunity level = 5
"BAILOPAN" "abc" "Gab3n" //name BAILOPAN, password "Gab3n": gets reservation, generic, kick
</pre>

=Detailed Admins=
Alternatively, you can add admins via <tt>configs/admins.cfg</tt>, a more advanced file stored in a KeyValues format. Each admin is its own block inside a main "Admin" block. You can create and / or modify <tt>admins.cfg</tt> files with [http://forums.alliedmods.net/showthread.php?t=81160 KVManager]. The format is as follows:

<pre>Admins
{
"Admin Name"
{
"auth" "[steam|name|ip]"
"identity" "[unique id]"
"[option1]" "[value1]"
"[option2]" "[value2]"
/* .... */
}
}</pre>

Available options are:
*<tt>auth</tt>: Required. Must be one of <tt>steam</tt>, <tt>name</tt>, or <tt>ip</tt> (unless there is a custom auth method), and instructs SourceMod how to interpret the <tt>identity</tt> value.
*<tt>identity</tt>: Required. Unique value that allows SourceMod to find this admin given an authentication method and the given value.
*<tt>password</tt>: Optional. Specifies the password the user must enter (see above section on passwords).
*<tt>group</tt>: Optional. Specifies a group name the user should inherit if available. More than one "group" line can be specified. There should be no '@' symbol as there is no ambiguity.
*<tt>flags</tt>: Optional. Default access flags the user should receive.
*<tt>immunity</tt>: Optional: Default immunity level the user should receive.

The admin name is optional (it can be blank). It is not used internally and is intended for convenience usage by 3rd party tools.

Example:
<pre>Admins
{
"BAILOPAN"
{
"auth" "steam"
"identity" "STEAM_0:1:2345"
"flags" "abcdef"
"immunity" "5"
"group" "Awesome Admins"
}

"Blue Crab"
{
"auth" "steam"
"identity" "STEAM_0:1:666666"
"flags" "z"
"immunity" "99"
}
}</pre>

=See Also=
*[[Adding Groups (SourceMod)]]
*[[Overriding Command Access (SourceMod)]]

[[Category:SourceMod Documentation]]

{{LanguageSwitch}}

Overriding Command Access (SourceMod)/ru

2013-09-01T08:30:46Z

Reiko1231:

Эта статья объясняет, как без изменений исходных кодов плагина вы можете изменить флаги доступа к любой команде, как для всех сразу, так и для одной из групп.

=Вступление=
Переопределение доступа к команде - один из самых мощных аспектов системы администрирования SourceMod. Оно позволяет вам:
*Настроить доступ к любой команде администратора без изменения исходного кода плагина;
*Изменить доступ к целой группе команд без изменений исходного кода;
*Создать настраиваемые уровни доступа;
*Разрешить или запретить команду или группу команд группе администраторов, несмотря на их флаги доступа.

Изменение прав доступа к SourceMod объекту называется ''переопределением'' (оверрайд, override). Переопределение - это произвольная строка. Если переопределенная строка совпадает с именем команды, то тогда доступ к команде будет унаследован от переопределения.

Это очень важно по двум причинам:
*Переопределение может изменить доступ к команде.
*Переопределение может использоваться как настраиваемый флаг доступа.

Например, плагин требует доступ к флагу "g", чтобы использовать команду <tt>sm_map</tt>. Однако, переопределение может дать/запретить использовать эту команду определенной группе и/или может изменить обычный флаг для <tt>sm_map</tt> на "k" (или любой другой).

Другой случай: плагин может требовать доступ к <tt>sm_map</tt>, чтобы использовать пункт в меню. В этом случае, пользователю будет достаточно иметь только доступ к <tt>sm_map</tt>, а не иметь флаг целиком.

Последний пример гибкости этой системы: плагин может сообщить, что пользователь должен обладать доступом к <tt>plugin_crab_usage</tt>, а это не является командой. Вместо этого плагин подразумевает "значение по умолчание" как уровень доступа, и пользователи могут выбрать, как переопределить. Это показывает, что переопределения отделены от команд, однако, команды наследуют их права доступа от переопределений одинаковых имен.

=Типы Переопределений=
Переопределения бывают двух видов: переопределение ''команды'' и переопределение ''групп команд''.

Переопределение команды переопределяет уровень доступа, если у переопределения и у команды одинаковые названия. В этом случае команда автоматически наследует уровень доступа у переопределения.
Пример: если существует переопределение для <tt>sm_map</tt>, то тогда любая команда администратора, имеющая название <tt>sm_map</tt> будет наследовать эти разрешения.

По аналогии с этим, переопределение ''групп команд'' переопределяет уровни доступа для всех команд, которые относятся к этой группе.
Пример: Если существует переопределение ''групп команд'' для <tt>CSDM</tt>, то все команды администратора, отмеченные как "CSDM" унаследуют такие же права доступа.

=Глобальная конфигурация=
Уровни доступа для переопределений могут быть глобально переопределены через <tt>configs/admin_overrides.cfg</tt>. Формат файла очень прост:

<pre>
Overrides
{
"[имя1]" "[флаги]"
"@[группа1]" "[флаги]"
/* ... */
}</pre>

Группы команд отмечаются установкой символа ('@') перед названием. Пример:

<pre>
Overrides
{
"sm_map" "k" //Изменить доступ к команде "sm_map" на "k" флаг.
"@CSDM" "m" //Изменяет доступ ко всем CSDM командам на "m" флаг.
"sm_chat" "" //Позволяет всем использовать "sm_chat"
}</pre>

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

=Настройка Групп=
Переопределения групп позволяет разрешить или запретить группе команды. Это гораздо проще, чем настраивать флаги каждой группе.

Для более подробной информации посетите [[Adding_Groups_%28SourceMod%29#File_Format|Adding Groups]].

[[Category:SourceMod Documentation]]

Overriding Command Access (SourceMod)/ru

2013-08-31T18:09:35Z

Reiko1231: edited little misprints

Custom Admin Menu (SourceMod)/ru

2013-08-31T18:05:41Z

Reiko1231: changed link from En:Overriding Command Access to Ru:Overriding Command Access

==Вступление==

Кастом меню (Custom menu) позволяет серверным администраторам добавлять новые пункты в меню администратора. Оно было разработано, чтобы позволить плагинам добавлять свои возможности в меню, без внесения изменений в исходный код, т.к. большинство людей не обладают необходимыми знаниями. Для более подробной информации смотрите [[Admin Menu (SourceMod Scripting)]].

Настраивается кастом меню через конфиг файл (расположен по пути: sourcemod/configs/adminmenu_custom.txt) и именно этот файл определяет, какие пункты или категории будут ''добавлены'' к стандартному меню при запуске сервера.

==Параметры==

Ниже перечислены все парамерты, которые могут быть указаны при настройке вашего меню. Многие из них опциональны и имеют значение по умолчанию, если их не указали. Для более подробной информации смотрите [[#Пример|Пример]] и/или приложение(я) [[#Файлы с примерами|Файлы с примерами]].

*cmd - команда на выполнение (#1,#2 и так далее - лимита на число параметров нет) Используйте @номер чтобы параметр не был взят в "кавычки"
*admin - требуемый уровень администратора для доступа к этой команде - смотрите [[#Уровни администраторов|Уровни администраторов]] для более подробной информации
*execute - 'server' или 'player' - кто является "выполнителем" команды - сервер или тот, кто использует эту команду. По умолчанию 'player'
*1 - Информация о параметре 1 (#1) - их должно быть ровно столько, сколько параметров в cmd
**type - по умолчанию 'list', если не было указан.
***'groupplayer' - Лист [[#Group Подменю|Групп]] + подключенные игроки
***'group' - Лист [[#Group Подменю|Групп]]
***'player' - Лист игроков
***'list' - Настраеваемый список опций
***'mapcycle' - Автоматически заполняемое меню из карт вашего файла цикла карт
***'onoff' - "Вкл" или "Выкл", отсылает 1/0 (удобно для работы с консольными переменными (квары, ConVars, cvars), и им подобным)
**path - Требуется только при type = mapcycle. Путь (включая имя файла и расширение) к файлу, содержащему список карт (с форматом записи как у mapcycle.txt) - по умолчанию значение 'mapcycle.txt'
**method - 'name' (имена игроков), 'steamid' (стим айди), 'userid' (юзерид), 'userid2' (не содержит '#'), 'clientid' (айди клиента), 'ip' (айпи) - требуется только для groupplayer/player типов - по умолчанию name
**title - Заглавие меню, которое будет отображаться для выбора параметров (опционально (не обязательно))
**1-x - Лист параметров - требуется только для типа 'list'
**1.-x. - Текст, который будет показан для параметра - требуется только для типа 'list' (опционально, если не указать, то будет написано то, что указано в соответствующем листе параметров)
**1* - x* - Требуемый уровень доступа администратора, чтобы увидеть эту опцию (тоже самое, что и поле 'admin')

==Пример==
'''Внимание!'''
Если вы хотите использовать русские буквы в меню, то кодировка файла '''должна быть''' UTF-8 (без BOOM), иначе вместо букв вы увидите знаки вопроса!
<pawn>
"Commands"
{
"Fun Commands"
{
"Set Player Speed"
{
"cmd" "sm_speed #1 @2"
"admin" "sm_kick"
"execute" "player"
"1"
{
"type" "groupplayer"
"method" "name"
"title" "Player/Team to Edit"

}
"2"
{
"type" "list"
"title" "Speed Multiplier"
"1" "1.0"
"1." "Normal"
"2" "0.8"
"2." "80%"
"3" "0.5"
"3." "Half"
"4" "1.5"
"4." "50% Boost"
"5" "2.0"
"5." "Double"
"5*" "sm_ban"
//Double увидят лишь те администраторы, которые имеют доступ к команде "sm_ban"
}

}
}
}
</pawn>
Если использовать пример выше для вашего adminmenu_custom.txt, то при запуске сервера в меню администратора будет добавлена новая категория под названием 'Fun Commands'.
*Эта категория будет содержать пункт под названием: "Set Player Speed".
*Выбрав его, вы увидите другое меню, с названием: "Player/Team to Edit", содержащий названия команд и имена игроков.
*Выбрав один из вариантов, будет создано второе меню, с названием "Speed Multiplier".
*С выбором опций: "Normal", "80%", и так далее.
*Если игрок выберет опцию "Double", то команда на выполнение будет выглядеть так: 'sm_speed "@CT" 2.0' (команда отсылается на выполнение через FakeClientCommand)

Заметка: Вы можете использовать \ как управляющий символ. Таким образом, \" позволит вам добавить кавычку в вашу строку.

==Уровни администраторов==

Все 'type' 'admin' теперь требуют строчную команду. Эта команда может уже существовать (например, sm_ban) или быть полностью придуманной (например, onlycrabscanusethis).

Если команда существует, то эта опция (или лист опций) будет требовать уровень доступа, равный уровню доступа к этой команде (включая любые переопределения (оверрайды, overrides), которые вы сделали). 
Например, если вы используете sm_ban как уровень администратора для подменю, то таким образом каждый, кто имеет доступ к sm_ban, будет так же иметь доступ и к этому подменю (по умолчанию доступ к этой команде является флаг бана). Однако если вы переопределили sm_ban для одной из групп ("override" "allow" - в файле admin_groups.cfg), то эта группа так же получит доступ.

Если команда не существует, то вам нужно будет добавить переопределение для этой команды, как это делается для простых команд. Это делается в файле admin_overrides.cfg (чтобы назначить флаг доступа к этой команде,
и/или в файле admin_groups.cfg (чтобы дать доступ к команде определенной группе или же забрать, несмотря на то, что они имеют флаг доступа)

Если уровень доступа не был назначен, то тогда уровнем доступа будет назначен первый аргумент "cmd". Например, для команды
<pawn>
"cmd" "sm_ban #1 #2"
</pawn>

уровнем доступа будет уровень доступа sm_ban, включая все его переопределения.

Для более подробной информации смотрите [[Ru:Overriding Command Access (SourceMod)|Переопределение уровней доступа]]

==Group Подменю==

Типы 'group' и 'groupplayer' автоматически добавляют заранее настроенные опции в меню. Эти опции настраиваются в файле sourcemod/configs/adminmenu_grouping.txt

Обычно они используются, чтобы добавить такие команды как '@all', '@t' и другие, для ваших меню.

==Категории==

Если вы хотите добавить пункт в уже существующую SourceMod категорию, вы должны будете определить его внутреннее имя в "commands" группе. Три категории, предоставленные SourceMod'ом:

*PlayerCommands (Управление игроками)
*ServerCommands (Управление сервером)
*VotingCommands (Управление голосованиями)

==Сортировка==
Категории и пункты, добавленные с использованием динамических меню, могут быть отсортированы, как обычные пункты. Для подробной информации смотрите [[Admin Menu Configuration (SourceMod)|Admin Menu Configuration]]

Для того, чтобы можно было сортировать добавленный пункт, вы должны дать вашей команде уникальное имя в вашем конфигурационном файле. Для приведенного примера:
<pawn>
"item" "Set Player Speed"
</pawn>
==Дополнительные возможности==
Пример использования полного потенциала меню: даем администраторам доступ к квару, не давая им флага доступа 'sm_cvars'

Добавьте квар, к которому вы хотите дать доступ, и установите 'execute' 'server'
<pawn>
"cmd" "mp_friendlyfire #1"
"execute" "server"
"admin" "sm_kick"
</pawn>
Таким образом, команда будет выполнена через rcon, несмотря на обычную систему уровней доступа, и проверит доступ только к флагу, указанному в поле 'admin'. Это так же работает для любых других команд, включая sm_rcon.

==Файлы с примерами==

Пример файла adminmenu_custom.txt настроенный для Super Commands: 
[http://alliedmods.net/~pred/supercmdsmenu.ini adminmenu_custom.txt] 
 
Полный пример, спасибо uE|Tekniqal: 
[http://alliedmods.net/~pred/smsuper.ini adminmenu_custom.txt] 
[http://alliedmods.net/~pred/admin_overrides.cfg admin_overrides.cfg] 
[http://alliedmods.net/~pred/admin_groups.cfg admin_groups.cfg] 

[[Category:SourceMod Documentation]]

Overriding Command Access (SourceMod)/ru

2013-08-31T18:03:32Z

Reiko1231: Created page with "Эта статья объясняет, как без изменений исходных кодов плагина, вы можете изменить флаги доступ..."

Эта статья объясняет, как без изменений исходных кодов плагина, вы можете изменить флаги доступа к любой команде, как для всех сразу, так и для одной из групп.

=Вступление=
Переопределение доступа к коменде - один из самых мощных аспектов SourceMod администрирования. Оно позволяет вам:
*Настроить доступ к любой команде администратора без изменения исходного кода плагина;
*Изменить доступ к целой группе команд без изменений исходного кода;
*Создать настраивыемые уровни доступа;
*Разрешить или запретить команду или группу команд группе администраторов, несмотря на их флаги доступа.

Изменение прав доступа к SourceMod объекту называется ''переопределением'' (оверрайд, override). Переопределение - это произвольная строка. Если переопределенная строка совпадает с именем команды, то тогда доступ к команде будет унаследован от переопределения.

Это очень важно по двум причинам:
*Переопределение может изменить доступ к команде.
*Переопределение может использоваться как настраиваемый флаг доступа.

Например, плагин требует доступ к флагу "g", чтобы использовать команду <tt>sm_map</tt>. Однако, переопределение может дать/запретить использовать эту команду определенной группе и/или может изменить обычный флаг для <tt>sm_map</tt> на "k" (или любой другой).

Другой случай: плагин может требовать доступ к <tt>sm_map</tt>, чтобы использовать особый пункт в меню. В этом случае, пользователю будет достаточно иметь только доступ к <tt>sm_map</tt>, а не иметь флаг целиком.

Последний пример гибкости этой системы: плагин может сообщить, что пользователь должен обладать доступом к <tt>plugin_crab_usage</tt>, а это не является командой. Вместо этого плагин подразумевает "значение по умолчание" как уровень доступа, и пользователи могут выбрать, как переопределить. Это показывает, что переопределения отделены от команд, однако, команды наследуют их права доступа от переопределений одинаковых имен.

=Типы Переопределений=
Переопределения бывают двух видов: переопределение ''команды'' и переопределение ''групп команд''.

Переопределение команды переопределяет уровень доступа, если у переопределения и у команды одинаковые названия. В этом случае команда автоматически наследует уровень доступа у переопределения.
Пример: если существует переопределение для <tt>sm_map</tt>, то тогда любая команда администратора, имеющая название <tt>sm_map</tt> будет наследовать эти разрешения.

По аналогии с этим, переопределение ''групп команд'' переопределяет уровни доступа для всех команд, которые относятся к этой группе.
Пример: Если существует переопределение ''групп команд'' для <tt>CSDM</tt>, то все команды администратора, отмеченные как "CSDM" унаследуют такие же права доступа.

=Глобальная конфигурация=
Уровни доступа для переопределений могут быть глобально переопределены через <tt>configs/admin_overrides.cfg</tt>. Формат файла очень прост:

<pre>
Overrides
{
"[имя1]" "[флаги]"
"@[группа1]" "[флаги]"
/* ... */
}</pre>

Группы команд отмечаются установкой символа ('@') перед названием. Пример:

<pre>
Overrides
{
"sm_map" "k" //Изменить доступ к команде "sm_map" на "k" флаг.
"@CSDM" "m" //Изменяет доступ ко всем CSDM командам на "m" флаг.
"sm_chat" "" //Позволяет всем использовать "sm_chat"
}</pre>

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

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

Для более подробной информации посетите [[Adding_Groups_%28SourceMod%29#File_Format|Adding Groups]].

[[Category:SourceMod Documentation]]

Overriding Command Access (SourceMod)

2013-08-31T18:03:01Z

Reiko1231: added LanguageSwitch, added RU translation

This article explains how, without editing plugin source code, you can change the flags or permissions on any command, either globally, or for a specific group.

=Introduction=
Command access overrides are one of the most powerful aspects of the SourceMod administration system. They effectively let you:
*Change the access to any admin command without modifying plugin source code;
*Change the access to entire groups of commands without modifying source code;
*Create custom access levels;
*Allow or deny commands and groups of commands to an administrator group regardless of the command flags.

When you change the permissions to a SourceMod object, it is called an ''override''. An override is an arbitrary string. If the override string matches a command name, then the command permissions will be inherited from that override.

This concept is important for two reasons:
*An override can change the permissions of a command.
*An override can be used as a custom access flag.

For example, a plugin might require access "g" to use the <tt>sm_map</tt> command. However, an override could explicitly allow/deny usage of this command to a given group, and/or it could change the default flag for <tt>sm_map</tt> to be "k" instead.

More interestingly, a plugin could require <tt>sm_map</tt> access in order to use a specific menu option. In this case, a user would have to be able to access <tt>sm_map</tt>, rather than have a hardcoded flag.

As a final example of the flexibility of this system, a plugin might say that users must be able to access <tt>plugin_crab_usage</tt>, which isn't a command at all. Instead, the plugin assumes a ''default'' access level internally, and users can opt to override it as they wish. This demonstrates that overrides are separate from commands, however, commands themselves inherit their permissions from overrides of the same name.

=Override Types=
Overrides come in two flavors: ''command'' overrides and ''command group'' overrides. Command overrides are overrides that, if they have the same name as a command, that command will automatically inherit that override's permissions.

Similarly, a ''command group'' override is an override that which, if a command has the same group name as a ''command group'' override, that command will inherit the override's permissions.

Example 1: If a command override exists for <tt>sm_map</tt>, any admin command named <tt>sm_map</tt> will inherit those permissions.

Example 2: If a command group override exists for <tt>CSDM</tt>, any admin command labelled as a "CSDM" command will inherit those permissions.

=Global Configuration=
Access levels for overrides can be globally reconfigured via <tt>configs/admin_overrides.cfg</tt>. The file format is very simple:

<pre>
Overrides
{
"[name1]" "[flags]"
"@[group1]" "[flags]"
/* ... */
}</pre>

Command groups are specified with an 'at' sign ('@') preceding the name. Example:

<pre>
Overrides
{
"sm_map" "k" //Change "sm_map" to the "k" flag.
"@CSDM" "m" //Change all CSDM commands to the "m" flag.
"sm_chat" "" //Allow anyone to use "sm_chat"
}</pre>

Note that given an arbitrary number of flags, the client must require access to '''all''' specified flags in the string, as opposed to just any one of them.

=Group Configuration=
Group overrides are given on an allow or deny basis. That is, rather than changing flags per-group, the override is simply whether it is allowed or denied to members of that group.

For more information, visit [[Adding_Groups_%28SourceMod%29#File_Format|Adding Groups]].

[[Category:SourceMod Documentation]]

{{LanguageSwitch}}

Custom Admin Menu (SourceMod)/ru

2013-08-30T10:20:37Z

Reiko1231:

==Вступление==

Кастом меню (Custom menu) позволяет серверным администраторам добавлять новые пункты в меню администратора. Оно было разработано, чтобы позволить плагинам добавлять свои возможности в меню, без внесения изменений в исходный код, т.к. большинство людей не обладают необходимыми знаниями. Для более подробной информации смотрите [[Admin Menu (SourceMod Scripting)]].

Настраивается кастом меню через конфиг файл (расположен по пути: sourcemod/configs/adminmenu_custom.txt) и именно этот файл определяет, какие пункты или категории будут ''добавлены'' к стандартному меню при запуске сервера.

==Параметры==

Ниже перечислены все парамерты, которые могут быть указаны при настройке вашего меню. Многие из них опциональны и имеют значение по умолчанию, если их не указали. Для более подробной информации смотрите [[#Пример|Пример]] и/или приложение(я) [[#Файлы с примерами|Файлы с примерами]].

*cmd - команда на выполнение (#1,#2 и так далее - лимита на число параметров нет) Используйте @номер чтобы параметр не был взят в "кавычки"
*admin - требуемый уровень администратора для доступа к этой команде - смотрите [[#Уровни администраторов|Уровни администраторов]] для более подробной информации
*execute - 'server' или 'player' - кто является "выполнителем" команды - сервер или тот, кто использует эту команду. По умолчанию 'player'
*1 - Информация о параметре 1 (#1) - их должно быть ровно столько, сколько параметров в cmd
**type - по умолчанию 'list', если не было указан.
***'groupplayer' - Лист [[#Group Подменю|Групп]] + подключенные игроки
***'group' - Лист [[#Group Подменю|Групп]]
***'player' - Лист игроков
***'list' - Настраеваемый список опций
***'mapcycle' - Автоматически заполняемое меню из карт вашего файла цикла карт
***'onoff' - "Вкл" или "Выкл", отсылает 1/0 (удобно для работы с консольными переменными (квары, ConVars, cvars), и им подобным)
**path - Требуется только при type = mapcycle. Путь (включая имя файла и расширение) к файлу, содержащему список карт (с форматом записи как у mapcycle.txt) - по умолчанию значение 'mapcycle.txt'
**method - 'name' (имена игроков), 'steamid' (стим айди), 'userid' (юзерид), 'userid2' (не содержит '#'), 'clientid' (айди клиента), 'ip' (айпи) - требуется только для groupplayer/player типов - по умолчанию name
**title - Заглавие меню, которое будет отображаться для выбора параметров (опционально (не обязательно))
**1-x - Лист параметров - требуется только для типа 'list'
**1.-x. - Текст, который будет показан для параметра - требуется только для типа 'list' (опционально, если не указать, то будет написано то, что указано в соответствующем листе параметров)
**1* - x* - Требуемый уровень доступа администратора, чтобы увидеть эту опцию (тоже самое, что и поле 'admin')

==Пример==
'''Внимание!'''
Если вы хотите использовать русские буквы в меню, то кодировка файла '''должна быть''' UTF-8 (без BOOM), иначе вместо букв вы увидите знаки вопроса!
<pawn>
"Commands"
{
"Fun Commands"
{
"Set Player Speed"
{
"cmd" "sm_speed #1 @2"
"admin" "sm_kick"
"execute" "player"
"1"
{
"type" "groupplayer"
"method" "name"
"title" "Player/Team to Edit"

}
"2"
{
"type" "list"
"title" "Speed Multiplier"
"1" "1.0"
"1." "Normal"
"2" "0.8"
"2." "80%"
"3" "0.5"
"3." "Half"
"4" "1.5"
"4." "50% Boost"
"5" "2.0"
"5." "Double"
"5*" "sm_ban"
//Double увидят лишь те администраторы, которые имеют доступ к команде "sm_ban"
}

}
}
}
</pawn>
Если использовать пример выше для вашего adminmenu_custom.txt, то при запуске сервера в меню администратора будет добавлена новая категория под названием 'Fun Commands'.
*Эта категория будет содержать пункт под названием: "Set Player Speed".
*Выбрав его, вы увидите другое меню, с названием: "Player/Team to Edit", содержащий названия команд и имена игроков.
*Выбрав один из вариантов, будет создано второе меню, с названием "Speed Multiplier".
*С выбором опций: "Normal", "80%", и так далее.
*Если игрок выберет опцию "Double", то команда на выполнение будет выглядеть так: 'sm_speed "@CT" 2.0' (команда отсылается на выполнение через FakeClientCommand)

Заметка: Вы можете использовать \ как управляющий символ. Таким образом, \" позволит вам добавить кавычку в вашу строку.

==Уровни администраторов==

Все 'type' 'admin' теперь требуют строчную команду. Эта команда может уже существовать (например, sm_ban) или быть полностью придуманной (например, onlycrabscanusethis).

Если команда существует, то эта опция (или лист опций) будет требовать уровень доступа, равный уровню доступа к этой команде (включая любые переопределения (оверрайды, overrides), которые вы сделали). 
Например, если вы используете sm_ban как уровень администратора для подменю, то таким образом каждый, кто имеет доступ к sm_ban, будет так же иметь доступ и к этому подменю (по умолчанию доступ к этой команде является флаг бана). Однако если вы переопределили sm_ban для одной из групп ("override" "allow" - в файле admin_groups.cfg), то эта группа так же получит доступ.

Если команда не существует, то вам нужно будет добавить переопределение для этой команды, как это делается для простых команд. Это делается в файле admin_overrides.cfg (чтобы назначить флаг доступа к этой команде,
и/или в файле admin_groups.cfg (чтобы дать доступ к команде определенной группе или же забрать, несмотря на то, что они имеют флаг доступа)

Если уровень доступа не был назначен, то тогда уровнем доступа будет назначен первый аргумент "cmd". Например, для команды
<pawn>
"cmd" "sm_ban #1 #2"
</pawn>

уровнем доступа будет уровень доступа sm_ban, включая все его переопределения.

Для более подробной информации смотрите [[Overriding Command Access (SourceMod)|Overriding Command Access]]

==Group Подменю==

Типы 'group' и 'groupplayer' автоматически добавляют заранее настроенные опции в меню. Эти опции настраиваются в файле sourcemod/configs/adminmenu_grouping.txt

Обычно они используются, чтобы добавить такие команды как '@all', '@t' и другие, для ваших меню.

==Категории==

Если вы хотите добавить пункт в уже существующую SourceMod категорию, вы должны будете определить его внутреннее имя в "commands" группе. Три категории, предоставленные SourceMod'ом:

*PlayerCommands (Управление игроками)
*ServerCommands (Управление сервером)
*VotingCommands (Управление голосованиями)

==Сортировка==
Категории и пункты, добавленные с использованием динамических меню, могут быть отсортированы, как обычные пункты. Для подробной информации смотрите [[Admin Menu Configuration (SourceMod)|Admin Menu Configuration]]

Для того, чтобы можно было сортировать добавленный пункт, вы должны дать вашей команде уникальное имя в вашем конфигурационном файле. Для приведенного примера:
<pawn>
"item" "Set Player Speed"
</pawn>
==Дополнительные возможности==
Пример использования полного потенциала меню: даем администраторам доступ к квару, не давая им флага доступа 'sm_cvars'

Добавьте квар, к которому вы хотите дать доступ, и установите 'execute' 'server'
<pawn>
"cmd" "mp_friendlyfire #1"
"execute" "server"
"admin" "sm_kick"
</pawn>
Таким образом, команда будет выполнена через rcon, несмотря на обычную систему уровней доступа, и проверит доступ только к флагу, указанному в поле 'admin'. Это так же работает для любых других команд, включая sm_rcon.

==Файлы с примерами==

Пример файла adminmenu_custom.txt настроенный для Super Commands: 
[http://alliedmods.net/~pred/supercmdsmenu.ini adminmenu_custom.txt] 
 
Полный пример, спасибо uE|Tekniqal: 
[http://alliedmods.net/~pred/smsuper.ini adminmenu_custom.txt] 
[http://alliedmods.net/~pred/admin_overrides.cfg admin_overrides.cfg] 
[http://alliedmods.net/~pred/admin_groups.cfg admin_groups.cfg] 

[[Category:SourceMod Documentation]]

Custom Admin Menu (SourceMod)/ru

2013-08-30T10:18:43Z

Reiko1231:

==Вступление==

Кастом меню (Custom menu) позволяет серверным администраторам добавлять новые пункты в меню администратора. Оно было разработано, чтобы позволить плагинам добавлять свои возможности в меню, без внесения изменений в исходный код, т.к. большинство людей не обладают необходимыми знаниями. Для более подробной информации смотрите [[Admin Menu (SourceMod Scripting)]].

Настраивается кастом меню через конфиг файл (расположен по пути: sourcemod/configs/adminmenu_custom.txt) и именно этот файл определяет, какие пункты или категории будут ''добавлены'' к стандартному меню при запуске сервера.

==Параметры==

Ниже перечислены все парамерты, которые могут быть указаны при настройке вашего меню. Многие из них опциональныи и имеют значение по умолчанию, если их не указали. Для более подробной информации смотрите [[#Пример|Пример]] и/или приложение(я) [[#Файлы с примерами|Файлы с примерами]].

*cmd - команда на выполнение (#1,#2 и так далее - лимита на число параметров нет) Используйте @номер чтобы параметр не был взят в "кавычки"
*admin - требуемый уровень администратора для доступа к этой команде - смотрите [[#Уровни администраторов|Уровни администраторов]] для более подробной информации
*execute - 'server' или 'player' - кто является "выполнителем" команды - сервер или тот, кто использует эту команду. По умолчанию 'player'
*1 - Информация о параметре 1 (#1) - их должно быть ровно столько, сколько параметров в cmd
**type - по умолчанию 'list', если не было указан.
***'groupplayer' - Лист [[#Group Подменю|Групп]] + подключенные игроки
***'group' - Лист [[#Group Подменю|Групп]]
***'player' - Лист игроков
***'list' - Настраеваемый список опций
***'mapcycle' - Автоматически заполняемое меню из карт вашего файла цикла карт
***'onoff' - "Вкл" или "Выкл", отсылает 1/0 (удобно для работы с консольными переменными (квары, ConVars, cvars), и им подобным)
**path - Требуется только при type = mapcycle. Путь (включая имя файла и расширение) к файлу, содержащему список карт (с форматом записи как у mapcycle.txt) - по умолчанию значение 'mapcycle.txt'
**method - 'name' (имена игроков), 'steamid' (стим айди), 'userid' (юзерид), 'userid2' (не содержит '#'), 'clientid' (айди клиента), 'ip' (айпи) - требуется только для groupplayer/player типов - по умолчанию name
**title - Заглавие меню, которое будет отображаться для выбора параметров (опционально (не обязательно))
**1-x - Лист параметров - требуется только для типа 'list'
**1.-x. - Текст, который будет показан для параметра - требуется только для типа 'list' (опционально, если не указать, то будет написано то, что указано в соответствующем листе параметров)
**1* - x* - Требуемый уровень доступа администратора, чтобы увидеть эту опцию (тоже самое, что и поле 'admin')

==Пример==
'''Внимание!'''
Если вы хотите использовать русские буквы в меню, то кодировка файла '''должна быть''' UTF-8 (без BOOM), иначе вместо букв вы увидите знаки вопроса!
<pawn>
"Commands"
{
"Fun Commands"
{
"Set Player Speed"
{
"cmd" "sm_speed #1 @2"
"admin" "sm_kick"
"execute" "player"
"1"
{
"type" "groupplayer"
"method" "name"
"title" "Player/Team to Edit"

}
"2"
{
"type" "list"
"title" "Speed Multiplier"
"1" "1.0"
"1." "Normal"
"2" "0.8"
"2." "80%"
"3" "0.5"
"3." "Half"
"4" "1.5"
"4." "50% Boost"
"5" "2.0"
"5." "Double"
"5*" "sm_ban"
//Double увидят лишь те администраторы, которые имеют доступ к команде "sm_ban"
}

}
}
}
</pawn>
Если использовать пример выше для вашего adminmenu_custom.txt, то при запуске сервера в меню администратора будет добавлена новая категория под названием 'Fun Commands'.
*Эта категория будет содержать пункт под названием: "Set Player Speed".
*Выбрав его, вы увидите другое меню, с названием: "Player/Team to Edit", содержащий названия команд и имена игроков.
*Выбрав один из вариантов, будет создано второе меню, с названием "Speed Multiplier".
*С выбором опций: "Normal", "80%", и так далее.
*Если игрок выберет опцию "Double", то команда на выполнение будет выглядеть так: 'sm_speed "@CT" 2.0' (команда отсылается на выполнение через FakeClientCommand)

Заметка: Вы можете использовать \ как управляющий символ. Таким образом, \" позволит вам добавить кавычку в вашу строку.

==Уровни администраторов==

Все 'type' 'admin' теперь требуют строчную команду. Эта команда может уже существовать (например, sm_ban) или быть полностью придуманной (например, onlycrabscanusethis).

Если команда существует, то эта опция (или лист опций) будет требовать уровень доступа, равный уровню доступа к этой команде (включая любые переопределения (оверрайды, overrides), которые вы сделали). 
Например, если вы используете sm_ban как уровень администратора для подменю, то таким образом каждый, кто имеет доступ к sm_ban, будет так же иметь доступ и к этому подменю (по умолчанию доступ к этой команде является флаг бана). Однако если вы переопределили sm_ban для одной из групп ("override" "allow" - в файле admin_groups.cfg), то эта группа так же получит доступ.

Если команда не существует, то вам нужно будет добавить переопределение для этой команды, как это делается для простых команд. Это делается в файле admin_overrides.cfg (чтобы назначить флаг доступа к этой команде,
и/или в файле admin_groups.cfg (чтобы дать доступ к команде определенной группе или же забрать, несмотря на то, что они имеют флаг доступа)

Если уровень доступа не был назначен, то тогда уровнем доступа будет назначен первый аргумент "cmd". Например, для команды
<pawn>
"cmd" "sm_ban #1 #2"
</pawn>

уровнем доступа будет уровень доступа sm_ban, включая все его переопределения.

Для более подробной информации смотрите [[Overriding Command Access (SourceMod)|Overriding Command Access]]

==Group Подменю==

Типы 'group' и 'groupplayer' автоматически добавляют заранее настроенные опции в меню. Эти опции настраиваются в файле sourcemod/configs/adminmenu_grouping.txt

Обычно они используются, чтобы добавить такие команды как '@all', '@t' и другие, для ваших меню.

==Категории==

Если вы хотите добавить пункт в уже существующую SourceMod категорию, вы должны будете определить его внутреннее имя в "commands" группе. Три категории, предоставленные SourceMod'ом:

*PlayerCommands (Управление игроками)
*ServerCommands (Управление сервером)
*VotingCommands (Управление голосованиями)

==Сортировка==
Категории и пункты, добавленные с использованием динамических меню, могут быть отсортированы, как обычные пункты. Для подробной информации смотрите [[Admin Menu Configuration (SourceMod)|Admin Menu Configuration]]

Для того, чтобы можно было сортировать добавленный пункт, вы должны дать вашей команде уникальное имя в вашем конфигурационном файле. Для приведенного примера:
<pawn>
"item" "Set Player Speed"
</pawn>
==Дополнительные возможности==
Пример использования полного потенциала меню: даем администраторам доступ к квару, не давая им флага доступа 'sm_cvars'

Добавьте квар, к которому вы хотите дать доступ, и установите 'execute' 'server'
<pawn>
"cmd" "mp_friendlyfire #1"
"execute" "server"
"admin" "sm_kick"
</pawn>
Таким образом, команда будет выполнена через rcon, несмотря на обычную систему уровней доступа, и проверит доступ только к флагу, указанному в поле 'admin'. Это так же работает для любых других команд, включая sm_rcon.

==Файлы с примерами==

Пример файла adminmenu_custom.txt настроенный для Super Commands: 
[http://alliedmods.net/~pred/supercmdsmenu.ini adminmenu_custom.txt] 
 
Полный пример, спасибо uE|Tekniqal: 
[http://alliedmods.net/~pred/smsuper.ini adminmenu_custom.txt] 
[http://alliedmods.net/~pred/admin_overrides.cfg admin_overrides.cfg] 
[http://alliedmods.net/~pred/admin_groups.cfg admin_groups.cfg] 

[[Category:SourceMod Documentation]]

Custom Admin Menu (SourceMod)/ru

2013-08-30T10:16:47Z

Reiko1231: Created page with "==Вступление== Кастом меню (Custom menu) позволяет серверным администраторам добавлять новые пункты ..."

==Вступление==

Кастом меню (Custom menu) позволяет серверным администраторам добавлять новые пункты в меню администратора. Оно было разработано, чтобы позволить плагинам добавлять свои возможности в меню, без внесения изменений в исходный код, т.к. большинство людей не обладают необходимыми знаниями. Для более подробной информации смотрите [[Admin Menu (SourceMod Scripting)]].

Настраивается кастом меню через конфиг файл (расположен по пути: sourcemod/configs/adminmenu_custom.txt) и именно этот файл определяет, какие пункты или категории будут ''добавлены'' к стандартному меню при запуске сервера.

==Лист параметров==

Ниже перечислены все парамерты, которые могут быть указаны при настройке вашего меню. Многие из них опциональныи и имеют значение по умолчанию, если их не указали. Для более подробной информации смотрите [[#Пример|Пример]] и/или приложение(я) [[#Файлы с примерами|Файлы с примерами]].

*cmd - команда на выполнение (#1,#2 и так далее - лимита на число параметров нет) Используйте @номер чтобы параметр не был взят в "кавычки"
*admin - требуемый уровень администратора для доступа к этой команде - смотрите [[#Уровни администраторов|Уровни администраторов]] для более подробной информации
*execute - 'server' или 'player' - кто является "выполнителем" команды - сервер или тот, кто использует эту команду. По умолчанию 'player'
*1 - Информация о параметре 1 (#1) - их должно быть ровно столько, сколько параметров в cmd
**type - по умолчанию 'list', если не было указан.
***'groupplayer' - Лист [[#Group Подменю|Групп]] + подключенные игроки
***'group' - Лист [[#Group Подменю|Групп]]
***'player' - Лист игроков
***'list' - Настраеваемый список опций
***'mapcycle' - Автоматически заполняемое меню из карт вашего файла цикла карт
***'onoff' - "Вкл" или "Выкл", отсылает 1/0 (удобно для работы с консольными переменными (квары, ConVars, cvars), и им подобным)
**path - Требуется только при type = mapcycle. Путь (включая имя файла и расширение) к файлу, содержащему список карт (с форматом записи как у mapcycle.txt) - по умолчанию значение 'mapcycle.txt'
**method - 'name' (имена игроков), 'steamid' (стим айди), 'userid' (юзерид), 'userid2' (не содержит '#'), 'clientid' (айди клиента), 'ip' (айпи) - требуется только для groupplayer/player типов - по умолчанию name
**title - Заглавие меню, которое будет отображаться для выбора параметров (опционально (не обязательно))
**1-x - Лист параметров - требуется только для типа 'list'
**1.-x. - Текст, который будет показан для параметра - требуется только для типа 'list' (опционально, если не указать, то будет написано то, что указано в соответствующем листе параметров)
**1* - x* - Требуемый уровень доступа администратора, чтобы увидеть эту опцию (тоже самое, что и поле 'admin')

==Пример==
'''Внимание!'''
Если вы хотите использовать русские буквы в меню, то кодировка файла '''должна быть''' UTF-8 (без BOOM), иначе вместо букв вы увидите знаки вопроса!
<pawn>
"Commands"
{
"Fun Commands"
{
"Set Player Speed"
{
"cmd" "sm_speed #1 @2"
"admin" "sm_kick"
"execute" "player"
"1"
{
"type" "groupplayer"
"method" "name"
"title" "Player/Team to Edit"

}
"2"
{
"type" "list"
"title" "Speed Multiplier"
"1" "1.0"
"1." "Normal"
"2" "0.8"
"2." "80%"
"3" "0.5"
"3." "Half"
"4" "1.5"
"4." "50% Boost"
"5" "2.0"
"5." "Double"
"5*" "sm_ban"
//Double увидят лишь те администраторы, которые имеют доступ к команде "sm_ban"
}

}
}
}
</pawn>
Если использовать пример выше для вашего adminmenu_custom.txt, то при запуске сервера в меню администратора будет добавлена новая категория под названием 'Fun Commands'.
*Эта категория будет содержать пункт под названием: "Set Player Speed".
*Выбрав его, вы увидите другое меню, с названием: "Player/Team to Edit", содержащий названия команд и имена игроков.
*Выбрав один из вариантов, будет создано второе меню, с названием "Speed Multiplier".
*С выбором опций: "Normal", "80%", и так далее.
*Если игрок выберет опцию "Double", то команда на выполнение будет выглядеть так: 'sm_speed "@CT" 2.0' (команда отсылается на выполнение через FakeClientCommand)

Заметка: Вы можете использовать \ как управляющий символ. Таким образом, \" позволит вам добавить кавычку в вашу строку.

==Уровни администраторов==

Все 'type' 'admin' теперь требуют строчную команду. Эта команда может уже существовать (например, sm_ban) или быть полностью придуманной (например, onlycrabscanusethis).

Если команда существует, то эта опция (или лист опций) будет требовать уровень доступа, равный уровню доступа к этой команде (включая любые переопределения (оверрайды, overrides), которые вы сделали). 
Например, если вы используете sm_ban как уровень администратора для подменю, то таким образом каждый, кто имеет доступ к sm_ban, будет так же иметь доступ и к этому подменю (по умолчанию доступ к этой команде является флаг бана). Однако если вы переопределили sm_ban для одной из групп ("override" "allow" - в файле admin_groups.cfg), то эта группа так же получит доступ.

Если команда не существует, то вам нужно будет добавить переопределение для этой команды, как это делается для простых команд. Это делается в файле admin_overrides.cfg (чтобы назначить флаг доступа к этой команде,
и/или в файле admin_groups.cfg (чтобы дать доступ к команде определенной группе или же забрать, несмотря на то, что они имеют флаг доступа)

Если уровень доступа не был назначен, то тогда уровнем доступа будет назначен первый аргумент "cmd". Например, для команды
<pawn>
"cmd" "sm_ban #1 #2"
</pawn>

уровнем доступа будет уровень доступа sm_ban, включая все его переопределения.

Для более подробной информации смотрите [[Overriding Command Access (SourceMod)|Overriding Command Access]]

==Group Подменю==

Типы 'group' и 'groupplayer' автоматически добавляют заранее настроенные опции в меню. Эти опции настраиваются в файле sourcemod/configs/adminmenu_grouping.txt

Обычно они используются, чтобы добавить такие команды как '@all', '@t' и другие, для ваших меню.

==Категории==

Если вы хотите добавить пункт в уже существующую SourceMod категорию, вы должны будете определить его внутреннее имя в "commands" группе. Три категории, предоставленные SourceMod'ом:

*PlayerCommands (Управление игроками)
*ServerCommands (Управление сервером)
*VotingCommands (Управление голосованиями)

==Сортировка==
Категории и пункты, добавленные с использованием динамических меню, могут быть отсортированы, как обычные пункты. Для подробной информации смотрите [[Admin Menu Configuration (SourceMod)|Admin Menu Configuration]]

Для того, чтобы можно было сортировать добавленный пункт, вы должны дать вашей команде уникальное имя в вашем конфигурационном файле. Для приведенного примера:
<pawn>
"item" "Set Player Speed"
</pawn>
==Дополнительные возможности==
Пример использования полного потенциала меню: даем администраторам доступ к квару, не давая им флага доступа 'sm_cvars'

Добавьте квар, к которому вы хотите дать доступ, и установите 'execute' 'server'
<pawn>
"cmd" "mp_friendlyfire #1"
"execute" "server"
"admin" "sm_kick"
</pawn>
Таким образом, команда будет выполнена через rcon, несмотря на обычную систему уровней доступа, и проверит доступ только к флагу, указанному в поле 'admin'. Это так же работает для любых других команд, включая sm_rcon.

==Файлы с примерами==

Пример файла adminmenu_custom.txt настроенный для Super Commands: 
[http://alliedmods.net/~pred/supercmdsmenu.ini adminmenu_custom.txt] 
 
Полный пример, спасибо uE|Tekniqal: 
[http://alliedmods.net/~pred/smsuper.ini adminmenu_custom.txt] 
[http://alliedmods.net/~pred/admin_overrides.cfg admin_overrides.cfg] 
[http://alliedmods.net/~pred/admin_groups.cfg admin_groups.cfg] 

[[Category:SourceMod Documentation]]
{{LanguageSwitch}}

Custom Admin Menu (SourceMod)

2013-08-30T10:10:22Z

Reiko1231:

==Introduction==
The custom menu feature allows server admins to add new items to the SourceMod admin menu. It is designed to be used as a complement to plugins adding themselves to the menu. For more information see [[Admin Menu (SourceMod Scripting)]].

Admins configure their menu using the config file (sourcemod/configs/adminmenu_custom.txt) and this is generated into a set of items and categories for the admin menu when the server starts.

==Parameter List==

These are all the parameters that can be specified to configure your menu. Most are optional and have a default value if they are not found. See the [[#Example Command|Example Command]] and/or the attached [[#Example Files|Example Files]] for information on how to lay out your config file.

*cmd - command to be executed (#1,#2 etc for parameters - no limit on these) Use @num to have the parameter sent without being surrounded by "quotes"
*admin - admin level required to access the command - see [[#Admin Levels|Admin Levels]]
*execute - 'server' or 'player' - selects whether to execute as a client command or server command - defaults to 'player'
*1 - Information about parameter 1 (#1) - You need as many of these as you have parameters
**type - defaults to 'list' if not provided
***'groupplayer' - List of [[#Group Submenus|Groups]] + connected player
***'group' - List of [[#Group Submenus|Groups]]
***'player' - List of players
***'list' - Custom Defined list of Options
***'mapcycle' - Auto filled with the contents of your mapcycle file
***'onoff' - On or Off menu that sends the numbers 1/0 (good for cvars etc)
**path - Only required for type mapcycle. Path (including file name and extension) to the file containing a list of maps (straight text formatting like mapcycle.txt) - defaults to 'mapcycle.txt'
**method - 'name', 'steamid', 'userid', 'userid2' (doesn't prepend the '#'), 'clientid', 'ip' - only needed for groupplayer/player menus - defaults to name
**title - To be shown for the parameter selection menu (optional)
**1-x - List parameters - only needed for 'list' type parameters
**1.-x. - Text to be shown for parameter - only needed for 'list' type parameters (optional, above will be used as text if ommited)
**1* - x* - Admin level required to see this option (same as the rest of the admin types)

==Example Command==
<pawn>
"Commands"
{
"Fun Commands"
{
"Set Player Speed"
{
"cmd" "sm_speed #1 @2"
"admin" "sm_kick"
"execute" "player"
"1"
{
"type" "groupplayer"
"method" "name"
"title" "Player/Team to Edit"

}
"2"
{
"type" "list"
"title" "Speed Multiplier"
"1" "1.0"
"1." "Normal"
"2" "0.8"
"2." "80%"
"3" "0.5"
"3." "Half"
"4" "1.5"
"4." "50% Boost"
"5" "2.0"
"5." "Double"
"5*" "sm_ban"
//restrict the double option to admins who have access to the 'sm_ban' override
}

}
}
}
</pawn>
Using the above as the contents of your adminmenu_custom.txt config file would create a new category option in the admin menu called 'Fun Commands'.
*This category would contain an option called : "Set Player Speed".
*Selecting it would prompt another menu titled: "Player/Team to Edit" containing a list of Groups and Player Names.
*Selecting one of these would prompt a second menu titled "Speed Multiplier".
*List of options like "Normal", "80%" etc.
*Example command sent if the user selected "Double" (through the player using FakeClientCommand) - 'sm_speed "@CT" 2.0'

NB: You can use \ as an escape character. So \" will let you add quotes to your strings.

==Admin Levels==

All 'admin' types now require a string command name. This command can be already existing (sm_ban) or completely imaginary (onlycrabscanusethis).

If the command exists that section (or list option) will require the exact same access level as that command (including any overrides you have specified). 
E.g. You use sm_ban as the admin level for a submenu, so anyone that can access sm_ban will also be able to access this menu option (By default this is admins with the 'ban' flag). However if you have overridden sm_ban in one of your lower groups ("override" "allow" - in admin_groups.cfg). This group will also have access.

If the command doesn't exist you will need to add it to your overrides sections as if it was a normal command. This can be done in admin_overrides.cfg (to assign flag letters to this command),
and/or in admin_groups.cfg (to give access to the command to a specified group or remove it from a group even though they have the flag)

If no admin level is specified for a base command it will default to the first argument of the "cmd" string. For example having
<pawn>
"cmd" "sm_ban #1 #2"
</pawn>

would have a default admin override string of 'sm_ban'

For more information, see [[Overriding Command Access (SourceMod)|Overriding Command Access]]

==Group Submenus==

Types 'group' and 'groupplayer' auto-add pre configured options to the menu. These options are configured using sourcemod/configs/adminmenu_grouping.txt

They are generally used to provide common commands like '@all' , '@t' etc to your menus.

==Categories==

If you wish to add items to an existing SourceMod category you will need to specify it’s internal name within the "commands" group. The three categories provided by SourceMod are:

*PlayerCommands
*ServerCommands
*VotingCommands

==Sorting==
Categories and items added using the dynamic menu can be sorted in the same way as normal items. For more information, see [[Admin Menu Configuration (SourceMod)|Admin Menu Configuration]]

You need to specify the name you gave the command in your configuration file. For the provided example:
<pawn>
"item" "Set Player Speed"
</pawn>
==Extra Uses==
An example of using the dynamic menu to its full potential: Giving admins access to some cvars while not letting them have general 'sm_cvar' access.

Add the cvar you want to make available using the command directly and set the 'execute' parameter to 'server'
<pawn>
"cmd" "mp_friendlyfire #1"
"execute" "server"
"admin" "sm_kick"
</pawn>
This fires the command directly through rcon so it bypasses the normal SourceMod admin requirements and only checks what you set using the 'admin' parameter. This method can be used to create a list of commonly used (and low impact) cvars that your lower admins can change at will, without giving them access to everything. The same method works for rcon commands.

==Example Files==

Example adminmenu_custom.txt setup with Super Commands examples: 
[http://alliedmods.net/~pred/supercmdsmenu.ini adminmenu_custom.txt] 
 
A Full example setup thanks to uE|Tekniqal: 
[http://alliedmods.net/~pred/smsuper.ini adminmenu_custom.txt] 
[http://alliedmods.net/~pred/admin_overrides.cfg admin_overrides.cfg] 
[http://alliedmods.net/~pred/admin_groups.cfg admin_groups.cfg] 

[[Category:SourceMod Documentation]]

{{LanguageSwitch}}