Game UserMessages (Source) - Revision history

Luki1412 at 15:58, 3 November 2026

2026-11-03T15:58:18Z

Luki1412: Changed Nuclear Dawn to No More Room In Hell

2026-11-03T15:53:26Z

Changed Nuclear Dawn to No More Room In Hell

Luki1412 at 13:24, 3 November 2026

2026-11-03T13:24:06Z

Luki1412 at 13:22, 3 November 2026

2026-11-03T13:22:27Z

Luki1412: Merged content from "User messages"

2026-11-03T13:19:54Z

Merged content from "User messages"

Luki1412: Linked pages

2026-11-03T13:14:26Z

Linked pages

Powerlord: Linkified DOTA 2 UserMessages

2013-03-26T18:46:57Z

Linkified DOTA 2 UserMessages

Powerlord: Shared structures aren't truly shared. Turns out they changed between DOTA2 and CS:GO.

2013-03-26T18:09:34Z

Shared structures aren't truly shared. Turns out they changed between DOTA2 and CS:GO.

Powerlord: New page for UserMessages.

2013-03-26T15:19:05Z

New page for UserMessages.

New page

In addition to events, Source games use UserMessages to send messages from the server to clients.

There are two types of UserMesssage: BitStream UserMessages and Protocol Buffer UserMessages. BitStream UserMessage names can be retrieved using the Metamod: Source "meta game" command. However, this will not give you the type and order of the arguments being sent to the client.

Protocol Buffer UserMessages are well-documented in .proto files included in the game SDKs.

Games that use BitStream UserMessages
* Counter-Strike: Source UserMessages
* Day of Defeat: Source UserMessages
* Half-Life 2: Deathmatch UserMessages
* Left 4 Dead UserMessages
* Left 4 Dead 2 UserMessages
* Nuclear Dawn UserMessages
* Team Fortress 2 UserMessages

Games that use [[Protobuf|Protobuf UserMessages]]
* [[Generic Source Protobuf UserMessages]]
* [[Counter-Strike: Global Offensive UserMessages]]
* DOTA 2 UserMessages

== Shared structures for Protobuf UserMessages ==

All games that use Protocol Buffers can use these

@@ Line 12: / Line 12: @@
 * [[Left 4 Dead UserMessages]]
 * [[Left 4 Dead 2 UserMessages]]
-* [[Nuclear Dawn UserMessages]]
+* [[No More Room In Hell UserMessages]]
 * [[Team Fortress 2 UserMessages]]

← Older revision		Revision as of 13:24, 3 November 2026
Line 19:		Line 19:
	* [[DOTA 2 UserMessages]]		* [[DOTA 2 UserMessages]]

		+	==Tutorials==
	Tutorial on the subject: https://forums.alliedmods.net/showthread.php?t=80256		Tutorial on the subject: https://forums.alliedmods.net/showthread.php?t=80256

@@ Line 1: / Line 1: @@
 In addition to events, Source games use UserMessages to send messages from the server to clients.
@@ Line 5: / Line 6: @@
 Protocol Buffer UserMessages are well-documented in .proto files included in the game SDKs.
-Games that use BitStream UserMessages
+==Games that use BitStream UserMessages==
 * [[Counter-Strike: Source UserMessages]]
 * [[Day of Defeat: Source UserMessages]]
@@ Line 14: / Line 15: @@
 * [[Team Fortress 2 UserMessages]]
-Games that use [[Protobuf|Protobuf UserMessages]]
+==Games that use [[Protobuf|Protobuf UserMessages]]==
 * [[Counter-Strike: Global Offensive UserMessages]]
 * [[DOTA 2 UserMessages]]

