Shared Libraries

Description

A function to add an option to the selector.

Parameters

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

Return Values

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

Description

A function to add text to the selector.

Parameters

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

Return Values

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

Description

A function to create a new config object.

Parameters

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

Return Values

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

Description

Called when crafting is unsuccessful.

Parameters

# Name Type Note
1 player Entity Player crafting the blueprint.

Return Values

None.

Description

A function to get the config's value.

Parameters

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

Return Values

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

Description

A function to get the config's value as a boolean.

Parameters

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

Return Values

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

Description

A function to get a config's default value.

Parameters

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

Return Values

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

Description

A function to get the config's next value.

Parameters

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

Return Values

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

Description

A function to get a config's value as a number.

Parameters

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

Return Values

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

Description

A function to get a config's value as a string.

Parameters

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

Return Values

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

Description

A function to get whether the item is an instance.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Bool Whether the blueprint is an instance or not.

Description

Called just before crafting.

Parameters

# Name Type Note
1 player Entity Player crafting the blueprint.

Return Values

None.

Description

A function to override an item's base data. This is just a nicer way to set a value to go along with the method of querying.

Parameters

None.

Return Values

None.

Description

Called just after crafting.

Parameters

# Name Type Note
1 player Entity Player crafting the blueprint.

Return Values

None.

Description

A function to query the config.

Parameters

# Name Type Note
1 key Unknown Missing description for key.
2 failSafe Unknown Missing description for failSafe.

Return Values

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

Description

A function to select a selector's option by key.

Parameters

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

Return Values

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

Description

A function to set the config's value.

Parameters

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

Return Values

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

Description

A function to set the selector callback.

Parameters

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

Return Values

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

Description

A function to set whether the selector can be exited.

Parameters

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

Return Values

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

Description

A function to set whether text should be paginated.

Parameters

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

Return Values

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

Description

A function to set the selector's player.

Parameters

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

Return Values

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

Description

Called when the config is invoked as a function.

Parameters

# Name Type Note
1 parameter Unknown Missing description for parameter.
2 failSafe Unknown Missing description for failSafe.

Return Values

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

Description

A function to get the global shared variables.

Parameters

# Name Type Note
1 bObject Table The global shared variable object.

Return Values

None.

Description

A function to get the player shared variables.

Parameters

# Name Type Note
1 bObject Table The player shared variable object.

Return Values

None.

Description

A function to add a global shared variable.

Parameters

# Name Type Note
1 name String A unique identifier.
2 class String The shared variable class.

Return Values

None.

Description

A function to add a global shared angle.

Parameters

# Name Type Note
1 name String A unique identifier.

Return Values

None.

Description

A function to add a global shared bool.

Parameters

# Name Type Note
1 name String A unique identifier.

Return Values

None.

Description

A function to add a global shared entity.

Parameters

# Name Type Note
1 name String A unique identifier.

Return Values

None.

Description

A function to add a global shared float.

Parameters

# Name Type Note
1 name String A unique identifier.

Return Values

None.

Description

A function to add a global shared number.

Parameters

# Name Type Note
1 name String A unique identifier.

Return Values

None.

Description

A function to add a global shared string.

Parameters

# Name Type Note
1 name String A unique identifier.

Return Values

None.

Description

A function to add a global shared vector.

Parameters

# Name Type Note
1 name String A unique identifier.

Return Values

None.

Description

A function to add a player shared variable.

Parameters

# Name Type Note
1 name String A unique identifier.
2 class String The shared variable class.
3 bPlayerOnly Bool Whether or not the shared varible is global.

Return Values

None.

Description

A function to add a player shared angle.

Parameters

# Name Type Note
1 name String A unique identifier.
2 bPlayerOnly Bool Whether or not the shared varible is global.

Return Values

None.

Description

A function to add a player shared bool.

Parameters

# Name Type Note
1 name String A unique identifier.
2 bPlayerOnly Bool Whether or not the shared varible is global.

Return Values

None.

Description

A function to add a player shared entity.

Parameters

# Name Type Note
1 name String A unique identifier.
2 bPlayerOnly Bool Whether or not the shared varible is global.

Return Values

None.

Description

A function to add a player shared float.

Parameters

# Name Type Note
1 name String A unique identifier.
2 bPlayerOnly Bool Whether or not the shared varible is global.

Return Values

None.

Description

A function to add a player shared number.

Parameters

# Name Type Note
1 name String A unique identifier.
2 bPlayerOnly Bool Whether or not the shared varible is global.

Return Values

None.

Description

A function to add a player shared string.

Parameters

# Name Type Note
1 name String A unique identifier.
2 bPlayerOnly Bool Whether or not the shared varible is global.

Return Values

None.

Description

A function to add a player shared vector.

Parameters

# Name Type Note
1 name String A unique identifier.
2 bPlayerOnly Bool Whether or not the shared varible is global.

Return Values

None.

Description

A function to make a model use the black skin for hands viewmodels.

Parameters

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

Return Values

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

Description

A function to make a model use the CSS viewmodel hands.

Parameters

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

Return Values

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

Description

A function to add a Civil Protection model.

Parameters

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

Return Values

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

Description

A function to make a model use the combine viewmodel hands.

Parameters

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

Return Values

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

Description

A function to add a Combine Overwatch model.

Parameters

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

Return Values

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

Description

A function to add a female human model.

Parameters

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

Return Values

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

Description

A function to make a model use the HL2 HEV viewmodel hands.

Parameters

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

Return Values

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

Description

A function to add viewmodel c_arms info to a model.

Parameters

# Name Type Note
1 model Unknown Missing description for model.
2 hands Unknown Missing description for hands.

Return Values

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

Description

A function to add a male human model.

Parameters

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

Return Values

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

Description

A function to add a model.

Parameters

