Difference between revisions of "Zombie Panic! Source Events"
(Updated for ZPS 3.0) |
(Added and Updated all events for ZPS 3.0) |
||
Line 15: | Line 15: | ||
{{begin-hl2msg|player_connected|string}} | {{begin-hl2msg|player_connected|string}} | ||
{{hl2msg|string|name|name of the player that connected}} | {{hl2msg|string|name|name of the player that connected}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === player_disconnected === | ||
+ | {{qnotice|When a player leaves the server}}<br> | ||
+ | {{begin-hl2msg|player_disconnected|string}} | ||
+ | {{hl2msg|string|name|name of the player that left}} | ||
+ | {{hl2msg|short|flag}} | ||
+ | {{hl2msg|string|reason|reason why the player left}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === map_change === | ||
+ | {{qnotice|Called when the map changes}}<br> | ||
+ | {{begin-hl2msg|map_change|string}} | ||
+ | {{hl2msg|string|map|name of the map that is being switched to}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === zombie_lives === | ||
+ | {{qnotice|Called when the zombie lives changes}}<br> | ||
+ | {{begin-hl2msg|zombie_lives|string}} | ||
+ | {{hl2msg|byte|count|amount of zombie lives left}} | ||
{{end-hl2msg}} | {{end-hl2msg}} | ||
Line 20: | Line 40: | ||
{{qnotice|Called when a sound plays}}<br> | {{qnotice|Called when a sound plays}}<br> | ||
{{begin-hl2msg|ambient_play|string}} | {{begin-hl2msg|ambient_play|string}} | ||
− | {{hl2msg|string|sound| | + | {{hl2msg|string|sound|sound file which played}} |
− | {{hl2msg|bool|fade}} | + | {{hl2msg|short|entity|entity which the sound plays from}} |
+ | {{hl2msg|bool|fade|should the sound fade}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === force_song === | ||
+ | {{qnotice|Called when the logic_music entity changes the song}}<br> | ||
+ | {{begin-hl2msg|force_song_play|string}} | ||
+ | {{hl2msg|string|song|file path for the song}} | ||
+ | {{hl2msg|string|title|custom song title}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === ambient_as === | ||
+ | {{qnotice|Called when a sound is played from AngelScript}}<br> | ||
+ | {{begin-hl2msg|ambient_as|string}} | ||
+ | {{hl2msg|string|sound|sound being played}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === armmodel_as === | ||
+ | {{qnotice|Called when a new arm model is set from AngelScript}}<br> | ||
+ | {{begin-hl2msg|armmodel_as|string}} | ||
+ | {{hl2msg|string|model|arm model that should be used}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === spawned_player === | ||
+ | {{qnotice|Called when player has spawned}}<br> | ||
+ | {{begin-hl2msg|spawned_player|string}} | ||
+ | {{hl2msg|string|name|name of the player that spawned}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === angelscript_callevent === | ||
+ | {{qnotice|when AS calls the function CallEvent()}}<br> | ||
+ | {{begin-hl2msg|angelscript_callevent|string}} | ||
+ | {{hl2msg|short|clientid}} | ||
+ | {{hl2msg|string|hostname}} | ||
+ | {{hl2msg|string|serverip}} | ||
+ | {{hl2msg|string|serverport}} | ||
+ | {{hl2msg|string|model}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === cleanupmap === | ||
+ | {{qnotice|when the server calls CleanUpMap(), it will tell the client todo the same for temp and client sided entities}}<br> | ||
+ | {{begin-hl2msg|cleanupmap|string}} | ||
+ | {{hl2msg|None|None|None}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === round_begins=== | ||
+ | {{qnotice|When the round begins}}<br> | ||
+ | {{begin-hl2msg|round_begins|string}} | ||
+ | {{hl2msg|None|None|None}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === round_win=== | ||
+ | {{qnotice|When the round ends}}<br> | ||
+ | {{begin-hl2msg|round_win|string}} | ||
+ | {{hl2msg|string|mapname|name of the current map}} | ||
+ | {{hl2msg|bool|humanwin|true if survivors won}} | ||
{{end-hl2msg}} | {{end-hl2msg}} | ||
Line 39: | Line 114: | ||
{{qnotice|None}}<br> | {{qnotice|None}}<br> | ||
{{begin-hl2msg|achievement_earned|string}} | {{begin-hl2msg|achievement_earned|string}} | ||
− | {{hl2msg| | + | {{hl2msg|short|userid|player who earned the achievement}} |
− | {{hl2msg| | + | {{hl2msg|string|achid|achievement id}} |
+ | {{hl2msg|string|achtitle|title of the achievement}} | ||
{{end-hl2msg}} | {{end-hl2msg}} | ||
Line 47: | Line 123: | ||
{{begin-hl2msg|spec_target_updated|string}} | {{begin-hl2msg|spec_target_updated|string}} | ||
{{hl2msg|none|none}} | {{hl2msg|none|none}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === zp_washuman === | ||
+ | {{qnotice|The player was a human player before we turned into zombie team (Only applies if there is no zombie lives left, or if the zombies won)}}<br> | ||
+ | {{begin-hl2msg|zp_washuman|string}} | ||
+ | {{hl2msg|short|userid|player that turned into a zombie}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | |||
+ | === zp_infected === | ||
+ | {{qnotice|Calls whenever someone got infected}}<br> | ||
+ | {{begin-hl2msg|zp_infected|string}} | ||
+ | {{hl2msg|short|userid|player that got infected}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === zp_entitypickedup === | ||
+ | {{qnotice|Calls whenever a button is pressed, or if an item is picked up}}<br> | ||
+ | {{begin-hl2msg|zp_entitypickedup|string}} | ||
+ | {{hl2msg|string|entkey|name of the button that is pressed or entity that is picked up}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === general_hint === | ||
+ | {{qnotice|None}}<br> | ||
+ | {{begin-hl2msg|general_hint|string}} | ||
+ | {{hl2msg|short|userid|the player who activated it}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === movement_hint === | ||
+ | {{qnotice|None}}<br> | ||
+ | {{begin-hl2msg|movement_hint|string}} | ||
+ | {{hl2msg|short|userid|the player who needs the hint}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === movement_hint_success === | ||
+ | {{qnotice|None}}<br> | ||
+ | {{begin-hl2msg|movement_hint_success|string}} | ||
+ | {{hl2msg|short|userid|the player succeeded}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | |||
+ | === gameinstructor_draw === | ||
+ | {{qnotice|None}}<br> | ||
+ | {{begin-hl2msg|gameinstructor_draw|string}} | ||
+ | {{hl2msg|None|None|None}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === gameinstructor_nodraw === | ||
+ | {{qnotice|None}}<br> | ||
+ | {{begin-hl2msg|gameinstructor_nodraw|string}} | ||
+ | {{hl2msg|None|None|None}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === set_instructor_group_enabled === | ||
+ | {{qnotice|None}}<br> | ||
+ | {{begin-hl2msg|set_instructor_group_enabled|string}} | ||
+ | {{hl2msg|string|group}} | ||
+ | {{hl2msg|short|enabled}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === instructor_tutor === | ||
+ | {{qnotice|Called from the instructor tutorial}}<br> | ||
+ | {{begin-hl2msg|instructor_tutor|string}} | ||
+ | {{hl2msg|long|userid}} | ||
+ | {{hl2msg|long|entindex}} | ||
+ | {{hl2msg|string|strbind}} | ||
+ | {{hl2msg|string|strmsg}} | ||
+ | {{hl2msg|string|icon_onscreen}} | ||
+ | {{hl2msg|string|icon_offscreen}} | ||
+ | {{hl2msg|bool|nooffscreen}} | ||
+ | {{hl2msg|int|posx}} | ||
+ | {{hl2msg|int|posy}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === instructor_server_hint_create === | ||
+ | {{qnotice|create a hint using data supplied entirely by the server/map. Intended for hints to smooth playtests before content is ready to make the hint unneccessary. NOT INTENDED AS A SHIPPABLE CRUTCH}}<br> | ||
+ | {{begin-hl2msg|instructor_server_hint_create|string}} | ||
+ | {{hl2msg|string|hint_name|what to name the hint. For referencing it again later (e.g. a kill command for the hint instead of a timeout)}} | ||
+ | {{hl2msg|string|hint_replace_key|type name so that messages of the same type will replace each other}} | ||
+ | {{hl2msg|long|hint_target|entity id that the hint should display at}} | ||
+ | {{hl2msg|long|hint_instance|the hint instance}} | ||
+ | {{hl2msg|short|hint_activator_userid|userid id of the activator}} | ||
+ | {{hl2msg|short|hint_timeout|how long in seconds until the hint automatically times out, 0 means never}} | ||
+ | {{hl2msg|string|hint_icon_onscreen|the hint icon to use when the hint is onscreen. e.g. "icon_alert_red"}} | ||
+ | {{hl2msg|string|hint_icon_offscreen|the hint icon to use when the hint is offscreen. e.g. "icon_alert"}} | ||
+ | {{hl2msg|string|hint_caption|the hint caption. e.g. "#ThisIsDangerous"}} | ||
+ | {{hl2msg|string|hint_activator_caption|the hint caption that only the activator sees e.g. "#YouPushedItGood"}} | ||
+ | {{hl2msg|string|hint_color|the hint color in "r,g,b" format where each component is 0-255}} | ||
+ | {{hl2msg|float|hint_icon_offset|how far on the z axis to offset the hint from entity origin}} | ||
+ | {{hl2msg|float|hint_range|range before the hint is culled}} | ||
+ | {{hl2msg|long|hint_flags|hint flags}} | ||
+ | {{hl2msg|string|hint_binding|bindings to use when use_binding is the onscreen icon}} | ||
+ | {{hl2msg|bool|hint_allow_nodraw_target|if false, the hint will dissappear if the target entity is invisible}} | ||
+ | {{hl2msg|bool|hint_nooffscreen|if true, the hint will not show when outside the player view}} | ||
+ | {{hl2msg|bool|hint_forcecaption|if true, the hint caption will show even if the hint is occluded}} | ||
+ | {{hl2msg|bool|hint_local_player_only|if true, only the local player will see the hint}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === instructor_server_hint_stop === | ||
+ | {{qnotice|destroys a server/map created hint}}<br> | ||
+ | {{begin-hl2msg|instructor_server_hint_stop|string}} | ||
+ | {{hl2msg|string|hint_name|The hint to stop. Will stop ALL hints with this name}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === instructor_survivor_supply === | ||
+ | {{qnotice|None}}<br> | ||
+ | {{begin-hl2msg|instructor_survivor_supply|string}} | ||
+ | {{hl2msg|long|hint_player|entity id that the hint will display for}} | ||
+ | {{hl2msg|long|hint_target|entity id that the hint should display at}} | ||
+ | {{hl2msg|string|hint_caption|the hint caption. e.g. "#ThisIsDangerous"}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === logicrounds_start === | ||
+ | {{qnotice|Called when the round has started (from logic_rounds)}}<br> | ||
+ | {{begin-hl2msg|logicrounds_start|string}} | ||
+ | {{hl2msg|None|None|None}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === logicrounds_end === | ||
+ | {{qnotice|Called when the round ends (from logic_rounds)}}<br> | ||
+ | {{begin-hl2msg|logicrounds_end|string}} | ||
+ | {{hl2msg|None|None|None}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === set_text === | ||
+ | {{qnotice|Called when AS sets the win text}}<br> | ||
+ | {{begin-hl2msg|set_text|string}} | ||
+ | {{hl2msg|string|txt}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === vote_ended === | ||
+ | {{qnotice|Called when a vote has ended}}<br> | ||
+ | {{begin-hl2msg|vote_ended|string}} | ||
+ | {{hl2msg|None|None|None}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === vote_generic_created === | ||
+ | {{qnotice|Called when a generic vote has been created}}<br> | ||
+ | {{begin-hl2msg|vote_generic_created|string}} | ||
+ | {{hl2msg|None|None|None}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === vote_generic_clr === | ||
+ | {{qnotice|None}}<br> | ||
+ | {{begin-hl2msg|vote_generic_clr|string}} | ||
+ | {{hl2msg|string|option}} | ||
+ | {{hl2msg|long|red}} | ||
+ | {{hl2msg|long|green}} | ||
+ | {{hl2msg|long|blue}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === vote_started === | ||
+ | {{qnotice|Called when a vote started}}<br> | ||
+ | {{begin-hl2msg|vote_started|string}} | ||
+ | {{hl2msg|string|issue}} | ||
+ | {{hl2msg|string|param1}} | ||
+ | {{hl2msg|byte|team}} | ||
+ | {{hl2msg|long|initiator|entity id of the player who initiated the vote}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === vote_changed === | ||
+ | {{qnotice|Called when a vote changed}}<br> | ||
+ | {{begin-hl2msg|vote_changed|string}} | ||
+ | {{hl2msg|byte|vote_option1}} | ||
+ | {{hl2msg|byte|vote_option2}} | ||
+ | {{hl2msg|byte|vote_option3}} | ||
+ | {{hl2msg|byte|vote_option4}} | ||
+ | {{hl2msg|byte|vote_option5}} | ||
+ | {{hl2msg|byte|yesVotes}} | ||
+ | {{hl2msg|byte|noVotes}} | ||
+ | {{hl2msg|byte|potentialVotes}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === vote_passed === | ||
+ | {{qnotice|Called when a vote passed}}<br> | ||
+ | {{begin-hl2msg|vote_passed|string}} | ||
+ | {{hl2msg|string|details}} | ||
+ | {{hl2msg|string|param1}} | ||
+ | {{hl2msg|byte|team}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | === vote_failed === | ||
+ | {{qnotice|Called when a vote failed}}<br> | ||
+ | {{begin-hl2msg|vote_passed|string}} | ||
+ | {{hl2msg|byte|team}} | ||
+ | {{end-hl2msg}} | ||
+ | |||
+ | |||
+ | === vote_cast === | ||
+ | {{qnotice|None}}<br> | ||
+ | {{begin-hl2msg|vote_cast|string}} | ||
+ | {{hl2msg|byte|vote|yes/no vote}} | ||
+ | {{hl2msg|byte|team}} | ||
+ | {{hl2msg|long|entityid|entity id of the voter}} | ||
{{end-hl2msg}} | {{end-hl2msg}} |
Revision as of 10:25, 19 December 2017
- Refer back to Game Events (Source) for more events.
Contents
- 1 player_death
- 2 player_connected
- 3 player_disconnected
- 4 map_change
- 5 zombie_lives
- 6 ambient_play
- 7 force_song
- 8 ambient_as
- 9 armmodel_as
- 10 spawned_player
- 11 angelscript_callevent
- 12 cleanupmap
- 13 round_begins
- 14 round_win
- 15 game_round_restart
- 16 gravity_change
- 17 achievement_earned
- 18 spec_target_updated
- 19 zp_washuman
- 20 zp_infected
- 21 zp_entitypickedup
- 22 general_hint
- 23 movement_hint
- 24 movement_hint_success
- 25 gameinstructor_draw
- 26 gameinstructor_nodraw
- 27 set_instructor_group_enabled
- 28 instructor_tutor
- 29 instructor_server_hint_create
- 30 instructor_server_hint_stop
- 31 instructor_survivor_supply
- 32 logicrounds_start
- 33 logicrounds_end
- 34 set_text
- 35 vote_ended
- 36 vote_generic_created
- 37 vote_generic_clr
- 38 vote_started
- 39 vote_changed
- 40 vote_passed
- 41 vote_failed
- 42 vote_cast
player_death
Note: When a player dies
Name: | player_death | ||||||||||||||||||
Structure: |
|
player_connected
Note: When a player joins the server
Name: | player_connected | |||
Structure: |
|
player_disconnected
Note: When a player leaves the server
Name: | player_disconnected | |||||||||
Structure: |
|
map_change
Note: Called when the map changes
Name: | map_change | |||
Structure: |
|
zombie_lives
Note: Called when the zombie lives changes
Name: | zombie_lives | |||
Structure: |
|
ambient_play
Note: Called when a sound plays
Name: | ambient_play | |||||||||
Structure: |
|
force_song
Note: Called when the logic_music entity changes the song
Name: | force_song_play | ||||||
Structure: |
|
ambient_as
Note: Called when a sound is played from AngelScript
Name: | ambient_as | |||
Structure: |
|
armmodel_as
Note: Called when a new arm model is set from AngelScript
Name: | armmodel_as | |||
Structure: |
|
spawned_player
Note: Called when player has spawned
Name: | spawned_player | |||
Structure: |
|
angelscript_callevent
Note: when AS calls the function CallEvent()
Name: | angelscript_callevent | |||||||||||||||
Structure: |
|
cleanupmap
Note: when the server calls CleanUpMap(), it will tell the client todo the same for temp and client sided entities
Name: | cleanupmap | |||
Structure: |
|
round_begins
Note: When the round begins
Name: | round_begins | |||
Structure: |
|
round_win
Note: When the round ends
Name: | round_win | ||||||
Structure: |
|
game_round_restart
Note: When one team won the round and players can select their team again
Name: | game_round_restart | |||
Structure: |
|
gravity_change
Note: When the gravity changes
Name: | gravity_change | |||
Structure: |
|
achievement_earned
Note: None
Name: | achievement_earned | |||||||||
Structure: |
|
spec_target_updated
Note: None
Name: | spec_target_updated | |||
Structure: |
|
zp_washuman
Note: The player was a human player before we turned into zombie team (Only applies if there is no zombie lives left, or if the zombies won)
Name: | zp_washuman | |||
Structure: |
|
zp_infected
Note: Calls whenever someone got infected
Name: | zp_infected | |||
Structure: |
|
zp_entitypickedup
Note: Calls whenever a button is pressed, or if an item is picked up
Name: | zp_entitypickedup | |||
Structure: |
|
general_hint
Note: None
Name: | general_hint | |||
Structure: |
|
movement_hint
Note: None
Name: | movement_hint | |||
Structure: |
|
movement_hint_success
Note: None
Name: | movement_hint_success | |||
Structure: |
|
gameinstructor_draw
Note: None
Name: | gameinstructor_draw | |||
Structure: |
|
gameinstructor_nodraw
Note: None
Name: | gameinstructor_nodraw | |||
Structure: |
|
set_instructor_group_enabled
Note: None
Name: | set_instructor_group_enabled | ||||||
Structure: |
|
instructor_tutor
Note: Called from the instructor tutorial
Name: | instructor_tutor | |||||||||||||||||||||||||||
Structure: |
|
instructor_server_hint_create
Note: create a hint using data supplied entirely by the server/map. Intended for hints to smooth playtests before content is ready to make the hint unneccessary. NOT INTENDED AS A SHIPPABLE CRUTCH
Name: | instructor_server_hint_create | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Structure: |
|
instructor_server_hint_stop
Note: destroys a server/map created hint
Name: | instructor_server_hint_stop | |||
Structure: |
|
instructor_survivor_supply
Note: None
Name: | instructor_survivor_supply | |||||||||
Structure: |
|
logicrounds_start
Note: Called when the round has started (from logic_rounds)
Name: | logicrounds_start | |||
Structure: |
|
logicrounds_end
Note: Called when the round ends (from logic_rounds)
Name: | logicrounds_end | |||
Structure: |
|
set_text
Note: Called when AS sets the win text
Name: | set_text | |||
Structure: |
|
vote_ended
Note: Called when a vote has ended
Name: | vote_ended | |||
Structure: |
|
vote_generic_created
Note: Called when a generic vote has been created
Name: | vote_generic_created | |||
Structure: |
|
vote_generic_clr
Note: None
Name: | vote_generic_clr | ||||||||||||
Structure: |
|
vote_started
Note: Called when a vote started
Name: | vote_started | ||||||||||||
Structure: |
|
vote_changed
Note: Called when a vote changed
Name: | vote_changed | ||||||||||||||||||||||||
Structure: |
|
vote_passed
Note: Called when a vote passed
Name: | vote_passed | |||||||||
Structure: |
|
vote_failed
Note: Called when a vote failed
Name: | vote_passed | |||
Structure: |
|
vote_cast
Note: None
Name: | vote_cast | |||||||||
Structure: |
|