AlliedModders Wiki - User contributions [en]

ConVars (SourceMod Scripting)/ru

2019-06-22T16:06:39Z

Kailo:

{{Languages|ConVars_(SourceMod_Scripting)}}
Квары - ''это консольные переменные.'' Они могут иметь числовое или строчное значение. Их значения могут быть изменены через консоль или с помощью .cfg файлов, а иногда сохраняются для всех сеансов сервера.

=Введение=
Квары доступны через Handle`s. Есть 2 способа получить Handle квара. Создать новый квар или найти существующий. Если вы создадите уже существующий квар, автоматически будет использоваться старый.

''Примечание: Handle`s для кваров являются уникальными, их не нужно закрывать или присваивать INVALID_HANDLE. Они должны существовать пока SourceMod запущен.''

==Поиск кваров==
Искать квары очень просто. Например, вы хотите найти <tt>mp_startmoney</tt> из Counter-Strike:Source:

<pawn>new g_hStartMoney

public OnPluginStart()
{
g_hStartMoney = FindConVar("mp_startmoney")
}</pawn>

''Примечание: FindConVar() вернет ''<tt>INVALID_HANDLE</tt>'' если квар не найден. Keep this in mind if you are trying to read ConVars from other plugins.''

==Создание кваров==
Простейший квар требует всего 2 значения: имя и значение по умолчанию. Тем не менее, он может содержать описание:

<pawn>new Handle:g_hEnabled

public OnPluginStart()
{
g_hEnabled = CreateConVar("myplugin_enabled", "1", "Включение/Выключение плагина.")
}</pawn>

Вы так же имеете возможностю ограничить значение. Например, давайте создадим квар названием <tt>myplugin_ratio</tt>, который не может быть выше 1,0 и ниже 0,1.
<pawn>new Handle:g_hEnabled

public OnPluginStart()
{
g_hEnabled = CreateConVar("myplugin_ratio",
"0.6",
"Sets a vote ratio",
_, /* Флаги (будут обсуждаться позже) */
true, /* Включить минимальное значение */
0.1,
true, /* Включить максимальное значение */
1.0)
}</pawn>

Значение по умолчанию может иметь любой тип данных, и оно не ограничивает будущие типы данных, которые можно использовать. Тем не менее, минимальные и максимальные ограничения всегда должны быть числом с плавающей точкой (float).

Если вы создаете квар, который уже существует, вы получите Handle на этот квар. Кроме того, сами Handle будут идентичны, поскольку плагин будет владеть Handle. Описание, значение по умолчанию, или ограничения не будут изменены.

=Использование/Изменение значений=
Использовать квары очень просто. Например, мы хотим изменить <tt>mp_startmoney</tt>, но сохранить старое значение и восстановить его позже. Повторно используем наш код <tt>mp_startmoney</tt> от раздела <tt>Получение кваров</tt>:

<pawn>new g_oldmoney

SetStartMoney(newmoney)
{
g_oldmoney = GetConVarInt(g_hStartMoney)
SetConVarInt(g_hStartMoney, newmoney)
}

RestoreStartMoney()
{
SetConVarInt(g_hStartMoney, g_oldmoney)
}</pawn>

Хотя существуют различные функции для типов значений (с плавающей точкой, строки, и так далее), внутренние данные всегда сохраняются так же. Например, этот код будет работать:

<pawn>public GetStartMoney()
{
decl String:buffer[128]

GetConVarString(g_hStartMoney, buffer, sizeof(buffer))

return StringToInt(buffer)
}</pawn>

Несмотря на то, что <tt>mp_startmoney</tt> целое число, он может использоваться как строка.

=Флаги=
Квары могут иметь ряд флагов, в зависимости от которых могут менять свое поведение. Основные флаги:
*<tt>FCVAR_PROTECTED</tt> - Секретная информация (не должны подвергаться воздействию клиентов или логов).
*<tt>FCVAR_NOTIFY</tt> - Уведомление клиентов об изменении.
*<tt>FCVAR_CHEAT</tt> - Могут использоваться только в случае если <tt>sv_cheats</tt> равно 1.
*<tt>FCVAR_REPLICATED</tt> - Принудительная установка значения квара на клиенте.

