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

A
	Add, hook
	addBan
	addCommand, cmds.TranslateCommand.cmds
	addCommandClient, cmds.TranslateCommand.cmds
	addGroup, ucl
	addSayCommand
	addUser, ucl
	applyAccel
	applyAccelInCurDirection
	applyForce
	applyForceInCurDirection
B
	backupFile
	ban
	BaseArg:complete, cmds.BaseArg.cmds
	BaseArg:parseAndValidate, cmds.BaseArg.cmds
	BaseArg:usage, cmds.BaseArg.cmds
	BoolArg:complete, cmds.BoolArg.cmds
	BoolArg:parseAndValidate, cmds.BoolArg.cmds
	BoolArg:processRestrictions, cmds.BoolArg.cmds
	BoolArg:usage, cmds.BoolArg.cmds
C
	Call, hook
	CallingPlayerArg:parseAndValidate, cmds.CallingPlayerArg.cmds
	checkArg
	clientRPC
	console
	csay
	csayDraw
D
	debugFunctionCall
E
	error
	execFile
	execString
	explode
F
	filesInDir
	findInTable
	findVar
G
	getAllReadyPlayers
	getCurrentHooks, hook
	getGroupCanTarget, ucl
	getInheritanceTree, ucl
	getPicker
	getPlyByUID
	getSpawnInfo
	GetTable, hook
	getUser
	getUserRegisteredID, ucl
	getUsers
	groupAllow, ucl
	groupInheritsFrom, ucl
I
	inheritsFrom
	invisible
	isDedicatedServer
	isInHook, hook
	isSandbox
	isValidIP
	isValidSteamID
K
	kick
	kickban
M
	makeKeyValues
	makePatternSafe
	makeReadOnly
	matrixTable

Our new and improved hook.Add function.

function ULib.addBan( steamid,
time,
reason,
name,
admin )

Helper function to store additional data about bans.

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

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.

function cmds.addCommandClient( cmd,
fn,
autocomplete )

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

function ucl.addGroup( name,
allows,
inherit_from )

Adds a new group to the UCL.

function ULib.addSayCommand( say_cmd,
fn_call,
access,
hide_say,
nospace )

Just like ULib’s concommand() except that the callback is called when the command is said in chat instead of typed in the console.

function ucl.addUser( id,
allows,
denies,
group )

Adds a user to the UCL.

function ULib.applyAccel( ent,
magnitude,
direction,
dTime )

function ULib.applyAccelInCurDirection( ent,
magnitude,
dTime )

Applies an acceleration in the entities current velocity direction ( not the entity’s heading ).

function ULib.applyForce( ent,
magnitude,
direction,
dTime )

function ULib.applyForceInCurDirection( ent,
magnitude,
dTime )

Applies a force in the entities current velocity direction ( not the entity’s heading ).

function ULib.backupFile( f )

Copies a file to a backup file.

function ULib.ban( ply,
time,
reason,
admin )

Bans a user.

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

Used to autocomplete a command.

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

Used to, you guessed it, parse and validate an argument specified by a user.

function cmds.BaseArg:usage( cmdInfo,
plyRestrictions )

Prints a basic usage message for this parameter.

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

See cmds.BaseArg:complete

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

See cmds.BaseArg:parseAndValidate

function cmds.BoolArg:processRestrictions( cmdRestrictions,
plyRestrictions )

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

function cmds.BoolArg:usage( cmdInfo,
plyRestrictions )

See cmds.BaseArg:usage

Normally, you don’t want to call this directly.

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

See cmds.BaseArg:parseAndValidate

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

Checks to see if an arg matches what is expected, if not, calls throwBadArg().

function ULib.clientRPC( plys,
fn,
... )

Think of this function as if you’re calling a client function directly from the server.

function ULib.console( ply,
msg )

Prints a message in the user’s consoles.

function ULib.csay( ply,
msg,
color,
duration,
fade )

Prints a message in center of the screen as well as in the user’s consoles.

function ULib.csayDraw( msg,
color,
duration,
fade )

Draws a csay text on the screen.

function ULib.debugFunctionCall( name,
... )

Prints a function call, very useful for debugging.

function ULib.error( s )

Gives an error to console.

function ULib.execFile( f,
usebasefolder )

Executes a file on the console.

function ULib.execString( f,
ply )

Just like execFile, except acts on newline-delimited strings.

function ULib.explode( separator,
str,
limit )

Split a string by a separator.

function ULib.filesInDir( dir,
recurse,
root )

Returns files in directory.

function ULib.findInTable( t,
check,
init,
last,
recursive )

Finds a value in a table.

function ULib.findVar( var )

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

function ULib.getAllReadyPlayers()

Similar to player.GetAll(), except it only returns players that have ULib ready to go.

Returns the hooks that are currently processing, if any.

function ucl.getGroupCanTarget( group )

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

function ucl.getInheritanceTree()

This function returns a tree-like structure representing the group inheritance architecture.

function ULib.getPicker( ply,
radius )

Gets the player directly in front of the specified player

function ULib.getPlyByUID( uid )

function ULib.getSpawnInfo( player )

Grabs and returns player information that can be used to respawn player with same health/armor as before the spawn.

The table filled with all the hooks in a format that is backwards compatible with garry’s.

function ULib.getUser( target,
enable_keywords,
ply )

Finds a user matching an identifier.

function ucl.getUserRegisteredID( ply )

Returns the SteamID, IP, or UniqueID of a player if they’re registered under any of those IDs under ucl.users.

function ULib.getUsers( target,
enable_keywords,
ply )

Finds users matching an identifier.

function ucl.groupAllow( name,
access,
revoke )

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

function ucl.groupInheritsFrom( group )

This function is used to see if a specified group is inheriting from another

function inheritsFrom( base_class )

Creates a psudeo-inheritance for lua.

function ULib.invisible( ply,
bool,
visibility )

Makes a user invisible

function isDedicatedServer() -- The normal GM10 function isn't working, let's define a hack

The normal GM10 bind is broken, this fixes it.

Returns true if the specified hook is currently processing

function ULib.isSandbox()

Returns true if the current gamemode is sandbox or is derived from sandbox.

function ULib.isValidIP( ip )

Checks to see if a given string is a valid IPv4 address.

function ULib.isValidSteamID( steamid )

Checks to see if a given string is a valid steamid.

function ULib.kick( ply,
reason )

Kicks a user.

function ULib.kickban( ply,
time,
reason,
admin )

Kicks and bans a user.

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.