# Name Type Note
1 class Unknown Missing description for class.
2 model Unknown Missing description for model.

Return Values

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

Description

A function to add an override.

Parameters

# Name Type Note
1 model Unknown Missing description for model.
2 key Unknown Missing description for key.
3 value Unknown Missing description for value.

Return Values

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

Description

A function to make a model use the refugee viewmodel hands.

Parameters

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

Return Values

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

Description

A function to add a vortigaunt model.

Parameters

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

Return Values

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

Description

A function to make a model use the zombie skin for citizen hands.

Parameters

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

Return Values

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

Description

a function to make a model use the refugee viewmodel hands with a zombie skin.

Parameters

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

Return Values

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

Description

A function to adjust the hands info with checks for if a model is set to use the black skin.

Parameters

# Name Type Note
1 model Unknown Missing description for model.
2 info Unknown Missing description for info.

Return Values

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

Description

A function to check for stored hands info by model.

Parameters

# Name Type Note
1 model Unknown Missing description for model.
2 animTable Unknown Missing description for animTable.

Return Values

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

Description

A function to get an animation for a model.

Parameters

# Name Type Note
1 model Unknown Missing description for model.
2 key Unknown Missing description for key.

Return Values

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

Description

A function to get the c_model hands based on model.

Parameters

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

Return Values

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

Description

A function to get a model's menu sequence.

Parameters

# Name Type Note
1 model Unknown Missing description for model.
2 bRandom Unknown Missing description for bRandom.

Return Values

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

Description

A function to get a model's class.

Parameters

# Name Type Note
1 model Unknown Missing description for model.
2 alwaysReal Unknown Missing description for alwaysReal.

Return Values

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

Description

A function to get an animation table.

Parameters

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

Return Values

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

Description

A function to get a weapon's hold type.

Parameters

# Name Type Note
1 player Unknown Missing description for player.
2 weapon Unknown Missing description for weapon.

Return Values

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

Description

A function to set a model's menu sequence.

Parameters

# Name Type Note
1 model Unknown Missing description for model.
2 sequence Unknown Missing description for sequence.

Return Values

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

Description

A function to find an attribute 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 attribute.

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

Parameters

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

Return Values

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

Description

A function to boost a player's attribute.

Parameters

# Name Type Note
1 player Unknown Missing description for player.
2 identifier Unknown Missing description for identifier.
3 attribute Unknown Missing description for attribute.
4 amount Unknown Missing description for amount.
5 duration Unknown Missing description for duration.

Return Values

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

Description

A function to clear a player's attribute boosts.

Parameters

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

Return Values

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

Description

A function to get the local player's attribute as a fraction.

Parameters

# Name Type Note
1 attribute Unknown Missing description for attribute.
2 fraction Unknown Missing description for fraction.
3 negative Unknown Missing description for negative.

Return Values

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

Description

A function to get whether the local player has an attribute.

Parameters

# Name Type Note
1 attribute Unknown Missing description for attribute.
2 boostless Unknown Missing description for boostless.
3 negative Unknown Missing description for negative.

Return Values

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

Description

A function to get whether a boost is active for a player.

Parameters

# Name Type Note
1 player Unknown Missing description for player.
2 identifier Unknown Missing description for identifier.
3 attribute Unknown Missing description for attribute.
4 amount Unknown Missing description for amount.
5 duration Unknown Missing description for duration.

Return Values

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

Description

A function to update a player's attribute.

Parameters

# Name Type Note
1 player Unknown Missing description for player.
2 attribute Unknown Missing description for attribute.
3 amount Unknown Missing description for amount.

Return Values

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

Description

A function to add some flags.

Parameters

# Name Type Note
1 field Unknown Missing description for field.
2 ... Unknown Missing description for ....

Return Values

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

Description

A function to combine some flags.

Parameters

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

Return Values

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

Description

A function to define some bit flags.

Parameters

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

Return Values

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

Description

A function to check if some flags are set.

Parameters

# Name Type Note
1 field Unknown Missing description for field.
2 ... Unknown Missing description for ....

Return Values

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

Description

A function to check if any flags are set.

Parameters

# Name Type Note
1 field Unknown Missing description for field.
2 ... Unknown Missing description for ....

Return Values

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

Description

A function to remove some flags.

Parameters

# Name Type Note
1 field Unknown Missing description for field.
2 ... Unknown Missing description for ....

Return Values

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

Description

A function to add a new chat message.

Parameters

# Name Type Note
1 filtered Unknown Missing description for filtered.
2 icon Unknown Missing description for icon.
3 ... Unknown Missing description for ....

Return Values

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

Description

A function to add a new chat message in a radius.

Parameters

None.

Return Values

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

Description

A function to add a new chat message in a target radius.

Parameters

None.

Return Values

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

Description

A function to decode a message.

Parameters

# Name Type Note
1 speaker Unknown Missing description for speaker.
2 name Unknown Missing description for name.
3 text Unknown Missing description for text.
4 data Unknown Missing description for data.
5 class Unknown Missing description for class.
6 multiplier Unknown Missing description for multiplier.

Return Values

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

Description

A function to get a chatbox class by identifier to modify.

Parameters

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

Return Values

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

Description

A function to get all the registered types of text, returns default ones or not based on bool argument.

Parameters

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

Return Values

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

Description

A function to get the position of the chat area.

Parameters

# Name Type Note
1 addX Unknown Missing description for addX.
2 addY Unknown Missing description for addY.

Return Values

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

Description

A function to get the spacing between messages.

Parameters

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

Return Values

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

Description

A function to register a chat box class.

Parameters

# Name Type Note
1 class Unknown Missing description for class.
2 filter Unknown Missing description for filter.
3 Callback Unknown Missing description for Callback.

Return Values

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

Description

A function to register a default chat box class.

Parameters

