ServerCmd()

From Valve Developer Community
Revision as of 07:22, 4 April 2008 by TomEdwards (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

ServerCmd() is a quick and easy method for passing user input to the server, available through cbase.h. It uploads an ASCII string, including with it information about which connected client sent it. The received strings are processed in CHL2_Player::ClientCommand() as a CCommand (i.e. a string array where 0 is the command itself and 1+ are parameters).

Warning.png Warning: Since ServerCmd() passes a full string value, it is NOT suitable for commands that will be sent frequently. Single-player mods can probably get away with the overhead, but multiplayer mods must send with the Usercmd instead.

Example

client:
	engine->ServerCmd( VarArgs("MyCommand %i", m_iMyNumber) ); // if no variables are required, simply pass the command as a string.
server:
	bool CHL2_Player::ClientCommand( const CCommand &args )
	{
		if ( !Q_stricmp( args[0], "MyCommand" ) )
		{
			Msg( "MyCommand received! Value: %i\n", atoi(args[1]) );
			return true;
		}
	}

See also