Point clientcommand: Difference between revisions

Revision as of 14:07, 22 November 2022

Class hierarchy
CPointClientCommand ↳CPointEntity ↳CBaseEntity
`client.cpp`

Template:Base point It issues commands to the client console as if they were typed manually by the player. The client commands are sent as parameters of the Command input. One instance of the entity is ever needed in a map.

In multiplayer games, the commands are only executed on the Activator's client. If the activator was not a player, then it simply won't do anything (unless it's in commentary mode; then the command will be executed from the first player). If you require all players to execute the command, use the point_broadcastclientcommand entity instead.

This command (in conjunction with point_servercommand and the config (cfg) file) used to allow a client to cheat on multiplayer servers through changing player names, execute client commands, and other things. On multiplayer servers, any command that DOES NOT HAVE the FCVAR_SERVER_CAN_EXECUTE flag set cannot be executed by this entity; any attempt will be reported and blocked.

Keyvalues

Name (targetname) <string>[ Edit ]: The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report. See also: Generic Keyvalues, Inputs and Outputs available to all entities

Inputs

Command <stringRedirectInput/string>: Command to execute.
Bug:In Hammer, using " symbol in parameter field will corrupt the VMF file's structure, making the file unviewable for the next Hammer session. [todo tested in ?]; Fix:Remove the string argument manually with a text editor.

Usable ConVars/ConCommands

Note:Only

cvar list was considered

Following commands have "server_can_execute" flag.

ConCommands

Cvar/Command	Parameters or default value	Descriptor	Effect
`echo`	`<string>`		Echo text to console.
`cancelselect`			In style hud cancels currently selected weapon
`invnext`
`invprev`
`lastinv`
`slot0 - slot10`
`(only in )cl_consistencycheck`	`cmd`		Triggers the client to perform a consistency check
`cl_soundscape_flush`			Flushes the client side soundscapes
`play`	`<string>`	<sound path>	Play a sound.
`playgamesound`	`<string>`	<soundscript>	Play a sound from the game sounds txt file
`snd_playsounds`	`<string> [<float> <float> <float>]`	<soundscript> [<x> <y> <z>]	Play sounds from the game sounds txt file at a given location
`snd_setsoundparam`	`<string> <volume <float 0.0-1.0> \|level SNDLVL_<int 1-179>>`	<soundscript> <volume <vol> \|level SNDLVL_<db>>	Can change level or volume of a soundscript. examples: `snd_setsoundparam Flaregun.Detonate volume 0.1` `snd_setsoundparam Flaregun.Detonate level SNDLVL_120`
`retry`			Retry connection to last server.
`rpt_connect`
`r_screenoverlay Bug:Also has cheat flag and cannot be used in Todo: confirm other games [todo tested in ?]`	`<string>`		Draw specified material as an overlay

ConVars

Cvar/Command	Parameters or default value	Effect
`cl_ideal_spec_mode`	`5`	desired spectator mode (4 = in-eye, 5 = chase, 6 = roaming)
`cl_session`
`dsp_player`	`0`
`name`	`step`	Current user name
`name2`	`unnamed`	Current user name

@@ Line 2: / Line 2: @@
 {{CD|CPointClientCommand|file1=client.cpp}}
 {{base point|point_clientcommand}} It issues commands to the client console as if they were typed manually by the player. The client commands are sent as parameters of the ''Command'' [[input]]. One instance of the entity is ever needed in a map.
 In multiplayer games, the commands are only executed on the [[Activator]]'s client. If the activator was not a player, then it simply won't do anything (unless it's in commentary mode; then the command will be executed from the first player). If you require all players to execute the command, use the [[point_broadcastclientcommand]] entity instead.
@@ Line 20: / Line 19: @@
 === ConCommands ===
 {{varcom|start}}
+{{varcom|echo|<string>||Echo text to console.}}
 {{varcom|cancelselect|||In {{hl2}} style hud cancels currently selected weapon}}
-{{varcom|cl_consistencycheck|cmd||Triggers the client to perform a consistency check}}
-{{varcom|cl_soundscape_flush|cmd||Flushes the client side soundscapes}}
-{{varcom|echo|<string>||Echo text to console.}}
 {{varcom|invnext|||}}
 {{varcom|invprev|||}}
 {{varcom|lastinv|||}}
-{{varcom|play|cmd||Play a sound.}}
+{{varcom|slot0 - slot10|||}}
+{{varcom|{{only|{{l4d2}}}}cl_consistencycheck|cmd||Triggers the client to perform a consistency check}}
+{{varcom|cl_soundscape_flush|||Flushes the client side soundscapes}}
+{{varcom|play|<string>|<sound path>|Play a sound.}}
 {{varcom|playgamesound|<string>|<soundscript>|Play a sound from the game sounds txt file}}
+{{varcom|snd_playsounds|<string> [<float> <float> <float>]|<soundscript> [<x> <y> <z>]|Play sounds from the game sounds txt file at a given location}}
+{{varcom|snd_setsoundparam|<string> <volume <float 0.0-1.0> {{!}}level SNDLVL_<int 1-179>>|<soundscript> <volume <vol> {{!}}level SNDLVL_<db>>|Can change level or volume of a soundscript.
+<br>examples: <code>snd_setsoundparam Flaregun.Detonate volume 0.1</code><br><code>snd_setsoundparam Flaregun.Detonate level SNDLVL_120</code>}}
+{{varcom|retry|||Retry connection to last server.}}
+{{varcom|rpt_connect|||}}
 {{varcom|r_screenoverlay {{bug|Also has cheat flag and cannot be used in {{l4d2}}<br>{{todo|confirm other games}}}}|<string>||Draw specified material as an overlay}}
-{{varcom|retry|cmd||Retry connection to last server.}}
-{{varcom|rpt_connect|cmd||}}
-{{varcom|slot0|cmd||}}
-{{varcom|slot1|cmd||}}
-{{varcom|slot10|cmd||}}
-{{varcom|slot2|cmd||}}
-{{varcom|slot3|cmd||}}
-{{varcom|slot4|cmd||}}
-{{varcom|slot5|cmd||}}
-{{varcom|slot6|cmd||}}
-{{varcom|slot7|cmd||}}
-{{varcom|slot8|cmd||}}
-{{varcom|slot9|cmd||}}
-{{varcom|snd_playsounds|cmd||Play sounds from the game sounds txt file at a given location}}
-{{varcom|snd_setsoundparam|cmd||Set a sound paramater}}
 {{varcom|end}}