# Name Type Note
1 class Unknown Missing description for class.
2 filter Unknown Missing description for filter.
3 Callback Unknown Missing description for Callback.

Return Values

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

Description

A function to send a colored message.

Parameters

None.

Return Values

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

Description

A function to set the chat box's custom position.

Parameters

# Name Type Note
1 x Unknown Missing description for x.
2 y Unknown Missing description for y.

Return Values

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

Description

A function to set the size (multiplier) of the next message.

Parameters

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

Return Values

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

Description

A function to add and wrap text to a message.

Parameters

# Name Type Note
1 newLine Unknown Missing description for newLine.
2 message Unknown Missing description for message.
3 color Unknown Missing description for color.
4 text Unknown Missing description for text.
5 OnHover Unknown Missing description for OnHover.

Return Values

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

Description

A function to find a class 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 an appropriate class model for a player.

Parameters

# Name Type Note
1 name Unknown Missing description for name.
2 player Unknown Missing description for player.
3 noSubstitute Unknown Missing description for noSubstitute.

Return Values

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

Description

A function to get the class limit.

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 get a class's model by gender.

Parameters

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

Return Values

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

Description

A function to check if a class has any flags.

Parameters

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

Return Values

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

Description

A function to check if a class has flags.

Parameters

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

Return Values

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

Description

A function to get a new class.

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 query a class.

Parameters

# Name Type Note
1 name Unknown Missing description for name.
2 key Unknown Missing description for key.
3 default Unknown Missing description for default.

Return Values

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

Description

A function to register a new class.

Parameters

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

Return Values

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

Description

Returns command's table by alias or unique id.

Parameters

# Name Type Note
1 identifier String Identifier of the command to find. Can be alias or original command name.

Return Values

None.

Description

A function to find a command 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

Whether or not the player has access to the command.

Parameters

# Name Type Note
1 player Userdata The player whose access to check.
2 command Table :String} The command name or command table to check against.

Return Values

None.

Description

A function to get a new command.

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

Parameters

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

Return Values

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

Description

A function to remove a command.

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 remove a command's help.

Parameters

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

Return Values

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

Description

A function to set whether a command is hidden.

Parameters

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

Return Values

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

Description

A function to add a new config key.

Parameters

# Name Type Note
1 key Unknown Missing description for key.
2 value Unknown Missing description for value.

Return Values

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

Description

A function to add a config key entry to the system.

Parameters

# Name Type Note
1 name Unknown Missing description for name.
2 key Unknown Missing description for key.
3 help Unknown Missing description for help.
4 minimum Unknown Missing description for minimum.
5 maximum Unknown Missing description for maximum.
6 decimals Unknown Missing description for decimals.
7 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 config object.

Parameters

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

Return Values

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

Description

A function to get a config key's system entry.

Parameters

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

Return Values

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

Description

A function to import a config file.

Parameters

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

Return Values

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

Description

A function to get whether a config value is valid.

Parameters

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

Return Values

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

Description

A function to load config from a file.

Parameters

# Name Type Note
1 fileName Unknown Missing description for fileName.
2 loadGlobal Unknown Missing description for loadGlobal.

Return Values

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

Description

A function to load an INI file.

Parameters

# Name Type Note
1 fileName Unknown Missing description for fileName.
2 bFromGame Unknown Missing description for bFromGame.
3 bStripQuotes Unknown Missing description for bStripQuotes.

Return Values

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

Description

A function to parse config keys.

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 send the config to a player.

Parameters

# Name Type Note
1 player Unknown Missing description for player.
2 key Unknown Missing description for key.

Return Values

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

Description

A function to set whether the config has initialized.

Parameters

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

Return Values

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

Description

A function to get whether the config has sent initialized.

Parameters

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

Return Values

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

Description

A function to share a config key.

Parameters

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

Return Values

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

Description

A function to check if an item can be crafted.

Parameters

# Name Type Note
1 player Entity Player crafting the blueprint.
2 blueprintTable Table Blueprint being crafted.

Return Values

None.

Description

Checks if the player has the items required to craft the blueprint.

Parameters

# Name Type Note
1 player Entity Player crafting the blueprint.
2 item String ID of the item being checked.
3 amount Number Amount of items the player needs to have.

Return Values

# Name Type Note
1 No name provided Bool Whether player can craft the blueprint.
2 No name provided String ID of the item that was checked.

Description

Gets the formatted requirement dependent on whether an inventory has the required ingredients.

Parameters

# Name Type Note
1 inventory Table The inventory to check against.
2 uniqueID String ID of the item being checked.
3 amount Number Amount of items the player needs to have.

Return Values

# Name Type Note
1 No name provided String Formatted requirement.

Description

Gives the player items crafted from the blueprint.

Parameters

# Name Type Note
1 player Entity Player being given the items.
2 item String ID of the item being given.
3 amount Number Amount of items to give.

Return Values

None.

Description

Takes items from the player required to be taken by the blueprint that was crafted.

Parameters

# Name Type Note
1 player Entity Player having the items taken from.
2 item String ID of the item to take.
3 amount Number Amount of items to take.

Return Values

None.

Description

A function to craft a blueprint.

Parameters

# Name Type Note
1 player Entity Player crafting the blueprint.
2 blueprintTable Table Blueprint being crafted.

Return Values

None.

Description

A function to get a blueprint by its ID.

Parameters

# Name Type Note
1 identifier String ID of the blueprint being found.

Return Values

# Name Type Note
1 No name provided Table Blueprint that was found.

Description

Formats the requirements to a specific way to improve readability when looking at the tooltip.

Parameters

# Name Type Note
1 inventory Table The inventory table to check against.
2 blueprintTable Table Blueprint having its requirements formatted.

Return Values

# Name Type Note
1 No name provided String Formatted requirements for the blueprint.

Description

Gets the appropriate icon for the blueprint when being displayed in the crafting menu.

