Difference between revisions of "Generic Source Events"

From AlliedModders Wiki
Jump to: navigation, search
Line 5: Line 5:
 
{{qnotice|Info about team}}<br>
 
{{qnotice|Info about team}}<br>
 
{{begin-hl2msg|team_info|string}}
 
{{begin-hl2msg|team_info|string}}
{{hl2msg|byte|teamid}}
+
{{hl2msg|byte|teamid|unique team id}}
{{hl2msg|string|teamname}}
+
{{hl2msg|string|teamname|team name eg "Team Blue"}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 12: Line 12:
 
{{qnotice|Team score changed}}<br>
 
{{qnotice|Team score changed}}<br>
 
{{begin-hl2msg|team_info|string}}
 
{{begin-hl2msg|team_info|string}}
{{hl2msg|byte|teamid}}
+
{{hl2msg|byte|teamid|team id}}
{{hl2msg|short|score}}
+
{{hl2msg|short|score|total team score}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 19: Line 19:
 
{{qnotice|Player change his team}}<br>
 
{{qnotice|Player change his team}}<br>
 
{{begin-hl2msg|player_team|string}}
 
{{begin-hl2msg|player_team|string}}
{{hl2msg|short|userid}}
+
{{hl2msg|short|userid|user ID on the server}}
{{hl2msg|byte|team}}
+
{{hl2msg|byte|team|team id}}
{{hl2msg|byte|oldteam}}
+
{{hl2msg|byte|oldteam|old team id}}
{{hl2msg|bool|disconnect}}
+
{{hl2msg|bool|disconnect|team change because player disconnects}}
 +
{{hl2msg|bool|autoteam|true if the player was auto assigned to the team (OB only)}}
 +
{{hl2msg|bool|silent|if true wont print the team join messages (OB only)}}
 +
{{hl2msg|string|name|player's name (OB only)}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 28: Line 31:
 
{{qnotice|A player changed his class}}<br>
 
{{qnotice|A player changed his class}}<br>
 
{{begin-hl2msg|player_class|string}}
 
{{begin-hl2msg|player_class|string}}
{{hl2msg|short|userid}}
+
{{hl2msg|short|userid|user ID on server}}
{{hl2msg|string|class}}
+
{{hl2msg|string|class|new player class / model}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
 
=== player_death ===
 
=== player_death ===
{{qnotice|A game event, name may be 32 characters long}}<br>
+
{{qnotice|A player has died}}<br>
 
{{begin-hl2msg|player_death|string}}
 
{{begin-hl2msg|player_death|string}}
{{hl2msg|short|userid}}
+
{{hl2msg|short|userid|user ID who died}}
{{hl2msg|short|attacker}}
+
{{hl2msg|short|attacker|user ID who killed}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 42: Line 45:
 
{{qnotice|A player was hurt}}<br>
 
{{qnotice|A player was hurt}}<br>
 
{{begin-hl2msg|player_hurt|string}}
 
{{begin-hl2msg|player_hurt|string}}
{{hl2msg|short|userid}}
+
{{hl2msg|short|userid|player index who was hurt}}
{{hl2msg|short|attacker}}
+
{{hl2msg|short|attacker|player index who attacked}}
{{hl2msg|byte|health}}
+
{{hl2msg|byte|health|remaining health points}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 50: Line 53:
 
{{qnotice|A public player chat}}<br>
 
{{qnotice|A public player chat}}<br>
 
{{begin-hl2msg|player_chat|string}}
 
{{begin-hl2msg|player_chat|string}}
{{hl2msg|bool|teamonly}}
+
{{hl2msg|bool|teamonly|true if team only chat}}
{{hl2msg|short|userid}}
+
{{hl2msg|short|userid|chatting player}}
{{hl2msg|string|text}}
+
{{hl2msg|string|text|chat text}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
 
=== player_score ===
 
=== player_score ===
{{qnotice|Players scores changed}}<br>
+
{{qnotice|Player's scores changed}}<br>
 
{{begin-hl2msg|player_score|string}}
 
{{begin-hl2msg|player_score|string}}
{{hl2msg|short|userid}}
+
{{hl2msg|short|userid|user ID on server}}
{{hl2msg|short|kills}}
+
{{hl2msg|short|kills|# of kills}}
{{hl2msg|short|deaths}}
+
{{hl2msg|short|deaths|# of deaths}}
{{hl2msg|short|score}}
+
{{hl2msg|short|score|total game score}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
 
=== player_spawn ===
 
=== player_spawn ===
{{qnotice|player spawned in game}}<br>
+
{{qnotice|Player spawned in game}}<br>
 
{{begin-hl2msg|player_spawn|string}}
 
{{begin-hl2msg|player_spawn|string}}
{{hl2msg|short|userid}}
+
{{hl2msg|short|userid|user ID on server}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
 
=== player_shoot ===
 
=== player_shoot ===
{{qnotice|Player shoot his weapon}}<br>
+
{{qnotice|Player shot his weapon}}<br>
 
{{begin-hl2msg|player_shoot|string}}
 
{{begin-hl2msg|player_shoot|string}}
{{hl2msg|short|userid}}
+
{{hl2msg|short|userid|user ID on server}}
{{hl2msg|byte|weapon}}
+
{{hl2msg|byte|weapon|weapon ID}}
{{hl2msg|byte|mode}}
+
{{hl2msg|byte|mode|weapon mode}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 81: Line 84:
 
{{qnotice|When a player uses an option}}<br>
 
{{qnotice|When a player uses an option}}<br>
 
{{begin-hl2msg|player_use|string}}
 
{{begin-hl2msg|player_use|string}}
{{hl2msg|short|userid}}
+
{{hl2msg|short|userid|user ID on server}}
{{hl2msg|short|entity}}
+
{{hl2msg|short|entity|entity used by player}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 88: Line 91:
 
{{qnotice|Player changed name}}<br>
 
{{qnotice|Player changed name}}<br>
 
{{begin-hl2msg|player_changename|string}}
 
{{begin-hl2msg|player_changename|string}}
{{hl2msg|string|userid}}
+
{{hl2msg|string|userid|user ID on server}}
{{hl2msg|string|oldname}}
+
{{hl2msg|string|oldname|players old (current) name}}
{{hl2msg|string|newname}}
+
{{hl2msg|string|newname|players new name}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
 +
 +
=== game_init ===
 +
{{qnotice|Sent when a new game is started (OB only)}}<br>
  
 
=== game_newmap ===
 
=== game_newmap ===
{{qnotice|Send when new map is completely loaded}}<br>
+
{{qnotice|Sent when new map is completely loaded}}<br>
 
{{begin-hl2msg|game_newmap|string}}
 
{{begin-hl2msg|game_newmap|string}}
{{hl2msg|string|mapname}}
+
{{hl2msg|string|mapname|map name}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 102: Line 108:
 
{{qnotice|A new game starts}}<br>
 
{{qnotice|A new game starts}}<br>
 
{{begin-hl2msg|game_start|string}}
 
{{begin-hl2msg|game_start|string}}
{{hl2msg|long|roundslimit}}
+
{{hl2msg|long|roundslimit|max round}}
{{hl2msg|long|timelimit}}
+
{{hl2msg|long|timelimit|time limit}}
{{hl2msg|long|fraglimit}}
+
{{hl2msg|long|fraglimit|frag limit}}
{{hl2msg|string|objective}}
+
{{hl2msg|string|objective|round objective}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 111: Line 117:
 
{{qnotice|A game ended}}<br>
 
{{qnotice|A game ended}}<br>
 
{{begin-hl2msg|game_end|string}}
 
{{begin-hl2msg|game_end|string}}
{{hl2msg|byte|winner}}
+
{{hl2msg|byte|winner|winner team/user id}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 117: Line 123:
 
{{qnotice|The round started}}<br>
 
{{qnotice|The round started}}<br>
 
{{begin-hl2msg|round_start|string}}
 
{{begin-hl2msg|round_start|string}}
{{hl2msg|long|timelimit}}
+
{{hl2msg|long|timelimit|round time limit in seconds}}
{{hl2msg|long|fraglimit}}
+
{{hl2msg|long|fraglimit|frag limit}}
{{hl2msg|string|objective}}
+
{{hl2msg|string|objective|round objective}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 125: Line 131:
 
{{qnotice|The round ended}}<br>
 
{{qnotice|The round ended}}<br>
 
{{begin-hl2msg|round_end|string}}
 
{{begin-hl2msg|round_end|string}}
{{hl2msg|byte|winner}}
+
{{hl2msg|byte|winner|winner team/user id}}
{{hl2msg|byte|reason}}
+
{{hl2msg|byte|reason|reason why the team won}}
{{hl2msg|string|message}}
+
{{hl2msg|string|message|end round message}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
 
=== game_message ===
 
=== game_message ===
{{qnotice|A game message}}<br>
+
{{qnotice|A message sent by game logic to everyone}}<br>
 
{{begin-hl2msg|game_message|string}}
 
{{begin-hl2msg|game_message|string}}
{{hl2msg|byte|target}}
+
{{hl2msg|byte|target|0 console, 1 HUD}}
{{hl2msg|string|text}}
+
{{hl2msg|string|text|the message text}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 140: Line 146:
 
{{qnotice|A breakable (func_break) is broken.}}<br>
 
{{qnotice|A breakable (func_break) is broken.}}<br>
 
{{begin-hl2msg|break_breakable|string}}
 
{{begin-hl2msg|break_breakable|string}}
{{hl2msg|long|entindex}}
+
{{hl2msg|long|entindex|index of the entity}}
{{hl2msg|short|userid}}
+
{{hl2msg|short|userid|userid who broke the entity}}
{{hl2msg|byte|material}}
+
{{hl2msg|byte|material|BREAK_GLASS, BREAK_WOOD, etc}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}
  
Line 148: Line 154:
 
{{qnotice|A breakable prop is broken.}}<br>
 
{{qnotice|A breakable prop is broken.}}<br>
 
{{begin-hl2msg|break_prop|string}}
 
{{begin-hl2msg|break_prop|string}}
{{hl2msg|long|entindex}}
+
{{hl2msg|long|entindex|index of the entity}}
{{hl2msg|short|userid}}
+
{{hl2msg|short|userid|userid who broke the entity}}
 +
{{end-hl2msg}}
 +
 
 +
=== entity_killed ===
 +
{{qnotice|An entity has been killed (OB only)}}<br>
 +
{{begin-hl2msg|entity_killed|string}}
 +
{{hl2msg|long|entindex_killed|index of the killed entity}}
 +
{{hl2msg|long|entindex_attacker|index of the attacker}}
 +
{{hl2msg|long|entindex_inflictor|index of the inflictor (weapon id, etc)}}
 +
{{hl2msg|long|damagebits|the damagebits of the attack}}
 +
{{end-hl2msg}}
 +
 
 +
=== bonus_updated ===
 +
{{qnotice|??? (OB only)}}<br>
 +
{{begin-hl2msg|bonus_updated|string}}
 +
{{hl2msg|short|numadvanced|}}
 +
{{hl2msg|short|numbronze|}}
 +
{{hl2msg|short|numsilver|}}
 +
{{hl2msg|short|numgold|}}
 +
{{end-hl2msg}}
 +
 
 +
=== achievement_event ===
 +
{{qnotice|A player has received an achievement (OB only)}}<br>
 +
{{begin-hl2msg|achievement_earned|string}}
 +
{{hl2msg|string|achievement_name|non-localized name of achievement}}
 +
{{hl2msg|short|cur_val|# of steps toward achievement}}
 +
{{hl2msg|short|max_val|total # of steps in achievement}}
 +
{{end-hl2msg}}
 +
 
 +
=== achievement_increment ===
 +
{{qnotice|Sent whenever an achievement that's tracked on the HUD increases (OB only)}}<br>
 +
{{begin-hl2msg|achievement_increment|string}}
 +
{{hl2msg|long|achievement_id|ID of achievement that went up}}
 +
{{hl2msg|short|cur_val|# of steps toward achievement}}
 +
{{hl2msg|short|max_val|total # of steps in achievement}}
 +
{{end-hl2msg}}
 +
 
 +
=== physgun_pickup ===
 +
{{qnotice|Player picked up a physgun (OB only)}}<br>
 +
{{begin-hl2msg|physgun_pickup|string}}
 +
{{hl2msg|long|entindex|entity picked up}}
 +
{{end-hl2msg}}
 +
 
 +
=== flare_ignite_npc ===
 +
{{qnotice|A flare has ignited a NPC (OB only)}}<br>
 +
{{begin-hl2msg|flare_ignite_npc|string}}
 +
{{hl2msg|long|entindex|entity ignited}}
 +
{{end-hl2msg}}
 +
 
 +
=== helicopter_grenade_punt_miss ===
 +
{{qnotice|??? (OB only)}}<br>
 +
 
 +
=== user_data_downloaded ===
 +
{{qnotice|Fired when achievements/stats are downloaded from Steam or XBOX Live (OB only)}}<br>
 +
 
 +
=== ragdoll_dissolved ===
 +
{{qnotice|A ragdoll has dissolved (OB only)}}<br>
 +
{{begin-hl2msg|ragdoll_dissolved|string}}
 +
{{hl2msg|long|entindex|index of the dissolved entity}}
 
{{end-hl2msg}}
 
{{end-hl2msg}}

Revision as of 11:37, 24 April 2009

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

These should apply to all Source engine games

team_info

Note: Info about team

Name: team_info
Structure:
byte teamid unique team id
string teamname team name eg "Team Blue"


team_score

Note: Team score changed

Name: team_info
Structure:
byte teamid team id
short score total team score


player_team

Note: Player change his team

Name: player_team
Structure:
short userid user ID on the server
byte team team id
byte oldteam old team id
bool disconnect team change because player disconnects
bool autoteam true if the player was auto assigned to the team (OB only)
bool silent if true wont print the team join messages (OB only)
string name player's name (OB only)


player_class

Note: A player changed his class

Name: player_class
Structure:
short userid user ID on server
string class new player class / model


player_death

Note: A player has died

Name: player_death
Structure:
short userid user ID who died
short attacker user ID who killed


player_hurt

Note: A player was hurt

Name: player_hurt
Structure:
short userid player index who was hurt
short attacker player index who attacked
byte health remaining health points


player_chat

Note: A public player chat

Name: player_chat
Structure:
bool teamonly true if team only chat
short userid chatting player
string text chat text


player_score

Note: Player's scores changed

Name: player_score
Structure:
short userid user ID on server
short kills # of kills
short deaths # of deaths
short score total game score


player_spawn

Note: Player spawned in game

Name: player_spawn
Structure:
short userid user ID on server


player_shoot

Note: Player shot his weapon

Name: player_shoot
Structure:
short userid user ID on server
byte weapon weapon ID
byte mode weapon mode


player_use

Note: When a player uses an option

Name: player_use
Structure:
short userid user ID on server
short entity entity used by player


player_changename

Note: Player changed name

Name: player_changename
Structure:
string userid user ID on server
string oldname players old (current) name
string newname players new name


game_init

Note: Sent when a new game is started (OB only)

game_newmap

Note: Sent when new map is completely loaded

Name: game_newmap
Structure:
string mapname map name


game_start

Note: A new game starts

Name: game_start
Structure:
long roundslimit max round
long timelimit time limit
long fraglimit frag limit
string objective round objective


game_end

Note: A game ended

Name: game_end
Structure:
byte winner winner team/user id


round_start

Note: The round started

Name: round_start
Structure:
long timelimit round time limit in seconds
long fraglimit frag limit
string objective round objective


round_end

Note: The round ended

Name: round_end
Structure:
byte winner winner team/user id
byte reason reason why the team won
string message end round message


game_message

Note: A message sent by game logic to everyone

Name: game_message
Structure:
byte target 0 console, 1 HUD
string text the message text


break_breakable

Note: A breakable (func_break) is broken.

Name: break_breakable
Structure:
long entindex index of the entity
short userid userid who broke the entity
byte material BREAK_GLASS, BREAK_WOOD, etc


break_prop

Note: A breakable prop is broken.

Name: break_prop
Structure:
long entindex index of the entity
short userid userid who broke the entity


entity_killed

Note: An entity has been killed (OB only)

Name: entity_killed
Structure:
long entindex_killed index of the killed entity
long entindex_attacker index of the attacker
long entindex_inflictor index of the inflictor (weapon id, etc)
long damagebits the damagebits of the attack


bonus_updated

Note: ??? (OB only)

Name: bonus_updated
Structure:
short numadvanced
short numbronze
short numsilver
short numgold


achievement_event

Note: A player has received an achievement (OB only)

Name: achievement_earned
Structure:
string achievement_name non-localized name of achievement
short cur_val # of steps toward achievement
short max_val total # of steps in achievement


achievement_increment

Note: Sent whenever an achievement that's tracked on the HUD increases (OB only)

Name: achievement_increment
Structure:
long achievement_id ID of achievement that went up
short cur_val # of steps toward achievement
short max_val total # of steps in achievement


physgun_pickup

Note: Player picked up a physgun (OB only)

Name: physgun_pickup
Structure:
long entindex entity picked up


flare_ignite_npc

Note: A flare has ignited a NPC (OB only)

Name: flare_ignite_npc
Structure:
long entindex entity ignited


helicopter_grenade_punt_miss

Note: ??? (OB only)

user_data_downloaded

Note: Fired when achievements/stats are downloaded from Steam or XBOX Live (OB only)

ragdoll_dissolved

Note: A ragdoll has dissolved (OB only)

Name: ragdoll_dissolved
Structure:
long entindex index of the dissolved entity