Clientside Libraries

Description

A function to add a menu item.

Parameters

# Name Type Note
1 text Unknown Missing description for text.
2 panel Unknown Missing description for panel.
3 tip Unknown Missing description for tip.
4 iconData Unknown Missing description for iconData.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to destroy a menu item.

Parameters

# Name Type Note
1 text Unknown Missing description for text.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to get a menu item.

Parameters

# Name Type Note
1 text Unknown Missing description for text.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add some player info text.

Parameters

# Name Type Note
1 uniqueID Unknown Missing description for uniqueID.
2 text Unknown Missing description for text.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add some sub player info text.

Parameters

# Name Type Note
1 uniqueID Unknown Missing description for uniqueID.
2 text Unknown Missing description for text.
3 priority Unknown Missing description for priority.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to destroy some player info text.

Parameters

# Name Type Note
1 uniqueID Unknown Missing description for uniqueID.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to destroy some sub player info text.

Parameters

# Name Type Note
1 uniqueID Unknown Missing description for uniqueID.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to get some player info text.

Parameters

# Name Type Note
1 uniqueID Unknown Missing description for uniqueID.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to get some sub player info text.

Parameters

# Name Type Note
1 uniqueID Unknown Missing description for uniqueID.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add some target player text.

Parameters

# Name Type Note
1 uniqueID Unknown Missing description for uniqueID.
2 text Unknown Missing description for text.
3 color Unknown Missing description for color.
4 scale Unknown Missing description for scale.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to destroy some target player text.

Parameters

# Name Type Note
1 uniqueID Unknown Missing description for uniqueID.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to get some target player text.

Parameters

# Name Type Note
1 uniqueID Unknown Missing description for uniqueID.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add a top bar.

Parameters

# Name Type Note
1 uniqueID Unknown Missing description for uniqueID.
2 color Unknown Missing description for color.
3 text Unknown Missing description for text.
4 value Unknown Missing description for value.
5 maximum Unknown Missing description for maximum.
6 flash Unknown Missing description for flash.
7 priority Unknown Missing description for priority.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to destroy a top bar.

Parameters

# Name Type Note
1 uniqueID Unknown Missing description for uniqueID.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to get a top bar.

Parameters

# Name Type Note
1 uniqueID Unknown Missing description for uniqueID.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add a character.

Parameters

# Name Type Note
1 characterID Unknown Missing description for characterID.
2 data Unknown Missing description for data.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to get the creation panels.

Parameters

# Name Type Note
1 availableOnly Unknown Missing description for availableOnly.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to get whether the local player is whitelisted for a faction.

Parameters

# Name Type Note
1 faction Unknown Missing description for faction.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Register a new creation panel.

Parameters

# Name Type Note
1 friendlyName String The friendly name of the creation process.
2 vguiName String The name of the VGUI panel to use.
3 index Function A callback to get the visibility of the process. Return false to hide.

Return Values

None.

Description

Used to remove a character creation panel from use.

Parameters

None.

Return Values

None.

Description

A function to set the character fault.

Parameters

# Name Type Note
1 fault Unknown Missing description for fault.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to set whether the character panel is loading.

Parameters

# Name Type Note
1 loading Unknown Missing description for loading.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to set whether the character panel is open.

Parameters

# Name Type Note
1 open Unknown Missing description for open.
2 bReset Unknown Missing description for bReset.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to set whether the character panel is polling.

Parameters

# Name Type Note
1 polling Unknown Missing description for polling.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Add a new cooldown size to the list.

Parameters

# Name Type Note
1 width Number The width of the cooldown box.
2 height Number The height of the cooldown box.

Return Values

# Name Type Note
1 No name provided Table The newly added cooldown table.

Description

Draw a cooldown box at a position.

Parameters

# Name Type Note
1 x Number The horizontal position of the box.
2 y Number The vertical position of the box.
3 width Number The width of the cooldown box.
4 height Number The height of the cooldown box.
5 progress Float The current progress of the cooldown.
6 color Color The color of the cooldown box.
7 textureID Number The texture ID to use when drawing.
8 bCenter Bool Whether or not to center the box.

Return Values

None.

Description

Get a cooldown table from the list.

Parameters

# Name Type Note
1 width Number The width of the cooldown box.
2 height Number The height of the cooldown box.
3 bAdd Bool Whether or not to add the size if it doesn't exist.

Return Values

# Name Type Note
1 No name provided Table The cooldown table matching the specified size.

Description

A function to add a category.

Parameters

# Name Type Note
1 category Unknown Missing description for category.
2 parent Unknown Missing description for parent.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add a category match.

Parameters

