Function Index

$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z

N
	nameCheck
	NumArg:complete, cmds.NumArg.cmds
	NumArg:parseAndValidate, cmds.NumArg.cmds
	NumArg:processRestrictions, cmds.NumArg.cmds
	NumArg:usage, cmds.NumArg.cmds
P
	parseKeyValues
	play3DSound
	Player:CheckGroup
	Player:GetUserGroup
	Player:IsAdmin
	Player:IsSuperAdmin
	Player:query
	PlayerArg:complete, cmds.PlayerArg.cmds
	PlayerArg:parseAndValidate, cmds.PlayerArg.cmds
	PlayerArg:processRestrictions, cmds.PlayerArg.cmds
	PlayerArg:usage, cmds.PlayerArg.cmds
	PlayersArg:parseAndValidate, cmds.PlayersArg.cmds
	PlayersArg:usage, cmds.PlayersArg.cmds
	probe, ucl
Q
	query, ucl
	queueFunctionCall
R
	redirect
	refreshBans
	registerAccess, ucl
	Remove, hook
	removeCommentHeader
	removeGroup, ucl
	removeSayCommand
	removeUser, ucl
	renameGroup, ucl
	replicatedWritableCvar
	root_class:call
	root_class:create
	ropairs
S
	sayCmdCheck
	serialize
	setGroupCanTarget, ucl
	setGroupInheritance, ucl
	slap
	spawn
	splitArgs
	splitPort
	StringArg:complete, cmds.StringArg.cmds
	StringArg:parseAndValidate, cmds.StringArg.cmds
	StringArg:processRestrictions, cmds.StringArg.cmds
	StringArg:usage, cmds.StringArg.cmds
	stringTimeToSeconds
	stripComments
	stripQuotes
T
	throwBadArg
	toBool
	TranslateCommand:addParam, cmds.TranslateCommand.cmds
	TranslateCommand:call, cmds.TranslateCommand.cmds
	TranslateCommand:defaultAccess, cmds.TranslateCommand.cmds
	TranslateCommand:getUsage, cmds.TranslateCommand.cmds
	TranslateCommand:instantiate, cmds.TranslateCommand.cmds
	TranslateCommand:setOpposite, cmds.TranslateCommand.cmds
	tsay
	tsayColor
	tsayError
U
	umsgRcv
	umsgSend
	unban
	unescapeBackslash
	userAllow, ucl

function ULib.nameCheck()

Checks all players’ names at regular intervals to detect name changes.

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

See cmds.BaseArg:complete

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

See cmds.BaseArg:parseAndValidate

function cmds.NumArg:processRestrictions( cmdRestrictions,
plyRestrictions )

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

function cmds.NumArg:usage( cmdInfo,
plyRestrictions )

See cmds.BaseArg:usage

function ULib.parseKeyValues( str,
convert )

Parses a keyvalue formatted string into a table.

function ULib.play3DSound( sound,
vector,
volume,
pitch )

Plays a 3D sound, the further away from the point the player is, the softer the sound will be.

This function is similar to IsUserGroup(), but this one checks the UCL group chain as well.

This should have been included with garrysmod by default, so ULib is creating it for us.

Overwrite garry’s IsAdmin function to check for membership in admin group.

Overwrite garry’s IsSuperAdmin function to check for membership in admin group.

This is an alias of ULib.ucl.query()

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

See cmds.BaseArg:complete

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

See cmds.BaseArg:parseAndValidate

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

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

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 ucl.probe( ply )

Probes the user to assign access appropriately.

function ucl.query( ply,
access,
hide )

This function is used to see if a user has access to a command.

function ULib.queueFunctionCall( fn,
... )

Adds a function call to the queue to be called.

function ULib.redirect( ply,
command,
argv )

This redirects any command to the server.

function ULib.refreshBans()

Refreshes the ULib bans.

function ucl.registerAccess( access,
groups,
comment,
category )

Inform UCL about the existence of a particular access string, optionally make it have a certain default access, optionally give a help message along with it.

function ULib.removeCommentHeader( data,
comment_char )

Removes a comment header.

function ucl.removeGroup( name )

Removes a group from the UCL.

function ULib.removeSayCommand( say_cmd )

Removes a say command.

function ucl.removeUser( id )

Removes a user from the UCL.

function ucl.renameGroup( orig,
new )

Renames a group in the UCL.

function ULib.replicatedWritableCvar( sv_cvar,
cl_cvar,
default_value,
save,
notify,
access )

This function also creates a cvar on the client that can be modified and will be sent back to the server.

This is a utility function used by the metatable __call to resolve Class( ...

function root_class:create( ... )

This is used to create new ‘class instances’.

function ULib.ropairs( t )

The equivalent of “pairs” for a readonly table, since “pairs” won’t work.

local function sayCmdCheck( ply,
strText,
bPublic )

Say callback which will check to see if there’s a say command being used.

function ULib.serialize( v )

Serializes a variable.

function ucl.setGroupCanTarget( group,
can_target )

Sets what a group is allowed to target in the UCL.

function ucl.setGroupInheritance( group,
inherit_from )

Sets a group’s inheritance in the UCL.

function ULib.slap( ent,
damage,
power,
nosound )

Slaps an entity, can be a user or any entity.

function ULib.spawn( player,
bool )

Enhanced spawn player.

function ULib.splitArgs( args,
start_token,
end_token )

This is similar to string.Explode( “ “, str ) except that it will also obey quotation marks.

function ULib.splitPort( ipAndPort )

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

See cmds.BaseArg:complete

function cmds.StringArg: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:usage( cmdInfo,
plyRestrictions )

See cmds.BaseArg:usage

function ULib.stringTimeToSeconds( str )

Converts a string containing time information to seconds.

function ULib.stripComments( str,
comment,
blockcommentbeg,
blockcommentend )

Strips comments from a string

function ULib.stripQuotes( s )

Trims leading and tailing quotes from a string

function ULib.throwBadArg( argnum,
fnName,
expected,
data,
throwLevel )

Throws an error similar to the lua “bad argument #x to fn_name (type expected, got type).

function ULib.toBool( x )

Converts a bool, nil, string, or number to a bool

function cmds.TranslateCommand:addParam( t )

Add an argument to this command.

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

This is just a pass-through function for calling the function callback.

function cmds.TranslateCommand:defaultAccess( access )

function cmds.TranslateCommand:getUsage( ply )

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

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

Set the command opposite for this command.

function ULib.tsay( ply,
msg,
wait,
wasValid )

Prints a message in talk say as well as in the user’s consoles.

function ULib.tsayColor( ply,
wait,
... )

Prints a tsay message in color!

function ULib.tsayError( ply,
msg,
wait )

Just like tsay, but prints the string in red

function ULib.umsgRcv( um,
control )

Receive a umsg sent by ULib.umsgSend

function ULib.umsgSend( v,
queue )

Makes sending umsgs a blast.

function ULib.unban( steamid )

Unbans the given steamid.

function ULib.unescapeBackslash( s )

Converts ‘\\’ to ‘\’

function ucl.userAllow( id,
access,
revoke,
deny )

Adds or removes an access tag in the allows or denies for a user.