Например, мы хотим изменить значение квара с флагом FCVAR_CHEAT. The following two functions could be used:
<pawn>UnsetCheatVar(Handle:hndl)
{
new flags = GetConVarFlags(hndl)
flags &= ~FCVAR_CHEAT
SetConVarFlags(hndl, flags)
}

SetCheatVar(Handle:hndl)
{
new flags = GetConVarFlags(hndl)
flags |= FCVAR_CHEAT
SetConVarFlags(hndl, flags)
}</pawn>

=Change Callbacks=
As of Half-Life 2, it is possible to know when ConVars change. While this is a very powerful feature, you must be careful not to set a ConVar inside a ConVar change hook such that it re-invokes he same callback. This results in ''infinite recursion''.

For example, let's say you want to detect when <tt>bot_quota</tt> changes and to prevent it from going below 2:

<pawn>new Handle:g_hBotQuota

public OnPluginStart()
{
g_hBotQuota = FindConVar("bot_quota")
if (g_hBotQuota != INVALID_HANDLE)
{
HookConVarChange(g_hBotQuota, OnBotQuotaChange)
}
}

public OnBotQuotaChange(Handle:cvar, const String:oldVal[], const String:newVal[])
{
if (StringToInt(newVal) < 2)
{
SetConVarInt(cvar, 2)
}
}</pawn>

'''Note 1:''' You do not need to explicitly unhook ConVarChange functions on shutdown. These hooks are removed when your plugin unloads.

'''Note 2:''' You cannot prevent cvar changes from happening; you can only change the value again. If the engine or game mod already have a change function installed for a ConVar, that function will always be called first.

[[Category:Ru:SourceMod Scripting]]

Admin Menu Configuration (SourceMod)/ru

2015-09-06T07:56:49Z

Kailo:

{{Languages|Admin Menu Configuration (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)

2015-09-06T07:56:15Z

Kailo:

{{Languages|Admin Menu Configuration (SourceMod)}}

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]]

Admin Menu Configuration (SourceMod)/ru

2015-09-06T07:55:34Z

Kailo: Kailo moved page Ru:Admin Menu Configuration (SourceMod) to Admin Menu Configuration (SourceMod)/ru

В меню администратора 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]]

Ru:Admin Menu Configuration (SourceMod)

2015-09-06T07:55:34Z

Kailo: Kailo moved page Ru:Admin Menu Configuration (SourceMod) to Admin Menu Configuration (SourceMod)/ru

#REDIRECT [[Admin Menu Configuration (SourceMod)/ru]]

Counter-Strike: Global Offensive Weapons

2015-07-12T18:04:00Z

Kailo: /* Pistols */

[[Weapon_Names(Source)]] > [[Counter-Strike: Global Offensive Weapons]]

==Counter-Strike: Global Offensive Weapons :==

