Difference between revisions of "Generic Source Server Events"

From AlliedModders Wiki
Jump to: navigation, search
(It's server_message, not server_msg)
(Added some missing descriptions and fields)
Line 5: Line 5:
 
{{qnotice|Send once a server starts (spawns)}}<br>
 
{{qnotice|Send once a server starts (spawns)}}<br>
 
{{begin-hl2msg|server_spawn|string}}
 
{{begin-hl2msg|server_spawn|string}}
{{hl2msg|string|hostname|}}
+
{{hl2msg|string|hostname|public host name}}
{{hl2msg|string|address|}}
+
{{hl2msg|string|address|hostame, IP or DNS name}}
{{hl2msg|string|port|}}
+
{{hl2msg|string|port|server port}}
{{hl2msg|string|game|}}
+
{{hl2msg|string|game|game dir}}
{{hl2msg|string|mapname|}}
+
{{hl2msg|string|mapname|map name}}
{{hl2msg|long|maxplayers|}}
+
{{hl2msg|long|maxplayers|max players}}
{{hl2msg|string|os|}}
+
{{hl2msg|string|os|WIN32, LINUX}}
{{hl2msg|bool|dedicated|}}
+
{{hl2msg|bool|dedicated|true if dedicated server}}
{{hl2msg|bool|password|}}
+
{{hl2msg|bool|password|true if password protected}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 19: Line 19:
 
{{qnotice|Server shut down}}
 
{{qnotice|Server shut down}}
 
{{begin-hl2msg|server_shutdown|string}}
 
{{begin-hl2msg|server_shutdown|string}}
{{hl2msg|string|reason|}}
+
{{hl2msg|string|reason|reason why server was shut down}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 25: Line 25:
 
{{qnotice|A server console var has changed}}
 
{{qnotice|A server console var has changed}}
 
{{begin-hl2msg|server_cvar|string}}
 
{{begin-hl2msg|server_cvar|string}}
{{hl2msg|string|cvarname|}}
+
{{hl2msg|string|cvarname|cvar name, eg "mp_roundtime"}}
{{hl2msg|string|cvarvalue|}}
+
{{hl2msg|string|cvarvalue|new cvar value}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 32: Line 32:
 
{{qnotice|A generic server message}}
 
{{qnotice|A generic server message}}
 
{{begin-hl2msg|server_message|string}}
 
{{begin-hl2msg|server_message|string}}
{{hl2msg|string|text|}}
+
{{hl2msg|string|text|the message text}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 38: Line 38:
 
{{qnotice|When the server has a ban added}}
 
{{qnotice|When the server has a ban added}}
 
{{begin-hl2msg|server_addban|string}}
 
{{begin-hl2msg|server_addban|string}}
{{hl2msg|string|name|}}
+
{{hl2msg|string|name|player name}}
{{hl2msg|string|userid|}}
+
{{hl2msg|string|userid|user ID on server}}
{{hl2msg|string|networkid|}}
+
{{hl2msg|string|networkid|player network (i.e steam) id}}
{{hl2msg|string|ip|}}
+
{{hl2msg|string|ip|IP address}}
{{hl2msg|string|duration|}}
+
{{hl2msg|string|duration|length of the ban}}
{{hl2msg|string|by|}}
+
{{hl2msg|string|by|banned by...}}
{{hl2msg|bool|kicked|}}
+
{{hl2msg|bool|kicked|whether the player was also kicked}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 50: Line 50:
 
{{qnotice|When the server has a ban removed}}
 
{{qnotice|When the server has a ban removed}}
 
{{begin-hl2msg|server_removeban|string}}
 
{{begin-hl2msg|server_removeban|string}}
{{hl2msg|string|networkid|}}
+
{{hl2msg|string|networkid|player network (i.e steam) id}}
{{hl2msg|string|ip|}}
+
{{hl2msg|string|ip|IP address}}
{{hl2msg|stsring|by|}}
+
{{hl2msg|stsring|by|removed by...}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
 
=== player_connect ===
 
=== player_connect ===
{{qnotice|A new player connected}}
+
{{qnotice|A new client connected}}
 
{{begin-hl2msg|player_connect|string}}
 
{{begin-hl2msg|player_connect|string}}
{{hl2msg|string|name|}}
+
{{hl2msg|string|name|player name}}
{{hl2msg|byte|index|}}
+
{{hl2msg|byte|index|player slot (entity index-1)}}
{{hl2msg|short|userid|}}
+
{{hl2msg|short|userid|user ID on server (unique on server)}}
{{hl2msg|string|networkid|}}
+
{{hl2msg|string|networkid|player network (i.e steam) id}}
{{hl2msg|string|address|}}
+
{{hl2msg|string|address|ip:port}}
 +
{{hl2msg|short|bot|is a bot}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 68: Line 69:
 
{{qnotice|A player changed his name}}
 
{{qnotice|A player changed his name}}
 
{{begin-hl2msg|player_info|string}}
 
{{begin-hl2msg|player_info|string}}
{{hl2msg|string|name|}}
+
{{hl2msg|string|name|player name}}
{{hl2msg|byte|index|}}
+
{{hl2msg|byte|index|player slot (entity index-1)}}
{{hl2msg|short|userid|}}
+
{{hl2msg|short|userid|user ID on server (unique on server)}}
{{hl2msg|string|networkid|}}
+
{{hl2msg|string|networkid|player network (i.e steam) id}}
{{hl2msg|bool|bot|}}
+
{{hl2msg|bool|bot|true if player is a AI bot}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 78: Line 79:
 
{{qnotice|A client was disconnected}}
 
{{qnotice|A client was disconnected}}
 
{{begin-hl2msg|player_disconnect|string}}
 
{{begin-hl2msg|player_disconnect|string}}
{{hl2msg|short|userid|}}
+
{{hl2msg|short|userid|user ID on server}}
{{hl2msg|string|reason|}}
+
{{hl2msg|string|reason|"self", "kick", "ban", "cheat", "error"}}
{{hl2msg|string|name|}}
+
{{hl2msg|string|name|player name}}
{{hl2msg|string|networkid|}}
+
{{hl2msg|string|networkid|player network (i.e steam) id}}
 +
{{hl2msg|short|bot|is a bot}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 87: Line 89:
 
{{qnotice|A client has entered the game (connected and loaded)}}
 
{{qnotice|A client has entered the game (connected and loaded)}}
 
{{begin-hl2msg|player_activate|string}}
 
{{begin-hl2msg|player_activate|string}}
{{hl2msg|short|userid|}}
+
{{hl2msg|short|userid|user ID on server}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 93: Line 95:
 
{{qnotice|When a client sends a message in chat}}
 
{{qnotice|When a client sends a message in chat}}
 
{{begin-hl2msg|player_say|string}}
 
{{begin-hl2msg|player_say|string}}
{{hl2msg|short|userid|}}
+
{{hl2msg|short|userid|user ID on server}}
{{hl2msg|string|text|}}
+
{{hl2msg|string|text|the say text}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}

Revision as of 09:45, 1 August 2013

Refer back to Game Events (Source) for more events.

These should apply to all Source Engine Servers

server_spawn

Note: Send once a server starts (spawns)

Name: server_spawn
Structure:
string hostname public host name
string address hostame, IP or DNS name
string port server port
string game game dir
string mapname map name
long maxplayers max players
string os WIN32, LINUX
bool dedicated true if dedicated server
bool password true if password protected


server_shutdown

Note: Server shut down

Name: server_shutdown
Structure:
string reason reason why server was shut down


server_cvar

Note: A server console var has changed

Name: server_cvar
Structure:
string cvarname cvar name, eg "mp_roundtime"
string cvarvalue new cvar value


server_messsage

Note: A generic server message

Name: server_message
Structure:
string text the message text


server_addban

Note: When the server has a ban added

Name: server_addban
Structure:
string name player name
string userid user ID on server
string networkid player network (i.e steam) id
string ip IP address
string duration length of the ban
string by banned by...
bool kicked whether the player was also kicked


server_removeban

Note: When the server has a ban removed

Name: server_removeban
Structure:
string networkid player network (i.e steam) id
string ip IP address
stsring by removed by...


player_connect

Note: A new client connected

Name: player_connect
Structure:
string name player name
byte index player slot (entity index-1)
short userid user ID on server (unique on server)
string networkid player network (i.e steam) id
string address ip:port
short bot is a bot


player_info

Note: A player changed his name

Name: player_info
Structure:
string name player name
byte index player slot (entity index-1)
short userid user ID on server (unique on server)
string networkid player network (i.e steam) id
bool bot true if player is a AI bot


player_disconnect

Note: A client was disconnected

Name: player_disconnect
Structure:
short userid user ID on server
string reason "self", "kick", "ban", "cheat", "error"
string name player name
string networkid player network (i.e steam) id
short bot is a bot


player_activate

Note: A client has entered the game (connected and loaded)

Name: player_activate
Structure:
short userid user ID on server


player_say

Note: When a client sends a message in chat

Name: player_say
Structure:
short userid user ID on server
string text the say text