← Older revision		Revision as of 13:19, 3 November 2026
Line 17:		Line 17:
	* [[Counter-Strike: Global Offensive UserMessages]]		* [[Counter-Strike: Global Offensive UserMessages]]
	* [[DOTA 2 UserMessages]]		* [[DOTA 2 UserMessages]]
		+
		+	Tutorial on the subject: https://forums.alliedmods.net/showthread.php?t=80256
		+
		+	=== Fade Flags ===
		+	These may not be correct...
		+
		+	FFADE_IN 0x0001 // Just here so we don't pass 0 into the function
		+	FFADE_OUT 0x0002 // Fade out (not in)
		+	FFADE_MODULATE 0x0004 // Modulate (don't blend)
		+	FFADE_STAYOUT 0x0008 // ignores the duration, stays faded out until new ScreenFade message received
		+	FFADE_PURGE 0x0010 // Purges all other fades, replacing them with this one
		+
		+	=== Fade Function ===
		+	Example Fade function (be sure to define the Fade Flags!)
		+
		+	This Fades the clients screen to a specified color, and stays until you reset the color to {0,0,0,0}
		+
		+	To modify it to Fade the screen for a certain amount of time, remove the STAYOUT flag, and pass a value to "fade & hold"
		+
		+	PerformFade(target, 500, {0, 128, 255, 51})
		+
		+	PerformFade(client, duration, const color[4]) {
		+	new Handle:hFadeClient=StartMessageOne("Fade",client)
		+	BfWriteShort(hFadeClient,duration) // FIXED 16 bit, with SCREENFADE_FRACBITS fractional, milliseconds duration
		+	BfWriteShort(hFadeClient,0) // FIXED 16 bit, with SCREENFADE_FRACBITS fractional, milliseconds duration until reset (fade & hold)
		+	BfWriteShort(hFadeClient,(FFADE_PURGE\|FFADE_OUT\|FFADE_STAYOUT)) // fade type (in / out)
		+	BfWriteByte(hFadeClient,color[0]) // fade red
		+	BfWriteByte(hFadeClient,color[1]) // fade green
		+	BfWriteByte(hFadeClient,color[2]) // fade blue
		+	BfWriteByte(hFadeClient,color[3]) // fade alpha
		+	EndMessage()
		+	}
		+
		+	=== HudMsg Function ===
		+	This does not work in CS:S.
		+
		+	This Draws a text Message to a specified players screen. This is just for educational purposes and there is a much easier way of doing this with native functions here: [https://sm.alliedmods.net/new-api/halflife/ShowHudText ShowHudText] & [https://sm.alliedmods.net/new-api/halflife/SetHudTextParams SetHudTextParams]
		+
		+	PerformHudMsg(client, "This is a Test")
		+
		+	PerformHudMsg(client, const String:szMsg[]) {
		+	new Handle:hBf = StartMessageOne("HudMsg", client)
		+	BfWriteByte(hBf, 3) //channel
		+	BfWriteFloat(hBf, 0.0); // x ( -1 = center )
		+	BfWriteFloat(hBf, -1); // y ( -1 = center )
		+	// second color
		+	BfWriteByte(hBf, 0); //r1
		+	BfWriteByte(hBf, 0); //g1
		+	BfWriteByte(hBf, 255); //b1
		+	BfWriteByte(hBf, 255); //a1 // transparent?
		+	// init color
		+	BfWriteByte(hBf, 255); //r2
		+	BfWriteByte(hBf, 0); //g2
		+	BfWriteByte(hBf, 0); //b2
		+	BfWriteByte(hBf, 255); //a2
		+	BfWriteByte(hBf, 0); //effect (0 is fade in/fade out; 1 is flickery credits; 2 is write out)
		+	BfWriteFloat(hBf, 1.0); //fadeinTime (message fade in time - per character in effect 2)
		+	BfWriteFloat(hBf, 1.0); //fadeoutTime
		+	BfWriteFloat(hBf, 15.0); //holdtime
		+	BfWriteFloat(hBf, 5.0); //fxtime (effect type(2) used)
		+	BfWriteString(hBf, szMsg); //Message
		+	EndMessage();
		+	}
		+
		+	=== HookUserMessage Fade ===
		+	Some sample code to hook a UserMessage, In this case Fade.
		+	You cannot send other UserMessages inside of a UserMessage Hook. Many simple functions such as PrintToChat call UserMessages.
		+
		+	public OnPluginStart() {
		+	HookUserMessage(GetUserMessageId("Fade"),HookFade,true)
		+	}
		+
		+	public Action:HookFade(UserMsg:msg_id, Handle:bf, const players[], playersNum, bool:reliable, bool:init) {
		+	new duration = BfReadShort(bf)
		+	new holdtime = BfReadShort(bf)
		+	BfReadShort(bf) //You must read all of the bf values, even If you only want the last value such as this one.
		+	new r = BfReadByte(bf) //You do NOT need to store their value though.
		+	new g = BfReadByte(bf)
		+	new b = BfReadByte(bf)
		+	new a = BfReadByte(bf)
		+
		+	PrintToServer("Duration: %i, HoldTime: %i, rgba: %i %i %i %i",duration,holdtime,r,g,b,a)
		+	}
		+
		+	[[Category:SourceMod Scripting]]

@@ Line 2: / Line 2: @@
 In addition to events, Source games use UserMessages to send messages from the server to clients.
-There are two types of UserMesssage: BitStream UserMessages and Protocol Buffer UserMessages.  BitStream UserMessage names can be retrieved using the Metamod: Source "meta game" command.  However, this will not give you the type and order of the arguments being sent to the client.
+There are two types of UserMesssage:
 Protocol Buffer UserMessages are well-documented in .proto files included in the game SDKs.