Ru:Events (SourceMod Scripting) - Revision history

V1KT0P: /* Hooking Events */

2010-12-25T04:16:50Z

‎Hooking Events

V1KT0P: /* Посылка сообщений */

2010-12-25T03:49:37Z

‎Посылка сообщений

V1KT0P at 15:17, 8 December 2010

2010-12-08T15:17:00Z

V1KT0P at 15:11, 8 December 2010

2010-12-08T15:11:23Z

V1KT0P at 14:52, 8 December 2010

2010-12-08T14:52:21Z

Frenzzy at 10:35, 24 December 2008

2008-12-24T10:35:05Z

Frenzzy: New page: :''To view all the events, click here.'' Events are short, named messages sent by the server. Although they are used for internal message passing, they are also ...

2008-12-23T16:21:53Z

New page: :''To view all the events, click here.'' Events are short, named messages sent by the server. Although they are used for internal message passing, they are also ...

New page

:''To view all the events, click [[Game Events (Source)|here]].''

Events are short, named messages sent by the server. Although they are used for internal message passing, they are also networked to clients.

All event natives are found in <tt>plugins/include/events.inc</tt>.

=Introduction=
Events are documented in <tt>.res</tt> files under a mod's <tt>resource</tt> folder. The "default" events are located in <tt>hl2/resource/gameevents.res</tt> and <tt>hl2/resource/serverevents.res</tt>. Mods can extend these events with their own.

For example, let's look at <tt>player_death</tt> from <tt>hl2/resource/gameevents.res</tt>:
<pre>"player_death"
{
"userid" "short" // user ID who died
"attacker" "short" // user ID who killed
}</pre>

Counter-Strike:Source extends this definition in <tt>cstrike/resource/modevents.res</tt>:
<pre>"player_death"
{
"userid" "short" // user ID who died
"attacker" "short" // user ID who killed
"weapon" "string" // weapon name killer used
"headshot" "bool" // signals a headshot
}</pre>

Note that the event is structured in the following format:
<pre>"name"
{
"key1" "valueType1"
"key2" "valueType2"
...
}</pre>

=Sending Events=
Events are very easy to send. For example, let's say we want to send a death message using the <tt>player_death</tt> event from above. For Counter-Strike:Source, this would look like:

<pawn>SendDeathMessage(attacker, victim, const String:weapon[], bool:headshot)
{
new Handle:event = CreateEvent("player_death")
if (event == INVALID_HANDLE)
{
return
}

SetEventInt(event, "userid", GetClientUserId(victim))
SetEventInt(event, "attacker", GetClientUserId(attacker))
SetEventString(event, "weapon", weapon)
SetEventBool(event, "headshot", headshot)
FireEvent(event)
}</pawn>

Notes:
*You don't need to call <tt>CloseHandle()</tt>, <tt>FireEvent()</tt> does this for us.
*Even though "userid" and "attacker" are shorts, we set them as ints. The term "short" is only used to tell the engine how many bytes of the integer are needed to be networked.
*It is possible for event creation to fail; this can happen if the event does not exist, or nothing is hooking the event. Thus, you should always make sure <tt>CreateEvent</tt> calls return a valid Handle.
*Most events use client userids instead of client indexes.
*By default, <tt>FireEvent()</tt> broadcasts messages to clients. This can be prevented by passing <tt>dontBroadcast</tt> as true.

=Hooking Events=
When hooking an event, there are three modes to choose from:
*<tt>Pre</tt> - Hook the event before it is fired.
*<tt>Post</tt> - Hook the event after it is fired.
*<tt>Post_NoCopy</tt> - Hook the event, but do not save any of its information (special optimization).

Hooking an event is usually done for one of the following goals. To get an idea of which mode to use, see the list below each goal:
*Blocking the event (preventing it from being fired)
**'''Always <tt>Pre</tt>'''
*Rewriting the event (changing its parameters)
**'''Always <tt>Pre</tt>'''
*Acting upon the event (doing something once the event is completed)
**'''<tt>Pre</tt>''' if your action must come before the mod's action.
**'''<tt>Post</tt>''' if your action must come after the mod's action.
**'''<tt>PostNoCopy</tt>''' if your action is <tt>Post</tt> and only requires the event name.

As always, you do not need to unhook events when your plugin unloads. They are automatically removed.

==Blocking Events==
Blocking events is the easiest thing to do. Let's say we want to block death events that are headshots:

<pawn>public OnPluginStart()
{
HookEvent("player_death", Event_PlayerDeath, EventHookMode_Pre)
}

public Action:Event_PlayerDeath(Handle:event, const String:name[], bool:dontBroadcast)
{
if (GetEventBool(event, "headshot"))
{
return Plugin_Handled
}
return Plugin_Continue
}</pawn>