Parameters

# Name Type Note
1 blueprintTable Table Blueprint getting the icon for.

Return Values

# Name Type Note
1 No name provided String Model the blueprint will be set to.
2 No name provided String Skin the model will be set to.

Description

A function to get an item's markup tool tip.

Parameters

# Name Type Note
1 blueprintTable Table Blueprint getting the tooltip for.
2 isBusinessStyle Bool Whether or not the tool tip wil be displayed in the business style.
3 Callback Function Called when the tooltip is displayed.

Return Values

# Name Type Note
1 No name provided String The tool tip to be displayed.

Description

A function to give items to a player from crafting a blueprint.

Parameters

# Name Type Note
1 player Entity Player crafting the blueprint.
2 blueprintTable Table Blueprint being crafted.

Return Values

None.

Description

A function to create a new blueprint.

Parameters

# Name Type Note
1 baseBlueprint String Blueprint base to inherit from.
2 isBaseBlueprint Bool Whether blueprint being created is a base blueprint.

Return Values

# Name Type Note
1 No name provided Table Blueprint just created.

Description

A function to register a new blueprint.

Parameters

# Name Type Note
1 blueprintTable Table Blueprint to register.

Return Values

None.

Description

A function to take items from a player from crafting a blueprint.

Parameters

# Name Type Note
1 player Entity Player crafting the blueprint.
2 blueprintTable Table Blueprint being crafted.

Return Values

None.

Description

A function to add a currency.

Parameters

# Name Type Note
1 name Unknown Missing description for name.
2 model Unknown Missing description for model.
3 defaultValue Unknown Missing description for defaultValue.

Return Values

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

Description

A function to get a currency table.

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 hook a data stream.

Parameters

# Name Type Note
1 name String A unique identifier.
2 Callback Function The datastream callback.

Return Values

None.

Description

A function to listen for a request.

Parameters

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

Return Values

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

Description

A function to send a request.

Parameters

# Name Type Note
1 name Unknown Missing description for name.
2 data Unknown Missing description for data.
3 Callback Unknown Missing description for Callback.

Return Values

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

Description

A function to start a data stream.

Parameters

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

Return Values

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

Description

Sends a derma popup message to a specific player.

Parameters

# Name Type Note
1 player Player The player to send the request to.
2 message String The message to send to the player.
3 title String A title string to apply to the derma popup (Optional).
4 button String An optional button text override (Optional).

Return Values

None.

Description

Requests a confirmation from a player. When called, it displays a question box with a Confirm and Cancel button.

Parameters

# Name Type Note
1 player Player The player to send the request to.
2 title String A title string to apply to the derma popup.
3 question String The question to ask in the derma popup.
4 Callback Function A callback function. It passes the answer as an argument.

Return Values

None.

Description

Requests a string in the form of a derma popup on the specified client.

Parameters

# Name Type Note
1 player Player The player to send the request to.
2 title String A title string to apply to the derma popup.
3 question String The question to ask in the derma popup.
4 default String An optional default string for the answer.
5 Callback Function A callback function. It passes the answer as an argument.

Return Values

None.

Description

An internal function to validate a return

Parameters

# Name Type Note
1 player Unknown Missing description for player.
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 a donation subscription table.

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 whether the local player is subscribed to a donation.

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 register a new donation subscription.

Parameters

# Name Type Note
1 uniqueID Unknown Missing description for uniqueID.
2 friendlyName Unknown Missing description for friendlyName.
3 description Unknown Missing description for description.
4 imageName Unknown Missing description for imageName.

Return Values

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

Description

A function to bash in a door entity.

Parameters

# Name Type Note
1 entity Entity The door being bashed in.
2 eBasher Entity The entity bashing in the door.

Return Values

None.

Description

A function to get whether an entity belongs to a player's other character.

Parameters

# Name Type Note
1 player Entity The player being checked if the item belongs to it.
2 entity Entity The entity being checked for ownership.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the entity belongs to the player.

Description

A function to blast down a door off its hinges.

Parameters

# Name Type Note
1 entity Entity The door being blasted off its hinges.
2 force Number The blast strength that should be applied to the door.
3 attacker Entity The entity that is blasting the door off its hinges.

Return Values

None.

Description

A function to calculate a door's text position.

Parameters

# Name Type Note
1 door Entity The door getting its text position calculated.
2 reversed Bool Optional: Whether or not the other side of the door text position is being calculated.

Return Values

# Name Type Note
1 No name provided Function Recall to this function.

Description

A function to get whether an entity can see an entity from its own position.

Parameters

# Name Type Note
1 entity Entity The entity that's being checked on if it can see another entity.
2 target Entity The entity being checked if it can be seen.
3 iAllowance Number Optional: Variance around the entity being checked.
4 tIgnoreEnts Entity Optional: Entities that should be ignored when checking if an entity can see another entity.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the entity can see another entity.

Description

A function to get whether an entity can see an NPC from its own position.

Parameters

# Name Type Note
1 entity Entity The entity that's being checked on if it can see an NPC.
2 target Entity The NPC being check if it can be seen.
3 iAllowance Number Optional: Variance around the position being checked.
4 tIgnoreEnts Entity Optional: Entities that should be ignored when checking if an entity can see an NPC.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the entity can see an NPC.

Description

A function to get whether an entity can see a player from its own position.

Parameters

# Name Type Note
1 entity Entity The entity that's being checked on if it can see a player.
2 target Entity The player being checked if it can be seen.
3 iAllowance Number Optional: Variance around the position being checked.
4 tIgnoreEnts Entity Optional: Entities that should be ignored when checking if an entity can see a player.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the entity can see a player.

Description

A function to get whether an entity can see a position from its own position.

Parameters

