Point clientcommand: Difference between revisions

Revision as of 06:12, 17 January 2025

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

point_clientcommand is a point entity available in all Source games. 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. Only 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.

Tip:In

, you can use the following entity I/O to send a client command to all players. This will not work if you have more than one point_clientcommand entity!

player RunScriptCode Entities.FindByClassname(null, `point_clientcommand`).AcceptInput(`Command`, `console_command_here`, self, self)

Todo: This can probably be done in other VScript supported titles by using

and escaping the quotes into the vmf file before compiling but not confirmed.

supports backticks so it's not necessary here.

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.

Note:In

Garry's Mod , due to abuse, the point_servercommand and point_clientcommand is removed.

Workaround:Use lua_run RunConsoleCommand('command')

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.
Fix:Remove additional " symbols manually with a text editor.

Usable ConVars/ConCommands in multiplayer

Note:In

item equipping related commands only work when bound or used on human player with this entity

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
`firstperson`			Go into firstperson view
`invnext`			In style hud selects next weapon
`invprev`			In style hud selects previous weapon
`lastinv`			Equips previously used weapon
`(only in )+inspect`			Force weapon inspection
`(only in )-inspect`			Cancel weapon inspection
`slot0 - slot10`			In style hud selects slot with the given number
`(only in )cl_consistencycheck`			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
`soundfade`	`<float> <float> [<float> <float>]`	<percent> <hold> [<out> <int>]	Fade in/out all client volume
`sndplaydelay`	`<float> <string>`	<delay_in_sec> <soundname>	Play a sound with a given delay. Negative to skip ahead
`(only in )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`
`redirect`	`<string>`	<server ip address>	Redirect client to specified server. Note:In , the client must have the server favorited in the server browser for this to work.
`retry`			Retry connection to current (or last) server.
`rpt_connect`
`r_cleardecals`			Clear all client decals
`r_screenoverlay Bug:Cannot be used without sv_cheats 1 in In other games, this command will only work without cheats but ONLY on dedicated servers. In , use the SetScriptOverlayMaterial input on players instead. [todo tested in ?]`	`<string>`	<material name>	Draw specified material as an overlay

ConVars

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

player class commands

Some commands are defined in player class and are completely hidden from auto complete. Such commands are also usable on clients connected to server via this entity

Todo: list commands defined in player class which don't require sv_cheats 1 (some examples from l4d2)

@@ Line 4: / Line 4: @@
 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.
+{{tip|In {{tf2}}, you can use the following entity I/O to send a client command to all players.  This will not work if you have more than one point_clientcommand entity!
+{{code|player  RunScriptCode  Entities.FindByClassname(null, `point_clientcommand`).AcceptInput(`Command`, `console_command_here`, self, self)}}
+{{todo|This can probably be done in other [[VScript]] supported titles by using {{hammerplusplus}} and escaping the quotes into the vmf file before compiling but not confirmed.  {{tf2}} supports backticks so it's not necessary here.}}
+}}
 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.