# Name Type Note
1 category Unknown Missing description for category.
2 findText Unknown Missing description for findText.
3 replaceText Unknown Missing description for replaceText.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add a category page.

Parameters

# Name Type Note
1 category Unknown Missing description for category.
2 parent Unknown Missing description for parent.
3 htmlCode Unknown Missing description for htmlCode.
4 isWebsite Unknown Missing description for isWebsite.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add some code.

Parameters

# Name Type Note
1 category Unknown Missing description for category.
2 htmlCode Unknown Missing description for htmlCode.
3 noLineBreak Unknown Missing description for noLineBreak.
4 sortData Unknown Missing description for sortData.
5 Callback Unknown Missing description for Callback.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add a page.

Parameters

# Name Type Note
1 category Unknown Missing description for category.
2 htmlCode Unknown Missing description for htmlCode.
3 isWebsite Unknown Missing description for isWebsite.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to get whether a category exists.

Parameters

# Name Type Note
1 category Unknown Missing description for category.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to get a category.

Parameters

# Name Type Note
1 category Unknown Missing description for category.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to get category formatting.

Parameters

# Name Type Note
1 category Unknown Missing description for category.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to get category sorting.

Parameters

# Name Type Note
1 category Unknown Missing description for category.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to get a category tip.

Parameters

# Name Type Note
1 category Unknown Missing description for category.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to get a friendly name.

Parameters

# Name Type Note
1 category Unknown Missing description for category.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to remove some code.

Parameters

# Name Type Note
1 category Unknown Missing description for category.
2 uniqueID Unknown Missing description for uniqueID.
3 forceRemove Unknown Missing description for forceRemove.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to replace a category's matches.

Parameters

# Name Type Note
1 category Unknown Missing description for category.
2 htmlCode Unknown Missing description for htmlCode.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to set category formatting.

Parameters

# Name Type Note
1 category Unknown Missing description for category.
2 htmlCode Unknown Missing description for htmlCode.
3 noLineBreaks Unknown Missing description for noLineBreaks.
4 noMasterFormatting Unknown Missing description for noMasterFormatting.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to set category sorting.

Parameters

# Name Type Note
1 category Unknown Missing description for category.
2 Callback Unknown Missing description for Callback.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to set a category tip.

Parameters

# Name Type Note
1 category Unknown Missing description for category.
2 tip Unknown Missing description for tip.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to set a friendly name.

Parameters

# Name Type Note
1 category Unknown Missing description for category.
2 name Unknown Missing description for name.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to set the master formatting.

Parameters

# Name Type Note
1 htmlCode Unknown Missing description for htmlCode.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add a new font to the system.

Parameters

# Name Type Note
1 name Unknown Missing description for name.
2 fontTable Unknown Missing description for fontTable.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to find a font by name.

Parameters

# Name Type Note
1 name Unknown Missing description for name.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to grab a font by multiplier.

Parameters

