Commands

function cmds.BaseArg:parseAndValidate( ply, arg, cmdInfo, plyRestrictions )

Used to, you guessed it, parse and validate an argument specified by a user.  Takes user command line input and converts it to a regular lua variable of the correct type.

Parameters

Returns

The parsed arg correctly typed if it validated, false and an explanation otherwise.

function cmds.BaseArg:complete( arg, cmdInfo, plyRestrictions )

Used to autocomplete a command.  Passes back the options the player has in using this command.

Parameters

Returns

A table of strings containing the options that are available.

function cmds.BaseArg:usage( cmdInfo, plyRestrictions )

Prints a basic usage message for this parameter.

Parameters

Returns

A string describing what this parameter is and how to use it.

function cmds.NumArg:processRestrictions( cmdRestrictions, plyRestrictions )

A helper function to help us figure out restrictions on this command.

function cmds.NumArg:parseAndValidate( ply, arg, cmdInfo, plyRestrictions )

See <cmds.BaseArg:parseAndValidate>

function cmds.NumArg:complete( ply, arg, cmdInfo, plyRestrictions )

See <cmds.BaseArg:complete>

function cmds.NumArg:usage( cmdInfo, plyRestrictions )

See <cmds.BaseArg:usage>

function cmds.BoolArg:processRestrictions( cmdRestrictions, plyRestrictions )

A helper function to help us figure out restrictions on this command.

function cmds.BoolArg:parseAndValidate( ply, arg, cmdInfo, plyRestrictions )

See <cmds.BaseArg:parseAndValidate>

function cmds.BoolArg:complete( ply, arg, cmdInfo, plyRestrictions )

See <cmds.BaseArg:complete>

function cmds.BoolArg:usage( cmdInfo, plyRestrictions )

See <cmds.BaseArg:usage>

function cmds.PlayerArg:processRestrictions( ply, cmdRestrictions, plyRestrictions )

A helper function to help us figure out restrictions on this command.

function cmds.PlayerArg:parseAndValidate( ply, arg, cmdInfo, plyRestrictions )

See <cmds.BaseArg:parseAndValidate>

function cmds.PlayerArg:complete( ply, arg, cmdInfo, plyRestrictions )

See <cmds.BaseArg:complete>

function cmds.PlayerArg:usage( cmdInfo, plyRestrictions )

See <cmds.BaseArg:usage>

function cmds.PlayersArg:parseAndValidate( ply, arg, cmdInfo, plyRestrictions )

See <cmds.PlayerArg:parseAndValidate>

function cmds.PlayersArg:usage( cmdInfo, plyRestrictions )

See <cmds.PlayerArg:usage>

function cmds.CallingPlayerArg:parseAndValidate( ply, arg, cmdInfo, plyRestrictions )

See <cmds.BaseArg:parseAndValidate>

function cmds.StringArg:processRestrictions( cmdRestrictions, plyRestrictions )

A helper function to help us figure out restrictions on this command.

function cmds.StringArg:parseAndValidate( ply, arg, cmdInfo, plyRestrictions )

See <cmds.BaseArg:parseAndValidate>

function cmds.StringArg:complete( ply, arg, cmdInfo, plyRestrictions )

See <cmds.BaseArg:complete>

function cmds.StringArg:usage( cmdInfo, plyRestrictions )

See <cmds.BaseArg:usage>

function cmds.TranslateCommand:instantiate( cmd, fn, say_cmd, hide_say, no_space_in_say, unsafe )

Parameters

function cmds.TranslateCommand:addParam( t )

Add an argument to this command.  See the types above for more usage info.

Parameters

function cmds.TranslateCommand:setOpposite( cmd, args, say_cmd, hide_say, no_space_in_say )

Set the command opposite for this command.  IE, if the main command is “jail”, the opposite might be “unjail”.  The same callback is called for both “jail” and “unjail”.  The parameters passed to this function specify required values for arguments passed to the callback.  Any nil values still allow any valid values from the user.  Automatically sets default access to be the same as the “non-opposite” command.

Parameters

Example

This sets the opposite to “unjail”, where the first parameter can still be any valid value, but the second value must be 0.

myCmd:setOpposite( "unjail", { _, 0 }, "!unjail" )

function cmds.TranslateCommand:getUsage( ply )

Parameters

Returns

A string of the usage information for this command.

function cmds.TranslateCommand:call( isOpposite, ... )

This is just a pass-through function for calling the function callback.  If you want to modify the behavior of TranslateCommand on the callback, this is the place to do it.  For example, ULX overrides this to add logging info.

Parameters

function cmds.TranslateCommand:defaultAccess( access )

Parameters

function cmds.getCommandTableAndArgv( commandName, argv, valveErrorCorrection )

Transforms a command and argument list as passed by the source engine into a ULib command table.

Parameters

Returns

Revisions

function cmds.execute( cmdTable, ply, commandName, argv )

Given a ULib command table and the information to pass to the command callback, execute the command.  Also routes server commands appropriately and executes ULib command hooks.

Parameters

Revisions

function cmds.addCommand( cmd, fn, autocomplete, access_string, say_cmd, hide_say, no_space_in_say, unsafe )

You must run this function on BOTH client AND server.  This function is very similar to garry’s concommand.Add() function with a few key differences.

First, this function supports commands with spaces in the name.  IE, “ulx slap” is handled just like you’d think it ought to be.

Second, autocompletes for spaced commands work similar to how the default autocomplete in console works.  IE, if you type “ulx sl” into the console, you’ll see all commands starting with that (“ulx slap”, “ulx slay”).

Third, it will automatically tie in chat commands.

Parameters

Example

The code below creates a bunch of different commands under the first “myTest” command.  If you type in “myTest “ at console, you see all the available commands for the next step in autocompletes.  Note that it’s case-insensitive, but otherwise works exactly like you would expect.

cmds.addCommand( "myTest", print )
cmds.addCommand( "myTest hi", print )
cmds.addCommand( "myTest hi2", print )
cmds.addCommand( "myTest hi2 doOty", print, print )
cmds.addCommand( "myTest hi2 doot", print, print )
cmds.addCommand( "myTest hi2 color", print, function() return { "red", "green", "blue" } end )
cmds.addCommand( "myTest rEd", print, print )
cmds.addCommand( "myTest blue", print, print )
cmds.addCommand( "myTest bluegreen", print, print )
cmds.addCommand( "myTest green", print, print )

Revisions

function cmds.addCommandClient( cmd, fn, autocomplete, unsafe )

Exactly like cmds.addCommand, except it will expect the callback to be run on the local client instead of the server.

Revisions