Events (SourceMod Scripting) - Revision history

Mooshua at 19:57, 19 May 2024

2024-05-19T19:57:08Z

2020-03-30T01:27:27Z

Update highlighting

2018-05-24T08:57:20Z

2018-05-24T03:39:10Z

2018-05-24T03:30:15Z

2018-05-24T03:29:37Z

2016-05-05T23:00:55Z

‎Rewriting Events

2015-10-03T16:45:03Z

‎PostNoCopy Hooks

2015-10-03T16:41:55Z

‎Blocking Events

2015-08-12T22:53:08Z

Updated to 1.7 Syntax

@@ Line 2: / Line 2: @@
 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>scripting/include/events.inc</tt>.
@@ Line 92: / Line 95: @@
 }</sourcepawn>
-'''Note:''' Blocking events does not necessarily block actions like damaging players.
+{{CommonMistake|Blocking an event only blocks other parts of the game from receiving the event; the source of the event may still take action (such as by damaging players)!}}
 ==Rewriting Events==
@@ Line 109: / Line 112: @@
 ==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:

@@ Line 4: / Line 4: @@
 All event natives are found in <tt>scripting/include/events.inc</tt>.
-sorry for the tony!
 =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.

@@ Line 4: / Line 4: @@
 All event natives are found in <tt>scripting/include/events.inc</tt>.
-[[File:Tony.jpeg]]
+sorry for the tony!
 =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.

@@ Line 4: / Line 4: @@
 All event natives are found in <tt>scripting/include/events.inc</tt>.
-[[file:tony.jpg]]
+[[File:Tony.jpeg]]
 =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.

@@ Line 4: / Line 4: @@
 All event natives are found in <tt>scripting/include/events.inc</tt>.
+[[file:tony.jpg]]
 =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.

@@ Line 105: / Line 105: @@
+{
 	event.SetBool("headshot", false);
-	return Plugin_Changed;
+	return Plugin_Continue;
 }</pawn>
 ==Post Hooks==

@@ Line 160: / Line 160: @@
 }</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>.
+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>null</tt>.  Thus, the <tt>name</tt> parameter must be used instead of <tt>event.GetName</tt>.
 [[Category:SourceMod Scripting]]
 {{LanguageSwitch}}

@@ Line 145: / Line 145: @@
 For example, let's say we want to find when a certain sequence of events is called.
-<pawn>public OnPluginStart()
+<pawn>public void OnPluginStart()
+{
-	HookEvent("game_newmap", GameEvents, EventHookMode_PostNoCopy)
+	HookEvent("game_newmap", GameEvents, EventHookMode_PostNoCopy);
-	HookEvent("game_start", GameEvents, EventHookMode_PostNoCopy)
+	HookEvent("game_start", GameEvents, EventHookMode_PostNoCopy);
-	HookEvent("game_end", GameEvents, EventHookMode_PostNoCopy)
+	HookEvent("game_end", GameEvents, EventHookMode_PostNoCopy);
-	HookEvent("game_message", GameEvents, EventHookMode_PostNoCopy)
+	HookEvent("game_message", GameEvents, EventHookMode_PostNoCopy);
+}
-public GameEvents(Handle:event, const String:name[], bool:dontBroadcast)
+public void GameEvents(Event event, const char[] name, bool dontBroadcast)
+{
-	PrintToServer("Event has been fired (event \"%s\") (nobcast \"%d\")", name, dontBroadcast)
+	PrintToServer("Event has been fired (event \"%s\") (nobcast \"%d\")", name, dontBroadcast);
 }</pawn>