# Name Type Note
1 entity Entity The entity that's being checked on if it can see a position.
2 position Vector Location being checked if the entity can see it.
3 iAllowance Number Optional: Variance around the position being checked.
4 tIgnoreEnts Entity Optional: Entities that should be ignored when checking if an entity can see a position.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the entity can see a position.

Description

A function to clear an entity as property.

Parameters

# Name Type Note
1 entity Entity The entity being cleared from the properties

Return Values

None.

Description

A function to copy an entity's owner.

Parameters

# Name Type Note
1 entity Entity The entity getting the properties copied from.
2 target Entity The entity getting the properties pasted to.

Return Values

None.

Description

A function to create cash.

Parameters

# Name Type Note
1 ownerObj Entity :Table} The owner(s) of the cash being created.
2 cash Number How much cash to create.
3 position Vector Where to create the cash.
4 angles Angle Optional: Angles to set the created cash to.

Return Values

# Name Type Note
1 No name provided Entity Reference to the cash just created.

Description

A function to create generator.

Parameters

# Name Type Note
1 ownerObj Entity :Table} The owner(s) of the generator being created.
2 class String Entity class for the generator to be assigned to.
3 position Vector Position the generator is set to.
4 angles Angle Optional: Angles the generator is set to.

Return Values

# Name Type Note
1 No name provided Entity Reference to the generator created.

Description

A function to create an item.

Parameters

# Name Type Note
1 ownerObj Entity :Table} The owner(s) of the item being created.
2 itemTable String ID for the item that is to be created.
3 position Vector Position the item is set to when created.
4 angles Angle Optional: Angles the item is set to.

Return Values

# Name Type Note
1 No name provided Entity Reference to the item created.

Description

A function to create a shipment.

Parameters

# Name Type Note
1 ownerObj Entity :Table} The owner(s) of the shipment being created.
2 uniqueID String Unique ID of the item being stored in the shipment.
3 batch Number How many items stored in the shipment.
4 position Vector Position the shipment is created at.
5 angles Angle Optional: Angles the shipment is set to.

Return Values

# Name Type Note
1 No name provided Entity Reference to the shipment that was created.

Description

A function to make an entity decay.

Parameters

# Name Type Note
1 entity Entity The entity being decayed.
2 seconds Number How fast the entity should decay.
3 Callback Function What to run just before the entity is removed.

Return Values

None.

Description

A function to make an entity disintegrate.

Parameters

# Name Type Note
1 entity Entity The entity being disintegrated.
2 delay Number How long to wait until disintegrating the entity.
3 velocity Number Optional: Adds speed to the entity once it gets disintegrated.
4 Callback Function What to run after the entity disintegrates.

Return Values

None.

Description

A function to dissolve an entity using a Source effect.

Parameters

# Name Type Note
1 entity Entity The entity that will be dissolved.
2 dissolveType String Dissolving effect to be applied to the entity.
3 iRemoveDelay Number Optional: Time until the entity is removed.
4 attacker Entity Optional: The entity that is set as the dissolved entity's attacker.

Return Values

# Name Type Note
1 No name provided Entity Reference to the entity making the dissolving effects.

Description

A function to get whether a door has shared access.

Parameters

# Name Type Note
1 entity Entity The door being checked if it has a shared access.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the door has a shared access to another door.

Description

A function to get whether a door has shared text.

Parameters

# Name Type Note
1 entity Entity The door being checked if it has shared text.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the door has shared text.

Description

A function to drop items and cash.

Parameters

# Name Type Note
1 inventory Table The inventory being dropped.
2 cash Number How much cash to drop.
3 position Vector Where the items and cash should drop.
4 entity Entity The owner of the items and cash being dropped.

Return Values

None.

Description

A function to fetch the entity's item data.

Parameters

# Name Type Note
1 entity Entity The entity getting the item data from.

Return Values

None.

Description

A function to fetch the entity's item table.

Parameters

# Name Type Note
1 entity Entity The entity getting the item table from.

Return Values

# Name Type Note
1 No name provided Table Contains the entity's item table.

Description

A function to force a menu option.

Parameters

# Name Type Note
1 entity Entity The entity having the menu option created on.
2 option String The name of the option to be displayed (not implemented?).
3 arguments String Interaction action to be done (e.g. cwItemTake).

Return Values

None.

Description

A function to get a door's children.

Parameters

# Name Type Note
1 door Entity The door to get the children from.

Return Values

# Name Type Note
1 No name provided Table The children of the door.

Description

A function to get a door's name.

Parameters

# Name Type Note
1 entity Entity Door getting its name checked.

Return Values

# Name Type Note
1 No name provided String Name of the door.

Description

A function to get a door's parent.

Parameters

# Name Type Note
1 door Entity The door that the parent should be gotten from.

Return Values

# Name Type Note
1 No name provided Table The parent of the door (if it exists).

Description

A function to get a door entity's partners which are doors that open along with it.

Parameters

# Name Type Note
1 entity Entity The entity to get the door partners from.

Return Values

# Name Type Note
1 No name provided Table A list of partners on the door entity.

Description

A function to get an entity's door state.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Table The state of the door.

Description

A function to get the text being displayed on a door.

Parameters

# Name Type Note
1 entity Entity Door getting its text from.

Return Values

# Name Type Note
1 No name provided String Text being displayed on the door.

Description

A function to get a weapon's muzzle position from its viewmodel.

Parameters

# Name Type Note
1 weapon Entity The player's current weapon.
2 attachment Entity The player's attachment on the weapon.

Return Values

# Name Type Note
1 No name provided Vector The coordinates of weapon's muzzle position.
2 No name provided Angle The angle of the weapon's muzzle position.

Description

A function to get an entity's owner.

Parameters

# Name Type Note
1 entity Entity The entity getting the owner from.
2 bAnyCharacter Bool Whether or not to get the owner even if the entity has no entity key.

Return Values