==Rewriting Events==
Rewriting events is just as easy -- events can be modified in pre hooks. For example, say we want to remove headshots from all events:

<pawn>public OnPluginStart()
{
HookEvent("player_death", Event_PlayerDeath, EventHookMode_Pre)
}

public Action:Event_PlayerDeath(Handle:event, const String:name[], bool:dontBroadcast)
{
SetEventBool(event, "headshot", false)
return Plugin_Continue
}</pawn>

==Post Hooks==
Post hooks are default, and will usually be the most common usage. For example, say we want to print a message to every client that dies:

<pawn>public OnPluginStart()
{
HookEvent("player_death", Event_PlayerDeath)
}

public Event_PlayerDeath(Handle:event, const String:name[], bool:dontBroadcast)
{
decl String:weapon[64]
new victimId = GetEventInt(event, "userid")
new attackerId = GetEventInt(event, "attacker")
new bool:headshot = GetEventBool(event, "headshot")
GetEventString(event, "weapon", weapon, sizeof(weapon))

decl String:name[64]
new victim = GetClientOfUserId(victimId)
new attacker = GetClientOfUserId(attackerId)
GetClientName(attacker, name, sizeof(name))

PrintToConsole(victim,
"You were killed by \"%s\" (weapon \"%s\") (headshot \"%d\")",
name,
weapon,
headshot)
}</pawn>

This will print a message to a player's console telling them who killed them, with what weapon, and whether it was a headshot or not.

Note that the return value for post hooks is ignored, so the <tt>Action</tt> tag is not needed.

==PostNoCopy Hooks==
Lastly, there are some hooks where the only piece of information needed is the name of the event. <tt>PostNoCopy</tt> is a special optimization for this case. When transitioning from <tt>Pre</tt> to <tt>Post</tt>, SourceMod must duplicate the event and all of its key/value pairs. <tt>PostNoCopy</tt> prevents that sequence from happening.

For example, let's say we want to find when a certain sequence of events is called.

<pawn>public OnPluginStart()
{
HookEvent("game_newmap", GameEvents, EventHookMode_PostNoCopy)
HookEvent("game_start", GameEvents, EventHookMode_PostNoCopy)
HookEvent("game_end", GameEvents, EventHookMode_PostNoCopy)
HookEvent("game_message", GameEvents, EventHookMode_PostNoCopy)
}

public GameEvents(Handle:event, const String:name[], bool:dontBroadcast)
{
PrintToServer("Event has been fired (event \"%s\") (nobcast \"%d\")", name, dontBroadcast)
}</pawn>

Note that like normal <tt>Post</tt> hooks, there is no return value needed. However, the <tt>event</tt> parameter for <tt>PostNoCopy</tt> will '''always''' be equal to <tt>INVALID_HANDLE</tt>. Thus, the <tt>name</tt> parameter must be used instead of <tt>GetEventName</tt>.

[[Category:SourceMod Scripting]]
[[Category:Russian]]

@@ Line 53: / Line 53: @@
 *Вы не должны вызывать <tt>CloseHandle()</tt>, <tt>FireEvent()</tt> сделает это за вас.
 *Даже если "userid" и "attacker" являются shorts, мы отсылаем их в качестве ints.  Термин "short" используется только для того, чтобы сказать движку сколько байт числа необходимо для отправки.
-*It is possible for event creation to fail; this can happen if the event does not exist, or nothing is hooking the event.  Thus, you should always make sure <tt>CreateEvent</tt> calls return a valid Handle.
+*Событие может и не создастся; это происходит если событие не существует или никто не перехватывает его.  Поэтому вы должны убедиться, что вызов <tt>CreateEvent</tt> возвращает правильный Handle.
-*Most events use client userids instead of client indexes.
+*Большинство событий используют userids вместо индекса.
-*By default, <tt>FireEvent()</tt> broadcasts messages to clients.  This can be prevented by passing <tt>dontBroadcast</tt> as true.
+*По умолчанию, <tt>FireEvent()</tt> посылает сообщения к клиенту.  Это можно отключить установив <tt>dontBroadcast</tt> в true.
 =Hooking Events=

← Older revision		Revision as of 14:52, 8 December 2010
Line 1:		Line 1:
−	:''~~To view all the events~~, ~~click~~ [[Game Events (Source)\|~~here~~]].''	+	:''Для просмотра всех событий, нажмите [[Game Events (Source)\|здесь]].''

	Events are short, named messages sent by the server. Although they are used for internal message passing, they are also networked to clients.		Events are short, named messages sent by the server. Although they are used for internal message passing, they are also networked to clients.