# Name Type Note
1 name Unknown Missing description for name.
2 multiplier Unknown Missing description for multiplier.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to grab a font by size (creating what doesn't exist.)

Parameters

# Name Type Note
1 name Unknown Missing description for creating what doesn't exist..

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add a chat icon.

Parameters

# Name Type Note
1 uniqueID Unknown Missing description for uniqueID.
2 path Unknown Missing description for path.
3 callback Unknown Missing description for callback.
4 isPlayer Unknown Missing description for isPlayer.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to set a group's icon.

Parameters

# Name Type Note
1 group Unknown Missing description for group.
2 uniqueID Unknown Missing description for uniqueID.
3 path Unknown Missing description for path.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to set a player's icon.

Parameters

# Name Type Note
1 steamID Unknown Missing description for steamID.
2 uniqueID Unknown Missing description for uniqueID.
3 path Unknown Missing description for path.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to remove a chat icon.

Parameters

# Name Type Note
1 uniqueID Unknown Missing description for uniqueID.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to return a Lerp table by the name it was given upon creation. @params String The name used to search the stored table for.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Table The Lerp table or stored target value (can be either number, vector, angle, or color) found by its name, if it exists currently.

Description

A function to get if a Lerp has reached its target value or not. @params String The name of the Lerp to check.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Bool Whether the Lerp is finished or not, returns false if it doesn't exist.

Description

A function to create a new Lerp and assign its variables. @params String The name of the Lerp. @params Number The time that the Lerp will start (should usually be the time of creation with CurTime). @params Number The time it will take until the Lerp finishes (in seconds). @params Variable The starting point of the Lerp (can be a color object, vector, angle, or number). @params Variable The ending point of the Lerp (can be a color object, vector, angle, or number). This will be stored in place of the Lerp table upon completion.

Parameters

None.

Return Values

# Name Type Note
1 No name provided String The name used for the first parameter.

Description

A function to remove a Lerp table by the name it was given upon creation. @params String The name used to remove from the stored table.

Parameters

None.

Return Values

None.

Description

A function to progress a number Lerp, use only if the start and end values are numbers. @params String The name of the Lerp to progress. @params Number The current time used for calculation (should be from the CurTime global function).

Parameters

None.

Return Values

# Name Type Note
1 No name provided Number The current point between the start and target value according to the time progressed and Lerp duration.

Description

A function to progress an angle Lerp, use only if the start and end values are angles. @params String The name of the Lerp to progress. @params Number The current time used for calculation (should be from the CurTime global function).

Parameters

None.

Return Values

# Name Type Note
1 No name provided Angle The current point between the start and target value according to the time progressed and Lerp duration.

Description

A function to progress a color Lerp, use only if the start and end values are colors. @params String The name of the Lerp to progress. @params Number The current time used for calculation (should be from the CurTime global function).

Parameters

None.

Return Values

# Name Type Note
1 No name provided Color The current point between the start and target value according to the time progressed and Lerp duration.

Description

A function to progress a vector Lerp, use only if the start and end values are vectors. @params String The name of the Lerp to progress. @params Number The current time used for calculation (should be from the CurTime global function).

Parameters

None.

Return Values

# Name Type Note
1 No name provided Vector The current point between the start and target value according to the time progressed and Lerp duration.

Description

A function to create the menu.

Parameters

# Name Type Note
1 setOpen Unknown Missing description for setOpen.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to get whether a panel is active.

Parameters

# Name Type Note
1 panel Unknown Missing description for panel.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to set whether the menu is open.

Parameters

# Name Type Note
1 bIsOpen Unknown Missing description for bIsOpen.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add an entity outline.

Parameters

# Name Type Note
1 entity Unknown Missing description for entity.
2 glowColor Unknown Missing description for glowColor.
3 glowSize Unknown Missing description for glowSize.
4 bIgnoreZ Unknown Missing description for bIgnoreZ.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add a fading entity outline.

Parameters

# Name Type Note
1 entity Unknown Missing description for entity.
2 glowColor Unknown Missing description for glowColor.
3 iDrawDist Unknown Missing description for iDrawDist.
4 bShowAnyway Unknown Missing description for bShowAnyway.
5 tIgnoreEnts Unknown Missing description for tIgnoreEnts.
6 glowSize Unknown Missing description for glowSize.
7 bIgnoreZ Unknown Missing description for bIgnoreZ.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add a quick menu callback.

Parameters

# Name Type Note
1 name Unknown Missing description for name.
2 category Unknown Missing description for category.
3 GetInfo Unknown Missing description for GetInfo.
4 OnCreateMenu Unknown Missing description for OnCreateMenu.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add a command quick menu callback.

Parameters

# Name Type Note
1 name Unknown Missing description for name.
2 category Unknown Missing description for category.
3 command Unknown Missing description for command.
4 options Unknown Missing description for options.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Add a new 9 Sliced sprite.

Parameters

# Name Type Note
1 name String A name to identify the sprite by.
2 fileName String The file name of the sprite (.png only).
3 cornerSize Number The size of the sprite's corners.

Return Values

# Name Type Note
1 No name provided The SliceObject created.

Description

A function to add a check box setting.

Parameters

# Name Type Note
1 category Unknown Missing description for category.
2 text Unknown Missing description for text.
3 conVar Unknown Missing description for conVar.
4 toolTip Unknown Missing description for toolTip.
5 Condition Unknown Missing description for Condition.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add a color mixer setting.

Parameters

# Name Type Note
1 category Unknown Missing description for category.
2 text Unknown Missing description for text.
3 conVar Unknown Missing description for conVar.
4 toolTip Unknown Missing description for toolTip.
5 Condition Unknown Missing description for Condition.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add a multi-choice setting.

Parameters

# Name Type Note
1 category Unknown Missing description for category.
2 text Unknown Missing description for text.
3 conVar Unknown Missing description for conVar.
4 options Unknown Missing description for options.
5 toolTip Unknown Missing description for toolTip.
6 Condition Unknown Missing description for Condition.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add a number slider setting.

Parameters

# Name Type Note
1 category Unknown Missing description for category.
2 text Unknown Missing description for text.
3 conVar Unknown Missing description for conVar.
4 minimum Unknown Missing description for minimum.
5 maximum Unknown Missing description for maximum.
6 decimals Unknown Missing description for decimals.
7 toolTip Unknown Missing description for toolTip.
8 Condition Unknown Missing description for Condition.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add a number wang setting.

Parameters

# Name Type Note
1 category Unknown Missing description for category.
2 text Unknown Missing description for text.
3 conVar Unknown Missing description for conVar.
4 minimum Unknown Missing description for minimum.
5 maximum Unknown Missing description for maximum.
6 decimals Unknown Missing description for decimals.
7 toolTip Unknown Missing description for toolTip.
8 Condition Unknown Missing description for Condition.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add a text entry setting.

Parameters

# Name Type Note
1 category Unknown Missing description for category.
2 text Unknown Missing description for text.
3 conVar Unknown Missing description for conVar.
4 toolTip Unknown Missing description for toolTip.
5 Condition Unknown Missing description for Condition.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to remove a setting.

Parameters

# Name Type Note
1 category Unknown Missing description for category.
2 text Unknown Missing description for text.
3 class Unknown Missing description for class.
4 conVar Unknown Missing description for conVar.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to remove a setting by its convar.

Parameters

# Name Type Note
1 conVar Unknown Missing description for conVar.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to remove a setting by its index.

Parameters

# Name Type Note
1 index Unknown Missing description for index.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to get a system by an identifier.

Parameters

# Name Type Note
1 identifier Unknown Missing description for identifier.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to get a new system.

Parameters

# Name Type Note
1 name Unknown Missing description for name.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to rebuild an system.

Parameters

# Name Type Note
1 name Unknown Missing description for name.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to register a new system.

Parameters

# Name Type Note
1 system Unknown Missing description for system.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to set the active system.

Parameters

# Name Type Note
1 name Unknown Missing description for name.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A deprecated function used to create a new theme. @params Bool Whether or not the theme will not allow players to change the information color in settings. @params String The name of the new theme to be created. @params String The name of the base theme to derive from.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Table The newly created theme table.

Description

A function call a hook from the currently active theme, along with any arguments. @params String The name of the hook to call. @params VarArg The arguments to call the hook with.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Mixed The results of the hook call.

Description

A function to find if a specific theme exists by the name it was created with. @params String The name to search for.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the theme searched for exists.

Description

A function to find a specific theme by the name it was created with. @params String The name to search for.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Table The theme table if found, returns nil if it doesn't exist.

Description

A deprecated function to save a new theme into the theme library. @params Table The theme table to be saved. @params Bool Whether or not you want to switch to the newly created theme upon creation.

Parameters

None.

Return Values

None.

Description

A function to add a hook to be called after a Derma panel's hook is called. @params String The name of the panel with the hook to hook after. @params String The name of the hook to add a hook after. @params Function The function that will be called after the panel's hook is called.

Parameters

None.

Return Values

None.

Description

A function to add a hook to be called before a Derma panel's hook is called. @params String The name of the panel with the hook to hook before. @params String The name of the hook to add a hook before. @params Function The function that will be called before the panel's hook is called.

Parameters

None.

Return Values

None.

Description

A function to replace a Derma panel's hook. @params String The name of the panel with the hook to replace. @params String The name of the hook that is being replaced. @params Function The function to replace the Derma panel's hook with.

Parameters

None.

Return Values

None.

Description

A function to load a theme and initialize it. Do not call this, as it will not unload the previous theme. @params Table The theme table to load.

Parameters

None.

Return Values

None.

Description

A function used to create a new theme. @params String The name of the new theme to be created. @params String The name of the base theme to derive from. @params Bool Whether or not the theme will not allow players to change the information color in settings.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Table The newly created theme table.

Description

A function to save a new theme into the theme library, uses the Finish method. @params Bool Whether or not you want to switch to the newly created theme upon creation.

Parameters

None.

Return Values

# Name Type Note
1 No name provided String The name of the new theme that was saved.

Description

A function to smoothly transition between themes, and call the hooks for loading and unloading them. @params String The name of the theme to be loaded, can also be the theme table itself. @params Bool Whether or not this is the first theme being loaded, used by Clockwork when initializing. Do NOT set to true.

Parameters

None.

Return Values

None.

Description

A function to unload the current theme. Do not call this, as it will not load another theme.

Parameters

None.

Return Values

None.

Description

A function to add new text to the markup object.

Parameters

# Name Type Note
1 text Unknown Missing description for text.
2 color Unknown Missing description for color.
3 scale Unknown Missing description for scale.
4 noNewLine Unknown Missing description for noNewLine.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to add a new title to the markup object.

Parameters

# Name Type Note
1 title Unknown Missing description for title.
2 color Unknown Missing description for color.
3 scale Unknown Missing description for scale.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

A function to draw the sliced sprite at a location (corner size can be overriden.)

Parameters

# Name Type Note
1 x Unknown Missing description for corner size can be overriden..

Return Values

# Name Type Note
1 No name provided Unknown No note provided