Here you can see the weapon's name returned in event's return values
(just add "weapon_" before if weapon's name comes from functions and not from events)

===Pistols===
* glock
* p250
* fiveseven
* deagle
* elite
* hkp2000 ''CT-only''
* tec9 ''T-only''

===Heavy===
* nova
* xm1014
* mag7 ''CT-only''
* sawedoff ''T-only''
* m249
* negev

===SMGs===
* mp9 ''CT-only''
* mac10 ''T-only''
* mp7
* ump45
* p90
* bizon

===Rifles===
* famas ''CT-only''
* m4a1 ''CT-only''
* galilar ''T-only''
* ak47 ''T-only''
* ssg08
* aug ''CT-only''
* sg556 ''T-only''
* awp
* scar20 ''CT-only''
* g3sg1 ''T-only''

===Gear===
* taser
* knife

===Grenades===
* hegrenade
* flashbang
* smokegrenade
* molotov
* decoy

Back to : [[Weapon_Names(Source)]]

ConVars (SourceMod Scripting)

2015-03-08T18:53:46Z

Kailo: /* Using/Changing Values */

{{Languages|ConVars_(SourceMod_Scripting)}}
This page for the new [[SourcePawn Transitional Syntax]]. For the old syntax see [https://wiki.alliedmods.net/index.php?title=ConVars_(SourceMod_Scripting)&oldid=6865 old version of page].

'''ConVars''' are ''con''sole ''var''iables. They store string which can view as boolean, float, or numerical values. These values can be changed via the console or .cfg files, and sometimes even persist across server sessions.

= Introduction =
ConVars are accessed through own class named as [https://sm.alliedmods.net/new-api/convars/ConVar ConVar]. There are two ways to obtain a ConVar. You can either create a new ConVar, or find an existing one. If you create a ConVar that already exists, it will automatically re-use the old one.

== Finding ConVars ==
Finding ConVars is very simple. For example, let's say you want to use <tt>mp_startmoney</tt> from Counter-Strike:Source:

<pawn>ConVar g_cvStartMoney

public void OnPluginStart()
{
g_cvStartMoney = FindConVar("mp_startmoney")
}</pawn>

''Note: FindConVar() will return ''<tt>null</tt>'' if the ConVar is not found. Keep this in mind if you are trying to read ConVars from other plugins.''

== Creating ConVars ==
A simple ConVar only requires two parameters, a name and a default value. However, it's a good idea to include a description:

<pawn>ConVar g_cvEnabled

public void OnPluginStart()
{
g_cvEnabled = CreateConVar("myplugin_enabled", "1", "Sets whether my plugin is enabled")
}</pawn>

You can also specify value constraints. For example, let's create a cvar called <tt>myplugin_ratio</tt> which cannot go above 1.0 or below 0.1.
<pawn>ConVar g_cvRatio

public void OnPluginStart()
{
g_cvRatio = CreateConVar("myplugin_ratio",
"0.6",
"Sets a vote ratio",
_, /* Flags will be discussed later */
true, /* Has a minimum */
0.1,
true, /* Has a maximum */
1.0)
}</pawn>

The default value can be any type of data, and it does not restrict future data types that can be used. However, the minimum and maximum constraints always interpret the value as a float.

= Using/Changing Values =
Managing ConVars is very simple. For example, let's say we want to change <tt>mp_startmoney</tt>, but save the old value and restore it later. Re-using our <tt>mp_startmoney</tt> code from <tt>[[ConVars_(SourceMod_Scripting)#Finding _ConVars|FindConVar]]</tt>:

<pawn>int g_oldmoney

SetStartMoney(int newmoney)
{
g_oldmoney = g_hStartMoney.IntValue
g_cvStartMoney.IntValue = newmoney
}

RestoreStartMoney()
{
g_cvStartMoney.IntValue = g_oldmoney
}</pawn>

Although there are different functions for value types (float, string, et cetera), the internal data is always stored the same way. For example, this code will work:

<pawn>public int GetStartMoney()
{
char buffer[128]

g_cvStartMoney.GetString(buffer, 128)

return StringToInt(buffer)
}</pawn>

Even though <tt>mp_startmoney</tt> is an integer, it can still be retrieved as a string.

= Flags =
ConVars can have a number of flags to change their behaviour. A few of the important flags are:
*<tt>FCVAR_PROTECTED</tt> - Sensitive information (should not be exposed to clients or logs).
*<tt>FCVAR_NOTIFY</tt> - Clients are notified of changes.
*<tt>FCVAR_CHEAT</tt> - Can only be use if <tt>sv_cheats</tt> is 1.
*<tt>FCVAR_REPLICATED</tt> - Setting is forced to clients.

Let's say we wanted to toggle whether a cvar had FCVAR_CHEAT. The following two functions could be used:
<pawn>void UnsetCheatVar(ConVar convar)
{
int flags = convar.Flags
flags &= ~FCVAR_CHEAT
convar.Flags = flags
}

void SetCheatVar(ConVar convar)
{
int flags = convar.Flags
flags |= FCVAR_CHEAT
convar.Flags = flags
}</pawn>

= Change Callbacks =
As of Half-Life 2, it is possible to know when ConVars change. While this is a very powerful feature, you must be careful not to set a ConVar inside a ConVar change hook such that it re-invokes he same callback. This results in ''infinite recursion''.

For example, let's say you want to detect when <tt>bot_quota</tt> changes and to prevent it from going below 2:

<pawn>ConVar g_hBotQuota

public void OnPluginStart()
{
g_hBotQuota = FindConVar("bot_quota")
if (g_hBotQuota != null)
{
g_hBotQuota.AddChangeHook(OnBotQuotaChange)
}
}

public void OnBotQuotaChange(ConVar convar, char[] oldValue, char[] newValue)
{
if (StringToInt(newValue) < 2)
{
convar.IntValue = 2
}
}</pawn>

'''Note 1:''' You do not need to explicitly unhook ConVarChange functions on shutdown. These hooks are removed when your plugin unloads.

'''Note 2:''' You cannot prevent cvar changes from happening; you can only change the value again. If the engine or game mod already have a change function installed for a ConVar, that function will always be called first.

[[Category:SourceMod Scripting]]

ConVars (SourceMod Scripting)

2015-03-08T18:52:27Z

Kailo: /* Creating ConVars */

{{Languages|ConVars_(SourceMod_Scripting)}}
This page for the new [[SourcePawn Transitional Syntax]]. For the old syntax see [https://wiki.alliedmods.net/index.php?title=ConVars_(SourceMod_Scripting)&oldid=6865 old version of page].

'''ConVars''' are ''con''sole ''var''iables. They store string which can view as boolean, float, or numerical values. These values can be changed via the console or .cfg files, and sometimes even persist across server sessions.

= Introduction =
ConVars are accessed through own class named as [https://sm.alliedmods.net/new-api/convars/ConVar ConVar]. There are two ways to obtain a ConVar. You can either create a new ConVar, or find an existing one. If you create a ConVar that already exists, it will automatically re-use the old one.

== Finding ConVars ==
Finding ConVars is very simple. For example, let's say you want to use <tt>mp_startmoney</tt> from Counter-Strike:Source:

<pawn>ConVar g_cvStartMoney

public void OnPluginStart()
{
g_cvStartMoney = FindConVar("mp_startmoney")
}</pawn>

''Note: FindConVar() will return ''<tt>null</tt>'' if the ConVar is not found. Keep this in mind if you are trying to read ConVars from other plugins.''

== Creating ConVars ==
A simple ConVar only requires two parameters, a name and a default value. However, it's a good idea to include a description:

<pawn>ConVar g_cvEnabled

public void OnPluginStart()
{
g_cvEnabled = CreateConVar("myplugin_enabled", "1", "Sets whether my plugin is enabled")
}</pawn>

You can also specify value constraints. For example, let's create a cvar called <tt>myplugin_ratio</tt> which cannot go above 1.0 or below 0.1.
<pawn>ConVar g_cvRatio

public void OnPluginStart()
{
g_cvRatio = CreateConVar("myplugin_ratio",
"0.6",
"Sets a vote ratio",
_, /* Flags will be discussed later */
true, /* Has a minimum */
0.1,
true, /* Has a maximum */
1.0)
}</pawn>

The default value can be any type of data, and it does not restrict future data types that can be used. However, the minimum and maximum constraints always interpret the value as a float.

= Using/Changing Values =
Managing ConVars is very simple. For example, let's say we want to change <tt>mp_startmoney</tt>, but save the old value and restore it later. Re-using our <tt>mp_startmoney</tt> code from <tt>FindConVar</tt>:

<pawn>int g_oldmoney

SetStartMoney(int newmoney)
{
g_oldmoney = g_hStartMoney.IntValue
g_cvStartMoney.IntValue = newmoney
}

RestoreStartMoney()
{
g_cvStartMoney.IntValue = g_oldmoney
}</pawn>

Although there are different functions for value types (float, string, et cetera), the internal data is always stored the same way. For example, this code will work:

<pawn>public int GetStartMoney()
{
char buffer[128]

g_cvStartMoney.GetString(buffer, 128)

return StringToInt(buffer)
}</pawn>

Even though <tt>mp_startmoney</tt> is an integer, it can still be retrieved as a string.

= Flags =
ConVars can have a number of flags to change their behaviour. A few of the important flags are:
*<tt>FCVAR_PROTECTED</tt> - Sensitive information (should not be exposed to clients or logs).
*<tt>FCVAR_NOTIFY</tt> - Clients are notified of changes.
*<tt>FCVAR_CHEAT</tt> - Can only be use if <tt>sv_cheats</tt> is 1.
*<tt>FCVAR_REPLICATED</tt> - Setting is forced to clients.

Let's say we wanted to toggle whether a cvar had FCVAR_CHEAT. The following two functions could be used:
<pawn>void UnsetCheatVar(ConVar convar)
{
int flags = convar.Flags
flags &= ~FCVAR_CHEAT
convar.Flags = flags
}

void SetCheatVar(ConVar convar)
{
int flags = convar.Flags
flags |= FCVAR_CHEAT
convar.Flags = flags
}</pawn>

= Change Callbacks =
As of Half-Life 2, it is possible to know when ConVars change. While this is a very powerful feature, you must be careful not to set a ConVar inside a ConVar change hook such that it re-invokes he same callback. This results in ''infinite recursion''.

For example, let's say you want to detect when <tt>bot_quota</tt> changes and to prevent it from going below 2:

<pawn>ConVar g_hBotQuota

public void OnPluginStart()
{
g_hBotQuota = FindConVar("bot_quota")
if (g_hBotQuota != null)
{
g_hBotQuota.AddChangeHook(OnBotQuotaChange)
}
}

public void OnBotQuotaChange(ConVar convar, char[] oldValue, char[] newValue)
{
if (StringToInt(newValue) < 2)
{
convar.IntValue = 2
}
}</pawn>

'''Note 1:''' You do not need to explicitly unhook ConVarChange functions on shutdown. These hooks are removed when your plugin unloads.

'''Note 2:''' You cannot prevent cvar changes from happening; you can only change the value again. If the engine or game mod already have a change function installed for a ConVar, that function will always be called first.

[[Category:SourceMod Scripting]]

ConVars (SourceMod Scripting)

2015-03-08T18:49:03Z

Kailo:

{{Languages|ConVars_(SourceMod_Scripting)}}
This page for the new [[SourcePawn Transitional Syntax]]. For the old syntax see [https://wiki.alliedmods.net/index.php?title=ConVars_(SourceMod_Scripting)&oldid=6865 old version of page].

'''ConVars''' are ''con''sole ''var''iables. They store string which can view as boolean, float, or numerical values. These values can be changed via the console or .cfg files, and sometimes even persist across server sessions.

= Introduction =
ConVars are accessed through own class named as [https://sm.alliedmods.net/new-api/convars/ConVar ConVar]. There are two ways to obtain a ConVar. You can either create a new ConVar, or find an existing one. If you create a ConVar that already exists, it will automatically re-use the old one.

== Finding ConVars ==
Finding ConVars is very simple. For example, let's say you want to use <tt>mp_startmoney</tt> from Counter-Strike:Source:

<pawn>ConVar g_cvStartMoney

public void OnPluginStart()
{
g_cvStartMoney = FindConVar("mp_startmoney")
}</pawn>

''Note: FindConVar() will return ''<tt>null</tt>'' if the ConVar is not found. Keep this in mind if you are trying to read ConVars from other plugins.''

== Creating ConVars ==
A simple ConVar only requires two parameters, a name and a default value. However, it's a good idea to include a description:

<pawn>ConVar g_cvEnabled

public void OnPluginStart()
{
g_cvEnabled = CreateConVar("myplugin_enabled", "1", "Sets whether my plugin is enabled")
}</pawn>

You can also specify value constraints. For example, let's create a cvar called <tt>myplugin_ratio</tt> which cannot go above 1.0 or below 0.1.
<pawn>ConVar g_cvRatio

public OnPluginStart()
{
g_cvRatio = CreateConVar("myplugin_ratio",
"0.6",
"Sets a vote ratio",
_, /* Flags will be discussed later */
true, /* Has a minimum */
0.1,
true, /* Has a maximum */
1.0)
}</pawn>

The default value can be any type of data, and it does not restrict future data types that can be used. However, the minimum and maximum constraints always interpret the value as a float.

= Using/Changing Values =
Managing ConVars is very simple. For example, let's say we want to change <tt>mp_startmoney</tt>, but save the old value and restore it later. Re-using our <tt>mp_startmoney</tt> code from <tt>FindConVar</tt>:

<pawn>int g_oldmoney

SetStartMoney(int newmoney)
{
g_oldmoney = g_hStartMoney.IntValue
g_cvStartMoney.IntValue = newmoney
}

RestoreStartMoney()
{
g_cvStartMoney.IntValue = g_oldmoney
}</pawn>

Although there are different functions for value types (float, string, et cetera), the internal data is always stored the same way. For example, this code will work:

<pawn>public int GetStartMoney()
{
char buffer[128]

g_cvStartMoney.GetString(buffer, 128)

return StringToInt(buffer)
}</pawn>

Even though <tt>mp_startmoney</tt> is an integer, it can still be retrieved as a string.

= Flags =
ConVars can have a number of flags to change their behaviour. A few of the important flags are:
*<tt>FCVAR_PROTECTED</tt> - Sensitive information (should not be exposed to clients or logs).
*<tt>FCVAR_NOTIFY</tt> - Clients are notified of changes.
*<tt>FCVAR_CHEAT</tt> - Can only be use if <tt>sv_cheats</tt> is 1.
*<tt>FCVAR_REPLICATED</tt> - Setting is forced to clients.

Let's say we wanted to toggle whether a cvar had FCVAR_CHEAT. The following two functions could be used:
<pawn>void UnsetCheatVar(ConVar convar)
{
int flags = convar.Flags
flags &= ~FCVAR_CHEAT
convar.Flags = flags
}

void SetCheatVar(ConVar convar)
{
int flags = convar.Flags
flags |= FCVAR_CHEAT
convar.Flags = flags
}</pawn>

= Change Callbacks =
As of Half-Life 2, it is possible to know when ConVars change. While this is a very powerful feature, you must be careful not to set a ConVar inside a ConVar change hook such that it re-invokes he same callback. This results in ''infinite recursion''.

For example, let's say you want to detect when <tt>bot_quota</tt> changes and to prevent it from going below 2:

<pawn>ConVar g_hBotQuota

public void OnPluginStart()
{
g_hBotQuota = FindConVar("bot_quota")
if (g_hBotQuota != null)
{
g_hBotQuota.AddChangeHook(OnBotQuotaChange)
}
}

public void OnBotQuotaChange(ConVar convar, char[] oldValue, char[] newValue)
{
if (StringToInt(newValue) < 2)
{
convar.IntValue = 2
}
}</pawn>

'''Note 1:''' You do not need to explicitly unhook ConVarChange functions on shutdown. These hooks are removed when your plugin unloads.

'''Note 2:''' You cannot prevent cvar changes from happening; you can only change the value again. If the engine or game mod already have a change function installed for a ConVar, that function will always be called first.

[[Category:SourceMod Scripting]]

ConVars (SourceMod Scripting)/ru

2015-03-08T15:42:35Z

Kailo: Kailo moved page Ru:ConVars (SourceMod Scripting) to ConVars (SourceMod Scripting)/ru: Wrong non-english page name

Квары - ''это консольные переменные.'' Они могут иметь числовое или строчное значение. Их значения могут быть изменены через консоль или с помощью .cfg файлов, а иногда сохраняются для всех сеансов сервера.

=Введение=
Квары доступны через Handle`s. Есть 2 способа получить Handle квара. Создать новый квар или найти существующий. Если вы создадите уже существующий квар, автоматически будет использоваться старый.

''Примечание: Handle`s для кваров являются уникальными, их не нужно закрывать или присваивать INVALID_HANDLE. Они должны существовать пока SourceMod запущен.''

==Поиск кваров==
Искать квары очень просто. Например, вы хотите найти <tt>mp_startmoney</tt> из Counter-Strike:Source:

<pawn>new g_hStartMoney

public OnPluginStart()
{
g_hStartMoney = FindConVar("mp_startmoney")
}</pawn>

''Примечание: FindConVar() вернет ''<tt>INVALID_HANDLE</tt>'' если квар не найден. Keep this in mind if you are trying to read ConVars from other plugins.''

==Создание кваров==
Простейший квар требует всего 2 значения: имя и значение по умолчанию. Тем не менее, он может содержать описание:

<pawn>new Handle:g_hEnabled

public OnPluginStart()
{
g_hEnabled = CreateConVar("myplugin_enabled", "1", "Включение/Выключение плагина.")
}</pawn>

Вы так же имеете возможностю ограничить значение. Например, давайте создадим квар названием <tt>myplugin_ratio</tt>, который не может быть выше 1,0 и ниже 0,1.
<pawn>new Handle:g_hEnabled

public OnPluginStart()
{
g_hEnabled = CreateConVar("myplugin_ratio",
"0.6",
"Sets a vote ratio",
_, /* Флаги (будут обсуждаться позже) */
true, /* Включить минимальное значение */
0.1,
true, /* Включить максимальное значение */
1.0)
}</pawn>

Значение по умолчанию может иметь любой тип данных, и оно не ограничивает будущие типы данных, которые можно использовать. Тем не менее, минимальные и максимальные ограничения всегда должны быть числом с плавающей точкой (float).

Если вы создаете квар, который уже существует, вы получите Handle на этот квар. Кроме того, сами Handle будут идентичны, поскольку плагин будет владеть Handle. Описание, значение по умолчанию, или ограничения не будут изменены.

=Использование/Изменение значений=
Использовать квары очень просто. Например, мы хотим изменить <tt>mp_startmoney</tt>, но сохранить старое значение и восстановить его позже. Повторно используем наш код <tt>mp_startmoney</tt> от раздела <tt>Получение кваров</tt>:

<pawn>new g_oldmoney

SetStartMoney(newmoney)
{
g_oldmoney = GetConVarInt(g_hStartMoney)
SetConVarInt(g_hStartMoney, newmoney)
}

RestoreStartMoney()
{
SetConVarInt(g_hStartMoney, g_oldmoney)
}</pawn>

Хотя существуют различные функции для типов значений (с плавающей точкой, строки, и так далее), внутренние данные всегда сохраняются так же. Например, этот код будет работать:

<pawn>public GetStartMoney()
{
decl String:buffer[128]

GetConVarString(g_hStartMoney, buffer, sizeof(buffer))

return StringToInt(buffer)
}</pawn>

Несмотря на то, что <tt>mp_startmoney</tt> целое число, он может использоваться как строка.

=Флаги=
Квары могут иметь ряд флагов, в зависимости от которых могут менять свое поведение. Основные флаги:
*<tt>FCVAR_PROTECTED</tt> - Секретная информация (не должны подвергаться воздействию клиентов или логов).
*<tt>FCVAR_NOTIFY</tt> - Уведомление клиентов об изменении.
*<tt>FCVAR_CHEAT</tt> - Могут использоваться только в случае если <tt>sv_cheats</tt> равно 1.
*<tt>FCVAR_REPLICATED</tt> - Принудительная установка значения квара на клиенте.

Например, мы хотим изменить значение квара с флагом FCVAR_CHEAT. The following two functions could be used:
<pawn>UnsetCheatVar(Handle:hndl)
{
new flags = GetConVarFlags(hndl)
flags &= ~FCVAR_CHEAT
SetConVarFlags(hndl, flags)
}

SetCheatVar(Handle:hndl)
{
new flags = GetConVarFlags(hndl)
flags |= FCVAR_CHEAT
SetConVarFlags(hndl, flags)
}</pawn>

=Change Callbacks=
As of Half-Life 2, it is possible to know when ConVars change. While this is a very powerful feature, you must be careful not to set a ConVar inside a ConVar change hook such that it re-invokes he same callback. This results in ''infinite recursion''.

For example, let's say you want to detect when <tt>bot_quota</tt> changes and to prevent it from going below 2:

<pawn>new Handle:g_hBotQuota

public OnPluginStart()
{
g_hBotQuota = FindConVar("bot_quota")
if (g_hBotQuota != INVALID_HANDLE)
{
HookConVarChange(g_hBotQuota, OnBotQuotaChange)
}
}

public OnBotQuotaChange(Handle:cvar, const String:oldVal[], const String:newVal[])
{
if (StringToInt(newVal) < 2)
{
SetConVarInt(cvar, 2)
}
}</pawn>

'''Note 1:''' You do not need to explicitly unhook ConVarChange functions on shutdown. These hooks are removed when your plugin unloads.

'''Note 2:''' You cannot prevent cvar changes from happening; you can only change the value again. If the engine or game mod already have a change function installed for a ConVar, that function will always be called first.

[[Category:Ru:SourceMod Scripting]]

Ru:ConVars (SourceMod Scripting)

2015-03-08T15:42:35Z

Kailo: Kailo moved page Ru:ConVars (SourceMod Scripting) to ConVars (SourceMod Scripting)/ru: Wrong non-english page name

#REDIRECT [[ConVars (SourceMod Scripting)/ru]]