Index - ULib

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

G
	getAllReadyPlayers
	getCommandTableAndArgv, cmds.TranslateCommand.cmds
	getGroupCanTarget, ucl
	getInheritanceTree, ucl
	getLegacyBans
	getPicker
	getPlyByID
	getPlyByUID
	getSpawnInfo
	getUniqueIDForPly
	getUser
	getUserInfoFromID, ucl
	getUserRegisteredID, ucl
	getUsers
	groupAllow, ucl
	groupInheritsFrom, ucl
H
	Hooks
I
	ignoreCanTarget, cmds
	Inheritance
	inheritsFrom
	invisible
	isSandbox
	isValidIP
	isValidSteamID
K
	kick
	kickban
M
	makeKeyValues
	makePatternSafe
	makeReadOnly
	matrixTable
	Messages
	Miscellaneous
N
	nameCheck
	namedQueueFunctionCall
	Net pooled strings
	NumArg:complete, cmds.NumArg.cmds
	NumArg:parseAndValidate, cmds.NumArg.cmds
	NumArg:processRestrictions, cmds.NumArg.cmds
	NumArg:usage, cmds.NumArg.cmds
O
	optional, cmds
P
	parseKeyValues
	pcallError
	Physics Helpers
	play3DSound
	Player lua/ulib/server/player.lua lua/ulib/shared/player.lua
	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
	Plugin Helpers
	plugins
	pluginVersionStr
	probe, ucl
Q
	query, ucl
	queueFunctionCall

function ULib.getAllReadyPlayers()

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

function cmds.getCommandTableAndArgv( commandName,
argv,
valveErrorCorrection )

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

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

Returns bans written by ULib versions prior to 2.7.

function ULib.getPicker( ply,
radius )

Gets the player directly in front of the specified player

function ULib.getPlyByID( id )

Finds a user identified by the given ID.

function ULib.getPlyByUID( uid )

function ULib.getSpawnInfo( ply )

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

Finds a unique ID for a player, suitable for use in getUsers or getUser to uniquely identify the given player.

function ULib.getUser( target,
enable_keywords,
ply )

Finds a user matching an identifier.

function ucl.getUserInfoFromID( id )

Returns a table containing the name and group of a player in the UCL table of users if they exist.

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

These are the hooks that ULib has created that other modders are free to make use of.

cmds.ignoreCanTarget

This is used when specifying a command that should ignore the can_target property in the groups config.

function inheritsFrom( base_class )

Creates a psudeo-inheritance for lua.

function ULib.invisible( ply,
bool,
visibility )

Makes a user invisible

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,
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.

Handles messaging like logging, debug, etc.

Some utility functions.

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.

These defines are server-only, to help with the networking library.

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

cmds.optional

This is used when specifying an argument to flag the argument as optional.

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

Various functions to make dealing with the HL2 physics engine a little easier.

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.

Holds some helpful player functions.

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

Some useful functions for ULib plugins to use for doing plugin-type things.

Holds plugin data for plugins that have registered themselves with ULib.

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.