← Older revision		Revision as of 10:35, 24 December 2008
Line 158:		Line 158:
	Note that like normal <tt>Post</tt> hooks, there is no return value needed. However, the <tt>event</tt> parameter for <tt>PostNoCopy</tt> will '''always''' be equal to <tt>INVALID_HANDLE</tt>. Thus, the <tt>name</tt> parameter must be used instead of <tt>GetEventName</tt>.		Note that like normal <tt>Post</tt> hooks, there is no return value needed. However, the <tt>event</tt> parameter for <tt>PostNoCopy</tt> will '''always''' be equal to <tt>INVALID_HANDLE</tt>. Thus, the <tt>name</tt> parameter must be used instead of <tt>GetEventName</tt>.

−	[[Category:SourceMod Scripting]]	+	[[Category:Ru:SourceMod Scripting]]
−	~~[[Category:Russian~~]]

@@ Line 57: / Line 57: @@
 *По умолчанию, <tt>FireEvent()</tt> посылает сообщения к клиенту.  Это можно отключить установив <tt>dontBroadcast</tt> в true.
-=Hooking Events=
+=Перехват Событий=
-When hooking an event, there are three modes to choose from:
+Существует три режима перехвата событий:
-*<tt>Pre</tt> - Hook the event before it is fired.
+*<tt>Pre</tt> - Перехват события до выполнения.
-*<tt>Post</tt> - Hook the event after it is fired.
+*<tt>Post</tt> - Перехват события после выполнения.
-*<tt>Post_NoCopy</tt> - Hook the event, but do not save any of its information (special optimization).
+*<tt>Post_NoCopy</tt> - Перехват события, но не сохраняется любая информация об этом событии (специальная оптимизация).
-Hooking an event is usually done for one of the following goals.  To get an idea of which mode to use, see the list below each goal:
+Перехват событий обычно делается для одной из этих целей.  Для того, чтоб понять какой режим использовать, смотрите ниже список целей:
-*Blocking the event (preventing it from being fired)
+*Блокировка события (предотвращение выполнения)
-**'''Always <tt>Pre</tt>'''
+**'''Всегда <tt>Pre</tt>'''
-*Rewriting the event (changing its parameters)
+*Изменение события (изменение параметров)
-**'''Always <tt>Pre</tt>'''
+**'''Всегда <tt>Pre</tt>'''
-*Acting upon the event (doing something once the event is completed)
+*Выполнить после события (сделать что-то после того как событие произошло)
-**'''<tt>Pre</tt>''' if your action must come before the mod's action.
+**'''<tt>Pre</tt>''' если ваши действия должны произойти перед выполнением мода.
-**'''<tt>Post</tt>''' if your action must come after the mod's action.
+**'''<tt>Post</tt>''' если ваши действия должны произойти после выполнением мода.
-**'''<tt>PostNoCopy</tt>''' if your action is <tt>Post</tt> and only requires the event name.
+**'''<tt>PostNoCopy</tt>''' если подходит <tt>Post</tt> и требуется только имя события.
-As always, you do not need to unhook events when your plugin unloads.  They are automatically removed.
+Как всегда вы не должны убирать перехват события, когда происходит выгрузка плагина.  Они удаляются автоматически.
-==Blocking Events==
+==Блокировка Событий==
-Blocking events is the easiest thing to do.  Let's say we want to block death events that are headshots:
+Блокировку событий сделать очень просто.  Например мы хотим заблокировать событие смерти если смерть произошла от попадания в голову:
 <pawn>public OnPluginStart()
@@ Line 92: / Line 92: @@
 }</pawn>
-==Rewriting Events==
+==Изменение Событий==
-Rewriting events is just as easy -- events can be modified in pre hooks.  For example, say we want to remove headshots from all events:
+Измененить событий тоже очень просто -- события могут быть изменены в режиме перед выполнением события.  Например мы хотим убрать попадание в голову со всех событий:
 <pawn>public OnPluginStart()
@@ Line 106: / Line 106: @@
 }</pawn>
-==Post Hooks==
+==Post Перехват==
-Post hooks are default, and will usually be the most common usage.  For example, say we want to print a message to every client that dies:
+По умолчанию используется перехват после события и как правило наиболее используемый.  Например мы хотим послать сообщение всем игрокам, которые умерли:
 <pawn>public OnPluginStart()
@@ Line 134: / Line 134: @@
 }</pawn>