# Name Type Note
1 No name provided Entity The owner of the entity.

Description

A function to get a ragdoll entity's pelvis position.

Parameters

# Name Type Note
1 entity Entity The entity to get the pelvis position from.

Return Values

# Name Type Note
1 No name provided Vector Coordinates of the entity's pelvis.

Description

A function to get a player from an entity.

Parameters

# Name Type Note
1 entity Entity The entity getting the player from.

Return Values

# Name Type Note
1 No name provided Entity The player from the entity.

Description

A function to get an entity's start angles.

Parameters

# Name Type Note
1 entity Entity The entity to get the angles from

Return Values

# Name Type Note
1 No name provided Angle Start angle for the entity.

Description

A function to get an entity's start position.

Parameters

# Name Type Note
1 entity Entity The entity getting the start position from.

Return Values

# Name Type Note
1 No name provided Vector The start position of the entity.

Description

A function to get whether an item's data has been fetched.

Parameters

# Name Type Note
1 entity Entity The entity being checked if the item data has been fetched.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the item data has been fetched.

Description

A function to get whether an entity has an owner.

Parameters

# Name Type Note
1 entity Entity The entity being checked if it has an owner.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the entity has an owner.

Description

A function to get whether an entity is a chair.

Parameters

# Name Type Note
1 entity Entity The Entity being checked if it is a chair entity.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the entity is a chair entity.

Description

A function to get whether an entity is decaying by being in the process of fading out and being removed.

Parameters

# Name Type Note
1 entity Entity The entity being checked as decaying or not.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the entity is decaying.

Description

A function to check if an entity is a door or not by seeing if its name includes "door" or if the entity is one of the following classes: "func_door", "func_door_rotating", "prop_door_rotating", "func_movelinear"

Parameters

# Name Type Note
1 entity Entity The entity being check as a door.

Return Values

# Name Type Note
1 No name provided Bool Whether the entity is a door or not.

Description

A function to get whether a door is false.

Parameters

# Name Type Note
1 entity Entity Door being check as false.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the door is false or not.

Description

A function to get whether a door is hidden.

Parameters

# Name Type Note
1 entity Entity Door being checked as hidden.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the door is hidden or not.

Description

A function to get whether a door is locked.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the door is locked.

Description

A function to get whether a door is a parent or not.

Parameters

# Name Type Note
1 door Entity The door being checked as a parent.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the door has any children (thus making it a parent door if it does, otherwise if not).

Description

A function to get whether a door is unownable by a player.

Parameters

# Name Type Note
1 entity Entity Door being checked as unownable.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the door is unownable.

Description

A function to get whether a door is unsellable.

Parameters

# Name Type Note
1 door Entity The door being checked as unsellable.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the door is unsellable.

Description

A function to check if an entity is in a specified box area.

Parameters

# Name Type Note
1 entity Entity The entity to check if it's in a box.
2 minimum Number Minimum position to check in.
3 maximum Number Maximum position to check in.

Return Values

# Name Type Note
1 No name provided Bool Whether or not an entity is within the defined box.

Description

A function to get whether an entity is interactable.

Parameters

# Name Type Note
1 entity Entity The entity being checked if it is interactable.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the entity is interactable.

Description

A function to get whether an entity is a map entity.

Parameters

# Name Type Note
1 entity Entity The entity being checked as a map entity.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the entity is a map entity.

Description

A function to get whether an entity is a physics entity.

Parameters

# Name Type Note
1 entity Entity The entity being checked if it is a physics entity.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the entity is a physicas entity.

Description

A function to get whether an entity is a player in ragdoll form.

Parameters

# Name Type Note
1 entity Entity The entity getting checked as a player ragdoll.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the entity is a player ragdoll.

Description

A function to get whether an entity is a pod.

Parameters

# Name Type Note
1 entity Entity The entity being checked if it is a pod entity.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the entity is a pod entity.

Description

A function to make an entity flush with the ground.

Parameters

# Name Type Note
1 entity Entity The entity being flushed the the ground.
2 position Vector Initial position of the entity being flushed.
3 normal Number Normalization for refining flushing.

Return Values

None.

Description

A function to make an entity into a ragdoll.

Parameters

# Name Type Note
1 entity Entity The entity being made in to a ragdoll.
2 force Number The amount of force applied to the entity upon being made in to a ragdoll.
3 overrideVelocity Number What the entity's velocity should be forcibly set to.
4 overrideAngles Angle What the entity's angles should be set to.

Return Values

None.

Description

A function to make an entity safe.

Parameters

# Name Type Note
1 entity Entity The entity being made safe.
2 bPhysgunProtect Bool Whether or not the entity should be safe from physguns.
3 tToolProtect Table List of tools that can't be used on the entity.
4 bFreezeEntity Bool Whether or not the entity should be frozen.

Return Values

None.

Description

A function to open a door.

Parameters

# Name Type Note
1 entity Entity The door to be opened.
2 delay Number Delay until the door should be opened.
3 bUnlock Bool Whether or not the door should be unlocked.
4 bSound Bool Whether or not a sound should be played for unlocking the door.
5 origin Vector Postition that the info_target is created at.
6 fSpeed Float Not implemented.

Return Values

None.

Description

A function to query an entity's property table.

Parameters

# Name Type Note
1 entity Entity The entity getting the properties from.
2 key String Which property is being queried.
3 default String Fallback value to return if no property is found.

Return Values

# Name Type Note
1 No name provided String Value of the property that was queried.

Description

A function to return an entity's collision group.

Parameters

# Name Type Note
1 entity Entity Which entity to restore the collision group on.
2 collisionGroup String What the collision group is set to on the entity.

Return Values

None.

Description

A function to set an entity's chair animations.

Parameters

# Name Type Note
1 entity Entity The entity having its animation set.

Return Values

None.

