ServerCmd(): Difference between revisions
Jump to navigation
Jump to search
Warning:Since
TomEdwards (talk | contribs) No edit summary |
TomEdwards (talk | contribs) mNo edit summary |
||
| Line 1: | Line 1: | ||
'''<code>ServerCmd()</code>''' is a quick and easy method for passing user input to the server | '''<code>ServerCmd()</code>''' is a quick and easy method for passing user input to the server available through <code>[[cbase.h]]</code>. It uploads an [[Wikipedia:ASCII|ASCII]] string, including with it information about which connected client sent it. The received strings are processed in <code>[[CHL2_Player]]::'''ClientCommand()'''</code> as a <code>[[CCommand]]</code> (i.e. a string array where 0 is the command itself and 1+ are parameters). | ||
{{warning|Since <code>ServerCmd()</code> 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'''.}} | {{warning|Since <code>ServerCmd()</code> 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'''.}} | ||
| Line 5: | Line 5: | ||
==Example== | ==Example== | ||
''client:'' | ''client:'' | ||
engine->ServerCmd( [[VarArgs()|VarArgs]]<span style="color:gray;">("MyCommand %i", m_iMyNumber)</span> ); ''// | engine->ServerCmd( [[VarArgs()|VarArgs]]<span style="color:gray;">("MyCommand %i", m_iMyNumber)</span> ); ''// No variables? Pass the command as a simple string.'' | ||
''server:'' | ''server:'' | ||
bool CHL2_Player::ClientCommand( const CCommand &args ) | bool CHL2_Player::ClientCommand( const CCommand &args ) | ||
Revision as of 08:24, 4 April 2008
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: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) ); // No variables? Pass the command as a simple 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; } }