-This will print a message to a player's console telling them who killed them, with what weapon, and whether it was a headshot or not.
+Это будет писать игроку в консоли кто его убил, с каким оружием и было ли попадание в голову.
-Note that the return value for post hooks is ignored, so the <tt>Action</tt> tag is not needed.
+Обратите внимание, что возвращение значений с перехвата после события игнорируется, поэтому тег <tt>Action</tt> ненужен.
-==PostNoCopy Hooks==
+==PostNoCopy Перехват==
-Lastly, there are some hooks where the only piece of information needed is the name of the event.  <tt>PostNoCopy</tt> is a special optimization for this case.  When transitioning from <tt>Pre</tt> to <tt>Post</tt>, SourceMod must duplicate the event and all of its key/value pairs.  <tt>PostNoCopy</tt> prevents that sequence from happening.
+Наконец есть перехваты где требуется только имя события.  <tt>PostNoCopy</tt> специальная оптимизация для этого.  При переходе от <tt>Pre</tt> к <tt>Post</tt>, SourceMod должен дублировать событие и все значения.  <tt>PostNoCopy</tt> предотвращает это.
-For example, let's say we want to find when a certain sequence of events is called.
+Например мы хотим найти когда происходят определенные события.
 <pawn>public OnPluginStart()
@@ Line 156: / Line 156: @@
 }</pawn>
-Note that like normal <tt>Post</tt> hooks, there is no return value needed.  However, the <tt>event</tt> parameter for <tt>PostNoCopy</tt> will '''always''' be equal to <tt>INVALID_HANDLE</tt>.  Thus, the <tt>name</tt> parameter must be used instead of <tt>GetEventName</tt>.
+Обратите внимание, что как и обычный <tt>Post</tt> перехват, он не требует возврата значений.  Однако, параметр <tt>event</tt> для <tt>PostNoCopy</tt> '''всегда''' должен быть равным <tt>INVALID_HANDLE</tt>.  Таким образом параметр <tt>name</tt> должен использоваться вместо <tt>GetEventName</tt>.
 [[Category:Ru:SourceMod Scripting]]

@@ Line 1: / Line 1: @@
 :''Для просмотра всех событий, нажмите [[Game Events (Source)|здесь]].''
-Events are short, named messages sent by the server.  Although they are used for internal message passing, they are also networked to clients.
+События это короткие сообщения с именем, посылаемые сервером.  Хотя они используются для внутренней передачи сообщений, они также посылаются клиентам.
-All event natives are found in <tt>plugins/include/events.inc</tt>.
+Все нативные события можно найти в <tt>plugins/include/events.inc</tt>.
-=Introduction=
+=Введение=
-Events are documented in <tt>.res</tt> files under a mod's <tt>resource</tt> folder.  The "default" events are located in <tt>hl2/resource/gameevents.res</tt> and <tt>hl2/resource/serverevents.res</tt>.  Mods can extend these events with their own.
+События описаны в <tt>.res</tt> файлах мода в папке <tt>resource</tt>.  "Стандартные" события находятся в <tt>hl2/resource/gameevents.res</tt> и <tt>hl2/resource/serverevents.res</tt>.  Мод может расширить эти события с помощью расширений.
-For example, let's look at <tt>player_death</tt> from <tt>hl2/resource/gameevents.res</tt>:
+Для примера посмотрим на <tt>player_death</tt> из <tt>hl2/resource/gameevents.res</tt>:
 <pre>"player_death"
+{
-	"userid"	"short"   	// user ID who died
+	"userid"	"short"   	// user ID убитого
-	"attacker"	"short"	 	// user ID who killed
+	"attacker"	"short"	 	// user ID убийцы
 }</pre>
-Counter-Strike:Source extends this definition in <tt>cstrike/resource/modevents.res</tt>:
+Counter-Strike:Source расширяет это описание в <tt>cstrike/resource/modevents.res</tt>:
 <pre>"player_death"
+{
-	"userid"	"short"   	// user ID who died
+	"userid"	"short"   	// user ID убитого
-	"attacker"	"short"	 	// user ID who killed
+	"attacker"	"short"	 	// user ID убийцы
-	"weapon"	"string" 	// weapon name killer used
+	"weapon"	"string" 	// название оружие, которым убил убийца
-	"headshot"	"bool"		// signals a headshot
+	"headshot"	"bool"		// сигнал попадания в голову
 }</pre>
-Note that the event is structured in the following format:
+Обратите внимание, что событие состоит в следующем формате:
 <pre>"name"
+{
@@ Line 32: / Line 32: @@
 }</pre>
-=Sending Events=
+=Посылка сообщений=
-Events are very easy to send.  For example, let's say we want to send a death message using the <tt>player_death</tt> event from above.  For Counter-Strike:Source, this would look like:
+Послать сообщенмя очень просто.  Например мы хотим послать сообщение смерти используя событие <tt>player_death</tt> описанное выше.  Для Counter-Strike:Source, это будет иметь вид:
 <pawn>SendDeathMessage(attacker, victim, const String:weapon[], bool:headshot)
@@ Line 50: / Line 50: @@
 }</pawn>
-Notes:
+Примечания:
 *You don't need to call <tt>CloseHandle()</tt>, <tt>FireEvent()</tt> does this for us.
 *Even though "userid" and "attacker" are shorts, we set them as ints.  The term "short" is only used to tell the engine how many bytes of the integer are needed to be networked.