onConsoleInput

Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This is called when text is typed to the server console.

Syntax

function onConsoleInput( string cmd, string text )

Arguments

• cmd - This is the command typed to the console
• text - These are the additional parameters for the command

Returns

This event does not handle return values.

Example

This example changes the server's gravity setting when someone types 'setgrav 0.001' into the server console.

 
function onConsoleInput( cmd, text )
{
     if ( cmd == "setgrav" ) SetGravity( text.tofloat() );
     
     return 1;
}

Notes

The function SetGravity was used in this example. More info about this in the corresponding page.

Related Events

• onConsoleInput
• onScriptLoad
• onScriptUnload
• onServerStart