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

K
	kick
	kickban
M
	makeKeyValues
	makePatternSafe
	makeReadOnly
	matrixTable
N
	nameCheck
	namedQueueFunctionCall
	NumArg:complete, cmds.NumArg.cmds
	NumArg:parseAndValidate, cmds.NumArg.cmds
	NumArg:processRestrictions, cmds.NumArg.cmds
	NumArg:usage, cmds.NumArg.cmds
P
	parseKeyValues
	pcallError
	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
	pluginVersionStr
	probe, ucl
Q
	query, ucl
	queueFunctionCall
R
	redirect
	refreshBans
	registerAccess, ucl
	registerPlugin
	removeCommentHeader
	removeGroup, ucl
	removeSayCommand
	removeUser, ucl
	renameGroup, ucl
	replicatedWritableCvar
	root_class:call
	root_class:create
	ropairs
S
	sayCmdCheck
	secondsToStringTime
	serialize
	setGroupCanTarget, ucl
	setGroupInheritance, ucl
	setVar
	slap
	spawn
	splitArgs
	splitPort
	StringArg:complete, cmds.StringArg.cmds
	StringArg:parseAndValidate, cmds.StringArg.cmds
	StringArg:processRestrictions, cmds.StringArg.cmds
	StringArg:usage, cmds.StringArg.cmds
	stringTimeToMinutes
	stripComments
	stripQuotes

function ULib.kick( ply,
reason,
calling_ply )

Kicks a user.

ULib.kickban = ULib.ban

An alias for ban.

function ULib.makeKeyValues( t,
tab,
completed )

Makes a key values string from a table.

function ULib.makePatternSafe( str )

Makes a string safe for pattern usage, like in string.gsub().

function ULib.makeReadOnly( t )

Makes a table and all recursive tables read-only

function ULib.matrixTable( t,
columns )

Splits a table into a number of given columns.

function ULib.nameCheck( data )

Calls all ULibPlayerNameChanged hooks if a player changes their name.

function ULib.namedQueueFunctionCall( queueName,
fn,
... )

Exactly like queueFunctionCall(), but allows for separately running queues to exist.

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.pcallError( ... )

An adaptation of a function that used to exist before GM13, allows you to call functions safely and print errors (if it errors).

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 superadmin 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 ULib.pluginVersionStr( name )

Returns a human-readable version string for plugins in a consistent format.

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.registerPlugin( pluginData )

function ULib.removeCommentHeader( data,
comment_char )

Removes a comment header.

function ucl.removeGroup( name,
from_CAMI )

Removes a group from the UCL.

function ULib.removeSayCommand( say_cmd )

Removes a say command.

function ucl.removeUser( id,
from_CAMI )

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,
bTeam )

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

function ULib.secondsToStringTime( secs )

Converts a number of seconds to a string describing the time span.

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,
from_CAMI )

Sets a group’s inheritance in the UCL.

function ULib.setVar( varLocation,
varValue,
rootTable )

Given a string, find and set a var starting from the global namespace.

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.stringTimeToMinutes( str )

Converts a string containing time information to minutes.

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

Strips comments from a string

function ULib.stripQuotes( s )

Trims leading and tailing quotes from a string