Description

A function to set whether a door is false.

Parameters

# Name Type Note
1 entity Entity The door being set to false.
2 isFalse Bool Whether the door should be false or not.

Return Values

None.

Description

A function to set whether a door is hidden.

Parameters

# Name Type Note
1 entity Entity The door being set to hidden.
2 hidden Bool Whether or not the doro should be set to hidden.

Return Values

None.

Description

A function to set a door's name.

Parameters

# Name Type Note
1 entity Entity The door getting its name set.
2 name String What the door's name will be set to.

Return Values

None.

Description

A function to set a door's parent.

Parameters

# Name Type Note
1 door Entity The door being set as a child.
2 parent Entity The door being set as the parent for the child.

Return Values

None.

Description

A function to set whether a door has shared access.

Parameters

# Name Type Note
1 entity Entity The door being given shared access.
2 sharedAccess Entity What has shared access to the door.

Return Values

None.

Description

A function to set a shared door's text

Parameters

# Name Type Note
1 entity Entity The door having its shared text set.
2 sharedText String The text that will be displayed on the shared door.

Return Values

None.

Description

A function to temporarily set a door's speed to fast.

Parameters

# Name Type Note
1 entity Entity The door getting its speed set to fast.

Return Values

None.

Description

A function to set a door's text.

Parameters

# Name Type Note
1 entity Entity The door getting its text set.
2 text String What the door's text will be set to.

Return Values

None.

Description

A function to set a door as unownable.

Parameters

# Name Type Note
1 entity Entity The door being set to unownable.
2 unownable Bool Whether or not the door should be set to unownable.

Return Values

None.

Description

A function to set whether an entity is a map entity.

Parameters

# Name Type Note
1 entity Entity The entity being set as a map entity or not.
2 isMapEntity Bool Whether or not the entity is a map entity.

Return Values

None.

Description

A function to set an entity's player.

Parameters

# Name Type Note
1 entity Entity The entity being set to a player.
2 player Entity What to set the entity's player to.

Return Values

None.

Description

A function to set a property variable for an entity.

Parameters

# Name Type Note
1 entity Entity The entity having its property var set.
2 key String ID for the property being set.
3 value String Value the property is being set to.

Return Values

None.

Description

A function to set an entity's start angles.

Parameters

# Name Type Note
1 entity Entity The entity having its start angles being set.
2 angles Angle What the start angles are set to.

Return Values

None.

Description

A function to set an entity's start position.

Parameters

# Name Type Note
1 entity Entity The entity having its start position set.
2 position Vector Start position the entity is set to.

Return Values

None.

Description

A function to statue a ragdoll.

Parameters

# Name Type Note
1 entity Entity The entity being set as a statue.
2 forceLimit Number How much force a bone can take before the weld breaks.

Return Values

None.

Description

A function to stop an entity's collision group restore.

Parameters

# Name Type Note
1 entity Entity Which entity to stop the collision group restore on.

Return Values

None.

Description

A function to get whether an event can run.

Parameters

# Name Type Note
1 eventClass Unknown Missing description for eventClass.
2 eventName Unknown Missing description for eventName.

Return Values

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

Description

A function to hook into an event.

Parameters

# Name Type Note
1 eventClass Unknown Missing description for eventClass.
2 eventName Unknown Missing description for eventName.
3 isAllowed Unknown Missing description for isAllowed.

Return Values

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

Description

A function to find a faction 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 the default rank of 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

A function to get the rank with the next lowest 'position' (next highest rank).

Parameters

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

Return Values

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

Description

A function to get the rank with the lowest 'position' (highest rank) in this 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

A function to get the faction limit.

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 get the rank with the next highest 'position' (next lowest rank).

Parameters

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

Return Values

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

Description

A function to get the rank with the highest 'position' (lowest rank) in this 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

A function to get each player in 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

A function to get whether a gender is valid.

Parameters

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

Return Values

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

Description

A function to get whether a model is valid.

Parameters

# Name Type Note
1 faction Unknown Missing description for faction.
2 gender Unknown Missing description for gender.
3 model Unknown Missing description for model.

Return Values

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

Description

A function to get a new faction.

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

Parameters

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

Return Values

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

Description

A function to add a new flag.

Parameters

# Name Type Note
1 flag Unknown Missing description for flag.
2 name Unknown Missing description for name.
3 details Unknown Missing description for details.

Return Values

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

Description

A function to get a flag.

Parameters

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

Return Values

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

Description

A function to get a flag's details.

Parameters

# Name Type Note
1 flag Unknown Missing description for flag.
2 default Unknown Missing description for default.

Return Values

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

Description

A function to get a flag by it's name.

Parameters

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

Return Values

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

Description

A function to get a flag's name.

Parameters

# Name Type Note
1 flag Unknown Missing description for flag.
2 default Unknown Missing description for default.

Return Values

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

Description

A function to find a generator 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 register a new generator.

Parameters

# Name Type Note
1 name Unknown Missing description for name.
2 power Unknown Missing description for power.
3 health Unknown Missing description for health.
4 maximum Unknown Missing description for maximum.
5 cash Unknown Missing description for cash.
6 uniqueID Unknown Missing description for uniqueID.
7 powerName Unknown Missing description for powerName.
8 powerPlural Unknown Missing description for powerPlural.

Return Values

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

Description

A function to get the amount of items an entity has in its inventory by ID.

Parameters

# Name Type Note
1 inventory Table Inventory of the entity.
2 uniqueID Number ID of item looked up in the inventory to get the amount.

Return Values

# Name Type Note
1 No name provided Number Number of items in the inventory that match the ID.

Description

A function to get whether a player has a specific amount of items in their inventory by ID.

Parameters

# Name Type Note
1 inventory Table Inventory of the entity.
2 uniqueID Number ID of the item being checked for its amount in the inventory.
3 amount Number Amount of items the entity needs to have in order to return true.

Return Values

# Name Type Note
1 No name provided Bool Whether the entity has a specific amount of items in its inventory or not.

Description

A function to add some cinematic text.

Parameters

# Name Type Note
1 text Unknown Missing description for text.
2 color Unknown Missing description for color.
3 barLength Unknown Missing description for barLength.
4 hangTime Unknown Missing description for hangTime.
5 font Unknown Missing description for font.
6 bThisOnly Unknown Missing description for bThisOnly.

Return Values

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

Description

A function to add files to the content download.

Parameters

# Name Type Note
1 directory Unknown Missing description for directory.
2 bRecursive Unknown Missing description for bRecursive.

Return Values

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

Description

A function to add a file to the content download.

Parameters

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

Return Values

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

Description

A function to add a markup line.

Parameters

# Name Type Note
1 markupText Unknown Missing description for markupText.
2 text Unknown Missing description for text.
3 color Unknown Missing description for color.

Return Values

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

Description

A function to add a menu from data.

Parameters

# Name Type Note
1 menuPanel Unknown Missing description for menuPanel.
2 data Unknown Missing description for data.
3 Callback Unknown Missing description for Callback.
4 minimumWidth Unknown Missing description for minimumWidth.
5 manualOpen Unknown Missing description for manualOpen.

Return Values

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

Description

A function to add a notice.

Parameters

# Name Type Note
1 text Unknown Missing description for text.
2 class Unknown Missing description for class.
3 length Unknown Missing description for length.

Return Values

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

Description

A function to adjust the width of text.

Parameters

# Name Type Note
1 font Unknown Missing description for font.
2 text Unknown Missing description for text.
3 width Unknown Missing description for width.
4 addition Unknown Missing description for addition.
5 extra Unknown Missing description for extra.

Return Values

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

Description

A function to get whether two tables are equal.

Parameters

# Name Type Note
1 tableA Table The first unique table to compare.
2 tableB Table The second unique table to compare.

Return Values

# Name Type Note
1 No name provided Bool Whether or not the tables are equal.

Description

A function to calculate alpha from a distance.

Parameters

# Name Type Note
1 maximum Unknown Missing description for maximum.
2 start Unknown Missing description for start.
3 finish Unknown Missing description for finish.

Return Values

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

Description

A function to calculate player damage.

Parameters

# Name Type Note
1 player Unknown Missing description for player.
2 hitGroup Unknown Missing description for hitGroup.
3 damageInfo Unknown Missing description for damageInfo.

Return Values

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

Description

A function to calculate a player's spawn time.

Parameters

# Name Type Note
1 player Unknown Missing description for player.
2 inflictor Unknown Missing description for inflictor.
3 attacker Unknown Missing description for attacker.
4 damageInfo Unknown Missing description for damageInfo.

Return Values

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

Description

A function to perform the timer think.

Parameters

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

Return Values

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

Description

A function to check if Clockwork data exists.

Parameters

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

Return Values

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

Description

A function to get markup from a color.

Parameters

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

Return Values

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

Description

A function to convert a force.

Parameters

# Name Type Note
1 force Unknown Missing description for force.
2 limit Unknown Missing description for limit.

Return Values

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

Description

A function to convert a networked class.

Parameters

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

Return Values

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

Description

A function to create blood effects at a position.

Parameters

# Name Type Note
1 position Unknown Missing description for position.
2 decals Unknown Missing description for decals.
3 entity Unknown Missing description for entity.
4 forceVec Unknown Missing description for forceVec.
5 fScale Unknown Missing description for fScale.

Return Values

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

Description

A function to create a client ConVar.

Parameters

# Name Type Note
1 name Unknown Missing description for name.
2 value Unknown Missing description for value.
3 save Unknown Missing description for save.
4 userData Unknown Missing description for userData.
5 Callback Unknown Missing description for Callback.

Return Values

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

Description

A function to create a ConVar.

Parameters

# Name Type Note
1 name Unknown Missing description for name.
2 value Unknown Missing description for value.
3 flags Unknown Missing description for flags.
4 Callback Unknown Missing description for Callback.

Return Values

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

Description

A function to create a custom category panel.

Parameters

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

Return Values

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

Description

A function to create a decal.

Parameters

# Name Type Note
1 texture Unknown Missing description for texture.
2 position Unknown Missing description for position.
3 temporary Unknown Missing description for temporary.

Return Values

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

Description

A function to create the info menu panel.

Parameters

# Name Type Note
1 x Unknown Missing description for x.
2 y Unknown Missing description for y.
3 minimumWidth Unknown Missing description for minimumWidth.

Return Values

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

Description

A function to create a markup tool tip.

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 create a multicall table (by Deco Da Man).

Parameters

# Name Type Note
1 baseTable Unknown Missing description for baseTable.
2 object Unknown Missing description for object.

Return Values

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

Description

A function to create a timer.

Parameters

# Name Type Note
1 name Unknown Missing description for name.
2 delay Unknown Missing description for delay.
3 repetitions Unknown Missing description for repetitions.
4 Callback Unknown Missing description for Callback.
5 ... Unknown Missing description for ....

Return Values

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

Description

A function to delete Clockwork data.

Parameters

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

Return Values

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

Description

A function to delete schema data.

Parameters

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

Return Values

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

Description

A function to deserialize a string.

Parameters

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

Return Values

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

Description

A function to destroy a timer.

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 do the entity take damage hook.

Parameters

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

Return Values

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

Description

A function to draw a bar with a value and a maximum.

Parameters

# Name Type Note
1 x Unknown Missing description for x.
2 y Unknown Missing description for y.
3 width Unknown Missing description for width.
4 height Unknown Missing description for height.
5 color Unknown Missing description for color.
6 text Unknown Missing description for text.