diff --git a/sf_doc.json b/sf_doc.json
index 9ee5d8135..156390cf0 100644
--- a/sf_doc.json
+++ b/sf_doc.json
@@ -1 +1 @@
-{"Libraries":{"coroutine":{"methods":{"status":{"path":"libs_sh/coroutine.lua#L109","returns":[{"type":"string","value":"string Either \"suspended\", \"running\", \"normal\" or \"dead\"","description":"Either \"suspended\", \"running\", \"normal\" or \"dead\""}],"realm":"shared","params":[{"type":"thread","value":"thread coroutine The coroutine","name":"coroutine","description":"The coroutine"}],"class":"function","name":"status","description":" Returns the status of the coroutine."},"yield":{"path":"libs_sh/coroutine.lua#L97","returns":[{"type":"...","value":"... Any values passed to the coroutine","description":"Any values passed to the coroutine"}],"realm":"shared","params":[{"type":"...","value":"... Optional parameters that will be returned to the main thread","name":"Optional","description":"parameters that will be returned to the main thread"}],"class":"function","name":"yield","description":" Suspends the currently running coroutine. May not be called outside a coroutine."},"running":{"path":"libs_sh/coroutine.lua#L118","returns":[{"type":"thread","value":"thread Currently running coroutine","description":"Currently running coroutine"}],"realm":"shared","class":"function","name":"running","description":" Returns the coroutine that is currently running."},"wrap":{"path":"libs_sh/coroutine.lua#L78","returns":[{"type":"function","value":"function A function that, when called, resumes the created coroutine. Any parameters to that function will be passed to the coroutine.","description":"A function that, when called, resumes the created coroutine. Any parameters to that function will be passed to the coroutine."}],"realm":"shared","params":[{"type":"function","value":"function func Function of the coroutine","name":"func","description":"Function of the coroutine"}],"class":"function","name":"wrap","description":" Creates a new coroutine."},"wait":{"path":"libs_sh/coroutine.lua#L125","realm":"shared","params":[{"type":"number","value":"number time Time in seconds to suspend the coroutine","name":"time","description":"Time in seconds to suspend the coroutine"}],"class":"function","name":"wait","description":" Suspends the coroutine for a number of seconds. Note that the coroutine will not resume automatically, but any attempts to resume the coroutine while it is waiting will not resume the coroutine and act as if the coroutine suspended itself immediately."},"create":{"path":"libs_sh/coroutine.lua#L69","returns":[{"type":"thread","value":"thread Created coroutine","description":"Created coroutine"}],"realm":"shared","params":[{"type":"function","value":"function func Function of the coroutine","name":"func","description":"Function of the coroutine"}],"class":"function","name":"create","description":" Creates a new coroutine."},"resume":{"path":"libs_sh/coroutine.lua#L87","returns":[{"type":"...","value":"... Any values the coroutine is returning to the main thread","description":"Any values the coroutine is returning to the main thread"}],"realm":"shared","params":[{"type":"thread","value":"thread coroutine to resume","name":"coroutine","description":"to resume"},{"type":"...","value":"... args Optional parameters that will be passed to the coroutine","name":"args","description":"Optional parameters that will be passed to the coroutine"}],"class":"function","name":"resume","description":" Resumes a suspended coroutine. Note that, in contrast to Lua's native coroutine.resume function, it will not run in protected mode and can throw an error."}},"tables":[],"path":"libs_sh/coroutine.lua#L5","libtbl":["coroutine_library"],"realm":"shared","fields":[],"class":"library","name":"coroutine","description":" Coroutine library"},"bass":{"methods":{"loadURL":{"path":"libs_cl/bass.lua#L212","realm":"client","params":[{"type":"string","value":"string path URL path to play from.","name":"path","description":"URL path to play from."},{"type":"string","value":"string flags Flags for the sound (`3d`, `mono`, `noplay`, `noblock`). noblock will fail if the webserver doesn't provide file length.","name":"flags","description":"Flags for the sound (`3d`, `mono`, `noplay`, `noblock`). noblock will fail if the webserver doesn't provide file length."},{"type":"function","value":"function callback Function which is called when the sound is loaded. It'll get 3 arguments: `Bass` object, error number and name.","name":"callback","description":"Function which is called when the sound is loaded. It'll get 3 arguments: `Bass` object, error number and name."}],"class":"function","name":"loadURL","description":" Loads a sound as a Bass object from a URL.\n 2D sounds require a HUD connection."},"loadFile":{"path":"libs_cl/bass.lua#L194","realm":"client","params":[{"type":"string","value":"string path File path to play from.","name":"path","description":"File path to play from."},{"type":"string","value":"string flags Flags for the sound (`3d`, `mono`, `noplay`, `noblock`).","name":"flags","description":"Flags for the sound (`3d`, `mono`, `noplay`, `noblock`)."},{"type":"function","value":"function callback Function which is called when the sound is loaded. It'll get 3 arguments: `Bass` object, error number and name.","name":"callback","description":"Function which is called when the sound is loaded. It'll get 3 arguments: `Bass` object, error number and name."}],"class":"function","name":"loadFile","description":" Loads a sound as a Bass object from a file.\n 2D sounds require a HUD connection."},"soundsLeft":{"path":"libs_cl/bass.lua#L230","returns":[{"type":"number","value":"number The number of sounds left.","description":"The number of sounds left."}],"realm":"client","class":"function","name":"soundsLeft","description":" Returns the number of sounds left that can be created."}},"tables":[],"path":"libs_cl/bass.lua#L123","libtbl":["bass_library"],"realm":"client","fields":[],"class":"library","name":"bass","description":" `bass` library is intended to be used only on client side. It's good for streaming local and remote sound files and playing them directly in player's \"2D\" context."},"hook":{"methods":{"run":{"path":"libs_sh/hook.lua#L664","returns":[{"type":"...","value":"... returns Return result(s) of the hook ran","description":"returns Return result(s) of the hook ran"}],"realm":"shared","params":[{"type":"string","value":"string hookname The hook name","name":"hookname","description":"The hook name"},{"type":"...","value":"... arguments Arguments to pass to the hook","name":"arguments","description":"Arguments to pass to the hook"}],"class":"function","name":"run","description":" Run a hook and return the result"},"add":{"path":"libs_sh/hook.lua#L644","realm":"shared","params":[{"type":"string","value":"string hookname Name of the event","name":"hookname","description":"Name of the event"},{"type":"string","value":"string name Unique identifier","name":"name","description":"Unique identifier"},{"type":"function","value":"function func Function to run","name":"func","description":"Function to run"}],"class":"function","name":"add","description":" Sets a hook function"},"remove":{"path":"libs_sh/hook.lua#L733","realm":"shared","params":[{"type":"string","value":"string hookname The hook name","name":"hookname","description":"The hook name"},{"type":"string","value":"string name The unique name for this hook","name":"name","description":"The unique name for this hook"}],"class":"function","name":"remove","description":" Remove a hook"},"runRemote":{"path":"libs_sh/hook.lua#L696","returns":[{"type":"table","value":"table A list of the resultset of each called hook","description":"A list of the resultset of each called hook"}],"realm":"shared","params":[{"type":"Entity?","value":"Entity? recipient Starfall entity to call the hook on. Nil to run on every starfall entity","name":"recipient","description":"Starfall entity to call the hook on. Nil to run on every starfall entity"},{"type":"...","value":"... payload Parameters that will be passed when calling hook functions","name":"payload","description":"Parameters that will be passed when calling hook functions"}],"class":"function","name":"runRemote","description":" Run a hook remotely.\n This will call the hook \"remote\" on either a specified entity or all instances on the server/client"}},"tables":[],"path":"libs_sh/hook.lua#L622","libtbl":["hook_library"],"realm":"shared","fields":[],"class":"library","name":"hook","description":" Deals with hooks"},"material":{"methods":{"getFloat":{"path":"libs_cl/material.lua#L479","returns":[{"type":"number?","value":"number? The float value or nil if it doesn't exist","description":"The float value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"},{"type":"string","value":"string key The key to get the float from","name":"key","description":"The key to get the float from"}],"class":"function","name":"getFloat","description":" Returns a float keyvalue of a material"},"createFromImage":{"path":"libs_cl/material.lua#L559","returns":[{"type":"Material","value":"Material The Material created.","description":"The Material created."}],"realm":"client","params":[{"type":"string","value":"string path The path to the image file, must be a jpg or png image","name":"path","description":"The path to the image file, must be a jpg or png image"},{"type":"string","value":"string params The shader parameters to apply to the material. See https://wiki.facepunch.com/gmod/Material_Parameters","name":"params","description":"The shader parameters to apply to the material. See https://wiki.facepunch.com/gmod/Material_Parameters"}],"class":"function","name":"createFromImage","description":" Creates a .jpg or .png material from file\n Can't be modified"},"create":{"path":"libs_cl/material.lua#L539","returns":[{"type":"Material","value":"Material The Material created.","description":"The Material created."}],"realm":"client","params":[{"type":"string","value":"string shader The shader of the material. Must be one of","name":"shader","description":"The shader of the material. Must be one of"}],"class":"function","name":"create","description":" Creates a new blank material\n UnlitGeneric\n VertexLitGeneric\n Refract_DX90\n Water_DX90\n Sky_DX9\n gmodscreenspace\n Modulate_DX9"},"getMatrix":{"path":"libs_cl/material.lua#L499","returns":[{"type":"VMatrix?","value":"VMatrix? The matrix value or nil if it doesn't exist","description":"The matrix value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"},{"type":"string","value":"string key The key to get the matrix from","name":"key","description":"The key to get the matrix from"}],"class":"function","name":"getMatrix","description":" Returns a matrix keyvalue of a material"},"getVectorLinear":{"path":"libs_cl/material.lua#L529","returns":[{"type":"Vector?","value":"Vector? The vector value or nil if it doesn't exist","description":"The vector value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"},{"type":"string","value":"string key The key to get the vector from","name":"key","description":"The key to get the vector from"}],"class":"function","name":"getVectorLinear","description":" Returns a linear color-corrected vector keyvalue of a material"},"getKeyValues":{"path":"libs_cl/material.lua#L427","returns":[{"type":"table","value":"table The table of keyvalues","description":"The table of keyvalues"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"}],"class":"function","name":"getKeyValues","description":" Returns a table of keyvalues from a material"},"getColor":{"path":"libs_cl/material.lua#L467","returns":[{"type":"Color","value":"Color The color value","description":"The color value"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"},{"type":"number","value":"number x The x coordinate of the pixel","name":"x","description":"The x coordinate of the pixel"},{"type":"number","value":"number y The y coordinate of the pixel","name":"y","description":"The y coordinate of the pixel"}],"class":"function","name":"getColor","description":" Returns a color pixel value of the $basetexture of a .png or .jpg material."},"getShader":{"path":"libs_cl/material.lua#L443","returns":[{"type":"string","value":"string The shader name of the material","description":"The shader name of the material"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"}],"class":"function","name":"getShader","description":" Returns the shader name of a material"},"getInt":{"path":"libs_cl/material.lua#L489","returns":[{"type":"number?","value":"number? The int value or nil if it doesn't exist","description":"The int value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"},{"type":"string","value":"string key The key to get the int from","name":"key","description":"The key to get the int from"}],"class":"function","name":"getInt","description":" Returns an int keyvalue of a material"},"load":{"path":"libs_cl/material.lua#L402","returns":[{"type":"Material","value":"Material The material object. Can't be modified.","description":"The material object. Can't be modified."}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"}],"class":"function","name":"load","description":" Loads a .vmt material or existing material. Throws an error if the material fails to load\n Existing created materials can be loaded with ! prepended to the name\n Can't be modified"},"getTexture":{"path":"libs_cl/material.lua#L416","returns":[{"type":"string?","value":"string? The texture's name or nil if texture key isn't found","description":"The texture's name or nil if texture key isn't found"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"},{"type":"string","value":"string texture The texture key to get","name":"texture","description":"The texture key to get"}],"class":"function","name":"getTexture","description":" Gets a texture from a material"},"getString":{"path":"libs_cl/material.lua#L509","returns":[{"type":"string?","value":"string? The string value or nil if it doesn't exist","description":"The string value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"},{"type":"string","value":"string key The key to get the string from","name":"key","description":"The key to get the string from"}],"class":"function","name":"getString","description":" Returns a string keyvalue"},"getVector":{"path":"libs_cl/material.lua#L519","returns":[{"type":"Vector?","value":"Vector? The vector value or nil if it doesn't exist","description":"The vector value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"},{"type":"string","value":"string key The key to get the vector from","name":"key","description":"The key to get the vector from"}],"class":"function","name":"getVector","description":" Returns a vector keyvalue of a material"},"getName":{"path":"libs_cl/material.lua#L435","returns":[{"type":"string","value":"string The name of a material. If this material is user created, add ! to the beginning of this to use it with entity.setMaterial","description":"The name of a material. If this material is user created, add ! to the beginning of this to use it with entity.setMaterial"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"}],"class":"function","name":"getName","description":" Returns a material's engine name"},"getWidth":{"path":"libs_cl/material.lua#L451","returns":[{"type":"number","value":"number The basetexture's width","description":"The basetexture's width"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"}],"class":"function","name":"getWidth","description":" Returns the width of the member texture set for $basetexture of a material"},"getHeight":{"path":"libs_cl/material.lua#L459","returns":[{"type":"number","value":"number The basetexture's height","description":"The basetexture's height"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"}],"class":"function","name":"getHeight","description":" Returns the height of the member texture set for $basetexture of a material"}},"tables":[],"path":"libs_cl/material.lua#L367","libtbl":["material_library"],"realm":"client","fields":[],"class":"library","name":"material","description":" `material` library is allows creating material objects which are used for controlling shaders in rendering."},"team":{"methods":{"getPlayers":{"path":"libs_sh/team.lua#L28","returns":[{"type":"table","value":"table Table of players","description":"Table of players"}],"realm":"shared","params":[{"type":"number","value":"number ind Index of the team","name":"ind","description":"Index of the team"}],"class":"function","name":"getPlayers","description":" Returns the table of players on a team"},"getScore":{"path":"libs_sh/team.lua#L48","returns":[{"type":"number","value":"number Number score of the team","description":"Number score of the team"}],"realm":"shared","params":[{"type":"number","value":"number ind Index of the team","name":"ind","description":"Index of the team"}],"class":"function","name":"getScore","description":" Returns the score of a team"},"getNumPlayers":{"path":"libs_sh/team.lua#L62","returns":[{"type":"number","value":"number Number of players on the team","description":"Number of players on the team"}],"realm":"shared","params":[{"type":"number","value":"number ind Index of the team","name":"ind","description":"Index of the team"}],"class":"function","name":"getNumPlayers","description":" Returns number of players on a team"},"getName":{"path":"libs_sh/team.lua#L41","returns":[{"type":"string","value":"string String name of the team","description":"String name of the team"}],"realm":"shared","params":[{"type":"number","value":"number ind Index of the team","name":"ind","description":"Index of the team"}],"class":"function","name":"getName","description":" Returns the name of a team"},"getJoinable":{"path":"libs_sh/team.lua#L55","returns":[{"type":"boolean","value":"boolean Whether the team is joinable","description":"Whether the team is joinable"}],"realm":"shared","params":[{"type":"number","value":"number ind Index of the team","name":"ind","description":"Index of the team"}],"class":"function","name":"getJoinable","description":" Returns whether or not a team can be joined"},"exists":{"path":"libs_sh/team.lua#L83","returns":[{"type":"boolean","value":"boolean Whether the team exists","description":"Whether the team exists"}],"realm":"shared","params":[{"type":"number","value":"number ind Index of the team","name":"ind","description":"Index of the team"}],"class":"function","name":"exists","description":" Returns whether or not the team exists"},"getNumDeaths":{"path":"libs_sh/team.lua#L69","returns":[{"type":"number","value":"number Number of deaths","description":"Number of deaths"}],"realm":"shared","params":[{"type":"number","value":"number ind Index of the team","name":"ind","description":"Index of the team"}],"class":"function","name":"getNumDeaths","description":" Returns number of deaths of all players on a team"},"getAllTeams":{"path":"libs_sh/team.lua#L15","returns":[{"type":"table","value":"table Table containing team information","description":"Table containing team information"}],"realm":"shared","class":"function","name":"getAllTeams","description":" Returns a table containing team information"},"getNumFrags":{"path":"libs_sh/team.lua#L76","returns":[{"type":"number","value":"number Number of frags","description":"Number of frags"}],"realm":"shared","params":[{"type":"number","value":"number ind Index of the team","name":"ind","description":"Index of the team"}],"class":"function","name":"getNumFrags","description":" Returns number of frags of all players on a team"},"bestAutoJoinTeam":{"path":"libs_sh/team.lua#L35","returns":[{"type":"number","value":"number Index of the best team to join","description":"Index of the best team to join"}],"realm":"shared","class":"function","name":"bestAutoJoinTeam","description":" Returns team with least players"},"getColor":{"path":"libs_sh/team.lua#L21","returns":[{"type":"Color","value":"Color Color of the team","description":"Color of the team"}],"realm":"shared","params":[{"type":"number","value":"number ind Index of the team","name":"ind","description":"Index of the team"}],"class":"function","name":"getColor","description":" Returns the color of a team"}},"tables":[],"path":"libs_sh/team.lua#L2","libtbl":["team_library"],"realm":"shared","fields":[],"class":"library","name":"team","description":" Library for retreiving information about teams"},"http":{"methods":{"base64Decode":{"path":"libs_sh/http.lua#L153","returns":[{"type":"string","value":"string The converted data","description":"The converted data"}],"realm":"shared","params":[{"type":"string","value":"string data The data to convert","name":"data","description":"The data to convert"}],"class":"function","name":"base64Decode","description":" Converts data from base64 format"},"getMaximumRequests":{"path":"libs_sh/http.lua#L44","returns":[{"type":"number","value":"number Maximum amount of concurrent active HTTP get/post requests ","description":"Maximum amount of concurrent active HTTP get/post requests "}],"realm":"shared","class":"function","name":"getMaximumRequests","description":" Gets how many get/post operations can be in progress at the same time"},"urlDecode":{"path":"libs_sh/http.lua#L172","returns":[{"type":"string","value":"string The converted data","description":"The converted data"}],"realm":"shared","params":[{"type":"string","value":"string data The data to convert","name":"data","description":"The data to convert"}],"class":"function","name":"urlDecode","description":" Decodes the % escaped chars in a url"},"urlGoogleDriveToRaw":{"path":"libs_sh/http.lua#L186","returns":[{"type":"string","value":"string The converted url","description":"The converted url"}],"realm":"shared","params":[{"type":"string","value":"string url The url to convert","name":"url","description":"The url to convert"}],"class":"function","name":"urlGoogleDriveToRaw","description":" Converts a simple google drive url to a raw one"},"getActiveRequests":{"path":"libs_sh/http.lua#L38","returns":[{"type":"number","value":"number The current amount of active HTTP get/post requests","description":"The current amount of active HTTP get/post requests"}],"realm":"shared","class":"function","name":"getActiveRequests","description":" Gets how many get/post operations are currently in progress"},"post":{"path":"libs_sh/http.lua#L76","realm":"shared","params":[{"type":"string","value":"string url Http target url","name":"url","description":"Http target url"},{"type":"table?","value":"table? payload Optional POST payload to be sent, can be both table and string. When table is used, the request body is encoded as application/x-www-form-urlencoded","name":"payload","description":"Optional POST payload to be sent, can be both table and string. When table is used, the request body is encoded as application/x-www-form-urlencoded"},{"type":"function?","value":"function? callbackSuccess Optional function to be called on request success, taking the arguments body (string), length (number), headers (table) and code (number)","name":"callbackSuccess","description":"Optional function to be called on request success, taking the arguments body (string), length (number), headers (table) and code (number)"},{"type":"function?","value":"function? callbackFail Optional function to be called on request fail, taking the failing reason as an argument","name":"callbackFail","description":"Optional function to be called on request fail, taking the failing reason as an argument"},{"type":"table?","value":"table? headers Optional POST headers to be sent","name":"headers","description":"Optional POST headers to be sent"}],"class":"function","name":"post","description":" Runs a new http POST request"},"urlDropboxToRaw":{"path":"libs_sh/http.lua#L196","returns":[{"type":"string","value":"string The converted url","description":"The converted url"}],"realm":"shared","params":[{"type":"string","value":"string url The url to convert","name":"url","description":"The url to convert"}],"class":"function","name":"urlDropboxToRaw","description":" Converts a regular dropbox url to a raw one"},"urlEncode":{"path":"libs_sh/http.lua#L160","returns":[{"type":"string","value":"string The converted data","description":"The converted data"}],"realm":"shared","params":[{"type":"string","value":"string data The data to convert","name":"data","description":"The data to convert"}],"class":"function","name":"urlEncode","description":" Encodes illegal url characters to be legal"},"base64Encode":{"path":"libs_sh/http.lua#L140","returns":[{"type":"string","value":"string The converted data","description":"The converted data"}],"realm":"shared","params":[{"type":"string","value":"string data The data to convert","name":"data","description":"The data to convert"}],"class":"function","name":"base64Encode","description":" Converts data into base64 format or nil if the string is 0 length"},"canRequest":{"path":"libs_sh/http.lua#L32","returns":[{"type":"boolean","value":"boolean If an HTTP get/post request can be made","description":"If an HTTP get/post request can be made"}],"realm":"shared","class":"function","name":"canRequest","description":" Checks if a new http request can be started"},"get":{"path":"libs_sh/http.lua#L50","realm":"shared","params":[{"type":"string","value":"string url Http target url","name":"url","description":"Http target url"},{"type":"function","value":"function callbackSuccess The function to be called on request success, taking the arguments body (string), length (number), headers (table) and code (number)","name":"callbackSuccess","description":"The function to be called on request success, taking the arguments body (string), length (number), headers (table) and code (number)"},{"type":"function?","value":"function? callbackFail The function to be called on request fail, taking the failing reason as an argument","name":"callbackFail","description":"The function to be called on request fail, taking the failing reason as an argument"},{"type":"table?","value":"table? headers GET headers to be sent","name":"headers","description":"GET headers to be sent"}],"class":"function","name":"get","description":" Runs a new http GET request"}},"tables":[],"path":"libs_sh/http.lua#L11","libtbl":["http_library"],"realm":"shared","fields":[],"class":"library","name":"http","description":" Http library. Requests content from urls."},"particle":{"methods":{"create":{"path":"libs_cl/particle.lua#L51","returns":[{"type":"ParticleEmitter","value":"ParticleEmitter ParticleEmitter Object","description":"ParticleEmitter Object"}],"realm":"client","params":[{"type":"Vector","value":"Vector position The particle emitter's position","name":"position","description":"The particle emitter's position"},{"type":"boolean","value":"boolean use3D Create the emitter in 3D mode","name":"use3D","description":"Create the emitter in 3D mode"}],"class":"function","name":"create","description":" Creates a ParticleEmitter data structure"},"particleEmittersLeft":{"path":"libs_cl/particle.lua#L64","returns":[{"type":"number","value":"number Number of particle emitters left","description":"Number of particle emitters left"}],"realm":"client","class":"function","name":"particleEmittersLeft","description":" Returns number of particle emitters left able to be created"}},"tables":[],"path":"libs_cl/particle.lua#L13","libtbl":["particle_library"],"realm":"client","fields":[],"class":"library","name":"particle","description":" Particles library."},"file":{"methods":{"exists":{"path":"libs_cl/file.lua#L313","returns":[{"type":"boolean?","value":"boolean? True if exists, false if not, nil if error","description":"True if exists, false if not, nil if error"}],"realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."}],"class":"function","name":"exists","description":" Checks if a file exists"},"find":{"path":"libs_cl/file.lua#L370","returns":[{"type":"table","value":"table Table of file names","description":"Table of file names"},{"type":"table","value":"table Table of directory names","description":"Table of directory names"}],"realm":"client","params":[{"type":"string","value":"string path The folder to enumerate, relative to data/sf_filedata/.","name":"path","description":"The folder to enumerate, relative to data/sf_filedata/."},{"type":"string?","value":"string? sorting Optional sorting argument. Either nameasc, namedesc, dateasc, datedesc","name":"sorting","description":"Optional sorting argument. Either nameasc, namedesc, dateasc, datedesc"}],"class":"function","name":"find","description":" Enumerates a directory"},"write":{"path":"libs_cl/file.lua#L234","realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."},{"type":"string","value":"string data The data to write","name":"data","description":"The data to write"}],"class":"function","name":"write","description":" Writes to a file. Throws an error if it failed to write"},"readInGame":{"path":"libs_cl/file.lua#L204","returns":[{"type":"string?","value":"string? Contents or nil if error","description":"Contents or nil if error"}],"realm":"client","params":[{"type":"string","value":"string path Filepath relative to GarrysMod/garrysmod/.","name":"path","description":"Filepath relative to GarrysMod/garrysmod/."}],"class":"function","name":"readInGame","description":" Reads a file from path relative to base GMod directory"},"read":{"path":"libs_cl/file.lua#L195","returns":[{"type":"string?","value":"string? Contents, or nil if error","description":"Contents, or nil if error"}],"realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."}],"class":"function","name":"read","description":" Reads a file from path"},"writeTemp":{"path":"libs_cl/file.lua#L263","returns":[{"type":"string","value":"string The generated path for your temp file","description":"The generated path for your temp file"}],"realm":"client","params":[{"type":"string","value":"string filename The name to give the file. Must be only a file and not a path","name":"filename","description":"The name to give the file. Must be only a file and not a path"},{"type":"string","value":"string data The data to write","name":"data","description":"The data to write"}],"class":"function","name":"writeTemp","description":" Writes a temporary file. Throws an error if it is unable to."},"existsTemp":{"path":"libs_cl/file.lua#L283","returns":[{"type":"string?","value":"string? The path to the temp file or nil if it doesn't exist","description":"The path to the temp file or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string filename The temp file name. Must be only a file and not a path","name":"filename","description":"The temp file name. Must be only a file and not a path"}],"class":"function","name":"existsTemp","description":" Returns the path of a temp file if it exists. Otherwise returns nil"},"open":{"path":"libs_cl/file.lua#L180","returns":[{"type":"File?","value":"File? File object or nil if it failed","description":"File object or nil if it failed"}],"realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."},{"type":"string","value":"string mode The file mode to use. See lua manual for explanation","name":"mode","description":"The file mode to use. See lua manual for explanation"}],"class":"function","name":"open","description":" Opens and returns a file"},"delete":{"path":"libs_cl/file.lua#L331","returns":[{"type":"boolean?","value":"boolean? True if successful, nil if it wasn't found","description":"True if successful, nil if it wasn't found"}],"realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."}],"class":"function","name":"delete","description":" Deletes a file"},"createDir":{"path":"libs_cl/file.lua#L362","realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."}],"class":"function","name":"createDir","description":" Creates a directory"},"deleteTemp":{"path":"libs_cl/file.lua#L344","returns":[{"type":"boolean?","value":"boolean? True if successful, nil if it wasn't found","description":"True if successful, nil if it wasn't found"}],"realm":"client","params":[{"type":"string","value":"string filename The temp file name. Must be only a file and not a path","name":"filename","description":"The temp file name. Must be only a file and not a path"}],"class":"function","name":"deleteTemp","description":" Deletes a temp file"},"append":{"path":"libs_cl/file.lua#L299","realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."},{"type":"string","value":"string data String that will be appended to the file.","name":"data","description":"String that will be appended to the file."}],"class":"function","name":"append","description":" Appends a string to the end of a file"},"findInGame":{"path":"libs_cl/file.lua#L382","returns":[{"type":"table","value":"table Table of file names","description":"Table of file names"},{"type":"table","value":"table Table of directory names","description":"Table of directory names"}],"realm":"client","params":[{"type":"string","value":"string path The folder to enumerate, relative to garrysmod.","name":"path","description":"The folder to enumerate, relative to garrysmod."},{"type":"string?","value":"string? sorting Optional sorting argument. Either nameasc, namedesc, dateasc, datedesc","name":"sorting","description":"Optional sorting argument. Either nameasc, namedesc, dateasc, datedesc"}],"class":"function","name":"findInGame","description":" Enumerates a directory relative to gmod"},"asyncRead":{"path":"libs_cl/file.lua#L213","realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."},{"type":"function","value":"function callback A callback function for when the read operation finishes. It has 3 arguments: `filename` string, `status` number and `data` string","name":"callback","description":"A callback function for when the read operation finishes. It has 3 arguments: `filename` string, `status` number and `data` string"}],"class":"function","name":"asyncRead","description":" Reads a file asynchronously. Can only read 'sf_file_asyncmax' files at a time"},"time":{"path":"libs_cl/file.lua#L394","returns":[{"type":"number","value":"number Last modified time in Unix time","description":"Last modified time in Unix time"}],"realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."}],"class":"function","name":"time","description":" Returns when the file or folder was last modified in Unix time.\n Can then be used with something like os.date for a human-readable date."},"isDir":{"path":"libs_cl/file.lua#L322","returns":[{"type":"boolean","value":"boolean True if given path is a directory, false if it's a file","description":"True if given path is a directory, false if it's a file"}],"realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."}],"class":"function","name":"isDir","description":" Checks if a given file is a directory or not"},"readTemp":{"path":"libs_cl/file.lua#L250","returns":[{"type":"string?","value":"string? The data of the temp file or nil if it doesn't exist","description":"The data of the temp file or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string filename The temp file name. Must be only a file and not a path","name":"filename","description":"The temp file name. Must be only a file and not a path"}],"class":"function","name":"readTemp","description":" Reads a temp file's data if it exists. Otherwise returns nil"}},"tables":[],"path":"libs_cl/file.lua#L23","libtbl":["file_library"],"realm":"client","fields":[],"class":"library","name":"file","description":" File functions. Allows modification of files."},"constraint":{"methods":{"rope":{"path":"libs_sv/constraint.lua#L326","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"number","value":"number index Index of the rope constraint","name":"index","description":"Index of the rope constraint"},{"type":"Entity","value":"Entity e1 The first entity","name":"e1","description":"The first entity"},{"type":"Entity","value":"Entity e2 The second entity","name":"e2","description":"The second entity"},{"type":"number?","value":"number? bone1 Number bone of the first entity. Default 0","name":"bone1","description":"Number bone of the first entity. Default 0"},{"type":"number?","value":"number? bone2 Number bone of the second entity. Default 0","name":"bone2","description":"Number bone of the second entity. Default 0"},{"type":"Vector","value":"Vector v1 Position on the first entity, in its local space coordinates","name":"v1","description":"Position on the first entity, in its local space coordinates"},{"type":"Vector","value":"Vector v2 Position on the second entity, in its local space coordinates","name":"v2","description":"Position on the second entity, in its local space coordinates"},{"type":"number?","value":"number? length Length of the created rope. Default 0","name":"length","description":"Length of the created rope. Default 0"},{"type":"number?","value":"number? addlength Amount to add to the base length of the rope. Default 0","name":"addlength","description":"Amount to add to the base length of the rope. Default 0"},{"type":"number?","value":"number? force_lim Amount of force until it breaks, 0 = Unbreakable. Default 0","name":"force_lim","description":"Amount of force until it breaks, 0 = Unbreakable. Default 0"},{"type":"number?","value":"number? width Width of the rope. Default 0","name":"width","description":"Width of the rope. Default 0"},{"type":"string?","value":"string? materialName Material of the rope","name":"materialName","description":"Material of the rope"},{"type":"boolean?","value":"boolean? rigid Whether the rope is rigid. Default false","name":"rigid","description":"Whether the rope is rigid. Default false"},{"type":"Color?","value":"Color? color The color of the rope. Default white","name":"color","description":"The color of the rope. Default white"}],"class":"function","name":"rope","description":" Creates a rope between two entities"},"setElasticLength":{"path":"libs_sv/constraint.lua#L479","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"number","value":"number index Index of the elastic constraint","name":"index","description":"Index of the elastic constraint"},{"type":"Entity","value":"Entity e Entity that has the constraint","name":"e","description":"Entity that has the constraint"},{"type":"number","value":"number length New length of the constraint","name":"length","description":"New length of the constraint"}],"class":"function","name":"setElasticLength","description":" Sets the length of an elastic attached to the entity"},"slider":{"path":"libs_sv/constraint.lua#L384","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"Entity","value":"Entity e1 The first entity","name":"e1","description":"The first entity"},{"type":"Entity","value":"Entity e2 The second entity","name":"e2","description":"The second entity"},{"type":"number?","value":"number? bone1 Number bone of the first entity. Default 0","name":"bone1","description":"Number bone of the first entity. Default 0"},{"type":"number?","value":"number? bone2 Number bone of the second entity. Default 0","name":"bone2","description":"Number bone of the second entity. Default 0"},{"type":"Vector","value":"Vector v1 Position on the first entity, in its local space coordinates","name":"v1","description":"Position on the first entity, in its local space coordinates"},{"type":"Vector","value":"Vector v2 Position on the second entity, in its local space coordinates","name":"v2","description":"Position on the second entity, in its local space coordinates"},{"type":"number?","value":"number? width Width of the slider. Default 0","name":"width","description":"Width of the slider. Default 0"}],"class":"function","name":"slider","description":" Sliders two entities"},"setConstraintClean":{"path":"libs_sv/constraint.lua#L577","realm":"server","params":[{"type":"boolean","value":"boolean on Whether the constraints should be cleaned or not","name":"on","description":"Whether the constraints should be cleaned or not"}],"class":"function","name":"setConstraintClean","description":" Sets whether the chip should remove created constraints when the chip is removed"},"ballsocketadv":{"path":"libs_sv/constraint.lua#L223","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"Entity","value":"Entity e1 The first entity","name":"e1","description":"The first entity"},{"type":"Entity","value":"Entity e2 The second entity","name":"e2","description":"The second entity"},{"type":"number?","value":"number? bone1 Number bone of the first entity. Default 0","name":"bone1","description":"Number bone of the first entity. Default 0"},{"type":"number?","value":"number? bone2 Number bone of the second entity. Default 0","name":"bone2","description":"Number bone of the second entity. Default 0"},{"type":"Vector","value":"Vector v1 Position on the first entity, in its local space coordinates","name":"v1","description":"Position on the first entity, in its local space coordinates"},{"type":"Vector","value":"Vector v2 Position on the second entity, in its local space coordinates","name":"v2","description":"Position on the second entity, in its local space coordinates"},{"type":"number?","value":"number? force_lim Amount of force until it breaks, 0 = Unbreakable. Default 0","name":"force_lim","description":"Amount of force until it breaks, 0 = Unbreakable. Default 0"},{"type":"number?","value":"number? torque_lim Amount of torque until it breaks, 0 = Unbreakable. Default 0","name":"torque_lim","description":"Amount of torque until it breaks, 0 = Unbreakable. Default 0"},{"type":"Vector?","value":"Vector? minv Vector defining minimum rotation angle based on world axes. Default Vec(0)","name":"minv","description":"Vector defining minimum rotation angle based on world axes. Default Vec(0)"},{"type":"Vector?","value":"Vector? maxv Vector defining maximum rotation angle based on world axes. Default Vec(0)","name":"maxv","description":"Vector defining maximum rotation angle based on world axes. Default Vec(0)"},{"type":"Vector?","value":"Vector? frictionv Vector defining rotational friction, local to the constraint. Default Vec(0)","name":"frictionv","description":"Vector defining rotational friction, local to the constraint. Default Vec(0)"},{"type":"boolean?","value":"boolean? rotateonly If True, ballsocket will only affect the rotation allowing for free movement, otherwise it will limit both - rotation and movement. Default false","name":"rotateonly","description":"If True, ballsocket will only affect the rotation allowing for free movement, otherwise it will limit both - rotation and movement. Default false"},{"type":"boolean?","value":"boolean? nocollide Bool whether or not to nocollide the two entities. Default false","name":"nocollide","description":"Bool whether or not to nocollide the two entities. Default false"}],"class":"function","name":"ballsocketadv","description":" Ballsocket two entities together with more options"},"breakType":{"path":"libs_sv/constraint.lua#L555","realm":"server","params":[{"type":"Entity","value":"Entity e Entity to be affected","name":"e","description":"Entity to be affected"},{"type":"string","value":"string typename Name of the constraint type, ie. Weld, Elastic, NoCollide, etc.","name":"typename","description":"Name of the constraint type, ie. Weld, Elastic, NoCollide, etc."}],"class":"function","name":"breakType","description":" Breaks all constraints of a certain type on an entity"},"keepupright":{"path":"libs_sv/constraint.lua#L451","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"Entity","value":"Entity e The entity","name":"e","description":"The entity"},{"type":"Angle","value":"Angle ang The upright angle","name":"ang","description":"The upright angle"},{"type":"number","value":"number bone Number bone of the entity. Default 0","name":"bone","description":"Number bone of the entity. Default 0"},{"type":"number","value":"number lim The strength of the constraint. Default 5000","name":"lim","description":"The strength of the constraint. Default 5000"}],"class":"function","name":"keepupright","description":" Applies a keepupright constraint on an entity"},"nocollide":{"path":"libs_sv/constraint.lua#L421","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"Entity","value":"Entity e1 The first entity","name":"e1","description":"The first entity"},{"type":"Entity","value":"Entity e2 The second entity","name":"e2","description":"The second entity"},{"type":"number?","value":"number? bone1 Number bone of the first entity. Default 0","name":"bone1","description":"Number bone of the first entity. Default 0"},{"type":"number?","value":"number? bone2 Number bone of the second entity. Default 0","name":"bone2","description":"Number bone of the second entity. Default 0"}],"class":"function","name":"nocollide","description":" Nocollides two entities"},"getTable":{"path":"libs_sv/constraint.lua#L570","returns":[{"type":"table","value":"table Table of tables containing constraint information","description":"Table of tables containing constraint information"}],"realm":"server","params":[{"type":"Entity","value":"Entity ent The entity","name":"ent","description":"The entity"}],"class":"function","name":"getTable","description":" Returns the table of constraints on an entity"},"ballsocket":{"path":"libs_sv/constraint.lua#L184","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"Entity","value":"Entity e1 The first entity","name":"e1","description":"The first entity"},{"type":"Entity","value":"Entity e2 The second entity","name":"e2","description":"The second entity"},{"type":"number?","value":"number? bone1 Number bone of the first entity. Default 0","name":"bone1","description":"Number bone of the first entity. Default 0"},{"type":"number?","value":"number? bone2 Number bone of the second entity. Default 0","name":"bone2","description":"Number bone of the second entity. Default 0"},{"type":"Vector","value":"Vector pos Position of the joint, relative to the second entity","name":"pos","description":"Position of the joint, relative to the second entity"},{"type":"number?","value":"number? force_lim Amount of force until it breaks, 0 = Unbreakable. Default 0","name":"force_lim","description":"Amount of force until it breaks, 0 = Unbreakable. Default 0"},{"type":"number?","value":"number? torque_lim Amount of torque until it breaks, 0 = Unbreakable. Default 0","name":"torque_lim","description":"Amount of torque until it breaks, 0 = Unbreakable. Default 0"},{"type":"boolean?","value":"boolean? nocollide Bool whether or not to nocollide the two entities. Default false","name":"nocollide","description":"Bool whether or not to nocollide the two entities. Default false"}],"class":"function","name":"ballsocket","description":" Ballsocket two entities together. For more options, see constraint.ballsocketadv"},"removeAll":{"path":"libs_sv/constraint.lua#L79","realm":"server","class":"function","name":"removeAll","description":" Removes all constraints created by the calling chip"},"constraintsLeft":{"path":"libs_sv/constraint.lua#L583","returns":[{"type":"number","value":"number Number of constraints able to be spawned","description":"Number of constraints able to be spawned"}],"realm":"server","class":"function","name":"constraintsLeft","description":" Checks how many constraints can be spawned"},"setElasticDamping":{"path":"libs_sv/constraint.lua#L501","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"number","value":"number index Index of the elastic constraint","name":"index","description":"Index of the elastic constraint"},{"type":"Entity","value":"Entity e Entity that has the elastic","name":"e","description":"Entity that has the elastic"},{"type":"number","value":"number damping New Damping value of the elastic","name":"damping","description":"New Damping value of the elastic"}],"class":"function","name":"setElasticDamping","description":" Sets the damping of an elastic attached to the entity"},"breakAll":{"path":"libs_sv/constraint.lua#L545","realm":"server","params":[{"type":"Entity","value":"Entity e Entity to remove the constraints from","name":"e","description":"Entity to remove the constraints from"}],"class":"function","name":"breakAll","description":" Breaks all constraints on an entity"},"axis":{"path":"libs_sv/constraint.lua#L138","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"Entity","value":"Entity e1 The first entity","name":"e1","description":"The first entity"},{"type":"Entity","value":"Entity e2 The second entity","name":"e2","description":"The second entity"},{"type":"number?","value":"number? bone1 Number bone of the first entity. Default 0","name":"bone1","description":"Number bone of the first entity. Default 0"},{"type":"number?","value":"number? bone2 Number bone of the second entity. Default 0","name":"bone2","description":"Number bone of the second entity. Default 0"},{"type":"Vector","value":"Vector v1 Position to center the axis, local to e1's space coordinates","name":"v1","description":"Position to center the axis, local to e1's space coordinates"},{"type":"Vector","value":"Vector v2 The second position defining the axis, local to e2's space coordinates. The laxis may be specified instead which is local to e1's space coordinates","name":"v2","description":"The second position defining the axis, local to e2's space coordinates. The laxis may be specified instead which is local to e1's space coordinates"},{"type":"number?","value":"number? force_lim Amount of force until it breaks, 0 = Unbreakable. Default 0","name":"force_lim","description":"Amount of force until it breaks, 0 = Unbreakable. Default 0"},{"type":"number?","value":"number? torque_lim Amount of torque until it breaks, 0 = Unbreakable. Default 0","name":"torque_lim","description":"Amount of torque until it breaks, 0 = Unbreakable. Default 0"},{"type":"number?","value":"number? friction Friction of the constraint. Default 0","name":"friction","description":"Friction of the constraint. Default 0"},{"type":"boolean?","value":"boolean? nocollide Bool whether or not to nocollide the two entities. Default false","name":"nocollide","description":"Bool whether or not to nocollide the two entities. Default false"},{"type":"Vector?","value":"Vector? laxis Optional second position of the constraint, same as v2 but local to e1","name":"laxis","description":"Optional second position of the constraint, same as v2 but local to e1"}],"class":"function","name":"axis","description":" Axis two entities. v1 in e1's coordinates and v2 in e2's coordinates (or laxis in e1's coordinates again) define the axis"},"weld":{"path":"libs_sv/constraint.lua#L104","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"Entity","value":"Entity e1 The first entity","name":"e1","description":"The first entity"},{"type":"Entity","value":"Entity e2 The second entity","name":"e2","description":"The second entity"},{"type":"number?","value":"number? bone1 Number bone of the first entity. Default 0","name":"bone1","description":"Number bone of the first entity. Default 0"},{"type":"number?","value":"number? bone2 Number bone of the second entity. Default 0","name":"bone2","description":"Number bone of the second entity. Default 0"},{"type":"number?","value":"number? force_lim Max force the weld can take before breaking. Default 0","name":"force_lim","description":"Max force the weld can take before breaking. Default 0"},{"type":"boolean?","value":"boolean? nocollide Bool whether or not to nocollide the two entities. Default false","name":"nocollide","description":"Bool whether or not to nocollide the two entities. Default false"}],"class":"function","name":"weld","description":" Welds two entities"},"setElasticConstant":{"path":"libs_sv/constraint.lua#L523","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"number","value":"number index Index of the elastic constraint","name":"index","description":"Index of the elastic constraint"},{"type":"Entity","value":"Entity e Entity that has the elastic","name":"e","description":"Entity that has the elastic"},{"type":"number","value":"number constant New constant value of the elastic","name":"constant","description":"New constant value of the elastic"}],"class":"function","name":"setElasticConstant","description":" Sets the constant of an elastic attached to the entity"},"elastic":{"path":"libs_sv/constraint.lua#L272","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"number","value":"number index Index of the elastic constraint","name":"index","description":"Index of the elastic constraint"},{"type":"Entity","value":"Entity e1 The first entity","name":"e1","description":"The first entity"},{"type":"Entity","value":"Entity e2 The second entity","name":"e2","description":"The second entity"},{"type":"number?","value":"number? bone1 Number bone of the first entity. Default 0","name":"bone1","description":"Number bone of the first entity. Default 0"},{"type":"number?","value":"number? bone2 Number bone of the second entity. Default 0","name":"bone2","description":"Number bone of the second entity. Default 0"},{"type":"Vector","value":"Vector v1 Position on the first entity, in its local space coordinates","name":"v1","description":"Position on the first entity, in its local space coordinates"},{"type":"Vector","value":"Vector v2 Position on the second entity, in its local space coordinates","name":"v2","description":"Position on the second entity, in its local space coordinates"},{"type":"number?","value":"number? const Constant of the constraint. Default 1000","name":"const","description":"Constant of the constraint. Default 1000"},{"type":"number?","value":"number? damp Damping of the constraint. Default 100","name":"damp","description":"Damping of the constraint. Default 100"},{"type":"number?","value":"number? rdamp Rotational damping of the constraint. Default 0","name":"rdamp","description":"Rotational damping of the constraint. Default 0"},{"type":"number?","value":"number? width Width of the created constraint. Default 0","name":"width","description":"Width of the created constraint. Default 0"},{"type":"boolean?","value":"boolean? stretch True to mark as stretch-only. Default false","name":"stretch","description":"True to mark as stretch-only. Default false"}],"class":"function","name":"elastic","description":" Elastic constraint between two entities"}},"tables":[],"path":"libs_sv/constraint.lua#L21","libtbl":["constraint_library"],"realm":"server","fields":[],"class":"library","name":"constraint","description":" Library for creating and manipulating constraints."},"game":{"methods":{"getAmmoData":{"path":"libs_sh/game.lua#L80","returns":[{"type":"table","value":"table AmmoData, see https://wiki.facepunch.com/gmod/Structures/AmmoData","description":"AmmoData, see https://wiki.facepunch.com/gmod/Structures/AmmoData"}],"realm":"shared","params":[{"type":"number","value":"number id See https://wiki.facepunch.com/gmod/Default_Ammo_Types","name":"id","description":"See https://wiki.facepunch.com/gmod/Default_Ammo_Types"}],"class":"function","name":"getAmmoData","description":" Returns AmmoData for given id"},"getTickInterval":{"path":"libs_sh/game.lua#L68","returns":[{"type":"number","value":"number Interval","description":"Interval"}],"realm":"shared","class":"function","name":"getTickInterval","description":" Returns the number of seconds between each gametick"},"steamIDTo64":{"path":"libs_sh/game.lua#L118","returns":[{"type":"string","value":"string 64bit Steam ID","description":"64bit Steam ID"}],"realm":"shared","params":[{"type":"string","value":"string id The STEAM_0 style id","name":"id","description":"The STEAM_0 style id"}],"class":"function","name":"steamIDTo64","description":" Given a STEAM_0 style Steam ID will return a 64bit Steam ID"},"serverFrameTime":{"path":"libs_sh/game.lua#L163","returns":[{"type":"number","value":"number Server frametime","description":"Server frametime"},{"type":"number","value":"number Server frametime standard deviation","description":"Server frametime standard deviation"}],"realm":"client","class":"function","name":"serverFrameTime","description":" Returns the server's frame time and standard deviation"},"blastDamage":{"path":"libs_sh/game.lua#L127","realm":"server","params":[{"type":"Vector","value":"Vector damageOrigin The center of the explosion","name":"damageOrigin","description":"The center of the explosion"},{"type":"number","value":"number damageRadius The radius in which entities will be damaged (0 - 1500)","name":"damageRadius","description":"The radius in which entities will be damaged (0 - 1500)"},{"type":"number","value":"number damage The amount of damage to be applied","name":"damage","description":"The amount of damage to be applied"}],"class":"function","name":"blastDamage","description":" Applies explosion damage to all entities in the specified radius"},"getHostname":{"path":"libs_sh/game.lua#L25","returns":[{"type":"string","value":"string The hostname of the server","description":"The hostname of the server"}],"realm":"shared","class":"function","name":"getHostname","description":" Returns The hostname"},"getPlayerModels":{"path":"libs_sh/game.lua#L100","returns":[{"type":"table","value":"table List of valid playermodels","description":"List of valid playermodels"}],"realm":"shared","class":"function","name":"getPlayerModels","description":" Returns a table with keys that are condensed model path names and value identifiers of said paths"},"getAmmoMax":{"path":"libs_sh/game.lua#L87","returns":[{"type":"number","value":"number The maximum amount of reserve ammo a player can hold of this ammo type","description":"The maximum amount of reserve ammo a player can hold of this ammo type"}],"realm":"shared","params":[{"type":"number","value":"number id See https://wiki.facepunch.com/gmod/Default_Ammo_Types","name":"id","description":"See https://wiki.facepunch.com/gmod/Default_Ammo_Types"}],"class":"function","name":"getAmmoMax","description":" Returns the real maximum amount of ammo of given ammo ID, regardless of the setting of gmod_maxammo convar"},"steamIDFrom64":{"path":"libs_sh/game.lua#L111","returns":[{"type":"string","value":"string STEAM_0 style Steam ID","description":"STEAM_0 style Steam ID"}],"realm":"shared","params":[{"type":"string","value":"string id The 64 bit Steam ID","name":"id","description":"The 64 bit Steam ID"}],"class":"function","name":"steamIDFrom64","description":" Given a 64bit SteamID will return a STEAM_0: style Steam ID"},"isDedicated":{"path":"libs_sh/game.lua#L43","returns":[{"type":"boolean","value":"boolean True if the game is a dedicated server","description":"True if the game is a dedicated server"}],"realm":"shared","class":"function","name":"isDedicated","description":" Returns whether or not the server is a dedicated server"},"isLan":{"path":"libs_sh/game.lua#L31","returns":[{"type":"boolean","value":"boolean True if the game is a lan game","description":"True if the game is a lan game"}],"realm":"shared","class":"function","name":"isLan","description":" Returns true if the server is on a LAN"},"getTimeScale":{"path":"libs_sh/game.lua#L62","returns":[{"type":"number","value":"number Time scale","description":"Time scale"}],"realm":"shared","class":"function","name":"getTimeScale","description":" Returns the game time scale"},"isTimingOut":{"path":"libs_sh/game.lua#L171","returns":[{"type":"boolean","value":"boolean If currently timing out","description":"If currently timing out"},{"type":"number","value":"number Time since the connection started to timeout","description":"Time since the connection started to timeout"}],"realm":"client","class":"function","name":"isTimingOut","description":" Returns if the client is currently timing out from the server"},"isSkyboxVisibleFromPoint":{"path":"libs_sh/game.lua#L155","returns":[{"type":"boolean","value":"boolean Whether the skybox is visible from the position","description":"Whether the skybox is visible from the position"}],"realm":"client","params":[{"type":"Vector","value":"Vector position The position to check the skybox visibility from","name":"position","description":"The position to check the skybox visibility from"}],"class":"function","name":"isSkyboxVisibleFromPoint","description":" Check whether the skybox is visible from the point specified"},"getTickCount":{"path":"libs_sh/game.lua#L74","returns":[{"type":"number","value":"number Ticks","description":"Ticks"}],"realm":"shared","class":"function","name":"getTickCount","description":" Returns the number of ticks since the game started"},"getSunInfo":{"path":"libs_sh/game.lua#L146","returns":[{"type":"Vector","value":"Vector The direction of the sun","description":"The direction of the sun"},{"type":"number","value":"number How obstructed the sun is 0 to 1.","description":"How obstructed the sun is 0 to 1."}],"realm":"client","class":"function","name":"getSunInfo","description":" Returns the direction and how obstructed the map's sun is or nil if it doesn't exist"},"getWorld":{"path":"libs_sh/game.lua#L94","returns":[{"type":"Entity","value":"Entity Worldspawn","description":"Worldspawn"}],"realm":"shared","class":"function","name":"getWorld","description":" Returns the worldspawn entity"},"getMap":{"path":"libs_sh/game.lua#L19","returns":[{"type":"string","value":"string The name of the current map","description":"The name of the current map"}],"realm":"shared","class":"function","name":"getMap","description":" Returns the map name"},"isSinglePlayer":{"path":"libs_sh/game.lua#L37","returns":[{"type":"boolean","value":"boolean True if the game is singleplayer","description":"True if the game is singleplayer"}],"realm":"shared","class":"function","name":"isSinglePlayer","description":" Returns whether or not the current game is single player"},"getMaxPlayers":{"path":"libs_sh/game.lua#L49","returns":[{"type":"number","value":"number The max players allowed by the server","description":"The max players allowed by the server"}],"realm":"shared","class":"function","name":"getMaxPlayers","description":" Returns the maximum player limit"},"isMounted":{"path":"libs_sh/game.lua#L55","returns":[{"type":"boolean","value":"boolean True if the game is mounted","description":"True if the game is mounted"}],"realm":"shared","params":[{"type":"string","value":"string str String identifier of the game, eg. 'cstrike'","name":"str","description":"String identifier of the game, eg. 'cstrike'"}],"class":"function","name":"isMounted","description":" Checks whether the specified game is mounted"},"hasFocus":{"path":"libs_sh/game.lua#L139","returns":[{"type":"boolean","value":"boolean True if the game is focused","description":"True if the game is focused"}],"realm":"client","class":"function","name":"hasFocus","description":" Returns if the game has focus or not, i.e. will return false if the game is minimized"}},"tables":[],"path":"libs_sh/game.lua#L6","libtbl":["game_library"],"realm":"shared","fields":[],"class":"library","name":"game","description":" Game functions"},"xinput":{"methods":{"setRumble":{"path":"libs_cl/xinput.lua#L133","realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number softPercent A number between 0.0-1.0 for how much the soft rumble motor should vibrate.","name":"softPercent","description":"A number between 0.0-1.0 for how much the soft rumble motor should vibrate."},{"type":"number","value":"number hardPercent A number between 0.0-1.0 for how much the hard rumble motor should vibrate.","name":"hardPercent","description":"A number between 0.0-1.0 for how much the hard rumble motor should vibrate."}],"class":"function","name":"setRumble","description":" Sets the rumble on the controller."},"getTrigger":{"path":"libs_cl/xinput.lua#L102","returns":[{"type":"number","value":"number 0-255 inclusive","description":"0-255 inclusive"}],"realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number trigger Which trigger to use. 0 is left","name":"trigger","description":"Which trigger to use. 0 is left"}],"class":"function","name":"getTrigger","description":" Gets the current position of the trigger on the controller."},"getStick":{"path":"libs_cl/xinput.lua#L110","returns":[{"type":"number","value":"number X Coordinate, Between -32768 - 32767 inclusive","description":"X Coordinate, Between -32768 - 32767 inclusive"},{"type":"number","value":"number Y Coordinate, Between -32768 - 32767 inclusive","description":"Y Coordinate, Between -32768 - 32767 inclusive"}],"realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number stick Which stick to use. 0 is left","name":"stick","description":"Which stick to use. 0 is left"}],"class":"function","name":"getStick","description":" Gets the current coordinates of the stick on the controller."},"getBatteryLevel":{"path":"libs_cl/xinput.lua#L119","returns":[{"type":"number|boolean","value":"number|boolean If successful: a number between 0.0-1.0 inclusive.","description":"If successful: a number between 0.0-1.0 inclusive."},{"type":"string?","value":"string? If last return was a false boolean (errored), this will be the error message.","description":"If last return was a false boolean (errored), this will be the error message."}],"realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"}],"class":"function","name":"getBatteryLevel","description":" Attempts to check the battery level of the controller."},"getState":{"path":"libs_cl/xinput.lua#L87","returns":[{"type":"table","value":"table Table containing all input data of the controller, or false if the controller is not connected. The table uses this struct: https://github.com/mitterdoo/garrysmod-xinput#xinput_gamepad","description":"Table containing all input data of the controller, or false if the controller is not connected. The table uses this struct: https://github.com/mitterdoo/garrysmod-xinput#xinput_gamepad"}],"realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"}],"class":"function","name":"getState","description":" Gets the state of the controller."},"getButton":{"path":"libs_cl/xinput.lua#L94","returns":[{"type":"boolean","value":"boolean","description":""}],"realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number button The button to check for. See https://github.com/mitterdoo/garrysmod-xinput#xinput_gamepad_","name":"button","description":"The button to check for. See https://github.com/mitterdoo/garrysmod-xinput#xinput_gamepad_"}],"class":"function","name":"getButton","description":" Gets whether the button on the controller is currently pushed down."},"getControllers":{"path":"libs_cl/xinput.lua#L127","returns":[{"type":"table","value":"table A table where each key is the ID of the controller that is connected. Disconnected controllers are not placed in the table.","description":"A table where each key is the ID of the controller that is connected. Disconnected controllers are not placed in the table."}],"realm":"client","class":"function","name":"getControllers","description":" Gets all of the connected controllers."}},"tables":[],"path":"libs_cl/xinput.lua#L60","libtbl":["xinput_library"],"realm":"client","fields":[],"class":"library","name":"xinput","description":" A simpler, hook-based, and more-powerful controller input library. Inputs are not lost between rendered frames, and there is support for rumble. Note: the client must have the XInput lua binary module installed in order to access this library. See more at https://github.com/mitterdoo/garrysmod-xinput"},"bit":{"methods":{"rol":{"path":"libs_sh/bit.lua#L613","returns":[{"type":"number","value":"number Left rotated value","description":"Left rotated value"}],"realm":"shared","params":[{"type":"number","value":"number value The value to be manipulated.","name":"value","description":"The value to be manipulated."},{"type":"number","value":"number shiftCount Amounts of bits to rotate left by.","name":"shiftCount","description":"Amounts of bits to rotate left by."}],"class":"function","name":"rol","description":" Returns the left rotated value."},"arshift":{"path":"libs_sh/bit.lua#L566","returns":[{"type":"number","value":"number shiftedValue","description":"shiftedValue"}],"realm":"shared","params":[{"type":"number","value":"number value The value to be manipulated.","name":"value","description":"The value to be manipulated."},{"type":"number","value":"number shiftCount Amount of bits to shift","name":"shiftCount","description":"Amount of bits to shift"}],"class":"function","name":"arshift","description":" Returns the arithmetically shifted value."},"compress":{"path":"libs_sh/bit.lua#L682","returns":[{"type":"string?","value":"string? Compressed string, or nil if compression failed","description":"Compressed string, or nil if compression failed"}],"realm":"shared","params":[{"type":"string","value":"string s String to compress","name":"s","description":"String to compress"}],"class":"function","name":"compress","description":" Compresses a string using LZMA."},"bnot":{"path":"libs_sh/bit.lua#L580","returns":[{"type":"number","value":"number Return value of bitwise not operation","description":"Return value of bitwise not operation"}],"realm":"shared","params":[{"type":"number","value":"number value The value to be inverted.","name":"value","description":"The value to be inverted."}],"class":"function","name":"bnot","description":" Returns the bitwise not of the value."},"lshift":{"path":"libs_sh/bit.lua#L606","returns":[{"type":"number","value":"number Return of bitwise lshift operation","description":"Return of bitwise lshift operation"}],"realm":"shared","params":[{"type":"number","value":"number value The value to be manipulated.","name":"value","description":"The value to be manipulated."},{"type":"number","value":"number shiftCount Amounts of bits to shift left by.","name":"shiftCount","description":"Amounts of bits to shift left by."}],"class":"function","name":"lshift","description":" Returns the left shifted value."},"stringstream":{"path":"libs_sh/bit.lua#L648","returns":[{"type":"StringStream","value":"StringStream StringStream object","description":"StringStream object"}],"realm":"shared","params":[{"type":"string?","value":"string? stream String to set the initial buffer to (default \"\")","name":"stream","description":"String to set the initial buffer to (default \"\")"},{"type":"number?","value":"number? i The initial buffer pointer (default 1)","name":"i","description":"The initial buffer pointer (default 1)"},{"type":"string?","value":"string? endian The endianness of number types. \"big\" or \"little\" (default \"little\")","name":"endian","description":"The endianness of number types. \"big\" or \"little\" (default \"little\")"}],"class":"function","name":"stringstream","description":" Creates a StringStream object"},"sha256":{"path":"libs_sh/bit.lua#L729","returns":[{"type":"string","value":"string The SHA-256 hex string of the checksum.","description":"The SHA-256 hex string of the checksum."}],"realm":"shared","params":[{"type":"string","value":"string s The string to calculate the checksum of.","name":"s","description":"The string to calculate the checksum of."}],"class":"function","name":"sha256","description":" Generates the SHA-256 Checksum of the specified string."},"stringToTable":{"path":"libs_sh/bit.lua#L674","returns":[{"type":"table","value":"table The deserialized table","description":"The deserialized table"}],"realm":"shared","params":[{"type":"string","value":"string s The serialized string data","name":"s","description":"The serialized string data"}],"class":"function","name":"stringToTable","description":" Converts serialized string data to table"},"sha1":{"path":"libs_sh/bit.lua#L740","returns":[{"type":"string","value":"string The SHA-1 hex string of the checksum.","description":"The SHA-1 hex string of the checksum."}],"realm":"shared","params":[{"type":"string","value":"string s The string to calculate the checksum of.","name":"s","description":"The string to calculate the checksum of."}],"class":"function","name":"sha1","description":" Generates the SHA-1 Checksum of the specified string."},"bor":{"path":"libs_sh/bit.lua#L586","returns":[{"type":"number","value":"number The bitwise OR result between all numbers.","description":"The bitwise OR result between all numbers."}],"realm":"shared","params":[{"type":"number","value":"number value1 The first value.","name":"value1","description":"The first value."},{"type":"...number","value":"...number Extra values to be evaluated. (must all be numbers)","name":"Extra","description":"values to be evaluated. (must all be numbers)"}],"class":"function","name":"bor","description":" Returns the bitwise OR of all values specified."},"md5":{"path":"libs_sh/bit.lua#L718","returns":[{"type":"string","value":"string The MD5 hex string of the checksum.","description":"The MD5 hex string of the checksum."}],"realm":"shared","params":[{"type":"string","value":"string s The string to calculate the checksum of.","name":"s","description":"The string to calculate the checksum of."}],"class":"function","name":"md5","description":" Generates the MD5 Checksum of the specified string."},"bswap":{"path":"libs_sh/bit.lua#L593","returns":[{"type":"number","value":"number Bit swapped value","description":"Bit swapped value"}],"realm":"shared","params":[{"type":"number","value":"number value The value to be byte swapped.","name":"value","description":"The value to be byte swapped."}],"class":"function","name":"bswap","description":" Swaps the byte order."},"tableToString":{"path":"libs_sh/bit.lua#L666","returns":[{"type":"string","value":"string Serialized data","description":"Serialized data"}],"realm":"shared","params":[{"type":"table","value":"table t The table to serialize","name":"t","description":"The table to serialize"}],"class":"function","name":"tableToString","description":" Converts a table to string serializing data types as best as it can"},"ror":{"path":"libs_sh/bit.lua#L620","returns":[{"type":"number","value":"number Right rotated value","description":"Right rotated value"}],"realm":"shared","params":[{"type":"number","value":"number value The value to be manipulated.","name":"value","description":"The value to be manipulated."},{"type":"number","value":"number shiftCount Amounts of bits to rotate right by.","name":"shiftCount","description":"Amounts of bits to rotate right by."}],"class":"function","name":"ror","description":" Returns the right rotated value."},"rshift":{"path":"libs_sh/bit.lua#L627","returns":[{"type":"number","value":"number Right shifted value","description":"Right shifted value"}],"realm":"shared","params":[{"type":"number","value":"number value The value to be manipulated.","name":"value","description":"The value to be manipulated."},{"type":"number","value":"number shiftCount Amounts of bits to shift right by.","name":"shiftCount","description":"Amounts of bits to shift right by."}],"class":"function","name":"rshift","description":" Returns the right shifted value."},"bxor":{"path":"libs_sh/bit.lua#L599","returns":[{"type":"number","value":"number Return value of bitwiseXOr operation","description":"Return value of bitwiseXOr operation"}],"realm":"shared","params":[{"type":"number","value":"number value The value to be manipulated.","name":"value","description":"The value to be manipulated."},{"type":"...number","value":"...number otherValues Values to bit xor with. Optional.","name":"otherValues","description":"Values to bit xor with. Optional."}],"class":"function","name":"bxor","description":" Returns the bitwise xor of all values specified."},"tobit":{"path":"libs_sh/bit.lua#L634","returns":[{"type":"number","value":"number Bit swapped value","description":"Bit swapped value"}],"realm":"shared","params":[{"type":"number","value":"number value The value to be normalized.","name":"value","description":"The value to be normalized."}],"class":"function","name":"tobit","description":" Normalizes the specified value and clamps it in the range of a signed 32bit integer."},"tohex":{"path":"libs_sh/bit.lua#L640","returns":[{"type":"string","value":"string Hex string.","description":"Hex string."}],"realm":"shared","params":[{"type":"number","value":"number value The value to be normalized.","name":"value","description":"The value to be normalized."},{"type":"number?","value":"number? digits The number of digits. Optional. (default 8)","name":"digits","description":"The number of digits. Optional. (default 8)"}],"class":"function","name":"tohex","description":" Returns the hexadecimal representation of the number with the specified digits."},"decompress":{"path":"libs_sh/bit.lua#L693","returns":[{"type":"string?","value":"string? Decompressed string, or nil if decompression failed","description":"Decompressed string, or nil if decompression failed"}],"realm":"shared","params":[{"type":"string","value":"string s String to decompress","name":"s","description":"String to decompress"},{"type":"number?","value":"number? maxSize Maximum allowed size of decompressed data","name":"maxSize","description":"Maximum allowed size of decompressed data"}],"class":"function","name":"decompress","description":" Decompresses a string using LZMA.\n XZ Utils will always produce streamed (i.e. the decompressed size is not specified in the header) LZMA data. If you're trying to compress data from outside of GMod and then decompress it inside of GMod, it probably won't work unless you use the older, deprecated 'LZMA Utils', or util.Compress."},"band":{"path":"libs_sh/bit.lua#L573","returns":[{"type":"number","value":"number Result of bitwise \"and\" operation.","description":"Result of bitwise \"and\" operation."}],"realm":"shared","params":[{"type":"number","value":"number value The value to be manipulated.","name":"value","description":"The value to be manipulated."},{"type":"...number","value":"...number otherValues Values bit to perform bitwise \"and\" with. Optional.","name":"otherValues","description":"Values bit to perform bitwise \"and\" with. Optional."}],"class":"function","name":"band","description":" Performs the bitwise \"and\" for all values specified."}},"tables":[],"path":"libs_sh/bit.lua#L556","libtbl":["bit_library"],"realm":"shared","fields":[],"class":"library","name":"bit","description":" Bit library http://wiki.facepunch.com/gmod/Category:bit"},"trace":{"methods":{"isBoxIntersectingSphere":{"path":"libs_sh/trace.lua#L139","returns":[{"type":"boolean","value":"boolean true if there is an intersection, false otherwise.","description":"true if there is an intersection, false otherwise."}],"realm":"shared","params":[{"type":"Vector","value":"Vector boxMins The minimum extents of the World Axis-Aligned box.","name":"boxMins","description":"The minimum extents of the World Axis-Aligned box."},{"type":"Vector","value":"Vector boxMaxs The maximum extents of the World Axis-Aligned box.","name":"boxMaxs","description":"The maximum extents of the World Axis-Aligned box."},{"type":"Vector","value":"Vector spherePos Position of the sphere.","name":"spherePos","description":"Position of the sphere."},{"type":"number","value":"number sphereRadius The radius of the sphere.","name":"sphereRadius","description":"The radius of the sphere."}],"class":"function","name":"isBoxIntersectingSphere","description":" Performs a box-sphere intersection and returns whether there was an intersection or not."},"canCreateDecal":{"path":"libs_sh/trace.lua#L188","returns":[{"type":"boolean","value":"boolean Whether the decal trace can be used","description":"Whether the decal trace can be used"}],"realm":"shared","class":"function","name":"canCreateDecal","description":" Returns True if player is allowed to use trace.decal"},"intersectRayWithOBB":{"path":"libs_sh/trace.lua#L117","returns":[{"type":"Vector?","value":"Vector? Hit position or nil if not hit","description":"Hit position or nil if not hit"},{"type":"Vector?","value":"Vector? Hit normal or nil if not hit","description":"Hit normal or nil if not hit"},{"type":"number?","value":"number? Hit fraction or nil if not hit","description":"Hit fraction or nil if not hit"}],"realm":"shared","params":[{"type":"Vector","value":"Vector rayStart The origin of the ray","name":"rayStart","description":"The origin of the ray"},{"type":"Vector","value":"Vector rayDelta The direction and length of the ray","name":"rayDelta","description":"The direction and length of the ray"},{"type":"Vector","value":"Vector boxOrigin The origin of the box","name":"boxOrigin","description":"The origin of the box"},{"type":"Angle","value":"Angle boxAngles The box's angles","name":"boxAngles","description":"The box's angles"},{"type":"Vector","value":"Vector boxMins The box min bounding vector","name":"boxMins","description":"The box min bounding vector"},{"type":"Vector","value":"Vector boxMaxs The box max bounding vector","name":"boxMaxs","description":"The box max bounding vector"}],"class":"function","name":"intersectRayWithOBB","description":" Does a ray box intersection returning the position hit, normal, and trace fraction, or nil if not hit."},"hull":{"path":"libs_sh/trace.lua#L89","returns":[{"type":"table","value":"table Result of the trace https://wiki.facepunch.com/gmod/Structures/TraceResult","description":"Result of the trace https://wiki.facepunch.com/gmod/Structures/TraceResult"}],"realm":"shared","params":[{"type":"Vector","value":"Vector start Start position","name":"start","description":"Start position"},{"type":"Vector","value":"Vector endpos End position","name":"endpos","description":"End position"},{"type":"Vector","value":"Vector minbox Lower box corner","name":"minbox","description":"Lower box corner"},{"type":"Vector","value":"Vector maxbox Upper box corner","name":"maxbox","description":"Upper box corner"},{"type":"Entity|table|function|nil","value":"Entity|table|function|nil filter Entity/array of entities to filter, or a function callback with an entity argument that returns whether the trace should hit","name":"filter","description":"Entity/array of entities to filter, or a function callback with an entity argument that returns whether the trace should hit"},{"type":"number?","value":"number? mask Trace mask","name":"mask","description":"Trace mask"},{"type":"number?","value":"number? colgroup The collision group of the trace","name":"colgroup","description":"The collision group of the trace"},{"type":"boolean?","value":"boolean? ignworld Whether the trace should ignore world","name":"ignworld","description":"Whether the trace should ignore world"}],"class":"function","name":"hull","description":" Does a swept-AABB trace"},"decal":{"path":"libs_sh/trace.lua#L168","realm":"shared","params":[{"type":"string","value":"string name The decal name, see https://wiki.facepunch.com/gmod/util.Decal","name":"name","description":"The decal name, see https://wiki.facepunch.com/gmod/util.Decal"},{"type":"Vector","value":"Vector start Start position","name":"start","description":"Start position"},{"type":"Vector","value":"Vector endpos End position","name":"endpos","description":"End position"},{"type":"Entity|table|nil","value":"Entity|table|nil filter (Optional) Entity/array of entities to filter","name":"filter","description":"(Optional) Entity/array of entities to filter"}],"class":"function","name":"decal","description":" Does a line trace and applies a decal to wherever is hit"},"line":{"path":"libs_sh/trace.lua#L67","returns":[{"type":"table","value":"table Result of the trace https://wiki.facepunch.com/gmod/Structures/TraceResult","description":"Result of the trace https://wiki.facepunch.com/gmod/Structures/TraceResult"}],"realm":"shared","params":[{"type":"Vector","value":"Vector start Start position","name":"start","description":"Start position"},{"type":"Vector","value":"Vector endpos End position","name":"endpos","description":"End position"},{"type":"Entity|table|function|nil","value":"Entity|table|function|nil filter Entity/array of entities to filter, or a function callback with an entity argument that returns whether the trace should hit","name":"filter","description":"Entity/array of entities to filter, or a function callback with an entity argument that returns whether the trace should hit"},{"type":"number?","value":"number? mask Trace mask","name":"mask","description":"Trace mask"},{"type":"number?","value":"number? colgroup The collision group of the trace","name":"colgroup","description":"The collision group of the trace"},{"type":"boolean?","value":"boolean? ignworld Whether the trace should ignore world","name":"ignworld","description":"Whether the trace should ignore world"}],"class":"function","name":"line","description":" Does a line trace"},"decalsLeft":{"path":"libs_sh/trace.lua#L194","returns":[{"type":"number","value":"number The number of decals left","description":"The number of decals left"}],"realm":"shared","class":"function","name":"decalsLeft","description":" Returns the number of decals player is allowed to use"},"aimVector":{"path":"libs_sh/trace.lua#L208","returns":[{"type":"Vector","value":"Vector The aim vector","description":"The aim vector"}],"realm":"shared","params":[{"type":"Angle","value":"Angle viewAngles View angles","name":"viewAngles","description":"View angles"},{"type":"number","value":"number viewFOV View field of view","name":"viewFOV","description":"View field of view"},{"type":"number","value":"number x X position on the screen","name":"x","description":"X position on the screen"},{"type":"number","value":"number y Y position on the screen","name":"y","description":"Y position on the screen"},{"type":"number","value":"number screenWidth Screen width","name":"screenWidth","description":"Screen width"},{"type":"number","value":"number screenHeight Screen height","name":"screenHeight","description":"Screen height"}],"class":"function","name":"aimVector","description":" Calculates the aim vector from a 2D screen position. This is essentially a generic version of input.screenToVector, where you can define the view angles and screen size manually."},"pointContents":{"path":"libs_sh/trace.lua#L200","returns":[{"type":"number","value":"number Contents bitflag, see the CONTENTS enums","description":"Contents bitflag, see the CONTENTS enums"}],"realm":"shared","params":[{"type":"Vector","value":"Vector position The position to get the CONTENTS of","name":"position","description":"The position to get the CONTENTS of"}],"class":"function","name":"pointContents","description":" Returns the contents of the position specified."},"intersectRayWithPlane":{"path":"libs_sh/trace.lua#L152","returns":[{"type":"Vector?","value":"Vector? Hit position or nil if not hit","description":"Hit position or nil if not hit"}],"realm":"shared","params":[{"type":"Vector","value":"Vector rayStart The origin of the ray","name":"rayStart","description":"The origin of the ray"},{"type":"Vector","value":"Vector rayDelta The direction and length of the ray","name":"rayDelta","description":"The direction and length of the ray"},{"type":"Vector","value":"Vector planeOrigin The origin of the plane","name":"planeOrigin","description":"The origin of the plane"},{"type":"Vector","value":"Vector planeNormal The normal of the plane","name":"planeNormal","description":"The normal of the plane"}],"class":"function","name":"intersectRayWithPlane","description":" Does a ray plane intersection returning the position hit or nil if not hit"}},"tables":[],"path":"libs_sh/trace.lua#L19","libtbl":["trace_library"],"realm":"shared","fields":[],"class":"library","name":"trace","description":" Provides functions for doing line/AABB traces"},"prop":{"methods":{"spawnRate":{"path":"libs_sv/prop.lua#L693","returns":[{"type":"number","value":"number Number of props per second the user can spawn","description":"Number of props per second the user can spawn"}],"realm":"server","class":"function","name":"spawnRate","description":" Returns how many props per second the user can spawn"},"setPropUndo":{"path":"libs_sv/prop.lua#L706","realm":"server","params":[{"type":"boolean","value":"boolean on Whether the props should be undo-able","name":"on","description":"Whether the props should be undo-able"}],"class":"function","name":"setPropUndo","description":" Sets whether the props should be undo-able"},"createSent":{"path":"libs_sv/prop.lua#L405","returns":[{"type":"Entity","value":"Entity The sent object","description":"The sent object"}],"realm":"server","params":[{"type":"Vector","value":"Vector pos Position of created sent","name":"pos","description":"Position of created sent"},{"type":"Angle","value":"Angle ang Angle of created sent","name":"ang","description":"Angle of created sent"},{"type":"string","value":"string class Class of created sent","name":"class","description":"Class of created sent"},{"type":"boolean?","value":"boolean? frozen True to spawn the entity in a frozen state. Default = False","name":"frozen","description":"True to spawn the entity in a frozen state. Default = False"},{"type":"table?","value":"table? data Optional table, additional entity data to be supplied to certain SENTs. See prop.SENT_Data_Structures table in Docs for list of SENTs","name":"data","description":"Optional table, additional entity data to be supplied to certain SENTs. See prop.SENT_Data_Structures table in Docs for list of SENTs"}],"class":"function","name":"createSent","description":" Creates a sent."},"create":{"path":"libs_sv/prop.lua#L46","returns":[{"type":"Entity","value":"Entity The prop object","description":"The prop object"}],"realm":"server","params":[{"type":"Vector","value":"Vector pos Initial entity position","name":"pos","description":"Initial entity position"},{"type":"Angle","value":"Angle ang Initial entity angles","name":"ang","description":"Initial entity angles"},{"type":"string","value":"string model Model path","name":"model","description":"Model path"},{"type":"boolean?","value":"boolean? frozen True to spawn the entity in a frozen state. Default = False","name":"frozen","description":"True to spawn the entity in a frozen state. Default = False"}],"class":"function","name":"create","description":" Creates a prop"},"createComponent":{"path":"libs_sv/prop.lua#L249","returns":[{"type":"Entity","value":"Entity Component entity","description":"Component entity"}],"realm":"server","params":[{"type":"Vector","value":"Vector pos Position of created component","name":"pos","description":"Position of created component"},{"type":"Angle","value":"Angle ang Angle of created component","name":"ang","description":"Angle of created component"},{"type":"string","value":"string class Class of created component","name":"class","description":"Class of created component"},{"type":"string","value":"string model Model of created component","name":"model","description":"Model of created component"},{"type":"boolean?","value":"boolean? frozen True to spawn the entity in a frozen state. Default = False","name":"frozen","description":"True to spawn the entity in a frozen state. Default = False"}],"class":"function","name":"createComponent","description":" Creates starfall component\n Allowed components:\n starfall_hud\n starfall_screen"},"createSeat":{"path":"libs_sv/prop.lua#L347","returns":[{"type":"Entity","value":"Entity The seat object","description":"The seat object"}],"realm":"server","params":[{"type":"Vector","value":"Vector pos Position of created seat","name":"pos","description":"Position of created seat"},{"type":"Angle","value":"Angle ang Angle of created seat","name":"ang","description":"Angle of created seat"},{"type":"string","value":"string model Model of created seat","name":"model","description":"Model of created seat"},{"type":"boolean?","value":"boolean? frozen True to spawn the entity in a frozen state. Default = False","name":"frozen","description":"True to spawn the entity in a frozen state. Default = False"}],"class":"function","name":"createSeat","description":" Creates a seat."},"propsLeft":{"path":"libs_sv/prop.lua#L685","returns":[{"type":"number","value":"number Number of props able to be spawned","description":"Number of props able to be spawned"}],"realm":"server","class":"function","name":"propsLeft","description":" Checks how many props can be spawned"},"createCustom":{"path":"libs_sv/prop.lua#L150","returns":[{"type":"Entity","value":"Entity The prop object","description":"The prop object"}],"realm":"server","params":[{"type":"Vector","value":"Vector pos The position to spawn the prop","name":"pos","description":"The position to spawn the prop"},{"type":"Angle","value":"Angle ang The angles to spawn the prop","name":"ang","description":"The angles to spawn the prop"},{"type":"table","value":"table vertices The table of tables of vertices that make up the physics mesh {{v1,v2,...},{v1,v2,...},...}","name":"vertices","description":"The table of tables of vertices that make up the physics mesh {{v1,v2,...},{v1,v2,...},...}"},{"type":"boolean?","value":"boolean? frozen True to spawn the entity in a frozen state. Default = False","name":"frozen","description":"True to spawn the entity in a frozen state. Default = False"}],"class":"function","name":"createCustom","description":" Creates a custom prop."},"setPropClean":{"path":"libs_sv/prop.lua#L700","realm":"server","params":[{"type":"boolean","value":"boolean on Whether the props should be cleaned or not","name":"on","description":"Whether the props should be cleaned or not"}],"class":"function","name":"setPropClean","description":" Sets whether the chip should remove created props when the chip is removed"},"canSpawn":{"path":"libs_sv/prop.lua#L677","returns":[{"type":"boolean","value":"boolean True if user can spawn props, False if not.","description":"True if user can spawn props, False if not."}],"realm":"server","class":"function","name":"canSpawn","description":" Checks if a user can spawn anymore props."},"getSpawnableSents":{"path":"libs_sv/prop.lua#L316","returns":[{"type":"table","value":"table The table","description":"The table"}],"realm":"server","params":[{"type":"boolean?","value":"boolean? categorized True to get an categorized list","name":"categorized","description":"True to get an categorized list"}],"class":"function","name":"getSpawnableSents","description":" Get a list of all spawnable sents."},"createRagdoll":{"path":"libs_sv/prop.lua#L101","returns":[{"type":"Entity","value":"Entity The ragdoll entity","description":"The ragdoll entity"}],"realm":"server","params":[{"type":"string","value":"string model Model path","name":"model","description":"Model path"},{"type":"boolean?","value":"boolean? frozen True to spawn the entity in a frozen state. Default = False","name":"frozen","description":"True to spawn the entity in a frozen state. Default = False"}],"class":"function","name":"createRagdoll","description":" Creates a ragdoll"}},"tables":{"SENT_Data_Structures":{"path":"libs_sv/prop_sent.lua#L1081","realm":"server","class":"table","name":"SENT_Data_Structures","description":" \n > gmod_balloon\n number b = 255\n number force\n number g = 255\n string Model = \"models/maxofs2d/balloon_classic.mdl\"\n number r = 255\n \n > gmod_button\n string description = \"\"\n number key\n string Model = \"models/maxofs2d/button_05.mdl\"\n boolean toggle = true\n \n > gmod_cameraprop\n number controlkey\n boolean locked = false\n string Model = \"models/dav0r/camera.mdl\"\n boolean toggle = true\n \n > gmod_dynamite\n number Damage = 200\n number delay = 0\n number key\n string Model = \"models/dav0r/tnt/tnt.mdl\"\n boolean remove = false\n \n > gmod_emitter\n number delay = 0\n string effect\n number key\n string Model = \"models/props_lab/tpplug.mdl\"\n number scale = 1\n boolean starton = false\n boolean toggle = true\n \n > gmod_hoverball\n number key_d = -1\n number key_u = -1\n string Model = \"models/dav0r/hoverball.mdl\"\n number resistance = 0\n number speed = 1\n number strength = 1\n \n > gmod_lamp\n number b = 255\n number brightness = 4\n number distance = 1024\n number fov = 90\n number g = 255\n number KeyDown = -1\n string Model = \"models/lamps/torch.mdl\"\n boolean on = false\n number r = 255\n string Texture = \"effects/flashlight001\"\n boolean toggle = true\n \n > gmod_light\n number Brightness = 2\n number KeyDown = -1\n number lightb = 255\n number lightg = 255\n number lightr = 255\n string Model = \"models/maxofs2d/light_tubular.mdl\"\n boolean on = false\n number Size = 256\n boolean toggle = true\n \n > gmod_thruster\n boolean damageable = false\n string effect = \"fire\"\n number force = 1500\n number key = -1\n number key_bck = -1\n string Model = \"models/props_phx2/garbage_metalcan001a.mdl\"\n string soundname = \"PhysicsCannister.ThrusterLoop\"\n boolean toggle = false\n \n > gmod_wire_addressbus\n number Mem1st = 0\n number Mem1sz = 0\n number Mem2st = 0\n number Mem2sz = 0\n number Mem3st = 0\n number Mem3sz = 0\n number Mem4st = 0\n number Mem4sz = 0\n string Model = \"models/jaanus/wiretool/wiretool_gate.mdl\"\n \n > gmod_wire_adv_emarker\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_adv_input\n number keyless = 1\n number keymore = 3\n string Model = \"models/beer/wiremod/numpad.mdl\"\n number speed = 1\n boolean toggle = false\n number value_max = 10\n number value_min = 0\n number value_start = 5\n \n > gmod_wire_button\n string description = \"\"\n boolean entityout = false\n string Model = \"models/props_c17/clock01.mdl\"\n boolean toggle = false\n number value_off = 0\n number value_on = 1\n \n > gmod_wire_cameracontroller\n boolean AllowZoom = false\n boolean AutoMove = false\n boolean AutoUnclip = false\n boolean AutoUnclip_IgnoreWater = false\n boolean DrawParent = true\n boolean DrawPlayer = true\n boolean FreeMove = false\n boolean LocalMove = false\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n boolean ParentLocal = false\n \n > gmod_wire_cd_disk\n number IRadius = 10\n string Model = \"models/venompapa/wirecd_medium.mdl\"\n number Precision = 4\n number Skin = 0\n \n > gmod_wire_cd_ray\n boolean DefaultZero = false\n string Model = \"models/jaanus/wiretool/wiretool_beamcaster.mdl\"\n number Range = 64\n \n > gmod_wire_clutch\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_colorer\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n boolean outColor = false\n number Range = 2000\n \n > gmod_wire_consolescreen\n string Model = \"models/props_lab/monitor01b.mdl\"\n \n > gmod_wire_damage_detector\n boolean includeconstrained = false\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_data_satellitedish\n string Model = \"models/props_wasteland/prison_lamp001c.mdl\"\n \n > gmod_wire_data_store\n string Model = \"models/jaanus/wiretool/wiretool_range.mdl\"\n \n > gmod_wire_data_transferer\n boolean DefaultZero = false\n boolean IgnoreZero = false\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n number Range = 25000\n \n > gmod_wire_dataport\n string Model = \"models/jaanus/wiretool/wiretool_gate.mdl\"\n \n > gmod_wire_datarate\n string Model = \"models/jaanus/wiretool/wiretool_gate.mdl\"\n \n > gmod_wire_datasocket\n number AttachRange = 5\n string Model = \"models/hammy/pci_slot.mdl\"\n number WeldForce = 5000\n \n > gmod_wire_detonator\n number damage = 1\n string Model = \"models/props_combine/breenclock.mdl\"\n \n > gmod_wire_dhdd\n string Model\n \n > gmod_wire_digitalscreen\n string Model = \"models/props_lab/monitor01b.mdl\"\n number ScreenHeight = 32\n number ScreenWidth = 32\n \n > gmod_wire_dual_input\n number keygroup = 7\n number keygroup2 = 4\n string Model = \"models/beer/wiremod/numpad.mdl\"\n boolean toggle = false\n number value_off = 0\n number value_on = 1\n number value_on2 = -1\n \n > gmod_wire_dynamic_button\n string description = \"\"\n boolean entityout = false\n string material_off = \"bull/dynamic_button_0\"\n string material_on = \"bull/dynamic_button_1\"\n string Model = \"models/bull/ranger.mdl\"\n number off_b = 255\n number off_g = 255\n number off_r = 255\n number on_b = 255\n number on_g = 255\n number on_r = 255\n boolean toggle = false\n number value_off = 0\n number value_on = 1\n \n > gmod_wire_egp\n string Model = \"models/kobilica/wiremonitorbig.mdl\"\n \n > gmod_wire_egp_emitter\n string Model = \"models/bull/dynamicbutton.mdl\"\n \n > gmod_wire_egp_hud\n string Model = \"models/bull/dynamicbutton.mdl\"\n \n > gmod_wire_emarker\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_exit_point\n string Model = \"models/jaanus/wiretool/wiretool_range.mdl\"\n \n > gmod_wire_explosive\n boolean affectother = false\n boolean bulletproof = false\n boolean coloreffect = true\n number damage = 200\n number delayreloadtime = 0\n number delaytime = 0\n boolean explodeatzero = true\n boolean explosionproof = false\n boolean fallproof = false\n boolean fireeffect = true\n boolean invisibleatzero = false\n number key = 1\n number maxhealth = 100\n string Model = \"models/props_c17/oildrum001_explosive.mdl\"\n boolean notaffected = false\n number radius = 300\n boolean removeafter = false\n boolean resetatexplode = true\n \n > gmod_wire_expression2\n string _name = \"Generic\"\n string _original = \"print(\"Hello World!\")\"\n table inc_files = {}\n string Model = \"models/beer/wiremod/gate_e2.mdl\"\n\n > starfall_processor\n string Model = \"models/spacecode/sfchip_medium.mdl\"\n string Code\n \n > gmod_wire_extbus\n string Model = \"models/jaanus/wiretool/wiretool_gate.mdl\"\n \n > gmod_wire_eyepod\n number ClampX = 0\n number ClampXMax = 0\n number ClampXMin = 0\n number ClampY = 0\n number ClampYMax = 0\n number ClampYMin = 0\n number DefaultToZero = 1\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n number ShowRateOfChange = 1\n \n > gmod_wire_forcer\n number Force = 1\n number Length = 100\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n boolean Reaction = false\n boolean ShowBeam = true\n \n > gmod_wire_freezer\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_friendslist\n string Model = \"models/kobilica/value.mdl\"\n boolean save_on_entity = false\n table steamids = {}\n \n > gmod_wire_fx_emitter\n number delay = 0.07\n string effect = \"sparks\"\n string Model = \"models/props_lab/tpplug.mdl\"\n \n > gmod_wire_gate\n string action = \"+\"\n string Model = \"models/jaanus/wiretool/wiretool_gate.mdl\"\n \n > gmod_wire_gimbal\n string Model = \"models/props_c17/canister01a.mdl\"\n \n > gmod_wire_gps\n string Model = \"models/beer/wiremod/gps.mdl\"\n \n > gmod_wire_gpulib_controller\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_grabber\n boolean Gravity = true\n string Model = \"models/jaanus/wiretool/wiretool_range.mdl\"\n number Range = 100\n \n > gmod_wire_graphics_tablet\n boolean draw_background = true\n boolean gmode = false\n string Model = \"models/kobilica/wiremonitorbig.mdl\"\n \n > gmod_wire_gyroscope\n string Model = \"models/bull/various/gyroscope.mdl\"\n boolean out180 = false\n \n > gmod_wire_hdd\n number DriveCap = 128\n number DriveID = 0\n string Model = \"models/jaanus/wiretool/wiretool_gate.mdl\"\n \n > gmod_wire_holoemitter\n string Model = \"models/jaanus/wiretool/wiretool_range.mdl\"\n \n > gmod_wire_hologrid\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n boolean usegps = false\n \n > gmod_wire_hoverball\n string Model = \"models/dav0r/hoverball.mdl\"\n number resistance = 0\n number speed = 1\n boolean starton = true\n number strength = 1\n \n > gmod_wire_hudindicator\n number a = 0\n number aa = 255\n number ab = 0\n number ag = 0\n boolean allowhook = true\n number ar = 255\n number b = 1\n number ba = 255\n number bb = 0\n number bg = 255\n number br = 0\n number fullcircleangle = 0\n boolean hudaddname = false\n string huddesc = \"\"\n number hudshowvalue = 0\n number hudstyle = 0\n string material = \"models/debug/debugwhite\"\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n boolean showinhud = false\n \n > gmod_wire_hydraulic\n number Bone1 = 0\n number Bone2 = 0\n Entity Ent1\n Entity Ent2\n number fixed = 0\n Vector LPos1 = Vector(0, 0, 0)\n Vector LPos2 = Vector(0, 0, 0)\n string material = \"cable/rope\"\n string Model = \"models/beer/wiremod/hydraulic.mdl\"\n number speed = 16\n boolean stretchonly = false\n number width = 3\n \n > gmod_wire_igniter\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n number Range = 2048\n boolean TargetPlayers = false\n \n > gmod_wire_indicator\n number a = 0\n number aa = 255\n number ab = 0\n number ag = 0\n number ar = 255\n number b = 1\n number ba = 255\n number bb = 0\n number bg = 255\n number br = 0\n string Model = \"models/segment.mdl\"\n \n > gmod_wire_input\n number keygroup = 7\n string Model = \"models/beer/wiremod/numpad.mdl\"\n boolean toggle = false\n number value_off = 0\n number value_on = 1\n \n > gmod_wire_keyboard\n boolean AutoBuffer = true\n boolean EnterKeyAscii = true\n string Model = \"models/jaanus/wiretool/wiretool_input.mdl\"\n boolean Synchronous = true\n \n > gmod_wire_keypad\n string Model = \"models/props_lab/keypad.mdl\"\n string Password\n boolean Secure\n \n > gmod_wire_lamp\n number b = 255\n number Brightness = 8\n number Dist = 1024\n number FOV = 90\n number g = 255\n string Model = \"models/lamps/torch.mdl\"\n boolean on = false\n number r = 255\n string Texture = \"effects/flashlight001\"\n \n > gmod_wire_las_receiver\n string Model = \"models/jaanus/wiretool/wiretool_range.mdl\"\n \n > gmod_wire_latch\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_lever\n number Max = 1\n number Min = 0\n \n > gmod_wire_light\n number B = 255\n number brightness = 2\n boolean directional = false\n number G = 255\n boolean glow = false\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n number R = 255\n boolean radiant = false\n number size = 256\n \n > gmod_wire_locator\n string Model = \"models/props_lab/powerbox02d.mdl\"\n \n > gmod_wire_motor\n number Bone1 = 0\n number Bone2 = 0\n Entity Ent1\n Entity Ent2\n number forcelimit = 0\n number friction = 1\n Vector LPos1 = Vector(0, 0, 0)\n Vector LPos2 = Vector(0, 0, 0)\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n number torque = 500\n \n > gmod_wire_nailer\n number Flim = 0\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n number Range = 100\n boolean ShowBeam = true\n \n > gmod_wire_numpad\n string Model = \"models/beer/wiremod/numpad.mdl\"\n boolean toggle = false\n number value_off = 0\n number value_on = 0\n \n > gmod_wire_oscilloscope\n string Model = \"models/props_lab/monitor01b.mdl\"\n \n > gmod_wire_output\n number key = 1\n string Model = \"models/beer/wiremod/numpad.mdl\"\n \n > gmod_wire_pixel\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_pod\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_radio\n string Channel = \"1\"\n string Model = \"models/props_lab/binderblue.mdl\"\n boolean Secure = false\n number values = 4\n \n > gmod_wire_ranger\n boolean default_zero = true\n boolean hires = false\n boolean ignore_world = false\n string Model = \"models/jaanus/wiretool/wiretool_range.mdl\"\n boolean out_ang = false\n boolean out_col = false\n boolean out_dist = true\n boolean out_eid = false\n boolean out_hnrm = false\n boolean out_pos = false\n boolean out_sid = false\n boolean out_uid = false\n boolean out_val = false\n boolean out_vel = false\n number range = 1500\n boolean show_beam = true\n boolean trace_water = false\n \n > gmod_wire_relay\n number keygroup1 = 1\n number keygroup2 = 2\n number keygroup3 = 3\n number keygroup4 = 4\n number keygroup5 = 5\n number keygroupoff = 0\n string Model = \"models/kobilica/relay.mdl\"\n boolean nokey = false\n number normclose = 0\n number poles = 1\n number throws = 2\n boolean toggle = true\n \n > gmod_wire_screen\n boolean Floor = false\n boolean FormatNumber = false\n boolean FormatTime = false\n boolean LeftAlign = false\n string Model = \"models/props_lab/monitor01b.mdl\"\n boolean SingleBigFont = true\n boolean SingleValue = false\n string TextA = \"Value A\"\n string TextB = \"Value B\"\n \n > gmod_wire_sensor\n boolean direction_normalized = false\n boolean direction_vector = false\n boolean gpscord = false\n string Model\n boolean outbrng = false\n boolean outdist = true\n boolean target_velocity = false\n boolean velocity_normalized = false\n boolean xyz_mode = false\n \n > gmod_wire_simple_explosive\n number damage = 200\n number key = 1\n string Model = \"models/props_c17/oildrum001_explosive.mdl\"\n number radius = 300\n boolean removeafter = false\n \n > gmod_wire_socket\n boolean ArrayInput = false\n number AttachRange = 5\n string Model = \"models/props_lab/tpplugholder_single.mdl\"\n number WeldForce = 5000\n \n > gmod_wire_soundemitter\n string Model = \"models/cheeze/wires/speaker.mdl\"\n string sound = \"synth/square.wav\"\n \n > gmod_wire_spawner\n number a = 255\n number b = 255\n number delay = 0\n number g = 255\n string mat = \"\"\n string Model\n number r = 255\n number skin = 0\n number spawn_effect = 0\n number undo_delay = 0\n \n > gmod_wire_speedometer\n boolean AngVel = false\n string Model\n boolean z_only = false\n \n > gmod_wire_target_finder\n boolean beacons = false\n boolean casesen = false\n boolean checkbuddylist = false\n boolean colorcheck = false\n boolean colortarget = false\n string entity = \"\"\n boolean hoverballs = false\n number maxbogeys = 1\n number maxtargets = 1\n number minrange = 1\n string Model = \"models/beer/wiremod/targetfinder.mdl\"\n boolean notargetowner = false\n boolean notownersstuff = false\n string npcname = \"\"\n boolean npcs = true\n boolean onbuddylist = false\n boolean painttarget = true\n number pcolA = 255\n number pcolB = 255\n number pcolG = 255\n number pcolR = 255\n string playername = \"\"\n boolean players = false\n string propmodel = \"\"\n boolean props = false\n number range = 1000\n boolean rpgs = false\n string steamname = \"\"\n boolean thrusters = false\n boolean vehicles = false\n \n > gmod_wire_teleporter\n string Model = \"models/props_c17/utilityconducter001.mdl\"\n boolean UseEffects = true\n boolean UseSounds = true\n \n > gmod_wire_textentry\n string Model = \"models/beer/wiremod/keyboard.mdl\"\n \n > gmod_wire_textreceiver\n boolean CaseInsensitive = true\n table Matches\n string Model = \"models/jaanus/wiretool/wiretool_range.mdl\"\n boolean UseLuaPatterns = false\n \n > gmod_wire_textscreen\n Color bgcolor = Color(0, 0, 0)\n number chrPerLine = 6\n Color fgcolor = Color(255, 255, 255)\n string Model = \"models/kobilica/wiremonitorbig.mdl\"\n string text = \"\"\n number textJust = 1\n string tfont = \"Arial\"\n number valign = 0\n \n > gmod_wire_thruster\n boolean bidir = true\n number force = 1500\n number force_max = 10000\n number force_min = 0\n string Model = \"models/props_c17/lampShade001a.mdl\"\n boolean owater = true\n string oweffect = \"fire\"\n string soundname = \"\"\n boolean uwater = true\n string uweffect = \"same\"\n \n > gmod_wire_trail\n Color Color = Color(255, 255, 255)\n number EndSize = 0\n number Length = 5\n string Material = \"trails/lol\"\n number StartSize = 32\n \n > gmod_wire_trigger\n number filter = 0\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n number offsetx = 0\n number offsety = 0\n number offsetz = 0\n boolean owneronly = false\n number sizex = 64\n number sizey = 64\n number sizez = 64\n \n > gmod_wire_turret\n number damage = 10\n number delay = 0.05\n number force = 1\n string Model = \"models/weapons/w_smg1.mdl\"\n number numbullets = 1\n string sound = \"0\"\n number spread = 0\n string tracer = \"Tracer\"\n number tracernum = 1\n \n > gmod_wire_twoway_radio\n string Model = \"models/props_lab/binderblue.mdl\"\n \n > gmod_wire_user\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n number Range = 200\n \n > gmod_wire_value\n string Model = \"models/kobilica/value.mdl\"\n table value\n \n > gmod_wire_vectorthruster\n boolean angleinputs = false\n boolean bidir = true\n number force = 1500\n number force_max = 10000\n number force_min = 0\n boolean lengthismul = false\n number mode = 0\n string Model = \"models/jaanus/wiretool/wiretool_speed.mdl\"\n boolean owater = true\n string oweffect = \"fire\"\n string soundname = \"\"\n boolean uwater = true\n string uweffect = \"same\"\n \n > gmod_wire_vehicle\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_watersensor\n string Model = \"models/beer/wiremod/watersensor.mdl\"\n \n > gmod_wire_waypoint\n string Model = \"models/props_lab/powerbox02d.mdl\"\n number range = 150\n \n > gmod_wire_weight\n string Model = \"models/props_interiors/pot01a.mdl\"\n \n > gmod_wire_wheel\n Entity Base\n number BaseTorque = 3000\n number bck = -1\n number Bone = 0\n number forcelimit = 0\n number friction = 1\n number fwd = 1\n Vector LAxis = Vector(0, 1, 0)\n Vector LPos = Vector(0, 0, 0)\n string Model = \"models/props_vehicles/carparts_wheel01a.mdl\"\n number stop = 0\n "}},"path":"libs_sv/prop.lua#L23","libtbl":["props_library"],"realm":"server","fields":[],"class":"library","name":"prop","description":" Library for creating and manipulating physics-less models AKA \"Props\"."},"von":{"methods":{"serialize":{"path":"libs_sh/von.lua#L817","returns":[{"type":"string","value":"string String encoded from the table","description":"String encoded from the table"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to serialize","name":"tbl","description":"Table to serialize"},{"type":"boolean?","value":"boolean? checkRecursive Enable checking for table recursion (default: false)","name":"checkRecursive","description":"Enable checking for table recursion (default: false)"}],"class":"function","name":"serialize","description":" Serialize a table"},"deserialize":{"path":"libs_sh/von.lua#L808","returns":[{"type":"table","value":"table Table","description":"Table"}],"realm":"shared","params":[{"type":"string","value":"string str String to deserialize","name":"str","description":"String to deserialize"}],"class":"function","name":"deserialize","description":" Deserialize a string"}},"tables":[],"path":"libs_sh/von.lua#L797","libtbl":["von_library"],"realm":"shared","fields":[],"class":"library","name":"von","description":" vON Library"},"nextbot":{"methods":{"canSpawn":{"path":"libs_sv/nextbot.lua#L115","returns":[{"type":"boolean","value":"boolean True if user can spawn nextbots, False if not.","description":"True if user can spawn nextbots, False if not."}],"realm":"server","class":"function","name":"canSpawn","description":" Checks if a user can spawn anymore nextbots."},"create":{"path":"libs_sv/nextbot.lua#L81","returns":[{"type":"NextBot","value":"NextBot The nextbot.","description":"The nextbot."}],"realm":"server","params":[{"type":"Vector","value":"Vector spawnpos The position the nextbot will be spawned at.","name":"spawnpos","description":"The position the nextbot will be spawned at."},{"type":"string","value":"string model The model the nextbot will use.","name":"model","description":"The model the nextbot will use."}],"class":"function","name":"create","description":" Creates a customizable NextBot"},"remove":{"path":"libs_sv/nextbot.lua#L108","realm":"server","class":"function","name":"remove","description":" Removes the given nextbot."}},"tables":[],"path":"libs_sv/nextbot.lua#L12","libtbl":["nextbot_library"],"realm":"server","fields":[],"class":"library","name":"nextbot","description":" Library for spawning NextBots."},"net":{"methods":{"readVector":{"path":"libs_sh/net.lua#L420","returns":[{"type":"Vector","value":"Vector The vector that was read","description":"The vector that was read"}],"realm":"shared","class":"function","name":"readVector","description":" Reads a vector from the net message"},"writeUInt":{"path":"libs_sh/net.lua#L298","realm":"shared","params":[{"type":"number","value":"number t The integer to be written","name":"t","description":"The integer to be written"},{"type":"number","value":"number n The amount of bits the integer consists of. Should not be greater than 32","name":"n","description":"The amount of bits the integer consists of. Should not be greater than 32"}],"class":"function","name":"writeUInt","description":" Writes an unsigned integer to the net message"},"send":{"path":"libs_sh/net.lua#L92","realm":"shared","params":[{"type":"Player|table|nil","value":"Player|table|nil target Optional target location to send the net message. Player or table of targets. If nil, sends to server on client","name":"target","description":"Optional target location to send the net message. Player or table of targets. If nil, sends to server on client"},{"type":"boolean?","value":"boolean? unreliable Optional choose whether it's more important for the message to actually reach its destination (false) or reach it as fast as possible (true).","name":"unreliable","description":"Optional choose whether it's more important for the message to actually reach its destination (false) or reach it as fast as possible (true)."}],"class":"function","name":"send","description":" Send a net message from client->server, or server->client."},"readInt":{"path":"libs_sh/net.lua#L289","returns":[{"type":"number","value":"number The integer that was read","description":"The integer that was read"}],"realm":"shared","params":[{"type":"number","value":"number n The amount of bits to read","name":"n","description":"The amount of bits to read"}],"class":"function","name":"readInt","description":" Reads an integer from the net message"},"readString":{"path":"libs_sh/net.lua#L197","returns":[{"type":"string","value":"string The string that was read","description":"The string that was read"}],"realm":"shared","class":"function","name":"readString","description":" Reads a string from the net message"},"readMatrix":{"path":"libs_sh/net.lua#L438","returns":[{"type":"VMatrix","value":"VMatrix The matrix that was read","description":"The matrix that was read"}],"realm":"shared","class":"function","name":"readMatrix","description":" Reads a matrix from the net message"},"writeDouble":{"path":"libs_sh/net.lua#L357","realm":"shared","params":[{"type":"number","value":"number t The double to be written","name":"t","description":"The double to be written"}],"class":"function","name":"writeDouble","description":" Writes a double to the net message"},"readTable":{"path":"libs_sh/net.lua#L178","returns":[{"type":"table","value":"table The table","description":"The table"}],"realm":"shared","class":"function","name":"readTable","description":" Reads an table from a net message automatically typing it\n Will throw an error if invalid type is read. Make sure to pcall it"},"readBool":{"path":"libs_sh/net.lua#L350","returns":[{"type":"boolean","value":"boolean The boolean that was read.","description":"The boolean that was read."}],"realm":"shared","class":"function","name":"readBool","description":" Reads a boolean from the net message"},"writeData":{"path":"libs_sh/net.lua#L204","realm":"shared","params":[{"type":"string","value":"string t The string to be written","name":"t","description":"The string to be written"},{"type":"number","value":"number n How much of the string to write","name":"n","description":"How much of the string to write"}],"class":"function","name":"writeData","description":" Writes string containing null characters to the net message"},"readUInt":{"path":"libs_sh/net.lua#L312","returns":[{"type":"number","value":"number The unsigned integer that was read","description":"The unsigned integer that was read"}],"realm":"shared","params":[{"type":"number","value":"number n The amount of bits to read","name":"n","description":"The amount of bits to read"}],"class":"function","name":"readUInt","description":" Reads an unsigned integer from the net message"},"readData":{"path":"libs_sh/net.lua#L218","returns":[{"type":"string","value":"string The string that was read","description":"The string that was read"}],"realm":"shared","params":[{"type":"number","value":"number n How many characters are in the data","name":"n","description":"How many characters are in the data"}],"class":"function","name":"readData","description":" Reads a string from the net message"},"writeTable":{"path":"libs_sh/net.lua#L166","realm":"shared","params":[{"type":"table","value":"table v The table to write","name":"v","description":"The table to write"}],"class":"function","name":"writeTable","description":" Writes a table to a net message automatically typing it."},"getStreamProgress":{"path":"libs_sh/net.lua#L267","returns":[{"type":"number","value":"number The progress ratio 0-1","description":"The progress ratio 0-1"}],"realm":"shared","class":"function","name":"getStreamProgress","description":" Returns the progress of a running readStream"},"readDouble":{"path":"libs_sh/net.lua#L368","returns":[{"type":"number","value":"number The double that was read","description":"The double that was read"}],"realm":"shared","class":"function","name":"readDouble","description":" Reads a double from the net message"},"getBitsLeft":{"path":"libs_sh/net.lua#L506","returns":[{"type":"number","value":"number Number of bits that can be sent","description":"Number of bits that can be sent"}],"realm":"shared","class":"function","name":"getBitsLeft","description":" Returns available bandwidth in bits"},"writeString":{"path":"libs_sh/net.lua#L186","realm":"shared","params":[{"type":"string","value":"string t The string to be written","name":"t","description":"The string to be written"}],"class":"function","name":"writeString","description":" Writes a string to the net message. Null characters will terminate the string."},"readBit":{"path":"libs_sh/net.lua#L332","returns":[{"type":"number","value":"number The bit that was read. (0 for false, 1 for true)","description":"The bit that was read. (0 for false, 1 for true)"}],"realm":"shared","class":"function","name":"readBit","description":" Reads a bit from the net message"},"writeEntity":{"path":"libs_sh/net.lua#L462","realm":"shared","params":[{"type":"Entity","value":"Entity t The entity to be written","name":"t","description":"The entity to be written"}],"class":"function","name":"writeEntity","description":" Writes an entity to the net message"},"writeInt":{"path":"libs_sh/net.lua#L275","realm":"shared","params":[{"type":"number","value":"number t The integer to be written","name":"t","description":"The integer to be written"},{"type":"number","value":"number n The amount of bits the integer consists of","name":"n","description":"The amount of bits the integer consists of"}],"class":"function","name":"writeInt","description":" Writes an integer to the net message"},"writeFloat":{"path":"libs_sh/net.lua#L375","realm":"shared","params":[{"type":"number","value":"number t The float to be written","name":"t","description":"The float to be written"}],"class":"function","name":"writeFloat","description":" Writes a float to the net message"},"writeVector":{"path":"libs_sh/net.lua#L410","realm":"shared","params":[{"type":"Vector","value":"Vector t The vector to be written","name":"t","description":"The vector to be written"}],"class":"function","name":"writeVector","description":" Writes an vector to the net message. Has significantly lower precision than writeFloat"},"readType":{"path":"libs_sh/net.lua#L158","returns":[{"type":"any","value":"any The object","description":"The object"}],"realm":"shared","class":"function","name":"readType","description":" Reads an object from a net message automatically typing it\n Will throw an error if invalid type is read. Make sure to pcall it"},"start":{"path":"libs_sh/net.lua#L78","realm":"shared","params":[{"type":"string","value":"string name The message name","name":"name","description":"The message name"}],"class":"function","name":"start","description":" Starts the net message"},"readAngle":{"path":"libs_sh/net.lua#L403","returns":[{"type":"Angle","value":"Angle The angle that was read","description":"The angle that was read"}],"realm":"shared","class":"function","name":"readAngle","description":" Reads an angle from the net message"},"cancelStream":{"path":"libs_sh/net.lua#L260","realm":"shared","class":"function","name":"cancelStream","description":" Cancels a currently running readStream"},"sendPVS":{"path":"libs_sh/net.lua#L130","realm":"server","params":[{"type":"Vector","value":"Vector pos A vector within the PVS area to send a message","name":"pos","description":"A vector within the PVS area to send a message"},{"type":"boolean?","value":"boolean? unreliable Optional choose whether it's more important for the message to actually reach its destination (false) or reach it as fast as possible (true).","name":"unreliable","description":"Optional choose whether it's more important for the message to actually reach its destination (false) or reach it as fast as possible (true)."}],"class":"function","name":"sendPVS","description":" Send net message to all players within the visible area of a vector"},"readFloat":{"path":"libs_sh/net.lua#L386","returns":[{"type":"number","value":"number The float that was read","description":"The float that was read"}],"realm":"shared","class":"function","name":"readFloat","description":" Reads a float from the net message"},"getBytesLeft":{"path":"libs_sh/net.lua#L500","returns":[{"type":"number","value":"number Number of bytes that can be sent","description":"Number of bytes that can be sent"}],"realm":"shared","class":"function","name":"getBytesLeft","description":" Returns available bandwidth in bytes"},"receive":{"path":"libs_sh/net.lua#L490","realm":"shared","params":[{"type":"string","value":"string name The name of the net message","name":"name","description":"The name of the net message"},{"type":"function","value":"function func The callback or nil to remove callback. (len - length of the net message, ply - player that sent it or nil if clientside)","name":"func","description":"The callback or nil to remove callback. (len - length of the net message, ply - player that sent it or nil if clientside)"}],"class":"function","name":"receive","description":" Like glua net.Receive, adds a callback that is called when a net message with the matching name is received. If this happens, the net hook won't be called."},"readEntity":{"path":"libs_sh/net.lua#L472","returns":[{"type":"Entity","value":"Entity The entity that was read","description":"The entity that was read"}],"realm":"shared","params":[{"type":"function?","value":"function? callback (Client only) optional callback to be ran whenever the entity becomes valid; returns nothing if this is used. The callback passes the entity if it succeeds or nil if it fails.","name":"callback","description":"(Client only) optional callback to be ran whenever the entity becomes valid; returns nothing if this is used. The callback passes the entity if it succeeds or nil if it fails."}],"class":"function","name":"readEntity","description":" Reads a entity from the net message"},"readColor":{"path":"libs_sh/net.lua#L455","returns":[{"type":"Color","value":"Color The color that was read","description":"The color that was read"}],"realm":"shared","class":"function","name":"readColor","description":" Reads a color from the net message"},"writeAngle":{"path":"libs_sh/net.lua#L393","realm":"shared","params":[{"type":"Angle","value":"Angle t The angle to be written","name":"t","description":"The angle to be written"}],"class":"function","name":"writeAngle","description":" Writes an angle to the net message"},"writeStream":{"path":"libs_sh/net.lua#L228","realm":"shared","params":[{"type":"string","value":"string str The string to be written","name":"str","description":"The string to be written"},{"type":"boolean?","value":"boolean? compress Compress the data. True by default","name":"compress","description":"Compress the data. True by default"}],"class":"function","name":"writeStream","description":" Streams up to 64MB strings. Anything over 20MB with compression enabled will throw cpu quota"},"writeColor":{"path":"libs_sh/net.lua#L447","realm":"shared","params":[{"type":"Color","value":"Color t The color to be written","name":"t","description":"The color to be written"}],"class":"function","name":"writeColor","description":" Writes an color to the net message"},"readStream":{"path":"libs_sh/net.lua#L239","realm":"shared","params":[{"type":"function","value":"function cb Callback to run when the stream is finished. The first parameter in the callback is the data. Will be nil if transfer fails or is cancelled","name":"cb","description":"Callback to run when the stream is finished. The first parameter in the callback is the data. Will be nil if transfer fails or is cancelled"}],"class":"function","name":"readStream","description":" Reads a large string stream from the net message."},"writeBit":{"path":"libs_sh/net.lua#L321","realm":"shared","params":[{"type":"number","value":"number t The bit to be written. (0 for false, 1 (or anything) for true)","name":"t","description":"The bit to be written. (0 for false, 1 (or anything) for true)"}],"class":"function","name":"writeBit","description":" Writes a bit to the net message"},"isStreaming":{"path":"libs_sh/net.lua#L512","returns":[{"type":"boolean","value":"boolean Whether we're currently reading data from a stream","description":"Whether we're currently reading data from a stream"}],"realm":"shared","class":"function","name":"isStreaming","description":" Returns whether or not the library is currently reading data from a stream"},"writeType":{"path":"libs_sh/net.lua#L147","realm":"shared","params":[{"type":"any","value":"any v The object to write","name":"v","description":"The object to write"}],"class":"function","name":"writeType","description":" Writes an object to a net message automatically typing it"},"writeBool":{"path":"libs_sh/net.lua#L339","realm":"shared","params":[{"type":"boolean","value":"boolean t The bit to be written.","name":"t","description":"The bit to be written."}],"class":"function","name":"writeBool","description":" Writes a boolean to the net message"},"writeMatrix":{"path":"libs_sh/net.lua#L427","realm":"shared","params":[{"type":"VMatrix","value":"VMatrix t The matrix to be written","name":"t","description":"The matrix to be written"}],"class":"function","name":"writeMatrix","description":" Writes an matrix to the net message"}},"tables":[],"path":"libs_sh/net.lua#L35","libtbl":["net_library"],"realm":"shared","fields":[],"class":"library","name":"net","description":" Net message library. Used for sending data from the server to the client and back"},"convar":{"methods":{"exists":{"path":"libs_cl/convar.lua#L29","returns":[{"type":"boolean","value":"boolean True if exists","description":"True if exists"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"}],"class":"function","name":"exists","description":" Check if the given ConVar exists"},"hasFlag":{"path":"libs_cl/convar.lua#L97","returns":[{"type":"boolean","value":"boolean Whether the flag is set","description":"Whether the flag is set"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"},{"type":"number","value":"number flag Convar Flag, see https://wiki.facepunch.com/gmod/Enums/FCVAR","name":"flag","description":"Convar Flag, see https://wiki.facepunch.com/gmod/Enums/FCVAR"}],"class":"function","name":"hasFlag","description":" Returns true if a given FCVAR flag is set for this ConVar."},"getInt":{"path":"libs_cl/convar.lua#L67","returns":[{"type":"number","value":"number The integer value or 0 if converting fails","description":"The integer value or 0 if converting fails"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"}],"class":"function","name":"getInt","description":" Returns value of the ConVar as a whole number.\n Floats values will be floored."},"getMax":{"path":"libs_cl/convar.lua#L52","returns":[{"type":"number?","value":"number? The maximum value or nil if not specified","description":"The maximum value or nil if not specified"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"}],"class":"function","name":"getMax","description":" Returns the maximum value of the convar"},"getString":{"path":"libs_cl/convar.lua#L82","returns":[{"type":"string","value":"string Value as a string","description":"Value as a string"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"}],"class":"function","name":"getString","description":" Returns value of the ConVar as a string."},"getFlags":{"path":"libs_cl/convar.lua#L89","returns":[{"type":"number","value":"number Number consisting of flag values","description":"Number consisting of flag values"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"}],"class":"function","name":"getFlags","description":" Returns FCVAR flags of the given ConVar.\n https://wiki.facepunch.com/gmod/Enums/FCVAR"},"getMin":{"path":"libs_cl/convar.lua#L45","returns":[{"type":"number","value":"number The minimum value or nil if not specified","description":"The minimum value or nil if not specified"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"}],"class":"function","name":"getMin","description":" Returns the minimum value of the convar"},"getDefault":{"path":"libs_cl/convar.lua#L38","returns":[{"type":"string","value":"string Default value as a string","description":"Default value as a string"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"}],"class":"function","name":"getDefault","description":" Returns default value of the ConVar"},"getFloat":{"path":"libs_cl/convar.lua#L75","returns":[{"type":"number","value":"number The float value or 0 if converting fails","description":"The float value or 0 if converting fails"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"}],"class":"function","name":"getFloat","description":" Returns value of the ConVar as a floating-point number."},"getBool":{"path":"libs_cl/convar.lua#L59","returns":[{"type":"boolean","value":"boolean The boolean value","description":"The boolean value"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"}],"class":"function","name":"getBool","description":" Returns value of the ConVar as a boolean.\n True for numeric ConVars with the value of 1, false otherwise."}},"tables":[],"path":"libs_cl/convar.lua#L7","libtbl":["convar_library"],"realm":"client","fields":[],"class":"library","name":"convar","description":" ConVar library https://wiki.facepunch.com/gmod/ConVar"},"vr":{"methods":{"getHMDAng":{"path":"libs_sh/vr.lua#L98","returns":[{"type":"Angle","value":"Angle HMD Angles","description":"HMD Angles"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to get the HMD angles from","name":"target","description":"Player to get the HMD angles from"}],"class":"function","name":"getHMDAng","description":" Returns the Head Mounted Device angles"},"isPlayerInVR":{"path":"libs_sh/vr.lua#L75","returns":[{"type":"boolean","value":"boolean True if player is in VR","description":"True if player is in VR"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to check","name":"target","description":"Player to check"}],"class":"function","name":"isPlayerInVR","description":" Checks whether the player is in VR"},"getHMDVelocities":{"path":"libs_sh/vr.lua#L199","returns":[{"type":"Vector","value":"Vector Velocity","description":"Velocity"},{"type":"Vector","value":"Vector Angular velocity","description":"Angular velocity"}],"realm":"client","class":"function","name":"getHMDVelocities","description":" Returns the HMD velocities, position and angular"},"getOrigin":{"path":"libs_sh/vr.lua#L281","returns":[{"type":"Vector","value":"Vector Position","description":"Position"},{"type":"Angle","value":"Angle Angles","description":"Angles"}],"realm":"client","class":"function","name":"getOrigin","description":" Returns the playspace position and angles"},"getHMDPos":{"path":"libs_sh/vr.lua#L91","returns":[{"type":"Vector","value":"Vector HMD Position","description":"HMD Position"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to get the HMD position from","name":"target","description":"Player to get the HMD position from"}],"class":"function","name":"getHMDPos","description":" Returns the Head Mounted Device position"},"getHMDVelocity":{"path":"libs_sh/vr.lua#L185","returns":[{"type":"Vector","value":"Vector HMD Velocity","description":"HMD Velocity"}],"realm":"client","class":"function","name":"getHMDVelocity","description":" Returns the HMD velocity"},"getRightEyePos":{"path":"libs_sh/vr.lua#L306","returns":[{"type":"Vector","value":"Vector Position","description":"Position"}],"realm":"client","class":"function","name":"getRightEyePos","description":" Returns position of the right eye"},"getHMDPose":{"path":"libs_sh/vr.lua#L105","returns":[{"type":"Vector","value":"Vector HMD Position","description":"HMD Position"},{"type":"Angle","value":"Angle HMD Angles","description":"HMD Angles"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to get the HMD pose from","name":"target","description":"Player to get the HMD pose from"}],"class":"function","name":"getHMDPose","description":" Returns the HMD pose"},"getLeftEyePos":{"path":"libs_sh/vr.lua#L299","returns":[{"type":"Vector","value":"Vector Position","description":"Position"}],"realm":"client","class":"function","name":"getLeftEyePos","description":" Returns position of the left eye"},"getEyePos":{"path":"libs_sh/vr.lua#L292","returns":[{"type":"Vector","value":"Vector Position","description":"Position"}],"realm":"client","class":"function","name":"getEyePos","description":" Returns position of the eye that is currently being used for rendering."},"getLeftHandPos":{"path":"libs_sh/vr.lua#L116","returns":[{"type":"Vector","value":"Vector Position","description":"Position"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to get the left hand position from","name":"target","description":"Player to get the left hand position from"}],"class":"function","name":"getLeftHandPos","description":" Returns the left hand position"},"getOriginPos":{"path":"libs_sh/vr.lua#L267","returns":[{"type":"Vector","value":"Vector Position","description":"Position"}],"realm":"client","class":"function","name":"getOriginPos","description":" Returns the playspace position"},"getLeftHandVelocities":{"path":"libs_sh/vr.lua#L224","returns":[{"type":"Vector","value":"Vector Velocity","description":"Velocity"},{"type":"Vector","value":"Vector Angular velocity","description":"Angular velocity"}],"realm":"client","class":"function","name":"getLeftHandVelocities","description":" Returns the left hand velocities, position and angular"},"getRightHandAng":{"path":"libs_sh/vr.lua#L148","returns":[{"type":"Angle","value":"Angle Angles","description":"Angles"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to get the right hand angles from","name":"target","description":"Player to get the right hand angles from"}],"class":"function","name":"getRightHandAng","description":" Returns the left hand angles"},"getLeftHandAng":{"path":"libs_sh/vr.lua#L123","returns":[{"type":"Angle","value":"Angle Angles","description":"Angles"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to get the left hand angles from","name":"target","description":"Player to get the left hand angles from"}],"class":"function","name":"getLeftHandAng","description":" Returns the left hand angles"},"usingEmptyHands":{"path":"libs_sh/vr.lua#L82","returns":[{"type":"boolean","value":"boolean True if player is using empty hands","description":"True if player is using empty hands"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to check","name":"target","description":"Player to check"}],"class":"function","name":"usingEmptyHands","description":" Checks whether the player is using empty hands"},"getRightHandAngularVelocity":{"path":"libs_sh/vr.lua#L242","returns":[{"type":"Vector","value":"Vector Angular velocity","description":"Angular velocity"}],"realm":"client","class":"function","name":"getRightHandAngularVelocity","description":" Returns the right hand angular velocity"},"getLeftHandPose":{"path":"libs_sh/vr.lua#L130","returns":[{"type":"Vector","value":"Vector Position","description":"Position"},{"type":"Angle","value":"Angle Angles","description":"Angles"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to get the left hand pose from","name":"target","description":"Player to get the left hand pose from"}],"class":"function","name":"getLeftHandPose","description":" Returns the left hand pose"},"getRightHandVelocity":{"path":"libs_sh/vr.lua#L235","returns":[{"type":"Vector","value":"Vector Velocity","description":"Velocity"}],"realm":"client","class":"function","name":"getRightHandVelocity","description":" Returns the right hand velocity"},"getRightHandPose":{"path":"libs_sh/vr.lua#L155","returns":[{"type":"Vector","value":"Vector Position","description":"Position"},{"type":"Angle","value":"Angle Angles","description":"Angles"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to get the right hand pose from","name":"target","description":"Player to get the right hand pose from"}],"class":"function","name":"getRightHandPose","description":" Returns the left hand pose"},"getRightHandVelocities":{"path":"libs_sh/vr.lua#L249","returns":[{"type":"Vector","value":"Vector Velocity","description":"Velocity"},{"type":"Vector","value":"Vector Angular velocity","description":"Angular velocity"}],"realm":"client","class":"function","name":"getRightHandVelocities","description":" Returns the right hand velocities, position and angular"},"getLeftHandAngularVelocity":{"path":"libs_sh/vr.lua#L217","returns":[{"type":"Vector","value":"Vector Angular velocity","description":"Angular velocity"}],"realm":"client","class":"function","name":"getLeftHandAngularVelocity","description":" Returns the left hand angular velocity"},"getInput":{"path":"libs_sh/vr.lua#L166","returns":[{"type":"boolean|Vector|number","value":"boolean|Vector|number Boolean, Vector or Number of input","description":"Boolean, Vector or Number of input"}],"realm":"client","params":[{"type":"string","value":"string actionname ActionName to check control of, see the VR enums","name":"actionname","description":"ActionName to check control of, see the VR enums"}],"class":"function","name":"getInput","description":" Returns the a controller's input state, may return boolean, number or vector."},"getRightHandPos":{"path":"libs_sh/vr.lua#L141","returns":[{"type":"Vector","value":"Vector Position","description":"Position"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to get the right hand position from","name":"target","description":"Player to get the right hand position from"}],"class":"function","name":"getRightHandPos","description":" Returns the right hand position"},"getHMDAngularVelocity":{"path":"libs_sh/vr.lua#L192","returns":[{"type":"Vector","value":"Vector Angular velocity","description":"Angular velocity"}],"realm":"client","class":"function","name":"getHMDAngularVelocity","description":" Returns the HMD angular velocity"},"getLeftHandVelocity":{"path":"libs_sh/vr.lua#L210","returns":[{"type":"Vector","value":"Vector Velocity","description":"Velocity"}],"realm":"client","class":"function","name":"getLeftHandVelocity","description":" Returns the left hand velocity"},"getOriginAng":{"path":"libs_sh/vr.lua#L274","returns":[{"type":"Angle","value":"Angle Angles","description":"Angles"}],"realm":"client","class":"function","name":"getOriginAng","description":" Returns the playspace angles"}},"tables":{"VR":{"path":"libs_sh/enum.lua#L1054","fields":[{"name":"BOOLEAN_PRIMARYFIRE","description":""},{"name":"VECTOR1_PRIMARYFIRE","description":""},{"name":"BOOLEAN_SECONDARYFIRE","description":""},{"name":"BOOLEAN_CHANGEWEAPON","description":""},{"name":"BOOLEAN_USE","description":""},{"name":"BOOLEAN_SPAWNMENU","description":""},{"name":"VECTOR2_WALKDIRECTION","description":""},{"name":"BOOLEAN_WALK","description":""},{"name":"BOOLEAN_FLASHLIGHT","description":""},{"name":"BOOLEAN_TURNLEFT","description":""},{"name":"BOOLEAN_TURNRIGHT","description":""},{"name":"VECTOR2_SMOOTHTURN","description":""},{"name":"BOOLEAN_CHAT","description":""},{"name":"BOOLEAN_RELOAD","description":""},{"name":"BOOLEAN_JUMP","description":""},{"name":"BOOLEAN_LEFT_PICKUP","description":""},{"name":"BOOLEAN_RIGHT_PICKUP","description":""},{"name":"BOOLEAN_UNDO","description":""},{"name":"BOOLEAN_SPRINT","description":""},{"name":"VECTOR1_FORWARD","description":""},{"name":"VECTOR1_REVERSE","description":""},{"name":"BOOLEAN_TURBO","description":""},{"name":"VECTOR2_STEER","description":""},{"name":"BOOLEAN_HANDBRAKE","description":""},{"name":"BOOLEAN_EXIT","description":""},{"name":"BOOLEAN_TURRET","description":""}],"realm":"shared","class":"table","name":"VR","description":" VRmod library enums"}},"path":"libs_sh/vr.lua#L5","libtbl":["vr_library"],"realm":"shared","fields":[],"class":"library","name":"vr","description":" VRMod Library\n Addon and module: https://steamcommunity.com/sharedfiles/filedetails/?id=1678408548\n Follow install instructions on the addon's page."},"input":{"methods":{"isControlLocked":{"path":"libs_sh/input.lua#L366","returns":[{"type":"boolean","value":"boolean Whether the player's control is locked","description":"Whether the player's control is locked"}],"realm":"client","class":"function","name":"isControlLocked","description":" Gets whether the player's control is currently locked"},"isKeyDown":{"path":"libs_sh/input.lua#L233","returns":[{"type":"boolean","value":"boolean True if the key is down","description":"True if the key is down"}],"realm":"client","params":[{"type":"number","value":"number key The key id, see input","name":"key","description":"The key id, see input"}],"class":"function","name":"isKeyDown","description":" Gets whether a key is down"},"getCursorPos":{"path":"libs_sh/input.lua#L288","returns":[{"type":"number","value":"number The x position of the mouse","description":"The x position of the mouse"},{"type":"number","value":"number The y position of the mouse","description":"The y position of the mouse"}],"realm":"client","class":"function","name":"getCursorPos","description":" Gets the position of the mouse"},"enableCursor":{"path":"libs_sh/input.lua#L319","realm":"client","params":[{"type":"boolean","value":"boolean enabled Whether or not the cursor should be enabled","name":"enabled","description":"Whether or not the cursor should be enabled"}],"class":"function","name":"enableCursor","description":" Sets the state of the mouse cursor"},"lookupKeyBinding":{"path":"libs_sh/input.lua#L223","returns":[{"type":"string","value":"string The command bound to the key","description":"The command bound to the key"}],"realm":"client","params":[{"type":"number","value":"number key The key id, see input","name":"key","description":"The key id, see input"}],"class":"function","name":"lookupKeyBinding","description":" Gets the command bound to a key"},"lockControls":{"path":"libs_sh/input.lua#L344","realm":"client","params":[{"type":"boolean","value":"boolean enabled Whether to lock or unlock the controls","name":"enabled","description":"Whether to lock or unlock the controls"}],"class":"function","name":"lockControls","description":" Locks game controls for typing purposes. Alt will unlock the controls. Has a 10 second cooldown."},"screenToVector":{"path":"libs_sh/input.lua#L307","returns":[{"type":"Vector","value":"Vector Aim vector","description":"Aim vector"}],"realm":"client","params":[{"type":"number","value":"number x X coordinate on the screen","name":"x","description":"X coordinate on the screen"},{"type":"number","value":"number y Y coordinate on the screen","name":"y","description":"Y coordinate on the screen"}],"class":"function","name":"screenToVector","description":" Translates position on player's screen to aim vector"},"getKeyName":{"path":"libs_sh/input.lua#L258","returns":[{"type":"string","value":"string The name of the key","description":"The name of the key"}],"realm":"client","params":[{"type":"number","value":"number key The key id, see input","name":"key","description":"The key id, see input"}],"class":"function","name":"getKeyName","description":" Gets the name of a key from the id"},"isShiftDown":{"path":"libs_sh/input.lua#L270","returns":[{"type":"boolean","value":"boolean True if the shift key is down","description":"True if the shift key is down"}],"realm":"client","class":"function","name":"isShiftDown","description":" Gets whether the shift key is down"},"getCursorVisible":{"path":"libs_sh/input.lua#L298","returns":[{"type":"boolean","value":"boolean The cursor's visibility","description":"The cursor's visibility"}],"realm":"client","class":"function","name":"getCursorVisible","description":" Gets whether the cursor is visible on the screen"},"canLockControls":{"path":"libs_sh/input.lua#L373","returns":[{"type":"boolean","value":"boolean Whether the player's control can be locked","description":"Whether the player's control can be locked"}],"realm":"client","class":"function","name":"canLockControls","description":" Gets whether the player's control can be locked"},"isMouseDown":{"path":"libs_sh/input.lua#L246","returns":[{"type":"boolean","value":"boolean True if the key is down","description":"True if the key is down"}],"realm":"client","params":[{"type":"number","value":"number key The mouse button id, see input","name":"key","description":"The mouse button id, see input"}],"class":"function","name":"isMouseDown","description":" Gets whether a mouse button is down"},"selectWeapon":{"path":"libs_sh/input.lua#L334","realm":"client","params":[{"type":"Weapon","value":"Weapon weapon The weapon entity to select","name":"weapon","description":"The weapon entity to select"}],"class":"function","name":"selectWeapon","description":" Makes the local player select a weapon"},"isControlDown":{"path":"libs_sh/input.lua#L279","returns":[{"type":"boolean","value":"boolean True if the control key is down","description":"True if the control key is down"}],"realm":"client","class":"function","name":"isControlDown","description":" Gets whether the control key is down"},"lookupBinding":{"path":"libs_sh/input.lua#L205","returns":[{"type":"number","value":"number The id of the first key bound","description":"The id of the first key bound"},{"type":"string","value":"string The name of the first key bound","description":"The name of the first key bound"}],"realm":"client","params":[{"type":"string","value":"string binding The name of the bind","name":"binding","description":"The name of the bind"}],"class":"function","name":"lookupBinding","description":" Gets the first key that is bound to the command passed"}},"tables":[],"path":"libs_sh/input.lua#L168","libtbl":["input_library"],"realm":"shared","fields":[],"class":"library","name":"input","description":" Input library."},"table":{"methods":{"maxn":{"path":"libs_sh/table.lua#L141","returns":[{"type":"number","value":"number The highest numerical key","description":"The highest numerical key"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to search","name":"tbl","description":"The table to search"}],"class":"function","name":"maxn","description":" Returns the highest numerical key."},"hasValue":{"path":"libs_sh/table.lua#L87","returns":[{"type":"boolean","value":"boolean Returns true if the table has that value, false otherwise","description":"Returns true if the table has that value, false otherwise"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to check","name":"tbl","description":"Table to check"},{"type":"any","value":"any val Value to search for","name":"val","description":"Value to search for"}],"class":"function","name":"hasValue","description":" Checks if a table has a value. This function is very inefficient for large tables (O(n))."},"collapseKeyValue":{"path":"libs_sh/table.lua#L36","returns":[{"type":"table","value":"table Output table","description":"Output table"}],"realm":"shared","params":[{"type":"table","value":"table tbl The input table","name":"tbl","description":"The input table"}],"class":"function","name":"collapseKeyValue","description":" Collapses a table with keyvalue structure"},"merge":{"path":"libs_sh/table.lua#L241","returns":[{"type":"table","value":"table Destination table","description":"Destination table"}],"realm":"shared","params":[{"type":"table","value":"table dest The table you want the source table to merge with","name":"dest","description":"The table you want the source table to merge with"},{"type":"table","value":"table source The table you want to merge with the destination table","name":"source","description":"The table you want to merge with the destination table"}],"class":"function","name":"merge","description":" Merges the contents of the second table with the content in the first one."},"reverse":{"path":"libs_sh/table.lua#L168","returns":[{"type":"table","value":"table A reversed copy of the table","description":"A reversed copy of the table"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to reverse","name":"tbl","description":"Table to reverse"}],"class":"function","name":"reverse","description":" Returns a reversed copy of a sequential table. Any non-sequential and non-numeric keyvalue pairs will not be copied"},"isSequential":{"path":"libs_sh/table.lua#L115","returns":[{"type":"boolean","value":"boolean True if sequential","description":"True if sequential"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to check","name":"tbl","description":"Table to check"}],"class":"function","name":"isSequential","description":" Returns whether or not the table's keys are sequential."},"inherit":{"path":"libs_sh/table.lua#L100","returns":[{"type":"table","value":"table The target table","description":"The target table"}],"realm":"shared","params":[{"type":"table","value":"table target Table to copy data to","name":"target","description":"Table to copy data to"},{"type":"table","value":"table base Table to copy data from","name":"base","description":"Table to copy data from"}],"class":"function","name":"inherit","description":" Copies any missing data from base to target, and sets the target's BaseClass member to the base table's pointer."},"toString":{"path":"libs_sh/table.lua#L207","realm":"shared","params":[{"type":"table","value":"table tbl The table to iterate over","name":"tbl","description":"The table to iterate over"},{"type":"string?","value":"string? displayName Optional name for the table","name":"displayName","description":"Optional name for the table"},{"type":"boolean?","value":"boolean? niceFormatting Optional, adds new lines and tabs to the string. Defaults to false","name":"niceFormatting","description":"Optional, adds new lines and tabs to the string. Defaults to false"}],"class":"function","name":"toString","description":" Converts a table into a string"},"sortDesc":{"path":"libs_sh/table.lua#L201","returns":[{"type":"table","value":"table Sorted table","description":"Sorted table"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to sort in descending order","name":"tbl","description":"The table to sort in descending order"}],"class":"function","name":"sortDesc","description":" Sorts a table in reverse order from table.sort"},"getWinningKey":{"path":"libs_sh/table.lua#L81","returns":[{"type":"any","value":"any Winning key","description":"Winning key"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to search in","name":"tbl","description":"The table to search in"}],"class":"function","name":"getWinningKey","description":" Returns a key of the supplied table with the highest number value."},"sortByKey":{"path":"libs_sh/table.lua#L188","realm":"shared","params":[{"type":"table","value":"table tbl Table to sort. All values of this table must be of same type","name":"tbl","description":"Table to sort. All values of this table must be of same type"},{"type":"boolean?","value":"boolean? descending Optional, should the order be descending? Defaults to false","name":"descending","description":"Optional, should the order be descending? Defaults to false"}],"class":"function","name":"sortByKey","description":" Returns a list of keys sorted based on values of those keys."},"copyFromTo":{"path":"libs_sh/table.lua#L51","realm":"shared","params":[{"type":"table","value":"table source The table to copy from","name":"source","description":"The table to copy from"},{"type":"table","value":"table target The table to write to","name":"target","description":"The table to write to"}],"class":"function","name":"copyFromTo","description":" Empties the target table, and merges all values from the source table into it."},"getKeys":{"path":"libs_sh/table.lua#L75","returns":[{"type":"table","value":"table Table of keys","description":"Table of keys"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to get keys of","name":"tbl","description":"The table to get keys of"}],"class":"function","name":"getKeys","description":" Returns all keys of a table"},"add":{"path":"libs_sh/table.lua#L14","returns":[{"type":"table","value":"table The target table","description":"The target table"}],"realm":"shared","params":[{"type":"table","value":"table target The table to insert the new values into","name":"target","description":"The table to insert the new values into"},{"type":"table","value":"table source The table to retrieve the values from","name":"source","description":"The table to retrieve the values from"}],"class":"function","name":"add","description":" Adds the contents from one table into another. The target table will be modified."},"sort":{"path":"libs_sh/table.lua#L179","realm":"shared","params":[{"type":"table","value":"table tbl The table to sort","name":"tbl","description":"The table to sort"},{"type":"function?","value":"function? sorter If specified, the function will be called with 2 parameters each. Return true in this function if you want the first parameter to come first in the sorted array","name":"sorter","description":"If specified, the function will be called with 2 parameters each. Return true in this function if you want the first parameter to come first in the sorted array"}],"class":"function","name":"sort","description":" Sorts a table either ascending or by the given sort function"},"insert":{"path":"libs_sh/table.lua#L107","returns":[{"type":"number","value":"number The index the variable was placed at.","description":"The index the variable was placed at."}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to insert the variable into","name":"tbl","description":"The table to insert the variable into"},{"type":"any","value":"any pos The position in the table to insert the variable. If the third argument is not provided, this argument becomes the value to insert at the end of given table","name":"pos","description":"The position in the table to insert the variable. If the third argument is not provided, this argument becomes the value to insert at the end of given table"},{"type":"any","value":"any val The variable to insert into the table","name":"val","description":"The variable to insert into the table"}],"class":"function","name":"insert","description":" Inserts a value into a table at the end of the table or at the given position."},"keysFromValue":{"path":"libs_sh/table.lua#L128","returns":[{"type":"table","value":"table Table of keys","description":"Table of keys"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to search","name":"tbl","description":"Table to search"},{"type":"any","value":"any val Value to search for","name":"val","description":"Value to search for"}],"class":"function","name":"keysFromValue","description":" Returns a table of keys containing the supplied value."},"sortByMember":{"path":"libs_sh/table.lua#L194","realm":"shared","params":[{"type":"table","value":"table tbl Table to sort","name":"tbl","description":"Table to sort"},{"type":"any","value":"any member The key used to identify the member","name":"member","description":"The key used to identify the member"},{"type":"boolean?","value":"boolean? ascending Optional, should be ascending? Defaults to false","name":"ascending","description":"Optional, should be ascending? Defaults to false"}],"class":"function","name":"sortByMember","description":" Sorts a table by a named member."},"isEmpty":{"path":"libs_sh/table.lua#L94","returns":[{"type":"boolean","value":"boolean Returns true if the table contains any value, false otherwise","description":"Returns true if the table contains any value, false otherwise"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to check","name":"tbl","description":"Table to check"}],"class":"function","name":"isEmpty","description":" Checks if a table contains any value."},"copy":{"path":"libs_sh/table.lua#L214","returns":[{"type":"table","value":"table A deep copy of the original table","description":"A deep copy of the original table"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to be copied","name":"tbl","description":"The table to be copied"}],"class":"function","name":"copy","description":" Creates a deep copy and returns that copy. This function does NOT copy userdata, such as Vectors and Angles!"},"forceInsert":{"path":"libs_sh/table.lua#L68","returns":[{"type":"table","value":"table The supplied or created table","description":"The supplied or created table"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to insert value in to. If not supplied, will create a table","name":"tbl","description":"Table to insert value in to. If not supplied, will create a table"},{"type":"any","value":"any val Value to insert","name":"val","description":"Value to insert"}],"class":"function","name":"forceInsert","description":" Inserts a value in to the given table even if the table is non-existent"},"removeByValue":{"path":"libs_sh/table.lua#L161","returns":[{"type":"any","value":"any The key at which the value was found, or false if the value was not found","description":"The key at which the value was found, or false if the value was not found"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table that will be searched","name":"tbl","description":"The table that will be searched"},{"type":"any","value":"any val The value to find within the table","name":"val","description":"The value to find within the table"}],"class":"function","name":"removeByValue","description":" Removes the first instance of a given value from the specified table with table.remove, then returns the key that the value was found at"},"shuffle":{"path":"libs_sh/table.lua#L174","realm":"shared","params":[{"type":"table","value":"table tbl Table to shuffle","name":"tbl","description":"Table to shuffle"}],"class":"function","name":"shuffle","description":" Performs an inline Fisher-Yates shuffle on the table in O(n) time"},"empty":{"path":"libs_sh/table.lua#L63","realm":"shared","params":[{"type":"table","value":"table tbl The table to empty","name":"tbl","description":"The table to empty"}],"class":"function","name":"empty","description":" Removes all values from a table"},"address":{"path":"libs_sh/table.lua#L21","returns":[{"type":"string","value":"string The table's string address","description":"The table's string address"}],"realm":"shared","params":[{"type":"table","value":"table target The target to get the address of","name":"target","description":"The target to get the address of"}],"class":"function","name":"address","description":" Returns the string address of the table"},"lowerKeyNames":{"path":"libs_sh/table.lua#L135","returns":[{"type":"table","value":"table New converted table","description":"New converted table"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to convert","name":"tbl","description":"Table to convert"}],"class":"function","name":"lowerKeyNames","description":" Returns a copy of the input table with all string keys converted to be lowercase recursively."},"remove":{"path":"libs_sh/table.lua#L154","returns":[{"type":"any","value":"any The value that was removed","description":"The value that was removed"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to remove the value from","name":"tbl","description":"The table to remove the value from"},{"type":"number?","value":"number? index Optional index of the value to remove. Defaults to #tbl","name":"index","description":"Optional index of the value to remove. Defaults to #tbl"}],"class":"function","name":"remove","description":" Removes a value from a table and shifts any other values down to fill the gap."},"clearKeys":{"path":"libs_sh/table.lua#L29","returns":[{"type":"table","value":"table Table with integer keys","description":"Table with integer keys"}],"realm":"shared","params":[{"type":"table","value":"table tbl The original table to modify","name":"tbl","description":"The original table to modify"},{"type":"boolean?","value":"boolean? saveKeys Optional save the keys within each member table. This will insert a new field __key into each value, and should not be used if the table contains non-table values. Defaults to false","name":"saveKeys","description":"Optional save the keys within each member table. This will insert a new field __key into each value, and should not be used if the table contains non-table values. Defaults to false"}],"class":"function","name":"clearKeys","description":" Changes all keys to sequential integers. This creates a new table object and does not affect the original."},"random":{"path":"libs_sh/table.lua#L147","returns":[{"type":"any","value":"any A random value from the table","description":"A random value from the table"},{"type":"any","value":"any The key associated with the random value","description":"The key associated with the random value"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to choose from","name":"tbl","description":"The table to choose from"}],"class":"function","name":"random","description":" Returns a random value from the supplied table."},"count":{"path":"libs_sh/table.lua#L57","returns":[{"type":"number","value":"number The number of keyvalue pairs","description":"The number of keyvalue pairs"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to count the keys of","name":"tbl","description":"The table to count the keys of"}],"class":"function","name":"count","description":" Counts the amount of keys in a table. This should only be used when a table is not numerically and sequentially indexed, for those table consider # operator"},"concat":{"path":"libs_sh/table.lua#L42","returns":[{"type":"string","value":"string Concatenated string","description":"Concatenated string"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to concatenate","name":"tbl","description":"The table to concatenate"},{"type":"string","value":"string concatenator A seperator to insert between each string","name":"concatenator","description":"A seperator to insert between each string"},{"type":"number?","value":"number? startPos Optional key to start at. Defaults to 1","name":"startPos","description":"Optional key to start at. Defaults to 1"},{"type":"number?","value":"number? endPos Optional key to end at. Defaults to #tbl","name":"endPos","description":"Optional key to end at. Defaults to #tbl"}],"class":"function","name":"concat","description":" Concatenates the contents of a table to a string."},"keyFromValue":{"path":"libs_sh/table.lua#L121","returns":[{"type":"any","value":"any Found key","description":"Found key"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to search","name":"tbl","description":"Table to search"},{"type":"any","value":"any val Value to search for","name":"val","description":"Value to search for"}],"class":"function","name":"keyFromValue","description":" Returns the first key found to be containing the supplied value."}},"tables":[],"path":"libs_sh/table.lua#L4","libtbl":["table_library"],"realm":"shared","fields":[],"class":"library","name":"table","description":" Lua table library https://wiki.garrysmod.com/page/Category:table"},"builtins":{"methods":{"localToWorld":{"path":"libs_sh/builtins.lua#L1158","returns":[{"type":"Vector","value":"Vector worldPos","description":"worldPos"},{"type":"Angle","value":"Angle worldAngles","description":"worldAngles"}],"realm":"shared","params":[{"type":"Vector","value":"Vector localPos The position vector that should be translated to world coordinates","name":"localPos","description":"The position vector that should be translated to world coordinates"},{"type":"Angle","value":"Angle localAng The angle that should be converted to a world angle","name":"localAng","description":"The angle that should be converted to a world angle"},{"type":"Vector","value":"Vector originPos The origin point of the source coordinate system, in world coordinates","name":"originPos","description":"The origin point of the source coordinate system, in world coordinates"},{"type":"Angle","value":"Angle originAngle The angles of the source coordinate system, as a world angle","name":"originAngle","description":"The angles of the source coordinate system, as a world angle"}],"class":"function","name":"localToWorld","description":" Translates the specified position and angle from the specified local coordinate system"},"version":{"path":"libs_sh/builtins.lua#L267","returns":[{"type":"string","value":"string Starfall version","description":"Starfall version"}],"realm":"shared","class":"function","name":"version","description":" Gets the starfall version"},"assert":{"path":"libs_sh/builtins.lua#L1119","realm":"shared","params":[{"type":"any","value":"any expression Anything that will be evaluated to be true or false","name":"expression","description":"Anything that will be evaluated to be true or false"},{"type":"string?","value":"string? msg Error message. Default \"assertion failed!\"","name":"msg","description":"Error message. Default \"assertion failed!\""},{"type":"...","value":"... args Any arguments to return if the assertion is successful","name":"args","description":"Any arguments to return if the assertion is successful"}],"class":"function","name":"assert","description":" If the result of the first argument is false or nil, an error is thrown with the second argument as the message."},"tostring":{"path":"libs_sh/builtins.lua#L100","returns":[{"type":"string","value":"string Object as a string","description":"Object as a string"}],"realm":"shared","params":[{"type":"any","value":"any obj Object to turn into a string","name":"obj","description":"Object to turn into a string"}],"class":"function","name":"tostring","description":" Attempts to convert the value to a string."},"isfunction":{"path":"libs_sh/builtins.lua#L195","returns":[{"type":"boolean","value":"boolean If the object is a function or not","description":"If the object is a function or not"}],"realm":"shared","params":[{"type":"any","value":"any x Input to check","name":"x","description":"Input to check"}],"class":"function","name":"isfunction","description":" Returns if the given input is a function"},"tonumber":{"path":"libs_sh/builtins.lua#L107","returns":[{"type":"number?","value":"number? The object as a number or nil if it couldn't be converted","description":"The object as a number or nil if it couldn't be converted"}],"realm":"shared","params":[{"type":"any","value":"any obj Object to turn into a number","name":"obj","description":"Object to turn into a number"}],"class":"function","name":"tonumber","description":" Attempts to convert the value to a number."},"throw":{"path":"libs_sh/builtins.lua#L1102","realm":"shared","params":[{"type":"string","value":"string msg Message string","name":"msg","description":"Message string"},{"type":"number?","value":"number? level Which level in the stacktrace to blame. Defaults to 1","name":"level","description":"Which level in the stacktrace to blame. Defaults to 1"},{"type":"boolean?","value":"boolean? uncatchable Makes this exception uncatchable","name":"uncatchable","description":"Makes this exception uncatchable"}],"class":"function","name":"throw","description":" Throws an exception"},"rawget":{"path":"libs_sh/builtins.lua#L441","returns":[{"type":"any","value":"any The value of the index","description":"The value of the index"}],"realm":"shared","params":[{"type":"table","value":"table table The table to get the value from","name":"table","description":"The table to get the value from"},{"type":"any","value":"any key The index of the table","name":"key","description":"The index of the table"}],"class":"function","name":"rawget","description":" Gets the value of a table index without invoking a metamethod"},"ramUsed":{"path":"libs_sh/builtins.lua#L249","returns":[{"type":"number","value":"number The ram used in kilobytes","description":"The ram used in kilobytes"}],"realm":"shared","class":"function","name":"ramUsed","description":" Gets the current ram usage of the gmod lua environment"},"Quaternion":{"path":"libs_sh/quaternion.lua#L195","returns":[{"type":"Quaternion","value":"Quaternion Quaternion object","description":"Quaternion object"}],"realm":"shared","params":[{"type":"number?","value":"number? r R (real) component","name":"r","description":"R (real) component"},{"type":"number?","value":"number? i I component","name":"i","description":"I component"},{"type":"number?","value":"number? j J component","name":"j","description":"J component"},{"type":"number?","value":"number? k K component","name":"k","description":"K component"}],"class":"function","name":"Quaternion","description":" Creates a Quaternion"},"isFirstTimePredicted":{"path":"libs_sh/builtins.lua#L229","returns":[{"type":"boolean","value":"boolean Whether this is the first time this hook was predicted","description":"Whether this is the first time this hook was predicted"}],"realm":"shared","class":"function","name":"isFirstTimePredicted","description":" Returns if this is the first time this hook was predicted."},"ipairs":{"path":"libs_sh/builtins.lua#L114","returns":[{"type":"function","value":"function Iterator function","description":"Iterator function"},{"type":"table","value":"table Table being iterated over","description":"Table being iterated over"},{"type":"number","value":"number Origin index. Equals 0.","description":"Origin index. Equals 0."}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to iterate over","name":"tbl","description":"Table to iterate over"}],"class":"function","name":"ipairs","description":" Returns an iterator function for a for loop, to return ordered key-value pairs from a table."},"cpuUsed":{"path":"libs_sh/builtins.lua#L235","returns":[{"type":"number","value":"number Current cpu time used this Think","description":"Current cpu time used this Think"}],"realm":"shared","class":"function","name":"cpuUsed","description":" Returns the current count for this Think's CPU Time.\n This value increases as more executions are done, may not be exactly as you want.\n If used on screens, will show 0 if only rendering is done. Operations must be done in the Think loop for them to be counted."},"print":{"path":"libs_sh/builtins.lua#L530","realm":"shared","params":[{"type":"...","value":"... printArgs Values to print. Colors before text will set the text color","name":"printArgs","description":"Values to print. Colors before text will set the text color"}],"class":"function","name":"print","description":" Prints a message to the player's chat."},"pcall":{"path":"libs_sh/builtins.lua#L1024","returns":[{"type":"boolean","value":"boolean If the function had no errors occur within it.","description":"If the function had no errors occur within it."},{"type":"...","value":"... If an error occurred, this will be a string containing the error message. Otherwise, this will be the return values of the function passed in.","description":"If an error occurred, this will be a string containing the error message. Otherwise, this will be the return values of the function passed in."}],"realm":"shared","params":[{"type":"function","value":"function func Function to be executed and of which the errors should be caught of","name":"func","description":"Function to be executed and of which the errors should be caught of"},{"type":"...","value":"... arguments Arguments to call the function with.","name":"arguments","description":"Arguments to call the function with."}],"class":"function","name":"pcall","description":" Lua's pcall with SF throw implementation\n Calls a function and catches an error that can be thrown while the execution of the call."},"getScript":{"path":"libs_sh/builtins.lua#L716","returns":[{"type":"string?","value":"string? Source code, or nil if could not be found","description":"Source code, or nil if could not be found"},{"type":"function?","value":"function? Compiled function, or nil if could not be found","description":"Compiled function, or nil if could not be found"}],"realm":"shared","params":[{"type":"string","value":"string path Path of file. Can be absolute or relative to calling file. Must be '--@include'-ed.","name":"path","description":"Path of file. Can be absolute or relative to calling file. Must be '--@include'-ed."}],"class":"function","name":"getScript","description":" Returns the source code of and compiled function for specified script."},"isValid":{"path":"libs_sh/builtins.lua#L1127","returns":[{"type":"boolean","value":"boolean If it is valid","description":"If it is valid"}],"realm":"shared","params":[{"type":"any","value":"any object Table to check","name":"object","description":"Table to check"}],"class":"function","name":"isValid","description":" Returns if the table has an isValid function and isValid returns true."},"getScripts":{"path":"libs_sh/builtins.lua#L727","returns":[{"type":"table","value":"table Table where keys are paths and values are strings","description":"Table where keys are paths and values are strings"},{"type":"table?","value":"table? Table where keys are paths and values are functions, or nil if another chip was specified","description":"Table where keys are paths and values are functions, or nil if another chip was specified"}],"realm":"shared","params":[{"type":"Entity?","value":"Entity? ent Optional target entity. Default: chip()","name":"ent","description":"Optional target entity. Default: chip()"}],"class":"function","name":"getScripts","description":" Returns the source code of and compiled functions for the scripts used by the chip."},"rawset":{"path":"libs_sh/builtins.lua#L432","realm":"shared","params":[{"type":"table","value":"table tbl The table to modify","name":"tbl","description":"The table to modify"},{"type":"any","value":"any key The index of the table","name":"key","description":"The index of the table"},{"type":"any","value":"any value The value to set the index equal to","name":"value","description":"The value to set the index equal to"}],"class":"function","name":"rawset","description":" Set the value of a table index without invoking a metamethod"},"Vector":{"path":"libs_sh/vectors.lua#L43","returns":[{"type":"Vector","value":"Vector Vector","description":"Vector"}],"realm":"shared","params":[{"type":"number?","value":"number? x X value","name":"x","description":"X value"},{"type":"number?","value":"number? y Y value","name":"y","description":"Y value"},{"type":"number?","value":"number? z Z value","name":"z","description":"Z value"}],"class":"function","name":"Vector","description":" Creates a Vector struct."},"setUserdata":{"path":"libs_sh/builtins.lua#L590","realm":"server","params":[{"type":"string","value":"string str String data","name":"str","description":"String data"}],"class":"function","name":"setUserdata","description":" Sets the chip's userdata that the duplicator tool saves. max 1MiB; can be changed with convar sf_userdata_max"},"setClipboardText":{"path":"libs_sh/builtins.lua#L631","realm":"client","params":[{"type":"string","value":"string txt Text to set to the clipboard","name":"txt","description":"Text to set to the clipboard"}],"class":"function","name":"setClipboardText","description":" Sets clipboard text. Only works on the owner of the chip."},"cpuAverage":{"path":"libs_sh/builtins.lua#L243","returns":[{"type":"number","value":"number Average CPU Time of the buffer.","description":"Average CPU Time of the buffer."}],"realm":"shared","class":"function","name":"cpuAverage","description":" Gets the Average CPU Time in the buffer"},"setAuthor":{"path":"libs_sh/builtins.lua#L620","realm":"client","params":[{"type":"string","value":"string author Author to set the chip's author to","name":"author","description":"Author to set the chip's author to"}],"class":"function","name":"setAuthor","description":" Sets the chip's display author"},"next":{"path":"libs_sh/builtins.lua#L141","returns":[{"type":"any","value":"any Key or nil","description":"Key or nil"},{"type":"any","value":"any Value or nil","description":"Value or nil"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to get the next key-value pair of","name":"tbl","description":"Table to get the next key-value pair of"},{"type":"any","value":"any k Previous key (can be nil)","name":"k","description":"Previous key (can be nil)"}],"class":"function","name":"next","description":" Returns the next key and value pair in a table."},"requiredir":{"path":"libs_sh/builtins.lua#L770","returns":[{"type":"table","value":"table Table of return values of the scripts","description":"Table of return values of the scripts"}],"realm":"shared","params":[{"type":"string","value":"string path The directory to include. Make sure to --@includedir it","name":"path","description":"The directory to include. Make sure to --@includedir it"},{"type":"table","value":"table loadpriority Table of files that should be loaded before any others in the directory","name":"loadpriority","description":"Table of files that should be loaded before any others in the directory"}],"class":"function","name":"requiredir","description":" Runs all included scripts in a directory and caches the results.\n The path must be an actual path, including the file extension and using slashes for directory separators instead of periods."},"sendPermissionRequest":{"path":"libs_sh/builtins.lua#L370","realm":"client","class":"function","name":"sendPermissionRequest","description":" Opens the permission request dialogue if the player is connected to HUD. setupPermissionRequest must be called first"},"setName":{"path":"libs_sh/builtins.lua#L609","realm":"client","params":[{"type":"string","value":"string name Name to set the chip's name to","name":"name","description":"Name to set the chip's name to"}],"class":"function","name":"setName","description":" Sets the chip's display name"},"type":{"path":"libs_sh/builtins.lua#L132","returns":[{"type":"string","value":"string The name of the object's type.","description":"The name of the object's type."}],"realm":"shared","params":[{"type":"any","value":"any obj Object to get type of","name":"obj","description":"Object to get type of"}],"class":"function","name":"type","description":" Returns a string representing the name of the type of the passed object."},"eyePos":{"path":"libs_sh/builtins.lua#L701","returns":[{"type":"Vector","value":"Vector The local player's camera position","description":"The local player's camera position"}],"realm":"client","class":"function","name":"eyePos","description":" Returns the local player's camera position"},"isnumber":{"path":"libs_sh/builtins.lua#L167","returns":[{"type":"boolean","value":"boolean If the object is a number or not","description":"If the object is a number or not"}],"realm":"shared","params":[{"type":"any","value":"any x Input to check","name":"x","description":"Input to check"}],"class":"function","name":"isnumber","description":" Returns if the given input is a number"},"Matrix":{"path":"libs_sh/vmatrix.lua#L25","returns":[{"type":"VMatrix","value":"VMatrix New VMatrix","description":"New VMatrix"}],"realm":"shared","params":[{"type":"table|Angle|nil","value":"table|Angle|nil t Optional data or rotation angle to initialize the Matrix with.","name":"t","description":"Optional data or rotation angle to initialize the Matrix with."},{"type":"Vector?","value":"Vector? v Optional translation to initialize the Matrix with.","name":"v","description":"Optional translation to initialize the Matrix with."}],"class":"function","name":"Matrix","description":" Returns a new VMatrix"},"permissionRequestSatisfied":{"path":"libs_sh/builtins.lua#L362","returns":[{"type":"boolean","value":"boolean Whether the client gave all permissions specified in last request or not.","description":"Whether the client gave all permissions specified in last request or not."}],"realm":"client","class":"function","name":"permissionRequestSatisfied","description":" Is permission request fully satisfied."},"shareScripts":{"path":"libs_sh/builtins.lua#L751","realm":"shared","params":[{"type":"boolean","value":"boolean enable If true, allow sharing scripts","name":"enable","description":"If true, allow sharing scripts"}],"class":"function","name":"shareScripts","description":" Sets the chip to allow other chips to view its sources"},"ramAverage":{"path":"libs_sh/builtins.lua#L255","returns":[{"type":"number","value":"number The ram used in kilobytes","description":"The ram used in kilobytes"}],"realm":"shared","class":"function","name":"ramAverage","description":" Gets the moving average of ram usage of the gmod lua environment"},"xpcall":{"path":"libs_sh/builtins.lua#L1053","returns":[{"type":"boolean","value":"boolean Status of the execution; true for success, false for failure.","description":"Status of the execution; true for success, false for failure."},{"type":"...","value":"... The returns of the first function if execution succeeded, otherwise the return values of the error callback.","description":"The returns of the first function if execution succeeded, otherwise the return values of the error callback."}],"realm":"shared","params":[{"type":"function","value":"function func The function to call initially.","name":"func","description":"The function to call initially."},{"type":"function","value":"function callback The function to be called if execution of the first fails; the error message and stack trace are passed.","name":"callback","description":"The function to be called if execution of the first fails; the error message and stack trace are passed."},{"type":"...","value":"... passArgs Varargs to pass to the initial function.","name":"passArgs","description":"Varargs to pass to the initial function."}],"class":"function","name":"xpcall","description":" Lua's xpcall with SF throw implementation, and a traceback for debugging.\n Attempts to call the first function. If the execution succeeds, this returns true followed by the returns of the function.\n If execution fails, this returns false and the second function is called with the error message, and the stack trace."},"isbool":{"path":"libs_sh/builtins.lua#L188","returns":[{"type":"boolean","value":"boolean If the object is a boolean or not","description":"If the object is a boolean or not"}],"realm":"shared","params":[{"type":"any","value":"any x Input to check","name":"x","description":"Input to check"}],"class":"function","name":"isbool","description":" Returns if the given input is a boolean"},"restart":{"path":"libs_sh/builtins.lua#L1197","realm":"shared","params":[{"type":"Entity?","value":"Entity? chip The chip to restart. If nil, it will restart the current chip.","name":"chip","description":"The chip to restart. If nil, it will restart the current chip."}],"class":"function","name":"restart","description":" Restarts a chip owned by yourself.\n Only restarts the realm that this gets called in."},"WebSocket":{"path":"libs_cl/websocket.lua#L112","returns":[{"type":"WebSocket","value":"WebSocket The websocket object. Use WebSocket:connect() to connect.","description":"The websocket object. Use WebSocket:connect() to connect."}],"realm":"client","params":[{"type":"string","value":"string domain Domain of the websocket server.","name":"domain","description":"Domain of the websocket server."},{"type":"number?","value":"number? port Port of the websocket server. (Default 443)","name":"port","description":"Port of the websocket server. (Default 443)"},{"type":"boolean?","value":"boolean? secure Whether to use secure connection (wss). (Default false)","name":"secure","description":"Whether to use secure connection (wss). (Default false)"},{"type":"string?","value":"string? path Optional path of the websocket.","name":"path","description":"Optional path of the websocket."}],"class":"function","name":"WebSocket","description":" Creates a new websocket object.\n Add onMessage, onConnected, onDisconnected functions for callbacks.\n Also see the websocket example."},"class":{"path":"libs_sh/builtins.lua#L1221","realm":"shared","params":[{"type":"string","value":"string name The string name of the class","name":"name","description":"The string name of the class"},{"type":"table?","value":"table? super The (optional) parent class to inherit from","name":"super","description":"The (optional) parent class to inherit from"}],"class":"function","name":"class","description":" Creates a 'middleclass' class object that can be used similarly to Java/C++ classes. See https://github.com/kikito/middleclass for examples."},"enableHud":{"path":"libs_sh/builtins.lua#L1177","realm":"shared","params":[{"type":"Player","value":"Player ply The player to enable the hud on. If CLIENT, will be forced to player()","name":"ply","description":"The player to enable the hud on. If CLIENT, will be forced to player()"},{"type":"boolean","value":"boolean active Whether hud hooks should be active. true to force on, false to force off.","name":"active","description":"Whether hud hooks should be active. true to force on, false to force off."}],"class":"function","name":"enableHud","description":" Sets the current instance to allow HUD drawing. Only works if player is in your vehicle or\n if it's ran on yourself or if the player is connected to your hud and you want to disconnect them"},"chip":{"path":"libs_sh/builtins.lua#L57","returns":[{"type":"Entity","value":"Entity Starfall chip entity","description":"Starfall chip entity"}],"realm":"shared","class":"function","name":"chip","description":" Returns the entity representing a processor that this script is running on."},"worldToLocal":{"path":"libs_sh/builtins.lua#L1139","returns":[{"type":"Vector","value":"Vector localPos","description":"localPos"},{"type":"Angle","value":"Angle localAngles","description":"localAngles"}],"realm":"shared","params":[{"type":"Vector","value":"Vector pos The position that should be translated from the current to the new system","name":"pos","description":"The position that should be translated from the current to the new system"},{"type":"Angle","value":"Angle ang The angles that should be translated from the current to the new system","name":"ang","description":"The angles that should be translated from the current to the new system"},{"type":"Vector","value":"Vector newSystemOrigin The origin of the system to translate to","name":"newSystemOrigin","description":"The origin of the system to translate to"},{"type":"Angle","value":"Angle newSystemAngles The angles of the system to translate to","name":"newSystemAngles","description":"The angles of the system to translate to"}],"class":"function","name":"worldToLocal","description":" Translates the specified position and angle into the specified coordinate system"},"dodir":{"path":"libs_sh/builtins.lua#L825","returns":[{"type":"table","value":"table Table of return values of the scripts","description":"Table of return values of the scripts"}],"realm":"shared","params":[{"type":"string","value":"string path The directory to include. Make sure to --@includedir it","name":"path","description":"The directory to include. Make sure to --@includedir it"},{"type":"table","value":"table loadpriority Table of files that should be loaded before any others in the directory","name":"loadpriority","description":"Table of files that should be loaded before any others in the directory"}],"class":"function","name":"dodir","description":" Runs all included scripts in directory, but does not cache the result."},"error":{"path":"libs_sh/builtins.lua#L1110","realm":"shared","params":[{"type":"string","value":"string msg Message string","name":"msg","description":"Message string"},{"type":"number?","value":"number? level Which level in the stacktrace to blame. Defaults to 1. 0 for no stacktrace.","name":"level","description":"Which level in the stacktrace to blame. Defaults to 1. 0 for no stacktrace."}],"class":"function","name":"error","description":" Throws an error. Similar to 'throw' but throws whatever you want instead of an SF Error."},"try":{"path":"libs_sh/builtins.lua#L1081","realm":"shared","params":[{"type":"function","value":"function func Function to execute","name":"func","description":"Function to execute"},{"type":"function?","value":"function? catch Optional function to execute in case func fails","name":"catch","description":"Optional function to execute in case func fails"}],"class":"function","name":"try","description":" Try to execute a function and catch possible exceptions\n Similar to xpcall, but a bit more in-depth"},"Color":{"path":"libs_sh/color.lua#L64","returns":[{"type":"Color","value":"Color New color","description":"New color"}],"realm":"shared","params":[{"name":"number","description":"|string? r Red component or string hexadecimal color. Defaults to 255."},{"type":"number?","value":"number? g Green component. Defaults to 255.","name":"g","description":"Green component. Defaults to 255."},{"type":"number?","value":"number? b Blue component. Defaults to 255.","name":"b","description":"Blue component. Defaults to 255."},{"type":"number?","value":"number? a Alpha component. Defaults to 255.","name":"a","description":"Alpha component. Defaults to 255."}],"class":"function","name":"Color","description":" Creates a table struct that resembles a Color"},"loadstring":{"path":"libs_sh/builtins.lua#L872","returns":[{"type":"function?","value":"function? Compiled function, or nil if failed to compile","description":"Compiled function, or nil if failed to compile"},{"type":"string?","value":"string? Error string, or nil if successfully compiled","description":"Error string, or nil if successfully compiled"}],"realm":"shared","params":[{"type":"string","value":"string code String to compile","name":"code","description":"String to compile"},{"type":"string?","value":"string? identifier Name of compiled function","name":"identifier","description":"Name of compiled function"},{"type":"table?","value":"table? env Environment of compiled function","name":"env","description":"Environment of compiled function"}],"class":"function","name":"loadstring","description":" Like Lua 5.2 or LuaJIT's load/loadstring, except it has no mode parameter and, of course, the resulting function is in your instance's environment by default.\n For compatibility with older versions of Starfall, loadstring is NOT an alias of this function like it is in vanilla Lua 5.2/LuaJIT."},"getMethods":{"path":"libs_sh/builtins.lua#L944","returns":[{"type":"table","value":"table Table of the type's methods which can be edited or iterated","description":"Table of the type's methods which can be edited or iterated"}],"realm":"shared","params":[{"type":"string","value":"string sfType Name of SF type","name":"sfType","description":"Name of SF type"}],"class":"function","name":"getMethods","description":" Gets an SF type's methods table"},"Angle":{"path":"libs_sh/angles.lua#L33","returns":[{"type":"Angle","value":"Angle Angle struct","description":"Angle struct"}],"realm":"shared","params":[{"type":"number?","value":"number? p Pitch","name":"p","description":"Pitch"},{"type":"number?","value":"number? y Yaw","name":"y","description":"Yaw"},{"type":"number?","value":"number? r Roll","name":"r","description":"Roll"}],"class":"function","name":"Angle","description":" Creates an Angle struct."},"concmd":{"path":"libs_sh/builtins.lua#L579","realm":"shared","params":[{"type":"string","value":"string cmd Command to execute","name":"cmd","description":"Command to execute"}],"class":"function","name":"concmd","description":" Execute a console command"},"getfenv":{"path":"libs_sh/builtins.lua#L925","returns":[{"type":"table?","value":"table? Environment table (or nil, if restricted)","description":"Environment table (or nil, if restricted)"}],"realm":"shared","params":[{"type":"function|number","value":"function|number funcOrStackLevel Function or stack level to get the environment of","name":"funcOrStackLevel","description":"Function or stack level to get the environment of"}],"class":"function","name":"getfenv","description":" Lua's getfenv\n Returns the environment of either the stack level or the function specified.\n Note that this function will return nil if the return value would be anything other than builtins_library or an environment you have passed to setfenv."},"eyeVector":{"path":"libs_sh/builtins.lua#L708","returns":[{"type":"Vector","value":"Vector The local player's camera forward vector","description":"The local player's camera forward vector"}],"realm":"client","class":"function","name":"eyeVector","description":" Returns the local player's camera forward vector"},"setfenv":{"path":"libs_sh/builtins.lua#L904","returns":[{"type":"function","value":"function Function with environment set to tbl","description":"Function with environment set to tbl"}],"realm":"shared","params":[{"type":"function|number","value":"function|number funcOrStackLevel Function or stack level to set the environment of","name":"funcOrStackLevel","description":"Function or stack level to set the environment of"},{"type":"table","value":"table tbl New environment","name":"tbl","description":"New environment"}],"class":"function","name":"setfenv","description":" Lua's setfenv\n Sets the environment of either the stack level or the function specified.\n Note that this function will throw an error if you try to use it on anything outside of your sandbox."},"pairs":{"path":"libs_sh/builtins.lua#L123","returns":[{"type":"function","value":"function Iterator function","description":"Iterator function"},{"type":"table","value":"table Table being iterated over","description":"Table being iterated over"},{"type":"any","value":"any Nil as current index (for the constructor)","description":"Nil as current index (for the constructor)"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to iterate over","name":"tbl","description":"Table to iterate over"}],"class":"function","name":"pairs","description":" Returns an iterator function for a for loop that will return the values of the specified table in an arbitrary order."},"getLibraries":{"path":"libs_sh/builtins.lua#L426","returns":[{"type":"table","value":"table Table where each key is the library name and value is table of the library","description":"Table where each key is the library name and value is table of the library"}],"realm":"shared","class":"function","name":"getLibraries","description":" Gets all libraries"},"printHud":{"path":"libs_sh/builtins.lua#L552","realm":"shared","params":[{"type":"Player","value":"Player ply The target player. If in CLIENT, then ply is the client player and this param is omitted","name":"ply","description":"The target player. If in CLIENT, then ply is the client player and this param is omitted"},{"type":"...","value":"... printArgs Values to print. Colors before text will set the text color","name":"printArgs","description":"Values to print. Colors before text will set the text color"}],"class":"function","name":"printHud","description":" Prints a message to a target player's chat as long as they're connected to a hud."},"isstring":{"path":"libs_sh/builtins.lua#L174","returns":[{"type":"boolean","value":"boolean If the object is a string or not","description":"If the object is a string or not"}],"realm":"shared","params":[{"type":"any","value":"any x Input to check","name":"x","description":"Input to check"}],"class":"function","name":"isstring","description":" Returns if the given input is a string"},"player":{"path":"libs_sh/builtins.lua#L70","returns":[{"type":"Player","value":"Player Returns player with given UserID or if none specified then returns either the owner (server) or the local player (client)","description":"Returns player with given UserID or if none specified then returns either the owner (server) or the local player (client)"}],"realm":"shared","params":[{"type":"number?","value":"number? num UserID to get the player with.","name":"num","description":"UserID to get the player with."}],"class":"function","name":"player","description":" Same as owner() on the server. On the client, returns the local player"},"crc":{"path":"libs_sh/builtins.lua#L212","returns":[{"type":"string","value":"string The unsigned 32 bit checksum as a string","description":"The unsigned 32 bit checksum as a string"}],"realm":"shared","params":[{"type":"string","value":"string stringToHash The string to calculate the checksum of","name":"stringToHash","description":"The string to calculate the checksum of"}],"class":"function","name":"crc","description":" Generates the CRC checksum of the specified string. (https://en.wikipedia.org/wiki/Cyclic_redundancy_check)"},"cpuMax":{"path":"libs_sh/builtins.lua#L297","returns":[{"type":"number","value":"number Max SysTime allowed to take for execution of the chip in a Think.","description":"Max SysTime allowed to take for execution of the chip in a Think."}],"realm":"shared","class":"function","name":"cpuMax","description":" Gets the CPU Time max.\n CPU Time is stored in a buffer of N elements, if the average of this exceeds cpuMax, the chip will error."},"dofile":{"path":"libs_sh/builtins.lua#L812","returns":[{"type":"...","value":"... Return value(s) of the script","description":"Return value(s) of the script"}],"realm":"shared","params":[{"type":"string","value":"string path The file path to include. Make sure to --@include it","name":"path","description":"The file path to include. Make sure to --@include it"}],"class":"function","name":"dofile","description":" Runs an included script, but does not cache the result.\n Pretty much like standard Lua dofile()"},"printConsole":{"path":"libs_sh/builtins.lua#L543","realm":"shared","params":[{"type":"...","value":"... printArgs Values to print. Colors before text will set the text color","name":"printArgs","description":"Values to print. Colors before text will set the text color"}],"class":"function","name":"printConsole","description":" Prints a message to the player's console."},"printTable":{"path":"libs_sh/builtins.lua#L572","realm":"shared","params":[{"type":"table","value":"table tbl Table to print","name":"tbl","description":"Table to print"}],"class":"function","name":"printTable","description":" Prints a table to player's chat"},"getmetatable":{"path":"libs_sh/builtins.lua#L202","returns":[{"type":"table?","value":"table? The metatable of tbl","description":"The metatable of tbl"}],"realm":"shared","params":[{"type":"any","value":"any tbl Table to get metatable of","name":"tbl","description":"Table to get metatable of"}],"class":"function","name":"getmetatable","description":" Returns the metatable of an object or nil.\n Doesn't work on most internal metatables.\n For any types other than table, nil will be returned."},"ramMax":{"path":"libs_sh/builtins.lua#L261","returns":[{"type":"number","value":"number The max ram usage in kilobytes","description":"The max ram usage in kilobytes"}],"realm":"shared","class":"function","name":"ramMax","description":" Gets the max allowed ram usage of the gmod lua environment"},"unpack":{"path":"libs_sh/builtins.lua#L150","returns":[{"type":"...","value":"... Elements of tbl","description":"Elements of tbl"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to get elements out of","name":"tbl","description":"Table to get elements out of"},{"type":"number?","value":"number? startIndex Which index to start from (default 1)","name":"startIndex","description":"Which index to start from (default 1)"},{"type":"number?","value":"number? endIndex Which index to end at (default #tbl)","name":"endIndex","description":"Which index to end at (default #tbl)"}],"class":"function","name":"unpack","description":" This function takes a numeric indexed table and return all the members as a vararg."},"Vector2":{"path":"libs_sv/wire.lua#L163","returns":[{"type":"Vector2","value":"Vector2 Vector2","description":"Vector2"}],"realm":"server","params":[{"type":"number?","value":"number? x X value","name":"x","description":"X value"},{"type":"number?","value":"number? y Y value","name":"y","description":"Y value"}],"class":"function","name":"Vector2","description":" Creates a Vector2 struct for use with wire xv2 type"},"istable":{"path":"libs_sh/builtins.lua#L181","returns":[{"type":"boolean","value":"boolean If the object is a table or not","description":"If the object is a table or not"}],"realm":"shared","params":[{"type":"any","value":"any x Input to check","name":"x","description":"Input to check"}],"class":"function","name":"istable","description":" Returns if the given input is a table"},"owner":{"path":"libs_sh/builtins.lua#L63","returns":[{"type":"Player","value":"Player Owner of the chip","description":"Owner of the chip"}],"realm":"shared","class":"function","name":"owner","description":" Returns whoever created the chip"},"entity":{"path":"libs_sh/builtins.lua#L83","returns":[{"type":"Entity","value":"Entity Entity at the index","description":"Entity at the index"}],"realm":"shared","params":[{"type":"number","value":"number num Entity index","name":"num","description":"Entity index"}],"class":"function","name":"entity","description":" Returns the entity with index 'num'"},"hasPermission":{"path":"libs_sh/builtins.lua#L311","returns":[{"type":"boolean","value":"boolean Whether the client has granted the specified permission.","description":"Whether the client has granted the specified permission."},{"type":"string","value":"string The reason the permission check failed","description":"The reason the permission check failed"}],"realm":"shared","params":[{"type":"string","value":"string perm The permission id to check","name":"perm","description":"The permission id to check"},{"type":"any","value":"any obj Optional object to pass to the permission system.","name":"obj","description":"Optional object to pass to the permission system."}],"class":"function","name":"hasPermission","description":" Checks if the chip is capable of performing an action."},"cpuTotalAverage":{"path":"libs_sh/builtins.lua#L287","returns":[{"type":"number","value":"number Total average CPU Time of all your chips.","description":"Total average CPU Time of all your chips."}],"realm":"shared","class":"function","name":"cpuTotalAverage","description":" Returns the total average time for all chips by the player."},"setupPermissionRequest":{"path":"libs_sh/builtins.lua#L329","realm":"client","params":[{"type":"table","value":"table perms Table of overridable permissions' names.","name":"perms","description":"Table of overridable permissions' names."},{"type":"string","value":"string desc Description attached to request.","name":"desc","description":"Description attached to request."},{"type":"boolean","value":"boolean showOnUse Whether request will popup when player uses chip or linked screen.","name":"showOnUse","description":"Whether request will popup when player uses chip or linked screen."}],"class":"function","name":"setupPermissionRequest","description":" Setups request for overriding permissions."},"cpuTotalUsed":{"path":"libs_sh/builtins.lua#L277","returns":[{"type":"number","value":"number Total used CPU time of all your chips.","description":"Total used CPU time of all your chips."}],"realm":"shared","class":"function","name":"cpuTotalUsed","description":" Returns the total used time for all chips by the player."},"setmetatable":{"path":"libs_sh/builtins.lua#L159","returns":[{"type":"table","value":"table tbl with metatable set to meta","description":"tbl with metatable set to meta"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to set the metatable of","name":"tbl","description":"The table to set the metatable of"},{"type":"table","value":"table meta The metatable to use","name":"meta","description":"The metatable to use"}],"class":"function","name":"setmetatable","description":" Sets, changes or removes a table's metatable. Doesn't work on most internal metatables"},"select":{"path":"libs_sh/builtins.lua#L92","returns":[{"type":"any","value":"any Returns a number or vararg, depending on the select method.","description":"Returns a number or vararg, depending on the select method."}],"realm":"shared","params":[{"type":"any","value":"any parameter","name":"parameter","description":""},{"type":"...","value":"... vararg Args to select from","name":"vararg","description":"Args to select from"}],"class":"function","name":"select","description":" Used to select single values from a vararg or get the count of values in it."},"setSoftQuota":{"path":"libs_sh/builtins.lua#L304","realm":"shared","params":[{"type":"number","value":"number quota The threshold where the soft error will be thrown. Ratio of current cpu to the max cpu usage. 0.5 is 50%","name":"quota","description":"The threshold where the soft error will be thrown. Ratio of current cpu to the max cpu usage. 0.5 is 50%"}],"class":"function","name":"setSoftQuota","description":" Sets a soft cpu quota which will trigger a catchable error if the cpu goes over a certain amount."},"getUserdata":{"path":"libs_sh/builtins.lua#L602","returns":[{"type":"string","value":"string String data","description":"String data"}],"realm":"server","class":"function","name":"getUserdata","description":" Gets the chip's userdata that the duplicator tool loads"},"require":{"path":"libs_sh/builtins.lua#L757","returns":[{"type":"any","value":"any Return value of the script","description":"Return value of the script"}],"realm":"shared","params":[{"type":"string","value":"string path The file path to include. Make sure to --@include it","name":"path","description":"The file path to include. Make sure to --@include it"}],"class":"function","name":"require","description":" Runs an included script and caches the result.\n The path must be an actual path, including the file extension and using slashes for directory separators instead of periods."},"eyeAngles":{"path":"libs_sh/builtins.lua#L694","returns":[{"type":"Angle","value":"Angle The local player's camera angles","description":"The local player's camera angles"}],"realm":"client","class":"function","name":"eyeAngles","description":" Returns the local player's camera angles"},"printMessage":{"path":"libs_sh/builtins.lua#L640","realm":"client","params":[{"type":"number","value":"number mtype How the message should be displayed. See http://wiki.facepunch.com/gmod/Enums/HUD","name":"mtype","description":"How the message should be displayed. See http://wiki.facepunch.com/gmod/Enums/HUD"},{"type":"string","value":"string text The message text.","name":"text","description":"The message text."}],"class":"function","name":"printMessage","description":" Prints a message to your chat, console, or the center of your screen."}},"tables":{"FSASYNC":{"path":"libs_sh/enum.lua#L1188","fields":[{"name":"ERR_NOT_MINE","description":""},{"name":"ERR_RETRY_LATER","description":""},{"name":"ERR_ALIGNMENT","description":""},{"name":"ERR_FAILURE","description":""},{"name":"ERR_READING","description":""},{"name":"ERR_NOMEMORY","description":""},{"name":"ERR_UNKNOWNID","description":""},{"name":"ERR_FILEOPEN","description":""},{"name":"OK","description":""},{"name":"STATUS_PENDING","description":""},{"name":"STATUS_INPROGRESS","description":""},{"name":"STATUS_ABORTED","description":""},{"name":"STATUS_UNSERVICED","description":""}],"realm":"shared","class":"table","name":"FSASYNC","description":" file.asyncRead ENUMs"},"TEXT_ALIGN":{"path":"libs_sh/enum.lua#L22","fields":[{"name":"LEFT","description":"Align the text on the left"},{"name":"CENTER","description":"Align the text in center"},{"name":"RIGHT","description":"Align the text on the right"},{"name":"TOP","description":"Align the text on the top"},{"name":"BOTTOM","description":"Align the text on the bottom"}],"realm":"shared","class":"table","name":"TEXT_ALIGN","description":" Align enum for drawing text"},"FSOLID":{"path":"libs_sh/enum.lua#L652","fields":[{"name":"CUSTOMRAYTEST","description":""},{"name":"CUSTOMBOXTEST","description":""},{"name":"NOT_SOLID","description":""},{"name":"TRIGGER","description":""},{"name":"NOT_STANDABLE","description":""},{"name":"VOLUME_CONTENTS","description":""},{"name":"FORCE_WORLD_ALIGNED","description":""},{"name":"USE_TRIGGER_BOUNDS","description":""},{"name":"ROOT_PARENT_ALIGNED","description":""},{"name":"TRIGGER_TOUCH_DEBRIS","description":""}],"realm":"shared","class":"table","name":"FSOLID","description":" ENUMs of solid flags for use with entity:getSolidFlags"},"RENDERGROUP":{"path":"libs_sh/enum.lua#L1028","fields":[{"name":"STATIC_HUGE","description":""},{"name":"OPAQUE_HUGE","description":""},{"name":"STATIC","description":""},{"name":"OPAQUE","description":""},{"name":"TRANSLUCENT","description":""},{"name":"BOTH","description":""},{"name":"VIEWMODEL","description":""},{"name":"VIEWMODEL_TRANSLUCENT","description":""},{"name":"OPAQUE_BRUSH","description":""},{"name":"OTHER","description":""}],"realm":"shared","class":"table","name":"RENDERGROUP","description":" ENUMs of entity rendergroups"},"BOX":{"path":"libs_sh/enum.lua#L868","fields":[{"name":"FRONT","description":""},{"name":"BACK","description":""},{"name":"RIGHT","description":""},{"name":"LEFT","description":""},{"name":"TOP","description":""},{"name":"BOTTOM","description":""}],"realm":"shared","class":"table","name":"BOX","description":" ENUMs used by render.SetModelLighting"},"EF":{"path":"libs_sh/enum.lua#L400","fields":[{"name":"BONEMERGE","description":""},{"name":"BONEMERGE_FASTCULL","description":""},{"name":"BRIGHTLIGHT","description":""},{"name":"DIMLIGHT","description":""},{"name":"NOINTERP","description":""},{"name":"NOSHADOW","description":""},{"name":"NODRAW","description":""},{"name":"NORECEIVESHADOW","description":""},{"name":"ITEM_BLINK","description":""},{"name":"PARENT_ANIMATES","description":""},{"name":"FOLLOWBONE","description":""}],"realm":"shared","class":"table","name":"EF","description":" ENUMs of ef for use with hologram:addEffects hologram:removeEffects entity:isEffectActive"},"FVPHYSICS":{"path":"libs_sh/enum.lua#L428","fields":[{"name":"CONSTRAINT_STATIC","description":""},{"name":"DMG_DISSOLVE","description":""},{"name":"DMG_SLICE","description":""},{"name":"HEAVY_OBJECT","description":""},{"name":"MULTIOBJECT_ENTITY","description":""},{"name":"NO_IMPACT_DMG","description":""},{"name":"NO_NPC_IMPACT_DMG","description":""},{"name":"NO_PLAYER_PICKUP","description":""},{"name":"NO_SELF_COLLISIONS","description":""},{"name":"PART_OF_RAGDOLL","description":""},{"name":"PENETRATING","description":""},{"name":"PLAYER_HELD","description":""},{"name":"WAS_THROWN","description":""}],"realm":"shared","class":"table","name":"FVPHYSICS","description":" ENUMs of physics object flags"},"DAMAGE":{"path":"libs_sh/enum.lua#L1340","fields":[{"name":"GENERIC","description":""},{"name":"CRUSH","description":""},{"name":"BULLET","description":""},{"name":"SLASH","description":""},{"name":"BURN","description":""},{"name":"VEHICLE","description":""},{"name":"FALL","description":""},{"name":"BLAST","description":""},{"name":"CLUB","description":""},{"name":"SHOCK","description":""},{"name":"SONIC","description":""},{"name":"ENERGYBEAM","description":""},{"name":"PREVENTPHYSICSFORCE","description":""},{"name":"NEVERGIB","description":""},{"name":"ALWAYSGIB","description":""},{"name":"DROWN","description":""},{"name":"PARALYZE","description":""},{"name":"NERVEGAS","description":""},{"name":"POISON","description":""},{"name":"RADIATION","description":""},{"name":"DROWNRECOVER","description":""},{"name":"ACID","description":""},{"name":"SLOWBURN","description":""},{"name":"REMOVENORAGDOLL","description":""},{"name":"PHYSGUN","description":""},{"name":"PLASMA","description":""},{"name":"AIRBOAT","description":""},{"name":"DISSOLVE","description":""},{"name":"BLASTSURFACE","description":""},{"name":"DIRECT","description":""},{"name":"BUCKSHOT","description":""},{"name":"SNIPER","description":""},{"name":"MISSILEDEFENSE","description":""}],"realm":"shared","class":"table","name":"DAMAGE","description":" ENUMs used for anything that returns a damage type."},"PATTACH":{"path":"libs_sh/enum.lua#L382","fields":[{"name":"ABSORIGIN","description":""},{"name":"ABSORIGIN_FOLLOW","description":""},{"name":"CUSTOMORIGIN","description":""},{"name":"POINT","description":""},{"name":"POINT_FOLLOW","description":""},{"name":"WORLDORIGIN","description":""}],"realm":"shared","class":"table","name":"PATTACH","description":" PATTACH enum for particle library"},"COLLISION_GROUP":{"path":"libs_sh/enum.lua#L582","fields":[{"name":"NONE","description":""},{"name":"DEBRIS","description":""},{"name":"DEBRIS_TRIGGER","description":""},{"name":"INTERACTIVE_DEBRIS","description":""},{"name":"INTERACTIVE","description":""},{"name":"PLAYER","description":""},{"name":"BREAKABLE_GLASS","description":""},{"name":"VEHICLE","description":""},{"name":"PLAYER_MOVEMENT","description":""},{"name":"NPC","description":""},{"name":"IN_VEHICLE","description":""},{"name":"WEAPON","description":""},{"name":"VEHICLE_CLIP","description":""},{"name":"PROJECTILE","description":""},{"name":"DOOR_BLOCKER","description":""},{"name":"PASSABLE_DOOR","description":""},{"name":"DISSOLVING","description":""},{"name":"PUSHAWAY","description":""},{"name":"NPC_ACTOR","description":""},{"name":"NPC_SCRIPTED","description":""},{"name":"WORLD","description":""}],"realm":"shared","class":"table","name":"COLLISION_GROUP","description":" ENUMs of collision groups for use with entity:setCollisionGroup"},"RENDERMODE":{"path":"libs_sh/enum.lua#L944","fields":[{"name":"NORMAL","description":""},{"name":"TRANSCOLOR","description":""},{"name":"TRANSTEXTURE","description":""},{"name":"GLOW","description":""},{"name":"TRANSALPHA","description":""},{"name":"TRANSADD","description":""},{"name":"ENVIROMENTAL","description":""},{"name":"TRANSADDFRAMEBLEND","description":""},{"name":"TRANSALPHADD","description":""},{"name":"WORLDGLOW","description":""},{"name":"NONE","description":""}],"realm":"shared","class":"table","name":"RENDERMODE","description":" ENUMs of entity render modes to be used with Entity.setRenderMode"},"RENDERFX":{"path":"libs_sh/enum.lua#L972","fields":[{"name":"NONE","description":""},{"name":"PULSESLOW","description":""},{"name":"PULSEFAST","description":""},{"name":"PULSESLOWWIDE","description":""},{"name":"PULSEFASTWIDE","description":""},{"name":"FADESLOW","description":""},{"name":"FADEFAST","description":""},{"name":"SOLIDSLOW","description":""},{"name":"SOLIDFAST","description":""},{"name":"STROBESLOW","description":""},{"name":"STROBEFAST","description":""},{"name":"STROBEFASTER","description":""},{"name":"FLICKERSLOW","description":""},{"name":"FLICKERFAST","description":""},{"name":"NODISSIPATION","description":""},{"name":"DISTORT","description":""},{"name":"HOLOGRAM","description":""},{"name":"EXPLODE","description":""},{"name":"GLOWSHELL","description":""},{"name":"CLAMPMINSCALE","description":""},{"name":"RAIN","description":""},{"name":"SNOW","description":""},{"name":"SPOTLIGHT","description":""},{"name":"RAGDOLL","description":""},{"name":"PULSEFASTWIDER","description":""}],"realm":"shared","class":"table","name":"RENDERFX","description":" ENUMs of entity renderfx to be used with Entity.setRenderFX"},"SOLID":{"path":"libs_sh/enum.lua#L631","fields":[{"name":"NONE","description":""},{"name":"BSP","description":""},{"name":"BBOX","description":""},{"name":"OBB","description":""},{"name":"OBB_YAW","description":""},{"name":"CUSTOM","description":""},{"name":"VPHYSICS","description":""}],"realm":"shared","class":"table","name":"SOLID","description":" ENUMs of solid for use with entity:getSolid"},"CONTENTS":{"path":"libs_sh/enum.lua#L760","fields":[{"name":"CURRENT_270","description":""},{"name":"DETAIL","description":""},{"name":"IGNORE_NODRAW_OPAQUE","description":""},{"name":"BLOCKLOS","description":""},{"name":"GRATE","description":""},{"name":"CURRENT_0","description":""},{"name":"AREAPORTAL","description":""},{"name":"DEBRIS","description":""},{"name":"MONSTERCLIP","description":""},{"name":"SLIME","description":""},{"name":"WINDOW","description":""},{"name":"LADDER","description":""},{"name":"CURRENT_180","description":""},{"name":"TRANSLUCENT","description":""},{"name":"EMPTY","description":""},{"name":"TEAM2","description":""},{"name":"CURRENT_UP","description":""},{"name":"TESTFOGVOLUME","description":""},{"name":"TEAM1","description":""},{"name":"AUX","description":""},{"name":"CURRENT_DOWN","description":""},{"name":"ORIGIN","description":""},{"name":"TEAM3","description":""},{"name":"MOVEABLE","description":""},{"name":"PLAYERCLIP","description":""},{"name":"SOLID","description":""},{"name":"TEAM4","description":""},{"name":"MONSTER","description":""},{"name":"HITBOX","description":""},{"name":"CURRENT_90","description":""},{"name":"OPAQUE","description":""},{"name":"WATER","description":""}],"realm":"shared","class":"table","name":"CONTENTS","description":" ENUMs used as masks in the trace library."},"MATERIAL_FOG":{"path":"libs_sh/enum.lua#L700","fields":[{"name":"NONE","description":""},{"name":"LINEAR","description":""},{"name":"LINEAR_BELOW_FOG_Z","description":""}],"realm":"shared","class":"table","name":"MATERIAL_FOG","description":" ENUMs of fog modes to use with render.setFogMode."},"MAT":{"path":"libs_sh/enum.lua#L1112","fields":[{"name":"ANTLION","description":""},{"name":"BLOODYFLESH","description":""},{"name":"CONCRETE","description":""},{"name":"DIRT","description":""},{"name":"EGGSHELL","description":""},{"name":"FLESH","description":""},{"name":"GRATE","description":""},{"name":"ALIENFLESH","description":""},{"name":"CLIP","description":""},{"name":"SNOW","description":""},{"name":"PLASTIC","description":""},{"name":"METAL","description":""},{"name":"SAND","description":""},{"name":"FOLIAGE","description":""},{"name":"COMPUTER","description":""},{"name":"SLOSH","description":""},{"name":"TILE","description":""},{"name":"GRASS","description":""},{"name":"VENT","description":""},{"name":"WOOD","description":""},{"name":"DEFAULT","description":""},{"name":"GLASS","description":""},{"name":"WARPSHIELD","description":""}],"realm":"shared","class":"table","name":"MAT","description":" ENUMs describing surface material. Used in TraceResult"},"BLENDFUNC":{"path":"libs_sh/enum.lua#L928","fields":[{"name":"ADD","description":""},{"name":"SUBTRACT","description":""},{"name":"REVERSE_SUBTRACT","description":""},{"name":"MIN","description":""},{"name":"MAX","description":""}],"realm":"shared","class":"table","name":"BLENDFUNC","description":" ENUMs of blend modes"},"NOTIFY":{"path":"libs_sh/enum.lua#L6","fields":[{"name":"GENERIC","description":""},{"name":"ERROR","description":""},{"name":"UNDO","description":""},{"name":"HINT","description":""},{"name":"CLEANUP","description":""}],"realm":"shared","class":"table","name":"NOTIFY","description":" Notification library enums"},"GMOD_CHANNEL":{"path":"libs_sh/enum.lua#L1412","fields":[{"name":"STOPPED","description":"0"},{"name":"PLAYING","description":"1"},{"name":"PAUSED","description":"2"},{"name":"STALLED","description":"3"}],"realm":"shared","class":"table","name":"GMOD_CHANNEL","description":" ENUMs used by Bass:getState()"},"HITGROUP":{"path":"libs_sh/enum.lua#L1164","fields":[{"name":"GENERIC","description":""},{"name":"HEAD","description":""},{"name":"CHEST","description":""},{"name":"STOMACH","description":""},{"name":"LEFTARM","description":""},{"name":"RIGHTARM","description":""},{"name":"LEFTLEG","description":""},{"name":"RIGHTLEG","description":""},{"name":"GEAR","description":""}],"realm":"shared","class":"table","name":"HITGROUP","description":" Player and NPC hitgroup ENUMs"},"BLEND":{"path":"libs_sh/enum.lua#L900","fields":[{"name":"ZERO","description":""},{"name":"ONE","description":""},{"name":"DST_COLOR","description":""},{"name":"ONE_MINUS_DST_COLOR","description":""},{"name":"SRC_ALPHA","description":""},{"name":"ONE_MINUS_SRC_ALPHA","description":""},{"name":"DST_ALPHA","description":""},{"name":"ONE_MINUS_DST_ALPHA","description":""},{"name":"SRC_ALPHA_SATURATE","description":""},{"name":"SRC_COLOR","description":""},{"name":"ONE_MINUS_SRC_COLOR","description":""}],"realm":"shared","class":"table","name":"BLEND","description":" ENUMs of blend functions"},"KEY":{"path":"libs_sh/enum.lua#L38","fields":[{"name":"FIRST","description":""},{"name":"NONE","description":""},{"name":"0","description":""},{"name":"KEY0","description":""},{"name":"1","description":""},{"name":"KEY1","description":""},{"name":"2","description":""},{"name":"KEY2","description":""},{"name":"3","description":""},{"name":"KEY3","description":""},{"name":"4","description":""},{"name":"KEY4","description":""},{"name":"5","description":""},{"name":"KEY5","description":""},{"name":"6","description":""},{"name":"KEY6","description":""},{"name":"7","description":""},{"name":"KEY7","description":""},{"name":"8","description":""},{"name":"KEY8","description":""},{"name":"9","description":""},{"name":"KEY9","description":""},{"name":"A","description":""},{"name":"B","description":""},{"name":"C","description":""},{"name":"D","description":""},{"name":"E","description":""},{"name":"F","description":""},{"name":"G","description":""},{"name":"H","description":""},{"name":"I","description":""},{"name":"J","description":""},{"name":"K","description":""},{"name":"L","description":""},{"name":"M","description":""},{"name":"N","description":""},{"name":"O","description":""},{"name":"P","description":""},{"name":"Q","description":""},{"name":"R","description":""},{"name":"S","description":""},{"name":"T","description":""},{"name":"U","description":""},{"name":"V","description":""},{"name":"W","description":""},{"name":"X","description":""},{"name":"Y","description":""},{"name":"Z","description":""},{"name":"KP_INS","description":""},{"name":"PAD_0","description":""},{"name":"KP_END","description":""},{"name":"PAD_1","description":""},{"name":"KP_DOWNARROW","description":""},{"name":"PAD_2","description":""},{"name":"KP_PGDN","description":""},{"name":"PAD_3","description":""},{"name":"KP_LEFTARROW","description":""},{"name":"PAD_4","description":""},{"name":"KP_5","description":""},{"name":"PAD_5","description":""},{"name":"KP_RIGHTARROW","description":""},{"name":"PAD_6","description":""},{"name":"KP_HOME","description":""},{"name":"PAD_7","description":""},{"name":"KP_UPARROW","description":""},{"name":"PAD_8","description":""},{"name":"KP_PGUP","description":""},{"name":"PAD_9","description":""},{"name":"PAD_DIVIDE","description":""},{"name":"KP_SLASH","description":""},{"name":"KP_MULTIPLY","description":""},{"name":"PAD_MULTIPLY","description":""},{"name":"KP_MINUS","description":""},{"name":"PAD_MINUS","description":""},{"name":"KP_PLUS","description":""},{"name":"PAD_PLUS","description":""},{"name":"KP_ENTER","description":""},{"name":"PAD_ENTER","description":""},{"name":"KP_DEL","description":""},{"name":"PAD_DECIMAL","description":""},{"name":"LBRACKET","description":""},{"name":"RBRACKET","description":""},{"name":"SEMICOLON","description":""},{"name":"APOSTROPHE","description":""},{"name":"BACKQUOTE","description":""},{"name":"COMMA","description":""},{"name":"PERIOD","description":""},{"name":"SLASH","description":""},{"name":"BACKSLASH","description":""},{"name":"MINUS","description":""},{"name":"EQUAL","description":""},{"name":"ENTER","description":""},{"name":"SPACE","description":""},{"name":"BACKSPACE","description":""},{"name":"TAB","description":""},{"name":"CAPSLOCK","description":""},{"name":"NUMLOCK","description":""},{"name":"ESCAPE","description":""},{"name":"SCROLLLOCK","description":""},{"name":"INS","description":""},{"name":"INSERT","description":""},{"name":"DEL","description":""},{"name":"DELETE","description":""},{"name":"HOME","description":""},{"name":"END","description":""},{"name":"PGUP","description":""},{"name":"PAGEUP","description":""},{"name":"PGDN","description":""},{"name":"PAGEDOWN","description":""},{"name":"PAUSE","description":""},{"name":"BREAK","description":""},{"name":"SHIFT","description":""},{"name":"LSHIFT","description":""},{"name":"RSHIFT","description":""},{"name":"ALT","description":""},{"name":"LALT","description":""},{"name":"RALT","description":""},{"name":"CTRL","description":""},{"name":"LCONTROL","description":""},{"name":"RCTRL","description":""},{"name":"RCONTROL","description":""},{"name":"LWIN","description":""},{"name":"RWIN","description":""},{"name":"APP","description":""},{"name":"UPARROW","description":""},{"name":"UP","description":""},{"name":"LEFTARROW","description":""},{"name":"LEFT","description":""},{"name":"DOWNARROW","description":""},{"name":"DOWN","description":""},{"name":"RIGHTARROW","description":""},{"name":"RIGHT","description":""},{"name":"F1","description":""},{"name":"F2","description":""},{"name":"F3","description":""},{"name":"F4","description":""},{"name":"F5","description":""},{"name":"F6","description":""},{"name":"F7","description":""},{"name":"F8","description":""},{"name":"F9","description":""},{"name":"F10","description":""},{"name":"F11","description":""},{"name":"F12","description":""},{"name":"CAPSLOCKTOGGLE","description":""},{"name":"NUMLOCKTOGGLE","description":""},{"name":"SCROLLLOCKTOGGLE","description":""},{"name":"LAST","description":""},{"name":"COUNT","description":""}],"realm":"shared","class":"table","name":"KEY","description":" ENUMs of keyboard keys for use with input library"},"STENCIL":{"path":"libs_sh/enum.lua#L830","fields":[{"name":"NEVER","description":""},{"name":"LESS","description":""},{"name":"EQUAL","description":""},{"name":"LESSEQUAL","description":""},{"name":"GREATER","description":""},{"name":"NOTEQUAL","description":""},{"name":"GREATEREQUAL","description":""},{"name":"ALWAYS","description":""},{"name":"KEEP","description":""},{"name":"ZERO","description":""},{"name":"REPLACE","description":""},{"name":"INCRSAT","description":""},{"name":"DECRSAT","description":""},{"name":"INVERT","description":""},{"name":"INCR","description":""},{"name":"DECR","description":""}],"realm":"shared","class":"table","name":"STENCIL","description":" ENUMs of stencil comparisons and operations"},"MASK":{"path":"libs_sh/enum.lua#L712","fields":[{"name":"OPAQUE_AND_NPCS","description":""},{"name":"SOLID","description":""},{"name":"OPAQUE","description":""},{"name":"PLAYERSOLID_BRUSHONLY","description":""},{"name":"BLOCKLOS","description":""},{"name":"SHOT_HULL","description":""},{"name":"ALL","description":""},{"name":"VISIBLE","description":""},{"name":"NPCWORLDSTATIC","description":""},{"name":"DEADSOLID","description":""},{"name":"SPLITAREAPORTAL","description":""},{"name":"CURRENT","description":""},{"name":"BLOCKLOS_AND_NPCS","description":""},{"name":"SHOT","description":""},{"name":"NPCSOLID","description":""},{"name":"SOLID_BRUSHONLY","description":""},{"name":"VISIBLE_AND_NPCS","description":""},{"name":"NPCSOLID_BRUSHONLY","description":""},{"name":"SHOT_PORTAL","description":""},{"name":"WATER","description":""},{"name":"PLAYERSOLID","description":""}],"realm":"shared","class":"table","name":"MASK","description":" ENUMs used as trace masks in the trace library. These are simply combinations of the CONTENTS enums."},"MOVETYPE":{"path":"libs_sh/enum.lua#L460","fields":[{"name":"NONE","description":""},{"name":"ISOMETRIC","description":""},{"name":"WALK","description":""},{"name":"STEP","description":""},{"name":"FLY","description":""},{"name":"FLYGRAVITY","description":""},{"name":"VPHYSICS","description":""},{"name":"PUSH","description":""},{"name":"NOCLIP","description":""},{"name":"LADDER","description":""},{"name":"OBSERVER","description":""},{"name":"CUSTOM","description":""}],"realm":"shared","class":"table","name":"MOVETYPE","description":" ENUMs of entity move types"},"IN_KEY":{"path":"libs_sh/enum.lua#L506","fields":[{"name":"ALT1","description":""},{"name":"ALT2","description":""},{"name":"ATTACK","description":""},{"name":"ATTACK2","description":""},{"name":"BACK","description":""},{"name":"DUCK","description":""},{"name":"FORWARD","description":""},{"name":"JUMP","description":""},{"name":"LEFT","description":""},{"name":"MOVELEFT","description":""},{"name":"MOVERIGHT","description":""},{"name":"RELOAD","description":""},{"name":"RIGHT","description":""},{"name":"SCORE","description":""},{"name":"SPEED","description":""},{"name":"USE","description":""},{"name":"WALK","description":""},{"name":"ZOOM","description":""},{"name":"GRENADE1","description":""},{"name":"GRENADE2","description":""},{"name":"WEAPON1","description":""},{"name":"WEAPON2","description":""},{"name":"BULLRUSH","description":""},{"name":"CANCEL","description":""},{"name":"RUN","description":""}],"realm":"shared","class":"table","name":"IN_KEY","description":" ENUMs of in_keys for use with player:keyDown"},"TEXFILTER":{"path":"libs_sh/enum.lua#L886","fields":[{"name":"NONE","description":""},{"name":"POINT","description":""},{"name":"LINEAR","description":""},{"name":"ANISOTROPIC","description":""}],"realm":"shared","class":"table","name":"TEXFILTER","description":" ENUMs of texture filtering modes"},"SIM":{"path":"libs_sh/enum.lua#L490","fields":[{"name":"NOTHING","description":""},{"name":"LOCAL_ACCELERATION","description":""},{"name":"LOCAL_FORCE","description":""},{"name":"GLOBAL_ACCELERATION","description":""},{"name":"GLOBAL_FORCE","description":""}],"realm":"shared","class":"table","name":"SIM","description":" ENUMs used by Entity.setCustomPropForces (Entity.PhysicsSimulate internally)"},"GESTURE_SLOT":{"path":"libs_sh/enum.lua#L562","fields":[{"name":"ATTACK_AND_RELOAD","description":""},{"name":"GRENADE","description":""},{"name":"JUMP","description":""},{"name":"SWIM","description":""},{"name":"FLINCH","description":""},{"name":"VCD","description":""},{"name":"CUSTOM","description":""}],"realm":"shared","class":"table","name":"GESTURE_SLOT","description":" ENUMs of gesture_slot for use with player:playGesture player:resetGesture"},"MOUSE":{"path":"libs_sh/enum.lua#L342","fields":[{"name":"MOUSE1","description":""},{"name":"LEFT","description":""},{"name":"MOUSE2","description":""},{"name":"RIGHT","description":""},{"name":"MOUSE3","description":""},{"name":"MIDDLE","description":""},{"name":"MOUSE4","description":""},{"name":"4","description":""},{"name":"MOUSE5","description":""},{"name":"5","description":""},{"name":"MWHEELUP","description":""},{"name":"WHEEL_UP","description":""},{"name":"MWHEELDOWN","description":""},{"name":"WHEEL_DOWN","description":""},{"name":"COUNT","description":""},{"name":"FIRST","description":""},{"name":"LAST","description":""}],"realm":"shared","class":"table","name":"MOUSE","description":" ENUMs of mouse buttons for use with input library"},"MATERIAL":{"path":"libs_sh/enum.lua#L678","fields":[{"name":"LINES","description":""},{"name":"LINE_LOOP","description":""},{"name":"LINE_STRIP","description":""},{"name":"POINTS","description":""},{"name":"POLYGON","description":""},{"name":"QUADS","description":""},{"name":"TRIANGLES","description":""},{"name":"TRIANGLE_STRIP","description":""}],"realm":"shared","class":"table","name":"MATERIAL","description":" ENUMs of mesh types. To be used with mesh.generate."}},"path":"libs_sh/builtins.lua#L51","libtbl":["builtins_library"],"realm":"shared","fields":{"SERVER":{"path":"libs_sh/builtins.lua#L224","realm":"shared","class":"field","name":"SERVER","description":" Constant that denotes whether the code is executed on the server"},"CLIENT":{"path":"libs_sh/builtins.lua#L219","realm":"shared","class":"field","name":"CLIENT","description":" Constant that denotes whether the code is executed on the client"}},"class":"library","name":"builtins","description":" Built in values. These don't need to be loaded; they are in the default builtins_library."},"mesh":{"methods":{"generate":{"path":"libs_sh/mesh.lua#L1003","realm":"client","params":[{"type":"Mesh?","value":"Mesh? mesh_obj Optional Mesh object, mesh to build. (default: nil)","name":"mesh_obj","description":"Optional Mesh object, mesh to build. (default: nil)"},{"type":"number","value":"number prim_type Int, primitive type, see MATERIAL","name":"prim_type","description":"Int, primitive type, see MATERIAL"},{"type":"number","value":"number prim_count Int, the amount of primitives","name":"prim_count","description":"Int, the amount of primitives"},{"type":"function","value":"function func The function provided that will generate the mesh vertices","name":"func","description":"The function provided that will generate the mesh vertices"}],"class":"function","name":"generate","description":" Generates mesh data. If an Mesh object is passed, it will populate that mesh with the data. Otherwise, it will render directly to renderer."},"parseObj":{"path":"libs_sh/mesh.lua#L705","returns":[{"type":"table","value":"table Table of Mesh tables. The keys correspond to the objs object names, and the values are tables of vertices that can be passed to mesh.createFromTable","description":"Table of Mesh tables. The keys correspond to the objs object names, and the values are tables of vertices that can be passed to mesh.createFromTable"},{"type":"table","value":"table Table of Mesh data. {positions = positionData, normals = normalData, texturecoords = texturecoordData, faces = faceData}","description":"Table of Mesh data. {positions = positionData, normals = normalData, texturecoords = texturecoordData, faces = faceData}"}],"realm":"shared","params":[{"type":"string","value":"string obj The obj data","name":"obj","description":"The obj data"},{"type":"boolean?","value":"boolean? threaded Optional bool, use threading object that can be used to load the mesh over time to prevent hitting quota limit","name":"threaded","description":"Optional bool, use threading object that can be used to load the mesh over time to prevent hitting quota limit"},{"type":"boolean?","value":"boolean? triangulate Whether to triangulate the faces","name":"triangulate","description":"Whether to triangulate the faces"}],"class":"function","name":"parseObj","description":" Parses obj data into a table of vertices, normals, texture coordinates, colors, and tangents"},"writeNormal":{"path":"libs_sh/mesh.lua#L1063","realm":"client","params":[{"type":"Vector","value":"Vector normal Normal","name":"normal","description":"Normal"}],"class":"function","name":"writeNormal","description":" Sets the vertex normal"},"writeUV":{"path":"libs_sh/mesh.lua#L1077","realm":"client","params":[{"type":"number","value":"number stage Stage of the texture coordinate","name":"stage","description":"Stage of the texture coordinate"},{"type":"number","value":"number u U coordinate","name":"u","description":"U coordinate"},{"type":"number","value":"number v V coordinate","name":"v","description":"V coordinate"}],"class":"function","name":"writeUV","description":" Sets the vertex texture coordinates"},"getModelMeshes":{"path":"libs_sh/mesh.lua#L941","returns":[{"type":"table","value":"table A table of tables with the following format:  string material - The material of the specific mesh table triangles - A table of MeshVertex structures ready to be fed into IMesh:BuildFromTriangles table verticies - A table of MeshVertex structures representing all the vertexes of the mesh. This table is used internally to generate the \"triangles\" table. Each MeshVertex structure returned also has an extra table of tables field called \"weights\" with the following data:  number boneID - The bone this vertex is attached to number weight - How \"strong\" this vertex is attached to the bone. A vertex can be attached to multiple bones at once.","description":"A table of tables with the following format:  string material - The material of the specific mesh table triangles - A table of MeshVertex structures ready to be fed into IMesh:BuildFromTriangles table verticies - A table of MeshVertex structures representing all the vertexes of the mesh. This table is used internally to generate the \"triangles\" table. Each MeshVertex structure returned also has an extra table of tables field called \"weights\" with the following data:  number boneID - The bone this vertex is attached to number weight - How \"strong\" this vertex is attached to the bone. A vertex can be attached to multiple bones at once."},{"type":"table","value":"table A table of tables with bone id keys with the following format:  number parent - The parent bone id Matrix matrix - pretransformed bone matrix","description":"A table of tables with bone id keys with the following format:  number parent - The parent bone id Matrix matrix - pretransformed bone matrix"}],"realm":"client","params":[{"type":"string","value":"string model The full path to a model to get the visual meshes of.","name":"model","description":"The full path to a model to get the visual meshes of."},{"type":"number?","value":"number? lod The lod of the model to use. Default 0.","name":"lod","description":"The lod of the model to use. Default 0."},{"type":"number?","value":"number? bodygroupMask The bodygroupMask of the model to use. Default 0.","name":"bodygroupMask","description":"The bodygroupMask of the model to use. Default 0."}],"class":"function","name":"getModelMeshes","description":" Returns a table of visual meshes of given model or nil if the model is invalid"},"trianglesLeft":{"path":"libs_sh/mesh.lua#L977","returns":[{"type":"number","value":"number Number of triangles that can be created","description":"Number of triangles that can be created"}],"realm":"client","class":"function","name":"trianglesLeft","description":" Returns how many triangles can be created"},"writeColor":{"path":"libs_sh/mesh.lua#L1053","realm":"client","params":[{"type":"number","value":"number r Number, red value","name":"r","description":"Number, red value"},{"type":"number","value":"number g Number, green value","name":"g","description":"Number, green value"},{"type":"number","value":"number b Number, blue value","name":"b","description":"Number, blue value"},{"type":"number","value":"number a Number, alpha value","name":"a","description":"Number, alpha value"}],"class":"function","name":"writeColor","description":" Sets the vertex color by RGBA values"},"writePosition":{"path":"libs_sh/mesh.lua#L1070","realm":"client","params":[{"type":"Vector","value":"Vector position Position","name":"position","description":"Position"}],"class":"function","name":"writePosition","description":" Sets the vertex position"},"trianglesLeftRender":{"path":"libs_sh/mesh.lua#L984","returns":[{"type":"number","value":"number Number of triangles that can be rendered","description":"Number of triangles that can be rendered"}],"realm":"client","class":"function","name":"trianglesLeftRender","description":" Returns how many triangles can be rendered"},"createFromObj":{"path":"libs_sh/mesh.lua#L885","returns":[{"type":"table","value":"table Table of Mesh objects. The keys correspond to the objs object names","description":"Table of Mesh objects. The keys correspond to the objs object names"}],"realm":"client","params":[{"type":"string","value":"string obj The obj file data","name":"obj","description":"The obj file data"},{"type":"boolean?","value":"boolean? threaded Optional bool, use threading object that can be used to load the mesh over time to prevent hitting quota limit","name":"threaded","description":"Optional bool, use threading object that can be used to load the mesh over time to prevent hitting quota limit"},{"type":"boolean?","value":"boolean? triangulate Whether to triangulate faces. (Consumes more CPU)","name":"triangulate","description":"Whether to triangulate faces. (Consumes more CPU)"}],"class":"function","name":"createFromObj","description":" Creates a mesh from an obj file. Only supports triangular meshes with normals and texture coordinates."},"generateNormals":{"path":"libs_sh/mesh.lua#L719","realm":"shared","params":[{"type":"table","value":"table vertices The table of vertices","name":"vertices","description":"The table of vertices"},{"type":"boolean?","value":"boolean? inverted Optional bool, invert the normal","name":"inverted","description":"Optional bool, invert the normal"},{"type":"number?","value":"number? smooth_limit Optional number, smooths the normal based on the limit in radians","name":"smooth_limit","description":"Optional number, smooths the normal based on the limit in radians"}],"class":"function","name":"generateNormals","description":" Generates normal vectors for the provided vertices table"},"advanceVertex":{"path":"libs_sh/mesh.lua#L1116","realm":"client","class":"function","name":"advanceVertex","description":" Pushes the vertex data onto the render stack"},"writeQuadEasy":{"path":"libs_sh/mesh.lua#L1106","realm":"client","params":[{"type":"Vector","value":"Vector position","name":"position","description":""},{"type":"Vector","value":"Vector normal","name":"normal","description":""},{"type":"number","value":"number w","name":"w","description":""},{"type":"number","value":"number h","name":"h","description":""}],"class":"function","name":"writeQuadEasy","description":" Draws a quad using a position, normal and size"},"writeQuad":{"path":"libs_sh/mesh.lua#L1096","realm":"client","params":[{"type":"Vector","value":"Vector v1 Vertex1 position","name":"v1","description":"Vertex1 position"},{"type":"Vector","value":"Vector v2 Vertex2 position","name":"v2","description":"Vertex2 position"},{"type":"Vector","value":"Vector v3 Vertex3 position","name":"v3","description":"Vertex3 position"},{"type":"Vector","value":"Vector v4 Vertex4 position","name":"v4","description":"Vertex4 position"}],"class":"function","name":"writeQuad","description":" Draws a quad using 4 vertices"},"generateTangents":{"path":"libs_sh/mesh.lua#L745","realm":"shared","params":[{"type":"table","value":"table vertices The table of vertices","name":"vertices","description":"The table of vertices"}],"class":"function","name":"generateTangents","description":" Generates the tangents for the provided vertices table"},"generateUV":{"path":"libs_sh/mesh.lua#L733","realm":"shared","params":[{"type":"table","value":"table vertices The table of vertices","name":"vertices","description":"The table of vertices"},{"type":"number","value":"number scale The scale of the uvs","name":"scale","description":"The scale of the uvs"}],"class":"function","name":"generateUV","description":" Generates the uv for the provided vertices table"},"createEmpty":{"path":"libs_sh/mesh.lua#L914","returns":[{"type":"Mesh","value":"Mesh Mesh object","description":"Mesh object"}],"realm":"client","class":"function","name":"createEmpty","description":" Creates a mesh without any vertex data."},"createFromTable":{"path":"libs_sh/mesh.lua#L844","returns":[{"type":"Mesh","value":"Mesh Mesh object","description":"Mesh object"}],"realm":"client","params":[{"type":"table","value":"table vertices Table containing vertex data. http://wiki.facepunch.com/gmod/Structures/MeshVertex","name":"vertices","description":"Table containing vertex data. http://wiki.facepunch.com/gmod/Structures/MeshVertex"},{"type":"boolean?","value":"boolean? threaded Optional bool, use threading object that can be used to load the mesh over time to prevent hitting quota limit. The thread will yield with number of vertices remaining to be processed. After 0 is yielded, the final expensive phase starts.","name":"threaded","description":"Optional bool, use threading object that can be used to load the mesh over time to prevent hitting quota limit. The thread will yield with number of vertices remaining to be processed. After 0 is yielded, the final expensive phase starts."}],"class":"function","name":"createFromTable","description":" Creates a mesh from vertex data."},"findConvexHull":{"path":"libs_sh/mesh.lua#L755","returns":[{"type":"table","value":"table The mesh table which can be passed to mesh.createFromTable","description":"The mesh table which can be passed to mesh.createFromTable"},{"type":"table","value":"table The table of vertices which can be passed to prop.createCustom","description":"The table of vertices which can be passed to prop.createCustom"}],"realm":"shared","params":[{"type":"table","value":"table vertices The table of vertices (vectors) or vertex data (http://wiki.facepunch.com/gmod/Structures/MeshVertex)","name":"vertices","description":"The table of vertices (vectors) or vertex data (http://wiki.facepunch.com/gmod/Structures/MeshVertex)"},{"type":"boolean?","value":"boolean? threaded Optional bool, use threading object that can be used to run algorithm over time to prevent hitting quota limit","name":"threaded","description":"Optional bool, use threading object that can be used to run algorithm over time to prevent hitting quota limit"}],"class":"function","name":"findConvexHull","description":" Finds the convex hull of provided vertices table."},"writeUserData":{"path":"libs_sh/mesh.lua#L1086","realm":"client","params":[{"type":"number","value":"number x x","name":"x","description":"x"},{"type":"number","value":"number y y","name":"y","description":"y"},{"type":"number","value":"number z z","name":"z","description":"z"},{"type":"number","value":"number handedness","name":"handedness","description":""}],"class":"function","name":"writeUserData","description":" Sets the vertex tangent user data"}},"tables":[],"path":"libs_sh/mesh.lua#L672","libtbl":["mesh_library"],"realm":"shared","fields":[],"class":"library","name":"mesh","description":" Mesh library."},"debug":{"methods":{"traceback":{"path":"libs_sh/builtins.lua#L958","returns":[{"type":"string","value":"string A dump of the execution stack.","description":"A dump of the execution stack."}],"realm":"shared","params":[{"type":"thread?","value":"thread? A thread to get the stack trace of. If nil, this argument will be used as the message and the current thread becomes the target.","name":"A","description":"thread to get the stack trace of. If nil, this argument will be used as the message and the current thread becomes the target."},{"type":"string?","value":"string? message A message to be included at the beginning of the stack trace. Default: \"\"","name":"message","description":"A message to be included at the beginning of the stack trace. Default: \"\""},{"type":"number?","value":"number? stacklevel Which position in the execution stack to start the traceback at. Default: 1","name":"stacklevel","description":"Which position in the execution stack to start the traceback at. Default: 1"}],"class":"function","name":"traceback","description":" GLua's debug.traceback()\n Returns a string containing a stack trace of the given thread"},"getlocal":{"path":"libs_sh/builtins.lua#L1001","returns":[{"type":"string","value":"string The name of the local","description":"The name of the local"}],"realm":"shared","params":[{"type":"function|number","value":"function|number funcOrStackLevel Function or stack level to get info about. Defaults to stack level 0.","name":"funcOrStackLevel","description":"Function or stack level to get info about. Defaults to stack level 0."},{"type":"number","value":"number index The index of the local to get","name":"index","description":"The index of the local to get"}],"class":"function","name":"getlocal","description":" GLua's debug.getlocal()\n Returns the name of a function or stack's locals"},"getinfo":{"path":"libs_sh/builtins.lua#L985","returns":[{"type":"table","value":"table DebugInfo table","description":"DebugInfo table"}],"realm":"shared","params":[{"type":"function|number","value":"function|number funcOrStackLevel Function or stack level to get info about. Defaults to stack level 0.","name":"funcOrStackLevel","description":"Function or stack level to get info about. Defaults to stack level 0."},{"type":"string?","value":"string? fields A string that specifies the information to be retrieved. Defaults to all (flnSu).","name":"fields","description":"A string that specifies the information to be retrieved. Defaults to all (flnSu)."}],"class":"function","name":"getinfo","description":" GLua's debug.getinfo()\n Returns a DebugInfo structure containing the passed function's info https://wiki.facepunch.com/gmod/Structures/DebugInfo"}},"tables":[],"path":"libs_sh/builtins.lua#L26","libtbl":["debug_library"],"realm":"shared","fields":[],"class":"library","name":"debug","description":" Lua debug library https://wiki.garrysmod.com/page/Category:debug"},"physenv":{"methods":{"getAirDensity":{"path":"libs_sh/physenv.lua#L15","returns":[{"type":"number","value":"number Air Density","description":"Air Density"}],"realm":"shared","class":"function","name":"getAirDensity","description":" Gets the air density."},"getPerformanceSettings":{"path":"libs_sh/physenv.lua#L27","returns":[{"type":"table","value":"table Performance Settings Table.","description":"Performance Settings Table."}],"realm":"shared","class":"function","name":"getPerformanceSettings","description":" Gets the performance settings.\n See http://wiki.facepunch.com/gmod/Structures/PhysEnvPerformanceSettings for table structure."},"getGravity":{"path":"libs_sh/physenv.lua#L21","returns":[{"type":"Vector","value":"Vector Gravity Vector ( eg Vector(0,0,-600) )","description":"Gravity Vector ( eg Vector(0,0,-600) )"}],"realm":"shared","class":"function","name":"getGravity","description":" Gets the gravity vector"}},"tables":[],"path":"libs_sh/physenv.lua#L3","libtbl":["physenv_lib"],"realm":"shared","fields":[],"class":"library","name":"physenv","description":" Physenv functions"},"find":{"methods":{"all":{"path":"libs_sh/find.lua#L183","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"shared","params":[{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"all","description":" Finds all entities"},"closest":{"path":"libs_sh/find.lua#L192","returns":[{"type":"Entity","value":"Entity The closest entity","description":"The closest entity"}],"realm":"shared","params":[{"type":"table","value":"table ents The array of entities","name":"ents","description":"The array of entities"},{"type":"Vector","value":"Vector pos The position","name":"pos","description":"The position"}],"class":"function","name":"closest","description":" Finds the closest entity to a point"},"byName":{"path":"libs_sh/find.lua#L139","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"shared","params":[{"type":"string","value":"string name The targetname","name":"name","description":"The targetname"},{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"byName","description":" Finds entities by their targetname"},"inSphere":{"path":"libs_sh/find.lua#L76","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"shared","params":[{"type":"Vector","value":"Vector center Center of the sphere","name":"center","description":"Center of the sphere"},{"type":"number","value":"number radius Sphere radius","name":"radius","description":"Sphere radius"},{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"inSphere","description":" Finds entities in a sphere"},"inRay":{"path":"libs_sh/find.lua#L107","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"shared","params":[{"type":"Vector","value":"Vector startpos The ray start","name":"startpos","description":"The ray start"},{"type":"Vector","value":"Vector endpos The ray end","name":"endpos","description":"The ray end"},{"type":"Vector?","value":"Vector? mins If not nil, will define a lower bound of the ray's hull","name":"mins","description":"If not nil, will define a lower bound of the ray's hull"},{"type":"Vector?","value":"Vector? maxs If not nil, will define a upper bound of the ray's hull","name":"maxs","description":"If not nil, will define a upper bound of the ray's hull"},{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"inRay","description":" Finds entities in a ray"},"allPlayers":{"path":"libs_sh/find.lua#L174","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"shared","params":[{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"allPlayers","description":" Finds all players (including bots)"},"inCone":{"path":"libs_sh/find.lua#L90","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"shared","params":[{"type":"Vector","value":"Vector pos The cone vertex position","name":"pos","description":"The cone vertex position"},{"type":"Vector","value":"Vector dir The direction to project the cone","name":"dir","description":"The direction to project the cone"},{"type":"number","value":"number distance The length to project the cone","name":"distance","description":"The length to project the cone"},{"type":"number","value":"number radius The cosine of angle of the cone. 1 makes a 0° cone, 0.707 makes approximately 90°, 0 makes 180°, and so on.","name":"radius","description":"The cosine of angle of the cone. 1 makes a 0° cone, 0.707 makes approximately 90°, 0 makes 180°, and so on."},{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"inCone","description":" Finds entities in a cone"},"inPVS":{"path":"libs_sh/find.lua#L162","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"server","params":[{"type":"Vector","value":"Vector pos Vector view point","name":"pos","description":"Vector view point"},{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"inPVS","description":" Finds entities that are in the PVS (Potentially Visible Set). See: https://developer.valvesoftware.com/wiki/PVS"},"inBox":{"path":"libs_sh/find.lua#L63","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"shared","params":[{"type":"Vector","value":"Vector min Bottom corner","name":"min","description":"Bottom corner"},{"type":"Vector","value":"Vector max Top corner","name":"max","description":"Top corner"},{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"inBox","description":" Finds entities in a box"},"sortByClosest":{"path":"libs_sh/find.lua#L211","returns":[{"type":"table","value":"table A table of the closest entities","description":"A table of the closest entities"}],"realm":"shared","params":[{"type":"table","value":"table ents The array of entities","name":"ents","description":"The array of entities"},{"type":"Vector","value":"Vector pos The position","name":"pos","description":"The position"},{"type":"boolean","value":"boolean furthest Whether to have the further entities first","name":"furthest","description":"Whether to have the further entities first"}],"class":"function","name":"sortByClosest","description":" Returns a sorted array of entities by how close they are to a point"},"playerBySteamID64":{"path":"libs_sh/find.lua#L280","returns":[{"type":"Player?","value":"Player? The player with matching steamid","description":"The player with matching steamid"}],"realm":"shared","params":[{"type":"string","value":"string steamid 64-bit steam id to search for","name":"steamid","description":"64-bit steam id to search for"}],"class":"function","name":"playerBySteamID64","description":" Finds the player with the given a 64-bit steamid. Returns nil if not found"},"getMapCreatedEntity":{"path":"libs_sh/find.lua#L288","returns":[{"type":"Entity?","value":"Entity? The found entity or nil if not found","description":"The found entity or nil if not found"}],"realm":"shared","params":[{"type":"number","value":"number num Entity's creation id","name":"num","description":"Entity's creation id"}],"class":"function","name":"getMapCreatedEntity","description":" Returns entity that has given Entity:mapCreationID."},"byClass":{"path":"libs_sh/find.lua#L128","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"shared","params":[{"type":"string","value":"string class The class name","name":"class","description":"The class name"},{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"byClass","description":" Finds entities by class name"},"byModel":{"path":"libs_sh/find.lua#L150","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"shared","params":[{"type":"string","value":"string model The model file","name":"model","description":"The model file"},{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"byModel","description":" Finds entities by model"},"playerBySteamID":{"path":"libs_sh/find.lua#L272","returns":[{"type":"Player?","value":"Player? The player with matching steamid","description":"The player with matching steamid"}],"realm":"shared","params":[{"type":"string","value":"string steamid Steam Id to search for","name":"steamid","description":"Steam Id to search for"}],"class":"function","name":"playerBySteamID","description":" Finds the player with the given a steamid. Returns nil if not found"},"playersByName":{"path":"libs_sh/find.lua#L235","returns":[{"type":"table","value":"table Table of found players","description":"Table of found players"}],"realm":"shared","params":[{"type":"string","value":"string name Name to search for","name":"name","description":"Name to search for"},{"type":"boolean?","value":"boolean? casesensitive Boolean should the match be case sensitive?","name":"casesensitive","description":"Boolean should the match be case sensitive?"},{"type":"boolean?","value":"boolean? exact Boolean should the name match exactly","name":"exact","description":"Boolean should the name match exactly"}],"class":"function","name":"playersByName","description":" Finds the first player with the given name"}},"tables":[],"path":"libs_sh/find.lua#L7","libtbl":["find_library"],"realm":"shared","fields":[],"class":"library","name":"find","description":" Find library. Finds entities in various shapes."},"particleEffect":{"methods":{"attach":{"path":"libs_cl/particle_effect.lua#L62","returns":[{"type":"ParticleEffect","value":"ParticleEffect ParticleEffect type.","description":"ParticleEffect type."}],"realm":"client","params":[{"type":"Entity","value":"Entity entity Entity to attach to","name":"entity","description":"Entity to attach to"},{"type":"string","value":"string name Name of the particle effect","name":"name","description":"Name of the particle effect"},{"type":"number","value":"number pattach PATTACH enum","name":"pattach","description":"PATTACH enum"},{"type":"table","value":"table options Table of options","name":"options","description":"Table of options"}],"class":"function","name":"attach","description":" Attaches a particleEffect to an entity."}},"tables":[],"path":"libs_cl/particle_effect.lua#L11","libtbl":["particleef_library"],"realm":"client","fields":[],"class":"library","name":"particleEffect","description":" ParticleEffect library."},"effect":{"methods":{"canCreate":{"path":"libs_sh/effect.lua#L57","returns":[{"type":"boolean","value":"boolean If an effect can be played","description":"If an effect can be played"}],"realm":"shared","class":"function","name":"canCreate","description":" Returns whether there are any effects able to be played"},"create":{"path":"libs_sh/effect.lua#L45","returns":[{"type":"Effect","value":"Effect Effect Object","description":"Effect Object"}],"realm":"shared","class":"function","name":"create","description":" Creates an effect data structure"},"effectsLeft":{"path":"libs_sh/effect.lua#L51","returns":[{"type":"number","value":"number Number of effects able to be created","description":"Number of effects able to be created"}],"realm":"shared","class":"function","name":"effectsLeft","description":" Returns number of effects able to be created"}},"tables":[],"path":"libs_sh/effect.lua#L17","libtbl":["effect_library"],"realm":"shared","fields":[],"class":"library","name":"effect","description":" Effects library."},"hologram":{"methods":{"removeAll":{"path":"libs_sh/hologram.lua#L562","realm":"shared","class":"function","name":"removeAll","description":" Removes all holograms created by the calling chip"},"canSpawn":{"path":"libs_sh/hologram.lua#L158","returns":[{"type":"boolean","value":"boolean True if user can spawn holograms, False if not.","description":"True if user can spawn holograms, False if not."}],"realm":"shared","class":"function","name":"canSpawn","description":" Checks if a user can spawn anymore holograms."},"create":{"path":"libs_sh/hologram.lua#L99","returns":[{"type":"Hologram","value":"Hologram The hologram object","description":"The hologram object"}],"realm":"shared","params":[{"type":"Vector","value":"Vector pos The position to create the hologram","name":"pos","description":"The position to create the hologram"},{"type":"Angle","value":"Angle ang The angle to create the hologram","name":"ang","description":"The angle to create the hologram"},{"type":"string","value":"string model The model to give the hologram","name":"model","description":"The model to give the hologram"},{"type":"Vector?","value":"Vector? scale (Optional) The scale to give the hologram","name":"scale","description":"(Optional) The scale to give the hologram"}],"class":"function","name":"create","description":" Creates a hologram."},"hologramsLeft":{"path":"libs_sh/hologram.lua#L165","returns":[{"type":"number","value":"number Number of holograms able to be spawned","description":"Number of holograms able to be spawned"}],"realm":"shared","class":"function","name":"hologramsLeft","description":" Checks how many holograms can be spawned"}},"tables":[],"path":"libs_sh/hologram.lua#L36","libtbl":["hologram_library"],"realm":"shared","fields":[],"class":"library","name":"hologram","description":" Library for creating and manipulating physics-less models AKA \"Holograms\"."},"navmesh":{"methods":{"clearWalkableSeeds":{"path":"libs_sv/navmesh.lua#L108","realm":"server","class":"function","name":"clearWalkableSeeds","description":" Clears all the walkable positions, used before calling navmesh.beginGeneration.\n Requires the `navmesh.modify` permission"},"find":{"path":"libs_sv/navmesh.lua#L175","returns":[{"type":"table","value":"table A table of immutable `NavArea`s","description":"A table of immutable `NavArea`s"}],"realm":"server","params":[{"type":"Vector","value":"Vector pos The position to search around","name":"pos","description":"The position to search around"},{"type":"number","value":"number radius Radius to search within (max 100000)","name":"radius","description":"Radius to search within (max 100000)"},{"type":"number","value":"number stepdown Maximum fall distance allowed (max 50000)","name":"stepdown","description":"Maximum fall distance allowed (max 50000)"},{"type":"number","value":"number stepup Maximum jump height allowed (max 50000)","name":"stepup","description":"Maximum jump height allowed (max 50000)"}],"class":"function","name":"find","description":" Returns a bunch of areas within distance, used to find hiding spots by NextBots for example."},"setMarkedArea":{"path":"libs_sv/navmesh.lua#L127","realm":"server","params":[{"type":"NavArea","value":"NavArea area The CNavArea to set as the marked area.","name":"area","description":"The CNavArea to set as the marked area."}],"class":"function","name":"setMarkedArea","description":" Sets the CNavArea as marked, so it can be used with editing console commands.\n Requires the `navmesh.modify` permission"},"isLoaded":{"path":"libs_sv/navmesh.lua#L72","returns":[{"type":"boolean","value":"boolean Whether a navmesh has been loaded when loading the map.","description":"Whether a navmesh has been loaded when loading the map."}],"realm":"server","class":"function","name":"isLoaded","description":" Returns true if a navmesh has been loaded when loading the map."},"save":{"path":"libs_sv/navmesh.lua#L92","realm":"server","class":"function","name":"save","description":" Saves any changes made to navmesh to the .nav file.\n Requires the 'navmesh.save' privilege"},"getNavAreaCount":{"path":"libs_sv/navmesh.lua#L197","returns":[{"type":"number","value":"number The highest ID of all nav areas on the map.","description":"The highest ID of all nav areas on the map."}],"realm":"server","class":"function","name":"getNavAreaCount","description":" Returns the highest ID of all nav areas on the map.\n While this can be used to get all nav areas, this number may not actually be the actual number of nav areas on the map."},"reset":{"path":"libs_sv/navmesh.lua#L85","realm":"server","class":"function","name":"reset","description":" Deletes every NavArea and NavLadder on the map without saving the changes.\n Requires the 'navmesh.reset' privilege"},"getGetEditCursorPosition":{"path":"libs_sv/navmesh.lua#L233","returns":[{"type":"Vector","value":"Vector The position of the edit cursor.","description":"The position of the edit cursor."}],"realm":"server","class":"function","name":"getGetEditCursorPosition","description":" Returns the position of the edit cursor when nav_edit is set to 1."},"getNearestNavArea":{"path":"libs_sv/navmesh.lua#L221","returns":[{"type":"NavArea","value":"NavArea The closest NavArea found with the given parameters, or a NULL NavArea if one was not found.","description":"The closest NavArea found with the given parameters, or a NULL NavArea if one was not found."}],"realm":"server","params":[{"type":"Vector","value":"Vector pos The position to look from","name":"pos","description":"The position to look from"},{"type":"number","value":"number maxDist Maximum distance from the given position that the function will look for a CNavArea (Default 10000)","name":"maxDist","description":"Maximum distance from the given position that the function will look for a CNavArea (Default 10000)"},{"type":"boolean","value":"boolean checkLOS If this is set to true then the function will internally do a trace from the starting position to each potential CNavArea with a MASK_NPCSOLID_BRUSHONLY. If the trace fails then the CNavArea is ignored. If this is set to false then the function will find the closest CNavArea through anything, including the world. (Default false)","name":"checkLOS","description":"If this is set to true then the function will internally do a trace from the starting position to each potential CNavArea with a MASK_NPCSOLID_BRUSHONLY. If the trace fails then the CNavArea is ignored. If this is set to false then the function will find the closest CNavArea through anything, including the world. (Default false)"},{"type":"boolean","value":"boolean checkGround If checkGround is true then this function will internally call navmesh.getNavArea to check if there is a CNavArea directly below the position, and return it if so, before checking anywhere else. (Default true)","name":"checkGround","description":"If checkGround is true then this function will internally call navmesh.getNavArea to check if there is a CNavArea directly below the position, and return it if so, before checking anywhere else. (Default true)"}],"class":"function","name":"getNearestNavArea","description":" Returns the closest NavArea to given position at the same height, or beneath it.\n This function will ignore blocked NavAreas.\n See navmesh.getNavArea for a function that does see blocked areas."},"getPlayerSpawnName":{"path":"libs_sv/navmesh.lua#L121","returns":[{"type":"string","value":"string The classname of the spawn point entity. By default returns \"info_player_start\"","description":"The classname of the spawn point entity. By default returns \"info_player_start\""}],"realm":"server","class":"function","name":"getPlayerSpawnName","description":" Returns the classname of the player spawn entity."},"getMarkedArea":{"path":"libs_sv/navmesh.lua#L115","returns":[{"type":"NavArea","value":"NavArea The currently marked NavArea.","description":"The currently marked NavArea."}],"realm":"server","class":"function","name":"getMarkedArea","description":" Returns the currently marked NavArea, for use with editing console commands."},"isGenerating":{"path":"libs_sv/navmesh.lua#L66","returns":[{"type":"boolean","value":"boolean Whether we're generating a nav mesh or not.","description":"Whether we're generating a nav mesh or not."}],"realm":"server","class":"function","name":"isGenerating","description":" Whether we're currently generating a new navmesh with navmesh.beginGeneration"},"getNavAreaByID":{"path":"libs_sv/navmesh.lua#L204","returns":[{"type":"NavArea","value":"NavArea The NavArea with given ID.","description":"The NavArea with given ID."}],"realm":"server","params":[{"type":"number","value":"number id ID of the NavArea to get. Starts with 1.","name":"id","description":"ID of the NavArea to get. Starts with 1."}],"class":"function","name":"getNavAreaByID","description":" Returns the NavArea at the given id."},"load":{"path":"libs_sv/navmesh.lua#L78","realm":"server","class":"function","name":"load","description":" Loads a new navmesh from the .nav file for current map discarding any changes made to the navmesh previously.\n Requires the 'navmesh.load' privilege"},"beginGeneration":{"path":"libs_sv/navmesh.lua#L60","realm":"server","class":"function","name":"beginGeneration","description":" Starts the generation of a new navmesh"},"getNavArea":{"path":"libs_sv/navmesh.lua#L212","returns":[{"type":"NavArea","value":"NavArea The NavArea.","description":"The NavArea."}],"realm":"server","params":[{"type":"Vector","value":"Vector pos The position to search for.","name":"pos","description":"The position to search for."},{"type":"number","value":"number limit The elevation limit at which the NavArea will be searched.","name":"limit","description":"The elevation limit at which the NavArea will be searched."}],"class":"function","name":"getNavArea","description":" Returns the NavArea contained in this position that also satisfies the elevation limit."},"addWalkableSeed":{"path":"libs_sv/navmesh.lua#L99","realm":"server","params":[{"type":"Vector","value":"Vector pos The terrain position.","name":"pos","description":"The terrain position."},{"type":"Vector","value":"Vector normal The terrain normal.","name":"normal","description":"The terrain normal."}],"class":"function","name":"addWalkableSeed","description":" Add this position and normal to the list of walkable positions, used before map generation with navmesh.beginGeneration\n Requires the `navmesh.modify` permission"},"setPlayerSpawnName":{"path":"libs_sv/navmesh.lua#L135","realm":"server","params":[{"type":"string","value":"string spawnPointClass The classname of what the player uses to spawn, automatically adds it to the walkable positions during map generation.","name":"spawnPointClass","description":"The classname of what the player uses to spawn, automatically adds it to the walkable positions during map generation."}],"class":"function","name":"setPlayerSpawnName","description":" Sets the classname of the default spawn point entity, used before generating a new navmesh with navmesh.beginGeneration."},"createNavArea":{"path":"libs_sv/navmesh.lua#L143","returns":[{"type":"NavArea?","value":"NavArea? The new NavArea or nil if we failed for some reason","description":"The new NavArea or nil if we failed for some reason"}],"realm":"server","params":[{"type":"Vector","value":"Vector corner The first corner of the new NavArea","name":"corner","description":"The first corner of the new NavArea"},{"type":"Vector","value":"Vector opposite_corner The opposite (diagonally) corner of the new NavArea","name":"opposite_corner","description":"The opposite (diagonally) corner of the new NavArea"}],"class":"function","name":"createNavArea","description":" Creates a new NavArea"},"getAllNavAreas":{"path":"libs_sv/navmesh.lua#L163","returns":[{"type":"table","value":"table A table of all the `NavArea`s on the current map","description":"A table of all the `NavArea`s on the current map"}],"realm":"server","class":"function","name":"getAllNavAreas","description":" Returns an integer indexed table of all `NavArea`s on the current map.\n If the map doesn't have a navmesh generated then this will return an empty table.\n The navareas will be immutable."}},"tables":{"NAV_MESH":{"path":"libs_sh/enum.lua#L1254","fields":[{"name":"INVALID","description":"The nav area is invalid."},{"name":"CROUCH","description":"Must crouch to use this node/area"},{"name":"JUMP","description":"Must jump to traverse this area (only used during generation)"},{"name":"PRECISE","description":"Do not adjust for obstacles, just move along area"},{"name":"NO_JUMP","description":"Inhibit discontinuity jumping"},{"name":"STOP","description":"Must stop when entering this area"},{"name":"RUN","description":"Must run to traverse this area"},{"name":"WALK","description":"Must walk to traverse this area"},{"name":"AVOID","description":"Avoid this area unless alternatives are too dangerous"},{"name":"TRANSIENT","description":"Area may become blocked, and should be periodically checked"},{"name":"DONT_HIDE","description":"Area should not be considered for hiding spot generation"},{"name":"STAND","description":"Bots hiding in this area should stand"},{"name":"NO_HOSTAGES","description":"Hostages shouldn't use this area"},{"name":"STAIRS","description":"This area represents stairs, do not attempt to climb or jump them - just walk up"},{"name":"NO_MERGE","description":"Don't merge this area with adjacent areas"},{"name":"OBSTACLE_TOP","description":"This nav area is the climb point on the tip of an obstacle"},{"name":"CLIFF","description":"This nav area is adjacent to a drop of at least CliffHeight"},{"name":"FUNC_COST","description":"Area has designer specified cost controlled by func_nav_cost entities"},{"name":"HAS_ELEVATOR","description":"Area is in an elevator's path"},{"name":"NAV_BLOCKER","description":"-2147483648"}],"realm":"shared","class":"table","name":"NAV_MESH","description":" ENUMs used by NavArea:getAttributes and NavArea:hasAttributes"},"NAV_CORNER":{"path":"libs_sh/enum.lua#L1300","fields":[{"name":"NORTH_WEST","description":"0"},{"name":"NORTH_EAST","description":"1"},{"name":"SOUTH_EAST","description":"2"},{"name":"SOUTH_WEST","description":"3"},{"name":"NUM_CORNERS","description":"Represents all corners, only applicable to certain functions, such as NavArea:placeOnGround."}],"realm":"shared","class":"table","name":"NAV_CORNER","description":" ENUMs used by NavArea methods. These Enums correspond to each corner of a CNavArea"},"NAV_DIR":{"path":"libs_sh/enum.lua#L1240","fields":[{"name":"NORTH","description":"0"},{"name":"SOUTH","description":"1"},{"name":"EAST","description":"2"},{"name":"WEST","description":"3"}],"realm":"shared","class":"table","name":"NAV_DIR","description":" NavArea direction ENUMs"},"NAV_TRAVERSE_TYPE":{"path":"libs_sh/enum.lua#L1316","fields":[{"name":"GO_NORTH","description":"0"},{"name":"GO_EAST","description":"1"},{"name":"GO_SOUTH","description":"2"},{"name":"GO_WEST","description":"3"},{"name":"GO_LADDER_UP","description":"4"},{"name":"GO_LADDER_DOWN","description":"5"},{"name":"GO_JUMP","description":"6"},{"name":"GO_ELEVATOR_UP","description":"7"},{"name":"GO_ELEVATOR_DOWN","description":"8"}],"realm":"shared","class":"table","name":"NAV_TRAVERSE_TYPE","description":" ENUMs used by NavArea:getParentHow."}},"path":"libs_sv/navmesh.lua#L17","libtbl":["navmesh_library"],"realm":"server","fields":[],"class":"library","name":"navmesh","description":" Library for navmesh navigation with the NavArea type"},"json":{"methods":{"decode":{"path":"libs_sh/json.lua#L23","returns":[{"type":"table","value":"table Table representing the JSON object","description":"Table representing the JSON object"}],"realm":"shared","params":[{"type":"string","value":"string s String to decode","name":"s","description":"String to decode"}],"class":"function","name":"decode","description":" Convert JSON string to table"},"encode":{"path":"libs_sh/json.lua#L14","returns":[{"type":"string","value":"string JSON encoded string representation of the table","description":"JSON encoded string representation of the table"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to encode","name":"tbl","description":"Table to encode"},{"type":"boolean?","value":"boolean? prettyPrint Optional. If true, formats and indents the resulting JSON","name":"prettyPrint","description":"Optional. If true, formats and indents the resulting JSON"}],"class":"function","name":"encode","description":" Convert table to JSON string"}},"tables":[],"path":"libs_sh/json.lua#L4","libtbl":["json_library"],"realm":"shared","fields":[],"class":"library","name":"json","description":" JSON library"},"sql":{"methods":{"query":{"path":"libs_cl/sql.lua#L17","returns":[{"type":"table?","value":"table? Query results as a table, nil if the query returned no data.","description":"Query results as a table, nil if the query returned no data."}],"realm":"client","params":[{"type":"string","value":"string query The query to execute.","name":"query","description":"The query to execute."}],"class":"function","name":"query","description":" Performs a query on the local SQLite database."},"SQLStr":{"path":"libs_cl/sql.lua#L54","returns":[{"type":"string","value":"string The escaped input.","description":"The escaped input."}],"realm":"client","params":[{"type":"string","value":"string str The string to be escaped.","name":"str","description":"The string to be escaped."},{"type":"boolean","value":"boolean bNoQuotes Set this as true, and the function will not wrap the input string in apostrophes.","name":"bNoQuotes","description":"Set this as true, and the function will not wrap the input string in apostrophes."}],"class":"function","name":"SQLStr","description":" Escapes dangerous characters and symbols from user input used in an SQLite SQL Query."},"tableExists":{"path":"libs_cl/sql.lua#L32","returns":[{"type":"boolean","value":"boolean False if the table does not exist, true if it does.","description":"False if the table does not exist, true if it does."}],"realm":"client","params":[{"type":"string","value":"string tabname The table to check for.","name":"tabname","description":"The table to check for."}],"class":"function","name":"tableExists","description":" Checks if a table exists within the local SQLite database."},"tableRemove":{"path":"libs_cl/sql.lua#L42","returns":[{"type":"boolean","value":"boolean True if the table was successfully removed, false if not.","description":"True if the table was successfully removed, false if not."}],"realm":"client","params":[{"type":"string","value":"string tabname The table to remove.","name":"tabname","description":"The table to remove."}],"class":"function","name":"tableRemove","description":" Removes a table within the local SQLite database."}},"tables":[],"path":"libs_cl/sql.lua#L5","libtbl":["sql_library"],"realm":"client","fields":[],"class":"library","name":"sql","description":" SQL library."},"light":{"methods":{"create":{"path":"libs_cl/light.lua#L117","returns":[{"type":"Light","value":"Light Dynamic light","description":"Dynamic light"}],"realm":"client","params":[{"type":"Vector","value":"Vector pos The position of the light","name":"pos","description":"The position of the light"},{"type":"number","value":"number size The size of the light. Must be lower than sf_light_maxsize","name":"size","description":"The size of the light. Must be lower than sf_light_maxsize"},{"type":"number","value":"number brightness The brightness of the light","name":"brightness","description":"The brightness of the light"},{"type":"Color","value":"Color color The color of the light","name":"color","description":"The color of the light"}],"class":"function","name":"create","description":" Creates a dynamic light (make sure to draw it)"}},"tables":[],"path":"libs_cl/light.lua#L74","libtbl":["light_library"],"realm":"client","fields":[],"class":"library","name":"light","description":" Light library."},"joystick":{"methods":{"numJoysticks":{"path":"libs_cl/joystick.lua#L60","returns":[{"type":"number","value":"number Number of joysticks","description":"Number of joysticks"}],"realm":"client","class":"function","name":"numJoysticks","description":" Gets the number of detected joysticks."},"numButtons":{"path":"libs_cl/joystick.lua#L82","returns":[{"type":"number","value":"number Number of buttons","description":"Number of buttons"}],"realm":"client","params":[{"type":"number","value":"number enum Joystick number. Starts at 0","name":"enum","description":"Joystick number. Starts at 0"}],"class":"function","name":"numButtons","description":" Gets the number of detected buttons on a joystick"},"numPovs":{"path":"libs_cl/joystick.lua#L74","returns":[{"type":"number","value":"number Number of povs","description":"Number of povs"}],"realm":"client","params":[{"type":"number","value":"number enum Joystick number. Starts at 0","name":"enum","description":"Joystick number. Starts at 0"}],"class":"function","name":"numPovs","description":" Gets the number of detected povs on a joystick"},"numAxes":{"path":"libs_cl/joystick.lua#L66","returns":[{"type":"number","value":"number Number of axes","description":"Number of axes"}],"realm":"client","params":[{"type":"number","value":"number enum Joystick number. Starts at 0","name":"enum","description":"Joystick number. Starts at 0"}],"class":"function","name":"numAxes","description":" Gets the number of detected axes on a joystick"},"getAxis":{"path":"libs_cl/joystick.lua#L25","returns":[{"type":"number","value":"number 0 - 65535 where 32767 is the middle.","description":"0 - 65535 where 32767 is the middle."}],"realm":"client","params":[{"type":"number","value":"number enum Joystick number. Starts at 0","name":"enum","description":"Joystick number. Starts at 0"},{"type":"number","value":"number axis Joystick axis number. Ranges from 0 to 7.","name":"axis","description":"Joystick axis number. Ranges from 0 to 7."}],"class":"function","name":"getAxis","description":" Gets the axis data value."},"getButton":{"path":"libs_cl/joystick.lua#L43","returns":[{"type":"number","value":"number 0 or 1","description":"0 or 1"}],"realm":"client","params":[{"type":"number","value":"number enum Joystick number. Starts at 0","name":"enum","description":"Joystick number. Starts at 0"},{"type":"number","value":"number button Joystick button number. Starts at 0","name":"button","description":"Joystick button number. Starts at 0"}],"class":"function","name":"getButton","description":" Returns if the button is pushed or not"},"getName":{"path":"libs_cl/joystick.lua#L52","returns":[{"type":"string","value":"string Name of the device","description":"Name of the device"}],"realm":"client","params":[{"type":"number","value":"number enum Joystick number. Starts at 0","name":"enum","description":"Joystick number. Starts at 0"}],"class":"function","name":"getName","description":" Gets the hardware name of the joystick"},"getPov":{"path":"libs_cl/joystick.lua#L34","returns":[{"type":"number","value":"number 0 - 65535 where 32767 is the middle.","description":"0 - 65535 where 32767 is the middle."}],"realm":"client","params":[{"type":"number","value":"number enum Joystick number. Starts at 0","name":"enum","description":"Joystick number. Starts at 0"},{"type":"number","value":"number pov Joystick pov number. Ranges from 0 to 7.","name":"pov","description":"Joystick pov number. Ranges from 0 to 7."}],"class":"function","name":"getPov","description":" Gets the pov data value."}},"tables":[],"path":"libs_cl/joystick.lua#L14","libtbl":["joystick_library"],"realm":"client","fields":[],"class":"library","name":"joystick","description":" Joystick library."},"notification":{"methods":{"addProgress":{"path":"libs_cl/notification.lua#L51","realm":"client","params":[{"type":"string","value":"string id String index of the notification","name":"id","description":"String index of the notification"},{"type":"string","value":"string text The text to display","name":"text","description":"The text to display"},{"type":"number?","value":"number? progress An optional progress val 0-1 indicating progress.","name":"progress","description":"An optional progress val 0-1 indicating progress."}],"class":"function","name":"addProgress","description":" Displays a notification with an animated progress bar, will persist unless killed or chip is removed."},"kill":{"path":"libs_cl/notification.lua#L84","realm":"client","params":[{"type":"string","value":"string id String index of the notification to kill","name":"id","description":"String index of the notification to kill"}],"class":"function","name":"kill","description":" Removes the notification with the given index after 0.8 seconds"},"addLegacy":{"path":"libs_cl/notification.lua#L28","realm":"client","params":[{"type":"string","value":"string text The text to display","name":"text","description":"The text to display"},{"type":"number","value":"number type Determines the notification method.","name":"type","description":"Determines the notification method."},{"type":"number","value":"number length Time in seconds to display the notification (Max length of 30)","name":"length","description":"Time in seconds to display the notification (Max length of 30)"}],"class":"function","name":"addLegacy","description":" Displays a standard notification.\nNOTIFY.GENERIC\nNOTIFY.ERROR\nNOTIFY.UNDO\nNOTIFY.HINT\nNOTIFY.CLEANUP"}},"tables":[],"path":"libs_cl/notification.lua#L9","libtbl":["notification_library"],"realm":"client","fields":[],"class":"library","name":"notification","description":" Notification library. Allows the user to display hints on the bottom right of their screen"},"math":{"methods":{"ceil":{"path":"libs_sh/math.lua#L96","returns":[{"type":"number","value":"number Rounded number","description":"Rounded number"}],"realm":"shared","params":[{"type":"number","value":"number n Number to be rounded","name":"n","description":"Number to be rounded"}],"class":"function","name":"ceil","description":" Rounds a number up."},"tan":{"path":"libs_sh/math.lua#L296","returns":[{"type":"number","value":"number The tangent of the given angle","description":"The tangent of the given angle"}],"realm":"shared","params":[{"type":"number","value":"number ang Angle in radians","name":"ang","description":"Angle in radians"}],"class":"function","name":"tan","description":" Calculates the tangent of the given angle."},"lerp":{"path":"libs_sh/math.lua#L333","returns":[{"type":"number","value":"number The result of the linear interpolation, (1 - t) * from + t * to","description":"The result of the linear interpolation, (1 - t) * from + t * to"}],"realm":"shared","params":[{"type":"number","value":"number t The fraction for finding the result. This number is clamped between 0 and 1","name":"t","description":"The fraction for finding the result. This number is clamped between 0 and 1"},{"type":"number","value":"number from The starting number. The result will be equal to this if value t is 0","name":"from","description":"The starting number. The result will be equal to this if value t is 0"},{"type":"number","value":"number to The ending number. The result will be equal to this if value t is 1","name":"to","description":"The ending number. The result will be equal to this if value t is 1"}],"class":"function","name":"lerp","description":" Performs a linear interpolation from the start number to the end number."},"sinh":{"path":"libs_sh/math.lua#L284","returns":[{"type":"number","value":"number The hyperbolic sine of the given angle","description":"The hyperbolic sine of the given angle"}],"realm":"shared","params":[{"type":"number","value":"number ang Angle in radians","name":"ang","description":"Angle in radians"}],"class":"function","name":"sinh","description":" Calculates the hyperbolic sine of the given angle."},"approach":{"path":"libs_sh/math.lua#L46","returns":[{"type":"number","value":"number New current value, closer to the target than it was previously","description":"New current value, closer to the target than it was previously"}],"realm":"shared","params":[{"type":"number","value":"number current The value we're currently at","name":"current","description":"The value we're currently at"},{"type":"number","value":"number target The target value. This function will never overshoot this value","name":"target","description":"The target value. This function will never overshoot this value"},{"type":"number","value":"number change The amount that the current value is allowed to change by to approach the target (positive or negative)","name":"change","description":"The amount that the current value is allowed to change by to approach the target (positive or negative)"}],"class":"function","name":"approach","description":" Gradually approaches the target value by the specified amount."},"distance":{"path":"libs_sh/math.lua#L128","returns":[{"type":"number","value":"number Distance between the two points","description":"Distance between the two points"}],"realm":"shared","params":[{"type":"number","value":"number x1 X position of first point","name":"x1","description":"X position of first point"},{"type":"number","value":"number y1 Y position of first point","name":"y1","description":"Y position of first point"},{"type":"number","value":"number x2 X position of second point","name":"x2","description":"X position of second point"},{"type":"number","value":"number y2 Y position of second point","name":"y2","description":"Y position of second point"}],"class":"function","name":"distance","description":" Calculates the difference between two points in 2D space"},"truncate":{"path":"libs_sh/math.lua#L316","returns":[{"type":"number","value":"number Rounded number","description":"Rounded number"}],"realm":"shared","params":[{"type":"number","value":"number val The number to truncate","name":"val","description":"The number to truncate"},{"type":"number?","value":"number? digits The amount of digits to keep after the point. Default 0","name":"digits","description":"The amount of digits to keep after the point. Default 0"}],"class":"function","name":"truncate","description":" Rounds towards zero"},"easeInOutBack":{"path":"libs_sh/math.lua#L470","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutBack","description":" Eases in and out by reversing the direction of the ease slightly before returning on both ends."},"easeInExpo":{"path":"libs_sh/math.lua#L464","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInExpo","description":" Eases in using an exponential equation with a base of 2 and where the fraction is used in the exponent."},"min":{"path":"libs_sh/math.lua#L206","returns":[{"type":"number","value":"number The smallest number","description":"The smallest number"}],"realm":"shared","params":[{"type":"...number","value":"...number numbers Any amount of number values","name":"numbers","description":"Any amount of number values"}],"class":"function","name":"min","description":" Picks the smallest value of all provided arguments."},"frexp":{"path":"libs_sh/math.lua#L164","returns":[{"type":"number","value":"number Multiplier between 0.5 and 1","description":"Multiplier between 0.5 and 1"},{"type":"number","value":"number Exponent integer","description":"Exponent integer"}],"realm":"shared","params":[{"type":"number","value":"number x The value to get the normalized fraction and the exponent from","name":"x","description":"The value to get the normalized fraction and the exponent from"}],"class":"function","name":"frexp","description":" Used to split the number value into a normalized fraction and an exponent"},"easeInOutExpo":{"path":"libs_sh/math.lua#L500","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutExpo","description":" Eases in and out using an exponential equation with a base of 2 and where the fraction is used in the exponent."},"easeInOutCubic":{"path":"libs_sh/math.lua#L488","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutCubic","description":" Eases in and out by cubing the fraction."},"sin":{"path":"libs_sh/math.lua#L278","returns":[{"type":"number","value":"number Sine for given angle","description":"Sine for given angle"}],"realm":"shared","params":[{"type":"number","value":"number ang Angle in radians","name":"ang","description":"Angle in radians"}],"class":"function","name":"sin","description":" Calculates the sine of given angle."},"easeInBack":{"path":"libs_sh/math.lua#L434","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInBack","description":" Eases in by reversing the direction of the ease slightly before returning."},"lerpVector":{"path":"libs_sh/math.lua#L357","returns":[{"type":"Vector","value":"Vector The interpolated vector","description":"The interpolated vector"}],"realm":"shared","params":[{"type":"number","value":"number ratio Ratio of progress through values","name":"ratio","description":"Ratio of progress through values"},{"type":"Vector","value":"Vector from Vector to begin from","name":"from","description":"Vector to begin from"},{"type":"Vector","value":"Vector Vector to end at","name":"Vector","description":"to end at"}],"class":"function","name":"lerpVector","description":" Calculates point between first and second vector using given fraction and linear interpolation."},"easeInBounce":{"path":"libs_sh/math.lua#L440","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInBounce","description":" Eases in like a bouncy ball."},"bSplinePoint":{"path":"libs_sh/math.lua#L323","returns":[{"type":"number","value":"number Point on Bezier curve, related to tDiff","description":"Point on Bezier curve, related to tDiff"}],"realm":"shared","params":[{"type":"number","value":"number tDiff From 0 to tMax, where alongside the spline the point will be","name":"tDiff","description":"From 0 to tMax, where alongside the spline the point will be"},{"type":"number","value":"number tPoints A table of Vectors. The amount cannot be less than 4","name":"tPoints","description":"A table of Vectors. The amount cannot be less than 4"},{"type":"number","value":"number tMax Dictates maximum value for tDiff","name":"tMax","description":"Dictates maximum value for tDiff"}],"class":"function","name":"bSplinePoint","description":" Calculates B-Spline point."},"easeInQuint":{"path":"libs_sh/math.lua#L542","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInQuint","description":" Eases in by raising the fraction to the power of 5."},"easeInCirc":{"path":"libs_sh/math.lua#L446","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInCirc","description":" Eases in using a circular function."},"tanh":{"path":"libs_sh/math.lua#L302","returns":[{"type":"number","value":"number The hyperbolic tangent of the given angle","description":"The hyperbolic tangent of the given angle"}],"realm":"shared","params":[{"type":"number","value":"number ang Angle in radians","name":"ang","description":"Angle in radians"}],"class":"function","name":"tanh","description":" Calculates hyperbolic tangent of the given angle."},"easeInQuart":{"path":"libs_sh/math.lua#L536","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInQuart","description":" Eases in by raising the fraction to the power of 4."},"pow":{"path":"libs_sh/math.lua#L227","returns":[{"type":"number","value":"number Exponent power of base","description":"Exponent power of base"}],"realm":"shared","params":[{"type":"number","value":"number base The Base number","name":"base","description":"The Base number"},{"type":"number","value":"number exp The Exponent","name":"exp","description":"The Exponent"}],"class":"function","name":"pow","description":" Returns x raised to the power y"},"easeInOutSine":{"path":"libs_sh/math.lua#L524","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutSine","description":" Eases in and out using math.sin."},"acos":{"path":"libs_sh/math.lua#L33","returns":[{"type":"number","value":"number Angle in radians or nothing if the argument is out of range","description":"Angle in radians or nothing if the argument is out of range"}],"realm":"shared","params":[{"type":"number","value":"number cos Cosine value in range of -1 to 1","name":"cos","description":"Cosine value in range of -1 to 1"}],"class":"function","name":"acos","description":" Calculates an angle in radians, between 0 and pi, which has the given cos value."},"distanceToLine":{"path":"libs_sh/math.lua#L368","returns":[{"type":"number","value":"number Distance from line","description":"Distance from line"},{"type":"Vector","value":"Vector Nearest point on line","description":"Nearest point on line"},{"type":"number","value":"number Distance along line from start","description":"Distance along line from start"}],"realm":"shared","params":[{"type":"Vector","value":"Vector lineStart Start of the line","name":"lineStart","description":"Start of the line"},{"type":"Vector","value":"Vector lineEnd End of the line","name":"lineEnd","description":"End of the line"},{"type":"Vector","value":"Vector pointPos Position of the point","name":"pointPos","description":"Position of the point"}],"class":"function","name":"distanceToLine","description":" Gets the distance between a line and a point in 3d space"},"normalizeAngle":{"path":"libs_sh/math.lua#L219","returns":[{"type":"number","value":"number The normalized angle","description":"The normalized angle"}],"realm":"shared","params":[{"type":"number","value":"number ang The angle in degrees","name":"ang","description":"The angle in degrees"}],"class":"function","name":"normalizeAngle","description":" Normalizes angle, so it returns value between -180 and 180."},"timeFraction":{"path":"libs_sh/math.lua#L308","returns":[{"type":"number","value":"number The time fraction","description":"The time fraction"}],"realm":"shared","params":[{"type":"number","value":"number start Start time in seconds","name":"start","description":"Start time in seconds"},{"type":"number","value":"number end End time in seconds","name":"end","description":"End time in seconds"},{"type":"number","value":"number current Current time in seconds","name":"current","description":"Current time in seconds"}],"class":"function","name":"timeFraction","description":" Calculates the fraction of where the current time is relative to the start and end times."},"factorial":{"path":"libs_sh/math.lua#L234","returns":[{"type":"number","value":"number Factorial of value","description":"Factorial of value"}],"realm":"shared","params":[{"type":"number","value":"number value The number value","name":"value","description":"The number value"}],"class":"function","name":"factorial","description":" Returns factorial of given value"},"log10":{"path":"libs_sh/math.lua#L194","returns":[{"type":"number","value":"number Logarithm of x to the base 10","description":"Logarithm of x to the base 10"}],"realm":"shared","params":[{"type":"number","value":"number x The value to get the base from exponent from","name":"x","description":"The value to get the base from exponent from"}],"class":"function","name":"log10","description":" Returns the base-10 logarithm of x. This is usually more accurate than math.log(x, 10)."},"sign":{"path":"libs_sh/math.lua#L25","returns":[{"type":"number","value":"number -1 if negative, 1 if positive, 0 if 0","description":"-1 if negative, 1 if positive, 0 if 0"}],"realm":"shared","params":[{"type":"number","value":"number x The number to get the sign of","name":"x","description":"The number to get the sign of"}],"class":"function","name":"sign","description":" Calculates the sign of a number"},"easeInOutCirc":{"path":"libs_sh/math.lua#L482","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutCirc","description":" Eases in and out using a circular function."},"round":{"path":"libs_sh/math.lua#L272","realm":"shared","params":[{"type":"number","value":"number value The number to be rounded","name":"value","description":"The number to be rounded"},{"type":"number?","value":"number? decimals Optional decimal places to round to. Defaults to 0","name":"decimals","description":"Optional decimal places to round to. Defaults to 0"}],"class":"function","name":"round","description":" Rounds the given value to the nearest whole number or to the given decimal places."},"easeInOutQuint":{"path":"libs_sh/math.lua#L518","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutQuint","description":" Eases in and out by raising the fraction to the power of 5."},"ldexp":{"path":"libs_sh/math.lua#L179","returns":[{"type":"number","value":"number Floating point reperesentation","description":"Floating point reperesentation"}],"realm":"shared","params":[{"type":"number","value":"number normalizedFraction The value to get the normalized fraction and the exponent from","name":"normalizedFraction","description":"The value to get the normalized fraction and the exponent from"},{"type":"number","value":"number exponent The value to get the normalized fraction and the exponent from","name":"exponent","description":"The value to get the normalized fraction and the exponent from"}],"class":"function","name":"ldexp","description":" Takes a normalised number and returns the floating point representation."},"deg":{"path":"libs_sh/math.lua#L122","returns":[{"type":"number","value":"number Angle in degrees","description":"Angle in degrees"}],"realm":"shared","params":[{"type":"number","value":"number rad Angle in radians to be converted","name":"rad","description":"Angle in radians to be converted"}],"class":"function","name":"deg","description":" Converts radians to degrees"},"nlerpQuaternion":{"path":"libs_sh/quaternion.lua#L875","returns":[{"type":"Quaternion","value":"Quaternion Interpolated quaternion","description":"Interpolated quaternion"}],"realm":"shared","params":[{"type":"Quaternion","value":"Quaternion quat1 Quaternion to start with","name":"quat1","description":"Quaternion to start with"},{"type":"Quaternion","value":"Quaternion quat2 Quaternion to end with","name":"quat2","description":"Quaternion to end with"},{"type":"number","value":"number t Ratio, 0 = quat1; 1 = quat2","name":"t","description":"Ratio, 0 = quat1; 1 = quat2"}],"class":"function","name":"nlerpQuaternion","description":" Performs normalized linear interpolation between two quaternions"},"intToBin":{"path":"libs_sh/math.lua#L173","returns":[{"type":"string","value":"string Binary number string. The length of this will always be a multiple of 3","description":"Binary number string. The length of this will always be a multiple of 3"}],"realm":"shared","params":[{"type":"number","value":"number int Number to be converted","name":"int","description":"Number to be converted"}],"class":"function","name":"intToBin","description":" Converts an integer to a binary (base-2) string."},"rand":{"path":"libs_sh/math.lua#L246","returns":[{"type":"number","value":"number Random float between min and max","description":"Random float between min and max"}],"realm":"shared","params":[{"type":"number","value":"number min The minimum value","name":"min","description":"The minimum value"},{"type":"number","value":"number max The maximum value","name":"max","description":"The maximum value"}],"class":"function","name":"rand","description":" Returns a random float between min and max."},"atan2":{"path":"libs_sh/math.lua#L74","returns":[{"type":"number","value":"number Angle of the line from (0, 0) to (x, y) in radians, in the range -pi to pi","description":"Angle of the line from (0, 0) to (x, y) in radians, in the range -pi to pi"}],"realm":"shared","params":[{"type":"number","value":"number y The Y coordinate","name":"y","description":"The Y coordinate"},{"type":"number","value":"number x The X coordinate","name":"x","description":"The X coordinate"}],"class":"function","name":"atan2","description":" Functions like math.atan(y / x), except it also takes into account the quadrant of the angle and so doesn't have a limited range of output."},"easeOutElastic":{"path":"libs_sh/math.lua#L578","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeOutElastic","description":" Eases out like a rubber band."},"easeOutQuint":{"path":"libs_sh/math.lua#L590","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeOutQuint","description":" Eases out by raising the fraction to the power of 5."},"calcBSplineN":{"path":"libs_sh/math.lua#L87","returns":[{"type":"number","value":"number Number value","description":"Number value"}],"realm":"shared","params":[{"type":"number","value":"number i","name":"i","description":""},{"type":"number","value":"number k","name":"k","description":""},{"type":"number","value":"number t","name":"t","description":""},{"type":"number","value":"number tinc","name":"tinc","description":""}],"class":"function","name":"calcBSplineN","description":" Basic code for Bezier-Spline algorithm."},"slerpQuaternion":{"path":"libs_sh/quaternion.lua#L848","returns":[{"type":"Quaternion","value":"Quaternion Interpolated quaternion","description":"Interpolated quaternion"}],"realm":"shared","params":[{"type":"Quaternion","value":"Quaternion quat1 Quaternion to start with","name":"quat1","description":"Quaternion to start with"},{"type":"Quaternion","value":"Quaternion quat2 Quaternion to end with","name":"quat2","description":"Quaternion to end with"},{"type":"number","value":"number t Ratio, 0 = quat1; 1 = quat2","name":"t","description":"Ratio, 0 = quat1; 1 = quat2"}],"class":"function","name":"slerpQuaternion","description":" Performs spherical linear interpolation between two quaternions"},"easeOutSine":{"path":"libs_sh/math.lua#L596","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeOutSine","description":" Eases out using math.sin."},"easeInOutElastic":{"path":"libs_sh/math.lua#L494","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutElastic","description":" Eases in and out like a rubber band."},"random":{"path":"libs_sh/math.lua#L253","returns":[{"type":"number","value":"number Random value","description":"Random value"}],"realm":"shared","params":[{"type":"number?","value":"number? m Optional integer value. If n is not provided - upper limit; if n is provided - lower limit","name":"m","description":"Optional integer value. If n is not provided - upper limit; if n is provided - lower limit"},{"type":"number?","value":"number? n Optional integer value. Upper value","name":"n","description":"Optional integer value. Upper value"}],"class":"function","name":"random","description":" When called without arguments, returns a uniform pseudo-random real number in the range 0 to 1 which includes 0 but excludes 1.\n When called with an integer number m, returns a uniform pseudo-random integer in the range 1 to m inclusive.\n When called with two integer numbers m and n, returns a uniform pseudo-random integer in the range m to n inclusive."},"max":{"path":"libs_sh/math.lua#L200","returns":[{"type":"number","value":"number The largest number","description":"The largest number"}],"realm":"shared","params":[{"type":"...number","value":"...number numbers Any amount of number values","name":"numbers","description":"Any amount of number values"}],"class":"function","name":"max","description":" Picks the largest value of all provided arguments."},"bezierVectorCubic":{"path":"libs_sh/math.lua#L398","returns":[{"type":"Vector","value":"Vector Vector representing the point along the curve.","description":"Vector representing the point along the curve."}],"realm":"shared","params":[{"type":"number","value":"number ratio Number representing how far along the curve, 0-1.","name":"ratio","description":"Number representing how far along the curve, 0-1."},{"type":"Vector","value":"Vector start The start position of the curve.","name":"start","description":"The start position of the curve."},{"type":"Vector","value":"Vector tangent1 First tangent","name":"tangent1","description":"First tangent"},{"type":"Vector","value":"Vector tangent2 Second tangent","name":"tangent2","description":"Second tangent"},{"type":"Vector","value":"Vector end The end position of the curve.","name":"end","description":"The end position of the curve."}],"class":"function","name":"bezierVectorCubic","description":" Returns a point along a cubic bezier curve."},"lerpAngle":{"path":"libs_sh/math.lua#L346","returns":[{"type":"Angle","value":"Angle The interpolated angle","description":"The interpolated angle"}],"realm":"shared","params":[{"type":"number","value":"number ratio Ratio of progress through values","name":"ratio","description":"Ratio of progress through values"},{"type":"Angle","value":"Angle from Angle to begin from","name":"from","description":"Angle to begin from"},{"type":"Angle","value":"Angle to Angle to end at","name":"to","description":"Angle to end at"}],"class":"function","name":"lerpAngle","description":" Calculates point between first and second angle using given fraction and linear interpolation."},"sharedRandom":{"path":"libs_sh/math.lua#L422","returns":[{"type":"number","value":"number The random float value","description":"The random float value"}],"realm":"shared","params":[{"type":"string","value":"string uniqueName The seed for the random value","name":"uniqueName","description":"The seed for the random value"},{"type":"number","value":"number Min The minimum value of the random range","name":"Min","description":"The minimum value of the random range"},{"type":"number","value":"number Max The maximum value of the random range","name":"Max","description":"The maximum value of the random range"},{"type":"number?","value":"number? additionalSeed The additional seed. Default 0","name":"additionalSeed","description":"The additional seed. Default 0"}],"class":"function","name":"sharedRandom","description":" Generates a random float value that should be the same on client and server"},"easeOutBounce":{"path":"libs_sh/math.lua#L560","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeOutBounce","description":" Eases out like a bouncy ball."},"easeOutBack":{"path":"libs_sh/math.lua#L554","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeOutBack","description":" Eases out by reversing the direction of the ease slightly before finishing."},"easeInQuad":{"path":"libs_sh/math.lua#L530","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInQuad","description":" Eases in by squaring the fraction."},"easeInSine":{"path":"libs_sh/math.lua#L548","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInSine","description":" Eases in using math.sin."},"angleDifference":{"path":"libs_sh/math.lua#L39","returns":[{"type":"number","value":"number The difference between the angles between -180 and 180","description":"The difference between the angles between -180 and 180"}],"realm":"shared","params":[{"type":"number","value":"number a The first angle","name":"a","description":"The first angle"},{"type":"number","value":"number b The second angle","name":"b","description":"The second angle"}],"class":"function","name":"angleDifference","description":" Calculates the difference between two angles."},"cos":{"path":"libs_sh/math.lua#L110","returns":[{"type":"number","value":"number Cosine of the angle","description":"Cosine of the angle"}],"realm":"shared","params":[{"type":"number","value":"number angle Angle in radians","name":"angle","description":"Angle in radians"}],"class":"function","name":"cos","description":" Calculates cosine of the given angle."},"easeInCubic":{"path":"libs_sh/math.lua#L452","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInCubic","description":" Eases in by cubing the fraction."},"easeInOutQuart":{"path":"libs_sh/math.lua#L512","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutQuart","description":" Eases in and out by raising the fraction to the power of 4."},"easeOutQuart":{"path":"libs_sh/math.lua#L584","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeOutQuart","description":" Eases out by raising the fraction to the power of 4."},"easeOutCirc":{"path":"libs_sh/math.lua#L566","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeOutCirc","description":" Eases out using a circular function."},"fmod":{"path":"libs_sh/math.lua#L157","returns":[{"type":"number","value":"number The calculated modulus","description":"The calculated modulus"}],"realm":"shared","params":[{"type":"number","value":"number base The base value","name":"base","description":"The base value"},{"type":"number","value":"number mod The modulator","name":"mod","description":"The modulator"}],"class":"function","name":"fmod","description":" Calculates the modulus of the specified values."},"atan":{"path":"libs_sh/math.lua#L68","returns":[{"type":"number","value":"number Angle in radians","description":"Angle in radians"}],"realm":"shared","params":[{"type":"number","value":"number tan Tangent value","name":"tan","description":"Tangent value"}],"class":"function","name":"atan","description":" Calculates an angle in radians, in the range -pi/2 to pi/2, which has the given tangent."},"floor":{"path":"libs_sh/math.lua#L151","returns":[{"type":"number","value":"number Rounded number","description":"Rounded number"}],"realm":"shared","params":[{"type":"number","value":"number n Number to be rounded","name":"n","description":"Number to be rounded"}],"class":"function","name":"floor","description":" Rounds a number down."},"asin":{"path":"libs_sh/math.lua#L62","returns":[{"type":"number","value":"number Angle in radians or nothing if the argument is out of range","description":"Angle in radians or nothing if the argument is out of range"}],"realm":"shared","params":[{"type":"number","value":"number sin Sine value in the range of -1 to 1","name":"sin","description":"Sine value in the range of -1 to 1"}],"class":"function","name":"asin","description":" Calculates an angle in radians, in the range -pi/2 to pi/2, which has the given sine value."},"easeInOut":{"path":"libs_sh/math.lua#L137","returns":[{"type":"number","value":"number Eased value","description":"Eased value"}],"realm":"shared","params":[{"type":"number","value":"number progress Fraction of the progress to ease","name":"progress","description":"Fraction of the progress to ease"},{"type":"number","value":"number easeIn Fraction of how much easing to begin with","name":"easeIn","description":"Fraction of how much easing to begin with"},{"type":"number","value":"number easeOut Fraction of how much easing to end with","name":"easeOut","description":"Fraction of how much easing to end with"}],"class":"function","name":"easeInOut","description":" Calculates the progress of a value fraction, taking in to account given easing fractions."},"binToInt":{"path":"libs_sh/math.lua#L81","returns":[{"type":"number","value":"number Base 10 number","description":"Base 10 number"}],"realm":"shared","params":[{"type":"string","value":"string str Binary string to convert","name":"str","description":"Binary string to convert"}],"class":"function","name":"binToInt","description":" Converts a binary string into a number."},"modf":{"path":"libs_sh/math.lua#L212","returns":[{"type":"number","value":"number The integral component","description":"The integral component"},{"type":"number","value":"number The fractional component","description":"The fractional component"}],"realm":"shared","params":[{"type":"number","value":"number base The base value","name":"base","description":"The base value"}],"class":"function","name":"modf","description":" Returns the integral and fractional component of the modulo operation."},"approachAngle":{"path":"libs_sh/math.lua#L54","returns":[{"type":"number","value":"number Modified angle","description":"Modified angle"}],"realm":"shared","params":[{"type":"number","value":"number currentAngle The current angle to increase","name":"currentAngle","description":"The current angle to increase"},{"type":"number","value":"number targetAngle The angle to increase towards","name":"targetAngle","description":"The angle to increase towards"},{"type":"number","value":"number rate The amount to approach the target angle by","name":"rate","description":"The amount to approach the target angle by"}],"class":"function","name":"approachAngle","description":" Increments an angle towards another by specified rate."},"cosh":{"path":"libs_sh/math.lua#L116","returns":[{"type":"number","value":"number The hyperbolic cosine of the angle","description":"The hyperbolic cosine of the angle"}],"realm":"shared","params":[{"type":"number","value":"number angle Angle in radians","name":"angle","description":"Angle in radians"}],"class":"function","name":"cosh","description":" Calculates hyperbolic cosine of the given angle."},"easeInOutQuad":{"path":"libs_sh/math.lua#L506","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutQuad","description":" Eases in and out by squaring the fraction."},"abs":{"path":"libs_sh/math.lua#L19","returns":[{"type":"number","value":"number Absolute value","description":"Absolute value"}],"realm":"shared","params":[{"type":"number","value":"number x The number to get the absolute value of","name":"x","description":"The number to get the absolute value of"}],"class":"function","name":"abs","description":" Calculates the absolute value of a number (effectively removes any negative sign)."},"easeOutCubic":{"path":"libs_sh/math.lua#L572","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeOutCubic","description":" Eases out by cubing the fraction."},"sqrt":{"path":"libs_sh/math.lua#L290","returns":[{"type":"number","value":"number Square root of the provided value","description":"Square root of the provided value"}],"realm":"shared","params":[{"type":"number","value":"number value The value to get the square root of","name":"value","description":"The value to get the square root of"}],"class":"function","name":"sqrt","description":" Calculates square root of the number."},"clamp":{"path":"libs_sh/math.lua#L102","returns":[{"type":"number","value":"number Clamped number","description":"Clamped number"}],"realm":"shared","params":[{"type":"number","value":"number current Input number","name":"current","description":"Input number"},{"type":"number","value":"number min Minimum value","name":"min","description":"Minimum value"},{"type":"number","value":"number max Maximum value","name":"max","description":"Maximum value"}],"class":"function","name":"clamp","description":" Clamps a number between a minimum and maximum value."},"log":{"path":"libs_sh/math.lua#L186","returns":[{"type":"number","value":"number Logarithm of x to the given base","description":"Logarithm of x to the given base"}],"realm":"shared","params":[{"type":"number","value":"number x The value to get the base from exponent from","name":"x","description":"The value to get the base from exponent from"},{"type":"number?","value":"number? base Optional logarithmic base. Default 'e'","name":"base","description":"Optional logarithmic base. Default 'e'"}],"class":"function","name":"log","description":" With one argument, returns the natural logarithm of x (to base e).\n With two arguments, return the logarithm of x to the given base, calculated as log(x) / log(base)."},"rad":{"path":"libs_sh/math.lua#L240","returns":[{"type":"number","value":"number Angle in radians","description":"Angle in radians"}],"realm":"shared","params":[{"type":"number","value":"number deg Angle in degrees","name":"deg","description":"Angle in degrees"}],"class":"function","name":"rad","description":" Converts an angle from degrees to radians."},"bezierVector":{"path":"libs_sh/math.lua#L380","returns":[{"type":"Vector","value":"Vector Vector representing the point along the curve.","description":"Vector representing the point along the curve."}],"realm":"shared","params":[{"type":"number","value":"number ratio Number representing how far along the curve, 0-1.","name":"ratio","description":"Number representing how far along the curve, 0-1."},{"type":"Vector","value":"Vector start The start position of the curve.","name":"start","description":"The start position of the curve."},{"type":"Vector","value":"Vector middle The middle position of the curve.","name":"middle","description":"The middle position of the curve."},{"type":"Vector","value":"Vector end The end position of the curve.","name":"end","description":"The end position of the curve."}],"class":"function","name":"bezierVector","description":" Returns a point along a bezier curve."},"easeInOutBounce":{"path":"libs_sh/math.lua#L476","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutBounce","description":" Eases in and out like a bouncy ball."},"exp":{"path":"libs_sh/math.lua#L145","returns":[{"type":"number","value":"number e to the specific power","description":"e to the specific power"}],"realm":"shared","params":[{"type":"number","value":"number x The exponent of the function","name":"x","description":"The exponent of the function"}],"class":"function","name":"exp","description":" Returns the x power of the Euler constant."},"remap":{"path":"libs_sh/math.lua#L262","returns":[{"type":"number","value":"number The number in the new range","description":"The number in the new range"}],"realm":"shared","params":[{"type":"number","value":"number value The number value","name":"value","description":"The number value"},{"type":"number","value":"number inMin The minimum of the initial range","name":"inMin","description":"The minimum of the initial range"},{"type":"number","value":"number inMax The maximum of the initial range","name":"inMax","description":"The maximum of the initial range"},{"type":"number","value":"number outMin The minimum of new range","name":"outMin","description":"The minimum of new range"},{"type":"number","value":"number outMax The maximum of new range","name":"outMax","description":"The maximum of new range"}],"class":"function","name":"remap","description":" Remaps the value from one range to another."},"easeInElastic":{"path":"libs_sh/math.lua#L458","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInElastic","description":" Eases in like a rubber band."}},"tables":[],"path":"libs_sh/math.lua#L4","fields":[],"realm":"shared","libtbl":["math_library"],"class":"library","name":"math","description":" Lua math library https://wiki.garrysmod.com/page/Category:math"},"midi":{"methods":{"closePort":{"path":"libs_cl/midi.lua#L80","returns":[{"type":"string","value":"string the name of the midi device closed at the given port.","description":"the name of the midi device closed at the given port."}],"realm":"client","params":[{"type":"number","value":"number port the midi port to close.","name":"port","description":"the midi port to close."}],"class":"function","name":"closePort","description":" Closes the specified midi port."},"getCode":{"path":"libs_cl/midi.lua#L87","returns":[{"type":"number","value":"number the command code","description":"the command code"}],"realm":"client","params":[{"type":"number","value":"number command the command","name":"command","description":"the command"}],"class":"function","name":"getCode","description":" Grabs the midi command code from the command."},"openPort":{"path":"libs_cl/midi.lua#L48","returns":[{"type":"string","value":"string the name of the midi device opened at the given port.","description":"the name of the midi device opened at the given port."}],"realm":"client","params":[{"type":"number","value":"number port the midi port to open. Passing nothing defaults to 0.","name":"port","description":"the midi port to open. Passing nothing defaults to 0."}],"class":"function","name":"openPort","description":" Opens the midi port to make it available to grab events from.  This must be called before the hook."},"isPortOpen":{"path":"libs_cl/midi.lua#L59","returns":[{"type":"boolean","value":"boolean if the port is open","description":"if the port is open"}],"realm":"client","class":"function","name":"isPortOpen","description":" Checks if the specified midi port is currently opened."},"getPorts":{"path":"libs_cl/midi.lua#L74","returns":[{"type":"table","value":"table the table of midi ports.  Starts at index 0","description":"the table of midi ports.  Starts at index 0"}],"realm":"client","class":"function","name":"getPorts","description":" Gets a table of all midi devices' ports."},"getChannel":{"path":"libs_cl/midi.lua#L94","returns":[{"type":"number","value":"number the midi channel","description":"the midi channel"}],"realm":"client","params":[{"type":"number","value":"number command the command","name":"command","description":"the command"}],"class":"function","name":"getChannel","description":" Grabs the midi channel from the command."},"getName":{"path":"libs_cl/midi.lua#L101","returns":[{"type":"string","value":"string command name","description":"command name"}],"realm":"client","params":[{"type":"number","value":"number command the command","name":"command","description":"the command"}],"class":"function","name":"getName","description":" Grabs the command code in a readable name."},"closeAllPorts":{"path":"libs_cl/midi.lua#L66","realm":"client","class":"function","name":"closeAllPorts","description":" Closes all midi ports."}},"tables":{"MIDI":{"path":"libs_sh/enum.lua#L1220","fields":[{"name":"NOTE_OFF","description":""},{"name":"NOTE_ON","description":""},{"name":"AFTERTOUCH","description":""},{"name":"CONTINUOUS_CONTROLLER","description":""},{"name":"PATCH_CHANGE","description":""},{"name":"CHANNEL_PRESSURE","description":""},{"name":"PITCH_BEND","description":""}],"realm":"shared","class":"table","name":"MIDI","description":" Midi Command ENUMS"}},"path":"libs_cl/midi.lua#L5","libtbl":["midi_library"],"realm":"client","fields":[],"class":"library","name":"midi","description":" Midi Library\n Polls midi event information from midi devices.\n Requires a custom binary -> https://github.com/FPtje/gmcl_midi/releases/tag/v0.2.0\n GNU/Linux and MacOS users will have to compile their own binaries.\n Instructions here -> https://github.com/FPtje/gmcl_midi/blob/master/Compiling.md"},"os":{"methods":{"date":{"path":"libs_sh/builtins.lua#L396","returns":[{"type":"string|table","value":"string|table If format is equal to '*t' or '!*t' then it will return a table with DateData structure, otherwise a string","description":"If format is equal to '*t' or '!*t' then it will return a table with DateData structure, otherwise a string"}],"realm":"shared","params":[{"type":"string","value":"string format The format string. If starts with an '!', it will use UTC timezone rather than the local timezone","name":"format","description":"The format string. If starts with an '!', it will use UTC timezone rather than the local timezone"},{"type":"number?","value":"number? time Time to use for the format. Default os.time()","name":"time","description":"Time to use for the format. Default os.time()"}],"class":"function","name":"date","description":" Returns the date/time as a formatted string or in a table.\n See https://wiki.facepunch.com/gmod/Structures/DateData for the table structure"},"time":{"path":"libs_sh/builtins.lua#L416","returns":[{"type":"number","value":"number Seconds passed since Unix epoch","description":"Seconds passed since Unix epoch"}],"realm":"shared","params":[{"type":"table?","value":"table? dateData Optional table to generate the time from. This table's data is interpreted as being in the local timezone","name":"dateData","description":"Optional table to generate the time from. This table's data is interpreted as being in the local timezone"}],"class":"function","name":"time","description":" Returns the system time in seconds past the unix epoch.\n If a table is supplied, the function attempts to build a system time with the specified table members"},"clock":{"path":"libs_sh/builtins.lua#L390","returns":[{"type":"number","value":"number The runtime","description":"The runtime"}],"realm":"shared","class":"function","name":"clock","description":" Returns the approximate cpu time the application ran.\n This function has different precision on Linux (1/100)."},"difftime":{"path":"libs_sh/builtins.lua#L409","returns":[{"type":"number","value":"number Time difference","description":"Time difference"}],"realm":"shared","params":[{"type":"number","value":"number timeA The first value","name":"timeA","description":"The first value"},{"type":"number","value":"number timeB The value to subtract","name":"timeB","description":"The value to subtract"}],"class":"function","name":"difftime","description":" Subtracts the second of the first value and rounds the result"}},"tables":[],"path":"libs_sh/builtins.lua#L20","libtbl":["os_library"],"realm":"shared","fields":[],"class":"library","name":"os","description":" Lua os library https://wiki.garrysmod.com/page/Category:os"},"timer":{"methods":{"exists":{"path":"libs_sh/timer.lua#L134","returns":[{"type":"boolean","value":"boolean if the timer exists","description":"if the timer exists"}],"realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"}],"class":"function","name":"exists","description":" Checks if a timer exists"},"toggle":{"path":"libs_sh/timer.lua#L199","returns":[{"type":"boolean","value":"boolean Status of the timer.","description":"Status of the timer."}],"realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"}],"class":"function","name":"toggle","description":" Runs either timer.pause or timer.unpause based on the timer's current status."},"create":{"path":"libs_sh/timer.lua#L98","realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"},{"type":"number","value":"number delay The time, in seconds, to set the timer to.","name":"delay","description":"The time, in seconds, to set the timer to."},{"type":"number","value":"number reps The repetitions of the timer. 0 = infinite","name":"reps","description":"The repetitions of the timer. 0 = infinite"},{"type":"function","value":"function func The function to call when the timer is fired","name":"func","description":"The function to call when the timer is fired"}],"class":"function","name":"create","description":" Creates (and starts) a timer"},"getTimersLeft":{"path":"libs_sh/timer.lua#L226","returns":[{"type":"number","value":"number Number of available timers","description":"Number of available timers"}],"realm":"shared","class":"function","name":"getTimersLeft","description":" Returns number of available timers"},"start":{"path":"libs_sh/timer.lua#L150","returns":[{"type":"boolean","value":"boolean True if the timer exists, false if it doesn't.","description":"True if the timer exists, false if it doesn't."}],"realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"}],"class":"function","name":"start","description":" Starts a timer"},"timeleft":{"path":"libs_sh/timer.lua#L208","returns":[{"type":"number","value":"number The amount of time left (in seconds). If the timer is paused, the amount will be negative. Nil if timer doesnt exist","description":"The amount of time left (in seconds). If the timer is paused, the amount will be negative. Nil if timer doesnt exist"}],"realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"}],"class":"function","name":"timeleft","description":" Returns amount of time left (in seconds) before the timer executes its function."},"frametime":{"path":"libs_sh/timer.lua#L51","returns":[{"type":"number","value":"number The time between frames / ticks depending on realm","description":"The time between frames / ticks depending on realm"}],"realm":"shared","class":"function","name":"frametime","description":" Returns time between frames on client and ticks on server. Same thing as G.FrameTime in GLua"},"adjust":{"path":"libs_sh/timer.lua#L159","returns":[{"type":"boolean","value":"boolean True if succeeded","description":"True if succeeded"}],"realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"},{"type":"number","value":"number delay The time, in seconds, to set the timer to.","name":"delay","description":"The time, in seconds, to set the timer to."},{"type":"number?","value":"number? reps (Optional) The repetitions of the timer. 0 = infinite, nil = 1","name":"reps","description":"(Optional) The repetitions of the timer. 0 = infinite, nil = 1"},{"type":"function?","value":"function? func (Optional) The function to call when the timer is fired","name":"func","description":"(Optional) The function to call when the timer is fired"}],"class":"function","name":"adjust","description":" Adjusts a timer"},"pause":{"path":"libs_sh/timer.lua#L181","returns":[{"type":"boolean","value":"boolean false if the timer didn't exist or was already paused, true otherwise.","description":"false if the timer didn't exist or was already paused, true otherwise."}],"realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"}],"class":"function","name":"pause","description":" Pauses a timer"},"systime":{"path":"libs_sh/timer.lua#L45","returns":[{"type":"number","value":"number The time in seconds since start up","description":"The time in seconds since start up"}],"realm":"shared","class":"function","name":"systime","description":" Returns a highly accurate time in seconds since the start up, ideal for benchmarking."},"repsleft":{"path":"libs_sh/timer.lua#L217","returns":[{"type":"number","value":"number The amount of executions left. Nil if timer doesnt exist","description":"The amount of executions left. Nil if timer doesnt exist"}],"realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"}],"class":"function","name":"repsleft","description":" Returns amount of repetitions/executions left before the timer destroys itself."},"remove":{"path":"libs_sh/timer.lua#L121","realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"}],"class":"function","name":"remove","description":" Stops and removes the timer."},"realtime":{"path":"libs_sh/timer.lua#L38","returns":[{"type":"number","value":"number Realtime in seconds","description":"Realtime in seconds"}],"realm":"shared","class":"function","name":"realtime","description":" Returns the uptime of the game/server in seconds (to at least 4 decimal places)\n Ideal for timing real world events since it updates local to the realm thinking, being clientside FPS or server tickrate"},"stop":{"path":"libs_sh/timer.lua#L142","returns":[{"type":"boolean","value":"boolean False if the timer didn't exist or was already stopped, true otherwise.","description":"False if the timer didn't exist or was already stopped, true otherwise."}],"realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"}],"class":"function","name":"stop","description":" Stops a timer"},"curtime":{"path":"libs_sh/timer.lua#L31","returns":[{"type":"number","value":"number Curtime in seconds","description":"Curtime in seconds"}],"realm":"shared","class":"function","name":"curtime","description":" Returns the uptime of the server in seconds (to at least 4 decimal places)\n You should not use this for timing real world events as it is synchronized with the server, use realtime instead"},"simple":{"path":"libs_sh/timer.lua#L112","realm":"shared","params":[{"type":"number","value":"number delay The time, in second, to set the timer to","name":"delay","description":"The time, in second, to set the timer to"},{"type":"function","value":"function func The function to call when the timer is fired","name":"func","description":"The function to call when the timer is fired"}],"class":"function","name":"simple","description":" Creates a simple timer, has no name, can't be stopped, paused, or destroyed."},"unpause":{"path":"libs_sh/timer.lua#L190","returns":[{"type":"boolean","value":"boolean false if the timer didn't exist or was already running, true otherwise.","description":"false if the timer didn't exist or was already running, true otherwise."}],"realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"}],"class":"function","name":"unpause","description":" Unpauses a timer"}},"tables":[],"path":"libs_sh/timer.lua#L8","libtbl":["timer_library"],"realm":"shared","fields":[],"class":"library","name":"timer","description":" Deals with time and timers."},"darkrp":{"methods":{"openF1Menu":{"path":"libs_sh/darkrp2.lua#L755","realm":"client","class":"function","name":"openF1Menu","description":" Open the F1 help menu. Roughly equivalent to pressing F1 (or running gm_showhelp), but won't close it if it's already open.\n Only works if the local player is the owner of the chip, or if the chip is running in superuser mode."},"doorIndexToEnt":{"path":"libs_sh/darkrp2.lua#L642","returns":[{"type":"Entity?","value":"Entity? The door entity, or nil if the index is invalid or the door was removed.","description":"The door entity, or nil if the index is invalid or the door was removed."}],"realm":"server","params":[{"type":"number","value":"number doorIndex The door index","name":"doorIndex","description":"The door index"}],"class":"function","name":"doorIndexToEnt","description":" Get the entity corresponding to a door index. Note: The door MUST have been created by the map!"},"canMakeMoneyRequest":{"path":"libs_sh/darkrp2.lua#L726","returns":[{"type":"boolean","value":"boolean If you can make another money request","description":"If you can make another money request"}],"realm":"server","params":[{"type":"Player?","value":"Player? sender Player you intend to ask for money from later (if nil, will only check your money request rate)","name":"sender","description":"Player you intend to ask for money from later (if nil, will only check your money request rate)"}],"class":"function","name":"canMakeMoneyRequest","description":" Returns whether you can make another money request this tick.\n If a player is provided as a parameter, will also check if you can request money from that particular player this tick."},"canGiveMoney":{"path":"libs_sh/darkrp2.lua#L748","returns":[{"type":"boolean","value":"boolean If you can give someone money","description":"If you can give someone money"}],"realm":"server","class":"function","name":"canGiveMoney","description":" Returns whether you can give someone money this tick."},"closeF4Menu":{"path":"libs_sh/darkrp2.lua#L779","realm":"client","class":"function","name":"closeF4Menu","description":" Close the F4 menu (the one where you can choose your job, buy shipments, ammo, money printers, etc).\n Only works if the local player is the owner of the chip, or if the chip is running in superuser mode."},"getFoodItems":{"path":"libs_sh/darkrp2.lua#L614","returns":[{"type":"table?","value":"table? Table with food items, or nil if there are none.","description":"Table with food items, or nil if there are none."}],"realm":"shared","class":"function","name":"getFoodItems","description":" Get all food items."},"requestMoney":{"path":"libs_sh/darkrp2.lua#L683","realm":"server","params":[{"type":"Player","value":"Player sender The player who may or may not send the money.","name":"sender","description":"The player who may or may not send the money."},{"type":"number","value":"number amount The amount of money to ask for.","name":"amount","description":"The amount of money to ask for."},{"type":"string?","value":"string? message An optional custom message that will be shown in the money request prompt. May not exceed 60 bytes in length.","name":"message","description":"An optional custom message that will be shown in the money request prompt. May not exceed 60 bytes in length."},{"type":"function?","value":"function? callbackSuccess Optional function to call if request succeeds. Args (string: The request message, player: The money sender, number: The amount)","name":"callbackSuccess","description":"Optional function to call if request succeeds. Args (string: The request message, player: The money sender, number: The amount)"},{"type":"function?","value":"function? callbackFailure Optional function to call if request fails. Args (string: why it failed)","name":"callbackFailure","description":"Optional function to call if request fails. Args (string: why it failed)"},{"type":"Player?","value":"Player? receiver The player who may or may not receive the money, or the owner of the chip if not specified. Superuser only.","name":"receiver","description":"The player who may or may not receive the money, or the owner of the chip if not specified. Superuser only."}],"class":"function","name":"requestMoney","description":" Request money from a player.\n This is subject to a burst limit, and a limit of one money request per sender per receiver at a time. Use \"darkrp.canMakeMoneyRequest\" to check if you can request money that tick for that player."},"moneyRequestsLeft":{"path":"libs_sh/darkrp2.lua#L717","returns":[{"type":"number","value":"number Number of money requests able to be created. This could be a decimal, so floor it first","description":"Number of money requests able to be created. This could be a decimal, so floor it first"}],"realm":"server","class":"function","name":"moneyRequestsLeft","description":" Returns number of money requests left.\n By default, this replenishes at a rate of 1 every 2 seconds, up to a maximum of 1.\n In other words, you can make a maximum of 1 money request every 2 seconds. May vary from server to server."},"openPocketMenu":{"path":"libs_sh/darkrp2.lua#L803","realm":"client","class":"function","name":"openPocketMenu","description":" Open the DarkRP pocket menu. This refers to DarkRP's built-in \"pocket\", and probably not your server's custom inventory system.\n Only works if the local player is the owner of the chip, or if the chip is running in superuser mode."},"payPlayer":{"path":"libs_sh/darkrp2.lua#L661","realm":"server","params":[{"type":"Player","value":"Player sender The player who gives the money.","name":"sender","description":"The player who gives the money."},{"type":"Player","value":"Player receiver The player who receives the money.","name":"receiver","description":"The player who receives the money."},{"type":"number","value":"number amount The amount of money.","name":"amount","description":"The amount of money."}],"class":"function","name":"payPlayer","description":" Make one player give money to the other player.\n This is subject to a burst limit. Use \"darkrp.canGiveMoney\" to check if you can give out money that tick.\n Only works if the sender is the owner of the chip, or if the chip is running in superuser mode."},"formatMoney":{"path":"libs_sh/darkrp2.lua#L594","returns":[{"type":"string","value":"string The money as a nice string, e.g. \"$100,000\".","description":"The money as a nice string, e.g. \"$100,000\"."}],"realm":"shared","params":[{"type":"number","value":"number amount The money to format, e.g. 100000.","name":"amount","description":"The money to format, e.g. 100000."}],"class":"function","name":"formatMoney","description":" Format a number as a money value. Includes currency symbol."},"isDarkRPVarBlacklisted":{"path":"libs_sh/darkrp2.lua#L633","returns":[{"type":"boolean","value":"boolean If the variable is blacklisted","description":"If the variable is blacklisted"}],"realm":"shared","params":[{"type":"string","value":"string var The name of the variable","name":"var","description":"The name of the variable"}],"class":"function","name":"isDarkRPVarBlacklisted","description":" Get whether a DarkRPVar is blacklisted from being read by Starfall."},"moneyGivingsLeft":{"path":"libs_sh/darkrp2.lua#L739","returns":[{"type":"number","value":"number Number of money requests able to be created. This could be a decimal, so floor it first","description":"Number of money requests able to be created. This could be a decimal, so floor it first"}],"realm":"server","class":"function","name":"moneyGivingsLeft","description":" Returns number of times you can give someone money.\n By default, this replenishes at a rate of 1 every 2 seconds, up to a maximum of 2.\n In other words, you can give out money two times at once, then you have to wait two seconds. May vary from server to server."},"toggleF4Menu":{"path":"libs_sh/darkrp2.lua#L787","realm":"client","class":"function","name":"toggleF4Menu","description":" Toggle the state of the F4 menu (open or closed). Equivalent to pressing F4 (or running gm_showspare2).\n Only works if the local player is the owner of the chip, or if the chip is running in superuser mode."},"openF4Menu":{"path":"libs_sh/darkrp2.lua#L771","realm":"client","class":"function","name":"openF4Menu","description":" Open the F4 menu (the one where you can choose your job, buy shipments, ammo, money printers, etc). Roughly equivalent to pressing F4 (or running gm_showspare2), but won't close it if it's already open.\n Only works if the local player is the owner of the chip, or if the chip is running in superuser mode."},"getLaws":{"path":"libs_sh/darkrp2.lua#L621","returns":[{"type":"table","value":"table A table of all current laws.","description":"A table of all current laws."}],"realm":"shared","class":"function","name":"getLaws","description":" Get the table of all current laws."},"getAvailableVehicles":{"path":"libs_sh/darkrp2.lua#L602","returns":[{"type":"table","value":"table Names, models and classnames of all supported vehicles.","description":"Names, models and classnames of all supported vehicles."}],"realm":"shared","class":"function","name":"getAvailableVehicles","description":" Get the available vehicles that DarkRP supports."},"getCategories":{"path":"libs_sh/darkrp2.lua#L608","returns":[{"type":"table","value":"table All categories.","description":"All categories."}],"realm":"shared","class":"function","name":"getCategories","description":" Get all categories for all F4 menu tabs, including all jobs and every entity available for purchase."},"closeF1Menu":{"path":"libs_sh/darkrp2.lua#L763","realm":"client","class":"function","name":"closeF1Menu","description":" Close the F1 help menu.\n Only works if the local player is the owner of the chip, or if the chip is running in superuser mode."},"getCustomShipments":{"path":"libs_sh/darkrp2.lua#L627","returns":[{"type":"table?","value":"table? A table with the contents of the GLua global \"CustomShipments\", or nil if it doesn't exist.","description":"A table with the contents of the GLua global \"CustomShipments\", or nil if it doesn't exist."}],"realm":"shared","class":"function","name":"getCustomShipments","description":" Get a list of possible shipments."},"openKeysMenu":{"path":"libs_sh/darkrp2.lua#L795","realm":"client","class":"function","name":"openKeysMenu","description":" Buy the door the local player is looking at, or open the menu if it's already bought. Equivalent to pressing F2 (or running gm_showteam).\n Only works if the local player is the owner of the chip, or if the chip is running in superuser mode."},"jailPosCount":{"path":"libs_sh/darkrp2.lua#L654","returns":[{"type":"number","value":"number The number of jail positions in the current map.","description":"The number of jail positions in the current map."}],"realm":"server","class":"function","name":"jailPosCount","description":" Get the number of jail positions in the current map."}},"tables":[],"path":"libs_sh/darkrp2.lua#L566","libtbl":["darkrp_library"],"realm":"shared","fields":[],"class":"library","name":"darkrp","description":" Functions relating to DarkRP. These functions WILL NOT EXIST if DarkRP is not in use."},"string":{"methods":{"getPathFromFilename":{"path":"libs_sh/string.lua#L113","returns":[{"type":"string","value":"string The path","description":"The path"}],"realm":"shared","params":[{"type":"string","value":"string str File-path to get the file extensions from","name":"str","description":"File-path to get the file extensions from"}],"class":"function","name":"getPathFromFilename","description":" Returns the path only from a file's path, excluding the file itself."},"format":{"path":"libs_sh/string.lua#L86","returns":[{"type":"string","value":"string The formatted string","description":"The formatted string"}],"realm":"shared","params":[{"type":"string","value":"string str The string to be formatted","name":"str","description":"The string to be formatted"},{"type":"...","value":"... params Vararg values to be formatted into the string","name":"params","description":"Vararg values to be formatted into the string"}],"class":"function","name":"format","description":" Formats the specified values into the string given. http://www.cplusplus.com/reference/cstdio/printf/"},"len":{"path":"libs_sh/string.lua#L149","returns":[{"type":"number","value":"number Length of the string","description":"Length of the string"}],"realm":"shared","params":[{"type":"string","value":"string str The string to find the length of","name":"str","description":"The string to find the length of"}],"class":"function","name":"len","description":" Counts the number of characters in the string. This is equivalent to using the # operator."},"comma":{"path":"libs_sh/string.lua#L47","returns":[{"type":"string","value":"string String with commas inserted","description":"String with commas inserted"}],"realm":"shared","params":[{"type":"number","value":"number num The number to be separated by commas","name":"num","description":"The number to be separated by commas"}],"class":"function","name":"comma","description":" Inserts commas for every third digit."},"javascriptSafe":{"path":"libs_sh/string.lua#L136","returns":[{"type":"string","value":"string The safe string","description":"The safe string"}],"realm":"shared","params":[{"type":"string","value":"string str The string that should be escaped","name":"str","description":"The string that should be escaped"}],"class":"function","name":"javascriptSafe","description":" Escapes special characters for JavaScript in a string, making the string safe for inclusion in to JavaScript strings."},"gsub":{"path":"libs_sh/string.lua#L126","returns":[{"type":"string","value":"string String with replaced parts","description":"String with replaced parts"},{"type":"number","value":"number Replacements count","description":"Replacements count"}],"realm":"shared","params":[{"type":"string","value":"string str String which should be modified.","name":"str","description":"String which should be modified."},{"type":"string","value":"string pattern The pattern that defines what should be matched and eventually be replaced.","name":"pattern","description":"The pattern that defines what should be matched and eventually be replaced."},{"type":"string|table|function","value":"string|table|function replacement If string: matched sequence will be replaced with it; If table: matched sequence will be used as key; If function: matches will be passed as parameters to the function (return to replace)","name":"replacement","description":"If string: matched sequence will be replaced with it; If table: matched sequence will be used as key; If function: matches will be passed as parameters to the function (return to replace)"},{"type":"number?","value":"number? max Optional maximum number of replacements to be made","name":"max","description":"Optional maximum number of replacements to be made"}],"class":"function","name":"gsub","description":" This functions main purpose is to replace certain character sequences in a string using Patterns."},"replace":{"path":"libs_sh/string.lua#L203","returns":[{"type":"string","value":"string String with parts replaced","description":"String with parts replaced"}],"realm":"shared","params":[{"type":"string","value":"string str The string we are seeking to replace an occurrence(s)","name":"str","description":"The string we are seeking to replace an occurrence(s)"},{"type":"string","value":"string find What we are seeking to replace","name":"find","description":"What we are seeking to replace"},{"type":"string","value":"string replace What to replace find with","name":"replace","description":"What to replace find with"}],"class":"function","name":"replace","description":" Replaces all occurrences of the supplied second string."},"formattedTime":{"path":"libs_sh/string.lua#L93","returns":[{"type":"string|table","value":"string|table Formatted string or a table","description":"Formatted string or a table"}],"realm":"shared","params":[{"type":"number","value":"number time The time in seconds to format","name":"time","description":"The time in seconds to format"},{"type":"string?","value":"string? format An optional formatting to use. If no format it specified, a table will be returned instead","name":"format","description":"An optional formatting to use. If no format it specified, a table will be returned instead"}],"class":"function","name":"formattedTime","description":" Returns the time as a formatted string or table. http://www.cplusplus.com/reference/cstdio/printf/\n If format is not specified, the table will contain the following keys: ms (milliseconds); s (seconds); m (minutes); h (hours)."},"char":{"path":"libs_sh/string.lua#L41","returns":[{"type":"string","value":"string String built from given bytes","description":"String built from given bytes"}],"realm":"shared","params":[{"type":"...","value":"... bytes The bytes to create the string from","name":"bytes","description":"The bytes to create the string from"}],"class":"function","name":"char","description":" Takes the given numerical bytes and converts them to a string."},"toHoursMinutesSeconds":{"path":"libs_sh/string.lua#L276","returns":[{"type":"string","value":"string Given time in \"HH:MM:SS\" format","description":"Given time in \"HH:MM:SS\" format"}],"realm":"shared","params":[{"type":"number","value":"number time Time in seconds","name":"time","description":"Time in seconds"}],"class":"function","name":"toHoursMinutesSeconds","description":" Converts time to hours, minutes and seconds string."},"setChar":{"path":"libs_sh/string.lua#L224","returns":[{"type":"string","value":"string Modified string","description":"Modified string"}],"realm":"shared","params":[{"type":"string","value":"string str The input string","name":"str","description":"The input string"},{"type":"number","value":"number index The character index, 1 is the first from left","name":"index","description":"The character index, 1 is the first from left"},{"type":"string","value":"string replacement String to replace with","name":"replacement","description":"String to replace with"}],"class":"function","name":"setChar","description":" Sets the character at the specific index of the string."},"split":{"path":"libs_sh/string.lua#L232","returns":[{"type":"table","value":"table Table with the separated strings in numerical sequential order","description":"Table with the separated strings in numerical sequential order"}],"realm":"shared","params":[{"type":"string","value":"string str String to split","name":"str","description":"String to split"},{"type":"string","value":"string separator Character(s) to split with","name":"separator","description":"Character(s) to split with"}],"class":"function","name":"split","description":" Splits the string into a table of strings, separated by the second argument"},"escapeMarkup":{"path":"libs_sh/string.lua#L187","returns":[{"type":"string","value":"string Sanitized text","description":"Sanitized text"}],"realm":"shared","params":[{"type":"string","value":"string str Text to sanitize","name":"str","description":"Text to sanitize"}],"class":"function","name":"escapeMarkup","description":" Sanitizes text to be used in `render.parseMarkup`"},"getFileFromFilename":{"path":"libs_sh/string.lua#L107","returns":[{"type":"string","value":"string The filename along with it's extension","description":"The filename along with it's extension"}],"realm":"shared","params":[{"type":"string","value":"string str File-path to get the file extensions from","name":"str","description":"File-path to get the file extensions from"}],"class":"function","name":"getFileFromFilename","description":" Returns file name and extension."},"rep":{"path":"libs_sh/string.lua#L195","returns":[{"type":"string","value":"string String result","description":"String result"}],"realm":"shared","params":[{"type":"string","value":"string str The string to repeat","name":"str","description":"The string to repeat"},{"type":"number","value":"number rep Number of times to repeat the string","name":"rep","description":"Number of times to repeat the string"},{"type":"string?","value":"string? sep (Optional) seperator string between each repeated string","name":"sep","description":"(Optional) seperator string between each repeated string"}],"class":"function","name":"rep","description":" Repeats the given string n times"},"utf8force":{"path":"libs_sh/string.lua#L360","returns":[{"type":"string","value":"string The UTF-8 string","description":"The UTF-8 string"}],"realm":"shared","params":[{"type":"string","value":"string str The string that will become a valid UTF-8 string","name":"str","description":"The string that will become a valid UTF-8 string"}],"class":"function","name":"utf8force","description":" Forces a string to contain only valid UTF-8 data. Invalid sequences are replaced with U+FFFD (the Unicode replacement character)."},"gmatch":{"path":"libs_sh/string.lua#L119","returns":[{"type":"function","value":"function The iterator function that can be used in a for-in loop","description":"The iterator function that can be used in a for-in loop"}],"realm":"shared","params":[{"type":"string","value":"string data The string to search in","name":"data","description":"The string to search in"},{"type":"string","value":"string pattern The pattern to search for","name":"pattern","description":"The pattern to search for"}],"class":"function","name":"gmatch","description":" Using Patterns, returns an iterator which will return either one value if no capture groups are defined, or any capture group matches."},"reverse":{"path":"libs_sh/string.lua#L211","returns":[{"type":"string","value":"string Reversed string","description":"Reversed string"}],"realm":"shared","params":[{"type":"string","value":"string str String to be reversed","name":"str","description":"String to be reversed"}],"class":"function","name":"reverse","description":" Reverses a string."},"toMinutesSecondsMilliseconds":{"path":"libs_sh/string.lua#L270","returns":[{"type":"string","value":"string Returns given time in \"MM:SS:MS\" format","description":"Returns given time in \"MM:SS:MS\" format"}],"realm":"shared","params":[{"type":"number","value":"number time Time in seconds","name":"time","description":"Time in seconds"}],"class":"function","name":"toMinutesSecondsMilliseconds","description":" Converts time to minutes, seconds and milliseconds string."},"startsWith":{"path":"libs_sh/string.lua#L239","returns":[{"type":"boolean","value":"boolean True if the first string starts with the second","description":"True if the first string starts with the second"}],"realm":"shared","params":[{"type":"string","value":"string str String to be checked","name":"str","description":"String to be checked"},{"type":"string","value":"string start String to check with","name":"start","description":"String to check with"}],"class":"function","name":"startsWith","description":" Whether or not the first string starts with the second"},"right":{"path":"libs_sh/string.lua#L217","returns":[{"type":"string","value":"string String containing a specified number of characters from the right side of a string","description":"String containing a specified number of characters from the right side of a string"}],"realm":"shared","params":[{"type":"string","value":"string str The string to extract from","name":"str","description":"The string to extract from"},{"type":"number","value":"number num Amount of chars relative to the end (starting from 1)","name":"num","description":"Amount of chars relative to the end (starting from 1)"}],"class":"function","name":"right","description":" Returns the last n-th characters of the string."},"fromColor":{"path":"libs_sh/string.lua#L17","returns":[{"type":"string","value":"string String with the color RGBA values separated by spaces","description":"String with the color RGBA values separated by spaces"}],"realm":"shared","params":[{"type":"Color","value":"Color col The color to put in the string","name":"col","description":"The color to put in the string"}],"class":"function","name":"fromColor","description":" Converts color to a string."},"utf8offset":{"path":"libs_sh/string.lua#L376","returns":[{"type":"number","value":"number Starting byte-index of the given position","description":"Starting byte-index of the given position"}],"realm":"shared","params":[{"type":"string","value":"string str The string that you will get the byte position from","name":"str","description":"The string that you will get the byte position from"},{"type":"number","value":"number n The position to get the beginning byte position from","name":"n","description":"The position to get the beginning byte position from"},{"type":"number?","value":"number? startPos The offset for n. Defaults to 1 if n >= 0, otherwise -1","name":"startPos","description":"The offset for n. Defaults to 1 if n >= 0, otherwise -1"}],"class":"function","name":"utf8offset","description":" Returns the byte-index of the n'th UTF-8-character after the given startPos (nil if none).\n startPos defaults to 1 when n is positive and -1 when n is negative. If n is zero,\n this function instead returns the byte-index of the UTF-8-character startPos lies within."},"utf8len":{"path":"libs_sh/string.lua#L366","returns":[{"type":"number|boolean","value":"number|boolean The number of UTF-8 characters in the string. If there are invalid bytes, this will be false","description":"The number of UTF-8 characters in the string. If there are invalid bytes, this will be false"},{"type":"number?","value":"number? The position of the first invalid byte. If there were no invalid bytes, this will be nil","description":"The position of the first invalid byte. If there were no invalid bytes, this will be nil"}],"realm":"shared","params":[{"type":"string","value":"string str The string to calculate the length of","name":"str","description":"The string to calculate the length of"},{"type":"number?","value":"number? startPos The starting position to get the length from","name":"startPos","description":"The starting position to get the length from"},{"type":"number?","value":"number? endPos The ending position to get the length from","name":"endPos","description":"The ending position to get the length from"}],"class":"function","name":"utf8len","description":" Returns the number of UTF-8 sequences in the given string between positions startPos and endPos (both inclusive).\n If it finds any invalid UTF-8 byte sequence, returns false as well as the position of the first invalid byte."},"utf8codes":{"path":"libs_sh/string.lua#L353","returns":[{"type":"function","value":"function The iterator (to be used in a for loop)","description":"The iterator (to be used in a for loop)"}],"realm":"shared","params":[{"type":"string","value":"string str The string that you will get the codes from","name":"str","description":"The string that you will get the codes from"}],"class":"function","name":"utf8codes","description":" Returns an iterator (like string.gmatch) which returns both the position and codepoint of each utf8 character in the string.\n It raises an error if it meets any invalid byte sequence."},"toMinutesSeconds":{"path":"libs_sh/string.lua#L264","returns":[{"type":"string","value":"string Given time in \"MM:SS\" format","description":"Given time in \"MM:SS\" format"}],"realm":"shared","params":[{"type":"number","value":"number time Time in seconds","name":"time","description":"Time in seconds"}],"class":"function","name":"toMinutesSeconds","description":" Converts time to minutes and seconds string."},"utf8codepoint":{"path":"libs_sh/string.lua#L344","returns":[{"type":"...","value":"... The codepoint number(s)","description":"The codepoint number(s)"}],"realm":"shared","params":[{"type":"string","value":"string str The string that you will get the code(s) from","name":"str","description":"The string that you will get the code(s) from"},{"type":"number?","value":"number? startPos The starting byte of the string to get the codepoint of","name":"startPos","description":"The starting byte of the string to get the codepoint of"},{"type":"number?","value":"number? endPos The ending byte of the string to get the codepoint of","name":"endPos","description":"The ending byte of the string to get the codepoint of"}],"class":"function","name":"utf8codepoint","description":" Returns the codepoints (as numbers) from all characters in the given string that start between byte position startPos and endPos.\n It raises an error if it meets any invalid byte sequence."},"niceTime":{"path":"libs_sh/string.lua#L175","returns":[{"type":"string","value":"string A nicely formatted time string","description":"A nicely formatted time string"}],"realm":"shared","params":[{"type":"number","value":"number time The number to format, in seconds","name":"time","description":"The number to format, in seconds"}],"class":"function","name":"niceTime","description":" Formats the supplied number (in seconds) to the highest possible time unit"},"upper":{"path":"libs_sh/string.lua#L323","returns":[{"type":"string","value":"string String with all letters upper case","description":"String with all letters upper case"}],"realm":"shared","params":[{"type":"string","value":"string str The string to convert","name":"str","description":"The string to convert"}],"class":"function","name":"upper","description":" Changes any lower-case letters in a string to upper-case letters."},"sub":{"path":"libs_sh/string.lua#L254","returns":[{"type":"string","value":"string The sub-string","description":"The sub-string"}],"realm":"shared","params":[{"type":"string","value":"string str The string you'll take a sub-string out of","name":"str","description":"The string you'll take a sub-string out of"},{"type":"number","value":"number startPos The position of the first character that will be included in the sub-string","name":"startPos","description":"The position of the first character that will be included in the sub-string"},{"type":"number?","value":"number? endPos The position of the last character to be included in the sub-string. It can be negative to count from the end","name":"endPos","description":"The position of the last character to be included in the sub-string. It can be negative to count from the end"}],"class":"function","name":"sub","description":" Returns a sub-string, starting from the character at position startPos of the string (inclusive)\n and optionally ending at the character at position endPos of the string (also inclusive).\n If EndPos is not given, the rest of the string is returned."},"normalizePath":{"path":"libs_sh/string.lua#L329","returns":[{"type":"string","value":"string Path with all .. replaced","description":"Path with all .. replaced"}],"realm":"shared","params":[{"type":"string","value":"string str Path","name":"str","description":"Path"}],"class":"function","name":"normalizePath","description":" Returns a path with all .. accounted for"},"utf8char":{"path":"libs_sh/string.lua#L337","returns":[{"type":"string","value":"string UTF-8 string generated from given arguments","description":"UTF-8 string generated from given arguments"}],"realm":"shared","params":[{"type":"...","value":"... codepoints Unicode code points to be converted in to a UTF-8 string","name":"codepoints","description":"Unicode code points to be converted in to a UTF-8 string"}],"class":"function","name":"utf8char","description":" Receives zero or more integers, converts each one to its corresponding UTF-8 byte sequence\n and returns a string with the concatenation of all these sequences"},"trimRight":{"path":"libs_sh/string.lua#L316","returns":[{"type":"string","value":"string Trimmed string","description":"Trimmed string"}],"realm":"shared","params":[{"type":"string","value":"string str The string to trim","name":"str","description":"The string to trim"},{"type":"string","value":"string char Optional character to be trimmed. Defaults to space character","name":"char","description":"Optional character to be trimmed. Defaults to space character"}],"class":"function","name":"trimRight","description":" Removes trailing spaces/characters from a string."},"patternSafe":{"path":"libs_sh/string.lua#L181","returns":[{"type":"string","value":"string The sanitized string","description":"The sanitized string"}],"realm":"shared","params":[{"type":"string","value":"string str The string to be sanitized","name":"str","description":"The string to be sanitized"}],"class":"function","name":"patternSafe","description":" Escapes all special characters within a string, making the string safe for inclusion in a Lua pattern."},"trimLeft":{"path":"libs_sh/string.lua#L309","returns":[{"type":"string","value":"string Trimmed string","description":"Trimmed string"}],"realm":"shared","params":[{"type":"string","value":"string str The string to trim","name":"str","description":"The string to trim"},{"type":"string?","value":"string? char Optional character to be trimmed. Defaults to space character","name":"char","description":"Optional character to be trimmed. Defaults to space character"}],"class":"function","name":"trimLeft","description":" Removes leading spaces/characters from a string"},"trim":{"path":"libs_sh/string.lua#L302","returns":[{"type":"string","value":"string Trimmed string","description":"Trimmed string"}],"realm":"shared","params":[{"type":"string","value":"string str The string to trim","name":"str","description":"The string to trim"},{"type":"string?","value":"string? char Optional character to be trimmed. Defaults to space character","name":"char","description":"Optional character to be trimmed. Defaults to space character"}],"class":"function","name":"trim","description":" Removes leading and trailing spaces/characters of a string"},"endsWith":{"path":"libs_sh/string.lua#L60","returns":[{"type":"boolean","value":"boolean True if the first string ends with the second, or the second is empty","description":"True if the first string ends with the second, or the second is empty"}],"realm":"shared","params":[{"type":"string","value":"string str The string whose end is to be checked","name":"str","description":"The string whose end is to be checked"},{"type":"string","value":"string end The string to be matched with the end of the first","name":"end","description":"The string to be matched with the end of the first"}],"class":"function","name":"endsWith","description":" Whether or not the second passed string matches the end of the first."},"left":{"path":"libs_sh/string.lua#L142","returns":[{"type":"string","value":"string Returns a string containing a specified number of characters from the left side of a string","description":"Returns a string containing a specified number of characters from the left side of a string"}],"realm":"shared","params":[{"type":"string","value":"string str The string to extract from","name":"str","description":"The string to extract from"},{"type":"number","value":"number num Amount of chars relative to the beginning (starting from 1)","name":"num","description":"Amount of chars relative to the beginning (starting from 1)"}],"class":"function","name":"left","description":" Returns everything left of supplied place of that string."},"stripExtension":{"path":"libs_sh/string.lua#L248","returns":[{"type":"string","value":"string Path without the extension","description":"Path without the extension"}],"realm":"shared","params":[{"type":"string","value":"string path The file-path to change","name":"path","description":"The file-path to change"}],"class":"function","name":"stripExtension","description":" Removes the extension of a path"},"toColor":{"path":"libs_sh/string.lua#L25","returns":[{"type":"Color","value":"Color The color object","description":"The color object"}],"realm":"shared","params":[{"type":"string","value":"string str The string to convert from","name":"str","description":"The string to convert from"}],"class":"function","name":"toColor","description":" Converts string with RGBA values separated by spaces into a color."},"lower":{"path":"libs_sh/string.lua#L155","returns":[{"type":"string","value":"string String with all uppercase letters replaced with their lowercase variants","description":"String with all uppercase letters replaced with their lowercase variants"}],"realm":"shared","params":[{"type":"string","value":"string str The string to convert","name":"str","description":"The string to convert"}],"class":"function","name":"lower","description":" Changes any upper-case letters in a string to lower-case letters."},"dump":{"path":"libs_sh/string.lua#L53","returns":[{"type":"string","value":"string The bytecode","description":"The bytecode"}],"realm":"shared","params":[{"type":"function","value":"function func The function to get the bytecode of","name":"func","description":"The function to get the bytecode of"},{"type":"boolean?","value":"boolean? strip True to strip the debug data, false to keep it. Defaults to false","name":"strip","description":"True to strip the debug data, false to keep it. Defaults to false"}],"class":"function","name":"dump","description":" Returns the binary bytecode of the given function."},"getExtensionFromFilename":{"path":"libs_sh/string.lua#L101","returns":[{"type":"string","value":"string The extension","description":"The extension"}],"realm":"shared","params":[{"type":"string","value":"string str File-path to get the file extensions from","name":"str","description":"File-path to get the file extensions from"}],"class":"function","name":"getExtensionFromFilename","description":" Returns extension of the file-path."},"find":{"path":"libs_sh/string.lua#L75","returns":[{"type":"number?","value":"number? Starting position of the found text, or nil if the text wasn't found","description":"Starting position of the found text, or nil if the text wasn't found"},{"type":"number?","value":"number? Ending position of found text, or nil if the text wasn't found","description":"Ending position of found text, or nil if the text wasn't found"},{"type":"string?","value":"string? Matched text for each group if patterns are enabled and used, or nil if the text wasn't found","description":"Matched text for each group if patterns are enabled and used, or nil if the text wasn't found"}],"realm":"shared","params":[{"type":"string","value":"string haystack The string to search in","name":"haystack","description":"The string to search in"},{"type":"string","value":"string needle The string to find, can contain patterns if enabled","name":"needle","description":"The string to find, can contain patterns if enabled"},{"type":"number","value":"number start The position to start the search from, negative start position will be relative to the end position","name":"start","description":"The position to start the search from, negative start position will be relative to the end position"},{"type":"boolean?","value":"boolean? noPatterns Disable patterns. Defaults to false","name":"noPatterns","description":"Disable patterns. Defaults to false"}],"class":"function","name":"find","description":" Attempts to find the specified substring in a string, uses Patterns by default. https://wiki.facepunch.com/gmod/Patterns"},"explode":{"path":"libs_sh/string.lua#L67","returns":[{"type":"table","value":"table Table with the separated strings in numerical sequential order","description":"Table with the separated strings in numerical sequential order"}],"realm":"shared","params":[{"type":"string","value":"string separator The separator that will split the string","name":"separator","description":"The separator that will split the string"},{"type":"string","value":"string str The string to split up","name":"str","description":"The string to split up"},{"type":"boolean?","value":"boolean? patterns Set this to true if your separator is a pattern. Defaults to false","name":"patterns","description":"Set this to true if your separator is a pattern. Defaults to false"}],"class":"function","name":"explode","description":" Splits a string up wherever it finds the given separator"},"byte":{"path":"libs_sh/string.lua#L33","returns":[{"type":"...","value":"... Vararg numerical bytes","description":"Vararg numerical bytes"}],"realm":"shared","params":[{"type":"string","value":"string str The string to get the chars from","name":"str","description":"The string to get the chars from"},{"type":"number","value":"number start The first character of the string to get the byte of","name":"start","description":"The first character of the string to get the byte of"},{"type":"number","value":"number end The last character of the string to get the byte of","name":"end","description":"The last character of the string to get the byte of"}],"class":"function","name":"byte","description":" Returns the given string's characters in their numeric ASCII representation."},"toTable":{"path":"libs_sh/string.lua#L294","returns":[{"type":"table","value":"table A sequential table where each value is a character from the given string","description":"A sequential table where each value is a character from the given string"}],"realm":"shared","params":[{"type":"string","value":"string str The string to turn into a table","name":"str","description":"The string to turn into a table"}],"class":"function","name":"toTable","description":" Splits the string into characters and creates a sequential table of characters.\n As a result of the encoding, non-ASCII characters will be split into more than one character in the output table.\n Each character value in the output table will always be 1 byte."},"toHoursMinutesSecondsMilliseconds":{"path":"libs_sh/string.lua#L285","returns":[{"type":"string","value":"string Returns given time in \"HH:MM:SS.MS\" format","description":"Returns given time in \"HH:MM:SS.MS\" format"}],"realm":"shared","params":[{"type":"number","value":"number time Time in seconds","name":"time","description":"Time in seconds"}],"class":"function","name":"toHoursMinutesSecondsMilliseconds","description":" Converts time to hours, minutes, seconds and milliseconds string."},"match":{"path":"libs_sh/string.lua#L161","returns":[{"type":"...","value":"... Vararg matched string(s)","description":"Vararg matched string(s)"}],"realm":"shared","params":[{"type":"string","value":"string str String which should be searched in for matches","name":"str","description":"String which should be searched in for matches"},{"type":"string","value":"string pattern The pattern that defines what should be matched","name":"pattern","description":"The pattern that defines what should be matched"},{"type":"number?","value":"number? start The start index to start the matching from, negative to start the match from a position relative to the end. Default 1","name":"start","description":"The start index to start the matching from, negative to start the match from a position relative to the end. Default 1"}],"class":"function","name":"match","description":" Finds a Pattern in a string."},"niceSize":{"path":"libs_sh/string.lua#L169","returns":[{"type":"string","value":"string The human-readable filesize, in Bytes/KB/MB/GB (whichever is appropriate)","description":"The human-readable filesize, in Bytes/KB/MB/GB (whichever is appropriate)"}],"realm":"shared","params":[{"type":"number","value":"number size The filesize in bytes","name":"size","description":"The filesize in bytes"}],"class":"function","name":"niceSize","description":" Converts a digital filesize to human-readable text."}},"tables":[],"path":"libs_sh/string.lua#L4","libtbl":["string_library"],"realm":"shared","fields":[],"class":"library","name":"string","description":" Lua string library https://wiki.garrysmod.com/page/Category:string"},"sound":{"methods":{"exists":{"path":"libs_sh/sound.lua#L119","returns":[{"type":"boolean","value":"boolean True if exists, false if not","description":"True if exists, false if not"}],"realm":"shared","params":[{"type":"string","value":"string path String path to the sound file","name":"path","description":"String path to the sound file"}],"class":"function","name":"exists","description":" Returns true if the sound or sound property exists."},"duration":{"path":"libs_sh/sound.lua#L111","returns":[{"type":"number","value":"number Number duration in seconds","description":"Number duration in seconds"}],"realm":"shared","params":[{"type":"string","value":"string path String path to the sound file","name":"path","description":"String path to the sound file"}],"class":"function","name":"duration","description":" Returns the sound duration in seconds. May not work for all file-types on linux/macos"},"emitSoundsLeft":{"path":"libs_sh/entities.lua#L315","returns":[{"type":"number","value":"number The number of sounds left","description":"The number of sounds left"}],"realm":"shared","class":"function","name":"emitSoundsLeft","description":" Returns the number of sound emits left"},"soundsLeft":{"path":"libs_sh/sound.lua#L105","returns":[{"type":"number","value":"number The number of sounds left","description":"The number of sounds left"}],"realm":"shared","class":"function","name":"soundsLeft","description":" Returns the number of sounds left that can be created"},"canEmitSound":{"path":"libs_sh/entities.lua#L309","returns":[{"type":"boolean","value":"boolean If it is possible to emit a sound","description":"If it is possible to emit a sound"}],"realm":"shared","class":"function","name":"canEmitSound","description":" Returns if a sound is able to be emitted from an entity"},"create":{"path":"libs_sh/sound.lua#L70","returns":[{"type":"Sound","value":"Sound Sound Object","description":"Sound Object"}],"realm":"shared","params":[{"type":"Entity","value":"Entity ent Entity to attach sound to.","name":"ent","description":"Entity to attach sound to."},{"type":"string","value":"string path Filepath to the sound file.","name":"path","description":"Filepath to the sound file."},{"type":"boolean?","value":"boolean? nofilter (Optional) Boolean Make the sound play for everyone regardless of range or location. Only affects Server-side sounds.","name":"nofilter","description":"(Optional) Boolean Make the sound play for everyone regardless of range or location. Only affects Server-side sounds."}],"class":"function","name":"create","description":" Creates a sound and attaches it to an entity"},"canCreate":{"path":"libs_sh/sound.lua#L99","returns":[{"type":"boolean","value":"boolean If it is possible to make a sound","description":"If it is possible to make a sound"}],"realm":"shared","class":"function","name":"canCreate","description":" Returns if a sound is able to be created"}},"tables":[],"path":"libs_sh/sound.lua#L19","libtbl":["sound_library"],"realm":"shared","fields":[],"class":"library","name":"sound","description":" Sound library."},"render":{"methods":{"setFogEnd":{"path":"libs_cl/render.lua#L2652","realm":"client","params":[{"type":"number","value":"number distance End distance","name":"distance","description":"End distance"}],"class":"function","name":"setFogEnd","description":" Sets distance at which the fog will reach it's target density"},"setRGBA":{"path":"libs_cl/render.lua#L889","realm":"client","params":[{"type":"number","value":"number r Number, red value","name":"r","description":"Number, red value"},{"type":"number","value":"number g Number, green value","name":"g","description":"Number, green value"},{"type":"number","value":"number b Number, blue value","name":"b","description":"Number, blue value"},{"type":"number","value":"number a Number, alpha value","name":"a","description":"Number, alpha value"}],"class":"function","name":"setRGBA","description":" Sets the draw color by RGBA values"},"getTintRGBA":{"path":"libs_cl/render.lua#L913","returns":[{"type":"number","value":"number The red channel value. Color The current color & blend modulation as a color","description":"The red channel value. Color The current color & blend modulation as a color"},{"type":"number","value":"number The green channel value.","description":"The green channel value."},{"type":"number","value":"number The blue channel value.","description":"The blue channel value."},{"type":"number","value":"number The alpha channel value.","description":"The alpha channel value."}],"realm":"client","class":"function","name":"getTintRGBA","description":" Gets the drawing tint. Internally, calls render.getColorModulation and render.getBlend, multiplies the values by 255, then returns a color object."},"clearBuffersObeyStencil":{"path":"libs_cl/render.lua#L619","realm":"client","params":[{"type":"number","value":"number r Value of the red channel to clear the current rt with.","name":"r","description":"Value of the red channel to clear the current rt with."},{"type":"number","value":"number g Value of the green channel to clear the current rt with.","name":"g","description":"Value of the green channel to clear the current rt with."},{"type":"number","value":"number b Value of the blue channel to clear the current rt with.","name":"b","description":"Value of the blue channel to clear the current rt with."},{"type":"number","value":"number a Value of the alpha channel to clear the current rt with.","name":"a","description":"Value of the alpha channel to clear the current rt with."},{"type":"boolean","value":"boolean Clear the depth buffer.","name":"Clear","description":"the depth buffer."}],"class":"function","name":"clearBuffersObeyStencil","description":" Clears the current rendertarget for obeying the current stencil buffer conditions."},"popViewMatrix":{"path":"libs_cl/render.lua#L817","realm":"client","class":"function","name":"popViewMatrix","description":" Pops a view matrix from the matrix stack."},"overrideBlend":{"path":"libs_cl/render.lua#L1939","realm":"client","params":[{"type":"boolean","value":"boolean on Whether to control the blend mode of upcoming rendering","name":"on","description":"Whether to control the blend mode of upcoming rendering"},{"type":"number","value":"number srcBlend http://wiki.facepunch.com/gmod/Enums/BLEND","name":"srcBlend","description":"http://wiki.facepunch.com/gmod/Enums/BLEND"},{"type":"number","value":"number destBlend","name":"destBlend","description":""},{"type":"number","value":"number blendFunc http://wiki.facepunch.com/gmod/Enums/BLENDFUNC","name":"blendFunc","description":"http://wiki.facepunch.com/gmod/Enums/BLENDFUNC"},{"type":"number?","value":"number? srcBlendAlpha http://wiki.facepunch.com/gmod/Enums/BLEND","name":"srcBlendAlpha","description":"http://wiki.facepunch.com/gmod/Enums/BLEND"},{"type":"number?","value":"number? destBlendAlpha","name":"destBlendAlpha","description":""},{"type":"number?","value":"number? blendFuncAlpha http://wiki.facepunch.com/gmod/Enums/BLENDFUNC","name":"blendFuncAlpha","description":"http://wiki.facepunch.com/gmod/Enums/BLENDFUNC"}],"class":"function","name":"overrideBlend","description":" Enables blend mode control. Read OpenGL or DirectX docs for more info"},"setFogHeight":{"path":"libs_cl/render.lua#L2661","realm":"client","params":[{"type":"number","value":"number height The fog height","name":"height","description":"The fog height"}],"class":"function","name":"setFogHeight","description":" Sets the height below which fog will be rendered. Only works with fog mode 2, MATERIAL_FOG.LINEAR_BELOW_FOG_Z"},"drawPixelsRGB":{"path":"libs_cl/render.lua#L1640","realm":"client","params":[{"type":"number","value":"number w Width of image to be drawn.","name":"w","description":"Width of image to be drawn."},{"type":"number","value":"number h Height of image to be drawn.","name":"h","description":"Height of image to be drawn."},{"type":"table","value":"table dataR Red channel data.","name":"dataR","description":"Red channel data."},{"type":"table","value":"table dataG Green channel data.","name":"dataG","description":"Green channel data."},{"type":"table","value":"table dataB Blue channel data.","name":"dataB","description":"Blue channel data."}],"class":"function","name":"drawPixelsRGB","description":" Draws RGB color channel tables to current render target."},"draw3DSprite":{"path":"libs_cl/render.lua#L1980","realm":"client","params":[{"type":"Vector","value":"Vector pos Position of the sprite.","name":"pos","description":"Position of the sprite."},{"type":"number","value":"number width Width of the sprite.","name":"width","description":"Width of the sprite."},{"type":"number","value":"number height Height of the sprite.","name":"height","description":"Height of the sprite."},{"type":"Color?","value":"Color? Color tint to give the sprite. Default: white","name":"Color","description":"tint to give the sprite. Default: white"}],"class":"function","name":"draw3DSprite","description":" Draws a sprite in 3d space."},"clearRGBA":{"path":"libs_cl/render.lua#L1298","returns":[{"type":"number","value":"number The red channel value.","description":"The red channel value."},{"type":"number","value":"number The green channel value.","description":"The green channel value."},{"type":"number","value":"number The blue channel value.","description":"The blue channel value."},{"type":"number","value":"number The alpha channel value.","description":"The alpha channel value."}],"realm":"client","params":[{"type":"boolean?","value":"boolean? depth Boolean if should clear depth. Default false","name":"depth","description":"Boolean if should clear depth. Default false"}],"class":"function","name":"clearRGBA","description":" Clears the active render target"},"drawTexturedRectRotatedFast":{"path":"libs_cl/render.lua#L1583","realm":"client","params":[{"type":"number","value":"number x X coordinate of center of rect","name":"x","description":"X coordinate of center of rect"},{"type":"number","value":"number y Y coordinate of center of rect","name":"y","description":"Y coordinate of center of rect"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"},{"type":"number","value":"number rot Rotation in degrees","name":"rot","description":"Rotation in degrees"}],"class":"function","name":"drawTexturedRectRotatedFast","description":" Draws a rotated, textured rectangle.\n Faster, but uses integer coordinates and will get clipped by user's screen resolution"},"drawPixelsRGBA":{"path":"libs_cl/render.lua#L1656","realm":"client","params":[{"type":"number","value":"number w Width of image to be drawn.","name":"w","description":"Width of image to be drawn."},{"type":"number","value":"number h Height of image to be drawn.","name":"h","description":"Height of image to be drawn."},{"type":"table","value":"table dataR Red channel data.","name":"dataR","description":"Red channel data."},{"type":"table","value":"table dataG Green channel data.","name":"dataG","description":"Green channel data."},{"type":"table","value":"table dataB Blue channel data.","name":"dataB","description":"Blue channel data."},{"type":"table","value":"table dataA Alpha channel data.","name":"dataA","description":"Alpha channel data."}],"class":"function","name":"drawPixelsRGBA","description":" Draws RGBA color channel tables to current render target."},"popCustomClipPlane":{"path":"libs_cl/render.lua#L2572","realm":"client","class":"function","name":"popCustomClipPlane","description":" Removes the current active clipping plane from the clip plane stack."},"drawRoundedBox":{"path":"libs_cl/render.lua#L1312","realm":"client","params":[{"type":"number","value":"number r The corner radius","name":"r","description":"The corner radius"},{"type":"number","value":"number x Top left corner x coordinate","name":"x","description":"Top left corner x coordinate"},{"type":"number","value":"number y Top left corner y coordinate","name":"y","description":"Top left corner y coordinate"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"}],"class":"function","name":"drawRoundedBox","description":" Draws a rounded rectangle using the current color"},"enableClipping":{"path":"libs_cl/render.lua#L2541","returns":[{"type":"boolean","value":"boolean Previous clipping state.","description":"Previous clipping state."}],"realm":"client","params":[{"type":"boolean","value":"boolean state New clipping state.","name":"state","description":"New clipping state."}],"class":"function","name":"enableClipping","description":" Sets the status of the clip renderer, returning previous state."},"draw3DBox":{"path":"libs_cl/render.lua#L2031","realm":"client","params":[{"type":"Vector","value":"Vector origin Origin of the box.","name":"origin","description":"Origin of the box."},{"type":"Angle","value":"Angle angle Orientation of the box","name":"angle","description":"Orientation of the box"},{"type":"Vector","value":"Vector mins Start position of the box, relative to origin.","name":"mins","description":"Start position of the box, relative to origin."},{"type":"Vector","value":"Vector maxs End position of the box, relative to origin.","name":"maxs","description":"End position of the box, relative to origin."}],"class":"function","name":"draw3DBox","description":" Draws a box in 3D space"},"draw3DQuadEasy":{"path":"libs_cl/render.lua#L2120","realm":"client","params":[{"type":"Vector","value":"Vector pos Origin of the quad.","name":"pos","description":"Origin of the quad."},{"type":"Vector","value":"Vector normal The face direction of the quad.","name":"normal","description":"The face direction of the quad."},{"type":"number","value":"number width The width of the quad.","name":"width","description":"The width of the quad."},{"type":"number","value":"number height The height of the quad.","name":"height","description":"The height of the quad."},{"type":"number?","value":"number? rot The rotation of the quad counter-clockwise in degrees around the normal axis. In other words, the quad will always face the same way but this will rotate its corners.","name":"rot","description":"The rotation of the quad counter-clockwise in degrees around the normal axis. In other words, the quad will always face the same way but this will rotate its corners."}],"class":"function","name":"draw3DQuadEasy","description":" Draws a quad."},"add3DBeam":{"path":"libs_cl/render.lua#L2084","realm":"client","params":[{"type":"Vector","value":"Vector startPos Beam start position.","name":"startPos","description":"Beam start position."},{"type":"number","value":"number width The width of the beam.","name":"width","description":"The width of the beam."},{"type":"number","value":"number textureEnd The end coordinate of the texture used.","name":"textureEnd","description":"The end coordinate of the texture used."},{"type":"Color","value":"Color color The color to be used.","name":"color","description":"The color to be used."}],"class":"function","name":"add3DBeam","description":" Adds a beam segment to the beam started by render.start3DBeam."},"drawRectOutline":{"path":"libs_cl/render.lua#L1402","realm":"client","params":[{"type":"number","value":"number x Top left corner x integer coordinate","name":"x","description":"Top left corner x integer coordinate"},{"type":"number","value":"number y Top left corner y integer coordinate","name":"y","description":"Top left corner y integer coordinate"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"},{"type":"number?","value":"number? thickness Optional inset border width","name":"thickness","description":"Optional inset border width"}],"class":"function","name":"drawRectOutline","description":" Draws a rectangle outline using the current color."},"start3DBeam":{"path":"libs_cl/render.lua#L2077","realm":"client","params":[{"type":"number","value":"number segmentCount The number of Beam Segments that this multi-segment Beam will contain","name":"segmentCount","description":"The number of Beam Segments that this multi-segment Beam will contain"}],"class":"function","name":"start3DBeam","description":" Begin drawing a multi-segment beam."},"drawTexturedTriangleUV":{"path":"libs_cl/render.lua#L1626","realm":"client","params":[{"type":"table","value":"table vert1 First vertex. {x = x1, y = y1, u = u1, v = v1}","name":"vert1","description":"First vertex. {x = x1, y = y1, u = u1, v = v1}"},{"type":"table","value":"table vert2 The second vertex.","name":"vert2","description":"The second vertex."},{"type":"table","value":"table vert3 The third vertex.","name":"vert3","description":"The third vertex."}],"class":"function","name":"drawTexturedTriangleUV","description":" Draws a textured triangle with UV coordinates"},"getResolution":{"path":"libs_cl/render.lua#L2355","returns":[{"type":"number","value":"number the X size of the current render context","description":"the X size of the current render context"},{"type":"number","value":"number the Y size of the current render context","description":"the Y size of the current render context"}],"realm":"client","class":"function","name":"getResolution","description":" Returns the render context's width and height. If a rendertarget is selected, will return 1024, 1024"},"traceSurfaceColor":{"path":"libs_cl/render.lua#L2376","returns":[{"type":"Color","value":"Color The color","description":"The color"}],"realm":"client","params":[{"type":"Vector","value":"Vector startpos The starting vector","name":"startpos","description":"The starting vector"},{"type":"Vector","value":"Vector endpos The ending vector","name":"endpos","description":"The ending vector"}],"class":"function","name":"traceSurfaceColor","description":" Does a trace and returns the color of the textel the trace hits."},"setStencilPassOperation":{"path":"libs_cl/render.lua#L659","realm":"client","params":[{"type":"number","value":"number operation","name":"operation","description":""}],"class":"function","name":"setStencilPassOperation","description":" Sets the operation to be performed on the stencil buffer values if the compare function was successful. More: http://wiki.facepunch.com/gmod/render.SetStencilPassOperation"},"drawTexturedRectRotated":{"path":"libs_cl/render.lua#L1596","realm":"client","params":[{"type":"number","value":"number x X coordinate of center of rect","name":"x","description":"X coordinate of center of rect"},{"type":"number","value":"number y Y coordinate of center of rect","name":"y","description":"Y coordinate of center of rect"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"},{"type":"number","value":"number rot Rotation in degrees","name":"rot","description":"Rotation in degrees"}],"class":"function","name":"drawTexturedRectRotated","description":" Draws a rotated, textured rectangle."},"getViewSetup":{"path":"libs_cl/render.lua#L2290","returns":[{"type":"table","value":"table A table describing the current view setup. See https://wiki.facepunch.com/gmod/Structures/ViewSetup for more information.","description":"A table describing the current view setup. See https://wiki.facepunch.com/gmod/Structures/ViewSetup for more information."}],"realm":"client","params":[{"type":"boolean?","value":"boolean? curview If true, returns the current calculated view setup, otherwise returns original player view setup","name":"curview","description":"If true, returns the current calculated view setup, otherwise returns original player view setup"}],"class":"function","name":"getViewSetup","description":" Returns information about the current view setup."},"setStencilReferenceValue":{"path":"libs_cl/render.lua#L675","realm":"client","params":[{"type":"number","value":"number referenceValue Reference value.","name":"referenceValue","description":"Reference value."}],"class":"function","name":"setStencilReferenceValue","description":" Sets the reference value which will be used for all stencil operations. This is an unsigned integer."},"draw3DLine":{"path":"libs_cl/render.lua#L2018","realm":"client","params":[{"type":"Vector","value":"Vector startPos Starting position","name":"startPos","description":"Starting position"},{"type":"Vector","value":"Vector endPos Ending position","name":"endPos","description":"Ending position"},{"type":"boolean?","value":"boolean? writeZ Optional should the line be drawn with depth considered (default: true)","name":"writeZ","description":"Optional should the line be drawn with depth considered (default: true)"}],"class":"function","name":"draw3DLine","description":" Draws a 3D Line"},"getMatrix":{"path":"libs_cl/render.lua#L756","returns":[{"type":"VMatrix","value":"VMatrix The currently active matrix.","description":"The currently active matrix."}],"realm":"client","class":"function","name":"getMatrix","description":" Returns a copy of the model matrix that is at the top of the stack."},"setModelLighting":{"path":"libs_cl/render.lua#L600","realm":"client","params":[{"type":"number","value":"number lightDirection The light source to edit, builtins.BOX enumeration.","name":"lightDirection","description":"The light source to edit, builtins.BOX enumeration."},{"type":"number","value":"number r The red component of the light color.","name":"r","description":"The red component of the light color."},{"type":"number","value":"number g The green component of the light color.","name":"g","description":"The green component of the light color."},{"type":"number","value":"number b The blue component of the light color.","name":"b","description":"The blue component of the light color."}],"class":"function","name":"setModelLighting","description":" Sets up the ambient lighting for any upcoming render operation. Ambient lighting can be seen as a cube enclosing the object to be drawn, each of its faces representing a directional light source that shines towards the object."},"draw3DWireframeBox":{"path":"libs_cl/render.lua#L2046","realm":"client","params":[{"type":"Vector","value":"Vector origin Origin of the box.","name":"origin","description":"Origin of the box."},{"type":"Angle","value":"Angle angle Orientation of the box","name":"angle","description":"Orientation of the box"},{"type":"Vector","value":"Vector mins Start position of the box, relative to origin.","name":"mins","description":"Start position of the box, relative to origin."},{"type":"Vector","value":"Vector maxs End position of the box, relative to origin.","name":"maxs","description":"End position of the box, relative to origin."},{"type":"boolean?","value":"boolean? writeZ Optional should the box be drawn with depth considered (default: true)","name":"writeZ","description":"Optional should the box be drawn with depth considered (default: true)"}],"class":"function","name":"draw3DWireframeBox","description":" Draws a wireframe box in 3D space"},"draw3DWireframeSphere":{"path":"libs_cl/render.lua#L2003","realm":"client","params":[{"type":"Vector","value":"Vector pos Position of the sphere","name":"pos","description":"Position of the sphere"},{"type":"number","value":"number radius Radius of the sphere","name":"radius","description":"Radius of the sphere"},{"type":"number","value":"number longitudeSteps The amount of longitude steps. The larger this number is, the smoother the sphere is","name":"longitudeSteps","description":"The amount of longitude steps. The larger this number is, the smoother the sphere is"},{"type":"number","value":"number latitudeSteps The amount of latitude steps. The larger this number is, the smoother the sphere is","name":"latitudeSteps","description":"The amount of latitude steps. The larger this number is, the smoother the sphere is"},{"type":"boolean?","value":"boolean? writeZ Optional should the sphere be drawn with depth considered (default: true)","name":"writeZ","description":"Optional should the sphere be drawn with depth considered (default: true)"}],"class":"function","name":"draw3DWireframeSphere","description":" Draws a wireframe sphere"},"drawRectFast":{"path":"libs_cl/render.lua#L1352","realm":"client","params":[{"type":"number","value":"number x Top left corner x","name":"x","description":"Top left corner x"},{"type":"number","value":"number y Top left corner y","name":"y","description":"Top left corner y"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"}],"class":"function","name":"drawRectFast","description":" Draws a rectangle using the current color\n Faster, but uses integer coordinates and will get clipped by user's screen resolution"},"setScreenDimensions":{"path":"libs_cl/render.lua#L2691","realm":"client","params":[{"type":"Entity","value":"Entity screen The custom screen to be resized","name":"screen","description":"The custom screen to be resized"},{"type":"number","value":"number x The x offset of the screen","name":"x","description":"The x offset of the screen"},{"type":"number","value":"number y The y offset of the screen","name":"y","description":"The y offset of the screen"},{"type":"number","value":"number w The width of the screen","name":"w","description":"The width of the screen"},{"type":"number","value":"number h The height of the screen","name":"h","description":"The height of the screen"}],"class":"function","name":"setScreenDimensions","description":" Using the custom screen model, sets the screen offset and size as long as its within bounds of -1024 to 1024 units"},"setColor":{"path":"libs_cl/render.lua#L862","realm":"client","params":[{"type":"Color","value":"Color clr Color type","name":"clr","description":"Color type"}],"class":"function","name":"setColor","description":" Sets the draw color"},"setChipOverlay":{"path":"libs_cl/render.lua#L2679","realm":"client","params":[{"type":"string?","value":"string? name The name of the RT to use or nil to set it back to normal","name":"name","description":"The name of the RT to use or nil to set it back to normal"}],"class":"function","name":"setChipOverlay","description":" Sets the overlay of the chip to a user's rendertarget"},"setBackgroundColor":{"path":"libs_cl/render.lua#L830","realm":"client","params":[{"type":"Color","value":"Color col Color of background","name":"col","description":"Color of background"},{"type":"Entity?","value":"Entity? screen (Optional) entity of screen","name":"screen","description":"(Optional) entity of screen"}],"class":"function","name":"setBackgroundColor","description":" Sets background color of screen"},"pushCustomClipPlane":{"path":"libs_cl/render.lua#L2556","realm":"client","params":[{"type":"Vector","value":"Vector normal The normal of the clipping plane.","name":"normal","description":"The normal of the clipping plane."},{"type":"number","value":"number distance The normal of the clipping plane.","name":"distance","description":"The normal of the clipping plane."}],"class":"function","name":"pushCustomClipPlane","description":" Pushes a new clipping plane of the clip plane stack."},"setMaterialEffectSub":{"path":"libs_cl/render.lua#L1003","realm":"client","params":[{"type":"Material","value":"Material mat The material object to use the texture of, or the name of a rendertarget to use instead.","name":"mat","description":"The material object to use the texture of, or the name of a rendertarget to use instead."}],"class":"function","name":"setMaterialEffectSub","description":" Sets the current render material to the given material or the rendertarget, applying a subtractive shader when drawn."},"readPixel":{"path":"libs_cl/render.lua#L2334","returns":[{"type":"Color","value":"Color Color object with ( r, g, b, a ) from the specified pixel.","description":"Color object with ( r, g, b, a ) from the specified pixel."}],"realm":"client","params":[{"type":"number","value":"number x Pixel x-coordinate.","name":"x","description":"Pixel x-coordinate."},{"type":"number","value":"number y Pixel y-coordinate.","name":"y","description":"Pixel y-coordinate."}],"class":"function","name":"readPixel","description":" Reads the color of the specified pixel."},"pushMatrix":{"path":"libs_cl/render.lua#L715","realm":"client","params":[{"type":"VMatrix","value":"VMatrix transform The matrix","name":"transform","description":"The matrix"},{"type":"boolean?","value":"boolean? absolute (default false) Should the transformation be absolute with respect to world or multipled with existing stack?","name":"absolute","description":"(default false) Should the transformation be absolute with respect to world or multipled with existing stack?"}],"class":"function","name":"pushMatrix","description":" Pushes a matrix onto the model matrix stack."},"depthRange":{"path":"libs_cl/render.lua#L2728","realm":"client","params":[{"type":"number","value":"number min The minimum depth of the upcoming render. 0.0 = render normally; 1.0 = render nothing.","name":"min","description":"The minimum depth of the upcoming render. 0.0 = render normally; 1.0 = render nothing."},{"type":"number","value":"number max The maximum depth of the upcoming render. 0.0 = render everything (through walls); 1.0 = render normally.","name":"max","description":"The maximum depth of the upcoming render. 0.0 = render everything (through walls); 1.0 = render normally."}],"class":"function","name":"depthRange","description":" Set's the depth range of the upcoming render."},"destroyRenderTarget":{"path":"libs_cl/render.lua#L1153","realm":"client","params":[{"type":"string","value":"string name Rendertarget name","name":"name","description":"Rendertarget name"}],"class":"function","name":"destroyRenderTarget","description":" Releases the rendertarget. Required if you reach the maximum rendertargets."},"pushViewMatrix":{"path":"libs_cl/render.lua#L771","realm":"client","params":[{"type":"table","value":"table tbl The view matrix data. See http://wiki.facepunch.com/gmod/Structures/RenderCamData","name":"tbl","description":"The view matrix data. See http://wiki.facepunch.com/gmod/Structures/RenderCamData"}],"class":"function","name":"pushViewMatrix","description":" Pushes a perspective matrix onto the view matrix stack."},"getTextSize":{"path":"libs_cl/render.lua#L1795","returns":[{"type":"number","value":"number width of the text","description":"width of the text"},{"type":"number","value":"number height of the text","description":"height of the text"}],"realm":"client","params":[{"type":"string","value":"string text Text to get the size of","name":"text","description":"Text to get the size of"}],"class":"function","name":"getTextSize","description":" Gets the size of the specified text. Don't forget to use setFont before calling this function"},"disableScissorRect":{"path":"libs_cl/render.lua#L742","realm":"client","class":"function","name":"disableScissorRect","description":" Disables a scissoring rect which limits the drawing area."},"setMaterialEffectAdd":{"path":"libs_cl/render.lua#L989","realm":"client","params":[{"type":"Material","value":"Material mat The material object to use the texture of, or the name of a rendertarget to use instead.","name":"mat","description":"The material object to use the texture of, or the name of a rendertarget to use instead."}],"class":"function","name":"setMaterialEffectAdd","description":" Sets the current render material to the given material or the rendertarget, applying an additive shader when drawn."},"draw3DSphere":{"path":"libs_cl/render.lua#L1990","realm":"client","params":[{"type":"Vector","value":"Vector pos Position of the sphere","name":"pos","description":"Position of the sphere"},{"type":"number","value":"number radius Radius of the sphere","name":"radius","description":"Radius of the sphere"},{"type":"number","value":"number longitudeSteps The amount of longitude steps. The larger this number is, the smoother the sphere is","name":"longitudeSteps","description":"The amount of longitude steps. The larger this number is, the smoother the sphere is"},{"type":"number","value":"number latitudeSteps The amount of latitude steps. The larger this number is, the smoother the sphere is","name":"latitudeSteps","description":"The amount of latitude steps. The larger this number is, the smoother the sphere is"}],"class":"function","name":"draw3DSphere","description":" Draws a sphere"},"setMaterialEffectBloom":{"path":"libs_cl/render.lua#L1017","realm":"client","params":[{"type":"Material","value":"Material mat The material object to use the texture of, or the name of a rendertarget to use instead.","name":"mat","description":"The material object to use the texture of, or the name of a rendertarget to use instead."},{"type":"number","value":"number levelr Multiplier for all red pixels. 1 = unchanged","name":"levelr","description":"Multiplier for all red pixels. 1 = unchanged"},{"type":"number","value":"number levelg Multiplier for all green pixels. 1 = unchanged","name":"levelg","description":"Multiplier for all green pixels. 1 = unchanged"},{"type":"number","value":"number levelb Multiplier for all blue pixels. 1 = unchanged","name":"levelb","description":"Multiplier for all blue pixels. 1 = unchanged"},{"type":"number","value":"number colormul Multiplier for all three colors. 1 = unchanged","name":"colormul","description":"Multiplier for all three colors. 1 = unchanged"}],"class":"function","name":"setMaterialEffectBloom","description":" Sets the current render material to the given material or the rendertarget, applying a bloom shader to the texture."},"setFogMode":{"path":"libs_cl/render.lua#L2616","realm":"client","params":[{"type":"number","value":"number mode Fog mode","name":"mode","description":"Fog mode"}],"class":"function","name":"setFogMode","description":" Sets the fog mode. See: https://wiki.facepunch.com/gmod/Enums/MATERIAL_FOG"},"clearStencil":{"path":"libs_cl/render.lua#L579","realm":"client","class":"function","name":"clearStencil","description":" Resets all values in the stencil buffer to zero."},"draw3DQuadUV":{"path":"libs_cl/render.lua#L2153","realm":"client","params":[{"type":"table","value":"table vert1 First vertex. {x, y, z, u, v}","name":"vert1","description":"First vertex. {x, y, z, u, v}"},{"type":"table","value":"table vert2 The second vertex.","name":"vert2","description":"The second vertex."},{"type":"table","value":"table vert3 The third vertex.","name":"vert3","description":"The third vertex."},{"type":"table","value":"table vert4 The fourth vertex.","name":"vert4","description":"The fourth vertex."}],"class":"function","name":"draw3DQuadUV","description":" Draws 2 connected triangles with custom UVs."},"drawLine":{"path":"libs_cl/render.lua#L1720","realm":"client","params":[{"type":"number","value":"number x1 X start float coordinate","name":"x1","description":"X start float coordinate"},{"type":"number","value":"number y1 Y start float coordinate","name":"y1","description":"Y start float coordinate"},{"type":"number","value":"number x2 X end float coordinate","name":"x2","description":"X end float coordinate"},{"type":"number","value":"number y2 Y end float coordinate","name":"y2","description":"Y end float coordinate"}],"class":"function","name":"drawLine","description":" Draws a line."},"setRenderTargetTexture":{"path":"libs_cl/render.lua#L1214","realm":"client","params":[{"type":"string?","value":"string? name Name of the render target to use","name":"name","description":"Name of the render target to use"}],"class":"function","name":"setRenderTargetTexture","description":" Sets the active texture to the render target with the specified name.\n Nil to reset."},"getScreenEntity":{"path":"libs_cl/render.lua#L2297","returns":[{"type":"Entity","value":"Entity Entity of the screen or hud being rendered","description":"Entity of the screen or hud being rendered"}],"realm":"client","class":"function","name":"getScreenEntity","description":" Returns the entity currently being rendered to"},"setStencilCompareFunction":{"path":"libs_cl/render.lua#L643","realm":"client","params":[{"type":"number","value":"number compareFunction","name":"compareFunction","description":""}],"class":"function","name":"setStencilCompareFunction","description":" Sets the compare function of the stencil. More: https://wiki.facepunch.com/gmod/render.SetStencilCompareFunction"},"enableScissorRect":{"path":"libs_cl/render.lua#L732","realm":"client","params":[{"type":"number","value":"number startX X start coordinate of the scissor rect.","name":"startX","description":"X start coordinate of the scissor rect."},{"type":"number","value":"number startY Y start coordinate of the scissor rect.","name":"startY","description":"Y start coordinate of the scissor rect."},{"type":"number","value":"number endX X end coordinate of the scissor rect.","name":"endX","description":"X end coordinate of the scissor rect."},{"type":"number","value":"number endY Y end coordinate of the scissor rect.","name":"endY","description":"Y end coordinate of the scissor rect."}],"class":"function","name":"enableScissorRect","description":" Enables a scissoring rect which limits the drawing area. Only works 2D contexts such as HUD or render targets."},"getAngles":{"path":"libs_cl/render.lua#L557","returns":[{"type":"Angle","value":"Angle The angles of the current render context as calculated by calcview.","description":"The angles of the current render context as calculated by calcview."}],"realm":"client","class":"function","name":"getAngles","description":" Call EyeAngles()"},"setFont":{"path":"libs_cl/render.lua#L1804","realm":"client","params":[{"type":"string","value":"string font The font to use","name":"font","description":"The font to use"}],"class":"function","name":"setFont","description":" Sets the font\n Use a font created by render.createFont or use one of these already defined fonts:\n \\- DebugFixed\n \\- DebugFixedSmall\n \\- Default\n \\- Marlett\n \\- Trebuchet18\n \\- Trebuchet24\n \\- HudHintTextLarge\n \\- HudHintTextSmall\n \\- CenterPrintText\n \\- HudSelectionText\n \\- CloseCaption_Normal\n \\- CloseCaption_Bold\n \\- CloseCaption_BoldItalic\n \\- ChatFont\n \\- TargetID\n \\- TargetIDSmall\n \\- HL2MPTypeDeath\n \\- BudgetLabel\n \\- HudNumbers\n \\- DermaDefault\n \\- DermaDefaultBold\n \\- DermaLarge"},"drawRectRotatedFast":{"path":"libs_cl/render.lua#L1375","realm":"client","params":[{"type":"number","value":"number x X coordinate of center of rect","name":"x","description":"X coordinate of center of rect"},{"type":"number","value":"number y Y coordinate of center of rect","name":"y","description":"Y coordinate of center of rect"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"},{"type":"number","value":"number rot Rotation in degrees","name":"rot","description":"Rotation in degrees"}],"class":"function","name":"drawRectRotatedFast","description":" Draws a rotated, rectangle using the current color\n Faster, but uses integer coordinates and will get clipped by user's screen resolution"},"getEyePos":{"path":"libs_cl/render.lua#L549","returns":[{"type":"Vector","value":"Vector The origin of the current render context as calculated by calcview.","description":"The origin of the current render context as calculated by calcview."}],"realm":"client","class":"function","name":"getEyePos","description":" Call EyePos()"},"renderViewsLeft":{"path":"libs_cl/render.lua#L2535","returns":[{"type":"number","value":"number How many render.renderView calls are left","description":"How many render.renderView calls are left"}],"realm":"client","class":"function","name":"renderViewsLeft","description":" Returns how many render.renderView calls can be done in the current frame."},"getEyeVector":{"path":"libs_cl/render.lua#L563","returns":[{"type":"Vector","value":"Vector The normal vector of the current render context as calculated by calcview, similar to render.getAngles.","description":"The normal vector of the current render context as calculated by calcview, similar to render.getAngles."}],"realm":"client","class":"function","name":"getEyeVector","description":" Call EyeVector()"},"setLightingMode":{"path":"libs_cl/render.lua#L854","realm":"client","params":[{"type":"number","value":"number mode The lighting mode. 0 - Default, 1 - Fullbright, 2 - Increased Fullbright","name":"mode","description":"The lighting mode. 0 - Default, 1 - Fullbright, 2 - Increased Fullbright"}],"class":"function","name":"setLightingMode","description":" Sets the lighting mode"},"setTint":{"path":"libs_cl/render.lua#L925","realm":"client","params":[{"type":"Color","value":"Color c A color","name":"c","description":"A color"}],"class":"function","name":"setTint","description":" Sets the drawing tint. Internally, calls render.setColorModulation and render.setBlend with the color parameters divided by 255."},"drawCircle":{"path":"libs_cl/render.lua#L1413","realm":"client","params":[{"type":"number","value":"number x Center x coordinate","name":"x","description":"Center x coordinate"},{"type":"number","value":"number y Center y coordinate","name":"y","description":"Center y coordinate"},{"type":"number","value":"number radius Radius","name":"radius","description":"Radius"}],"class":"function","name":"drawCircle","description":" Draws a circle outline"},"getBlend":{"path":"libs_cl/render.lua#L1958","returns":[{"type":"number","value":"number Blending in the range 0 to 1","description":"Blending in the range 0 to 1"}],"realm":"client","class":"function","name":"getBlend","description":" Returns the current alpha blending"},"getDefaultFont":{"path":"libs_cl/render.lua#L1835","returns":[{"type":"string","value":"string Default font","description":"Default font"}],"realm":"client","class":"function","name":"getDefaultFont","description":" Gets the default font"},"setFilterMin":{"path":"libs_cl/render.lua#L1265","realm":"client","params":[{"type":"number","value":"number val The filter function to use http://wiki.facepunch.com/gmod/Enums/TEXFILTER","name":"val","description":"The filter function to use http://wiki.facepunch.com/gmod/Enums/TEXFILTER"}],"class":"function","name":"setFilterMin","description":" Sets the texture filtering function when viewing a far texture"},"setBlend":{"path":"libs_cl/render.lua#L1965","realm":"client","params":[{"type":"number","value":"number alpha Blending in the range 0 to 1","name":"alpha","description":"Blending in the range 0 to 1"}],"class":"function","name":"setBlend","description":" Changes alpha blending for the upcoming model drawing operations"},"renderView":{"path":"libs_cl/render.lua#L2393","realm":"client","params":[{"type":"table","value":"table tbl view The view data to be used in the rendering. See http://wiki.facepunch.com/gmod/Structures/ViewData. There's an additional key drawviewer used to tell the engine whether the local player model should be rendered.","name":"tbl","description":"view The view data to be used in the rendering. See http://wiki.facepunch.com/gmod/Structures/ViewData. There's an additional key drawviewer used to tell the engine whether the local player model should be rendered."}],"class":"function","name":"renderView","description":" Renders the scene with the specified viewData to the current active render target."},"setFogColor":{"path":"libs_cl/render.lua#L2625","realm":"client","params":[{"type":"Color","value":"Color col Color (alpha won't have any effect)","name":"col","description":"Color (alpha won't have any effect)"}],"class":"function","name":"setFogColor","description":" Changes color of the fog"},"drawSimpleText":{"path":"libs_cl/render.lua#L1854","returns":[{"type":"number","value":"number Width of the drawn text. Same as calling render.getTextSize","description":"Width of the drawn text. Same as calling render.getTextSize"},{"type":"number","value":"number Height of the drawn text. Same as calling render.getTextSize","description":"Height of the drawn text. Same as calling render.getTextSize"}],"realm":"client","params":[{"type":"number","value":"number x X coordinate","name":"x","description":"X coordinate"},{"type":"number","value":"number y Y coordinate","name":"y","description":"Y coordinate"},{"type":"string","value":"string text Text to draw","name":"text","description":"Text to draw"},{"type":"number?","value":"number? xalign Horizontal text alignment. Default TEXT_ALIGN.LEFT","name":"xalign","description":"Horizontal text alignment. Default TEXT_ALIGN.LEFT"},{"type":"number?","value":"number? yalign Vertical text alignment. Default TEXT_ALIGN.TOP","name":"yalign","description":"Vertical text alignment. Default TEXT_ALIGN.TOP"}],"class":"function","name":"drawSimpleText","description":" Draws text more easily and quickly but no new lines or tabs."},"draw3DTriangleUV":{"path":"libs_cl/render.lua#L2217","realm":"client","params":[{"type":"table","value":"table vert1 First vertex. {x = x1, y = y1, z = z1, u = u1, v = v1}","name":"vert1","description":"First vertex. {x = x1, y = y1, z = z1, u = u1, v = v1}"},{"type":"table","value":"table vert2 The second vertex.","name":"vert2","description":"The second vertex."},{"type":"table","value":"table vert3 The third vertex.","name":"vert3","description":"The third vertex."}],"class":"function","name":"draw3DTriangleUV","description":" Draws a triangle with UV coordinates in 3D space"},"drawRoundedBoxEx":{"path":"libs_cl/render.lua#L1323","realm":"client","params":[{"type":"number","value":"number r The corner radius","name":"r","description":"The corner radius"},{"type":"number","value":"number x Top left corner x coordinate","name":"x","description":"Top left corner x coordinate"},{"type":"number","value":"number y Top left corner y coordinate","name":"y","description":"Top left corner y coordinate"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"},{"type":"boolean?","value":"boolean? tl Top left corner. Default false","name":"tl","description":"Top left corner. Default false"},{"type":"boolean?","value":"boolean? tr Top right corner. Default false","name":"tr","description":"Top right corner. Default false"},{"type":"boolean?","value":"boolean? bl Bottom left corner. Default false","name":"bl","description":"Bottom left corner. Default false"},{"type":"boolean?","value":"boolean? br Bottom right corner. Default false","name":"br","description":"Bottom right corner. Default false"}],"class":"function","name":"drawRoundedBoxEx","description":" Draws a rounded rectangle using the current color"},"drawTriangle":{"path":"libs_cl/render.lua#L1476","realm":"client","params":[{"type":"number","value":"number x1 X of the first vertex","name":"x1","description":"X of the first vertex"},{"type":"number","value":"number y1 Y of the first vertex","name":"y1","description":"Y of the first vertex"},{"type":"number","value":"number x2 X of the second vertex","name":"x2","description":"X of the second vertex"},{"type":"number","value":"number y2 Y of the second vertex","name":"y2","description":"Y of the second vertex"},{"type":"number","value":"number x3 X of the third vertex","name":"x3","description":"X of the third vertex"},{"type":"number","value":"number y3 Y of the third vertex","name":"y3","description":"Y of the third vertex"}],"class":"function","name":"drawTriangle","description":" Draws a triangle using the current color"},"parseMarkup":{"path":"libs_cl/render.lua#L1888","returns":[{"type":"Markup","value":"Markup The markup object. See https://wiki.facepunch.com/gmod/markup.Parse","description":"The markup object. See https://wiki.facepunch.com/gmod/markup.Parse"}],"realm":"client","params":[{"type":"string","value":"string str The markup string to parse","name":"str","description":"The markup string to parse"},{"type":"number?","value":"number? maxsize The max width of the markup. Default nil","name":"maxsize","description":"The max width of the markup. Default nil"}],"class":"function","name":"parseMarkup","description":" Constructs a markup object for quick styled text drawing."},"computeLighting":{"path":"libs_cl/render.lua#L2582","returns":[{"type":"Vector","value":"Vector Vector representing color of the light","description":"Vector representing color of the light"}],"realm":"client","params":[{"type":"Vector","value":"Vector pos Vector position to sample from","name":"pos","description":"Vector position to sample from"},{"type":"Vector","value":"Vector normal Normal vector of the surface","name":"normal","description":"Normal vector of the surface"}],"class":"function","name":"computeLighting","description":" Calculates the light color of a certain surface"},"setWriteDepthToDestAlpha":{"path":"libs_cl/render.lua#L592","realm":"client","params":[{"type":"boolean","value":"boolean enable True to write depth to destination alpha.","name":"enable","description":"True to write depth to destination alpha."}],"class":"function","name":"setWriteDepthToDestAlpha","description":" Sets the internal parameter INT_RENDERPARM_WRITE_DEPTH_TO_DESTALPHA. Allows creation of RTs with alpha masks.\n Check https://wiki.facepunch.com/gmod/render.SetWriteDepthToDestAlpha for example."},"drawPixelsSubrectRGB":{"path":"libs_cl/render.lua#L1672","realm":"client","params":[{"type":"number","value":"number dstX Destination x coordinate","name":"dstX","description":"Destination x coordinate"},{"type":"number","value":"number dstY Destination y coordinate","name":"dstY","description":"Destination y coordinate"},{"type":"number","value":"number srcX Source x coordinate","name":"srcX","description":"Source x coordinate"},{"type":"number","value":"number srcY Source y coordinate","name":"srcY","description":"Source y coordinate"},{"type":"number","value":"number srcW Source original width","name":"srcW","description":"Source original width"},{"type":"number","value":"number srcH Source original height","name":"srcH","description":"Source original height"},{"type":"number","value":"number subrectW Width of subrect","name":"subrectW","description":"Width of subrect"},{"type":"number","value":"number subrectH Height of subrect","name":"subrectH","description":"Height of subrect"},{"type":"table","value":"table dataR Red channel data.","name":"dataR","description":"Red channel data."},{"type":"table","value":"table dataG Green channel data.","name":"dataG","description":"Green channel data."},{"type":"table","value":"table dataB Blue channel data.","name":"dataB","description":"Blue channel data."}],"class":"function","name":"drawPixelsSubrectRGB","description":" Draws region of RGB color channel tables to current render target."},"drawRect":{"path":"libs_cl/render.lua#L1363","realm":"client","params":[{"type":"number","value":"number x Top left corner x","name":"x","description":"Top left corner x"},{"type":"number","value":"number y Top left corner y","name":"y","description":"Top left corner y"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"}],"class":"function","name":"drawRect","description":" Draws a rectangle using the current color"},"resetModelLighting":{"path":"libs_cl/render.lua#L610","realm":"client","params":[{"type":"number","value":"number r The red part of the color, 0-1","name":"r","description":"The red part of the color, 0-1"},{"type":"number","value":"number g The green part of the color, 0-1","name":"g","description":"The green part of the color, 0-1"},{"type":"number","value":"number b The blue part of the color, 0-1","name":"b","description":"The blue part of the color, 0-1"}],"class":"function","name":"resetModelLighting","description":" Resets the model lighting to the specified color."},"clear":{"path":"libs_cl/render.lua#L1284","realm":"client","params":[{"type":"Color?","value":"Color? clr Color type to clear with","name":"clr","description":"Color type to clear with"},{"type":"boolean?","value":"boolean? depth Boolean if should clear depth. Default false","name":"depth","description":"Boolean if should clear depth. Default false"}],"class":"function","name":"clear","description":" Clears the active render target"},"getLightColor":{"path":"libs_cl/render.lua#L2602","returns":[{"type":"Vector","value":"Vector Vector representing color of the light","description":"Vector representing color of the light"}],"realm":"client","params":[{"type":"Vector","value":"Vector pos Vector position to sample from","name":"pos","description":"Vector position to sample from"}],"class":"function","name":"getLightColor","description":" Gets the light exposure on the specified position"},"pixelVisible":{"path":"libs_cl/render.lua#L2736","returns":[{"type":"number","value":"number Percentage visible, from 0-1","description":"Percentage visible, from 0-1"}],"realm":"client","params":[{"type":"Vector","value":"Vector position","name":"position","description":""},{"type":"number","value":"number radius","name":"radius","description":""}],"class":"function","name":"pixelVisible","description":" Returns the visibility of a sphere in the world."},"screenShake":{"path":"libs_cl/render.lua#L2719","realm":"client","params":[{"type":"number","value":"number amplitude The strength of the effect","name":"amplitude","description":"The strength of the effect"},{"type":"number","value":"number frequency The frequency of the effect in hertz","name":"frequency","description":"The frequency of the effect in hertz"},{"type":"number","value":"number duration The duration of the effect in seconds, max 10.","name":"duration","description":"The duration of the effect in seconds, max 10."}],"class":"function","name":"screenShake","description":" Makes the screen shake, client must be connected to a HUD."},"setFogStart":{"path":"libs_cl/render.lua#L2643","realm":"client","params":[{"type":"number","value":"number distance Start distance","name":"distance","description":"Start distance"}],"class":"function","name":"setFogStart","description":" Sets distance at which the fog will start appearing"},"resetStencil":{"path":"libs_cl/render.lua#L699","realm":"client","class":"function","name":"resetStencil","description":" Resets stencil operations to their default behavior"},"drawTexturedRect":{"path":"libs_cl/render.lua#L1505","realm":"client","params":[{"type":"number","value":"number x Top left corner x","name":"x","description":"Top left corner x"},{"type":"number","value":"number y Top left corner y","name":"y","description":"Top left corner y"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"}],"class":"function","name":"drawTexturedRect","description":" Draws a textured rectangle"},"setFogDensity":{"path":"libs_cl/render.lua#L2634","realm":"client","params":[{"type":"number","value":"number density Density between 0 and 1","name":"density","description":"Density between 0 and 1"}],"class":"function","name":"setFogDensity","description":" Changes density of the fog"},"getGameResolution":{"path":"libs_cl/render.lua#L2366","returns":[{"type":"number","value":"number the X size of the game window","description":"the X size of the game window"},{"type":"number","value":"number the Y size of the game window","description":"the Y size of the game window"}],"realm":"client","class":"function","name":"getGameResolution","description":" Returns width and height of the game window"},"getAmbientLightColor":{"path":"libs_cl/render.lua#L2610","returns":[{"type":"Vector","value":"Vector Vector representing color of the light","description":"Vector representing color of the light"}],"realm":"client","class":"function","name":"getAmbientLightColor","description":" Returns the ambient color of the map"},"isInRenderView":{"path":"libs_cl/render.lua#L2529","returns":[{"type":"boolean","value":"boolean Whether render.renderView is being executed","description":"Whether render.renderView is being executed"}],"realm":"client","class":"function","name":"isInRenderView","description":" Returns whether render.renderView is being executed."},"renderTargetExists":{"path":"libs_cl/render.lua#L1131","realm":"client","params":[{"type":"string","value":"string name The name of the render target","name":"name","description":"The name of the render target"}],"class":"function","name":"renderTargetExists","description":" Check if the specified render target exists."},"drawText":{"path":"libs_cl/render.lua#L1841","realm":"client","params":[{"type":"number","value":"number x X coordinate","name":"x","description":"X coordinate"},{"type":"number","value":"number y Y coordinate","name":"y","description":"Y coordinate"},{"type":"string","value":"string text Text to draw","name":"text","description":"Text to draw"},{"type":"number","value":"number alignment Horizontal text alignment. Default TEXT_ALIGN.LEFT","name":"alignment","description":"Horizontal text alignment. Default TEXT_ALIGN.LEFT"}],"class":"function","name":"drawText","description":" Draws text with newlines and tabs"},"setTextureFromScreen":{"path":"libs_cl/render.lua#L1237","realm":"client","params":[{"type":"Entity","value":"Entity ent Screen entity","name":"ent","description":"Screen entity"}],"class":"function","name":"setTextureFromScreen","description":" Sets the texture of a screen entity"},"getScreenInfo":{"path":"libs_cl/render.lua#L2280","returns":[{"type":"table","value":"table A table describing the screen.","description":"A table describing the screen."}],"realm":"client","params":[{"type":"Entity","value":"Entity e The screen to get info from.","name":"e","description":"The screen to get info from."}],"class":"function","name":"getScreenInfo","description":" Returns information about the screen, such as world offsets, dimensions, and rotation.\n Note: this does a table copy so move it out of your draw hook"},"setMaterialEffectColorModify":{"path":"libs_cl/render.lua#L1076","realm":"client","params":[{"type":"Material","value":"Material mat The material object to use the texture of, or the name of a rendertarget to use instead.","name":"mat","description":"The material object to use the texture of, or the name of a rendertarget to use instead."},{"type":"table","value":"table cmStructure A table where each key must be of \"addr\", \"addg\", \"addb\", \"brightness\", \"color\" or \"colour\", \"contrast\", \"mulr\", \"mulg\", and \"mulb\". All keys are optional.","name":"cmStructure","description":"A table where each key must be of \"addr\", \"addg\", \"addb\", \"brightness\", \"color\" or \"colour\", \"contrast\", \"mulr\", \"mulg\", and \"mulb\". All keys are optional."}],"class":"function","name":"setMaterialEffectColorModify","description":" Sets the current render material to the given material or the rendertarget, applying a color modification shader to the texture. Alias: render.setMaterialEffectColourModify"},"setStencilZFailOperation":{"path":"libs_cl/render.lua#L667","realm":"client","params":[{"type":"number","value":"number operation","name":"operation","description":""}],"class":"function","name":"setStencilZFailOperation","description":" Sets the operation to be performed on the stencil buffer values if the stencil test is passed but the depth buffer test fails. More: http://wiki.facepunch.com/gmod/render.SetStencilZFailOperation"},"capturePixels":{"path":"libs_cl/render.lua#L2303","realm":"client","class":"function","name":"capturePixels","description":" Dumps the current render target and allows the pixels to be accessed by render.readPixel."},"drawTexturedRectFast":{"path":"libs_cl/render.lua#L1494","realm":"client","params":[{"type":"number","value":"number x Top left corner x","name":"x","description":"Top left corner x"},{"type":"number","value":"number y Top left corner y","name":"y","description":"Top left corner y"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"}],"class":"function","name":"drawTexturedRectFast","description":" Draws a textured rectangle\n Faster, but uses integer coordinates and will get clipped by user's screen resolution"},"drawBlurEffect":{"path":"libs_cl/render.lua#L1109","realm":"client","params":[{"type":"number","value":"number blurx The amount of horizontal blur to apply.","name":"blurx","description":"The amount of horizontal blur to apply."},{"type":"number","value":"number blury The amount of vertical blur to apply.","name":"blury","description":"The amount of vertical blur to apply."},{"type":"number","value":"number passes The number of times the blur effect is applied.","name":"passes","description":"The number of times the blur effect is applied."}],"class":"function","name":"drawBlurEffect","description":" Applies a blur effect to the active rendertarget. This must be used with a rendertarget created beforehand."},"draw3DBeam":{"path":"libs_cl/render.lua#L2063","realm":"client","params":[{"type":"Vector","value":"Vector startPos Beam start position.","name":"startPos","description":"Beam start position."},{"type":"Vector","value":"Vector endPos Beam end position.","name":"endPos","description":"Beam end position."},{"type":"number","value":"number width The width of the beam.","name":"width","description":"The width of the beam."},{"type":"number","value":"number textureStart The start coordinate of the texture used.","name":"textureStart","description":"The start coordinate of the texture used."},{"type":"number","value":"number textureEnd The end coordinate of the texture used.","name":"textureEnd","description":"The end coordinate of the texture used."}],"class":"function","name":"draw3DBeam","description":" Draws textured beam."},"setStencilEnable":{"path":"libs_cl/render.lua#L571","realm":"client","params":[{"type":"boolean","value":"boolean enable True to enable, false to disable","name":"enable","description":"True to enable, false to disable"}],"class":"function","name":"setStencilEnable","description":" Sets whether stencil tests are carried out for each rendered pixel. Only pixels passing the stencil test are written to the render target."},"destroyTexture":{"path":"libs_cl/render.lua#L953","realm":"client","params":[{"type":"Material","value":"Material mat The material object","name":"mat","description":"The material object"}],"class":"function","name":"destroyTexture","description":" Releases the texture. Required if you reach the maximum url textures."},"createRenderTarget":{"path":"libs_cl/render.lua#L1138","realm":"client","params":[{"type":"string","value":"string name The name of the render target","name":"name","description":"The name of the render target"}],"class":"function","name":"createRenderTarget","description":" Creates a new render target to draw onto.\n The dimensions will always be 1024x1024"},"drawPoly":{"path":"libs_cl/render.lua#L1927","realm":"client","params":[{"type":"table","value":"table poly Table of polygon vertices. Texture coordinates are optional. {{x=x1, y=y1, u=u1, v=v1}, ... }","name":"poly","description":"Table of polygon vertices. Texture coordinates are optional. {{x=x1, y=y1, u=u1, v=v1}, ... }"}],"class":"function","name":"drawPoly","description":" Draws a polygon."},"captureImage":{"path":"libs_cl/render.lua#L2310","returns":[{"type":"string","value":"string Image binary data","description":"Image binary data"}],"realm":"client","params":[{"type":"table","value":"table captureData Parameters of the capture. See https://wiki.facepunch.com/gmod/Structures/RenderCaptureData","name":"captureData","description":"Parameters of the capture. See https://wiki.facepunch.com/gmod/Structures/RenderCaptureData"}],"class":"function","name":"captureImage","description":" Captures a part of the current render target and returns the data as a binary string in the given format."},"cursorPos":{"path":"libs_cl/render.lua#L2232","returns":[{"type":"number","value":"number X position","description":"X position"},{"type":"number","value":"number Y position","description":"Y position"}],"realm":"client","params":[{"type":"Player?","value":"Player? ply player to get cursor position from. Default player()","name":"ply","description":"player to get cursor position from. Default player()"},{"type":"Entity?","value":"Entity? screen An explicit screen to get the cursor pos of (default: The current rendering screen using 'render' hook)","name":"screen","description":"An explicit screen to get the cursor pos of (default: The current rendering screen using 'render' hook)"}],"class":"function","name":"cursorPos","description":" Gets a 2D cursor position where ply is aiming at the current rendered screen or nil if they aren't aiming at it."},"getTint":{"path":"libs_cl/render.lua#L904","returns":[{"type":"Color","value":"Color The current color & blend modulation as a color","description":"The current color & blend modulation as a color"}],"realm":"client","class":"function","name":"getTint","description":" Gets the drawing tint. Internally, calls render.getColorModulation and render.getBlend, multiplies the values by 255, then returns a color object."},"setStencilFailOperation":{"path":"libs_cl/render.lua#L651","realm":"client","params":[{"type":"number","value":"number operation","name":"operation","description":""}],"class":"function","name":"setStencilFailOperation","description":" Sets the operation to be performed on the stencil buffer values if the compare function was not successful. More: http://wiki.facepunch.com/gmod/render.SetStencilFailOperation"},"suppressEngineLighting":{"path":"libs_cl/render.lua#L585","realm":"client","params":[{"type":"boolean","value":"boolean suppress True to suppress false to enable.","name":"suppress","description":"True to suppress false to enable."}],"class":"function","name":"suppressEngineLighting","description":" Suppresses or enables any engine lighting for any upcoming render operation."},"end3DBeam":{"path":"libs_cl/render.lua#L2097","realm":"client","class":"function","name":"end3DBeam","description":" Ends the beam mesh of a beam started with render.start3DBeam."},"setStencilTestMask":{"path":"libs_cl/render.lua#L683","realm":"client","params":[{"type":"number","value":"number mask The mask bitflag.","name":"mask","description":"The mask bitflag."}],"class":"function","name":"setStencilTestMask","description":" Sets the unsigned 8-bit test bitflag mask to be used for any stencil testing."},"clearStencilBufferRectangle":{"path":"libs_cl/render.lua#L631","realm":"client","params":[{"type":"number","value":"number originX X origin of the rectangle.","name":"originX","description":"X origin of the rectangle."},{"type":"number","value":"number originY Y origin of the rectangle.","name":"originY","description":"Y origin of the rectangle."},{"type":"number","value":"number endX The end X coordinate of the rectangle.","name":"endX","description":"The end X coordinate of the rectangle."},{"type":"number","value":"number endY The end Y coordinate of the rectangle.","name":"endY","description":"The end Y coordinate of the rectangle."},{"type":"number","value":"number stencilValue Value to set cleared stencil buffer to.","name":"stencilValue","description":"Value to set cleared stencil buffer to."}],"class":"function","name":"clearStencilBufferRectangle","description":" Sets the stencil value in a specified rect."},"drawSimpleTextOutlined":{"path":"libs_cl/render.lua#L1870","returns":[{"type":"number","value":"number Width of the drawn text. Same as calling render.getTextSize","description":"Width of the drawn text. Same as calling render.getTextSize"},{"type":"number","value":"number Height of the drawn text. Same as calling render.getTextSize","description":"Height of the drawn text. Same as calling render.getTextSize"}],"realm":"client","params":[{"type":"number","value":"number x X coordinate","name":"x","description":"X coordinate"},{"type":"number","value":"number y Y coordinate","name":"y","description":"Y coordinate"},{"type":"string","value":"string text Text to draw","name":"text","description":"Text to draw"},{"type":"number","value":"number outlinewidth Width of the outline.","name":"outlinewidth","description":"Width of the outline."},{"type":"Color","value":"Color outlinecolor The color of the text.","name":"outlinecolor","description":"The color of the text."},{"type":"number?","value":"number? xalign Horizontal text alignment. Default TEXT_ALIGN.LEFT","name":"xalign","description":"Horizontal text alignment. Default TEXT_ALIGN.LEFT"},{"type":"number?","value":"number? yalign Vertical text alignment. Default TEXT_ALIGN.TOP","name":"yalign","description":"Vertical text alignment. Default TEXT_ALIGN.TOP"}],"class":"function","name":"drawSimpleTextOutlined","description":" Draws outlined text more easily but no new lines or tabs."},"setFilterMag":{"path":"libs_cl/render.lua#L1254","realm":"client","params":[{"type":"number","value":"number val The filter function to use http://wiki.facepunch.com/gmod/Enums/TEXFILTER","name":"val","description":"The filter function to use http://wiki.facepunch.com/gmod/Enums/TEXFILTER"}],"class":"function","name":"setFilterMag","description":" Sets the texture filtering function when viewing a close texture"},"selectRenderTarget":{"path":"libs_cl/render.lua#L1166","realm":"client","params":[{"type":"string?","value":"string? name Name of the render target to use","name":"name","description":"Name of the render target to use"}],"class":"function","name":"selectRenderTarget","description":" Selects the render target to draw on.\n Nil for the visible RT."},"drawTexturedRectUV":{"path":"libs_cl/render.lua#L1554","realm":"client","params":[{"type":"number","value":"number x Top left corner x","name":"x","description":"Top left corner x"},{"type":"number","value":"number y Top left corner y","name":"y","description":"Top left corner y"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"},{"type":"number","value":"number startU Texture mapping at rectangle origin","name":"startU","description":"Texture mapping at rectangle origin"},{"type":"number","value":"number startV Texture mapping at rectangle origin","name":"startV","description":"Texture mapping at rectangle origin"},{"type":"number","value":"number endU Texture mapping at rectangle end","name":"endU","description":"Texture mapping at rectangle end"},{"type":"number","value":"number endV Texture mapping at rectangle end","name":"endV","description":"Texture mapping at rectangle end"}],"class":"function","name":"drawTexturedRectUV","description":" Draws a textured rectangle with UV coordinates"},"setMaterialEffectDownsample":{"path":"libs_cl/render.lua#L1043","realm":"client","params":[{"type":"Material","value":"Material mat The material object to use the texture of, or the name of a rendertarget to use instead.","name":"mat","description":"The material object to use the texture of, or the name of a rendertarget to use instead."},{"type":"number","value":"number darken The amount to darken the texture by. -1 to 1 inclusive.","name":"darken","description":"The amount to darken the texture by. -1 to 1 inclusive."},{"type":"number","value":"number multiply The amount to multiply the pixel colors by. (0-1024)","name":"multiply","description":"The amount to multiply the pixel colors by. (0-1024)"}],"class":"function","name":"setMaterialEffectDownsample","description":" Sets the current render material to the given material or the rendertarget, darkening the texture, and scaling up color values."},"drawFilledCircle":{"path":"libs_cl/render.lua#L1423","realm":"client","params":[{"type":"number","value":"number x Center x coordinate","name":"x","description":"Center x coordinate"},{"type":"number","value":"number y Center y coordinate","name":"y","description":"Center y coordinate"},{"type":"number","value":"number radius Radius","name":"radius","description":"Radius"}],"class":"function","name":"drawFilledCircle","description":" Draws a filled circle"},"drawPixelsSubrectRGBA":{"path":"libs_cl/render.lua#L1695","realm":"client","params":[{"type":"number","value":"number dstX Destination x coordinate","name":"dstX","description":"Destination x coordinate"},{"type":"number","value":"number dstY Destination y coordinate","name":"dstY","description":"Destination y coordinate"},{"type":"number","value":"number srcX Source x coordinate","name":"srcX","description":"Source x coordinate"},{"type":"number","value":"number srcY Source y coordinate","name":"srcY","description":"Source y coordinate"},{"type":"number","value":"number srcW Source original width","name":"srcW","description":"Source original width"},{"type":"number","value":"number srcH Source original height","name":"srcH","description":"Source original height"},{"type":"number","value":"number subrectW Width of subrect","name":"subrectW","description":"Width of subrect"},{"type":"number","value":"number subrectH Height of subrect","name":"subrectH","description":"Height of subrect"},{"type":"table","value":"table dataR Red channel data.","name":"dataR","description":"Red channel data."},{"type":"table","value":"table dataG Green channel data.","name":"dataG","description":"Green channel data."},{"type":"table","value":"table dataB Blue channel data.","name":"dataB","description":"Blue channel data."},{"type":"table","value":"table dataA Alpha channel data.","name":"dataA","description":"Alpha channel data."}],"class":"function","name":"drawPixelsSubrectRGBA","description":" Draws region of RGBA color channel tables to current render target."},"setCullMode":{"path":"libs_cl/render.lua#L1276","realm":"client","params":[{"type":"number","value":"number mode Cull mode. 0 for counter clock wise, 1 for clock wise","name":"mode","description":"Cull mode. 0 for counter clock wise, 1 for clock wise"}],"class":"function","name":"setCullMode","description":" Changes the cull mode"},"createFont":{"path":"libs_cl/render.lua#L1730","returns":[{"type":"string","value":"string The font name that can be used with the rest of the font functions.","description":"The font name that can be used with the rest of the font functions."}],"realm":"client","params":[{"type":"string","value":"string font Base font to use","name":"font","description":"Base font to use"},{"type":"number?","value":"number? size Font size. Default 16","name":"size","description":"Font size. Default 16"},{"type":"number?","value":"number? weight Font weight. Default 400","name":"weight","description":"Font weight. Default 400"},{"type":"boolean?","value":"boolean? antialias Antialias font? Default false","name":"antialias","description":"Antialias font? Default false"},{"type":"boolean?","value":"boolean? additive If true, adds brightness to pixels behind it rather than drawing over them. Default false","name":"additive","description":"If true, adds brightness to pixels behind it rather than drawing over them. Default false"},{"type":"boolean?","value":"boolean? shadow Enable drop shadow? Default false","name":"shadow","description":"Enable drop shadow? Default false"},{"type":"boolean?","value":"boolean? outline Enable outline? Default false","name":"outline","description":"Enable outline? Default false"},{"type":"boolean?","value":"boolean? blursize The size of the blur Default 0","name":"blursize","description":"The size of the blur Default 0"},{"type":"boolean?","value":"boolean? extended Allows the font to display glyphs outside of Latin-1 range. Unicode code points above 0xFFFF are not supported. Required to use FontAwesome","name":"extended","description":"Allows the font to display glyphs outside of Latin-1 range. Unicode code points above 0xFFFF are not supported. Required to use FontAwesome"},{"type":"number?","value":"number? scanlines Scanline interval. Must be greater than 1 to work. Shares uniqueness with blursize so you cannot create more than one scanline type of font with the same blursize. Default 0","name":"scanlines","description":"Scanline interval. Must be greater than 1 to work. Shares uniqueness with blursize so you cannot create more than one scanline type of font with the same blursize. Default 0"}],"class":"function","name":"createFont","description":" Creates a font. Does not require rendering hook\n Base font can be one of (keep in mind that these may not exist on all clients if they are not shipped with starfall):\n \\- Akbar\n \\- Coolvetica\n \\- Roboto\n \\- Roboto Mono\n \\- FontAwesome\n \\- Courier New\n \\- Verdana\n \\- Arial\n \\- HalfLife2\n \\- hl2mp\n \\- csd\n \\- Tahoma\n \\- Trebuchet\n \\- Trebuchet MS\n \\- DejaVu Sans Mono\n \\- Lucida Console\n \\- Times New Roman"},"drawRectRotated":{"path":"libs_cl/render.lua#L1388","realm":"client","params":[{"type":"number","value":"number x X coordinate of center of rect","name":"x","description":"X coordinate of center of rect"},{"type":"number","value":"number y Y coordinate of center of rect","name":"y","description":"Y coordinate of center of rect"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"},{"type":"number","value":"number rot Rotation in degrees","name":"rot","description":"Rotation in degrees"}],"class":"function","name":"drawRectRotated","description":" Draws a rotated, rectangle using the current color"},"clearDepth":{"path":"libs_cl/render.lua#L1972","realm":"client","class":"function","name":"clearDepth","description":" Resets the depth buffer"},"setColorModulation":{"path":"libs_cl/render.lua#L877","realm":"client","params":[{"type":"number","value":"number r Red channel","name":"r","description":"Red channel"},{"type":"number","value":"number g Green channel","name":"g","description":"Green channel"},{"type":"number","value":"number b Blue channel","name":"b","description":"Blue channel"}],"class":"function","name":"setColorModulation","description":" Sets the draw color modulation."},"popMatrix":{"path":"libs_cl/render.lua#L748","realm":"client","class":"function","name":"popMatrix","description":" Pops a matrix from the model matrix stack."},"computeDynamicLighting":{"path":"libs_cl/render.lua#L2592","returns":[{"type":"Vector","value":"Vector Vector representing color of the light","description":"Vector representing color of the light"}],"realm":"client","params":[{"type":"Vector","value":"Vector pos Vector position to sample from","name":"pos","description":"Vector position to sample from"},{"type":"Vector","value":"Vector normal Normal vector of the surface","name":"normal","description":"Normal vector of the surface"}],"class":"function","name":"computeDynamicLighting","description":" Calculates the lighting caused by dynamic lights for the specified surface"},"draw3DQuad":{"path":"libs_cl/render.lua#L2103","realm":"client","params":[{"type":"Vector","value":"Vector vert1 First vertex.","name":"vert1","description":"First vertex."},{"type":"Vector","value":"Vector vert2 The second vertex.","name":"vert2","description":"The second vertex."},{"type":"Vector","value":"Vector vert3 The third vertex.","name":"vert3","description":"The third vertex."},{"type":"Vector","value":"Vector vert4 The fourth vertex.","name":"vert4","description":"The fourth vertex."}],"class":"function","name":"draw3DQuad","description":" Draws 2 connected triangles."},"getColorModulation":{"path":"libs_cl/render.lua#L868","returns":[{"type":"number","value":"number Red channel","description":"Red channel"},{"type":"number","value":"number Green channel","description":"Green channel"},{"type":"number","value":"number Blue channel","description":"Blue channel"}],"realm":"client","class":"function","name":"getColorModulation","description":" Gets the draw color modulation."},"enableDepth":{"path":"libs_cl/render.lua#L1932","realm":"client","params":[{"type":"boolean","value":"boolean enable True to enable","name":"enable","description":"True to enable"}],"class":"function","name":"enableDepth","description":" Enables or disables Depth Buffer"},"draw3DTriangle":{"path":"libs_cl/render.lua#L2184","realm":"client","params":[{"type":"Vector","value":"Vector vert1 Position of the first vertex.","name":"vert1","description":"Position of the first vertex."},{"type":"Vector","value":"Vector vert2 Position of the the second vertex.","name":"vert2","description":"Position of the the second vertex."},{"type":"Vector","value":"Vector vert3 Position of the the third vertex.","name":"vert3","description":"Position of the the third vertex."}],"class":"function","name":"draw3DTriangle","description":" Draws a triangle in 3D space"},"drawTexturedRectUVFast":{"path":"libs_cl/render.lua#L1516","realm":"client","params":[{"type":"number","value":"number x Top left corner x","name":"x","description":"Top left corner x"},{"type":"number","value":"number y Top left corner y","name":"y","description":"Top left corner y"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"},{"type":"number","value":"number startU Texture mapping at rectangle's origin U","name":"startU","description":"Texture mapping at rectangle's origin U"},{"type":"number","value":"number startV Texture mapping at rectangle's origin V","name":"startV","description":"Texture mapping at rectangle's origin V"},{"type":"number","value":"number endU Texture mapping at rectangle's end U","name":"endU","description":"Texture mapping at rectangle's end U"},{"type":"number","value":"number endV Texture mapping at rectangle's end V","name":"endV","description":"Texture mapping at rectangle's end V"},{"type":"boolean?","value":"boolean? UVHack If enabled, will scale the UVs to compensate for internal bug. Should be true for user created materials.","name":"UVHack","description":"If enabled, will scale the UVs to compensate for internal bug. Should be true for user created materials."}],"class":"function","name":"drawTexturedRectUVFast","description":" Draws a textured rectangle with UV coordinates\n Faster, but uses integer coordinates and will get clipped by user's screen resolution"},"createMaterial":{"path":"libs_cl/render.lua#L932","returns":[{"type":"Material","value":"Material The material. Use with render.setMaterial to draw with it.","description":"The material. Use with render.setMaterial to draw with it."}],"realm":"client","params":[{"type":"string","value":"string tx Texture file path, a http url, or image data: https://en.wikipedia.org/wiki/Data_URI_scheme","name":"tx","description":"Texture file path, a http url, or image data: https://en.wikipedia.org/wiki/Data_URI_scheme"},{"type":"function?","value":"function? cb An optional callback called when loading is done. Passes nil if it fails or Passes the material, url, width, height, and layout function which can be called with x, y, w, h to reposition the image in the texture.","name":"cb","description":"An optional callback called when loading is done. Passes nil if it fails or Passes the material, url, width, height, and layout function which can be called with x, y, w, h to reposition the image in the texture."},{"type":"function?","value":"function? done An optional callback called when the image is done loading. Passes the material, url","name":"done","description":"An optional callback called when the image is done loading. Passes the material, url"}],"class":"function","name":"createMaterial","description":" Looks up a texture by file name and creates an UnlitGeneric material with it.\n Also supports image URLs or image data (These will create a rendertarget for the $basetexture): https://en.wikipedia.org/wiki/Data_URI_scheme\n Make sure to store the material to use it rather than calling this slow function repeatedly.\n NOTE: This no longer supports material names. Use texture names instead (Textures are .vtf, material are .vmt)"},"readPixelRGBA":{"path":"libs_cl/render.lua#L2343","returns":[{"type":"number","value":"number The red channel value.","description":"The red channel value."},{"type":"number","value":"number The green channel value.","description":"The green channel value."},{"type":"number","value":"number The blue channel value.","description":"The blue channel value."},{"type":"number","value":"number The alpha channel value.","description":"The alpha channel value."}],"realm":"client","params":[{"type":"number","value":"number x Pixel x-coordinate.","name":"x","description":"Pixel x-coordinate."},{"type":"number","value":"number y Pixel y-coordinate.","name":"y","description":"Pixel y-coordinate."}],"class":"function","name":"readPixelRGBA","description":" Reads the color of the specified pixel."},"setMaterial":{"path":"libs_cl/render.lua#L964","realm":"client","params":[{"type":"Material","value":"Material mat The material object","name":"mat","description":"The material object"}],"class":"function","name":"setMaterial","description":" Sets the current render material"},"setViewPort":{"path":"libs_cl/render.lua#L2323","realm":"client","params":[{"type":"number","value":"number x Pixel x-coordinate.","name":"x","description":"Pixel x-coordinate."},{"type":"number","value":"number y Pixel y-coordinate.","name":"y","description":"Pixel y-coordinate."},{"type":"number","value":"number w Width of the viewport.","name":"w","description":"Width of the viewport."},{"type":"number","value":"number h Height of the viewport.","name":"h","description":"Height of the viewport."}],"class":"function","name":"setViewPort","description":" Changes the view port position and size."},"isHUDActive":{"path":"libs_cl/render.lua#L2387","returns":[{"type":"boolean","value":"boolean True if a HUD component is connected and active, nil otherwise","description":"True if a HUD component is connected and active, nil otherwise"}],"realm":"client","class":"function","name":"isHUDActive","description":" Checks if the client is connected to a HUD component that's linked to this chip"},"setStencilWriteMask":{"path":"libs_cl/render.lua#L691","realm":"client","params":[{"type":"number","value":"number mask The mask bitflag.","name":"mask","description":"The mask bitflag."}],"class":"function","name":"setStencilWriteMask","description":" Sets the unsigned 8-bit write bitflag mask to be used for any writes to the stencil buffer."}},"tables":{"Screen":{"path":"libs_cl/render.lua#L2752","fields":[{"name":"Name","description":"Pretty name of model"},{"name":"offset","description":"Offset of screen from prop"},{"name":"RS","description":"Resolution/scale"},{"name":"RatioX","description":"Inverted Aspect ratio (height divided by width)"},{"name":"x1","description":"Corner of screen in local coordinates (relative to offset?)"},{"name":"x2","description":"Corner of screen in local coordinates (relative to offset?)"},{"name":"y1","description":"Corner of screen in local coordinates (relative to offset?)"},{"name":"y2","description":"Corner of screen in local coordinates (relative to offset?)"},{"name":"z","description":"Screen plane offset in local coordinates (relative to offset?)"},{"name":"rot","description":"Screen rotation"}],"realm":"client","class":"table","name":"Screen","description":""},"Vertex":{"path":"libs_cl/render.lua#L2766","fields":[{"name":"x","description":"X coordinate"},{"name":"y","description":"Y coordinate"},{"name":"u","description":"U coordinate (optional, default is 0)"},{"name":"v","description":"V coordinate (optional, default is 0)"}],"realm":"client","class":"table","name":"Vertex","description":" Vertex format"}},"path":"libs_cl/render.lua#L413","libtbl":["render_library"],"realm":"client","fields":[],"class":"library","name":"render","description":" Render library. Screens are 512x512 units. Most functions require\n that you be in the rendering hook to call, otherwise an error is\n thrown. +x is right, +y is down"},"wire":{"methods":{"self":{"path":"libs_sv/wire.lua#L496","returns":[{"type":"Wirelink","value":"Wirelink Wirelink representing this entity","description":"Wirelink representing this entity"}],"realm":"server","class":"function","name":"self","description":" Returns the wirelink representing this entity."},"getWirelink":{"path":"libs_sv/wire.lua#L615","returns":[{"type":"Wirelink","value":"Wirelink Wirelink of the entity","description":"Wirelink of the entity"}],"realm":"server","params":[{"type":"Entity","value":"Entity ent Wire entity","name":"ent","description":"Wire entity"}],"class":"function","name":"getWirelink","description":" Returns a wirelink to a wire entity"},"adjustInputs":{"path":"libs_sv/wire.lua#L345","realm":"server","params":[{"type":"table","value":"table names An array of input names. May be modified by the function.","name":"names","description":"An array of input names. May be modified by the function."},{"type":"table","value":"table types An array of input types. Can be shortcuts. May be modified by the function.","name":"types","description":"An array of input types. Can be shortcuts. May be modified by the function."},{"type":"table?","value":"table? descriptions An optional array of input descriptions. ","name":"descriptions","description":"An optional array of input descriptions. "}],"class":"function","name":"adjustInputs","description":" Creates/Modifies wire inputs. All wire ports must begin with an uppercase\n letter and contain only alphabetical characters or numbers but may not begin with a number."},"create":{"path":"libs_sv/wire.lua#L511","realm":"server","params":[{"type":"Entity","value":"Entity entI Entity with input","name":"entI","description":"Entity with input"},{"type":"Entity","value":"Entity entO Entity with output","name":"entO","description":"Entity with output"},{"type":"string","value":"string inputname Input to be wired","name":"inputname","description":"Input to be wired"},{"type":"string","value":"string outputname Output to be wired","name":"outputname","description":"Output to be wired"},{"type":"number?","value":"number? width Width of the wire(optional)","name":"width","description":"Width of the wire(optional)"},{"type":"Color?","value":"Color? color Color of the wire(optional)","name":"color","description":"Color of the wire(optional)"},{"type":"string?","value":"string? materialName Material of the wire(optional), Valid materials are cable/rope, cable/cable2, cable/xbeam, cable/redlaser, cable/blue_elec, cable/physbeam, cable/hydra, arrowire/arrowire, arrowire/arrowire2","name":"materialName","description":"Material of the wire(optional), Valid materials are cable/rope, cable/cable2, cable/xbeam, cable/redlaser, cable/blue_elec, cable/physbeam, cable/hydra, arrowire/arrowire, arrowire/arrowire2"}],"class":"function","name":"create","description":" Wires two entities together"},"serverUUID":{"path":"libs_sv/wire.lua#L504","returns":[{"type":"string","value":"string Server UUID","description":"Server UUID"}],"realm":"server","class":"function","name":"serverUUID","description":" Returns the server's UUID."},"delete":{"path":"libs_sv/wire.lua#L563","realm":"server","params":[{"type":"Entity","value":"Entity entI Entity with input","name":"entI","description":"Entity with input"},{"type":"string","value":"string inputname Input to be un-wired","name":"inputname","description":"Input to be un-wired"}],"class":"function","name":"delete","description":" Unwires an entity's input"},"getOutputs":{"path":"libs_sv/wire.lua#L607","returns":[{"type":"table","value":"table Table of entity's output names","description":"Table of entity's output names"},{"type":"table","value":"table Table of entity's output types","description":"Table of entity's output types"}],"realm":"server","params":[{"type":"Entity","value":"Entity entO Entity with output(s)","name":"entO","description":"Entity with output(s)"}],"class":"function","name":"getOutputs","description":" Returns a table of entity's outputs"},"adjustPorts":{"path":"libs_sv/wire.lua#L440","realm":"server","params":[{"type":"table?","value":"table? inputs (Optional) A key-value table with input port names as keys and types as values. e.g. {MyInput=\"number\"} or {MyInput={type=\"number\"}}. If nil, input ports won't be changed. If you use the latter syntax for defining ports, you can also specify description alongside the type, ex. {MyInput={type=\"number\", description=\"Description for this input.\"}}","name":"inputs","description":"(Optional) A key-value table with input port names as keys and types as values. e.g. {MyInput=\"number\"} or {MyInput={type=\"number\"}}. If nil, input ports won't be changed. If you use the latter syntax for defining ports, you can also specify description alongside the type, ex. {MyInput={type=\"number\", description=\"Description for this input.\"}}"},{"type":"table?","value":"table? outputs (Optional) A key-value table with output port names as keys and types as values. The above behavior for inputs also applies for outputs.","name":"outputs","description":"(Optional) A key-value table with output port names as keys and types as values. The above behavior for inputs also applies for outputs."}],"class":"function","name":"adjustPorts","description":" Creates/Modifies wire inputs/outputs. All wire ports must begin with an uppercase\n letter and contain only alphabetical characters or numbers but may not begin with a number."},"getInputs":{"path":"libs_sv/wire.lua#L599","returns":[{"type":"table","value":"table Table of entity's input names","description":"Table of entity's input names"},{"type":"table","value":"table Table of entity's input types","description":"Table of entity's input types"}],"realm":"server","params":[{"type":"Entity","value":"Entity entI Entity with input(s)","name":"entI","description":"Entity with input(s)"}],"class":"function","name":"getInputs","description":" Returns a table of entity's inputs"},"adjustOutputs":{"path":"libs_sv/wire.lua#L388","realm":"server","params":[{"type":"table","value":"table names An array of output names. May be modified by the function.","name":"names","description":"An array of output names. May be modified by the function."},{"type":"table","value":"table types An array of output types. Can be shortcuts. May be modified by the function.","name":"types","description":"An array of output types. Can be shortcuts. May be modified by the function."},{"type":"table?","value":"table? descriptions An optional array of output descriptions. ","name":"descriptions","description":"An optional array of output descriptions. "}],"class":"function","name":"adjustOutputs","description":" Creates/Modifies wire outputs. All wire ports must begin with an uppercase\n letter and contain only alphabetical characters or numbers but may not begin with a number."}},"tables":{"ports":{"path":"libs_sv/wire.lua#L787","realm":"server","class":"table","name":"ports","description":" Ports table. Reads from this table will read from the wire input\n of the same name. Writes will write to the wire output of the same name."}},"path":"libs_sv/wire.lua#L17","libtbl":["wire_library"],"realm":"server","fields":[],"class":"library","name":"wire","description":" Wire library. Handles wire inputs/outputs, wirelinks, etc."},"socket":{"methods":{"connect4":{"path":"libs_cl/socket.lua#L241","returns":[{"type":"table","value":"table client TCPClient object. Nil if error","description":"client TCPClient object. Nil if error"},{"type":"string?","value":"string? error Error string if the previous return was nil, else nil","description":"error Error string if the previous return was nil, else nil"}],"realm":"client","params":[{"type":"number","value":"number addr Address to connect to","name":"addr","description":"Address to connect to"},{"type":"number","value":"number port Port to connect to","name":"port","description":"Port to connect to"},{"type":"number?","value":"number? laddr Local address to bind to","name":"laddr","description":"Local address to bind to"},{"type":"number?","value":"number? lport Local port to bind to","name":"lport","description":"Local port to bind to"}],"class":"function","name":"connect4","description":" This function is a shortcut that creates and returns a TCP client object connected to a remote address at a given port.\n Optionally, the user can also specify the local address and port to bind (locaddr and locport)"},"tcp6":{"path":"libs_cl/socket.lua#L189","returns":[{"type":"table","value":"table New IPv6 TCP Master Object, or nil if error","description":"New IPv6 TCP Master Object, or nil if error"},{"type":"string?","value":"string? The error message, or nil if no error","description":"The error message, or nil if no error"}],"realm":"client","class":"function","name":"tcp6","description":" Creates and returns an IPv6 TCP master object.\n A master object can be transformed into a server object with the method listen (after a call to bind) or into a client object with the method connect.\n The only other method supported by a master object is the close method.\n Note: The TCP object returned will have the option \"ipv6-v6only\" set to true."},"udp4":{"path":"libs_cl/socket.lua#L208","returns":[{"type":"table","value":"table New IPv4 UDP master object, or nil in case of error.","description":"New IPv4 UDP master object, or nil in case of error."},{"type":"string?","value":"string? The error string if errored, else nil","description":"The error string if errored, else nil"}],"realm":"client","class":"function","name":"udp4","description":" Creates and returns an unconnected IPv4 UDP object.\n Unconnected objects support the sendto, receive, receivefrom, getoption, getsockname, setoption, settimeout, setpeername, setsockname, and close methods.\n The setpeername method is used to connect the object."},"connect":{"path":"libs_cl/socket.lua#L227","returns":[{"type":"table","value":"table client TCPClient object. Nil if error","description":"client TCPClient object. Nil if error"},{"type":"string?","value":"string? error Error string if the previous return was nil, else nil","description":"error Error string if the previous return was nil, else nil"}],"realm":"client","params":[{"type":"number","value":"number addr Address to connect to","name":"addr","description":"Address to connect to"},{"type":"number","value":"number port Port to connect to","name":"port","description":"Port to connect to"},{"type":"number?","value":"number? laddr Local address to bind to","name":"laddr","description":"Local address to bind to"},{"type":"number?","value":"number? lport Local port to bind to","name":"lport","description":"Local port to bind to"},{"type":"string?","value":"string? family Socket family, either \"inet\" or \"inet6\".","name":"family","description":"Socket family, either \"inet\" or \"inet6\"."}],"class":"function","name":"connect","description":" This function is a shortcut that creates and returns a TCP client object connected to a remote address at a given port.\n Optionally, the user can also specify the local address and port to bind (locaddr and locport), or restrict the socket family to \"inet\" or \"inet6\".\n Without specifying family to connect, whether a tcp or tcp6 connection is created depends on your system configuration."},"udp":{"path":"libs_cl/socket.lua#L199","returns":[{"type":"table","value":"table New IPv4 TCP master object, or nil in case of error.","description":"New IPv4 TCP master object, or nil in case of error."},{"type":"string?","value":"string? The error string if errored, else nil","description":"The error string if errored, else nil"}],"realm":"client","class":"function","name":"udp","description":" Creates and returns an unconnected IPv4 UDP object.\n Unconnected objects support the sendto, receive, receivefrom, getoption, getsockname, setoption, settimeout, setpeername, setsockname, and close methods.\n The setpeername method is used to connect the object."},"tcp4":{"path":"libs_cl/socket.lua#L180","returns":[{"type":"table","value":"table New IPv4 TCP Master Object, or nil if error","description":"New IPv4 TCP Master Object, or nil if error"},{"type":"string?","value":"string? The error message, or nil if no error","description":"The error message, or nil if no error"}],"realm":"client","class":"function","name":"tcp4","description":" Creates and returns an IPv4 TCP master object.\n A master object can be transformed into a server object with the method listen (after a call to bind) or into a client object with the method connect.\n The only other method supported by a master object is the close method."},"tcp":{"path":"libs_cl/socket.lua#L171","returns":[{"type":"table","value":"table New IPv4 TCP Master Object, or nil if error","description":"New IPv4 TCP Master Object, or nil if error"},{"type":"string?","value":"string? The error message, or nil if no error","description":"The error message, or nil if no error"}],"realm":"client","class":"function","name":"tcp","description":" Creates and returns an IPv4 TCP master object.\n A master object can be transformed into a server object with the method listen (after a call to bind) or into a client object with the method connect.\n The only other method supported by a master object is the close method."},"udp6":{"path":"libs_cl/socket.lua#L217","returns":[{"type":"table","value":"table New IPv6 UDP master object, or nil in case of error.","description":"New IPv6 UDP master object, or nil in case of error."},{"type":"string?","value":"string? The error string if errored, else nil","description":"The error string if errored, else nil"}],"realm":"client","class":"function","name":"udp6","description":" Creates and returns an unconnected IPv4 UDP object.\n Unconnected objects support the sendto, receive, receivefrom, getoption, getsockname, setoption, settimeout, setpeername, setsockname, and close methods.\n The setpeername method is used to connect the object.\n Note: The UDP object returned will have the option \"ipv6-v6only\" set to true."},"connect6":{"path":"libs_cl/socket.lua#L253","returns":[{"type":"table","value":"table client TCPClient object. Nil if error","description":"client TCPClient object. Nil if error"},{"type":"string?","value":"string? error Error string if the previous return was nil, else nil","description":"error Error string if the previous return was nil, else nil"}],"realm":"client","params":[{"type":"number","value":"number addr Address to connect to","name":"addr","description":"Address to connect to"},{"type":"number","value":"number port Port to connect to","name":"port","description":"Port to connect to"},{"type":"number?","value":"number? laddr Local address to bind to","name":"laddr","description":"Local address to bind to"},{"type":"number?","value":"number? lport Local port to bind to","name":"lport","description":"Local port to bind to"}],"class":"function","name":"connect6","description":" This function is a shortcut that creates and returns a TCP client object connected to a remote address at a given port.\n Optionally, the user can also specify the local address and port to bind (locaddr and locport)"}},"tables":[],"path":"libs_cl/socket.lua#L134","libtbl":["socket_library"],"realm":"client","fields":[],"class":"library","name":"socket","description":" Socket library. Only usable by owner of starfall.\n See the WebSocket type for a version of this that doesn't require a DLL, and supports secure websockets (wss)\n Beware \"Blocking\" functions; they will freeze the game. See http://w3.impa.br/~diego/software/luasocket/socket.html\n Install the gmcl_socket.core_*.dll binary file to lua/bin and create a 'gm_socket_whitelist.txt' file in steamapps/common\n Each line in the whitelist will allow luasocket to access the specified domain and port. They are formatted as 'domain:port' e.g. 'garrysmod.com:80', '*.com:80' '95.123.12.22:27015'"}},"Hooks":{"OnPhysgunPickup":{"path":"libs_sh/hook.lua#L73","realm":"server","params":[{"type":"Player","value":"Player ply The player that has picked up something using the physics gun.","name":"ply","description":"The player that has picked up something using the physics gun."},{"type":"Entity","value":"Entity ent The entity that was picked up","name":"ent","description":"The entity that was picked up"}],"class":"hook","name":"OnPhysgunPickup","description":" Called when a player has successfully picked up an entity with their Physics Gun.\n Not to be confused with PhysgunPickup which is a predicted hook"},"setupskyboxfog":{"path":"libs_cl/render.lua#L331","realm":"client","params":[{"type":"number","value":"number scale Skybox scale","name":"scale","description":"Skybox scale"}],"class":"hook","name":"setupskyboxfog","description":" Called when skybox fog is drawn."},"PlayerEnteredVehicle":{"path":"libs_sh/hook.lua#L141","realm":"server","params":[{"type":"Player","value":"Player ply Player who entered a vehicle","name":"ply","description":"Player who entered a vehicle"},{"type":"Vehicle","value":"Vehicle vehicle Vehicle that was entered","name":"vehicle","description":"Vehicle that was entered"},{"type":"number","value":"number num Role. The seat number","name":"num","description":"Role. The seat number"}],"class":"hook","name":"PlayerEnteredVehicle","description":" Called when a players enters a vehicle"},"OnPlayerPhysicsPickup":{"path":"libs_sh/hook.lua#L37","realm":"server","params":[{"type":"Player","value":"Player ply Player picking up an object","name":"ply","description":"Player picking up an object"},{"type":"Entity","value":"Entity ent Entity being picked up","name":"ent","description":"Entity being picked up"}],"class":"hook","name":"OnPlayerPhysicsPickup","description":" Called when an entity is being picked up by +use"},"postdrawhud":{"path":"libs_cl/render.lua#L298","realm":"client","class":"hook","name":"postdrawhud","description":" Called after drawing HUD (2D Context)"},"writecell":{"path":"libs_sv/wire.lua#L837","realm":"server","params":[{"type":"any","value":"any address The address written to","name":"address","description":"The address written to"},{"type":"table","value":"table data The data being written","name":"data","description":"The data being written"}],"class":"hook","name":"writecell","description":" Called when a high speed device writes to a wired SF chip"},"remote":{"path":"libs_sh/hook.lua#L685","realm":"shared","params":[{"type":"Entity","value":"Entity sender The entity that caused the hook to run","name":"sender","description":"The entity that caused the hook to run"},{"type":"Player","value":"Player owner The owner of the sender","name":"owner","description":"The owner of the sender"},{"type":"...","value":"... payload The payload that was supplied when calling the hook","name":"payload","description":"The payload that was supplied when calling the hook"}],"class":"hook","name":"remote","description":" Remote hook.\n This hook can be called from other instances"},"EntityRemoved":{"path":"libs_sh/hook.lua#L486","realm":"shared","params":[{"type":"Entity","value":"Entity ent Entity being removed","name":"ent","description":"Entity being removed"},{"type":"boolean","value":"boolean fullupdate If clientside, will be true if the entity was removed by a fullupdate","name":"fullupdate","description":"If clientside, will be true if the entity was removed by a fullupdate"}],"class":"hook","name":"EntityRemoved","description":" Called when an entity is removed"},"addLaw":{"path":"libs_sh/darkrp2.lua#L489","realm":"shared","params":[{"type":"number","value":"number index Index of the law","name":"index","description":"Index of the law"},{"type":"string","value":"string law Law string","name":"law","description":"Law string"},{"type":"Player?","value":"Player? player The player who added the law.","name":"player","description":"The player who added the law."}],"class":"hook","name":"addLaw","description":" Called when a law is added. DarkRP only."},"hudshoulddraw":{"path":"libs_cl/render.lua#L241","returns":[{"type":"boolean","value":"boolean Return false to not draw the element","description":"Return false to not draw the element"}],"realm":"client","params":[{"type":"string","value":"string str The name of the hud element trying to be drawn","name":"str","description":"The name of the hud element trying to be drawn"}],"class":"hook","name":"hudshoulddraw","description":" Called when a hud element is attempting to be drawn"},"onLockpickCompleted":{"path":"libs_sh/darkrp2.lua#L544","realm":"server","params":[{"type":"Player","value":"Player ply The player attempting to lockpick the entity.","name":"ply","description":"The player attempting to lockpick the entity."},{"type":"boolean","value":"boolean success Whether the player succeeded in lockpicking the entity.","name":"success","description":"Whether the player succeeded in lockpicking the entity."},{"type":"Entity","value":"Entity ent The entity that was lockpicked.","name":"ent","description":"The entity that was lockpicked."}],"class":"hook","name":"onLockpickCompleted","description":" Called when a player has finished picking a lock, successfully or otherwise. DarkRP only.\n Will only be called if the lockpicker is the owner of the chip, or if the chip is running in superuser mode."},"renderoffscreen":{"path":"libs_cl/render.lua#L195","realm":"client","class":"hook","name":"renderoffscreen","description":" Called when a frame is requested to be drawn. Doesn't require a screen or HUD but only works on rendertargets. (2D Context)"},"PlayerStartVoice":{"path":"libs_sh/hook.lua#L321","returns":[{"type":"boolean?","value":"boolean? Return true to hide CHudVoiceStatus (Voice Chat HUD Element).","description":"Return true to hide CHudVoiceStatus (Voice Chat HUD Element)."}],"realm":"client","params":[{"type":"Player","value":"Player ply Player who started using voice chat","name":"ply","description":"Player who started using voice chat"}],"class":"hook","name":"PlayerStartVoice","description":" Called when a player starts using voice chat."},"VRPreRenderRight":{"path":"libs_sh/vr.lua#L51","realm":"client","class":"hook","name":"VRPreRenderRight","description":" Called before rendering the right eye. This along with the previous hook can be used to render different things in different eyes. HUD is required."},"KeyRelease":{"path":"libs_sh/hook.lua#L411","realm":"shared","params":[{"type":"Player","value":"Player ply Player releasing the key","name":"ply","description":"Player releasing the key"},{"type":"number","value":"number key The key being released","name":"key","description":"The key being released"}],"class":"hook","name":"KeyRelease","description":" Called when a player releases a key"},"PhysgunPickup":{"path":"libs_sh/hook.lua#L427","realm":"shared","params":[{"type":"Player","value":"Player ply Player picking up the entity","name":"ply","description":"Player picking up the entity"},{"type":"Entity","value":"Entity ent Entity being picked up","name":"ent","description":"Entity being picked up"}],"class":"hook","name":"PhysgunPickup","description":" Called when an entity gets picked up by a physgun\n This hook is predicted."},"PlayerAmmoChanged":{"path":"libs_sh/hook.lua#L453","realm":"shared","params":[{"type":"Player","value":"Player ply The player whose ammo is being affected.","name":"ply","description":"The player whose ammo is being affected."},{"type":"number","value":"number ammoID The ammo type ID","name":"ammoID","description":"The ammo type ID"},{"type":"number","value":"number oldcount Previous ammo count","name":"oldcount","description":"Previous ammo count"},{"type":"number","value":"number newcount The new ammo count","name":"newcount","description":"The new ammo count"}],"class":"hook","name":"PlayerAmmoChanged","description":" Called when a player's reserve ammo count changes."},"StartChat":{"path":"libs_sh/hook.lua#L259","realm":"client","params":[{"type":"boolean","value":"boolean isTeamChat Whether they're typing in team chat","name":"isTeamChat","description":"Whether they're typing in team chat"}],"class":"hook","name":"StartChat","description":" Called when the local player opens their chat window."},"lockpickStarted":{"path":"libs_sh/darkrp2.lua#L524","realm":"server","params":[{"type":"Player","value":"Player ply The player that is about to pick a lock.","name":"ply","description":"The player that is about to pick a lock."},{"type":"Entity","value":"Entity ent The entity being lockpicked.","name":"ent","description":"The entity being lockpicked."},{"type":"table","value":"table trace The trace result.","name":"trace","description":"The trace result."}],"class":"hook","name":"lockpickStarted","description":" Called when a player is about to pick a lock. DarkRP only.\n Will only be called if the lockpicker is the owner of the chip, or if the chip is running in superuser mode."},"FinishChat":{"path":"libs_sh/hook.lua#L266","realm":"client","class":"hook","name":"FinishChat","description":" Called when the local player closes their chat window."},"moneyPrinterPrintMoney":{"path":"libs_sh/darkrp2.lua#L433","realm":"server","params":[{"type":"Entity","value":"Entity moneyprinter The money printer","name":"moneyprinter","description":"The money printer"},{"type":"number","value":"number amount The amount to be printed","name":"amount","description":"The amount to be printed"}],"class":"hook","name":"moneyPrinterPrintMoney","description":" Called when a money printer is about to print money. DarkRP only.\n Not guaranteed to work for non-vanilla money printers.\n You should use moneyPrinterPrinted instead, as the printer is not guaranteed to print money even if this hook is called.\n Only works if the owner of the chip also owns the money printer, or if the chip is running in superuser mode."},"Removed":{"path":"libs_sh/hook.lua#L761","realm":"shared","class":"hook","name":"Removed","description":" Called when the starfall chip is removed"},"xinputPressed":{"path":"libs_cl/xinput.lua#L21","realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number button The button that was pushed. See https://github.com/mitterdoo/garrysmod-xinput#xinput_gamepad_","name":"button","description":"The button that was pushed. See https://github.com/mitterdoo/garrysmod-xinput#xinput_gamepad_"},{"type":"number","value":"number when The timer.realtime() at which this event occurred.","name":"when","description":"The timer.realtime() at which this event occurred."}],"class":"hook","name":"xinputPressed","description":" Called when a controller button has been pressed. Client must have XInput Lua binary installed."},"PlayerChangename":{"path":"libs_sh/hook.lua#L583","realm":"shared","params":[{"type":"Player","value":"Player player Player entity of the player.","name":"player","description":"Player entity of the player."},{"type":"string","value":"string oldname Name before change.","name":"oldname","description":"Name before change."},{"type":"string","value":"string newname Name after change.","name":"newname","description":"Name after change."}],"class":"hook","name":"PlayerChangename","description":" Called when a player changes their Steam name. (Game Event)"},"DupeFinished":{"path":"libs_sh/hook.lua#L766","realm":"server","params":[{"type":"table","value":"table entTbl A table of entities duped with the chip mapped to their previous indices.","name":"entTbl","description":"A table of entities duped with the chip mapped to their previous indices."}],"class":"hook","name":"DupeFinished","description":" Called after the starfall chip is duplicated and the duplication is finished."},"VRInput":{"path":"libs_sh/vr.lua#L26","realm":"client","params":[{"type":"string","value":"string actionname Name of the input","name":"actionname","description":"Name of the input"},{"type":"boolean","value":"boolean state State of the input","name":"state","description":"State of the input"}],"class":"hook","name":"VRInput","description":" This gets called every time a boolean controller input action changes state"},"PlayerHurt":{"path":"libs_sh/hook.lua#L107","realm":"shared","params":[{"type":"Player","value":"Player ply Player being hurt","name":"ply","description":"Player being hurt"},{"type":"Entity","value":"Entity attacker Entity causing damage to the player","name":"attacker","description":"Entity causing damage to the player"},{"type":"number","value":"number newHealth New health of the player","name":"newHealth","description":"New health of the player"},{"type":"number","value":"number damageTaken On server, Amount of damage the player has taken, nil on client.","name":"damageTaken","description":"On server, Amount of damage the player has taken, nil on client."}],"class":"hook","name":"PlayerHurt","description":" Called when a player gets hurt, uses the player_hurt game event clientside."},"xinputDisconnected":{"path":"libs_cl/xinput.lua#L13","realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number when The timer.realtime() at which this event occurred.","name":"when","description":"The timer.realtime() at which this event occurred."}],"class":"hook","name":"xinputDisconnected","description":" Called when a controller has been disconnected. Client must have XInput Lua binary installed."},"VRExit":{"path":"libs_sh/vr.lua#L19","realm":"shared","params":[{"type":"Player","value":"Player ply Player exiting VR","name":"ply","description":"Player exiting VR"}],"class":"hook","name":"VRExit","description":" Called when a player exits VR"},"VRStart":{"path":"libs_sh/vr.lua#L13","realm":"shared","params":[{"type":"Player","value":"Player ply Player entering VR","name":"ply","description":"Player entering VR"}],"class":"hook","name":"VRStart","description":" Called when a player enters VR"},"PlayerSwitchWeapon":{"path":"libs_sh/hook.lua#L444","realm":"shared","params":[{"type":"Player","value":"Player ply Player changing weapon","name":"ply","description":"Player changing weapon"},{"type":"Weapon","value":"Weapon oldwep Old weapon","name":"oldwep","description":"Old weapon"},{"type":"Weapon","value":"Weapon newweapon New weapon","name":"newweapon","description":"New weapon"}],"class":"hook","name":"PlayerSwitchWeapon","description":" Called when a player switches their weapon"},"think":{"path":"libs_sh/hook.lua#L756","realm":"shared","class":"hook","name":"think","description":" Think hook. Called each frame on the client and each game tick on the server."},"OnPhysgunFreeze":{"path":"libs_sh/hook.lua#L54","realm":"server","params":[{"type":"Weapon","value":"Weapon physgun The Physgun freezing the entity","name":"physgun","description":"The Physgun freezing the entity"},{"type":"PhysObj","value":"PhysObj physobj PhysObj of the entity","name":"physobj","description":"PhysObj of the entity"},{"type":"Entity","value":"Entity ent Entity being frozen","name":"ent","description":"Entity being frozen"},{"type":"Player","value":"Player ply Player freezing the entity","name":"ply","description":"Player freezing the entity"}],"class":"hook","name":"OnPhysgunFreeze","description":" Called when an entity is being frozen\n Note this is not called for players or NPCs held with the physgun (bug)"},"mouseWheeled":{"path":"libs_sh/input.lua#L141","realm":"client","params":[{"type":"number","value":"number delta Rotate delta","name":"delta","description":"Rotate delta"}],"class":"hook","name":"mouseWheeled","description":" Called when the mouse wheel is rotated"},"EntityFireBullets":{"path":"libs_sh/hook.lua#L502","returns":[{"type":"function?","value":"function? Optional callback to called as if it were the Bullet structure's Callback. Called before the bullet deals damage with attacker, traceResult.","description":"Optional callback to called as if it were the Bullet structure's Callback. Called before the bullet deals damage with attacker, traceResult."}],"realm":"shared","params":[{"type":"Entity","value":"Entity ent The entity that fired the bullet","name":"ent","description":"The entity that fired the bullet"},{"type":"table","value":"table data The bullet data. See http://wiki.facepunch.com/gmod/Structures/Bullet","name":"data","description":"The bullet data. See http://wiki.facepunch.com/gmod/Structures/Bullet"}],"class":"hook","name":"EntityFireBullets","description":" Called every time a bullet is fired from an entity"},"mousemoved":{"path":"libs_sh/input.lua#L125","realm":"client","params":[{"type":"number","value":"number x X coordinate moved","name":"x","description":"X coordinate moved"},{"type":"number","value":"number y Y coordinate moved","name":"y","description":"Y coordinate moved"}],"class":"hook","name":"mousemoved","description":" Called when the mouse is moved"},"OnContextMenuOpen":{"path":"libs_sh/hook.lua#L340","realm":"client","class":"hook","name":"OnContextMenuOpen","description":" Called when the player opens the context menu"},"PlayerChat":{"path":"libs_sh/hook.lua#L272","returns":[{"type":"boolean","value":"boolean Return true to hide the message. Can only be done for the owner of the chip","description":"Return true to hide the message. Can only be done for the owner of the chip"}],"realm":"shared","params":[{"type":"Player","value":"Player ply Player that said the message","name":"ply","description":"Player that said the message"},{"type":"string","value":"string text The message","name":"text","description":"The message"},{"type":"boolean","value":"boolean team Whether the message was team only","name":"team","description":"Whether the message was team only"},{"type":"boolean","value":"boolean isdead Whether the message was send from a dead player","name":"isdead","description":"Whether the message was send from a dead player"}],"class":"hook","name":"PlayerChat","description":" Called when a chat message is printed your chat window (chip owner only)"},"huddisconnected":{"path":"libs_sh/hook.lua#L790","realm":"shared","params":[{"type":"Entity","value":"Entity ent The hud component entity","name":"ent","description":"The hud component entity"},{"type":"Player","value":"Player ply The player who disconnected","name":"ply","description":"The player who disconnected"}],"class":"hook","name":"huddisconnected","description":" Called when the player disconnects from a HUD component linked to the Starfall Chip"},"OnPlayerPhysicsDrop":{"path":"libs_sh/hook.lua#L45","realm":"server","params":[{"type":"Player","value":"Player ply Player dropping the object","name":"ply","description":"Player dropping the object"},{"type":"Entity","value":"Entity ent Entity being dropped","name":"ent","description":"Entity being dropped"},{"type":"boolean","value":"boolean thrown Whether the entity was thrown or dropped","name":"thrown","description":"Whether the entity was thrown or dropped"}],"class":"hook","name":"OnPlayerPhysicsDrop","description":" Called when an entity is being dropped or thrown by +use"},"inputPressed":{"path":"libs_sh/input.lua#L110","realm":"client","params":[{"type":"number","value":"number button Number of the button","name":"button","description":"Number of the button"}],"class":"hook","name":"inputPressed","description":" Called when a button is pressed"},"GravGunPunt":{"path":"libs_sh/hook.lua#L419","realm":"shared","params":[{"type":"Player","value":"Player ply Player punting the gravgun","name":"ply","description":"Player punting the gravgun"},{"type":"Entity","value":"Entity ent Entity being punted","name":"ent","description":"Entity being punted"}],"class":"hook","name":"GravGunPunt","description":" Called when a player punts with the gravity gun"},"PlayerSpray":{"path":"libs_sh/hook.lua#L176","realm":"server","params":[{"type":"Player","value":"Player ply Player that sprayed","name":"ply","description":"Player that sprayed"}],"class":"hook","name":"PlayerSpray","description":" Called when a players sprays their logo"},"GravGunOnPickedUp":{"path":"libs_sh/hook.lua#L21","realm":"server","params":[{"type":"Player","value":"Player ply Player picking up an object","name":"ply","description":"Player picking up an object"},{"type":"Entity","value":"Entity ent Entity being picked up","name":"ent","description":"Entity being picked up"}],"class":"hook","name":"GravGunOnPickedUp","description":" Called when an entity is being picked up by a gravity gun"},"xinputStick":{"path":"libs_cl/xinput.lua#L49","realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number x The X coordinate of the trigger. -32768 - 32767 inclusive","name":"x","description":"The X coordinate of the trigger. -32768 - 32767 inclusive"},{"type":"number","value":"number y The Y coordinate of the trigger. -32768 - 32767 inclusive","name":"y","description":"The Y coordinate of the trigger. -32768 - 32767 inclusive"},{"type":"number","value":"number stick The stick that was moved. 0 is left","name":"stick","description":"The stick that was moved. 0 is left"},{"type":"number","value":"number when The timer.realtime() at which this event occurred.","name":"when","description":"The timer.realtime() at which this event occurred."}],"class":"hook","name":"xinputStick","description":" Called when a stick on the controller has moved. Client must have XInput Lua binary installed."},"PlayerEndVoice":{"path":"libs_sh/hook.lua#L333","realm":"client","params":[{"type":"Player","value":"Player ply Player who stopped talking","name":"ply","description":"Player who stopped talking"}],"class":"hook","name":"PlayerEndVoice","description":" Called when a player stops using voice chat."},"OnEntityWaterLevelChanged":{"path":"libs_sh/hook.lua#L248","realm":"server","params":[{"type":"Entity","value":"Entity ent The entity","name":"ent","description":"The entity"},{"type":"number","value":"number old Previous water level","name":"old","description":"Previous water level"},{"type":"number","value":"number new New water level","name":"new","description":"New water level"}],"class":"hook","name":"OnEntityWaterLevelChanged","description":" Called when the Entity:getWaterLevel of an entity is changed."},"PlayerNoClip":{"path":"libs_sh/hook.lua#L357","realm":"shared","params":[{"type":"Player","value":"Player ply Player toggling noclip","name":"ply","description":"Player toggling noclip"},{"type":"boolean","value":"boolean newState New noclip state. True if on.","name":"newState","description":"New noclip state. True if on."}],"class":"hook","name":"PlayerNoClip","description":" Called when a player toggles noclip"},"xinputTrigger":{"path":"libs_cl/xinput.lua#L39","realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number value The position of the trigger. 0-255 inclusive","name":"value","description":"The position of the trigger. 0-255 inclusive"},{"type":"number","value":"number trigger The trigger that was moved. 0 is left","name":"trigger","description":"The trigger that was moved. 0 is left"},{"type":"number","value":"number when The timer.realtime() at which this event occurred.","name":"when","description":"The timer.realtime() at which this event occurred."}],"class":"hook","name":"xinputTrigger","description":" Called when a trigger on the controller has moved. Client must have XInput Lua binary installed."},"StartEntityDriving":{"path":"libs_sh/hook.lua#L556","realm":"shared","params":[{"type":"Entity","value":"Entity ent Entity being driven","name":"ent","description":"Entity being driven"},{"type":"Player","value":"Player ply Player that is driving the entity","name":"ply","description":"Player that is driving the entity"}],"class":"hook","name":"StartEntityDriving","description":" Called when a player starts driving an entity"},"readcell":{"path":"libs_sv/wire.lua#L830","returns":[{"type":"any","value":"any The value read","description":"The value read"}],"realm":"server","params":[{"type":"any","value":"any address The address requested","name":"address","description":"The address requested"}],"class":"hook","name":"readcell","description":" Called when a high speed device reads from a wired SF chip"},"NetworkEntityCreated":{"path":"libs_sh/hook.lua#L298","realm":"client","params":[{"type":"Entity","value":"Entity ent New entity","name":"ent","description":"New entity"}],"class":"hook","name":"NetworkEntityCreated","description":" Called when a clientside entity gets created or re-created via lag/PVS"},"xinputConnected":{"path":"libs_cl/xinput.lua#L5","realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number when The timer.realtime() at which this event occurred.","name":"when","description":"The timer.realtime() at which this event occurred."}],"class":"hook","name":"xinputConnected","description":" Called when a controller has been connected. Client must have XInput Lua binary installed."},"ComponentUnlinked":{"path":"libs_sh/hook.lua#L784","realm":"shared","params":[{"type":"Entity","value":"Entity ent The component entity","name":"ent","description":"The component entity"}],"class":"hook","name":"ComponentUnlinked","description":" Called when a component is unlinked to the starfall"},"OnPhysgunReload":{"path":"libs_sh/hook.lua#L65","realm":"server","params":[{"type":"Weapon","value":"Weapon physgun The Physgun the player is reloading with","name":"physgun","description":"The Physgun the player is reloading with"},{"type":"Player","value":"Player ply Player reloading the physgun","name":"ply","description":"Player reloading the physgun"}],"class":"hook","name":"OnPhysgunReload","description":" Called when a player reloads their physgun"},"postdrawskybox":{"path":"libs_cl/render.lua#L364","realm":"client","class":"hook","name":"postdrawskybox","description":" Called after the 3D skybox is drawn. This will not be called if PreDrawSkyBox has prevented rendering of the skybox"},"postdraw2dskybox":{"path":"libs_cl/render.lua#L358","realm":"client","class":"hook","name":"postdraw2dskybox","description":" Called right after the 2D skybox has been drawn - allowing you to draw over it."},"starfallUsed":{"path":"libs_sh/hook.lua#L804","realm":"shared","params":[{"type":"Player","value":"Player activator Player who used the screen or chip","name":"activator","description":"Player who used the screen or chip"},{"type":"Entity","value":"Entity used The screen or chip entity that was used","name":"used","description":"The screen or chip entity that was used"}],"class":"hook","name":"starfallUsed","description":" Called when a player uses the screen"},"render":{"path":"libs_sh/hook.lua#L810","realm":"client","class":"hook","name":"render","description":" Called when a frame is requested to be drawn on screen. (2D/3D Context)"},"predrawskybox":{"path":"libs_cl/render.lua#L348","returns":[{"type":"boolean","value":"boolean Return true to not predraw the skybox both 2d and 3d","description":"Return true to not predraw the skybox both 2d and 3d"}],"realm":"client","class":"hook","name":"predrawskybox","description":" Called before the 3D skybox is drawn. This will not be called for maps with no 3D skybox, or when the 3d skybox is disabled"},"NotifyShouldTransmit":{"path":"libs_sh/hook.lua#L305","realm":"client","params":[{"type":"Entity","value":"Entity ent The entity","name":"ent","description":"The entity"},{"type":"boolean","value":"boolean shouldtransmit Whether it is now transmitting or not","name":"shouldtransmit","description":"Whether it is now transmitting or not"}],"class":"hook","name":"NotifyShouldTransmit","description":" Called when a clientside entity transmit state is changed. Usually when changing PVS\n If you want clientside render changes to persist on an entity you have to re-apply them\n each time it begins transmitting again"},"StarfallError":{"path":"libs_sh/hook.lua#L570","realm":"shared","params":[{"type":"Entity","value":"Entity ent Starfall chip that errored","name":"ent","description":"Starfall chip that errored"},{"type":"Player|Entity","value":"Player|Entity ply Who's fault it errored. World-entity if it was a server error, or player that the script errored if on client","name":"ply","description":"Who's fault it errored. World-entity if it was a server error, or player that the script errored if on client"},{"type":"string","value":"string err Error message","name":"err","description":"Error message"}],"class":"hook","name":"StarfallError","description":" Called when starfall chip errors"},"predrawviewmodels":{"path":"libs_cl/render.lua#L309","realm":"client","class":"hook","name":"predrawviewmodels","description":" Called before drawing the viewmodel rendergroup (3D Context)"},"drawhud":{"path":"libs_cl/render.lua#L235","realm":"client","class":"hook","name":"drawhud","description":" Called when a frame is requested to be drawn on hud. (2D Context)"},"predrawhud":{"path":"libs_cl/render.lua#L292","realm":"client","class":"hook","name":"predrawhud","description":" Called before drawing HUD (2D Context)"},"tick":{"path":"libs_sh/hook.lua#L564","realm":"shared","class":"hook","name":"tick","description":" Tick hook. Called each game tick on both the server and client."},"PostEntityFireBullets":{"path":"libs_sh/hook.lua#L520","realm":"shared","params":[{"type":"Entity","value":"Entity ent The entity that fired the bullet","name":"ent","description":"The entity that fired the bullet"},{"type":"table","value":"table data A table containing Trace (See http://wiki.facepunch.com/gmod/Structures/TraceResult) and AmmoType, Tracer, Damage, Force, Attacker, TracerName (see http://wiki.facepunch.com/gmod/Structures/Bullet)","name":"data","description":"A table containing Trace (See http://wiki.facepunch.com/gmod/Structures/TraceResult) and AmmoType, Tracer, Damage, Force, Attacker, TracerName (see http://wiki.facepunch.com/gmod/Structures/Bullet)"}],"class":"hook","name":"PostEntityFireBullets","description":" Called after a bullet is fired and it's trace has been calculated"},"removeLaw":{"path":"libs_sh/darkrp2.lua#L501","realm":"server","params":[{"type":"number","value":"number index Index of the law","name":"index","description":"Index of the law"},{"type":"string","value":"string law Law string","name":"law","description":"Law string"},{"type":"Player?","value":"Player? player The player who removed the law.","name":"player","description":"The player who removed the law."}],"class":"hook","name":"removeLaw","description":" Called when a law is removed. DarkRP only. Not usually called when /resetlaws is used."},"predrawtranslucentrenderables":{"path":"libs_cl/render.lua#L274","realm":"client","params":[{"type":"boolean","value":"boolean depth Whether the current draw is writing depth","name":"depth","description":"Whether the current draw is writing depth"},{"type":"boolean","value":"boolean skybox Whether the current draw is drawing the skybox","name":"skybox","description":"Whether the current draw is drawing the skybox"},{"type":"boolean","value":"boolean skybox3d Whether the current draw is drawing the 3D skybox","name":"skybox3d","description":"Whether the current draw is drawing the 3D skybox"}],"class":"hook","name":"predrawtranslucentrenderables","description":" Called before translucent entities are drawn. (Only works with HUD) (3D context)"},"PhysgunDrop":{"path":"libs_sh/hook.lua#L436","realm":"shared","params":[{"type":"Player","value":"Player ply Player dropping the entity","name":"ply","description":"Player dropping the entity"},{"type":"Entity","value":"Entity ent Entity being dropped","name":"ent","description":"Entity being dropped"}],"class":"hook","name":"PhysgunDrop","description":" Called when an entity being held by a physgun gets dropped"},"PlayerFootstep":{"path":"libs_sh/hook.lua#L365","returns":[{"type":"boolean?","value":"boolean? Return true to prevent default step sound (only on chip owner)","description":"Return true to prevent default step sound (only on chip owner)"}],"realm":"shared","params":[{"type":"Player","value":"Player ply The stepping player","name":"ply","description":"The stepping player"},{"type":"Vector","value":"Vector pos The position of the step","name":"pos","description":"The position of the step"},{"type":"number","value":"number foot Foot that is stepped. 0 for left, 1 for right","name":"foot","description":"Foot that is stepped. 0 for left, 1 for right"},{"type":"string","value":"string sound Sound that is going to play","name":"sound","description":"Sound that is going to play"},{"type":"number","value":"number volume Volume of the footstep","name":"volume","description":"Volume of the footstep"}],"class":"hook","name":"PlayerFootstep","description":" Called whenever a player steps"},"postdrawopaquerenderables":{"path":"libs_cl/render.lua#L265","realm":"client","params":[{"type":"boolean","value":"boolean depth Whether the current draw is writing depth","name":"depth","description":"Whether the current draw is writing depth"},{"type":"boolean","value":"boolean skybox Whether the current draw is drawing the skybox","name":"skybox","description":"Whether the current draw is drawing the skybox"},{"type":"boolean","value":"boolean skybox3d Whether the current draw is drawing the 3D skybox","name":"skybox3d","description":"Whether the current draw is drawing the 3D skybox"}],"class":"hook","name":"postdrawopaquerenderables","description":" Called after opaque entities are drawn. (Only works with HUD) (3D context)"},"predrawopaquerenderables":{"path":"libs_cl/render.lua#L256","realm":"client","params":[{"type":"boolean","value":"boolean depth Whether the current draw is writing depth","name":"depth","description":"Whether the current draw is writing depth"},{"type":"boolean","value":"boolean skybox Whether the current draw is drawing the skybox","name":"skybox","description":"Whether the current draw is drawing the skybox"},{"type":"boolean","value":"boolean skybox3d Whether the current draw is drawing the 3D skybox","name":"skybox3d","description":"Whether the current draw is drawing the 3D skybox"}],"class":"hook","name":"predrawopaquerenderables","description":" Called before opaque entities are drawn. (Only works with HUD) (3D context)"},"hologrammatrix":{"path":"libs_cl/render.lua#L227","realm":"client","class":"hook","name":"hologrammatrix","description":" Called before entities are drawn. You can't render anything, but you can edit hologram matrices before they are drawn."},"OnPlayerJump":{"path":"libs_sh/hook.lua#L385","realm":"shared","params":[{"type":"Player","value":"Player ply Player who jumped","name":"ply","description":"Player who jumped"},{"type":"number","value":"number speed The velocity/impulse of the jump","name":"speed","description":"The velocity/impulse of the jump"}],"class":"hook","name":"OnPlayerJump","description":" Called when a player jumps."},"resetLaws":{"path":"libs_sh/darkrp2.lua#L514","realm":"server","params":[{"type":"Player?","value":"Player? player The player resetting the laws.","name":"player","description":"The player resetting the laws."}],"class":"hook","name":"resetLaws","description":" Called when laws are reset. DarkRP only. Usually the only hook called when /resetlaws is used."},"renderscene":{"path":"libs_cl/render.lua#L207","realm":"client","params":[{"type":"Vector","value":"Vector origin View origin","name":"origin","description":"View origin"},{"type":"Angle","value":"Angle angles View angles","name":"angles","description":"View angles"},{"type":"number","value":"number fov View FOV","name":"fov","description":"View FOV"}],"class":"hook","name":"renderscene","description":" Called when a scene is requested to be drawn. This is used for the render.renderview function."},"PropBreak":{"path":"libs_sh/hook.lua#L494","realm":"shared","params":[{"type":"Player","value":"Player ply Player who broke it","name":"ply","description":"Player who broke it"},{"type":"Entity","value":"Entity ent Entity broken","name":"ent","description":"Entity broken"}],"class":"hook","name":"PropBreak","description":" Called when an entity is broken"},"net":{"path":"libs_sh/net.lua#L520","realm":"shared","params":[{"type":"string","value":"string name Name of the arriving net message","name":"name","description":"Name of the arriving net message"},{"type":"number","value":"number len Length of the arriving net message in bits","name":"len","description":"Length of the arriving net message in bits"},{"type":"Player?","value":"Player? ply On server, the player that sent the message. Nil on client.","name":"ply","description":"On server, the player that sent the message. Nil on client."}],"class":"hook","name":"net","description":" Called when a net message arrives"},"xinputReleased":{"path":"libs_cl/xinput.lua#L30","realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number button The button that was released. See https://github.com/mitterdoo/garrysmod-xinput#xinput_gamepad_","name":"button","description":"The button that was released. See https://github.com/mitterdoo/garrysmod-xinput#xinput_gamepad_"},{"type":"number","value":"number when The timer.realtime() at which this event occurred.","name":"when","description":"The timer.realtime() at which this event occurred."}],"class":"hook","name":"xinputReleased","description":" Called when a controller button has been released. Client must have XInput Lua binary installed."},"input":{"path":"libs_sv/wire.lua#L824","realm":"server","params":[{"type":"string","value":"string input The input name","name":"input","description":"The input name"},{"type":"any","value":"any value The value of the input","name":"value","description":"The value of the input"}],"class":"hook","name":"input","description":" Called when an input on a wired SF chip is written to"},"midi":{"path":"libs_cl/midi.lua#L27","libtbl":["midi_library"],"realm":"client","params":[{"type":"number","value":"number time the exact systime which the event occured","name":"time","description":"the exact systime which the event occured"},{"type":"number","value":"number command the command code of the event.  First 4 bits are the command code and last 4 are the channel","name":"command","description":"the command code of the event.  First 4 bits are the command code and last 4 are the channel"},{"type":"number","value":"number param1 Each command has their own set of parameters, see above","name":"param1","description":"Each command has their own set of parameters, see above"},{"type":"number","value":"number param2 Each command has their own set of parameters, see above","name":"param2","description":"Each command has their own set of parameters, see above"}],"class":"hook","name":"midi","description":" Event hook for midi devices.  \n Everytime a midi device outputs a signal, the callback function on the hook is called.\n Read up on the MIDI protocol to make better sense of everything -> https://ccrma.stanford.edu/~craig/articles/linuxmidi/misc/essenmidi.html\n Commands and their parameters:\n 0x80 NOTE_OFF              : param1 = key;                         param2 = velocity\n 0x90 NOTE_ON               : param1 = key;                         param2 = velocity\n 0xA0 AFTERTOUCH            : param1 = key;                         param2 = touch\n 0xB0 CONTINUOUS_CONTROLLER : param1 = button_number;               param2 = button_value\n 0xC0 PATCH_CHANGE          : param1 = patch number;\n 0xD0 CHANNEL_PRESSURE      : param1 = pressure;\n 0xE0 PITCH_BEND            : param1 = lsb(least signifigant bit);  param2 = msb(most signifigant bit)"},"PlayerLeaveVehicle":{"path":"libs_sh/hook.lua#L150","realm":"server","params":[{"type":"Player","value":"Player ply Player who left a vehicle","name":"ply","description":"Player who left a vehicle"},{"type":"Vehicle","value":"Vehicle vehicle Vehicle that was left","name":"vehicle","description":"Vehicle that was left"}],"class":"hook","name":"PlayerLeaveVehicle","description":" Called when a players leaves a vehicle"},"hudconnected":{"path":"libs_sh/hook.lua#L797","realm":"shared","params":[{"type":"Entity","value":"Entity ent The hud component entity","name":"ent","description":"The hud component entity"},{"type":"Player","value":"Player ply The player who connected","name":"ply","description":"The player who connected"}],"class":"hook","name":"hudconnected","description":" Called when the player connects to a HUD component linked to the Starfall Chip"},"DoAnimationEvent":{"path":"libs_sh/hook.lua#L463","realm":"shared","params":[{"type":"Player","value":"Player ply The player being animated","name":"ply","description":"The player being animated"},{"type":"number","value":"number event The event id","name":"event","description":"The event id"},{"type":"number","value":"number data The event data","name":"data","description":"The event data"}],"class":"hook","name":"DoAnimationEvent","description":" Called when a player animation event occurs"},"inputReleased":{"path":"libs_sh/input.lua#L117","realm":"client","params":[{"type":"number","value":"number button Number of the button","name":"button","description":"Number of the button"}],"class":"hook","name":"inputReleased","description":" Called when a button is released"},"ComponentLinked":{"path":"libs_sh/hook.lua#L778","realm":"shared","params":[{"type":"Entity","value":"Entity ent The component entity","name":"ent","description":"The component entity"}],"class":"hook","name":"ComponentLinked","description":" Called when a component is linked to the starfall"},"lockdownEnded":{"path":"libs_sh/darkrp2.lua#L469","realm":"server","params":[{"type":"Player?","value":"Player? actor The player who ended the lockdown, or nil.","name":"actor","description":"The player who ended the lockdown, or nil."}],"class":"hook","name":"lockdownEnded","description":" Called when a lockdown has ended. DarkRP only."},"PlayerDisconnect":{"path":"libs_sh/hook.lua#L608","realm":"shared","params":[{"type":"string","value":"string networkid The SteamID the player had. Will be \"BOT\" for bots and \"STEAM_0:0:0\" in single-player.","name":"networkid","description":"The SteamID the player had. Will be \"BOT\" for bots and \"STEAM_0:0:0\" in single-player."},{"type":"string","value":"string name The name the player had.","name":"name","description":"The name the player had."},{"type":"Player","value":"Player player Player entity the player had.","name":"player","description":"Player entity the player had."},{"type":"string","value":"string reason Reason for disconnecting.","name":"reason","description":"Reason for disconnecting."},{"type":"boolean","value":"boolean isbot False if the player isn't a bot, true if they are.","name":"isbot","description":"False if the player isn't a bot, true if they are."}],"class":"hook","name":"PlayerDisconnect","description":" Called when a player disconnects from the server. (Game Event)"},"PlayerChangedTeam":{"path":"libs_sh/hook.lua#L132","realm":"server","params":[{"type":"Player","value":"Player ply Player whose team has changed","name":"ply","description":"Player whose team has changed"},{"type":"number","value":"number oldTeam Index of the team the player was originally in. See team.getName and the team library","name":"oldTeam","description":"Index of the team the player was originally in. See team.getName and the team library"},{"type":"number","value":"number newTeam Index of the team the player has changed to.","name":"newTeam","description":"Index of the team the player has changed to."}],"class":"hook","name":"PlayerChangedTeam","description":" Called when a player has changed team using Player:SetTeam"},"PlayerConnect":{"path":"libs_sh/hook.lua#L595","realm":"shared","params":[{"type":"string","value":"string networkid The SteamID the player had. Will be \"BOT\" for bots and \"STEAM_0:0:0\" in single-player.","name":"networkid","description":"The SteamID the player had. Will be \"BOT\" for bots and \"STEAM_0:0:0\" in single-player."},{"type":"string","value":"string name The name the player had.","name":"name","description":"The name the player had."},{"type":"number","value":"number userid The UserID the player has.","name":"userid","description":"The UserID the player has."},{"type":"boolean","value":"boolean isbot False if the player isn't a bot, true if they are.","name":"isbot","description":"False if the player isn't a bot, true if they are."}],"class":"hook","name":"PlayerConnect","description":" Called when a player connects to the server. (Game Event)"},"VRPreRender":{"path":"libs_sh/vr.lua#L45","realm":"client","class":"hook","name":"VRPreRender","description":" Called before rendering the game. Any code that you want to run once per frame should be put here. HUD is required."},"EntityTakeDamage":{"path":"libs_sh/hook.lua#L211","returns":[{"type":"boolean?","value":"boolean? Return true to prevent the entity from taking damage","description":"Return true to prevent the entity from taking damage"}],"realm":"server","params":[{"type":"Entity","value":"Entity target Entity that is hurt","name":"target","description":"Entity that is hurt"},{"type":"Entity","value":"Entity attacker Entity that attacked","name":"attacker","description":"Entity that attacked"},{"type":"Entity","value":"Entity inflictor Entity that inflicted the damage","name":"inflictor","description":"Entity that inflicted the damage"},{"type":"number","value":"number amount How much damage","name":"amount","description":"How much damage"},{"type":"number","value":"number type Type of the damage","name":"type","description":"Type of the damage"},{"type":"Vector","value":"Vector position Position of the damage","name":"position","description":"Position of the damage"},{"type":"Vector","value":"Vector force Force of the damage","name":"force","description":"Force of the damage"}],"class":"hook","name":"EntityTakeDamage","description":" Called when an entity is damaged"},"setupworldfog":{"path":"libs_cl/render.lua#L315","realm":"client","class":"hook","name":"setupworldfog","description":" Called when world fog is drawn."},"postdrawtranslucentrenderables":{"path":"libs_cl/render.lua#L283","realm":"client","params":[{"type":"boolean","value":"boolean depth Whether the current draw is writing depth","name":"depth","description":"Whether the current draw is writing depth"},{"type":"boolean","value":"boolean skybox Whether the current draw is drawing the skybox","name":"skybox","description":"Whether the current draw is drawing the skybox"},{"type":"boolean","value":"boolean skybox3d Whether the current draw is drawing the 3D skybox","name":"skybox3d","description":"Whether the current draw is drawing the 3D skybox"}],"class":"hook","name":"postdrawtranslucentrenderables","description":" Called after translucent entities are drawn. (Only works with HUD) (3D context)"},"ChatTextChanged":{"path":"libs_sh/hook.lua#L285","realm":"client","params":[{"type":"string","value":"string txt Text it was changed to","name":"txt","description":"Text it was changed to"}],"class":"hook","name":"ChatTextChanged","description":" Called when the player's chat box text changes.\n Requires the 'input' permission."},"OnEntityCreated":{"path":"libs_sh/hook.lua#L474","realm":"shared","params":[{"type":"Entity","value":"Entity ent New entity","name":"ent","description":"New entity"}],"class":"hook","name":"OnEntityCreated","description":" Called when an entity gets created"},"moneyPrinterCatchFire":{"path":"libs_sh/darkrp2.lua#L400","realm":"server","params":[{"type":"Entity","value":"Entity moneyprinter The money printer that is about to catch fire","name":"moneyprinter","description":"The money printer that is about to catch fire"}],"class":"hook","name":"moneyPrinterCatchFire","description":" Called when a money printer is about to catch fire. DarkRP only. Called between moneyPrinterPrintMoney and moneyPrinterPrinted.\n Not guaranteed to work for non-vanilla money printers.\n Only works if the owner of the chip also owns the money printer, or if the chip is running in superuser mode."},"lockdownStarted":{"path":"libs_sh/darkrp2.lua#L479","realm":"server","params":[{"type":"Player?","value":"Player? actor The player who started the lockdown, or nil.","name":"actor","description":"The player who started the lockdown, or nil."}],"class":"hook","name":"lockdownStarted","description":" Called when a lockdown has started. DarkRP only."},"PlayerDeath":{"path":"libs_sh/hook.lua#L91","realm":"server","params":[{"type":"Player","value":"Player ply Player who died","name":"ply","description":"Player who died"},{"type":"Entity","value":"Entity inflictor Entity used to kill the player","name":"inflictor","description":"Entity used to kill the player"},{"type":"Entity","value":"Entity attacker Entity that killed the player","name":"attacker","description":"Entity that killed the player"}],"class":"hook","name":"PlayerDeath","description":" Called when a player dies"},"OnPlayerHitGround":{"path":"libs_sh/hook.lua#L393","realm":"shared","params":[{"type":"Player","value":"Player ply Player that hit the ground","name":"ply","description":"Player that hit the ground"},{"type":"boolean","value":"boolean inWater Did the player land in water?","name":"inWater","description":"Did the player land in water?"},{"type":"boolean","value":"boolean onFloater Did the player land on an object floating in the water?","name":"onFloater","description":"Did the player land on an object floating in the water?"},{"type":"number","value":"number speed The speed at which the player hit the ground","name":"speed","description":"The speed at which the player hit the ground"}],"class":"hook","name":"OnPlayerHitGround","description":" Called when a player makes contact with the ground after a jump or a fall."},"EndEntityDriving":{"path":"libs_sh/hook.lua#L548","realm":"shared","params":[{"type":"Entity","value":"Entity ent Entity that had been driven","name":"ent","description":"Entity that had been driven"},{"type":"Player","value":"Player ply Player that drove the entity","name":"ply","description":"Player that drove the entity"}],"class":"hook","name":"EndEntityDriving","description":" Called when a player stops driving an entity"},"EntityEmitSound":{"path":"libs_sh/hook.lua#L532","returns":[{"type":"boolean?","value":"boolean? Return false to prevent the sound from playing or nothing to play the sound without altering it.","description":"Return false to prevent the sound from playing or nothing to play the sound without altering it."}],"realm":"shared","params":[{"type":"table","value":"table data Information about the played sound. Changes done to this table can be applied by returning true from this hook. See https://wiki.facepunch.com/gmod/Structures/EmitSoundInfo.","name":"data","description":"Information about the played sound. Changes done to this table can be applied by returning true from this hook. See https://wiki.facepunch.com/gmod/Structures/EmitSoundInfo."}],"class":"hook","name":"EntityEmitSound","description":" Called whenever a sound has been played. This will not be called clientside if the server played the sound without the client also calling Entity:EmitSound."},"PlayerSpawn":{"path":"libs_sh/hook.lua#L125","realm":"server","params":[{"type":"Player","value":"Player ply Player who spawned","name":"ply","description":"Player who spawned"}],"class":"hook","name":"PlayerSpawn","description":" Called when a player spawns"},"PlayerDisconnected":{"path":"libs_sh/hook.lua#L100","realm":"server","params":[{"type":"Player","value":"Player ply Player that disconnected","name":"ply","description":"Player that disconnected"}],"class":"hook","name":"PlayerDisconnected","description":" Called when a player disconnects"},"OnContextMenuClose":{"path":"libs_sh/hook.lua#L346","realm":"client","class":"hook","name":"OnContextMenuClose","description":" Called when the player closes the context menu"},"PlayerUnfrozeObject":{"path":"libs_sh/hook.lua#L82","realm":"server","params":[{"type":"Player","value":"Player ply The player who has unfrozen an entity","name":"ply","description":"The player who has unfrozen an entity"},{"type":"Entity","value":"Entity ent The unfrozen entity","name":"ent","description":"The unfrozen entity"},{"type":"PhysObj","value":"PhysObj physobj The physics object of the unfrozen entity ","name":"physobj","description":"The physics object of the unfrozen entity "}],"class":"hook","name":"PlayerUnfrozeObject","description":" Called when a player unfreezes an object"},"playerWalletChanged":{"path":"libs_sh/darkrp2.lua#L452","realm":"server","params":[{"type":"Player","value":"Player ply The player who is getting money.","name":"ply","description":"The player who is getting money."},{"type":"number","value":"number amount The amount of money given to the player.","name":"amount","description":"The amount of money given to the player."},{"type":"number","value":"number wallet How much money the player had before receiving the money.","name":"wallet","description":"How much money the player had before receiving the money."}],"class":"hook","name":"playerWalletChanged","description":" Called when a player receives money. DarkRP only.\n Will only be called if the recipient is the owner of the chip, or if the chip is running in superuser mode."},"ClientInitialized":{"path":"libs_sh/hook.lua#L772","realm":"server","params":[{"type":"Player","value":"Player ply The player that initialized","name":"ply","description":"The player that initialized"}],"class":"hook","name":"ClientInitialized","description":" Called after a client's starfall has initialized. Use this to know when it's safe to send net messages to the client."},"OnNPCKilled":{"path":"libs_sh/hook.lua#L239","realm":"server","params":[{"type":"Npc","value":"Npc npc NPC that was killed","name":"npc","description":"NPC that was killed"},{"type":"Entity","value":"Entity attacker The NPCs attacker, the entity that gets the kill credit, for example a player or an NPC.","name":"attacker","description":"The NPCs attacker, the entity that gets the kill credit, for example a player or an NPC."},{"type":"Entity","value":"Entity inflictor Entity that did the killing","name":"inflictor","description":"Entity that did the killing"}],"class":"hook","name":"OnNPCKilled","description":" Called whenever an NPC is killed."},"moneyPrinterPrinted":{"path":"libs_sh/darkrp2.lua#L416","realm":"server","params":[{"type":"Entity","value":"Entity moneyprinter The money printer","name":"moneyprinter","description":"The money printer"},{"type":"Entity","value":"Entity moneybag The moneybag produed by the printer.","name":"moneybag","description":"The moneybag produed by the printer."}],"class":"hook","name":"moneyPrinterPrinted","description":" Called after a money printer is has printed money. DarkRP only.\n Not guaranteed to work for non-vanilla money printers.\n Only works if the owner of the chip also owns the money printer, or if the chip is running in superuser mode."},"PlayerCanPickupWeapon":{"path":"libs_sh/hook.lua#L200","realm":"server","params":[{"type":"Player","value":"Player ply Player","name":"ply","description":"Player"},{"type":"Weapon","value":"Weapon wep Weapon","name":"wep","description":"Weapon"}],"class":"hook","name":"PlayerCanPickupWeapon","description":" Called when a wants to pick up a weapon"},"calcview":{"path":"libs_cl/render.lua#L370","returns":[{"type":"table","value":"table Table containing information for the camera. {origin=camera origin, angles=camera angles, fov=camera fov, znear=znear, zfar=zfar, drawviewer=drawviewer, ortho=ortho table}","description":"Table containing information for the camera. {origin=camera origin, angles=camera angles, fov=camera fov, znear=znear, zfar=zfar, drawviewer=drawviewer, ortho=ortho table}"}],"realm":"client","params":[{"type":"Vector","value":"Vector pos Current position of the camera","name":"pos","description":"Current position of the camera"},{"type":"Angle","value":"Angle ang Current angles of the camera","name":"ang","description":"Current angles of the camera"},{"type":"number","value":"number fov Current fov of the camera","name":"fov","description":"Current fov of the camera"},{"type":"number","value":"number znear Current near plane of the camera","name":"znear","description":"Current near plane of the camera"},{"type":"number","value":"number zfar Current far plane of the camera","name":"zfar","description":"Current far plane of the camera"}],"class":"hook","name":"calcview","description":" Called when the engine wants to calculate the player's view. Only works if connected to Starfall HUD"},"PlayerSwitchFlashlight":{"path":"libs_sh/hook.lua#L192","realm":"server","params":[{"type":"Player","value":"Player ply Player switching flashlight","name":"ply","description":"Player switching flashlight"},{"type":"boolean","value":"boolean state New flashlight state. True if on.","name":"state","description":"New flashlight state. True if on."}],"class":"hook","name":"PlayerSwitchFlashlight","description":" Called when a players turns their flashlight on or off"},"PlayerSay":{"path":"libs_sh/hook.lua#L159","returns":[{"type":"string?","value":"string? New text. \"\" to stop from displaying. Nil to keep original.","description":"New text. \"\" to stop from displaying. Nil to keep original."}],"realm":"server","params":[{"type":"Player","value":"Player ply Player that sent the message","name":"ply","description":"Player that sent the message"},{"type":"string","value":"string text Content of the message","name":"text","description":"Content of the message"},{"type":"boolean","value":"boolean teamChat True if team chat","name":"teamChat","description":"True if team chat"}],"class":"hook","name":"PlayerSay","description":" Called when a player sends a chat message"},"PlayerInitialSpawn":{"path":"libs_sh/hook.lua#L117","realm":"server","params":[{"type":"Player","value":"Player ply Player who spawned","name":"ply","description":"Player who spawned"},{"type":"boolean","value":"boolean transition If true, the player just spawned from a map transition.","name":"transition","description":"If true, the player just spawned from a map transition."}],"class":"hook","name":"PlayerInitialSpawn","description":" Called when a player spawns for the first time"},"permissionrequest":{"path":"libs_sh/builtins.lua#L324","realm":"client","class":"hook","name":"permissionrequest","description":" Called when local client changed instance permissions"},"PlayerUse":{"path":"libs_sh/hook.lua#L183","realm":"server","params":[{"type":"Player","value":"Player ply Player using the entity","name":"ply","description":"Player using the entity"},{"type":"Entity","value":"Entity ent Entity being used","name":"ent","description":"Entity being used"}],"class":"hook","name":"PlayerUse","description":" Called when a player holds their use key and looks at an entity.\n Will continuously run."},"KeyPress":{"path":"libs_sh/hook.lua#L403","realm":"shared","params":[{"type":"Player","value":"Player ply Player pressing the key","name":"ply","description":"Player pressing the key"},{"type":"number","value":"number key The key being pressed","name":"key","description":"The key being pressed"}],"class":"hook","name":"KeyPress","description":" Called when a player presses a key"},"GravGunOnDropped":{"path":"libs_sh/hook.lua#L29","realm":"server","params":[{"type":"Player","value":"Player ply Player dropping the object","name":"ply","description":"Player dropping the object"},{"type":"Entity","value":"Entity ent Entity being dropped","name":"ent","description":"Entity being dropped"}],"class":"hook","name":"GravGunOnDropped","description":" Called when an entity is being dropped by a gravity gun"}},"Version":"master","Directives":{"server":{"path":"libs_sh/builtins.lua#L1267","realm":"shared","class":"directive","name":"server","description":" Set the current file to only run on the server. Shared is default. --@server"},"shared":{"path":"libs_sh/builtins.lua#L1275","realm":"shared","class":"directive","name":"shared","description":" Set the current file to run on both the server and client. This is enabled by default. --@shared"},"owneronly":{"path":"libs_sh/builtins.lua#L1290","realm":"shared","class":"directive","name":"owneronly","description":" Set the current file to only be sent to the owner. --@owneronly"},"model":{"path":"libs_sh/builtins.lua#L1262","realm":"shared","params":[{"type":"model","value":"model String of the model","name":"String","description":"of the model"}],"class":"directive","name":"model","description":" Set the model of the processor entity. --@model models/props_junk/watermelon01.mdl"},"client":{"path":"libs_sh/builtins.lua#L1271","realm":"shared","class":"directive","name":"client","description":" Set the current file to only run on the client. Shared is default. --@client"},"includedata":{"path":"libs_sh/builtins.lua#L1243","realm":"shared","params":[{"type":"path","value":"path Path to the file","name":"Path","description":"to the file"}],"class":"directive","name":"includedata","description":" Mark a file to be included in the upload.\n Different from include in that the file does not have to have valid syntax.\n Cannot be used with require() or dofile(), can only be used with getScripts()."},"includedir":{"path":"libs_sh/builtins.lua#L1237","realm":"shared","params":[{"type":"path","value":"path Path to the directory","name":"Path","description":"to the directory"}],"class":"directive","name":"includedir","description":" Mark a directory to be included in the upload.\n This is optional to include all files in the directory in require() and dofile()"},"superuser":{"path":"libs_sh/builtins.lua#L1286","realm":"shared","class":"directive","name":"superuser","description":" Lets the chip run with no restrictions and the chip owner becomes SF.Superuser. Can only be used in the main file. --@superuser"},"clientmain":{"path":"libs_sh/builtins.lua#L1279","realm":"shared","params":[{"type":"filename","value":"filename The file to run as main on client","name":"The","description":"file to run as main on client"}],"class":"directive","name":"clientmain","description":" Set the client file to run as main. Can only be used in the main file. The client file must be --@include'ed. The main file will not be sent to the client if you use this directive.\n --@include somefile.txt\n --@clientmain somefile.txt"},"name":{"path":"libs_sh/builtins.lua#L1250","realm":"shared","params":[{"type":"name","value":"name Name of the script","name":"Name","description":"of the script"}],"class":"directive","name":"name","description":" Set the name of the script.\n This will become the name of the tab and will show on the overlay of the processor. --@name Awesome script"},"include":{"path":"libs_sh/builtins.lua#L1230","realm":"shared","params":[{"type":"path","value":"path Path to the file, or URL of the single-file library to be included","name":"Path","description":"to the file, or URL of the single-file library to be included"}],"class":"directive","name":"include","description":" Mark a file to be included in the upload.\n URL is also supported, e.g. --@include http://mydomain.com/myfile as myfile.txt\n This is required to use the file in require() and dofile()"},"author":{"path":"libs_sh/builtins.lua#L1256","realm":"shared","params":[{"type":"author","value":"author Author of the script","name":"Author","description":"of the script"}],"class":"directive","name":"author","description":" Set the author of the script.\n This will set the author that will be shown on the overlay of the processor. --@author TheAuthor"}},"Types":{"NavArea":{"path":"libs_sv/navmesh.lua#L23","libtbl":["navarea_methods","navarea_meta"],"realm":"server","methods":{"getCenter":{"path":"libs_sv/navmesh.lua#L390","returns":[{"type":"Vector","value":"Vector The center vector.","description":"The center vector."}],"realm":"server","class":"function","name":"getCenter","description":" Returns the center position of the CNavArea."},"getSizeX":{"path":"libs_sv/navmesh.lua#L518","returns":[{"type":"number","value":"number Width","description":"Width"}],"realm":"server","class":"function","name":"getSizeX","description":" Returns the width this Nav Area."},"getAdjacentAreas":{"path":"libs_sv/navmesh.lua#L337","returns":[{"type":"table","value":"table A table of all CNavArea that have a ( one and two way ) connection from this CNavArea.","description":"A table of all CNavArea that have a ( one and two way ) connection from this CNavArea."}],"realm":"server","class":"function","name":"getAdjacentAreas","description":" Returns a table of all the CNavAreas that have a ( one and two way ) connection from this NavArea.\n If an area has a one-way incoming connection to this NavArea, then it will not be returned from this function, use NavArea:getIncomingConnections to get all one-way incoming connections.\n See NavArea:getAdjacentAreasAtSide for a function that only returns areas from one side/direction."},"isConnectedAtSide":{"path":"libs_sv/navmesh.lua#L295","returns":[{"type":"boolean","value":"boolean","description":""}],"realm":"server","params":[{"type":"NavArea","value":"NavArea other The other NavArea to check for connection to.","name":"other","description":"The other NavArea to check for connection to."},{"type":"number","value":"number navDirType The direction, in which to look for the connection. See NAV_DIR enums","name":"navDirType","description":"The direction, in which to look for the connection. See NAV_DIR enums"}],"class":"function","name":"isConnectedAtSide","description":" Returns whether this NavArea has an outgoing ( one or two way ) connection to given NavArea in given direction."},"setParent":{"path":"libs_sv/navmesh.lua#L687","realm":"server","params":[{"type":"NavArea","value":"NavArea parent The new parent to set","name":"parent","description":"The new parent to set"},{"type":"number","value":"number how How we get from parent to us using NAV_TRAVERSE_TYPE","name":"how","description":"How we get from parent to us using NAV_TRAVERSE_TYPE"}],"class":"function","name":"setParent","description":" Sets the new parent of this CNavArea."},"hasAttributes":{"path":"libs_sv/navmesh.lua#L547","returns":[{"type":"boolean","value":"boolean True if the CNavArea matches the given mask. False otherwise.","description":"True if the CNavArea matches the given mask. False otherwise."}],"realm":"server","params":[{"type":"number","value":"number attributes Attribute mask to check for, see NAV_MESH enums","name":"attributes","description":"Attribute mask to check for, see NAV_MESH enums"}],"class":"function","name":"hasAttributes","description":" Returns true if the given CNavArea has this attribute flag set."},"getParentHow":{"path":"libs_sv/navmesh.lua#L488","returns":[{"type":"number","value":"number","description":""}],"realm":"server","class":"function","name":"getParentHow","description":" Returns how this CNavArea is connected to its parent."},"getCorner":{"path":"libs_sv/navmesh.lua#L405","returns":[{"type":"Vector","value":"Vector The vector position of the corner.","description":"The vector position of the corner."}],"realm":"server","params":[{"type":"number","value":"number cornerId The target corner to get the position of, takes NAV_CORNER.","name":"cornerId","description":"The target corner to get the position of, takes NAV_CORNER."}],"class":"function","name":"getCorner","description":" Returns the vector position of the corner for the given CNavArea."},"computeGroundHeightChange":{"path":"libs_sv/navmesh.lua#L321","returns":[{"type":"number","value":"number","description":""}],"realm":"server","params":[{"type":"NavArea","value":"NavArea other The nav area to test against.","name":"other","description":"The nav area to test against."}],"class":"function","name":"computeGroundHeightChange","description":" Returns the height difference on the Z axis of the two CNavAreas. This is calculated from the center most point on both CNavAreas."},"clearSearchLists":{"path":"libs_sv/navmesh.lua#L749","realm":"server","class":"function","name":"clearSearchLists","description":" Clears the open and closed lists for a new search."},"isOpen":{"path":"libs_sv/navmesh.lua#L239","returns":[{"type":"boolean","value":"boolean Whether this area is in the Open List.","description":"Whether this area is in the Open List."}],"realm":"server","class":"function","name":"isOpen","description":" Returns whether this area is in the Open List.\n Used in pathfinding via the A* algorithm.\n More information can be found here: https://wiki.facepunch.com/gmod/Simple_Pathfinding"},"addToOpenList":{"path":"libs_sv/navmesh.lua#L742","realm":"server","class":"function","name":"addToOpenList","description":" Adds this CNavArea to the Open List.\n Requires `navarea.openlist` permission"},"addToClosedList":{"path":"libs_sv/navmesh.lua#L737","realm":"server","class":"function","name":"addToClosedList","description":" Adds this CNavArea to the closed list, a list of areas that have been checked by A* pathfinding algorithm."},"getClosestPointOnArea":{"path":"libs_sv/navmesh.lua#L397","returns":[{"type":"Vector","value":"Vector The closest point on the NavArea.","description":"The closest point on the NavArea."}],"realm":"server","params":[{"type":"Vector","value":"Vector pos The given position, can be outside of the NavArea bounds.","name":"pos","description":"The given position, can be outside of the NavArea bounds."}],"class":"function","name":"getClosestPointOnArea","description":" Returns the closest point of this NavArea from the given position."},"addHidingSpot":{"path":"libs_sv/navmesh.lua#L722","realm":"server","params":[{"type":"Vector","value":"Vector pos The position of the hiding spot on the nav area","name":"pos","description":"The position of the hiding spot on the nav area"},{"type":"number","value":"number flags Flags describing what kind of hiding spot this is.","name":"flags","description":"Flags describing what kind of hiding spot this is."}],"class":"function","name":"addHidingSpot","description":" Adds a hiding spot onto this nav area.\n There's a limit of 255 hiding spots per area.\n 0 = None (not recommended)\n 1 = In Cover/basically a hiding spot, in a corner with good hard cover nearby\n 2 = good sniper spot, had at least one decent sniping corridor\n 4 = perfect sniper spot, can see either very far, or a large area, or both\n 8 = exposed, spot in the open, usually on a ledge or cliff\n Values over 255 will be clamped."},"disconnect":{"path":"libs_sv/navmesh.lua#L715","realm":"server","params":[{"type":"NavArea","value":"NavArea other The other NavArea to disconnect from.","name":"other","description":"The other NavArea to disconnect from."}],"class":"function","name":"disconnect","description":" Disconnects this nav area from given area or ladder. (Only disconnects one way)"},"updateOnOpenList":{"path":"libs_sv/navmesh.lua#L710","realm":"server","class":"function","name":"updateOnOpenList","description":" Moves this open list to appropriate position based on its CNavArea:getTotalCost compared to the total cost of other areas in the open list."},"getAttributes":{"path":"libs_sv/navmesh.lua#L383","returns":[{"type":"number","value":"number Attribute mask for this CNavArea, see NAV_MESH for the specific flags.","description":"Attribute mask for this CNavArea, see NAV_MESH for the specific flags."}],"realm":"server","class":"function","name":"getAttributes","description":" Returns the attribute mask for the given CNavArea."},"setTotalCost":{"path":"libs_sv/navmesh.lua#L703","realm":"server","params":[{"type":"number","value":"number cost The total cost of the path to set. (>= 0)","name":"cost","description":"The total cost of the path to set. (>= 0)"}],"class":"function","name":"setTotalCost","description":" Sets the total cost when passing from starting area to the goal area through this node."},"computeDirection":{"path":"libs_sv/navmesh.lua#L313","returns":[{"type":"number","value":"number The direction the vector is in relation to this NavArea. See NAV_DIR enums","description":"The direction the vector is in relation to this NavArea. See NAV_DIR enums"}],"realm":"server","params":[{"type":"Vector","value":"Vector pos The position to compute direction towards.","name":"pos","description":"The position to compute direction towards."}],"class":"function","name":"computeDirection","description":" Returns the NAV_DIR direction that the given vector faces on this NavArea."},"getRandomPoint":{"path":"libs_sv/navmesh.lua#L511","returns":[{"type":"Vector","value":"Vector The random point on the nav area.","description":"The random point on the nav area."}],"realm":"server","class":"function","name":"getRandomPoint","description":" Returns a random point on the nav area."},"placeOnGround":{"path":"libs_sv/navmesh.lua#L636","realm":"server","params":[{"type":"number","value":"number corner The corner(s) to drop, uses NAV_CORNER enums","name":"corner","description":"The corner(s) to drop, uses NAV_CORNER enums"}],"class":"function","name":"placeOnGround","description":" Drops a corner or all corners of a CNavArea to the ground below it."},"connectTo":{"path":"libs_sv/navmesh.lua#L754","realm":"server","params":[{"type":"NavArea","value":"NavArea other The CNavArea this area leads to.","name":"other","description":"The CNavArea this area leads to."}],"class":"function","name":"connectTo","description":" Connects this CNavArea to another CNavArea with a one way connection. ( From this area to the target )"},"setPlace":{"path":"libs_sv/navmesh.lua#L695","returns":[{"type":"boolean","value":"boolean True if operation succeeded, false otherwise.","description":"True if operation succeeded, false otherwise."}],"realm":"server","params":[{"type":"string?","value":"string? place Place to set. Leave as nil to remove place from NavArea","name":"place","description":"Place to set. Leave as nil to remove place from NavArea"}],"class":"function","name":"setPlace","description":" Sets the Place of the nav area.\n There is a limit of 256 Places per nav file"},"setCorner":{"path":"libs_sv/navmesh.lua#L672","realm":"server","params":[{"type":"number","value":"number corner The corner to set, uses NAV_CORNER enums","name":"corner","description":"The corner to set, uses NAV_CORNER enums"},{"type":"Vector","value":"Vector pos The new position to set.","name":"pos","description":"The new position to set."}],"class":"function","name":"setCorner","description":" Sets the position of a corner of a nav area."},"getIncomingConnections":{"path":"libs_sv/navmesh.lua#L452","returns":[{"type":"table","value":"table Table of all CNavAreas with one-way connection to this CNavArea.","description":"Table of all CNavAreas with one-way connection to this CNavArea."}],"realm":"server","class":"function","name":"getIncomingConnections","description":" Returns a table of all the CNavAreas that have a one-way connection to this CNavArea.\n If a CNavArea has a two-way connection to or from this CNavArea then it will not be returned from this function, use CNavArea:GetAdjacentAreas to get outgoing ( one and two way ) connections.\n See CNavArea:getIncomingConnectionsAtSide for a function that returns one-way incoming connections from only one side/direction."},"isOpenListEmpty":{"path":"libs_sv/navmesh.lua#L248","returns":[{"type":"boolean","value":"boolean Whether the Open List is empty or not.","description":"Whether the Open List is empty or not."}],"realm":"server","class":"function","name":"isOpenListEmpty","description":" Returns whether the Open List is empty or not.\n Used in pathfinding via the A* algorithm.\n More information can be found here: https://wiki.facepunch.com/gmod/Simple_Pathfinding"},"getParent":{"path":"libs_sv/navmesh.lua#L481","returns":[{"type":"NavArea","value":"NavArea The parent NavArea","description":"The parent NavArea"}],"realm":"server","class":"function","name":"getParent","description":" Returns the parent NavArea"},"getIncomingConnectionsAtSide":{"path":"libs_sv/navmesh.lua#L465","returns":[{"type":"table","value":"table Table of all CNavAreas with one-way connection to this CNavArea from given direction.","description":"Table of all CNavAreas with one-way connection to this CNavArea from given direction."}],"realm":"server","params":[{"type":"number","value":"number navDir The direction, from which to look for CNavAreas, see NAV_DIR enums.","name":"navDir","description":"The direction, from which to look for CNavAreas, see NAV_DIR enums."}],"class":"function","name":"getIncomingConnectionsAtSide","description":" Returns a table of all the CNavAreas that have a one-way connection to this CNavArea from given direction.\n If a CNavArea has a two-way connection to or from this CNavArea then it will not be returned from this function, use CNavArea:getAdjacentAreas to get outgoing ( one and two way ) connections.\n See CNavArea:getIncomingConnections for a function that returns one-way incoming connections from all sides/directions."},"isValid":{"path":"libs_sv/navmesh.lua#L257","returns":[{"type":"boolean","value":"boolean Whether this NavArea is valid or not","description":"Whether this NavArea is valid or not"}],"realm":"server","class":"function","name":"isValid","description":" Returns whether this NavArea is valid or not."},"isConnected":{"path":"libs_sv/navmesh.lua#L286","returns":[{"type":"boolean","value":"boolean Whether this NavArea has an outgoing ( one or two way ) connection to given NavArea.","description":"Whether this NavArea has an outgoing ( one or two way ) connection to given NavArea."}],"realm":"server","params":[{"type":"NavArea","value":"NavArea other The other NavArea to check for connection to.","name":"other","description":"The other NavArea to check for connection to."}],"class":"function","name":"isConnected","description":" Returns whether this NavArea has an outgoing ( one or two way ) connection to given NavArea.\n See NavArea:isConnectedAtSide for a function that only checks for outgoing connections in one direction."},"isFlat":{"path":"libs_sv/navmesh.lua#L279","returns":[{"type":"boolean","value":"boolean Whether this NavArea is mostly flat.","description":"Whether this NavArea is mostly flat."}],"realm":"server","class":"function","name":"isFlat","description":" Returns whether this Nav Area is flat within the tolerance of the nav_coplanar_slope_limit_displacement and nav_coplanar_slope_limit convars."},"setCostSoFar":{"path":"libs_sv/navmesh.lua#L680","realm":"server","params":[{"type":"number","value":"number cost The cost so far","name":"cost","description":"The cost so far"}],"class":"function","name":"setCostSoFar","description":" Sets the cost from starting area this area when pathfinding."},"removeFromClosedList":{"path":"libs_sv/navmesh.lua#L660","realm":"server","class":"function","name":"removeFromClosedList","description":" Removes the given NavArea from the Closed List"},"remove":{"path":"libs_sv/navmesh.lua#L652","realm":"server","class":"function","name":"remove","description":" Removes the given NavArea."},"isCompletelyVisible":{"path":"libs_sv/navmesh.lua#L575","returns":[{"type":"boolean","value":"boolean Whether this CNavArea can see the given CNavArea.","description":"Whether this CNavArea can see the given CNavArea."}],"realm":"server","params":[{"type":"NavArea","value":"NavArea area The area to test visibility with.","name":"area","description":"The area to test visibility with."}],"class":"function","name":"isCompletelyVisible","description":" Returns whether this CNavArea can completely (i.e. all corners of this area can see all corners of the given area) see the given CNavArea."},"getExtentInfo":{"path":"libs_sv/navmesh.lua#L433","returns":[{"type":"table","value":"table Struct containing the above keys","description":"Struct containing the above keys"}],"realm":"server","class":"function","name":"getExtentInfo","description":" Returns size info about the nav area.\n Vector hi\n Vector lo\n number SizeX\n number SizeY\n number SizeZ"},"popOpenList":{"path":"libs_sv/navmesh.lua#L643","returns":[{"type":"NavArea","value":"NavArea The CNavArea from the Open List with the lowest cost to traverse to from the starting node.","description":"The CNavArea from the Open List with the lowest cost to traverse to from the starting node."}],"realm":"server","class":"function","name":"popOpenList","description":" Removes a CNavArea from the Open List with the lowest cost to traverse to from the starting node, and returns it.\n Requires the `navarea.openlist` permission"},"isVisible":{"path":"libs_sv/navmesh.lua#L626","returns":[{"type":"boolean","value":"boolean Whether we can be seen or not.","description":"Whether we can be seen or not."},{"type":"Vector","value":"Vector If we can be seen, this is returned with either the center or one of the corners of the Nav Area.","description":"If we can be seen, this is returned with either the center or one of the corners of the Nav Area."}],"realm":"server","params":[{"type":"Vector","value":"Vector pos The position to check.","name":"pos","description":"The position to check."}],"class":"function","name":"isVisible","description":" Returns whether we can be seen from the given position."},"getID":{"path":"libs_sv/navmesh.lua#L445","returns":[{"type":"number","value":"number The unique ID.","description":"The unique ID."}],"realm":"server","class":"function","name":"getID","description":" Returns this CNavAreas unique ID."},"isBlocked":{"path":"libs_sv/navmesh.lua#L556","returns":[{"type":"boolean","value":"boolean Whether the area is blocked or not","description":"Whether the area is blocked or not"}],"realm":"server","params":[{"type":"number?","value":"number? teamID The team ID to test, -2 = any team. Only 2 actual teams are available, 0 and 1. (Default -2)","name":"teamID","description":"The team ID to test, -2 = any team. Only 2 actual teams are available, 0 and 1. (Default -2)"},{"type":"boolean?","value":"boolean? ignoreNavBlockers Whether to ignore func_nav_blocker entities. (Default false)","name":"ignoreNavBlockers","description":"Whether to ignore func_nav_blocker entities. (Default false)"}],"class":"function","name":"isBlocked","description":" Returns whether the nav area is blocked or not, i.e. whether it can be walked through or not."},"isUnderwater":{"path":"libs_sv/navmesh.lua#L264","returns":[{"type":"boolean","value":"boolean Whether we're underwater or not.","description":"Whether we're underwater or not."}],"realm":"server","class":"function","name":"isUnderwater","description":" Whether this NavArea is placed underwater."},"isOverlappingArea":{"path":"libs_sv/navmesh.lua#L594","returns":[{"type":"boolean","value":"boolean True if the given CNavArea overlaps this CNavArea at any point.","description":"True if the given CNavArea overlaps this CNavArea at any point."}],"realm":"server","params":[{"type":"NavArea","value":"NavArea area The area to test.","name":"area","description":"The area to test."}],"class":"function","name":"isOverlappingArea","description":" Returns true if this CNavArea is overlapping the given CNavArea."},"getExposedSpots":{"path":"libs_sv/navmesh.lua#L421","returns":[{"type":"table","value":"table A table of Vectors","description":"A table of Vectors"}],"realm":"server","class":"function","name":"getExposedSpots","description":" Returns a table of very bad hiding spots in this area.\n See also NavArea:getHidingSpots"},"isPotentiallyVisible":{"path":"libs_sv/navmesh.lua#L611","returns":[{"type":"boolean","value":"boolean Whether the given area is visible from this area","description":"Whether the given area is visible from this area"}],"realm":"server","params":[{"type":"NavArea","value":"NavArea area The area to test.","name":"area","description":"The area to test."}],"class":"function","name":"isPotentiallyVisible","description":" Returns whether this CNavArea can potentially see the given CNavArea."},"setAttributes":{"path":"libs_sv/navmesh.lua#L665","realm":"server","params":[{"type":"number","value":"number attributes The attribute bitflag. See NAV_MESH enums","name":"attributes","description":"The attribute bitflag. See NAV_MESH enums"}],"class":"function","name":"setAttributes","description":" Sets the attributes for given CNavArea."},"getRandomAdjacentAreaAtSide":{"path":"libs_sv/navmesh.lua#L502","returns":[{"type":"NavArea","value":"NavArea The random CNavArea that has an outgoing ( one or two way ) connection from this CNavArea in given direction, if any.","description":"The random CNavArea that has an outgoing ( one or two way ) connection from this CNavArea in given direction, if any."}],"realm":"server","params":[{"type":"number","value":"number navDir The direction, from which to look for CNavAreas, see NAV_DIR enums.","name":"navDir","description":"The direction, from which to look for CNavAreas, see NAV_DIR enums."}],"class":"function","name":"getRandomAdjacentAreaAtSide","description":" Returns a random CNavArea that has an outgoing ( one or two way ) connection from this CNavArea in given direction."},"isRoughlySquare":{"path":"libs_sv/navmesh.lua#L619","returns":[{"type":"boolean","value":"boolean If we're a square or not.","description":"If we're a square or not."}],"realm":"server","class":"function","name":"isRoughlySquare","description":" Returns if we're shaped like a square."},"contains":{"path":"libs_sv/navmesh.lua#L271","returns":[{"type":"boolean","value":"boolean If the vector is inside the area","description":"If the vector is inside the area"}],"realm":"server","params":[{"type":"Vector","value":"Vector v The position to check","name":"v","description":"The position to check"}],"class":"function","name":"contains","description":" Returns true if this NavArea contains the given vector."},"getZ":{"path":"libs_sv/navmesh.lua#L539","returns":[{"type":"number","value":"number Elevation","description":"Elevation"}],"realm":"server","params":[{"type":"Vector","value":"Vector The position to get the elevation from, the z value from this position is ignored and only the X and Y values are used to this task.","name":"The","description":"position to get the elevation from, the z value from this position is ignored and only the X and Y values are used to this task."}],"class":"function","name":"getZ","description":" Returns the elevation of this Nav Area at the given position."},"isCoplanar":{"path":"libs_sv/navmesh.lua#L305","returns":[{"type":"boolean","value":"boolean Whether we're coplanar or not.","description":"Whether we're coplanar or not."}],"realm":"server","params":[{"type":"NavArea","value":"NavArea other The other NavArea to check against","name":"other","description":"The other NavArea to check against"}],"class":"function","name":"isCoplanar","description":" Returns whether this Nav Area is in the same plane as the given one."},"getAdjacentCount":{"path":"libs_sv/navmesh.lua#L365","returns":[{"type":"number","value":"number The amount of CNavAreas that have a connection ( one and two way ) from this CNavArea.","description":"The amount of CNavAreas that have a connection ( one and two way ) from this CNavArea."}],"realm":"server","class":"function","name":"getAdjacentCount","description":" Returns the amount of CNavAreas that have a connection ( one and two way ) from this CNavArea.\n See CNavArea:GetAdjacentCountAtSide for a function that only returns area count from one side/direction."},"computeAdjacentConnectionHeightChange":{"path":"libs_sv/navmesh.lua#L329","returns":[{"type":"number","value":"number The height change","description":"The height change"}],"realm":"server","params":[{"type":"NavArea","value":"NavArea other The nav area to test against.","name":"other","description":"The nav area to test against."}],"class":"function","name":"computeAdjacentConnectionHeightChange","description":" Returns the height difference between the edges of two connected navareas."},"isOverlapping":{"path":"libs_sv/navmesh.lua#L583","returns":[{"type":"number","value":"number Whether the given position overlaps the NavArea or not.","description":"Whether the given position overlaps the NavArea or not."}],"realm":"server","params":[{"type":"Vector","value":"Vector pos The position to test.","name":"pos","description":"The position to test."},{"type":"number?","value":"number? tolerance The tolerance of the overlapping, set to 0 for no tolerance. (Default 0)","name":"tolerance","description":"The tolerance of the overlapping, set to 0 for no tolerance. (Default 0)"}],"class":"function","name":"isOverlapping","description":" Returns if this position overlaps the NavArea within the given tolerance."},"isPartiallyVisible":{"path":"libs_sv/navmesh.lua#L602","returns":[{"type":"boolean","value":"boolean Whether the given position is visible from this area","description":"Whether the given position is visible from this area"}],"realm":"server","params":[{"type":"Vector","value":"Vector pos The position to test.","name":"pos","description":"The position to test."},{"type":"Entity?","value":"Entity? ignoreEnt If set, the given entity will be ignored when doing LOS tests (Default NULL)","name":"ignoreEnt","description":"If set, the given entity will be ignored when doing LOS tests (Default NULL)"}],"class":"function","name":"isPartiallyVisible","description":" Returns whether this CNavArea can see given position."},"getAdjacentAreasAtSide":{"path":"libs_sv/navmesh.lua#L350","returns":[{"type":"table","value":"table A table of all CNavArea that have a ( one and two way ) connection from this CNavArea in given direction.","description":"A table of all CNavArea that have a ( one and two way ) connection from this CNavArea in given direction."}],"realm":"server","params":[{"type":"number","value":"number navDir The direction, in which to look for CNavAreas, see NAV_DIR enums","name":"navDir","description":"The direction, in which to look for CNavAreas, see NAV_DIR enums"}],"class":"function","name":"getAdjacentAreasAtSide","description":" Returns a table of all the CNavAreas that have a ( one and two way ) connection from this CNavArea in given direction.\n If an area has a one-way incoming connection to this CNavArea, then it will not be returned from this function, use CNavArea:GetIncomingConnections to get all incoming connections.\n See CNavArea:getAdjacentAreas for a function that returns all areas from all sides/directions."},"getAdjacentCountAtSide":{"path":"libs_sv/navmesh.lua#L373","returns":[{"type":"number","value":"number The amount of CNavAreas that have a connection ( one or two way ) from this CNavArea in given direction.","description":"The amount of CNavAreas that have a connection ( one or two way ) from this CNavArea in given direction."}],"realm":"server","params":[{"type":"number","value":"number The direction, in which to look for CNavAreas, see NAV_DIR enums.","name":"The","description":"direction, in which to look for CNavAreas, see NAV_DIR enums."}],"class":"function","name":"getAdjacentCountAtSide","description":" Returns the amount of CNavAreas that have a connection ( one or two way ) from this CNavArea in given direction.\n See CNavArea:getAdjacentCount for a function that returns CNavArea count from/in all sides/directions."},"isClosed":{"path":"libs_sv/navmesh.lua#L568","returns":[{"type":"boolean","value":"boolean Whether this node is in the Closed List.","description":"Whether this node is in the Closed List."}],"realm":"server","class":"function","name":"isClosed","description":" Returns whether this node is in the Closed List."},"getTotalCost":{"path":"libs_sv/navmesh.lua#L532","returns":[{"type":"number","value":"number The total cost","description":"The total cost"}],"realm":"server","class":"function","name":"getTotalCost","description":" Returns the total cost when passing from starting area to the goal area through this node. Set by NavArea:setTotalCost."},"getPlace":{"path":"libs_sv/navmesh.lua#L495","returns":[{"type":"string","value":"string The place of the nav area, or no value if it doesn't have a place set.","description":"The place of the nav area, or no value if it doesn't have a place set."}],"realm":"server","class":"function","name":"getPlace","description":" Returns the place of the NavArea"},"getSizeY":{"path":"libs_sv/navmesh.lua#L525","returns":[{"type":"number","value":"number Height","description":"Height"}],"realm":"server","class":"function","name":"getSizeY","description":" Returns the height this Nav Area."},"getCostSoFar":{"path":"libs_sv/navmesh.lua#L414","returns":[{"type":"number","value":"number The cost so far.","description":"The cost so far."}],"realm":"server","class":"function","name":"getCostSoFar","description":" Returns the cost from starting area this area when pathfinding. Set by NavArea:setCostSoFar"}},"class":"type","name":"NavArea","description":" NavArea type, returned by navmesh library functions"},"NextBot":{"path":"libs_sv/nextbot.lua#L4","libtbl":["nb_methods","nb_meta"],"realm":"server","methods":{"removeApproachPos":{"path":"libs_sv/nextbot.lua#L132","realm":"server","class":"function","name":"removeApproachPos","description":" Removes the \"approach\" position from the NextBot."},"setRunAct":{"path":"libs_sv/nextbot.lua#L207","realm":"server","params":[{"type":"number","value":"number runact The activity the nextbot will use.","name":"runact","description":"The activity the nextbot will use."}],"class":"function","name":"setRunAct","description":" Sets the activity the nextbot uses for running."},"setVelocity":{"path":"libs_sv/nextbot.lua#L247","realm":"server","params":[{"type":"Vector","value":"Vector newvel Velocity.","name":"newvel","description":"Velocity."}],"class":"function","name":"setVelocity","description":" Sets the nextbot's velocity. Seems to work only when used if nextbot is in air after using nextbot:jump()"},"setJumpGapsAllowed":{"path":"libs_sv/nextbot.lua#L650","realm":"server","params":[{"type":"boolean","value":"boolean jumpgapsallowed Whether this bot should be allowed to jump gaps.","name":"jumpgapsallowed","description":"Whether this bot should be allowed to jump gaps."}],"class":"function","name":"setJumpGapsAllowed","description":" Sets whether the Nextbot is allowed to jump gaps or not. This is used during path generation. Works similarly to nb_allow_gap_jumping convar. By default bots are allowed to jump gaps."},"getRunAct":{"path":"libs_sv/nextbot.lua#L219","returns":[{"type":"number","value":"number The run activity.","description":"The run activity."}],"realm":"server","class":"function","name":"getRunAct","description":" Gets the activity the nextbot uses for running."},"setStepHeight":{"path":"libs_sv/nextbot.lua#L569","realm":"server","params":[{"type":"number","value":"number stepheight Height (default is 18)","name":"stepheight","description":"Height (default is 18)"}],"class":"function","name":"setStepHeight","description":" Sets the max height the bot can step up."},"removeGotoPos":{"path":"libs_sv/nextbot.lua#L160","realm":"server","class":"function","name":"removeGotoPos","description":" Removes the \"go to\" position from the NextBot."},"getMaxYawRate":{"path":"libs_sv/nextbot.lua#L515","realm":"server","params":[{"type":"number","value":"number The NextBot's max yaw rate.","name":"The","description":"NextBot's max yaw rate."}],"class":"function","name":"getMaxYawRate","description":" Gets the max rate at which the NextBot can visually rotate."},"getDeathDropHeight":{"path":"libs_sv/nextbot.lua#L561","returns":[{"type":"number","value":"number Height nextbot is afraid of.","description":"Height nextbot is afraid of."}],"realm":"server","class":"function","name":"getDeathDropHeight","description":" Gets the height the nextbot is scared to fall from."},"playSequence":{"path":"libs_sv/nextbot.lua#L179","realm":"server","params":[{"type":"string","value":"string seqtoplay The name of the sequence to play.","name":"seqtoplay","description":"The name of the sequence to play."}],"class":"function","name":"playSequence","description":" Makes the nextbot play a sequence. This takes priority over movement. Will go to set pos after animation plays."},"removeDeathCallback":{"path":"libs_sv/nextbot.lua#L308","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID of the callback to remove.","name":"callbackid","description":"The unique ID of the callback to remove."}],"class":"function","name":"removeDeathCallback","description":" Removes a death callback function from the NextBot."},"setGravity":{"path":"libs_sv/nextbot.lua#L541","realm":"server","params":[{"type":"number","value":"number newgravity NB's new gravity. Default is 1000","name":"newgravity","description":"NB's new gravity. Default is 1000"}],"class":"function","name":"setGravity","description":" Sets the gravity of the NextBot."},"addLeaveGroundCallback":{"path":"libs_sv/nextbot.lua#L362","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID this callback will use.","name":"callbackid","description":"The unique ID this callback will use."},{"type":"function","value":"function callback The function to run when the NB leaves the ground. The arguments are: (The entity the NB \"jumped\" from.)","name":"callback","description":"The function to run when the NB leaves the ground. The arguments are: (The entity the NB \"jumped\" from.)"}],"class":"function","name":"addLeaveGroundCallback","description":" Adds a callback function that will be run when this nextbot leaves the ground."},"addInjuredCallback":{"path":"libs_sv/nextbot.lua#L318","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID this callback will use.","name":"callbackid","description":"The unique ID this callback will use."},{"type":"function","value":"function callback The function to run when the NB gets injured. The arguments are: (Damage, Attacker, Inflictor, Damage Pos, Damage Force, Damage Type)","name":"callback","description":"The function to run when the NB gets injured. The arguments are: (Damage, Attacker, Inflictor, Damage Pos, Damage Force, Damage Type)"}],"class":"function","name":"addInjuredCallback","description":" Adds a callback function that will be run when this nextbot is injured."},"removeNavChangeCallback":{"path":"libs_sv/nextbot.lua#L418","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID of the callback to remove.","name":"callbackid","description":"The unique ID of the callback to remove."}],"class":"function","name":"removeNavChangeCallback","description":" Removes a nav area change callback function from the NextBot."},"jumpAcrossGap":{"path":"libs_sv/nextbot.lua#L686","realm":"server","params":[{"type":"Vector","value":"Vector landGoal The goal the nextbot should aim for.","name":"landGoal","description":"The goal the nextbot should aim for."},{"type":"Vector","value":"Vector landForward Presumably the direction vector the entity should be aiming in when landing.","name":"landForward","description":"Presumably the direction vector the entity should be aiming in when landing."}],"class":"function","name":"jumpAcrossGap","description":" Makes the bot jump across a gap. The bot must be on ground (Entity:isOnGround). Its model must have the ACT_JUMP activity for proper animation."},"addDeathCallback":{"path":"libs_sv/nextbot.lua#L296","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID this callback will use.","name":"callbackid","description":"The unique ID this callback will use."},{"type":"function","value":"function callback The function to run when the NB dies. The arguments are: (Damage, Attacker, Inflictor, Damage Pos, Damage Force, Damage Type)","name":"callback","description":"The function to run when the NB dies. The arguments are: (Damage, Attacker, Inflictor, Damage Pos, Damage Force, Damage Type)"}],"class":"function","name":"addDeathCallback","description":" Adds a callback function that will be run when this nextbot dies."},"setGotoPos":{"path":"libs_sv/nextbot.lua#L151","realm":"server","params":[{"type":"Vector","value":"Vector gotopos The position the nextbot will continuosly try to go to.","name":"gotopos","description":"The position the nextbot will continuosly try to go to."}],"class":"function","name":"setGotoPos","description":" Makes the nextbot try to go to a specified position using navmesh pathfinding."},"getVelocity":{"path":"libs_sv/nextbot.lua#L256","returns":[{"type":"Vector","value":"Vector NB's velocity.","description":"NB's velocity."}],"realm":"server","class":"function","name":"getVelocity","description":" Gets the nextbot's velocity as a vector."},"getAvoidAllowed":{"path":"libs_sv/nextbot.lua#L624","returns":[{"type":"boolean","value":"boolean Whether this bot is allowed to try to avoid obstacles.","description":"Whether this bot is allowed to try to avoid obstacles."}],"realm":"server","class":"function","name":"getAvoidAllowed","description":" Returns whether the Nextbot is allowed to avoid obstacles or not."},"isAreaTraversable":{"path":"libs_sv/nextbot.lua#L603","returns":[{"type":"boolean","value":"boolean Whether this nextbot can traverse given NavArea.","description":"Whether this nextbot can traverse given NavArea."}],"realm":"server","params":[{"type":"NavArea","value":"NavArea NavArea to check.","name":"NavArea","description":"to check."}],"class":"function","name":"isAreaTraversable","description":" Returns whether this nextbot can reach and/or traverse/move in given NavArea."},"getJumpGapsAllowed":{"path":"libs_sv/nextbot.lua#L660","returns":[{"type":"boolean","value":"boolean Whether this bot is allowed to jump gaps.","description":"Whether this bot is allowed to jump gaps."}],"realm":"server","class":"function","name":"getJumpGapsAllowed","description":" Returns whether the Nextbot is allowed to jump gaps or not."},"getGravity":{"path":"libs_sv/nextbot.lua#L533","returns":[{"type":"number","value":"number The nextbot's current gravity value.","description":"The nextbot's current gravity value."}],"realm":"server","class":"function","name":"getGravity","description":" Gets the gravity of the NextBot."},"getClimbAllowed":{"path":"libs_sv/nextbot.lua#L642","returns":[{"type":"boolean","value":"boolean Whether this bot is allowed to climb.","description":"Whether this bot is allowed to climb."}],"realm":"server","class":"function","name":"getClimbAllowed","description":" Returns whether the Nextbot is allowed to climb or not."},"setClimbAllowed":{"path":"libs_sv/nextbot.lua#L632","realm":"server","params":[{"type":"boolean","value":"boolean climballowed Whether this bot should be allowed to climb.","name":"climballowed","description":"Whether this bot should be allowed to climb."}],"class":"function","name":"setClimbAllowed","description":" Sets whether the Nextbot is allowed to climb or not. This is used during path generation. Works similarly to nb_allow_climbing convar. By default bots are allowed to climb."},"setAvoidAllowed":{"path":"libs_sv/nextbot.lua#L614","realm":"server","params":[{"type":"boolean","value":"boolean avoidallowed Whether this bot should be allowed to try to avoid obstacles.","name":"avoidallowed","description":"Whether this bot should be allowed to try to avoid obstacles."}],"class":"function","name":"setAvoidAllowed","description":" Sets whether the Nextbot is allowed try to to avoid obstacles or not. This is used during path generation. Works similarly to nb_allow_avoiding convar. By default bots are allowed to try to avoid obstacles."},"addLandCallback":{"path":"libs_sv/nextbot.lua#L340","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID this callback will use.","name":"callbackid","description":"The unique ID this callback will use."},{"type":"function","value":"function callback The function to run when the NB lands on the ground. The arguments are: (The entity the NB landed on.)","name":"callback","description":"The function to run when the NB lands on the ground. The arguments are: (The entity the NB landed on.)"}],"class":"function","name":"addLandCallback","description":" Adds a callback function that will be run when this nextbot lands on the ground."},"setJumpHeight":{"path":"libs_sv/nextbot.lua#L668","realm":"server","params":[{"type":"number","value":"number jumpheight Height (default is 58)","name":"jumpheight","description":"Height (default is 58)"}],"class":"function","name":"setJumpHeight","description":" Sets the height of the bot's jump"},"isOnGround":{"path":"libs_sv/nextbot.lua#L595","returns":[{"type":"boolean","value":"boolean Whether the nextbot is on ground or not.","description":"Whether the nextbot is on ground or not."}],"realm":"server","class":"function","name":"isOnGround","description":" Returns whether the nextbot this locomotion is attached to is on ground or not."},"addNavChangeCallback":{"path":"libs_sv/nextbot.lua#L406","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID this callback will use.","name":"callbackid","description":"The unique ID this callback will use."},{"type":"function","value":"function callback The function to run when the NB enters a new nav area. The arguments are: (Old Nav Area, New Nav Area)","name":"callback","description":"The function to run when the NB enters a new nav area. The arguments are: (Old Nav Area, New Nav Area)"}],"class":"function","name":"addNavChangeCallback","description":" Adds a callback function that will be run when the nextbot enters a new nav area."},"getGroundMotionVector":{"path":"libs_sv/nextbot.lua#L587","returns":[{"type":"Vector","value":"Vector A vector representing the X and Y movement.","description":"A vector representing the X and Y movement."}],"realm":"server","class":"function","name":"getGroundMotionVector","description":" Return unit vector in XY plane describing our direction of motion - even if we are currently not moving"},"getJumpHeight":{"path":"libs_sv/nextbot.lua#L678","returns":[{"type":"number","value":"number Jump height","description":"Jump height"}],"realm":"server","class":"function","name":"getJumpHeight","description":" Gets the height of the bot's jump"},"setDeathDropHeight":{"path":"libs_sv/nextbot.lua#L551","realm":"server","params":[{"type":"number","value":"number newdeathdropheight New height nextbot is afraid of. Default is 200.","name":"newdeathdropheight","description":"New height nextbot is afraid of. Default is 200."}],"class":"function","name":"setDeathDropHeight","description":" Sets the height the nextbot is scared to fall from."},"addIgniteCallback":{"path":"libs_sv/nextbot.lua#L384","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID this callback will use.","name":"callbackid","description":"The unique ID this callback will use."},{"type":"function","value":"function callback The function to run when the NB gets ignited.","name":"callback","description":"The function to run when the NB gets ignited."}],"class":"function","name":"addIgniteCallback","description":" Adds a callback function that will be run when this nextbot gets ignited."},"setMaxYawRate":{"path":"libs_sv/nextbot.lua#L523","realm":"server","params":[{"type":"number","value":"number newmaxyawrate Desired new maximum yaw rate","name":"newmaxyawrate","description":"Desired new maximum yaw rate"}],"class":"function","name":"setMaxYawRate","description":" Sets the max rate at which the NextBot can visually rotate. This will not affect moving or pathing."},"getDeceleration":{"path":"libs_sv/nextbot.lua#L507","returns":[{"type":"number","value":"number NB's deceleration value.","description":"NB's deceleration value."}],"realm":"server","class":"function","name":"getDeceleration","description":" Gets the deceleration speed of the NextBot."},"ragdollOnDeath":{"path":"libs_sv/nextbot.lua#L450","realm":"server","params":[{"type":"boolean","value":"boolean ragdollondeath Whether the nextbot should ragdoll on death.","name":"ragdollondeath","description":"Whether the nextbot should ragdoll on death."}],"class":"function","name":"ragdollOnDeath","description":" Enable or disable ragdolling on death for the NextBot."},"setDeceleration":{"path":"libs_sv/nextbot.lua#L497","realm":"server","params":[{"type":"number","value":"number newaccel NB's new deceleration. Default is 400","name":"newaccel","description":"NB's new deceleration. Default is 400"}],"class":"function","name":"setDeceleration","description":" Sets the deceleration speed of the NextBot."},"removeInjuredCallback":{"path":"libs_sv/nextbot.lua#L330","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID of the callback to remove.","name":"callbackid","description":"The unique ID of the callback to remove."}],"class":"function","name":"removeInjuredCallback","description":" Removes a injury callback function from the NextBot."},"getMoveSpeed":{"path":"libs_sv/nextbot.lua#L471","returns":[{"type":"number","value":"number NB's move speed.","description":"NB's move speed."}],"realm":"server","class":"function","name":"getMoveSpeed","description":" Gets the move speed of the NextBot."},"setMoveSpeed":{"path":"libs_sv/nextbot.lua#L460","realm":"server","params":[{"type":"number","value":"number newmovespeed NB's new move speed. Default is 200.","name":"newmovespeed","description":"NB's new move speed. Default is 200."}],"class":"function","name":"setMoveSpeed","description":" Sets the move speed of the NextBot."},"getAcceleration":{"path":"libs_sv/nextbot.lua#L489","returns":[{"type":"number","value":"number NB's acceleration value.","description":"NB's acceleration value."}],"realm":"server","class":"function","name":"getAcceleration","description":" Gets the acceleration speed of the NextBot."},"faceTowards":{"path":"libs_sv/nextbot.lua#L198","realm":"server","params":[{"type":"Vector","value":"Vector facepos Position to face towards.","name":"facepos","description":"Position to face towards."}],"class":"function","name":"faceTowards","description":" Makes the nextbot face towards a specified position. Has to be called continuously to be effective."},"removeIgniteCallback":{"path":"libs_sv/nextbot.lua#L396","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID of the callback to remove.","name":"callbackid","description":"The unique ID of the callback to remove."}],"class":"function","name":"removeIgniteCallback","description":" Removes a ignite callback function from the NextBot."},"jump":{"path":"libs_sv/nextbot.lua#L264","realm":"server","params":[{"type":"number?","value":"number? jumpAct The activity ID of the anim to play when jumping.","name":"jumpAct","description":"The activity ID of the anim to play when jumping."}],"class":"function","name":"jump","description":" Forces the nextbot to jump."},"setAcceleration":{"path":"libs_sv/nextbot.lua#L479","realm":"server","params":[{"type":"number","value":"number newaccel NB's new acceleration. Default is 400","name":"newaccel","description":"NB's new acceleration. Default is 400"}],"class":"function","name":"setAcceleration","description":" Sets the acceleration speed of the NextBot."},"setApproachPos":{"path":"libs_sv/nextbot.lua#L123","realm":"server","params":[{"type":"Vector","value":"Vector goal The vector we want to get to.","name":"goal","description":"The vector we want to get to."}],"class":"function","name":"setApproachPos","description":" Makes the nextbot try to go to a specified position without using navmesh pathfinding (in a straight line).\n setGotoPos takes priority."},"getApproachPos":{"path":"libs_sv/nextbot.lua#L140","returns":[{"type":"Vector?","value":"Vector? Where the nextbot is trying to go to if it exists, else returns nil.","description":"Where the nextbot is trying to go to if it exists, else returns nil."}],"realm":"server","class":"function","name":"getApproachPos","description":" Returns the Vector the nextbot is trying to go to, set by setApproachPos"},"addContactCallback":{"path":"libs_sv/nextbot.lua#L428","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID this callback will use.","name":"callbackid","description":"The unique ID this callback will use."},{"type":"function","value":"function callback The function to run when the NB touches another entity. The arguments are: (The entity the NB touched.)","name":"callback","description":"The function to run when the NB touches another entity. The arguments are: (The entity the NB touched.)"}],"class":"function","name":"addContactCallback","description":" Sets a callback function that will be run when this nextbot touches another entity. Only 1 per NB. Setting a new callback will replace the old one."},"removeContactCallback":{"path":"libs_sv/nextbot.lua#L440","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID of the callback to remove.","name":"callbackid","description":"The unique ID of the callback to remove."}],"class":"function","name":"removeContactCallback","description":" Removes the contact callback function from the NextBot if present."},"removeReachCallback":{"path":"libs_sv/nextbot.lua#L286","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID of the callback to remove.","name":"callbackid","description":"The unique ID of the callback to remove."}],"class":"function","name":"removeReachCallback","description":" Removes a reach callback function from the NextBot."},"startActivity":{"path":"libs_sv/nextbot.lua#L189","realm":"server","params":[{"type":"number","value":"number act The ACT enum to play.","name":"act","description":"The ACT enum to play."}],"class":"function","name":"startActivity","description":" Start doing an activity (animation)."},"removeLandCallback":{"path":"libs_sv/nextbot.lua#L352","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID of the callback to remove.","name":"callbackid","description":"The unique ID of the callback to remove."}],"class":"function","name":"removeLandCallback","description":" Removes a landing callback function from the NextBot."},"addReachCallback":{"path":"libs_sv/nextbot.lua#L274","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID this callback will use.","name":"callbackid","description":"The unique ID this callback will use."},{"type":"function","value":"function callback The function to run when the NB reaches its destination.","name":"callback","description":"The function to run when the NB reaches its destination."}],"class":"function","name":"addReachCallback","description":" Adds a callback function that will be run when this nextbot reaches a destination set by setApproachPos or setGotoPos."},"getStepHeight":{"path":"libs_sv/nextbot.lua#L579","returns":[{"type":"number","value":"number The max height the bot can step up.","description":"The max height the bot can step up."}],"realm":"server","class":"function","name":"getStepHeight","description":" Gets the max height the bot can step up."},"removeLeaveGroundCallback":{"path":"libs_sv/nextbot.lua#L374","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID of the callback to remove.","name":"callbackid","description":"The unique ID of the callback to remove."}],"class":"function","name":"removeLeaveGroundCallback","description":" Removes a landing callback function from the NextBot."},"getGotoPos":{"path":"libs_sv/nextbot.lua#L168","returns":[{"type":"Vector?","value":"Vector? Where the nextbot is trying to go to if it exists, else returns nil.","description":"Where the nextbot is trying to go to if it exists, else returns nil."}],"realm":"server","class":"function","name":"getGotoPos","description":" Returns the Vector the nextbot is trying to go to, set by setGotoPos"},"getIdleAct":{"path":"libs_sv/nextbot.lua#L239","returns":[{"type":"number","value":"number The idle activity.","description":"The idle activity."}],"realm":"server","class":"function","name":"getIdleAct","description":" Gets the activity the nextbot uses for idling."},"setIdleAct":{"path":"libs_sv/nextbot.lua#L227","realm":"server","params":[{"type":"number","value":"number runact The activity the nextbot will use.","name":"runact","description":"The activity the nextbot will use."}],"class":"function","name":"setIdleAct","description":" Sets the activity the nextbot uses for idling."}},"class":"type","name":"NextBot","description":" NextBot type"},"Vector2":{"path":"libs_sv/wire.lua#L30","libtbl":["vec2_meta"],"realm":"server","methods":[],"class":"type","name":"Vector2","description":" Vector2 type for wire xv2"},"Vehicle":{"path":"libs_sh/vehicles.lua#L15","libtbl":["vehicle_methods","vehicle_meta"],"realm":"shared","methods":{"getDriver":{"path":"libs_sh/vehicles.lua#L42","returns":[{"type":"Player","value":"Player Driver of vehicle","description":"Driver of vehicle"}],"realm":"shared","class":"function","name":"getDriver","description":" Returns the driver of the vehicle"},"getPassenger":{"path":"libs_sh/vehicles.lua#L48","returns":[{"type":"Player","value":"Player The passenger or NULL if empty","description":"The passenger or NULL if empty"}],"realm":"shared","params":[{"type":"number","value":"number n The index of the passenger to get","name":"n","description":"The index of the passenger to get"}],"class":"function","name":"getPassenger","description":" Returns a passenger of a vehicle"},"ejectDriver":{"path":"libs_sh/vehicles.lua#L57","realm":"server","class":"function","name":"ejectDriver","description":" Ejects the driver of the vehicle"},"unlock":{"path":"libs_sh/vehicles.lua#L105","realm":"server","class":"function","name":"unlock","description":" Will unlock the vehicle."},"lock":{"path":"libs_sh/vehicles.lua#L94","realm":"server","class":"function","name":"lock","description":" Will lock the vehicle preventing players from entering or exiting the vehicle."},"killDriver":{"path":"libs_sh/vehicles.lua#L66","realm":"server","class":"function","name":"killDriver","description":" Kills the driver of the vehicle"},"stripDriver":{"path":"libs_sh/vehicles.lua#L77","realm":"server","params":[{"type":"string?","value":"string? class Optional weapon class to strip. Otherwise all are stripped.","name":"class","description":"Optional weapon class to strip. Otherwise all are stripped."}],"class":"function","name":"stripDriver","description":" Strips weapons of the driver"}},"class":"type","name":"Vehicle","description":" Vehicle type"},"Player":{"path":"libs_sh/players.lua#L81","libtbl":["player_methods"],"realm":"shared","methods":{"getShootPos":{"path":"libs_sh/players.lua#L294","returns":[{"type":"Vector","value":"Vector Shoot position","description":"Shoot position"}],"realm":"shared","class":"function","name":"getShootPos","description":" Returns the player's shoot position"},"shouldDrawLocalPlayer":{"path":"libs_sh/players.lua#L1134","returns":[{"type":"boolean","value":"boolean True if the player's playermodel is visible","description":"True if the player's playermodel is visible"}],"realm":"client","class":"function","name":"shouldDrawLocalPlayer","description":" Returns whether the player's player model will be drawn at the time the function is called."},"getVehicle":{"path":"libs_sh/players.lua#L308","returns":[{"type":"Vehicle","value":"Vehicle Vehicle if player in vehicle or nil","description":"Vehicle if player in vehicle or nil"}],"realm":"shared","class":"function","name":"getVehicle","description":" Returns the vehicle the player is driving"},"getAnimationProgress":{"path":"libs_sh/players.lua#L1112","returns":[{"type":"number","value":"number Progress ranging 0-1","description":"Progress ranging 0-1"}],"realm":"client","class":"function","name":"getAnimationProgress","description":" Gets the progress of the animation ranging 0-1"},"isPlayingAnimation":{"path":"libs_sh/players.lua#L1104","returns":[{"type":"boolean","value":"boolean If an animation is playing","description":"If an animation is playing"}],"realm":"client","class":"function","name":"isPlayingAnimation","description":" Gets whether a animation is playing"},"setAnimationRange":{"path":"libs_sh/players.lua#L1085","realm":"client","params":[{"type":"number","value":"number min Min. Ranging from 0-1","name":"min","description":"Min. Ranging from 0-1"},{"type":"number","value":"number max Max. Ranging from 0-1","name":"max","description":"Max. Ranging from 0-1"}],"class":"function","name":"setAnimationRange","description":" Sets the animation range"},"setWalkSpeed":{"path":"libs_sh/players.lua#L771","realm":"server","params":[{"type":"number","value":"number newwalkspeed New Walk speed.","name":"newwalkspeed","description":"New Walk speed."}],"class":"function","name":"setWalkSpeed","description":" Sets Walk Speed"},"getGroundEntity":{"path":"libs_sh/players.lua#L470","returns":[{"type":"Entity","value":"Entity Ground entity","description":"Ground entity"}],"realm":"shared","class":"function","name":"getGroundEntity","description":" Returns the entity that the player is standing on"},"setAnimationBounce":{"path":"libs_sh/players.lua#L1055","realm":"client","params":[{"type":"boolean","value":"boolean bounce Should the animation bounce instead of loop?","name":"bounce","description":"Should the animation bounce instead of loop?"}],"class":"function","name":"setAnimationBounce","description":" Sets the animation bounce"},"getTeam":{"path":"libs_sh/players.lua#L387","returns":[{"type":"number","value":"number Team Index, from TEAM enums or custom teams","description":"Team Index, from TEAM enums or custom teams"}],"realm":"shared","class":"function","name":"getTeam","description":" Returns the player's current team"},"setAnimationAutoAdvance":{"path":"libs_sh/players.lua#L1040","realm":"client","params":[{"type":"boolean","value":"boolean auto_advance Should the animation handle advancing itself?","name":"auto_advance","description":"Should the animation handle advancing itself?"}],"class":"function","name":"setAnimationAutoAdvance","description":" Sets the animation auto advance"},"getSteamID":{"path":"libs_sh/players.lua#L365","returns":[{"type":"string","value":"string SteamID","description":"SteamID"}],"realm":"shared","class":"function","name":"getSteamID","description":" Returns the player's SteamID"},"isMuted":{"path":"libs_sh/players.lua#L842","returns":[{"type":"boolean","value":"boolean True if the player was muted","description":"True if the player was muted"}],"realm":"client","class":"function","name":"isMuted","description":" Returns whether the local player has muted the player"},"isCrouching":{"path":"libs_sh/players.lua#L224","returns":[{"type":"boolean","value":"boolean True if player crouching","description":"True if player crouching"}],"realm":"shared","class":"function","name":"isCrouching","description":" Returns whether the player is crouching"},"setLadderClimbSpeed":{"path":"libs_sh/players.lua#L731","realm":"server","params":[{"type":"number","value":"number newladderclimbspeed New Ladder Climb speed.","name":"newladderclimbspeed","description":"New Ladder Climb speed."}],"class":"function","name":"setLadderClimbSpeed","description":" Sets Ladder Climb Speed, probably unstable"},"getMoney":{"path":"libs_sh/darkrp2.lua#L1076","returns":[{"type":"number?","value":"number? The amount of money, or nil if not accessible.","description":"The amount of money, or nil if not accessible."}],"realm":"shared","class":"function","name":"getMoney","description":" Get the amount of money this player has. DarkRP only.\n Equivalent to \"ply:getDarkRPVar('money')\""},"stripWeapon":{"path":"libs_sh/players.lua#L570","realm":"server","params":[{"type":"string","value":"string weapon The weapon class name of the weapon to strip","name":"weapon","description":"The weapon class name of the weapon to strip"}],"class":"function","name":"stripWeapon","description":" Strips the player's weapon"},"playGesture":{"path":"libs_sh/players.lua#L863","realm":"client","params":[{"type":"string|number","value":"string|number animation Sequence string or act number. https://wiki.facepunch.com/gmod/Enums/ACT","name":"animation","description":"Sequence string or act number. https://wiki.facepunch.com/gmod/Enums/ACT"},{"type":"boolean?","value":"boolean? loop Optional boolean (Default true), should the gesture loop","name":"loop","description":"Optional boolean (Default true), should the gesture loop"},{"type":"number?","value":"number? slot Optional int (Default GESTURE_SLOT.CUSTOM), the gesture slot to use. GESTURE_SLOT table values","name":"slot","description":"Optional int (Default GESTURE_SLOT.CUSTOM), the gesture slot to use. GESTURE_SLOT table values"},{"type":"number?","value":"number? weight Optional float (Default 1), the weight of the gesture. Ranging from 0-1","name":"weight","description":"Optional float (Default 1), the weight of the gesture. Ranging from 0-1"}],"class":"function","name":"playGesture","description":" Plays gesture animations on a player"},"getWalkSpeed":{"path":"libs_sh/players.lua#L196","returns":[{"type":"number","value":"number Walk Speed value","description":"Walk Speed value"}],"realm":"shared","class":"function","name":"getWalkSpeed","description":" Returns the players Walk Speed"},"isHitman":{"path":"libs_sh/darkrp2.lua#L1052","returns":[{"type":"boolean?","value":"boolean? Whether this player is a hitman. May be nil instead of false.","description":"Whether this player is a hitman. May be nil instead of false."}],"realm":"shared","class":"function","name":"isHitman","description":" Whether this player is a hitman. DarkRP only."},"setAnimationTime":{"path":"libs_sh/players.lua#L1010","realm":"client","params":[{"type":"number","value":"number time The time of the animation in seconds. Float","name":"time","description":"The time of the animation in seconds. Float"}],"class":"function","name":"setAnimationTime","description":" Sets the animation time"},"getJobTable":{"path":"libs_sh/darkrp2.lua#L1003","returns":[{"type":"table","value":"table Table with the job information.","description":"Table with the job information."}],"realm":"shared","class":"function","name":"getJobTable","description":" Get the job table of a player. DarkRP only."},"getWeaponColor":{"path":"libs_sh/players.lua#L452","returns":[{"type":"Vector","value":"Vector The color","description":"The color"}],"realm":"shared","class":"function","name":"getWeaponColor","description":" Returns a player's weapon color\n The part of the model that is colored is determined by the model itself, and is different for each model\n The format is Vector(r,g,b), and each color should be between 0 and 1"},"getAnimationTime":{"path":"libs_sh/players.lua#L1123","returns":[{"type":"number","value":"number Time in seconds","description":"Time in seconds"}],"realm":"client","class":"function","name":"getAnimationTime","description":" Gets the animation time"},"getViewPunchAngles":{"path":"libs_sh/players.lua#L430","returns":[{"type":"Angle","value":"Angle The angle of the view offset","description":"The angle of the view offset"}],"realm":"shared","class":"function","name":"getViewPunchAngles","description":" Returns the camera punch offset angle"},"isHUDActive":{"path":"libs_sh/players.lua#L526","returns":[{"type":"boolean","value":"boolean True if a HUD component is connected and active for the player, nil otherwise","description":"True if a HUD component is connected and active for the player, nil otherwise"}],"realm":"server","class":"function","name":"isHUDActive","description":" Checks if the player is connected to a HUD component that's linked to this chip"},"setAnimationActivity":{"path":"libs_sh/players.lua#L976","realm":"client","params":[{"type":"number|string|nil","value":"number|string|nil activity Activity, nil to use the current animation sequence","name":"activity","description":"Activity, nil to use the current animation sequence"}],"class":"function","name":"setAnimationActivity","description":" Sets the animation activity"},"isWalking":{"path":"libs_sh/players.lua#L501","returns":[{"type":"boolean","value":"boolean Whether they are walking","description":"Whether they are walking"}],"realm":"shared","class":"function","name":"isWalking","description":" Returns whether the player is walking\n In singleplayer, this will return false clientside"},"isSuperAdmin":{"path":"libs_sh/players.lua#L336","returns":[{"type":"boolean","value":"boolean True if player is super admin","description":"True if player is super admin"}],"realm":"shared","class":"function","name":"isSuperAdmin","description":" Returns whether the player is a super admin"},"getPocketItems":{"path":"libs_sh/darkrp2.lua#L1009","returns":[{"type":"table","value":"table A table containing information about the items in the pocket.","description":"A table containing information about the items in the pocket."}],"realm":"shared","class":"function","name":"getPocketItems","description":" Get a player's pocket items. DarkRP only."},"getUserID":{"path":"libs_sh/players.lua#L401","returns":[{"type":"number","value":"number UserID","description":"UserID"}],"realm":"shared","class":"function","name":"getUserID","description":" Returns the player's UserID"},"setAnimation":{"path":"libs_sh/players.lua#L919","realm":"client","params":[{"type":"number|string","value":"number|string sequence Sequence number or string name","name":"sequence","description":"Sequence number or string name"},{"type":"number?","value":"number? progress Optional float (Default 0), the progress of the animation. Ranging from 0-1","name":"progress","description":"Optional float (Default 0), the progress of the animation. Ranging from 0-1"},{"type":"number?","value":"number? rate Optional float (Default 1), the playback rate of the animation","name":"rate","description":"Optional float (Default 1), the playback rate of the animation"},{"type":"boolean?","value":"boolean? loop Optional boolean (Default false), should the animation loop","name":"loop","description":"Optional boolean (Default false), should the animation loop"},{"type":"boolean?","value":"boolean? auto_advance Optional boolean (Default true), should the animation handle advancing itself","name":"auto_advance","description":"Optional boolean (Default true), should the animation handle advancing itself"},{"type":"number|string|nil","value":"number|string|nil act Optional number or string name (Default sequence value), the activity the player should use","name":"act","description":"Optional number or string name (Default sequence value), the activity the player should use"}],"class":"function","name":"setAnimation","description":" Plays an animation on the player"},"isConnected":{"path":"libs_sh/players.lua#L659","returns":[{"type":"boolean","value":"boolean True if player is connected","description":"True if player is connected"}],"realm":"server","class":"function","name":"isConnected","description":" Returns whether the player is connected"},"isUserGroup":{"path":"libs_sh/players.lua#L343","returns":[{"type":"boolean","value":"boolean True if player belongs to group","description":"True if player belongs to group"}],"realm":"shared","params":[{"type":"string","value":"string groupName Group to check against","name":"groupName","description":"Group to check against"}],"class":"function","name":"isUserGroup","description":" Returns whether the player belongs to a usergroup"},"getLadderClimbSpeed":{"path":"libs_sh/players.lua#L168","returns":[{"type":"number","value":"number Ladder Climb Speed value","description":"Ladder Climb Speed value"}],"realm":"shared","class":"function","name":"getLadderClimbSpeed","description":" Returns the players Ladder Climb Speed, probably unstable"},"isNoclipped":{"path":"libs_sh/players.lua#L245","returns":[{"type":"boolean","value":"boolean True if the player is noclipped","description":"True if the player is noclipped"}],"realm":"shared","class":"function","name":"isNoclipped","description":" Returns true if the player is noclipped"},"resetGesture":{"path":"libs_sh/players.lua#L893","realm":"client","params":[{"type":"number?","value":"number? slot Optional int (Default GESTURE_SLOT.CUSTOM), the gesture slot to use. GESTURE_SLOT table values","name":"slot","description":"Optional int (Default GESTURE_SLOT.CUSTOM), the gesture slot to use. GESTURE_SLOT table values"}],"class":"function","name":"resetGesture","description":" Resets gesture animations on a player"},"getDarkRPVar":{"path":"libs_sh/darkrp2.lua#L991","returns":[{"type":"any","value":"any The value of the DarkRP var.","description":"The value of the DarkRP var."}],"realm":"shared","params":[{"type":"string","value":"string var The name of the variable.","name":"var","description":"The name of the variable."}],"class":"function","name":"getDarkRPVar","description":" Get the value of a DarkRPVar, which is shared between server and client. Case-sensitive.\n Possible variables include (but are not limited to): AFK, AFKDemoted, money, salaryRL, rpname, job, HasGunlicense, Arrested, wanted, wantedReason, agenda, zombieToggle, hitTarget, hitPrice, lastHitTime, Energy\n For money specifically, you may optionally use Player:getMoney instead.\n Some variables may be blacklisted so that you can't read their value."},"setAnimationRate":{"path":"libs_sh/players.lua#L1025","realm":"client","params":[{"type":"number","value":"number rate The playback rate of the animation. Float","name":"rate","description":"The playback rate of the animation. Float"}],"class":"function","name":"setAnimationRate","description":" Sets the animation playback rate"},"getTeamName":{"path":"libs_sh/players.lua#L394","returns":[{"type":"string","value":"string Team Name","description":"Team Name"}],"realm":"shared","class":"function","name":"getTeamName","description":" Returns the name of the player's current team"},"voiceVolume":{"path":"libs_sh/players.lua#L856","returns":[{"type":"number","value":"number Returns the players voice volume, how loud the player's voice communication currently is, as a normal number. Doesn't work on local player unless the voice_loopback convar is set to 1.","description":"Returns the players voice volume, how loud the player's voice communication currently is, as a normal number. Doesn't work on local player unless the voice_loopback convar is set to 1."}],"realm":"client","class":"function","name":"voiceVolume","description":" Returns the voice volume of the player"},"isChief":{"path":"libs_sh/darkrp2.lua#L1034","returns":[{"type":"boolean?","value":"boolean? Whether this player is a Chief. May be nil instead of false.","description":"Whether this player is a Chief. May be nil instead of false."}],"realm":"shared","class":"function","name":"isChief","description":" Whether this player is a Chief. DarkRP only."},"isSpeaking":{"path":"libs_sh/players.lua#L849","returns":[{"type":"boolean","value":"boolean Whether they are speaking and able to be heard by LocalPlayer","description":"Whether they are speaking and able to be heard by LocalPlayer"}],"realm":"client","class":"function","name":"isSpeaking","description":" Returns whether the player is heard by the local player."},"getEyeTrace":{"path":"libs_sh/players.lua#L408","returns":[{"type":"table","value":"table Trace data https://wiki.facepunch.com/gmod/Structures/TraceResult","description":"Trace data https://wiki.facepunch.com/gmod/Structures/TraceResult"}],"realm":"shared","class":"function","name":"getEyeTrace","description":" Returns a table with information of what the player is looking at"},"isMedic":{"path":"libs_sh/darkrp2.lua#L1064","returns":[{"type":"boolean?","value":"boolean? Whether this player is a medic. May be nil instead of false.","description":"Whether this player is a medic. May be nil instead of false."}],"realm":"shared","class":"function","name":"isMedic","description":" Whether this player is a medic. DarkRP only."},"requestMoney":{"path":"libs_sh/darkrp2.lua#L929","realm":"server","params":[{"type":"string?","value":"string? message An optional custom message that will be shown in the money request prompt. May not exceed 60 bytes in length.","name":"message","description":"An optional custom message that will be shown in the money request prompt. May not exceed 60 bytes in length."},{"type":"number","value":"number amount The amount of money to ask for.","name":"amount","description":"The amount of money to ask for."},{"type":"function?","value":"function? callbackSuccess Optional function to call if request succeeds.","name":"callbackSuccess","description":"Optional function to call if request succeeds."},{"type":"function?","value":"function? callbackFailure Optional function to call if request fails.","name":"callbackFailure","description":"Optional function to call if request fails."},{"type":"Player?","value":"Player? receiver The player who may or may not receive the money, or the owner of the chip if not specified. Superuser only.","name":"receiver","description":"The player who may or may not receive the money, or the owner of the chip if not specified. Superuser only."}],"class":"function","name":"requestMoney","description":" Request money from a player.\n This is subject to a burst limit. Use the darkrp.canMakeMoneyRequest function to check if you can request money that tick."},"setAnimationProgress":{"path":"libs_sh/players.lua#L995","realm":"client","params":[{"type":"number","value":"number progress The progress of the animation. Ranging from 0-1","name":"progress","description":"The progress of the animation. Ranging from 0-1"}],"class":"function","name":"setAnimationProgress","description":" Sets the animation progress"},"getMaxArmor":{"path":"libs_sh/players.lua#L140","returns":[{"type":"number","value":"number Armor limit","description":"Armor limit"}],"realm":"shared","class":"function","name":"getMaxArmor","description":" Returns the players maximum armor capacity"},"getViewModel":{"path":"libs_sh/players.lua#L422","returns":[{"type":"Entity","value":"Entity Player's view model","description":"Player's view model"}],"realm":"shared","class":"function","name":"getViewModel","description":" Returns the player's view model\n In the Client realm, other players' viewmodels are not available unless they are being spectated"},"isFrozen":{"path":"libs_sh/players.lua#L329","returns":[{"type":"boolean","value":"boolean True if player is frozen","description":"True if player is frozen"}],"realm":"shared","class":"function","name":"isFrozen","description":" Returns whether the player is frozen"},"keyDown":{"path":"libs_sh/players.lua#L823","returns":[{"type":"boolean","value":"boolean Whether they key is down","description":"Whether they key is down"}],"realm":"shared","params":[{"type":"number","value":"number key Key to check. IN_KEY table values","name":"key","description":"Key to check. IN_KEY table values"}],"class":"function","name":"keyDown","description":" Returns whether or not the player is pushing the key."},"setMaxSpeed":{"path":"libs_sh/players.lua#L741","realm":"server","params":[{"type":"number","value":"number newmaxspeed New Max speed.","name":"newmaxspeed","description":"New Max speed."}],"class":"function","name":"setMaxSpeed","description":" Sets Max Speed"},"teamBanTimeLeft":{"path":"libs_sh/darkrp2.lua#L916","returns":[{"type":"number?","value":"number? The time left on the team ban in seconds, or nil if not banned.","description":"The time left on the team ban in seconds, or nil if not banned."}],"realm":"server","params":[{"type":"number?","value":"number? team The number of the job (e.g. TEAM_MEDIC). Uses the player's team if nil.","name":"team","description":"The number of the job (e.g. TEAM_MEDIC). Uses the player's team if nil."}],"class":"function","name":"teamBanTimeLeft","description":" Returns the time left on a player's team ban. DarkRP only.\n Only works if the player is the owner of the chip, or if the chip is running in superuser mode."},"kill":{"path":"libs_sh/players.lua#L811","realm":"server","class":"function","name":"kill","description":" Kills the target.\n Requires 'entities.setHealth' permission."},"getPacketLoss":{"path":"libs_sh/players.lua#L631","returns":[{"type":"number","value":"number Packets lost","description":"Packets lost"}],"realm":"server","class":"function","name":"getPacketLoss","description":" Returns the packet loss of the client"},"getMaxSpeed":{"path":"libs_sh/players.lua#L175","returns":[{"type":"number","value":"number Max Speed value","description":"Max Speed value"}],"realm":"shared","class":"function","name":"getMaxSpeed","description":" Returns the players Max Speed, probably unstable"},"setStepSize":{"path":"libs_sh/players.lua#L791","realm":"server","params":[{"type":"number","value":"number newstepsize New Step Size.","name":"newstepsize","description":"New Step Size."}],"class":"function","name":"setStepSize","description":" Sets Step Size"},"setJumpPower":{"path":"libs_sh/players.lua#L781","realm":"server","params":[{"type":"number","value":"number newjumppower New Jump Power.","name":"newjumppower","description":"New Jump Power."}],"class":"function","name":"setJumpPower","description":" Sets Jump Power"},"getTimeoutSeconds":{"path":"libs_sh/players.lua#L645","returns":[{"type":"number","value":"number Timeout seconds","description":"Timeout seconds"}],"realm":"server","class":"function","name":"getTimeoutSeconds","description":" Returns the number of seconds that the player has been timing out for"},"resetAnimation":{"path":"libs_sh/players.lua#L967","realm":"client","class":"function","name":"resetAnimation","description":" Resets the animation"},"getPing":{"path":"libs_sh/players.lua#L358","returns":[{"type":"number","value":"number The player's ping","description":"The player's ping"}],"realm":"shared","class":"function","name":"getPing","description":" Returns the player's current ping"},"setUnDuckSpeed":{"path":"libs_sh/players.lua#L721","realm":"server","params":[{"type":"number","value":"number newunduckspeed New UnDuck speed, This is a multiplier from 0 to 1.","name":"newunduckspeed","description":"New UnDuck speed, This is a multiplier from 0 to 1."}],"class":"function","name":"setUnDuckSpeed","description":" Sets UnDuck Speed"},"setDuckSpeed":{"path":"libs_sh/players.lua#L711","realm":"server","params":[{"type":"number","value":"number newduckspeed New Duck speed, This is a multiplier from 0 to 1.","name":"newduckspeed","description":"New Duck speed, This is a multiplier from 0 to 1."}],"class":"function","name":"setDuckSpeed","description":" Sets Duck Speed"},"isCP":{"path":"libs_sh/darkrp2.lua#L1046","returns":[{"type":"boolean","value":"boolean Whether this player is a part of the police force.","description":"Whether this player is a part of the police force."}],"realm":"shared","class":"function","name":"isCP","description":" Whether this player is part of the police force (Mayor, CP, Chief). DarkRP only."},"stripWeapons":{"path":"libs_sh/players.lua#L580","realm":"server","class":"function","name":"stripWeapons","description":" Strips all the player's weapons"},"setMaxArmor":{"path":"libs_sh/players.lua#L691","realm":"server","params":[{"type":"number","value":"number newmaxarmor New max armor value.","name":"newmaxarmor","description":"New max armor value."}],"class":"function","name":"setMaxArmor","description":" Sets the maximum armor for player. You can still set a player's armor above this amount with Player:setArmor."},"getJumpPower":{"path":"libs_sh/players.lua#L203","returns":[{"type":"number","value":"number Jump Power value","description":"Jump Power value"}],"realm":"shared","class":"function","name":"getJumpPower","description":" Returns the players Jump Power"},"dropWeapon":{"path":"libs_sh/players.lua#L550","realm":"server","params":[{"type":"Weapon|string","value":"Weapon|string weapon The weapon instance or class name of the weapon to drop","name":"weapon","description":"The weapon instance or class name of the weapon to drop"},{"type":"Vector?","value":"Vector? target If set, launches the weapon at the given position","name":"target","description":"If set, launches the weapon at the given position"},{"type":"Vector?","value":"Vector? velocity If set and target is unset, launches the weapon with the given velocity","name":"velocity","description":"If set and target is unset, launches the weapon with the given velocity"}],"class":"function","name":"dropWeapon","description":" Drops the player's weapon"},"setRunSpeed":{"path":"libs_sh/players.lua#L751","realm":"server","params":[{"type":"number","value":"number newrunspeed New Run speed.","name":"newrunspeed","description":"New Run speed."}],"class":"function","name":"setRunSpeed","description":" Sets Run Speed ( +speed )"},"isFlashlightOn":{"path":"libs_sh/players.lua#L238","returns":[{"type":"boolean","value":"boolean True if player has flashlight on","description":"True if player has flashlight on"}],"realm":"shared","class":"function","name":"isFlashlightOn","description":" Returns whether the player's flashlight is on"},"say":{"path":"libs_sh/players.lua#L666","realm":"server","params":[{"type":"string","value":"string text The text to force the player to say","name":"text","description":"The text to force the player to say"},{"type":"boolean?","value":"boolean? teamOnly Team chat only?, Defaults to false.","name":"teamOnly","description":"Team chat only?, Defaults to false."}],"class":"function","name":"say","description":" Forces the player to say the first argument\n Only works on the chip's owner."},"isInRoom":{"path":"libs_sh/darkrp2.lua#L959","returns":[{"type":"boolean","value":"boolean Whether this player is in the same room.","description":"Whether this player is in the same room."}],"realm":"client","class":"function","name":"isInRoom","description":" Whether this player is in the same room as the LocalPlayer. DarkRP only."},"isTyping":{"path":"libs_sh/players.lua#L487","returns":[{"type":"boolean","value":"boolean Whether they are typing in the chat","description":"Whether they are typing in the chat"}],"realm":"shared","class":"function","name":"isTyping","description":" Returns whether the player is typing in their chat"},"setAmmo":{"path":"libs_sh/players.lua#L588","realm":"server","params":[{"type":"number","value":"number amount The ammo value","name":"amount","description":"The ammo value"},{"type":"number|string","value":"number|string ammoType Ammo type id or name","name":"ammoType","description":"Ammo type id or name"}],"class":"function","name":"setAmmo","description":" Sets the player's ammo"},"isTimingOut":{"path":"libs_sh/players.lua#L652","returns":[{"type":"boolean","value":"boolean isTimingOut","description":"isTimingOut"}],"realm":"server","class":"function","name":"isTimingOut","description":" Returns true if the player is timing out"},"getFrags":{"path":"libs_sh/players.lua#L252","returns":[{"type":"number","value":"number Amount of kills","description":"Amount of kills"}],"realm":"shared","class":"function","name":"getFrags","description":" Returns the amount of kills of the player"},"setSlowWalkSpeed":{"path":"libs_sh/players.lua#L761","realm":"server","params":[{"type":"number","value":"number newslowwalkspeed New Slow Walk speed.","name":"newslowwalkspeed","description":"New Slow Walk speed."}],"class":"function","name":"setSlowWalkSpeed","description":" Sets Slow Walk Speed ( +walk )"},"keysUnOwnAll":{"path":"libs_sh/darkrp2.lua#L907","realm":"server","class":"function","name":"keysUnOwnAll","description":" Unown every door and vehicle owned by this player. DarkRP only."},"getSlowWalkSpeed":{"path":"libs_sh/players.lua#L189","returns":[{"type":"number","value":"number Slow Walk Speed value","description":"Slow Walk Speed value"}],"realm":"shared","class":"function","name":"getSlowWalkSpeed","description":" Returns the players Slow Walk Speed, which is +walk"},"getWeapons":{"path":"libs_sh/players.lua#L436","returns":[{"type":"table","value":"table Table of weapons","description":"Table of weapons"}],"realm":"shared","class":"function","name":"getWeapons","description":" Returns a table of weapons the player is carrying"},"getAmmoCount":{"path":"libs_sh/players.lua#L477","returns":[{"type":"number","value":"number The amount of ammo player has in reserve.","description":"The amount of ammo player has in reserve."}],"realm":"shared","params":[{"type":"string|number","value":"string|number idOrName The string ammo name or number id of the ammo","name":"idOrName","description":"The string ammo name or number id of the ammo"}],"class":"function","name":"getAmmoCount","description":" Gets the amount of ammo the player has."},"getWeapon":{"path":"libs_sh/players.lua#L443","returns":[{"type":"Weapon","value":"Weapon Weapon","description":"Weapon"}],"realm":"shared","params":[{"type":"string","value":"string wep Weapon class name","name":"wep","description":"Weapon class name"}],"class":"function","name":"getWeapon","description":" Returns the specified weapon or nil if the player doesn't have it"},"setFriction":{"path":"libs_sh/players.lua#L801","realm":"server","params":[{"type":"number","value":"number newfriction New Friction.","name":"newfriction","description":"New Friction."}],"class":"function","name":"setFriction","description":" Sets Friction"},"setEyeAngles":{"path":"libs_sh/players.lua#L619","realm":"server","params":[{"type":"Angle","value":"Angle ang New angles","name":"ang","description":"New angles"}],"class":"function","name":"setEyeAngles","description":" Sets a player's eye angles"},"getUserGroup":{"path":"libs_sh/players.lua#L351","returns":[{"type":"string","value":"string Usergroup, \"user\" if player has no group","description":"Usergroup, \"user\" if player has no group"}],"realm":"shared","class":"function","name":"getUserGroup","description":" Returns the usergroup of the player"},"isAdmin":{"path":"libs_sh/players.lua#L315","returns":[{"type":"boolean","value":"boolean True if player is admin","description":"True if player is admin"}],"realm":"shared","class":"function","name":"isAdmin","description":" Returns whether the player is an admin"},"getName":{"path":"libs_sh/players.lua#L280","returns":[{"type":"string","value":"string Name","description":"Name"}],"realm":"shared","class":"function","name":"getName","description":" Returns the player's name"},"isWanted":{"path":"libs_sh/darkrp2.lua#L1070","returns":[{"type":"boolean?","value":"boolean? Whether this player is wanted. May be nil instead of false.","description":"Whether this player is wanted. May be nil instead of false."}],"realm":"shared","class":"function","name":"isWanted","description":" Whether this player is wanted. DarkRP only. Use Player:getWantedReason if you want to know the reason."},"stripAmmo":{"path":"libs_sh/players.lua#L604","realm":"server","class":"function","name":"stripAmmo","description":" Removes all a player's ammo"},"hasGodMode":{"path":"libs_sh/players.lua#L543","returns":[{"type":"boolean","value":"boolean True if the player has godmode","description":"True if the player has godmode"}],"realm":"server","class":"function","name":"hasGodMode","description":" Returns whether or not the player has godmode"},"setViewEntity":{"path":"libs_sh/players.lua#L533","realm":"server","params":[{"type":"Entity","value":"Entity ent Entity to set the player's view entity to, or nothing to reset it","name":"ent","description":"Entity to set the player's view entity to, or nothing to reset it"}],"class":"function","name":"setViewEntity","description":" Sets the view entity of the player. Only works if they are linked to a hud."},"canAfford":{"path":"libs_sh/darkrp2.lua#L969","returns":[{"type":"boolean","value":"boolean Whether the player can afford it","description":"Whether the player can afford it"}],"realm":"shared","params":[{"type":"number","value":"number amount The amount of money","name":"amount","description":"The amount of money"}],"class":"function","name":"canAfford","description":" Get whether the player can afford the given amount of money. DarkRP only."},"getUnDuckSpeed":{"path":"libs_sh/players.lua#L161","returns":[{"type":"number","value":"number UnDuck Speed value","description":"UnDuck Speed value"}],"realm":"shared","class":"function","name":"getUnDuckSpeed","description":" Returns the players UnDuck Speed, a rate from 0-1 for how quickly they can uncrouch"},"getDeathRagdoll":{"path":"libs_sh/players.lua#L509","returns":[{"type":"Entity?","value":"Entity? The entity or nil if it doesn't exist","description":"The entity or nil if it doesn't exist"}],"realm":"shared","class":"function","name":"getDeathRagdoll","description":" Gets the player's death ragdoll"},"isSprinting":{"path":"libs_sh/players.lua#L494","returns":[{"type":"boolean","value":"boolean Whether they are sprinting","description":"Whether they are sprinting"}],"realm":"shared","class":"function","name":"isSprinting","description":" Returns whether the player is sprinting"},"canKeysLock":{"path":"libs_sh/darkrp2.lua#L977","returns":[{"type":"boolean?","value":"boolean? Whether the player is allowed to lock the door. May be nil instead of false.","description":"Whether the player is allowed to lock the door. May be nil instead of false."}],"realm":"shared","params":[{"type":"Entity","value":"Entity door The door","name":"door","description":"The door"}],"class":"function","name":"canKeysLock","description":" Get whether the player can lock a given door. DarkRP only."},"getRunSpeed":{"path":"libs_sh/players.lua#L182","returns":[{"type":"number","value":"number Run Speed value","description":"Run Speed value"}],"realm":"shared","class":"function","name":"getRunSpeed","description":" Returns the players Run Speed, which is +speed"},"getViewEntity":{"path":"libs_sh/players.lua#L415","returns":[{"type":"Entity","value":"Entity Player's current view entity","description":"Player's current view entity"}],"realm":"shared","class":"function","name":"getViewEntity","description":" Returns the player's current view entity"},"giveMoney":{"path":"libs_sh/darkrp2.lua#L942","realm":"server","params":[{"type":"number","value":"number amount The amount of money to give.","name":"amount","description":"The amount of money to give."}],"class":"function","name":"giveMoney","description":" Give this player money.\n This is subject to a burst limit. Use the darkrp.canGiveMoney function to check if you can request money that tick."},"setAnimationLoop":{"path":"libs_sh/players.lua#L1070","realm":"client","params":[{"type":"boolean","value":"boolean loop Should the animation loop?","name":"loop","description":"Should the animation loop?"}],"class":"function","name":"setAnimationLoop","description":" Sets the animation loop"},"setArmor":{"path":"libs_sh/players.lua#L681","realm":"server","params":[{"type":"number","value":"number newarmor New armor value.","name":"newarmor","description":"New armor value."}],"class":"function","name":"setArmor","description":" Sets the armor of the player."},"getSteamID64":{"path":"libs_sh/players.lua#L372","returns":[{"type":"string","value":"string SteamID64 aka Community ID","description":"SteamID64 aka Community ID"}],"realm":"shared","params":[{"type":"boolean?","value":"boolean? owner Return the actual game owner account id","name":"owner","description":"Return the actual game owner account id"}],"class":"function","name":"getSteamID64","description":" Returns the player's SteamID64 / Community ID\n In singleplayer, this will return no value serverside.\n For bots, this will return 90071996842377216 (equivalent to STEAM_0:0:0) for the first bot to join, and adds 1 to the id for the bot id.\n Returns no value for bots clientside."},"getFriendStatus":{"path":"libs_sh/players.lua#L834","returns":[{"type":"string","value":"string One of: \"friend\", \"blocked\", \"none\", \"requested\"","description":"One of: \"friend\", \"blocked\", \"none\", \"requested\""}],"realm":"client","class":"function","name":"getFriendStatus","description":" Returns the relationship of the player to the local client"},"lastHitGroup":{"path":"libs_sh/players.lua#L612","returns":[{"type":"number","value":"number Hitgroup, see https://wiki.facepunch.com/gmod/Enums/HITGROUP","description":"Hitgroup, see https://wiki.facepunch.com/gmod/Enums/HITGROUP"}],"realm":"server","class":"function","name":"lastHitGroup","description":" Returns the hitgroup where the player was last hit."},"isArrested":{"path":"libs_sh/darkrp2.lua#L1028","returns":[{"type":"boolean?","value":"boolean? Whether this player is arrested. May be nil instead of false.","description":"Whether this player is arrested. May be nil instead of false."}],"realm":"shared","class":"function","name":"isArrested","description":" Whether this player is arrested. DarkRP only."},"inVehicle":{"path":"libs_sh/players.lua#L301","returns":[{"type":"boolean","value":"boolean True if player in vehicle","description":"True if player in vehicle"}],"realm":"shared","class":"function","name":"inVehicle","description":" Returns whether the player is in a vehicle"},"getCrouchedWalkSpeed":{"path":"libs_sh/players.lua#L147","returns":[{"type":"number","value":"number Crouch Walk Speed value","description":"Crouch Walk Speed value"}],"realm":"shared","class":"function","name":"getCrouchedWalkSpeed","description":" Returns the players Crouched Walk Speed"},"isAlive":{"path":"libs_sh/players.lua#L126","returns":[{"type":"boolean","value":"boolean True if player alive","description":"True if player alive"}],"realm":"shared","class":"function","name":"isAlive","description":" Returns whether the player is alive"},"hasDarkRPPrivilege":{"path":"libs_sh/darkrp2.lua#L1021","returns":[{"type":"boolean","value":"boolean Whether the player has the privilege.","description":"Whether the player has the privilege."}],"realm":"shared","class":"function","name":"hasDarkRPPrivilege","description":" Whether the player has a certain DarkRP privilege."},"setModelScale":{"path":"libs_sh/players.lua#L516","realm":"server","params":[{"type":"number","value":"number scale The scale to apply, will be truncated to the first two decimal places (min 0.01, max 100)","name":"scale","description":"The scale to apply, will be truncated to the first two decimal places (min 0.01, max 100)"}],"class":"function","name":"setModelScale","description":" Lets you change the size of yourself if the server has sf_permissions_entity_owneraccess 1"},"getWantedReason":{"path":"libs_sh/darkrp2.lua#L1015","returns":[{"type":"string?","value":"string? The reason, or nil if not wanted","description":"The reason, or nil if not wanted"}],"realm":"shared","class":"function","name":"getWantedReason","description":" Get the reason why someone is wanted. DarkRP only."},"isBot":{"path":"libs_sh/players.lua#L322","returns":[{"type":"boolean","value":"boolean True if player is a bot","description":"True if player is a bot"}],"realm":"shared","class":"function","name":"isBot","description":" Returns whether the player is a bot"},"getDeaths":{"path":"libs_sh/players.lua#L231","returns":[{"type":"number","value":"number Amount of deaths","description":"Amount of deaths"}],"realm":"shared","class":"function","name":"getDeaths","description":" Returns the amount of deaths of the player"},"getDuckSpeed":{"path":"libs_sh/players.lua#L154","returns":[{"type":"number","value":"number Duck Speed value","description":"Duck Speed value"}],"realm":"shared","class":"function","name":"getDuckSpeed","description":" Returns the players Duck Speed, a rate from 0-1 for how quickly they can crouch"},"getTimeConnected":{"path":"libs_sh/players.lua#L638","returns":[{"type":"number","value":"number Time connected","description":"Time connected"}],"realm":"server","class":"function","name":"getTimeConnected","description":" Returns the time in seconds since the player connected"},"getEntityInUse":{"path":"libs_sh/players.lua#L287","returns":[{"type":"Entity","value":"Entity Entity","description":"Entity"}],"realm":"shared","class":"function","name":"getEntityInUse","description":" Returns the entity the player is currently using, like func_tank mounted turrets or +use prop pickups."},"isMayor":{"path":"libs_sh/darkrp2.lua#L1058","returns":[{"type":"boolean?","value":"boolean? Whether this player is the Mayor. May be nil instead of false.","description":"Whether this player is the Mayor. May be nil instead of false."}],"realm":"shared","class":"function","name":"isMayor","description":" Whether this player is the Mayor. DarkRP only."},"getPlayerColor":{"path":"libs_sh/players.lua#L461","returns":[{"type":"Vector","value":"Vector The color","description":"The color"}],"realm":"shared","class":"function","name":"getPlayerColor","description":" Returns a player's color\n The part of the model that is colored is determined by the model itself, and is different for each model\n The format is Vector(r,g,b), and each color should be between 0 and 1"},"getFriction":{"path":"libs_sh/players.lua#L210","returns":[{"type":"number","value":"number Friction value","description":"Friction value"}],"realm":"shared","class":"function","name":"getFriction","description":" Returns the players Friction"},"getStepSize":{"path":"libs_sh/players.lua#L217","returns":[{"type":"number","value":"number Step Size Value","description":"Step Size Value"}],"realm":"shared","class":"function","name":"getStepSize","description":" Returns the players Step Size"},"getArmor":{"path":"libs_sh/players.lua#L133","returns":[{"type":"number","value":"number Armor","description":"Armor"}],"realm":"shared","class":"function","name":"getArmor","description":" Returns the players armor"},"getAimVector":{"path":"libs_sh/players.lua#L266","returns":[{"type":"Vector","value":"Vector Aim vector","description":"Aim vector"}],"realm":"shared","class":"function","name":"getAimVector","description":" Returns the player's aim vector"},"getFOV":{"path":"libs_sh/players.lua#L273","returns":[{"type":"number","value":"number Field of view as a float","description":"Field of view as a float"}],"realm":"shared","class":"function","name":"getFOV","description":" Returns the player's field of view"},"canKeysUnlock":{"path":"libs_sh/darkrp2.lua#L984","returns":[{"type":"boolean?","value":"boolean? Whether the player is allowed to unlock the door. May be nil instead of false.","description":"Whether the player is allowed to unlock the door. May be nil instead of false."}],"realm":"shared","params":[{"type":"Entity","value":"Entity door The door","name":"door","description":"The door"}],"class":"function","name":"canKeysUnlock","description":" Get whether the player can unlock a given door. DarkRP only."},"setCrouchedWalkSpeed":{"path":"libs_sh/players.lua#L701","realm":"server","params":[{"type":"number","value":"number newcwalkspeed New Crouch Walk speed, This is a multiplier from 0 to 1.","name":"newcwalkspeed","description":"New Crouch Walk speed, This is a multiplier from 0 to 1."}],"class":"function","name":"setCrouchedWalkSpeed","description":" Sets Crouched Walk Speed"},"isCook":{"path":"libs_sh/darkrp2.lua#L1040","returns":[{"type":"boolean?","value":"boolean? Whether this player is a cook. May be nil instead of false.","description":"Whether this player is a cook. May be nil instead of false."}],"realm":"shared","class":"function","name":"isCook","description":" Whether this player is a cook. DarkRP only. Only works if hungermod is enabled."},"getActiveWeapon":{"path":"libs_sh/players.lua#L259","returns":[{"type":"Weapon","value":"Weapon The weapon","description":"The weapon"}],"realm":"shared","class":"function","name":"getActiveWeapon","description":" Returns the name of the player's active weapon"},"setGestureWeight":{"path":"libs_sh/players.lua#L905","realm":"client","params":[{"type":"number?","value":"number? slot Optional int (Default GESTURE_SLOT.CUSTOM), the gesture slot to use. GESTURE_SLOT table values","name":"slot","description":"Optional int (Default GESTURE_SLOT.CUSTOM), the gesture slot to use. GESTURE_SLOT table values"},{"type":"number?","value":"number? weight Optional float (Default 1), the weight of the gesture. Ranging from 0-1","name":"weight","description":"Optional float (Default 1), the weight of the gesture. Ranging from 0-1"}],"class":"function","name":"setGestureWeight","description":" Sets the weight of the gesture animation in the given gesture slot"}},"class":"type","name":"Player","description":" Player type"},"Vector":{"path":"libs_sh/vectors.lua#L6","methods":{"isEqualTol":{"path":"libs_sh/vectors.lua#L251","returns":[{"type":"boolean","value":"boolean Whether the vector is equal to v within the tolerance.","description":"Whether the vector is equal to v within the tolerance."}],"realm":"shared","params":[{"type":"Vector","value":"Vector v Second Vector","name":"v","description":"Second Vector"},{"type":"number","value":"number t Tolerance number.","name":"t","description":"Tolerance number."}],"class":"function","name":"isEqualTol","description":" Is this vector and v equal within tolerance t."},"getQuaternion":{"path":"libs_sh/quaternion.lua#L781","returns":[{"type":"Quaternion","value":"Quaternion Quaternion from the given vector","description":"Quaternion from the given vector"}],"realm":"shared","params":[{"type":"Vector","value":"Vector up Upward direction. If specified, the original vector will act like a forward pointing one","name":"up","description":"Upward direction. If specified, the original vector will act like a forward pointing one"}],"class":"function","name":"getQuaternion","description":" Converts vector to quaternion"},"getLength2D":{"path":"libs_sh/vectors.lua#L279","returns":[{"type":"number","value":"number Vector length","description":"Vector length"}],"realm":"shared","class":"function","name":"getLength2D","description":" Returns the length of the vector in two dimensions, without the Z axis."},"__mul":{"path":"libs_sh/vectors.lua#L122","returns":[{"type":"Vector","value":"Vector Multiplied vector.","description":"Multiplied vector."}],"realm":"shared","params":[{"type":"number|Vector","value":"number|Vector a Number or Vector multiplicand.","name":"a","description":"Number or Vector multiplicand."},{"type":"number|Vector","value":"number|Vector b Number or Vector multiplier.","name":"b","description":"Number or Vector multiplier."}],"class":"function","name":"__mul","description":" Multiplication metamethod"},"round":{"path":"libs_sh/vectors.lua#L455","realm":"shared","params":[{"type":"number","value":"number idp (Default 0) The integer decimal place to round to.","name":"idp","description":"(Default 0) The integer decimal place to round to."}],"class":"function","name":"round","description":" Round the vector values.\n Self-Modifies. Does not return anything"},"getQuaternionFromRotation":{"path":"libs_sh/quaternion.lua#L819","returns":[{"type":"Quaternion","value":"Quaternion Rotated quaternion","description":"Rotated quaternion"}],"realm":"shared","class":"function","name":"getQuaternionFromRotation","description":" Constructs a quaternion from the rotation vector. Vector direction is axis of rotation, it's magnitude is angle in degrees"},"withinAABox":{"path":"libs_sh/vectors.lua#L485","returns":[{"type":"boolean","value":"boolean True/False.","description":"True/False."}],"realm":"shared","params":[{"type":"Vector","value":"Vector v1 Vector used to define AABox","name":"v1","description":"Vector used to define AABox"},{"type":"Vector","value":"Vector v2 Second Vector to define AABox","name":"v2","description":"Second Vector to define AABox"}],"class":"function","name":"withinAABox","description":" Returns whenever the given vector is in a box created by the 2 other vectors."},"__sub":{"path":"libs_sh/vectors.lua#L170","returns":[{"type":"Vector","value":"Vector Resultant vector after subtraction operation.","description":"Resultant vector after subtraction operation."}],"realm":"shared","params":[{"type":"Vector","value":"Vector v1 Initial Vector","name":"v1","description":"Initial Vector"},{"type":"Vector","value":"Vector v2 Vector to subtract","name":"v2","description":"Vector to subtract"}],"class":"function","name":"__sub","description":" Subtraction metamethod"},"__unm":{"path":"libs_sh/vectors.lua#L178","returns":[{"type":"Vector","value":"Vector Negative vector.","description":"Negative vector."}],"realm":"shared","class":"function","name":"__unm","description":" Unary Minus metamethod (Negative)"},"getLength":{"path":"libs_sh/vectors.lua#L267","returns":[{"type":"number","value":"number Length of the vector.","description":"Length of the vector."}],"realm":"shared","class":"function","name":"getLength","description":" Get the vector's Length."},"getLengthSqr":{"path":"libs_sh/vectors.lua#L273","returns":[{"type":"number","value":"number length squared.","description":"length squared."}],"realm":"shared","class":"function","name":"getLengthSqr","description":" Get the vector's length squared ( Saves computation by skipping the square root )."},"vdiv":{"path":"libs_sh/vectors.lua#L340","realm":"shared","params":[{"type":"Vector","value":"Vector v Vector to divide by","name":"v","description":"Vector to divide by"}],"class":"function","name":"vdiv","description":" Divide self by a Vector.\n Self-Modifies. Does not return anything"},"mul":{"path":"libs_sh/vectors.lua#L309","realm":"shared","params":[{"type":"number","value":"number n Scalar to multiply with.","name":"n","description":"Scalar to multiply with."}],"class":"function","name":"mul","description":" Scalar Multiplication of the vector.\n Self-Modifies. Does not return anything"},"__eq":{"path":"libs_sh/vectors.lua#L184","returns":[{"type":"boolean","value":"boolean Whether both sides are equal.","description":"Whether both sides are equal."}],"realm":"shared","params":[{"type":"Vector","value":"Vector v1 Initial vector.","name":"v1","description":"Initial vector."},{"type":"Vector","value":"Vector v2 Vector to check against.","name":"v2","description":"Vector to check against."}],"class":"function","name":"__eq","description":" Equivalence metamethod"},"rotate":{"path":"libs_sh/vectors.lua#L394","realm":"shared","params":[{"type":"Angle","value":"Angle b Angle to rotate by.","name":"b","description":"Angle to rotate by."}],"class":"function","name":"rotate","description":" Rotate the vector by Angle b.\n Self-Modifies. Does not return anything"},"normalize":{"path":"libs_sh/vectors.lua#L381","realm":"shared","class":"function","name":"normalize","description":" Normalise the vector, same direction, length 1.\n Self-Modifies. Does not return anything"},"getNormalized":{"path":"libs_sh/vectors.lua#L243","returns":[{"type":"Vector","value":"Vector Normalized vector","description":"Normalized vector"}],"realm":"shared","class":"function","name":"getNormalized","description":" Returns a new vector with the same direction by length of 1."},"getQuaternionFromAxis":{"path":"libs_sh/quaternion.lua#L808","returns":[{"type":"Quaternion","value":"Quaternion Rotated quaternion","description":"Rotated quaternion"}],"realm":"shared","params":[{"type":"number","value":"number ang Number rotation angle","name":"ang","description":"Number rotation angle"}],"class":"function","name":"getQuaternionFromAxis","description":" Returns quaternion for rotation about axis represented by the vector by an angle"},"setX":{"path":"libs_sh/vectors.lua#L357","returns":[{"type":"Vector","value":"Vector Modified vector after setting X.","description":"Modified vector after setting X."}],"realm":"shared","params":[{"type":"number","value":"number x The x coordinate","name":"x","description":"The x coordinate"}],"class":"function","name":"setX","description":" Set's the vector's x coordinate and returns the vector after modifying."},"setY":{"path":"libs_sh/vectors.lua#L365","returns":[{"type":"Vector","value":"Vector Modified vector after setting Y.","description":"Modified vector after setting Y."}],"realm":"shared","params":[{"type":"number","value":"number y The y coordinate","name":"y","description":"The y coordinate"}],"class":"function","name":"setY","description":" Set's the vector's y coordinate and returns the vector after modifying."},"getDistanceSqr":{"path":"libs_sh/vectors.lua#L229","returns":[{"type":"number","value":"number Vector distance from v","description":"Vector distance from v"}],"realm":"shared","params":[{"type":"Vector","value":"Vector v Second Vector","name":"v","description":"Second Vector"}],"class":"function","name":"getDistanceSqr","description":" Returns the squared distance of 2 vectors, this is faster Vector:getDistance as calculating the square root is an expensive process."},"getColor":{"path":"libs_sh/vectors.lua#L479","returns":[{"type":"Color","value":"Color New color object","description":"New color object"}],"realm":"shared","class":"function","name":"getColor","description":" Converts vector to color"},"cross":{"path":"libs_sh/vectors.lua#L215","returns":[{"type":"Vector","value":"Vector Vector from cross product","description":"Vector from cross product"}],"realm":"shared","params":[{"type":"Vector","value":"Vector v Second Vector","name":"v","description":"Second Vector"}],"class":"function","name":"cross","description":" Calculates the cross product of the 2 vectors, creates a unique perpendicular vector to both input vectors."},"isInWorld":{"path":"libs_sh/vectors.lua#L498","returns":[{"type":"boolean","value":"boolean True/False.","description":"True/False."}],"realm":"server","class":"function","name":"isInWorld","description":" Returns whether the vector is in world"},"set":{"path":"libs_sh/vectors.lua#L470","realm":"shared","params":[{"type":"Vector","value":"Vector v Second Vector","name":"v","description":"Second Vector"}],"class":"function","name":"set","description":" Copies the values from the second vector to the first vector.\n Self-Modifies. Does not return anything"},"setZ":{"path":"libs_sh/vectors.lua#L373","returns":[{"type":"Vector","value":"Vector Modified vector after setting Z.","description":"Modified vector after setting Z."}],"realm":"shared","params":[{"type":"number","value":"number z The z coordinate","name":"z","description":"The z coordinate"}],"class":"function","name":"setZ","description":" Set's the vector's z coordinate and returns the vector after modifying."},"sub":{"path":"libs_sh/vectors.lua#L300","realm":"shared","params":[{"type":"Vector","value":"Vector v Vector to subtract.","name":"v","description":"Vector to subtract."}],"class":"function","name":"sub","description":" Subtract v from this Vector.\n Self-Modifies. Does not return anything"},"add":{"path":"libs_sh/vectors.lua#L291","realm":"shared","params":[{"type":"Vector","value":"Vector v Vector to add","name":"v","description":"Vector to add"}],"class":"function","name":"add","description":" Add v to this vector\n Self-Modifies. Does not return anything"},"__div":{"path":"libs_sh/vectors.lua#L144","returns":[{"type":"Vector","value":"Vector Scaled vector.","description":"Scaled vector."}],"realm":"shared","params":[{"type":"number|Vector","value":"number|Vector v1 Number or Vector dividend.","name":"v1","description":"Number or Vector dividend."},{"type":"number|Vector","value":"number|Vector v2 Number or Vector divisor.","name":"v2","description":"Number or Vector divisor."}],"class":"function","name":"__div","description":" Division metamethod"},"rotateAroundAxis":{"path":"libs_sh/vectors.lua#L432","returns":[{"type":"Vector","value":"Vector Rotated vector","description":"Rotated vector"}],"realm":"shared","params":[{"type":"Vector","value":"Vector axis Axis the rotate around","name":"axis","description":"Axis the rotate around"},{"type":"number?","value":"number? degrees Angle to rotate by in degrees or nil if radians.","name":"degrees","description":"Angle to rotate by in degrees or nil if radians."},{"type":"number?","value":"number? radians Angle to rotate by in radians or nil if degrees.","name":"radians","description":"Angle to rotate by in radians or nil if degrees."}],"class":"function","name":"rotateAroundAxis","description":" Return rotated vector by an axis"},"__index":{"path":"libs_sh/vectors.lua#L89","returns":[{"type":"number","value":"number The value at the index","description":"The value at the index"}],"realm":"shared","params":[{"type":"number|string","value":"number|string Key to get the value at","name":"Key","description":"to get the value at"}],"class":"function","name":"__index","description":" Gets a value at a key in the vector\n Can be indexed with: 1, 2, 3, x, y, z, xx, xy, xz, xxx, xyz, zyx, etc.. 1,2,3 is most efficient."},"dot":{"path":"libs_sh/vectors.lua#L236","returns":[{"type":"number","value":"number Dot product result between the two vectors","description":"Dot product result between the two vectors"}],"realm":"shared","params":[{"type":"Vector","value":"Vector v Second Vector","name":"v","description":"Second Vector"}],"class":"function","name":"dot","description":" Dot product is the cosine of the angle between both vectors multiplied by their lengths. A.B = ||A||||B||cosA."},"getRotated":{"path":"libs_sh/vectors.lua#L409","returns":[{"type":"Vector","value":"Vector Rotated Vector","description":"Rotated Vector"}],"realm":"shared","params":[{"type":"Angle","value":"Angle b Angle to rotate by.","name":"b","description":"Angle to rotate by."}],"class":"function","name":"getRotated","description":" Returns Rotated vector by Angle b"},"getDistance":{"path":"libs_sh/vectors.lua#L222","returns":[{"type":"number","value":"number Vector distance from v","description":"Vector distance from v"}],"realm":"shared","params":[{"type":"Vector","value":"Vector v Second Vector","name":"v","description":"Second Vector"}],"class":"function","name":"getDistance","description":" Returns the pythagorean distance between the vector and the other vector."},"clone":{"path":"libs_sh/vectors.lua#L464","returns":[{"type":"Vector","value":"Vector The copy of the vector","description":"The copy of the vector"}],"realm":"shared","class":"function","name":"clone","description":" Copies x,y,z from a vector and returns a new vector"},"__tostring":{"path":"libs_sh/vectors.lua#L116","returns":[{"type":"string","value":"string String representation of the vector.","description":"String representation of the vector."}],"realm":"shared","class":"function","name":"__tostring","description":" Turns a vector into a string."},"getAngle":{"path":"libs_sh/vectors.lua#L195","returns":[{"type":"Angle","value":"Angle Angle representing the vector","description":"Angle representing the vector"}],"realm":"shared","class":"function","name":"getAngle","description":" Get the vector's angle."},"vmul":{"path":"libs_sh/vectors.lua#L331","realm":"shared","params":[{"type":"Vector","value":"Vector v Vector to multiply with","name":"v","description":"Vector to multiply with"}],"class":"function","name":"vmul","description":" Multiply self with a Vector.\n Self-Modifies. Does not return anything"},"isZero":{"path":"libs_sh/vectors.lua#L261","returns":[{"type":"boolean","value":"boolean Whether all fields are zero","description":"Whether all fields are zero"}],"realm":"shared","class":"function","name":"isZero","description":" Returns whether all fields are zero"},"toScreen":{"path":"libs_sh/vectors.lua#L505","returns":[{"type":"table","value":"table A table {x=screenx,y=screeny,visible=visible}","description":"A table {x=screenx,y=screeny,visible=visible}"}],"realm":"client","class":"function","name":"toScreen","description":" Translates the vectors position into 2D user screen coordinates."},"__newindex":{"path":"libs_sh/vectors.lua#L63","realm":"shared","params":[{"type":"Vector","value":"Vector Vec","name":"Vec","description":""},{"type":"number|string","value":"number|string Key","name":"Key","description":""},{"type":"number","value":"number Value","name":"Value","description":""}],"class":"function","name":"__newindex","description":" Sets a value at a key in the vector"},"__add":{"path":"libs_sh/vectors.lua#L162","returns":[{"type":"Vector","value":"Vector Resultant vector after addition operation.","description":"Resultant vector after addition operation."}],"realm":"shared","params":[{"type":"Vector","value":"Vector v1 Initial vector.","name":"v1","description":"Initial vector."},{"type":"Vector","value":"Vector v2 Vector to add to the first.","name":"v2","description":"Vector to add to the first."}],"class":"function","name":"__add","description":" Addition metamethod"},"div":{"path":"libs_sh/vectors.lua#L320","realm":"shared","params":[{"type":"number","value":"number n Scalar to divide by.","name":"n","description":"Scalar to divide by."}],"class":"function","name":"div","description":" \"Scalar Division\" of the vector.\n Self-Modifies. Does not return anything"},"getLength2DSqr":{"path":"libs_sh/vectors.lua#L285","returns":[{"type":"number","value":"number Length squared.","description":"Length squared."}],"realm":"shared","class":"function","name":"getLength2DSqr","description":" Returns the length squared of the vector in two dimensions, without the Z axis. ( Saves computation by skipping the square root )"},"getBasis":{"path":"libs_sh/vectors.lua#L419","returns":[{"type":"number","value":"number Basis 1","description":"Basis 1"},{"type":"number","value":"number Basis 2","description":"Basis 2"}],"realm":"shared","class":"function","name":"getBasis","description":" Returns an arbitrary orthogonal basis from the direction of the vector. Input must be a normalized vector"},"getAngleEx":{"path":"libs_sh/vectors.lua#L208","returns":[{"type":"Angle","value":"Angle Angle","description":"Angle"}],"realm":"shared","params":[{"type":"Vector","value":"Vector v Second Vector","name":"v","description":"Second Vector"}],"class":"function","name":"getAngleEx","description":" Returns the vector's euler angle with respect to the other vector as if it were the new vertical axis."},"setZero":{"path":"libs_sh/vectors.lua#L349","realm":"shared","class":"function","name":"setZero","description":" Set's all vector fields to 0.\n Self-Modifies. Does not return anything"}},"fields":[{"name":"x","description":"The x value of the vector. Can also be indexed with [1]"},{"name":"y","description":"The y value of the vector. Can also be indexed with [2]"},{"name":"z","description":"The z value of the vector. Can also be indexed with [3]"}],"realm":"shared","libtbl":["vec_methods","vec_meta"],"class":"type","name":"Vector","description":" Vector type"},"Markup":{"path":"libs_cl/render.lua#L422","libtbl":["markup_methods"],"realm":"client","methods":{"getSize":{"path":"libs_cl/render.lua#L1920","returns":[{"type":"number","value":"number The width of the object","description":"The width of the object"},{"type":"number","value":"number The height of the object","description":"The height of the object"}],"realm":"client","class":"function","name":"getSize","description":" Get the object size"},"draw":{"path":"libs_cl/render.lua#L1896","realm":"client","params":[{"type":"number","value":"number x number The x offset","name":"x","description":"number The x offset"},{"type":"number","value":"number y number The x offset","name":"y","description":"number The x offset"},{"type":"number?","value":"number? xAlign number The x TEXT_ALIGN. Default TEXT_ALIGN.LEFT","name":"xAlign","description":"number The x TEXT_ALIGN. Default TEXT_ALIGN.LEFT"},{"type":"number?","value":"number? yAlign number The y TEXT_ALIGN. Default TEXT_ALIGN.TOP","name":"yAlign","description":"number The y TEXT_ALIGN. Default TEXT_ALIGN.TOP"},{"type":"number?","value":"number? alpha The alpha to draw it with. Default 255","name":"alpha","description":"The alpha to draw it with. Default 255"},{"type":"number?","value":"number? contentAlign The content alignment TEXT_ALIGN. Default TEXT_ALIGN.LEFT","name":"contentAlign","description":"The content alignment TEXT_ALIGN. Default TEXT_ALIGN.LEFT"}],"class":"function","name":"draw","description":" Draw the markup object"},"getWidth":{"path":"libs_cl/render.lua#L1908","returns":[{"type":"number","value":"number The width of the object","description":"The width of the object"}],"realm":"client","class":"function","name":"getWidth","description":" Get the object width"},"getHeight":{"path":"libs_cl/render.lua#L1914","returns":[{"type":"number","value":"number The height of the object","description":"The height of the object"}],"realm":"client","class":"function","name":"getHeight","description":" Get the object height"}},"class":"type","name":"Markup","description":" The Markup type is used to easily format and draw text. Use render.parseMarkup(str, maxwidth) to create one."},"Hologram":{"path":"libs_sh/hologram.lua#L42","libtbl":["hologram_methods"],"realm":"shared","methods":{"setCullMode":{"path":"libs_sh/hologram.lua#L491","realm":"shared","params":[{"type":"number","value":"number mode Cull mode. 0 for counter clock wise, 1 for clock wise","name":"mode","description":"Cull mode. 0 for counter clock wise, 1 for clock wise"}],"class":"function","name":"setCullMode","description":" Set the cull mode for a hologram."},"setAngVel":{"path":"libs_sh/hologram.lua#L186","realm":"server","params":[{"type":"Angle","value":"Angle angvel *Vector* angular velocity.","name":"angvel","description":"*Vector* angular velocity."}],"class":"function","name":"setAngVel","description":" Sets the hologram's angular velocity."},"setAnimation":{"path":"libs_sh/hologram.lua#L461","realm":"shared","params":[{"type":"number|string","value":"number|string animation Animation number or string name.","name":"animation","description":"Animation number or string name."},{"type":"number?","value":"number? frame Optional int (Default 0) The starting frame number. Does nothing if nil","name":"frame","description":"Optional int (Default 0) The starting frame number. Does nothing if nil"},{"type":"number?","value":"number? rate Optional float (Default 1) Frame speed. Does nothing if nil","name":"rate","description":"Optional float (Default 1) Frame speed. Does nothing if nil"}],"class":"function","name":"setAnimation","description":" Animates a hologram"},"suppressEngineLighting":{"path":"libs_sh/hologram.lua#L427","realm":"shared","params":[{"type":"boolean","value":"boolean suppress Boolean to represent if shading should be set or not.","name":"suppress","description":"Boolean to represent if shading should be set or not."}],"class":"function","name":"suppressEngineLighting","description":" Suppress Engine Lighting of a hologram. Disabled by default."},"setScale":{"path":"libs_sh/hologram.lua#L394","realm":"shared","params":[{"type":"Vector","value":"Vector scale Vector new scale","name":"scale","description":"Vector new scale"}],"class":"function","name":"setScale","description":" Sets the hologram scale. Basically the same as setRenderMatrix() with a scaled matrix"},"setRenderGroup":{"path":"libs_sh/hologram.lua#L511","realm":"shared","params":[{"type":"number|nil","value":"number|nil group Render group. If unset, the engine will decide the render group based on the entity's materials. Can be RENDERGROUP.OPAQUE RENDERGROUP.TRANSLUCENT RENDERGROUP.BOTH RENDERGROUP.VIEWMODEL RENDERGROUP.VIEWMODEL.TRANSLUCENT RENDERGROUP.OPAQUE.BRUSH","name":"group","description":"Render group. If unset, the engine will decide the render group based on the entity's materials. Can be RENDERGROUP.OPAQUE RENDERGROUP.TRANSLUCENT RENDERGROUP.BOTH RENDERGROUP.VIEWMODEL RENDERGROUP.VIEWMODEL.TRANSLUCENT RENDERGROUP.OPAQUE.BRUSH"}],"class":"function","name":"setRenderGroup","description":" Set the render group for a hologram."},"getScale":{"path":"libs_sh/hologram.lua#L420","returns":[{"type":"Vector","value":"Vector Vector scale","description":"Vector scale"}],"realm":"shared","class":"function","name":"getScale","description":" Gets the hologram scale."},"setClip":{"path":"libs_sh/hologram.lua#L358","realm":"shared","params":[{"type":"number","value":"number index Whatever number you want the clip to be","name":"index","description":"Whatever number you want the clip to be"},{"type":"boolean","value":"boolean enabled Whether the clip is enabled","name":"enabled","description":"Whether the clip is enabled"},{"type":"Vector?","value":"Vector? origin The center of the clip plane in world coordinates, or local to entity if it is specified. Only used if enabled.","name":"origin","description":"The center of the clip plane in world coordinates, or local to entity if it is specified. Only used if enabled."},{"type":"Vector?","value":"Vector? normal The the direction of the clip plane in world coordinates, or local to entity if it is specified. Only used if enabled.","name":"normal","description":"The the direction of the clip plane in world coordinates, or local to entity if it is specified. Only used if enabled."},{"type":"Entity?","value":"Entity? entity (Optional) The entity to make coordinates local to, otherwise the world is used. Only used if enabled.","name":"entity","description":"(Optional) The entity to make coordinates local to, otherwise the world is used. Only used if enabled."}],"class":"function","name":"setClip","description":" Updates a clip plane"},"setFilterMag":{"path":"libs_sh/hologram.lua#L242","realm":"client","params":[{"type":"number","value":"number val The filter function to use http://wiki.facepunch.com/gmod/Enums/TEXFILTER","name":"val","description":"The filter function to use http://wiki.facepunch.com/gmod/Enums/TEXFILTER"}],"class":"function","name":"setFilterMag","description":" Sets the texture filtering function when viewing a close texture"},"addEffects":{"path":"libs_sh/hologram.lua#L527","realm":"shared","params":[{"type":"number","value":"number effect The effects to add. See EF Enums","name":"effect","description":"The effects to add. See EF Enums"}],"class":"function","name":"addEffects","description":" Applies engine effects to the hologram"},"setRenderMatrix":{"path":"libs_sh/hologram.lua#L276","realm":"client","params":[{"type":"VMatrix","value":"VMatrix mat Starfall matrix to use","name":"mat","description":"Starfall matrix to use"}],"class":"function","name":"setRenderMatrix","description":" Sets a hologram entity's rendermatrix"},"setPos":{"path":"libs_sh/hologram.lua#L210","realm":"shared","params":[{"type":"Vector","value":"Vector vec New position","name":"vec","description":"New position"}],"class":"function","name":"setPos","description":" Sets the hologram's position."},"setAngles":{"path":"libs_sh/hologram.lua#L226","realm":"shared","params":[{"type":"Angle","value":"Angle ang New angles","name":"ang","description":"New angles"}],"class":"function","name":"setAngles","description":" Sets the hologram's angles."},"setMoveType":{"path":"libs_sh/hologram.lua#L197","realm":"server","params":[{"type":"number","value":"number Movetype to set, either MOVETYPE.NOCLIP (default) or MOVETYPE.NONE","name":"Movetype","description":"to set, either MOVETYPE.NOCLIP (default) or MOVETYPE.NONE"}],"class":"function","name":"setMoveType","description":" Sets the hologram's movetype"},"setModel":{"path":"libs_sh/hologram.lua#L447","realm":"shared","params":[{"type":"string","value":"string model string model path","name":"model","description":"string model path"}],"class":"function","name":"setModel","description":" Sets the model of a hologram"},"getPlayerColor":{"path":"libs_sh/hologram.lua#L344","returns":[{"type":"Vector?","value":"Vector? color The player color to use, or nil if disabled","description":"color The player color to use, or nil if disabled"}],"realm":"shared","class":"function","name":"getPlayerColor","description":" Gets the player color of a hologram\n The part of the model that is colored is determined by the model itself, and is different for each model\n The format is Vector(r,g,b), and each color should be between 0 and 1"},"getSuppressEngineLighting":{"path":"libs_sh/hologram.lua#L440","returns":[{"type":"boolean","value":"boolean Whether engine lighting is suppressed","description":"Whether engine lighting is suppressed"}],"realm":"shared","class":"function","name":"getSuppressEngineLighting","description":" Suppress Engine Lighting of a hologram. Disabled by default."},"removeEffects":{"path":"libs_sh/hologram.lua#L539","realm":"shared","params":[{"type":"number","value":"number effect The effects to remove. See EF Enums","name":"effect","description":"The effects to remove. See EF Enums"}],"class":"function","name":"removeEffects","description":" Removes engine effects from the hologram"},"remove":{"path":"libs_sh/hologram.lua#L551","realm":"shared","class":"function","name":"remove","description":" Removes a hologram"},"setVel":{"path":"libs_sh/hologram.lua#L173","realm":"server","params":[{"type":"Vector","value":"Vector vel New velocity","name":"vel","description":"New velocity"}],"class":"function","name":"setVel","description":" Sets the hologram linear velocity"},"setPlayerColor":{"path":"libs_sh/hologram.lua#L329","realm":"shared","params":[{"type":"Vector?","value":"Vector? color The player color to use, or nil to disable","name":"color","description":"The player color to use, or nil to disable"}],"class":"function","name":"setPlayerColor","description":" Sets the player color of a hologram\n The part of the model that is colored is determined by the model itself, and is different for each model\n The format is Vector(r,g,b), and each color should be between 0 and 1"},"draw":{"path":"libs_sh/hologram.lua#L302","realm":"client","params":[{"type":"boolean?","value":"boolean? noTint If true, renders the hologram without its color and opacity. The default is for holograms to render with color or opacity, so use this argument if you need that behavior.","name":"noTint","description":"If true, renders the hologram without its color and opacity. The default is for holograms to render with color or opacity, so use this argument if you need that behavior."}],"class":"function","name":"draw","description":" Manually draws a hologram, requires a 3d render context"},"setSize":{"path":"libs_sh/hologram.lua#L406","realm":"shared","params":[{"type":"Vector","value":"Vector size Vector new size in game units","name":"size","description":"Vector new size in game units"}],"class":"function","name":"setSize","description":" Sets the hologram size in game units"},"setFilterMin":{"path":"libs_sh/hologram.lua#L259","realm":"client","params":[{"type":"number","value":"number val The filter function to use http://wiki.facepunch.com/gmod/Enums/TEXFILTER","name":"val","description":"The filter function to use http://wiki.facepunch.com/gmod/Enums/TEXFILTER"}],"class":"function","name":"setFilterMin","description":" Sets the texture filtering function when viewing a far texture"}},"class":"type","name":"Hologram","description":" Hologram type"},"Light":{"path":"libs_cl/light.lua#L80","libtbl":["light_methods"],"realm":"client","methods":{"setNoWorld":{"path":"libs_cl/light.lua#L211","realm":"client","params":[{"type":"boolean","value":"boolean on Whether the light shouldn't cast onto the world","name":"on","description":"Whether the light shouldn't cast onto the world"}],"class":"function","name":"setNoWorld","description":" Sets whether the light should cast onto the world or not"},"setOuterAngle":{"path":"libs_cl/light.lua#L197","realm":"client","params":[{"type":"number","value":"number ang Outer angle of the light","name":"ang","description":"Outer angle of the light"}],"class":"function","name":"setOuterAngle","description":" Sets the light outer angle (used with setDirection and setInnerAngle)"},"setInnerAngle":{"path":"libs_cl/light.lua#L190","realm":"client","params":[{"type":"number","value":"number ang Inner angle of the light","name":"ang","description":"Inner angle of the light"}],"class":"function","name":"setInnerAngle","description":" Sets the light inner angle (used with setDirection and setOuterAngle)"},"destroy":{"path":"libs_cl/light.lua#L255","realm":"client","class":"function","name":"destroy","description":" Destroys the light object freeing up whatever slot it was using"},"setStyle":{"path":"libs_cl/light.lua#L238","realm":"client","params":[{"type":"number","value":"number style The number of the flicker style","name":"style","description":"The number of the flicker style"}],"class":"function","name":"setStyle","description":" Sets the flicker style of the light https://developer.valvesoftware.com/wiki/Light_dynamic#Appearances"},"setColor":{"path":"libs_cl/light.lua#L245","realm":"client","params":[{"type":"Color","value":"Color col The color of the light","name":"col","description":"The color of the light"}],"class":"function","name":"setColor","description":" Sets the color of the light"},"setBrightness":{"path":"libs_cl/light.lua#L163","realm":"client","params":[{"type":"number","value":"number brightness The light's brightness","name":"brightness","description":"The light's brightness"}],"class":"function","name":"setBrightness","description":" Sets the light brightness"},"setDieTime":{"path":"libs_cl/light.lua#L177","realm":"client","params":[{"type":"number","value":"number dietime The how long the light will stay alive after turning it off.","name":"dietime","description":"The how long the light will stay alive after turning it off."}],"class":"function","name":"setDieTime","description":" Sets the light lifespan (Required for fade effect i.e. decay)"},"draw":{"path":"libs_cl/light.lua#L143","realm":"client","class":"function","name":"draw","description":" Draws the light. Typically used in the think hook. Will throw an error if it fails (use pcall)"},"setSize":{"path":"libs_cl/light.lua#L231","realm":"client","params":[{"type":"number","value":"number size The size of the light","name":"size","description":"The size of the light"}],"class":"function","name":"setSize","description":" Sets the size of the light (max is sf_light_maxsize)"},"setMinLight":{"path":"libs_cl/light.lua#L204","realm":"client","params":[{"type":"number","value":"number min The minimum light","name":"min","description":"The minimum light"}],"class":"function","name":"setMinLight","description":" Sets the minimum light amount"},"setDecay":{"path":"libs_cl/light.lua#L170","realm":"client","params":[{"type":"number","value":"number decay The light's decay speed","name":"decay","description":"The light's decay speed"}],"class":"function","name":"setDecay","description":" Sets the light decay speed in thousandths per second. 1000 lasts for 1 second, 2000 lasts for 0.5 seconds"},"setPos":{"path":"libs_cl/light.lua#L225","realm":"client","params":[{"type":"Vector","value":"Vector pos The position of the light","name":"pos","description":"The position of the light"}],"class":"function","name":"setPos","description":" Sets the light position"},"setNoModel":{"path":"libs_cl/light.lua#L218","realm":"client","params":[{"type":"boolean","value":"boolean on Whether the light shouldn't cast onto the models","name":"on","description":"Whether the light shouldn't cast onto the models"}],"class":"function","name":"setNoModel","description":" Sets whether the light should cast onto models or not"},"setDirection":{"path":"libs_cl/light.lua#L184","realm":"client","params":[{"type":"Vector","value":"Vector dir Direction of the light","name":"dir","description":"Direction of the light"}],"class":"function","name":"setDirection","description":" Sets the light direction (used with setInnerAngle and setOuterAngle)"}},"class":"type","name":"Light","description":" Light type"},"WebSocket":{"path":"libs_cl/websocket.lua#L97","libtbl":["websocket_methods","websocket_meta"],"realm":"client","methods":{"close":{"path":"libs_cl/websocket.lua#L132","realm":"client","class":"function","name":"close","description":" Closes the websocket connection. Does nothing if already closed"},"write":{"path":"libs_cl/websocket.lua#L137","realm":"client","params":[{"type":"string","value":"string msg What to send","name":"msg","description":"What to send"}],"class":"function","name":"write","description":" Sends a message to the connected websocket stream."},"__tostring":{"path":"libs_cl/websocket.lua#L180","realm":"client","class":"function","name":"__tostring","description":" Returns \"WebSocket: \" alongside the address of the websocket."},"getState":{"path":"libs_cl/websocket.lua#L148","returns":[{"type":"number","value":"number The current state of the websocket.","description":"The current state of the websocket."}],"realm":"client","class":"function","name":"getState","description":" Returns the current state of the websocket.\n https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/readyState\n * 0 - CONNECTING\n * 1 - OPEN\n * 2 - CLOSING\n * 3 - CLOSED"},"__newindex":{"path":"libs_cl/websocket.lua#L159","realm":"client","params":[{"type":"string","value":"string k onMessage, onConnected, onDisconnected","name":"k","description":"onMessage, onConnected, onDisconnected"},{"type":"function","value":"function v The callback function, which will be called with the websocket as the first argument.","name":"v","description":"The callback function, which will be called with the websocket as the first argument."}],"class":"function","name":"__newindex","description":" Sets a callback for the websocket.\n Can be used with the following callbacks:\n * onMessage - Called when a message is received.\n * onConnected - Called when the websocket initially connects.\n * onDisconnected - Called when the websocket is disconnected, with the only param being if it was caused by an 'error' event."},"connect":{"path":"libs_cl/websocket.lua#L143","realm":"client","class":"function","name":"connect","description":" Connects to the websocket server."}},"class":"type","name":"WebSocket","description":" Websocket Type. Create a websocket with WebSocket(...)"},"Material":{"path":"libs_cl/material.lua#L373","libtbl":["material_methods"],"realm":"client","methods":{"getFloat":{"path":"libs_cl/material.lua#L644","returns":[{"type":"number?","value":"number? The float value or nil if it doesn't exist","description":"The float value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string key The key to get the float from","name":"key","description":"The key to get the float from"}],"class":"function","name":"getFloat","description":" Returns a float keyvalue"},"recompute":{"path":"libs_cl/material.lua#L715","realm":"client","class":"function","name":"recompute","description":" Refreshes the material. Sometimes needed for certain parameters to update"},"getMatrix":{"path":"libs_cl/material.lua#L669","returns":[{"type":"VMatrix?","value":"VMatrix? The matrix value or nil if it doesn't exist","description":"The matrix value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string key The key to get the matrix from","name":"key","description":"The key to get the matrix from"}],"class":"function","name":"getMatrix","description":" Returns a matrix keyvalue"},"getColor":{"path":"libs_cl/material.lua#L633","returns":[{"type":"Color","value":"Color The color value","description":"The color value"}],"realm":"client","params":[{"type":"number","value":"number x The x coordinate of the pixel","name":"x","description":"The x coordinate of the pixel"},{"type":"number","value":"number y The y coordinate of the pixel","name":"y","description":"The y coordinate of the pixel"}],"class":"function","name":"getColor","description":" Returns a color pixel value of the $basetexture of a .png or .jpg material."},"getInt":{"path":"libs_cl/material.lua#L653","returns":[{"type":"number?","value":"number? The int value or nil if it doesn't exist","description":"The int value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string key The key to get the int from","name":"key","description":"The key to get the int from"}],"class":"function","name":"getInt","description":" Returns an int keyvalue"},"setInt":{"path":"libs_cl/material.lua#L729","realm":"client","params":[{"type":"string","value":"string key The key name to set","name":"key","description":"The key name to set"},{"type":"number","value":"number v The value to set it to","name":"v","description":"The value to set it to"}],"class":"function","name":"setInt","description":" Sets an int keyvalue"},"getTexture":{"path":"libs_cl/material.lua#L687","returns":[{"type":"string?","value":"string? The string id of the texture or nil if it doesn't exist","description":"The string id of the texture or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string key The key to get the texture from","name":"key","description":"The key to get the texture from"}],"class":"function","name":"getTexture","description":" Returns a texture id keyvalue"},"setFloat":{"path":"libs_cl/material.lua#L720","realm":"client","params":[{"type":"string","value":"string key The key name to set","name":"key","description":"The key name to set"},{"type":"number","value":"number v The value to set it to","name":"v","description":"The value to set it to"}],"class":"function","name":"setFloat","description":" Sets a float keyvalue"},"setTexture":{"path":"libs_cl/material.lua#L755","realm":"client","params":[{"type":"string","value":"string key The key name to set. $basetexture is the key name for most purposes.","name":"key","description":"The key name to set. $basetexture is the key name for most purposes."},{"type":"string","value":"string v The texture name to set it to.","name":"v","description":"The texture name to set it to."}],"class":"function","name":"setTexture","description":" Sets a texture keyvalue"},"setUndefined":{"path":"libs_cl/material.lua#L835","realm":"client","params":[{"type":"string","value":"string key The key name to set","name":"key","description":"The key name to set"}],"class":"function","name":"setUndefined","description":" Sets a keyvalue to be undefined"},"getString":{"path":"libs_cl/material.lua#L678","returns":[{"type":"string?","value":"string? The string value or nil if it doesn't exist","description":"The string value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string key The key to get the string from","name":"key","description":"The key to get the string from"}],"class":"function","name":"getString","description":" Returns a string keyvalue"},"getVectorLinear":{"path":"libs_cl/material.lua#L706","returns":[{"type":"Vector?","value":"Vector? The vector value or nil if it doesn't exist","description":"The vector value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string key The key to get the vector from","name":"key","description":"The key to get the vector from"}],"class":"function","name":"getVectorLinear","description":" Returns a linear color-corrected vector keyvalue"},"setTextureURL":{"path":"libs_cl/material.lua#L765","realm":"client","params":[{"type":"string","value":"string key The key name to set. $basetexture is the key name for most purposes.","name":"key","description":"The key name to set. $basetexture is the key name for most purposes."},{"type":"string","value":"string url The url or base64 data","name":"url","description":"The url or base64 data"},{"type":"function?","value":"function? cb An optional callback called when image is loaded. Passes nil if it fails or Passes the material, url, width, height, and layout function which can be called with x, y, w, h, pixelated to reposition the image in the texture. Setting the optional 'pixelated' argument to True tells the image to use nearest-neighbor interpolation","name":"cb","description":"An optional callback called when image is loaded. Passes nil if it fails or Passes the material, url, width, height, and layout function which can be called with x, y, w, h, pixelated to reposition the image in the texture. Setting the optional 'pixelated' argument to True tells the image to use nearest-neighbor interpolation"},{"type":"function?","value":"function? done An optional callback called when the image is done loading. Passes the material, url","name":"done","description":"An optional callback called when the image is done loading. Passes the material, url"}],"class":"function","name":"setTextureURL","description":" Loads an online image or base64 data to the specified texture key\n If the texture in key is not set to a rendertarget, a rendertarget will be created and used."},"getKeyValues":{"path":"libs_cl/material.lua#L662","returns":[{"type":"table","value":"table The table of keyvalues","description":"The table of keyvalues"}],"realm":"client","class":"function","name":"getKeyValues","description":" Returns a table of material keyvalues"},"getName":{"path":"libs_cl/material.lua#L605","returns":[{"type":"string","value":"string The name of the material. If this material is user created, add ! to the beginning of this to use it with entity.setMaterial","description":"The name of the material. If this material is user created, add ! to the beginning of this to use it with entity.setMaterial"}],"realm":"client","class":"function","name":"getName","description":" Returns the material's engine name"},"destroy":{"path":"libs_cl/material.lua#L587","realm":"client","class":"function","name":"destroy","description":" Frees a user created material allowing you to create others"},"setVector":{"path":"libs_cl/material.lua#L842","realm":"client","params":[{"type":"string","value":"string key The key name to set","name":"key","description":"The key name to set"},{"type":"Vector","value":"Vector v The value to set it to","name":"v","description":"The value to set it to"}],"class":"function","name":"setVector","description":" Sets a vector keyvalue"},"setString":{"path":"libs_cl/material.lua#L746","realm":"client","params":[{"type":"string","value":"string key The key name to set","name":"key","description":"The key name to set"},{"type":"string","value":"string v The value to set it to","name":"v","description":"The value to set it to"}],"class":"function","name":"setString","description":" Sets a string keyvalue"},"setMatrix":{"path":"libs_cl/material.lua#L738","realm":"client","params":[{"type":"string","value":"string key The key name to set","name":"key","description":"The key name to set"},{"type":"VMatrix","value":"VMatrix v The value to set it to","name":"v","description":"The value to set it to"}],"class":"function","name":"setMatrix","description":" Sets a matrix keyvalue"},"getShader":{"path":"libs_cl/material.lua#L612","returns":[{"type":"string","value":"string The shader name of the material","description":"The shader name of the material"}],"realm":"client","class":"function","name":"getShader","description":" Returns the shader name of the material"},"getVector":{"path":"libs_cl/material.lua#L697","returns":[{"type":"Vector?","value":"Vector? The vector value or nil if it doesn't exist","description":"The vector value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string key The key to get the vector from","name":"key","description":"The key to get the vector from"}],"class":"function","name":"getVector","description":" Returns a vector keyvalue"},"setTextureRenderTarget":{"path":"libs_cl/material.lua#L821","realm":"client","params":[{"type":"string","value":"string key The key name to set. $basetexture is the key name for most purposes.","name":"key","description":"The key name to set. $basetexture is the key name for most purposes."},{"type":"string","value":"string name The name of the rendertarget","name":"name","description":"The name of the rendertarget"}],"class":"function","name":"setTextureRenderTarget","description":" Sets a rendertarget texture to the specified texture key"},"getWidth":{"path":"libs_cl/material.lua#L619","returns":[{"type":"number","value":"number The basetexture's width","description":"The basetexture's width"}],"realm":"client","class":"function","name":"getWidth","description":" Gets the base texture set to the material's width"},"getHeight":{"path":"libs_cl/material.lua#L626","returns":[{"type":"number","value":"number The basetexture's height","description":"The basetexture's height"}],"realm":"client","class":"function","name":"getHeight","description":" Gets the base texture set to the material's height"}},"class":"type","name":"Material","description":" The `Material` type is used to control shaders in rendering.\n For a list of shader parameters, see https://developer.valvesoftware.com/wiki/Category:List_of_Shader_Parameters\n For a list of $flags and $flags2, see https://developer.valvesoftware.com/wiki/Material_Flags"},"File":{"path":"libs_cl/file.lua#L29","libtbl":["file_methods"],"realm":"client","methods":{"write":{"path":"libs_cl/file.lua#L492","realm":"client","params":[{"type":"string","value":"string str The data to write","name":"str","description":"The data to write"}],"class":"function","name":"write","description":" Writes a string to the file and advances the file position"},"read":{"path":"libs_cl/file.lua#L443","returns":[{"type":"string","value":"string The data","description":"The data"}],"realm":"client","params":[{"type":"number","value":"number n The length to read","name":"n","description":"The length to read"}],"class":"function","name":"read","description":" Reads a certain length of the file's bytes"},"writeFloat":{"path":"libs_cl/file.lua#L520","realm":"client","params":[{"type":"number","value":"number x The float to write","name":"x","description":"The float to write"}],"class":"function","name":"writeFloat","description":" Writes a float and advances the file position"},"seek":{"path":"libs_cl/file.lua#L416","realm":"client","params":[{"type":"number","value":"number n The position to set it to","name":"n","description":"The position to set it to"}],"class":"function","name":"seek","description":" Sets the file position"},"writeLong":{"path":"libs_cl/file.lua#L527","realm":"client","params":[{"type":"number","value":"number x The long to write","name":"x","description":"The long to write"}],"class":"function","name":"writeLong","description":" Writes a long and advances the file position"},"flush":{"path":"libs_cl/file.lua#L404","realm":"client","class":"function","name":"flush","description":" Wait until all changes to the file are complete"},"writeDouble":{"path":"libs_cl/file.lua#L513","realm":"client","params":[{"type":"number","value":"number x The double to write","name":"x","description":"The double to write"}],"class":"function","name":"writeDouble","description":" Writes a double and advances the file position"},"readLine":{"path":"libs_cl/file.lua#L474","returns":[{"type":"string","value":"string Line contents","description":"Line contents"}],"realm":"client","class":"function","name":"readLine","description":" Reads a line and advances the file position"},"readBool":{"path":"libs_cl/file.lua#L450","returns":[{"type":"boolean","value":"boolean Boolean","description":"Boolean"}],"realm":"client","class":"function","name":"readBool","description":" Reads a boolean and advances the file position"},"writeBool":{"path":"libs_cl/file.lua#L499","realm":"client","params":[{"type":"boolean","value":"boolean x The boolean to write","name":"x","description":"The boolean to write"}],"class":"function","name":"writeBool","description":" Writes a boolean and advances the file position"},"readByte":{"path":"libs_cl/file.lua#L456","returns":[{"type":"number","value":"number UInt8 number","description":"UInt8 number"}],"realm":"client","class":"function","name":"readByte","description":" Reads a byte and advances the file position"},"readFloat":{"path":"libs_cl/file.lua#L468","returns":[{"type":"number","value":"number Float32 number","description":"Float32 number"}],"realm":"client","class":"function","name":"readFloat","description":" Reads a float and advances the file position"},"writeByte":{"path":"libs_cl/file.lua#L506","realm":"client","params":[{"type":"number","value":"number x The byte to write","name":"x","description":"The byte to write"}],"class":"function","name":"writeByte","description":" Writes a byte and advances the file position"},"readLong":{"path":"libs_cl/file.lua#L480","returns":[{"type":"number","value":"number Int32 number","description":"Int32 number"}],"realm":"client","class":"function","name":"readLong","description":" Reads a long and advances the file position"},"readDouble":{"path":"libs_cl/file.lua#L462","returns":[{"type":"number","value":"number Float64 number","description":"Float64 number"}],"realm":"client","class":"function","name":"readDouble","description":" Reads a double and advances the file position"},"close":{"path":"libs_cl/file.lua#L409","realm":"client","class":"function","name":"close","description":" Flushes and closes the file. The file must be opened again to use a new file object."},"skip":{"path":"libs_cl/file.lua#L423","returns":[{"type":"number","value":"number The resulting position","description":"The resulting position"}],"realm":"client","params":[{"type":"number","value":"number n How much to move the position","name":"n","description":"How much to move the position"}],"class":"function","name":"skip","description":" Moves the file position relative to its current position"},"writeShort":{"path":"libs_cl/file.lua#L534","realm":"client","params":[{"type":"number","value":"number x The short to write","name":"x","description":"The short to write"}],"class":"function","name":"writeShort","description":" Writes a short and advances the file position"},"tell":{"path":"libs_cl/file.lua#L431","returns":[{"type":"number","value":"number The current file position","description":"The current file position"}],"realm":"client","class":"function","name":"tell","description":" Returns the current file position"},"readShort":{"path":"libs_cl/file.lua#L486","returns":[{"type":"number","value":"number Int16 number","description":"Int16 number"}],"realm":"client","class":"function","name":"readShort","description":" Reads a short and advances the file position"},"size":{"path":"libs_cl/file.lua#L437","returns":[{"type":"number","value":"number The file's size","description":"The file's size"}],"realm":"client","class":"function","name":"size","description":" Returns the file's size in bytes"}},"class":"type","name":"File","description":" File type"},"Quaternion":{"path":"libs_sh/quaternion.lua#L157","methods":{"getMatrix":{"path":"libs_sh/quaternion.lua#L668","returns":[{"type":"VMatrix","value":"VMatrix Transformation matrix","description":"Transformation matrix"}],"realm":"shared","params":[{"type":"boolean?","value":"boolean? Optional bool, normalizes the quaternion","name":"Optional","description":"bool, normalizes the quaternion"}],"class":"function","name":"getMatrix","description":" Converts quaternion to a matrix"},"getMod":{"path":"libs_sh/quaternion.lua#L624","returns":[{"type":"Quaternion","value":"Quaternion Quaternion with contained rotation","description":"Quaternion with contained rotation"}],"realm":"shared","class":"function","name":"getMod","description":" Gets the quaternion representing rotation contained within an angle between 0 and 180 degrees"},"__mul":{"path":"libs_sh/quaternion.lua#L275","returns":[{"type":"Quaternion","value":"Quaternion Product","description":"Product"}],"realm":"shared","params":[{"type":"Quaternion|number","value":"Quaternion|number lhs Left side of equation. Quaternion or number","name":"lhs","description":"Left side of equation. Quaternion or number"},{"type":"Quaternion|number","value":"Quaternion|number rhs Right side of equation. Quaternion or number","name":"rhs","description":"Right side of equation. Quaternion or number"}],"class":"function","name":"__mul","description":" Multiplication metamethod"},"getForward":{"path":"libs_sh/quaternion.lua#L570","returns":[{"type":"Vector","value":"Vector Vector pointing forward","description":"Vector pointing forward"}],"realm":"shared","class":"function","name":"getForward","description":" Calculates forward direction of the quaternion"},"__sub":{"path":"libs_sh/quaternion.lua#L407","returns":[{"type":"Quaternion","value":"Quaternion Difference","description":"Difference"}],"realm":"shared","params":[{"type":"Quaternion|number","value":"Quaternion|number lhs Left side of equation. Quaternion or number","name":"lhs","description":"Left side of equation. Quaternion or number"},{"type":"Quaternion|number","value":"Quaternion|number rhs Right side of equation. Quaternion or number","name":"rhs","description":"Right side of equation. Quaternion or number"}],"class":"function","name":"__sub","description":" Subtraction metamethod"},"__unm":{"path":"libs_sh/quaternion.lua#L428","returns":[{"type":"Quaternion","value":"Quaternion Negated quaternion","description":"Negated quaternion"}],"realm":"shared","class":"function","name":"__unm","description":" Unary minus metamethod"},"set":{"path":"libs_sh/quaternion.lua#L475","realm":"shared","params":[{"type":"Quaternion","value":"Quaternion quat Quaternion to copy from","name":"quat","description":"Quaternion to copy from"}],"class":"function","name":"set","description":" Copies components of the second quaternion to the first quaternion.\n Self-Modifies. Does not return anything"},"getRight":{"path":"libs_sh/quaternion.lua#L558","returns":[{"type":"Vector","value":"Vector Vector pointing right","description":"Vector pointing right"}],"realm":"shared","class":"function","name":"getRight","description":" Calculates right direction of the quaternion"},"getRotationVector":{"path":"libs_sh/quaternion.lua#L759","returns":[{"type":"Vector","value":"Vector Rotation vector","description":"Rotation vector"}],"realm":"shared","class":"function","name":"getRotationVector","description":" Returns the rotation vector - rotation axis where magnitude is the angle of rotation in degrees"},"__pow":{"path":"libs_sh/quaternion.lua#L349","returns":[{"type":"Quaternion","value":"Quaternion Power","description":"Power"}],"realm":"shared","params":[{"type":"Quaternion|number","value":"Quaternion|number lhs Left side of equation. Quaternion or number","name":"lhs","description":"Left side of equation. Quaternion or number"},{"type":"Quaternion|number","value":"Quaternion|number rhs Right side of equation. Quaternion or number","name":"rhs","description":"Right side of equation. Quaternion or number"}],"class":"function","name":"__pow","description":" Involution metamethod"},"__newindex":{"path":"libs_sh/quaternion.lua#L215","realm":"shared","params":[{"type":"number|string","value":"number|string Key","name":"Key","description":""},{"type":"number","value":"number Value to set","name":"Value","description":"to set"}],"class":"function","name":"__newindex","description":" Newindex metamethod"},"conjugate":{"path":"libs_sh/quaternion.lua#L604","realm":"shared","class":"function","name":"conjugate","description":" Conjugates the quaternion.\n Self-Modifies. Does not return anything"},"getExp":{"path":"libs_sh/quaternion.lua#L516","returns":[{"type":"Quaternion","value":"Quaternion Constant e raised to the quaternion","description":"Constant e raised to the quaternion"}],"realm":"shared","class":"function","name":"getExp","description":" Raises Euler's constant e to the quaternion's power"},"pack":{"path":"libs_sh/quaternion.lua#L450","realm":"shared","params":[{"type":"number","value":"number r R component","name":"r","description":"R component"},{"type":"number","value":"number i I component","name":"i","description":"I component"},{"type":"number","value":"number j J component","name":"j","description":"J component"},{"type":"number","value":"number k K component","name":"k","description":"K component"}],"class":"function","name":"pack","description":" Set components of the quaternion\n Self-Modifies. Does not return anything"},"getNormalized":{"path":"libs_sh/quaternion.lua#L638","returns":[{"type":"Quaternion","value":"Quaternion Normalized quaternion","description":"Normalized quaternion"}],"realm":"shared","class":"function","name":"getNormalized","description":" Returns new normalized quaternion"},"setK":{"path":"libs_sh/quaternion.lua#L506","returns":[{"type":"Quaternion","value":"Quaternion self","description":"self"}],"realm":"shared","params":[{"type":"number","value":"number k Value of the K component","name":"k","description":"Value of the K component"}],"class":"function","name":"setK","description":" Sets K component of the quaternion and returns self after modification"},"log":{"path":"libs_sh/quaternion.lua#L538","realm":"shared","class":"function","name":"log","description":" Calculates natural logarithm of the quaternion.\n Self-Modifies. Does not return anything"},"setR":{"path":"libs_sh/quaternion.lua#L482","returns":[{"type":"Quaternion","value":"Quaternion self","description":"self"}],"realm":"shared","params":[{"type":"number","value":"number r Value of the R component","name":"r","description":"Value of the R component"}],"class":"function","name":"setR","description":" Sets R (real) component of the quaternion and returns self after modification"},"getRotationAngle":{"path":"libs_sh/quaternion.lua#L723","returns":[{"type":"number","value":"number Angle number","description":"Angle number"}],"realm":"shared","params":[{"type":"boolean?","value":"boolean? full Optional bool, if true returned angle will be between -180 and 180, otherwise between 0 and 360","name":"full","description":"Optional bool, if true returned angle will be between -180 and 180, otherwise between 0 and 360"}],"class":"function","name":"getRotationAngle","description":" Returns the angle of rotation in degrees"},"mod":{"path":"libs_sh/quaternion.lua#L632","realm":"shared","class":"function","name":"mod","description":" Contains quaternion's represented rotation within an angle between 0 and 180 degrees.\n Self-Modifies. Does not return anything"},"getEulerAngle":{"path":"libs_sh/quaternion.lua#L692","returns":[{"type":"Angle","value":"Angle Angle object","description":"Angle object"}],"realm":"shared","class":"function","name":"getEulerAngle","description":" Returns the euler angle of rotation in degrees"},"getVector":{"path":"libs_sh/quaternion.lua#L661","returns":[{"type":"Vector","value":"Vector Vector from the quaternion","description":"Vector from the quaternion"}],"realm":"shared","class":"function","name":"getVector","description":" Converts quaternion to a vector by dropping the R (real) component"},"setI":{"path":"libs_sh/quaternion.lua#L490","returns":[{"type":"Quaternion","value":"Quaternion self","description":"self"}],"realm":"shared","params":[{"type":"number","value":"number i Value of the I component","name":"i","description":"Value of the I component"}],"class":"function","name":"setI","description":" Sets I component of the quaternion and returns self after modification"},"getNormSqr":{"path":"libs_sh/quaternion.lua#L590","returns":[{"type":"number","value":"number squared norm/absolute value","description":"squared norm/absolute value"}],"realm":"shared","class":"function","name":"getNormSqr","description":" Returns squared norm of the quaternion"},"getNorm":{"path":"libs_sh/quaternion.lua#L584","returns":[{"type":"number","value":"number norm value","description":"norm value"}],"realm":"shared","class":"function","name":"getNorm","description":" Returns norm of the quaternion"},"__index":{"path":"libs_sh/quaternion.lua#L248","returns":[{"type":"number","value":"number Found value","description":"Found value"}],"realm":"shared","params":[{"type":"number|string","value":"number|string Key","name":"Key","description":""}],"class":"function","name":"__index","description":" Index metamethod\n Can be indexed with: 1, 2, 3, 4, r, i, j, k, rr, ri, rj, rk, rrr, rijk, kjir, etc. Numerical lookup is the most efficient"},"dot":{"path":"libs_sh/quaternion.lua#L652","returns":[{"type":"number","value":"number The dot product","description":"The dot product"}],"realm":"shared","params":[{"type":"Quaternion","value":"Quaternion quat Second quaternion","name":"quat","description":"Second quaternion"}],"class":"function","name":"dot","description":" Returns dot product of two quaternions"},"normalize":{"path":"libs_sh/quaternion.lua#L646","realm":"shared","class":"function","name":"normalize","description":" Normalizes the quaternion.\n Self-Modifies. Does not return anything"},"setJ":{"path":"libs_sh/quaternion.lua#L498","returns":[{"type":"Quaternion","value":"Quaternion self","description":"self"}],"realm":"shared","params":[{"type":"number","value":"number j Value of the J component","name":"j","description":"Value of the J component"}],"class":"function","name":"setJ","description":" Sets J component of the quaternion and returns self after modification"},"clone":{"path":"libs_sh/quaternion.lua#L469","returns":[{"type":"Quaternion","value":"Quaternion Duplicate quaternion","description":"Duplicate quaternion"}],"realm":"shared","class":"function","name":"clone","description":" Creates a copy of the quaternion"},"getRotationAxis":{"path":"libs_sh/quaternion.lua#L746","returns":[{"type":"Vector","value":"Vector Vector axis","description":"Vector axis"}],"realm":"shared","class":"function","name":"getRotationAxis","description":" Returns the axis of rotation"},"__add":{"path":"libs_sh/quaternion.lua#L380","returns":[{"type":"Quaternion","value":"Quaternion Sum","description":"Sum"}],"realm":"shared","params":[{"type":"Quaternion|number","value":"Quaternion|number lhs Left side of equation. Quaternion or number","name":"lhs","description":"Left side of equation. Quaternion or number"},{"type":"Quaternion|number","value":"Quaternion|number rhs Right side of equation. Quaternion or number","name":"rhs","description":"Right side of equation. Quaternion or number"}],"class":"function","name":"__add","description":" Addition metamethod"},"getLog":{"path":"libs_sh/quaternion.lua#L530","returns":[{"type":"Quaternion","value":"Quaternion Logarithmic quaternion","description":"Logarithmic quaternion"}],"realm":"shared","class":"function","name":"getLog","description":" Calculates natural logarithm of the quaternion"},"exp":{"path":"libs_sh/quaternion.lua#L524","realm":"shared","class":"function","name":"exp","description":" Raises Euler's constant e to the quaternion's power.\n Self-Modifies. Does not return anything"},"inverse":{"path":"libs_sh/quaternion.lua#L618","realm":"shared","class":"function","name":"inverse","description":" Calculates inverse of the quaternion.\n Self-Modifies. Does not return anything"},"__eq":{"path":"libs_sh/quaternion.lua#L434","returns":[{"type":"boolean","value":"boolean True if both sides are equal","description":"True if both sides are equal"}],"realm":"shared","params":[{"type":"Quaternion","value":"Quaternion rhs Quaternion to compare to","name":"rhs","description":"Quaternion to compare to"}],"class":"function","name":"__eq","description":" Equivalence metamethod"},"getUp":{"path":"libs_sh/quaternion.lua#L546","returns":[{"type":"Vector","value":"Vector Vector pointing up","description":"Vector pointing up"}],"realm":"shared","class":"function","name":"getUp","description":" Calculates upward direction of the quaternion"},"__tostring":{"path":"libs_sh/quaternion.lua#L441","returns":[{"type":"string","value":"string Quaternion represented as a string","description":"Quaternion represented as a string"}],"realm":"shared","params":[{"type":"Quaternion","value":"Quaternion q Quaternion","name":"q","description":"Quaternion"}],"class":"function","name":"__tostring","description":" Tostring metamethod"},"unpack":{"path":"libs_sh/quaternion.lua#L460","returns":[{"type":"number","value":"number r","description":"r"},{"type":"number","value":"number i","description":"i"},{"type":"number","value":"number j","description":"j"},{"type":"number","value":"number k","description":"k"}],"realm":"shared","class":"function","name":"unpack","description":" Returns components of the quaternion"},"__div":{"path":"libs_sh/quaternion.lua#L314","returns":[{"type":"Quaternion","value":"Quaternion Quotient","description":"Quotient"}],"realm":"shared","params":[{"type":"Quaternion|number","value":"Quaternion|number lhs Left side of equation. Quaternion or number","name":"lhs","description":"Left side of equation. Quaternion or number"},{"type":"Quaternion|number","value":"Quaternion|number rhs Right side of equation. Quaternion or number","name":"rhs","description":"Right side of equation. Quaternion or number"}],"class":"function","name":"__div","description":" Division metamethod"},"getInverse":{"path":"libs_sh/quaternion.lua#L610","returns":[{"type":"Quaternion","value":"Quaternion Inverse of the quaternion","description":"Inverse of the quaternion"}],"realm":"shared","class":"function","name":"getInverse","description":" Calculates inverse of the quaternion"},"getConjugate":{"path":"libs_sh/quaternion.lua#L596","returns":[{"type":"Quaternion","value":"Quaternion Quaternion's conjugate","description":"Quaternion's conjugate"}],"realm":"shared","class":"function","name":"getConjugate","description":" Returns conjugate of the quaternion"}},"fields":[{"name":"r","description":"The r value of the quaternion. Can also be indexed with [1]"},{"name":"i","description":"The i value of the quaternion. Can also be indexed with [2]"},{"name":"j","description":"The j value of the quaternion. Can also be indexed with [3]"},{"name":"k","description":"The k value of the quaternion. Can also be indexed with [4]"}],"realm":"shared","libtbl":["quat_methods","quat_meta"],"class":"type","name":"Quaternion","description":" Quaternion type. Recently reworked, for full changelist visit: https://github.com/thegrb93/StarfallEx/pull/953"},"Effect":{"path":"libs_sh/effect.lua#L23","libtbl":["effect_methods"],"realm":"shared","methods":{"setAttachment":{"path":"libs_sh/effect.lua#L180","realm":"shared","params":[{"type":"number","value":"number attachment The new attachment ID of the effect","name":"attachment","description":"The new attachment ID of the effect"}],"class":"function","name":"setAttachment","description":" Sets the effect's attachment"},"setRadius":{"path":"libs_sh/effect.lua#L255","realm":"shared","params":[{"type":"number","value":"number radius The radius","name":"radius","description":"The radius"}],"class":"function","name":"setRadius","description":" Sets the effect's radius"},"getAttachment":{"path":"libs_sh/effect.lua#L84","returns":[{"type":"number","value":"number The effect's attachment ID","description":"The effect's attachment ID"}],"realm":"shared","class":"function","name":"getAttachment","description":" Returns the effect's attachment"},"getRadius":{"path":"libs_sh/effect.lua#L150","returns":[{"type":"number","value":"number The effect's radius","description":"The effect's radius"}],"realm":"shared","class":"function","name":"getRadius","description":" Returns the effect's radius"},"getScale":{"path":"libs_sh/effect.lua#L156","returns":[{"type":"number","value":"number The effect's scale","description":"The effect's scale"}],"realm":"shared","class":"function","name":"getScale","description":" Returns the effect's scale"},"getSurfaceProp":{"path":"libs_sh/effect.lua#L168","returns":[{"type":"number","value":"number The effect's surface property index","description":"The effect's surface property index"}],"realm":"shared","class":"function","name":"getSurfaceProp","description":" Returns the effect's surface prop"},"getMaterialIndex":{"path":"libs_sh/effect.lua#L132","returns":[{"type":"number","value":"number The effect's material index","description":"The effect's material index"}],"realm":"shared","class":"function","name":"getMaterialIndex","description":" Returns the effect's material index"},"setColor":{"path":"libs_sh/effect.lua#L187","realm":"shared","params":[{"type":"number","value":"number color The color represented by a byte 0-255.","name":"color","description":"The color represented by a byte 0-255."}],"class":"function","name":"setColor","description":" Sets the effect's color\n Internally stored as an integer, but only first 8 bits are networked, effectively limiting this function to 0-255 range."},"setOrigin":{"path":"libs_sh/effect.lua#L249","realm":"shared","params":[{"type":"Vector","value":"Vector origin The vector origin","name":"origin","description":"The vector origin"}],"class":"function","name":"setOrigin","description":" Sets the effect's origin"},"setMaterialIndex":{"path":"libs_sh/effect.lua#L236","realm":"shared","params":[{"type":"number","value":"number mat The material index","name":"mat","description":"The material index"}],"class":"function","name":"setMaterialIndex","description":" Sets the effect's material index"},"setSurfaceProp":{"path":"libs_sh/effect.lua#L276","realm":"shared","params":[{"type":"number","value":"number prop The surface property index","name":"prop","description":"The surface property index"}],"class":"function","name":"setSurfaceProp","description":" Sets the effect's surface property\n Internally stored as an integer, but only first 8 bits are networked, effectively limiting this function to -1-254 range.(yes, that's not a mistake)"},"getStart":{"path":"libs_sh/effect.lua#L162","returns":[{"type":"Vector","value":"Vector The effect's start position","description":"The effect's start position"}],"realm":"shared","class":"function","name":"getStart","description":" Returns the effect's start position"},"setHitBox":{"path":"libs_sh/effect.lua#L222","realm":"shared","params":[{"type":"number","value":"number hitbox The hitbox","name":"hitbox","description":"The hitbox"}],"class":"function","name":"setHitBox","description":" Sets the effect's hitbox"},"setNormal":{"path":"libs_sh/effect.lua#L243","realm":"shared","params":[{"type":"Vector","value":"Vector normal The vector normal","name":"normal","description":"The vector normal"}],"class":"function","name":"setNormal","description":" Sets the effect's normal"},"getColor":{"path":"libs_sh/effect.lua#L90","returns":[{"type":"number","value":"number The effect's color as a byte","description":"The effect's color as a byte"}],"realm":"shared","class":"function","name":"getColor","description":" Returns byte which represents the color of the effect."},"getOrigin":{"path":"libs_sh/effect.lua#L144","returns":[{"type":"Vector","value":"Vector The effect's origin","description":"The effect's origin"}],"realm":"shared","class":"function","name":"getOrigin","description":" Returns the effect's origin"},"setEntIndex":{"path":"libs_sh/effect.lua#L202","realm":"shared","params":[{"type":"number","value":"number index The entity index","name":"index","description":"The entity index"}],"class":"function","name":"setEntIndex","description":" Sets the effect's entity index"},"setStart":{"path":"libs_sh/effect.lua#L269","realm":"shared","params":[{"type":"Vector","value":"Vector start The vector start","name":"start","description":"The vector start"}],"class":"function","name":"setStart","description":" Sets the effect's start pos\n Limited to world bounds (+-16386 on every axis) and has horrible networking precision. (17 bit float per component)"},"play":{"path":"libs_sh/effect.lua#L63","realm":"shared","params":[{"type":"string","value":"string eff The effect type name to play","name":"eff","description":"The effect type name to play"}],"class":"function","name":"play","description":" Plays the effect"},"setMagnitude":{"path":"libs_sh/effect.lua#L229","realm":"shared","params":[{"type":"number","value":"number magnitude The magnitude","name":"magnitude","description":"The magnitude"}],"class":"function","name":"setMagnitude","description":" Sets the effect's magnitude"},"setAngles":{"path":"libs_sh/effect.lua#L174","realm":"shared","params":[{"type":"Angle","value":"Angle ang The angles","name":"ang","description":"The angles"}],"class":"function","name":"setAngles","description":" Sets the effect's angles"},"getEntity":{"path":"libs_sh/effect.lua#L108","returns":[{"type":"Entity","value":"Entity The effect's entity","description":"The effect's entity"}],"realm":"shared","class":"function","name":"getEntity","description":" Returns the effect's entity"},"getAngles":{"path":"libs_sh/effect.lua#L78","returns":[{"type":"Angle","value":"Angle The effect's angle","description":"The effect's angle"}],"realm":"shared","class":"function","name":"getAngles","description":" Returns the effect's angle"},"getHitBox":{"path":"libs_sh/effect.lua#L120","returns":[{"type":"number","value":"number The effect's hitbox ID","description":"The effect's hitbox ID"}],"realm":"shared","class":"function","name":"getHitBox","description":" Returns the effect's hitbox ID"},"setDamageType":{"path":"libs_sh/effect.lua#L195","realm":"shared","params":[{"type":"number","value":"number dmgtype The damage type, see the DMG enums","name":"dmgtype","description":"The damage type, see the DMG enums"}],"class":"function","name":"setDamageType","description":" Sets the effect's damage type"},"getNormal":{"path":"libs_sh/effect.lua#L138","returns":[{"type":"Vector","value":"Vector The effect's normal","description":"The effect's normal"}],"realm":"shared","class":"function","name":"getNormal","description":" Returns the effect's normal"},"getDamageType":{"path":"libs_sh/effect.lua#L96","returns":[{"type":"number","value":"number The effect's damagetype","description":"The effect's damagetype"}],"realm":"shared","class":"function","name":"getDamageType","description":" Returns the effect's damagetype"},"getFlags":{"path":"libs_sh/effect.lua#L114","returns":[{"type":"number","value":"number The effect's flags","description":"The effect's flags"}],"realm":"shared","class":"function","name":"getFlags","description":" Returns the effect's flags"},"setFlags":{"path":"libs_sh/effect.lua#L215","realm":"shared","params":[{"type":"number","value":"number flags The flags","name":"flags","description":"The flags"}],"class":"function","name":"setFlags","description":" Sets the effect's flags"},"getMagnitude":{"path":"libs_sh/effect.lua#L126","returns":[{"type":"number","value":"number The effect's magnitude","description":"The effect's magnitude"}],"realm":"shared","class":"function","name":"getMagnitude","description":" Returns the effect's magnitude"},"setEntity":{"path":"libs_sh/effect.lua#L209","realm":"shared","params":[{"type":"Entity","value":"Entity ent The entity","name":"ent","description":"The entity"}],"class":"function","name":"setEntity","description":" Sets the effect's entity"},"getEntIndex":{"path":"libs_sh/effect.lua#L102","returns":[{"type":"number","value":"number The effect's entindex","description":"The effect's entindex"}],"realm":"shared","class":"function","name":"getEntIndex","description":" Returns the effect's entindex"},"setScale":{"path":"libs_sh/effect.lua#L262","realm":"shared","params":[{"type":"number","value":"number scale The number scale","name":"scale","description":"The number scale"}],"class":"function","name":"setScale","description":" Sets the effect's scale"}},"class":"type","name":"Effect","description":" Effect type"},"Weapon":{"path":"libs_sh/weapons.lua#L6","libtbl":["weapon_methods","weapon_meta"],"realm":"shared","methods":{"getNextSecondaryFire":{"path":"libs_sh/weapons.lua#L83","returns":[{"type":"number","value":"number The time, relative to CurTime","description":"The time, relative to CurTime"}],"realm":"shared","class":"function","name":"getNextSecondaryFire","description":" Gets the next time the weapon can secondary fire."},"lastShootTime":{"path":"libs_sh/weapons.lua#L111","returns":[{"type":"number","value":"number Time the weapon was last shot","description":"Time the weapon was last shot"}],"realm":"shared","class":"function","name":"lastShootTime","description":" Returns the time since a weapon was last fired at a float variable"},"clip1":{"path":"libs_sh/weapons.lua#L34","returns":[{"type":"number","value":"number Amount of ammo","description":"Amount of ammo"}],"realm":"shared","class":"function","name":"clip1","description":" Returns Ammo in primary clip"},"maxClip1":{"path":"libs_sh/weapons.lua#L41","returns":[{"type":"number","value":"number Amount of ammo","description":"Amount of ammo"}],"realm":"shared","class":"function","name":"maxClip1","description":" Returns Maximum ammo in primary clip"},"getActivity":{"path":"libs_sh/weapons.lua#L62","returns":[{"type":"number","value":"number Current activity","description":"Current activity"}],"realm":"shared","class":"function","name":"getActivity","description":" Returns the sequence enumeration number that the weapon is playing. Must be used on a view model."},"maxClip2":{"path":"libs_sh/weapons.lua#L55","returns":[{"type":"number","value":"number Amount of ammo","description":"Amount of ammo"}],"realm":"shared","class":"function","name":"maxClip2","description":" Returns Maximum ammo in secondary clip"},"getNextPrimaryFire":{"path":"libs_sh/weapons.lua#L76","returns":[{"type":"number","value":"number The time, relative to CurTime","description":"The time, relative to CurTime"}],"realm":"shared","class":"function","name":"getNextPrimaryFire","description":" Gets the next time the weapon can primary fire."},"isCarriedByLocalPlayer":{"path":"libs_sh/weapons.lua#L134","returns":[{"type":"boolean","value":"boolean Whether or not the weapon is carried by the local player","description":"Whether or not the weapon is carried by the local player"}],"realm":"client","class":"function","name":"isCarriedByLocalPlayer","description":" Returns if the weapon is carried by the local player."},"getPrintName":{"path":"libs_sh/weapons.lua#L127","returns":[{"type":"string","value":"string Display name of weapon","description":"Display name of weapon"}],"realm":"client","class":"function","name":"getPrintName","description":" Gets Display name of weapon"},"getToolMode":{"path":"libs_sh/weapons.lua#L118","returns":[{"type":"string","value":"string The tool mode of the toolgun","description":"The tool mode of the toolgun"}],"realm":"shared","class":"function","name":"getToolMode","description":" Returns the tool mode of the toolgun"},"isWeaponVisible":{"path":"libs_sh/weapons.lua#L104","returns":[{"type":"boolean","value":"boolean Whether the weapon is visible or not","description":"Whether the weapon is visible or not"}],"realm":"shared","class":"function","name":"isWeaponVisible","description":" Returns whether the weapon is visible"},"clip2":{"path":"libs_sh/weapons.lua#L48","returns":[{"type":"number","value":"number Amount of ammo","description":"Amount of ammo"}],"realm":"shared","class":"function","name":"clip2","description":" Returns Ammo in secondary clip"},"getSecondaryAmmoType":{"path":"libs_sh/weapons.lua#L97","returns":[{"type":"number","value":"number Ammo number type","description":"Ammo number type"}],"realm":"shared","class":"function","name":"getSecondaryAmmoType","description":" Gets the secondary ammo type of the given weapon."},"getHoldType":{"path":"libs_sh/weapons.lua#L69","returns":[{"type":"string","value":"string Holdtype","description":"Holdtype"}],"realm":"shared","class":"function","name":"getHoldType","description":" Returns the hold type of the weapon."},"getPrimaryAmmoType":{"path":"libs_sh/weapons.lua#L90","returns":[{"type":"number","value":"number Ammo number type","description":"Ammo number type"}],"realm":"shared","class":"function","name":"getPrimaryAmmoType","description":" Gets the primary ammo type of the given weapon."}},"class":"type","name":"Weapon","description":" Weapon type"},"Particle":{"path":"libs_cl/particle.lua#L25","libtbl":["particle_methods"],"realm":"client","methods":{"setVelocity":{"path":"libs_cl/particle.lua#L295","realm":"client","params":[{"type":"Vector","value":"Vector vel Velocity to set to","name":"vel","description":"Velocity to set to"}],"class":"function","name":"setVelocity","description":" Sets the velocity of the particle."},"setAngleVelocity":{"path":"libs_cl/particle.lua#L235","realm":"client","params":[{"type":"Angle","value":"Angle angVel Angular velocity to set the particle's to","name":"angVel","description":"Angular velocity to set the particle's to"}],"class":"function","name":"setAngleVelocity","description":" Sets the angular velocity of the the particle."},"getPos":{"path":"libs_cl/particle.lua#L211","returns":[{"type":"Vector","value":"Vector Position of the particle","description":"Position of the particle"}],"realm":"client","class":"function","name":"getPos","description":" Returns the absolute position of the particle."},"getAngles":{"path":"libs_cl/particle.lua#L193","returns":[{"type":"Angle","value":"Angle Angles of the particle","description":"Angles of the particle"}],"realm":"client","class":"function","name":"getAngles","description":" Returns the current orientation of the particle."},"setBounce":{"path":"libs_cl/particle.lua#L241","realm":"client","params":[{"type":"number","value":"number bounce Bounciness to set to","name":"bounce","description":"Bounciness to set to"}],"class":"function","name":"setBounce","description":" Sets the 'bounciness' of the the particle."},"setPos":{"path":"libs_cl/particle.lua#L275","realm":"client","params":[{"type":"Vector","value":"Vector pos Vector position to set to","name":"pos","description":"Vector position to set to"}],"class":"function","name":"setPos","description":" Sets the absolute position of the particle."},"getRoll":{"path":"libs_cl/particle.lua#L217","returns":[{"type":"number","value":"number Roll","description":"Roll"}],"realm":"client","class":"function","name":"getRoll","description":" Returns the current rotation of the particle in radians, this should only be used for 2D particles."},"setRoll":{"path":"libs_cl/particle.lua#L281","realm":"client","params":[{"type":"number","value":"number roll Roll","name":"roll","description":"Roll"}],"class":"function","name":"setRoll","description":" Sets the roll of the particle in radians. This should only be used for 2D particles."},"getAngleVelocity":{"path":"libs_cl/particle.lua#L199","returns":[{"type":"Angle","value":"Angle Angular velocity of the particle","description":"Angular velocity of the particle"}],"realm":"client","class":"function","name":"getAngleVelocity","description":" Returns the angular velocity of the particle"},"setAngles":{"path":"libs_cl/particle.lua#L229","realm":"client","params":[{"type":"Angle","value":"Angle ang Angles to set the particle's angles to","name":"ang","description":"Angles to set the particle's angles to"}],"class":"function","name":"setAngles","description":" Sets the angles of the particle."},"setVelocityScale":{"path":"libs_cl/particle.lua#L314","realm":"client","params":[{"type":"boolean","value":"boolean doScale Whether it should scale","name":"doScale","description":"Whether it should scale"}],"class":"function","name":"setVelocityScale","description":" Scales the velocity based on the particle speed."},"getVelocity":{"path":"libs_cl/particle.lua#L223","returns":[{"type":"Vector","value":"Vector Velocity","description":"Velocity"}],"realm":"client","class":"function","name":"getVelocity","description":" Returns the current velocity of the particle."},"setRollDelta":{"path":"libs_cl/particle.lua#L288","realm":"client","params":[{"type":"number","value":"number rollDelta Rolldelta","name":"rollDelta","description":"Rolldelta"}],"class":"function","name":"setRollDelta","description":" Sets the rotation speed of the particle in radians. This should only be used for 2D particles."},"setGravity":{"path":"libs_cl/particle.lua#L308","realm":"client","params":[{"type":"Vector","value":"Vector gravity Directional gravity","name":"gravity","description":"Directional gravity"}],"class":"function","name":"setGravity","description":" Sets the directional gravity aka. acceleration of the particle."},"setAirResistance":{"path":"libs_cl/particle.lua#L301","realm":"client","params":[{"type":"number","value":"number airResistance AirResistance to set to","name":"airResistance","description":"AirResistance to set to"}],"class":"function","name":"setAirResistance","description":" Sets the air resistance of the the particle."},"setColor":{"path":"libs_cl/particle.lua#L255","realm":"client","params":[{"type":"Color","value":"Color col Color to set to","name":"col","description":"Color to set to"}],"class":"function","name":"setColor","description":" Sets the color of the particle."},"setMaterial":{"path":"libs_cl/particle.lua#L269","realm":"client","params":[{"type":"Material","value":"Material mat Material to set","name":"mat","description":"Material to set"}],"class":"function","name":"setMaterial","description":" Sets the material of the particle."},"setCollide":{"path":"libs_cl/particle.lua#L248","realm":"client","params":[{"type":"boolean","value":"boolean shouldCollide Whether it should collide","name":"shouldCollide","description":"Whether it should collide"}],"class":"function","name":"setCollide","description":" Sets the whether the particle should collide with the world or not."},"setLighting":{"path":"libs_cl/particle.lua#L262","realm":"client","params":[{"type":"boolean","value":"boolean useLighting Whether the particle should be affected by lighting","name":"useLighting","description":"Whether the particle should be affected by lighting"}],"class":"function","name":"setLighting","description":" Sets whether the particle should be affected by lighting."},"getColor":{"path":"libs_cl/particle.lua#L205","returns":[{"type":"Color","value":"Color Color of the particle","description":"Color of the particle"}],"realm":"client","class":"function","name":"getColor","description":" Returns the color of the particle."}},"class":"type","name":"Particle","description":" Particle type"},"PhysObj":{"path":"libs_sh/physobj.lua#L22","libtbl":["physobj_methods"],"realm":"shared","methods":{"localToWorld":{"path":"libs_sh/physobj.lua#L150","returns":[{"type":"Vector","value":"Vector The transformed vector","description":"The transformed vector"}],"realm":"shared","params":[{"type":"Vector","value":"Vector vec The vector to transform","name":"vec","description":"The vector to transform"}],"class":"function","name":"localToWorld","description":" Returns a vector in the reference frame of the world from the local frame of the physicsobject"},"setDamping":{"path":"libs_sh/physobj.lua#L494","realm":"shared","params":[{"type":"number","value":"number linear Number of the linear damping","name":"linear","description":"Number of the linear damping"},{"type":"number","value":"number angular Number of the angular damping","name":"angular","description":"Number of the angular damping"}],"class":"function","name":"setDamping","description":" Sets the movement damping of the bone. Unlike air drag, it doesn't take into account the cross-section of the object."},"getMatrix":{"path":"libs_sh/physobj.lua#L61","returns":[{"type":"VMatrix","value":"VMatrix The matrix","description":"The matrix"}],"realm":"shared","class":"function","name":"getMatrix","description":" Returns the world transform matrix of the physobj"},"setAngleVelocity":{"path":"libs_sh/physobj.lua#L324","realm":"server","params":[{"type":"Vector","value":"Vector angvel The local angvel vector to set","name":"angvel","description":"The local angvel vector to set"}],"class":"function","name":"setAngleVelocity","description":" Sets the angular velocity of an object"},"getPos":{"path":"libs_sh/physobj.lua#L54","returns":[{"type":"Vector","value":"Vector Vector position of the physics object","description":"Vector position of the physics object"}],"realm":"shared","class":"function","name":"getPos","description":" Gets the position of the physics object"},"getAngles":{"path":"libs_sh/physobj.lua#L68","returns":[{"type":"Angle","value":"Angle Angle angles of the physics object","description":"Angle angles of the physics object"}],"realm":"shared","class":"function","name":"getAngles","description":" Gets the angles of the physics object"},"addGameFlags":{"path":"libs_sh/physobj.lua#L395","realm":"shared","params":[{"type":"number","value":"number flags The flags to add. FVPHYSICS enum.","name":"flags","description":"The flags to add. FVPHYSICS enum."}],"class":"function","name":"addGameFlags","description":" Adds game flags to the physics object. Some flags cannot be modified. Can be:\n FVPHYSICS.DMG_DISSOLVE\n FVPHYSICS.DMG_SLICE\n FVPHYSICS.HEAVY_OBJECT\n FVPHYSICS.NO_IMPACT_DMG\n FVPHYSICS.NO_NPC_IMPACT_DMG\n FVPHYSICS.NO_PLAYER_PICKUP"},"enableMotion":{"path":"libs_sh/physobj.lua#L507","realm":"shared","params":[{"type":"boolean","value":"boolean move Should the bone move?","name":"move","description":"Should the bone move?"}],"class":"function","name":"enableMotion","description":" Sets the bone movement state"},"calculateVelocityOffset":{"path":"libs_sh/physobj.lua#L596","returns":[{"type":"Vector","value":"Vector The calculated linear velocity from the impulse on the physics object's center of mass in source_unit/s. (World frame)","description":"The calculated linear velocity from the impulse on the physics object's center of mass in source_unit/s. (World frame)"},{"type":"Vector","value":"Vector The calculated angular velocity from the impulse on the physics object's center of mass in degrees/s. (Local frame)","description":"The calculated angular velocity from the impulse on the physics object's center of mass in degrees/s. (Local frame)"}],"realm":"server","params":[{"type":"Vector","value":"Vector impulse The impulse acting on the object in world coordinates (kg*source_unit/s)","name":"impulse","description":"The impulse acting on the object in world coordinates (kg*source_unit/s)"},{"type":"Vector","value":"Vector position The location of the impulse in world coordinates","name":"position","description":"The location of the impulse in world coordinates"}],"class":"function","name":"calculateVelocityOffset","description":" Calculates the linear and angular velocities on the center of mass for an offset impulse.\n The outputs can be directly passed to PhysObj:addVelocity and PhysObj:addAngleVelocity, respectively."},"setPos":{"path":"libs_sh/physobj.lua#L219","realm":"server","params":[{"type":"Vector","value":"Vector pos The position vector to set it to","name":"pos","description":"The position vector to set it to"}],"class":"function","name":"setPos","description":" Sets the position of the physics object. Will cause interpolation of the entity in clientside, use entity.setPos to avoid this."},"isDragEnabled":{"path":"libs_sh/physobj.lua#L461","returns":[{"type":"boolean","value":"boolean If bone is affected by drag","description":"If bone is affected by drag"}],"realm":"shared","class":"function","name":"isDragEnabled","description":" Check if bone is affected by air resistance"},"setAngleDragCoefficient":{"path":"libs_sh/physobj.lua#L477","realm":"shared","params":[{"type":"number","value":"number coeff How much drag affects the bone when rotating","name":"coeff","description":"How much drag affects the bone when rotating"}],"class":"function","name":"setAngleDragCoefficient","description":" Sets coefficient of air resistance affecting the bone when rotating. Air resistance depends on the cross-section of the object."},"setContents":{"path":"libs_sh/physobj.lua#L285","realm":"server","params":[{"type":"number","value":"number contents The CONTENTS enum","name":"contents","description":"The CONTENTS enum"}],"class":"function","name":"setContents","description":" Sets the contents flag of the physobject"},"applyTorque":{"path":"libs_sh/physobj.lua#L350","realm":"server","params":[{"type":"Vector","value":"Vector torque The world torque vector to apply","name":"torque","description":"The world torque vector to apply"}],"class":"function","name":"applyTorque","description":" Applies a torque to a physics object"},"calculateForceOffset":{"path":"libs_sh/physobj.lua#L574","returns":[{"type":"Vector","value":"Vector The calculated linear impulse on the physics object's center of mass in kg*source_unit/s. (World frame)","description":"The calculated linear impulse on the physics object's center of mass in kg*source_unit/s. (World frame)"},{"type":"Vector","value":"Vector The calculated angular impulse on the physics object's center of mass in kg*m^2*degrees/s. (Local frame)","description":"The calculated angular impulse on the physics object's center of mass in kg*m^2*degrees/s. (Local frame)"}],"realm":"server","params":[{"type":"Vector","value":"Vector impulse The impulse acting on the object in world coordinates (kg*source_unit/s)","name":"impulse","description":"The impulse acting on the object in world coordinates (kg*source_unit/s)"},{"type":"Vector","value":"Vector position The location of the impulse in world coordinates","name":"position","description":"The location of the impulse in world coordinates"}],"class":"function","name":"calculateForceOffset","description":" Calculates the linear and angular impulse on the object's center of mass for an offset impulse.\n The outputs can be used with PhysObj:applyForceCenter and PhysObj:applyTorque, respectively.\n\n Be careful to convert the angular impulse to world frame (PhysObj:localToWorldVector)\n if you are going to use it with applyTorque."},"getVelocity":{"path":"libs_sh/physobj.lua#L75","returns":[{"type":"Vector","value":"Vector Vector velocity of the physics object","description":"Vector velocity of the physics object"}],"realm":"shared","class":"function","name":"getVelocity","description":" Gets the velocity of the physics object"},"getStress":{"path":"libs_sh/physobj.lua#L566","returns":[{"type":"number","value":"number External stress. Usually about the mass of the object if on the ground, usually 0 if in freefall.","description":"External stress. Usually about the mass of the object if on the ground, usually 0 if in freefall."},{"type":"number","value":"number Internal stress. Usually about the mass of every object resting on top of it combined.","description":"Internal stress. Usually about the mass of every object resting on top of it combined."}],"realm":"server","class":"function","name":"getStress","description":" Returns the stress of the entity."},"worldToLocal":{"path":"libs_sh/physobj.lua#L143","returns":[{"type":"Vector","value":"Vector The transformed vector","description":"The transformed vector"}],"realm":"shared","params":[{"type":"Vector","value":"Vector vec The vector to transform","name":"vec","description":"The vector to transform"}],"class":"function","name":"worldToLocal","description":" Returns a vector in the local reference frame of the physicsobject from the world frame"},"sleep":{"path":"libs_sh/physobj.lua#L524","realm":"server","class":"function","name":"sleep","description":" Makes a physobj go to sleep. (like it's frozen but interacting wakes it back up)"},"getFrictionSnapshot":{"path":"libs_sh/physobj.lua#L540","returns":[{"type":"table","value":"table Table of tables of data. Each table will contain:","description":"Table of tables of data. Each table will contain:"}],"realm":"server","class":"function","name":"getFrictionSnapshot","description":" Returns table of tables of friction data of a contact against the physobj\n PhysObj Other - The other physics object we came in contact with\n number EnergyAbsorbed -\n number FrictionCoefficient -\n number NormalForce -\n Vector Normal - Direction of the friction event\n Vector ContactPoint - Contact point of the friction event\n number Material - Surface Property ID of our physics obj\n number MaterialOther - Surface Property ID of the physics obj we came in contact with"},"setDragCoefficient":{"path":"libs_sh/physobj.lua#L468","realm":"shared","params":[{"type":"number","value":"number coeff How much drag affects the bone","name":"coeff","description":"How much drag affects the bone"}],"class":"function","name":"setDragCoefficient","description":" Sets coefficient of air resistance affecting the bone. Air resistance depends on the cross-section of the object."},"getMassCenter":{"path":"libs_sh/physobj.lua#L122","returns":[{"type":"Vector","value":"Vector Center of mass vector in the physobject's local reference frame.","description":"Center of mass vector in the physobject's local reference frame."}],"realm":"shared","class":"function","name":"getMassCenter","description":" Gets the center of mass of the physics object in the local reference frame."},"getVolume":{"path":"libs_sh/physobj.lua#L559","returns":[{"type":"number?","value":"number? The volume or nil if the PhysObj is a generated sphere or box.","description":"The volume or nil if the PhysObj is a generated sphere or box."}],"realm":"shared","class":"function","name":"getVolume","description":" Returns the volume in source units cubed. Or nil if the PhysObj is a generated sphere or box."},"getMesh":{"path":"libs_sh/physobj.lua#L171","returns":[{"type":"table","value":"table Table of MeshVertex structures","description":"Table of MeshVertex structures"}],"realm":"shared","class":"function","name":"getMesh","description":" Returns a table of MeshVertex structures where each 3 vertices represent a triangle. See: http://wiki.facepunch.com/gmod/Structures/MeshVertex"},"addAngleVelocity":{"path":"libs_sh/physobj.lua#L337","realm":"server","params":[{"type":"Vector","value":"Vector angvel The local angvel vector to apply","name":"angvel","description":"The local angvel vector to apply"}],"class":"function","name":"addAngleVelocity","description":" Applies a angular velocity to an object"},"isAsleep":{"path":"libs_sh/physobj.lua#L516","returns":[{"type":"boolean","value":"boolean If the physobj is asleep","description":"If the physobj is asleep"}],"realm":"server","class":"function","name":"isAsleep","description":" Returns whether the physobj is asleep"},"getLocalVelocity":{"path":"libs_sh/physobj.lua#L82","returns":[{"type":"Vector","value":"Vector Vector velocity of the physics object local to itself","description":"Vector velocity of the physics object local to itself"}],"realm":"shared","class":"function","name":"getLocalVelocity","description":" Gets the velocity of the physics object in coordinates local to itself"},"applyForceOffset":{"path":"libs_sh/physobj.lua#L308","realm":"server","params":[{"type":"Vector","value":"Vector force The force vector in world coordinates","name":"force","description":"The force vector in world coordinates"},{"type":"Vector","value":"Vector position The force position in world coordinates","name":"position","description":"The force position in world coordinates"}],"class":"function","name":"applyForceOffset","description":" Applies an offset force to a physics object"},"setBuoyancyRatio":{"path":"libs_sh/physobj.lua#L270","realm":"server","params":[{"type":"number","value":"number ratio The buoyancy ratio to use","name":"ratio","description":"The buoyancy ratio to use"}],"class":"function","name":"setBuoyancyRatio","description":" Sets the buoyancy ratio of a physobject"},"setMaterial":{"path":"libs_sh/physobj.lua#L185","realm":"shared","params":[{"type":"string","value":"string materialName The physical material to set it to","name":"materialName","description":"The physical material to set it to"}],"class":"function","name":"setMaterial","description":" Sets the physical material of a physics object"},"isMoveable":{"path":"libs_sh/physobj.lua#L204","returns":[{"type":"boolean","value":"boolean Whether the object is moveable","description":"Whether the object is moveable"}],"realm":"shared","class":"function","name":"isMoveable","description":" Returns whether the entity is able to move.\n Inverse of Entity:isFrozen"},"getMass":{"path":"libs_sh/physobj.lua#L115","returns":[{"type":"number","value":"number Mass of the physics object","description":"Mass of the physics object"}],"realm":"shared","class":"function","name":"getMass","description":" Gets the mass of the physics object"},"isValid":{"path":"libs_sh/physobj.lua#L40","returns":[{"type":"boolean","value":"boolean If the physics object is valid","description":"If the physics object is valid"}],"realm":"shared","class":"function","name":"isValid","description":" Checks if the physics object is valid"},"wake":{"path":"libs_sh/physobj.lua#L532","realm":"server","class":"function","name":"wake","description":" Makes a sleeping physobj wakeup"},"localToWorldVector":{"path":"libs_sh/physobj.lua#L164","returns":[{"type":"Vector","value":"Vector The transformed vector","description":"The transformed vector"}],"realm":"shared","params":[{"type":"Vector","value":"Vector vec The normal vector to transform","name":"vec","description":"The normal vector to transform"}],"class":"function","name":"localToWorldVector","description":" Returns a normal vector in the reference frame of the world from the local frame of the physicsobject"},"enableDrag":{"path":"libs_sh/physobj.lua#L453","realm":"shared","params":[{"type":"boolean","value":"boolean drag Should the bone have air resistance?","name":"drag","description":"Should the bone have air resistance?"}],"class":"function","name":"enableDrag","description":" Sets the bone drag state"},"addVelocity":{"path":"libs_sh/physobj.lua#L258","realm":"server","params":[{"type":"Vector","value":"Vector vel The world velocity vector to apply","name":"vel","description":"The world velocity vector to apply"}],"class":"function","name":"addVelocity","description":" Applies velocity to an object"},"applyForceCenter":{"path":"libs_sh/physobj.lua#L295","realm":"server","params":[{"type":"Vector","value":"Vector force The force vector to apply","name":"force","description":"The force vector to apply"}],"class":"function","name":"applyForceCenter","description":" Applies a force to the center of the physics object"},"getVelocityAtPoint":{"path":"libs_sh/physobj.lua#L99","returns":[{"type":"Vector","value":"Vector Vector Local velocity of the physics object at the point","description":"Vector Local velocity of the physics object at the point"}],"realm":"shared","params":[{"type":"Vector","value":"Vector vec The point to get velocity of in local reference frame","name":"vec","description":"The point to get velocity of in local reference frame"}],"class":"function","name":"getVelocityAtPoint","description":" Gets the velocity of the physics object at an arbitrary point in its local reference frame\n This includes velocity at the point induced by rotational velocity"},"isGravityEnabled":{"path":"libs_sh/physobj.lua#L211","returns":[{"type":"boolean","value":"boolean Whether the object is affect gravity","description":"Whether the object is affect gravity"}],"realm":"shared","class":"function","name":"isGravityEnabled","description":" Returns whether the entity is affected by gravity."},"getAngleVelocity":{"path":"libs_sh/physobj.lua#L108","returns":[{"type":"Vector","value":"Vector Vector angular velocity of the physics object","description":"Vector angular velocity of the physics object"}],"realm":"shared","class":"function","name":"getAngleVelocity","description":" Gets the angular velocity of the physics object"},"setInertia":{"path":"libs_sh/physobj.lua#L376","realm":"server","params":[{"type":"Vector","value":"Vector inertia The inertia vector to set it to","name":"inertia","description":"The inertia vector to set it to"}],"class":"function","name":"setInertia","description":" Sets the inertia of a physics object"},"setAngles":{"path":"libs_sh/physobj.lua#L232","realm":"server","params":[{"type":"Angle","value":"Angle ang The angle to set it to","name":"ang","description":"The angle to set it to"}],"class":"function","name":"setAngles","description":" Sets the angles of the physics object. Will cause interpolation of the entity in clientside, use entity.setAngles to avoid this."},"getEntity":{"path":"libs_sh/physobj.lua#L47","returns":[{"type":"Entity","value":"Entity The entity attached to the physics object","description":"The entity attached to the physics object"}],"realm":"shared","class":"function","name":"getEntity","description":" Gets the entity attached to the physics object"},"enableGravity":{"path":"libs_sh/physobj.lua#L444","realm":"shared","params":[{"type":"boolean","value":"boolean grav Should the bone respect gravity?","name":"grav","description":"Should the bone respect gravity?"}],"class":"function","name":"enableGravity","description":" Sets bone gravity"},"getDamping":{"path":"libs_sh/physobj.lua#L486","returns":[{"type":"number","value":"number Linear damping","description":"Linear damping"},{"type":"number","value":"number Angular damping","description":"Angular damping"}],"realm":"shared","class":"function","name":"getDamping","description":" Returns Movement damping of the bone."},"clearGameFlags":{"path":"libs_sh/physobj.lua#L415","realm":"shared","params":[{"type":"number","value":"number flags The flags to clear. FVPHYSICS enum.","name":"flags","description":"The flags to clear. FVPHYSICS enum."}],"class":"function","name":"clearGameFlags","description":" Clears game flags from the physics object. Some flags cannot be modified. Can be:\n FVPHYSICS.DMG_DISSOLVE\n FVPHYSICS.DMG_SLICE\n FVPHYSICS.HEAVY_OBJECT\n FVPHYSICS.NO_IMPACT_DMG\n FVPHYSICS.NO_NPC_IMPACT_DMG\n FVPHYSICS.NO_PLAYER_PICKUP"},"setMass":{"path":"libs_sh/physobj.lua#L363","realm":"server","params":[{"type":"number","value":"number mass The mass to set it to","name":"mass","description":"The mass to set it to"}],"class":"function","name":"setMass","description":" Sets the mass of a physics object"},"hasGameFlags":{"path":"libs_sh/physobj.lua#L435","returns":[{"type":"boolean","value":"boolean If the flags are set","description":"If the flags are set"}],"realm":"shared","params":[{"type":"number","value":"number flags The flags to test. FVPHYSICS enum.","name":"flags","description":"The flags to test. FVPHYSICS enum."}],"class":"function","name":"hasGameFlags","description":" Returns whether the game flags of the physics object are set."},"getMaterial":{"path":"libs_sh/physobj.lua#L136","returns":[{"type":"string","value":"string The physics material of the physics object","description":"The physics material of the physics object"}],"realm":"shared","class":"function","name":"getMaterial","description":" Gets the material of the physics object"},"worldToLocalVector":{"path":"libs_sh/physobj.lua#L157","returns":[{"type":"Vector","value":"Vector The transformed vector","description":"The transformed vector"}],"realm":"shared","params":[{"type":"Vector","value":"Vector vec The normal vector to transform","name":"vec","description":"The normal vector to transform"}],"class":"function","name":"worldToLocalVector","description":" Returns a normal vector in the local reference frame of the physicsobject from the world frame"},"getSurfaceArea":{"path":"libs_sh/physobj.lua#L198","returns":[{"type":"number?","value":"number? Surface area, or nil if a generated sphere or box","description":"Surface area, or nil if a generated sphere or box"}],"realm":"shared","class":"function","name":"getSurfaceArea","description":" Returns the surface area of the object in Hammer units squared."},"getAABB":{"path":"libs_sh/physobj.lua#L90","returns":[{"type":"Vector","value":"Vector The mins of the AABB","description":"The mins of the AABB"},{"type":"Vector","value":"Vector The maxs of the AABB","description":"The maxs of the AABB"}],"realm":"shared","class":"function","name":"getAABB","description":" Gets the axis aligned bounding box of the physics object"},"getMeshConvexes":{"path":"libs_sh/physobj.lua#L178","returns":[{"type":"table","value":"table Table of MeshVertex structures","description":"Table of MeshVertex structures"}],"realm":"shared","class":"function","name":"getMeshConvexes","description":" Returns a structured table, the physics mesh of the physics object. See: http://wiki.facepunch.com/gmod/Structures/MeshVertex"},"getInertia":{"path":"libs_sh/physobj.lua#L129","returns":[{"type":"Vector","value":"Vector Vector Inertia of the physics object","description":"Vector Inertia of the physics object"}],"realm":"shared","class":"function","name":"getInertia","description":" Gets the inertia of the physics object"},"setVelocity":{"path":"libs_sh/physobj.lua#L245","realm":"server","params":[{"type":"Vector","value":"Vector vel The velocity vector to set it to","name":"vel","description":"The velocity vector to set it to"}],"class":"function","name":"setVelocity","description":" Sets the velocity of the physics object"}},"class":"type","name":"PhysObj","description":" PhysObj Type"},"VMatrix":{"path":"libs_sh/vmatrix.lua#L6","libtbl":["vmatrix_methods","vmatrix_meta"],"realm":"shared","methods":{"setRight":{"path":"libs_sh/vmatrix.lua#L172","realm":"shared","params":[{"type":"Vector","value":"Vector right The right vector","name":"right","description":"The right vector"}],"class":"function","name":"setRight","description":" Sets the right direction of the matrix. Negated second column\n Self-Modifies. Does not return anything"},"invert":{"path":"libs_sh/vmatrix.lua#L239","returns":[{"type":"boolean","value":"boolean Whether the matrix was inverted or not","description":"Whether the matrix was inverted or not"}],"realm":"shared","class":"function","name":"invert","description":" Inverts the matrix. Inverting the matrix will fail if its determinant is 0 or close to 0\n Self-Modifies."},"getInverse":{"path":"libs_sh/vmatrix.lua#L99","returns":[{"type":"VMatrix","value":"VMatrix Inverted matrix","description":"Inverted matrix"}],"realm":"shared","class":"function","name":"getInverse","description":" Returns an inverted matrix. Inverting the matrix will fail if its determinant is 0 or close to 0"},"setForward":{"path":"libs_sh/vmatrix.lua#L165","realm":"shared","params":[{"type":"Vector","value":"Vector forward The forward vector","name":"forward","description":"The forward vector"}],"class":"function","name":"setForward","description":" Sets the forward direction of the matrix. First column\n Self-Modifies. Does not return anything"},"getAngles":{"path":"libs_sh/vmatrix.lua#L56","returns":[{"type":"Angle","value":"Angle Angles","description":"Angles"}],"realm":"shared","class":"function","name":"getAngles","description":" Returns angles"},"__mul":{"path":"libs_sh/vmatrix.lua#L360","returns":[{"type":"VMatrix","value":"VMatrix Result matrix","description":"Result matrix"}],"realm":"shared","params":[{"type":"VMatrix","value":"VMatrix lhs Matrix multiplicand","name":"lhs","description":"Matrix multiplicand"},{"type":"VMatrix|Vector","value":"VMatrix|Vector rhs Matrix or Vector multiplier","name":"rhs","description":"Matrix or Vector multiplier"}],"class":"function","name":"__mul","description":" Multiplies two matrices (Left must be a VMatrix)"},"getScale":{"path":"libs_sh/vmatrix.lua#L62","returns":[{"type":"Vector","value":"Vector Scale","description":"Scale"}],"realm":"shared","class":"function","name":"getScale","description":" Returns scale"},"getForward":{"path":"libs_sh/vmatrix.lua#L111","returns":[{"type":"Vector","value":"Vector Translation","description":"Translation"}],"realm":"shared","class":"function","name":"getForward","description":" Returns forward vector of matrix. First matrix column"},"__sub":{"path":"libs_sh/vmatrix.lua#L352","returns":[{"type":"VMatrix","value":"VMatrix Subtracted matrix","description":"Subtracted matrix"}],"realm":"shared","params":[{"type":"VMatrix","value":"VMatrix lhs Initial Matrix","name":"lhs","description":"Initial Matrix"},{"type":"VMatrix","value":"VMatrix rhs Matrix to subtract from the first","name":"rhs","description":"Matrix to subtract from the first"}],"class":"function","name":"__sub","description":" Subtracts two matrices (why would you do this?)"},"setAxisAngle":{"path":"libs_sh/vmatrix.lua#L264","realm":"shared","params":[{"type":"Vector","value":"Vector axis The normalized axis of rotation","name":"axis","description":"The normalized axis of rotation"},{"type":"number","value":"number angle The angle of rotation in radians","name":"angle","description":"The angle of rotation in radians"}],"class":"function","name":"setAxisAngle","description":" Sets the rotation or the matrix to the rotation by an axis and angle\n Self-Modifies. Does not return anything"},"getField":{"path":"libs_sh/vmatrix.lua#L74","returns":[{"type":"number","value":"number Value of the specified field","description":"Value of the specified field"}],"realm":"shared","params":[{"type":"number","value":"number row A number from 1 to 4","name":"row","description":"A number from 1 to 4"},{"type":"number","value":"number column A number from 1 to 4","name":"column","description":"A number from 1 to 4"}],"class":"function","name":"getField","description":" Returns a specific field in the matrix"},"set":{"path":"libs_sh/vmatrix.lua#L214","realm":"shared","params":[{"type":"VMatrix","value":"VMatrix src Second matrix","name":"src","description":"Second matrix"}],"class":"function","name":"set","description":" Copies the values from the second matrix to the first matrix.\n Self-Modifies. Does not return anything"},"translate":{"path":"libs_sh/vmatrix.lua#L252","realm":"shared","params":[{"type":"Vector","value":"Vector vec Vector to translate by","name":"vec","description":"Vector to translate by"}],"class":"function","name":"translate","description":" Translate the matrix"},"getRight":{"path":"libs_sh/vmatrix.lua#L117","returns":[{"type":"Vector","value":"Vector Translation","description":"Translation"}],"realm":"shared","class":"function","name":"getRight","description":" Returns right vector of matrix. Negated second matrix column"},"setTranslation":{"path":"libs_sh/vmatrix.lua#L158","realm":"shared","params":[{"type":"Vector","value":"Vector vec New translation","name":"vec","description":"New translation"}],"class":"function","name":"setTranslation","description":" Sets the translation\n Self-Modifies. Does not return anything"},"invertTR":{"path":"libs_sh/vmatrix.lua#L246","realm":"shared","class":"function","name":"invertTR","description":" Inverts the matrix efficiently for translations and rotations\n Self-Modifies. Does not return anything"},"isRotationMatrix":{"path":"libs_sh/vmatrix.lua#L233","returns":[{"type":"boolean","value":"boolean True/False","description":"True/False"}],"realm":"shared","class":"function","name":"isRotationMatrix","description":" Returns whether the matrix is a rotation matrix or not. Checks if the forward, right and up vectors are orthogonal and normalized."},"rotate":{"path":"libs_sh/vmatrix.lua#L82","realm":"shared","params":[{"type":"Angle","value":"Angle ang Angle to rotate by","name":"ang","description":"Angle to rotate by"}],"class":"function","name":"rotate","description":" Rotate the matrix\n Self-Modifies. Does not return anything"},"scale":{"path":"libs_sh/vmatrix.lua#L136","realm":"shared","params":[{"type":"Vector","value":"Vector vec Vector to scale by","name":"vec","description":"Vector to scale by"}],"class":"function","name":"scale","description":" Scale the matrix\n Self-Modifies. Does not return anything"},"setScale":{"path":"libs_sh/vmatrix.lua#L129","realm":"shared","params":[{"type":"Vector","value":"Vector vec New scale","name":"vec","description":"New scale"}],"class":"function","name":"setScale","description":" Sets the scale\n Self-Modifies. Does not return anything"},"__add":{"path":"libs_sh/vmatrix.lua#L344","returns":[{"type":"VMatrix","value":"VMatrix Added matrix","description":"Added matrix"}],"realm":"shared","params":[{"type":"VMatrix","value":"VMatrix lhs Initial Matrix","name":"lhs","description":"Initial Matrix"},{"type":"VMatrix","value":"VMatrix rhs Matrix to add to the first","name":"rhs","description":"Matrix to add to the first"}],"class":"function","name":"__add","description":" Adds two matrices (why would you do this?)"},"getAxisAngle":{"path":"libs_sh/vmatrix.lua#L289","returns":[{"type":"Vector","value":"Vector The axis of rotation","description":"The axis of rotation"},{"type":"number","value":"number The angle of rotation","description":"The angle of rotation"}],"realm":"shared","class":"function","name":"getAxisAngle","description":" Gets the rotation axis and angle of rotation of the rotation matrix"},"isIdentity":{"path":"libs_sh/vmatrix.lua#L227","returns":[{"type":"boolean","value":"boolean True/False","description":"True/False"}],"realm":"shared","class":"function","name":"isIdentity","description":" Returns whether the matrix is equal to Identity matrix or not"},"getRotatedAroundAxis":{"path":"libs_sh/vmatrix.lua#L89","returns":[{"type":"VMatrix","value":"VMatrix The rotated matrix","description":"The rotated matrix"}],"realm":"shared","params":[{"type":"Vector","value":"Vector axis Axis to rotate around","name":"axis","description":"Axis to rotate around"},{"type":"number","value":"number ang Angle to rotate by in radians","name":"ang","description":"Angle to rotate by in radians"}],"class":"function","name":"getRotatedAroundAxis","description":" Returns the input matrix rotated by an axis"},"clone":{"path":"libs_sh/vmatrix.lua#L195","returns":[{"type":"VMatrix","value":"VMatrix The copy of the matrix","description":"The copy of the matrix"}],"realm":"shared","class":"function","name":"clone","description":" Copies The matrix and returns a new matrix"},"setIdentity":{"path":"libs_sh/vmatrix.lua#L221","realm":"shared","class":"function","name":"setIdentity","description":" Initializes the matrix as Identity matrix\n Self-Modifies. Does not return anything"},"setUnpacked":{"path":"libs_sh/vmatrix.lua#L207","realm":"shared","params":[{"type":"...number","value":"...number fields The 16 fields","name":"fields","description":"The 16 fields"}],"class":"function","name":"setUnpacked","description":" Allows you to set all 16 fields in row-major order\n Self-Modifies. Does not return anything"},"getUp":{"path":"libs_sh/vmatrix.lua#L123","returns":[{"type":"Vector","value":"Vector Translation","description":"Translation"}],"realm":"shared","class":"function","name":"getUp","description":" Returns up vector of matrix. Third matrix column"},"setUp":{"path":"libs_sh/vmatrix.lua#L179","realm":"shared","params":[{"type":"Vector","value":"Vector up The up vector","name":"up","description":"The up vector"}],"class":"function","name":"setUp","description":" Sets the up direction of the matrix. Third column\n Self-Modifies. Does not return anything"},"getTranslation":{"path":"libs_sh/vmatrix.lua#L68","returns":[{"type":"Vector","value":"Vector Translation","description":"Translation"}],"realm":"shared","class":"function","name":"getTranslation","description":" Returns translation"},"getInverseTR":{"path":"libs_sh/vmatrix.lua#L105","returns":[{"type":"VMatrix","value":"VMatrix Inverted matrix","description":"Inverted matrix"}],"realm":"shared","class":"function","name":"getInverseTR","description":" Returns an inverted matrix. Efficiently for translations and rotations"},"__tostring":{"path":"libs_sh/vmatrix.lua#L50","returns":[{"type":"string","value":"string String representing the matrix.","description":"String representing the matrix."}],"realm":"shared","class":"function","name":"__tostring","description":" tostring metamethod"},"setAngles":{"path":"libs_sh/vmatrix.lua#L151","realm":"shared","params":[{"type":"Angle","value":"Angle ang New angles","name":"ang","description":"New angles"}],"class":"function","name":"setAngles","description":" Sets the angles\n Self-Modifies. Does not return anything"},"toTable":{"path":"libs_sh/vmatrix.lua#L258","returns":[{"type":"table","value":"table The 4x4 table","description":"The 4x4 table"}],"realm":"shared","class":"function","name":"toTable","description":" Converts the matrix to a 4x4 table"},"unpack":{"path":"libs_sh/vmatrix.lua#L201","returns":[{"type":"...number","value":"...number The 16 fields","description":"The 16 fields"}],"realm":"shared","class":"function","name":"unpack","description":" Returns all 16 fields of the matrix in row-major order"},"setField":{"path":"libs_sh/vmatrix.lua#L186","realm":"shared","params":[{"type":"number","value":"number row A number from 1 to 4","name":"row","description":"A number from 1 to 4"},{"type":"number","value":"number column A number from 1 to 4","name":"column","description":"A number from 1 to 4"},{"type":"number","value":"number value Value to set","name":"value","description":"Value to set"}],"class":"function","name":"setField","description":" Sets a specific field in the matrix\n Self-Modifies. Does not return anything"},"scaleTranslation":{"path":"libs_sh/vmatrix.lua#L143","realm":"shared","params":[{"type":"number","value":"number num Amount to scale by","name":"num","description":"Amount to scale by"}],"class":"function","name":"scaleTranslation","description":" Scales the absolute translation\n Self-Modifies. Does not return anything"}},"class":"type","name":"VMatrix","description":" VMatrix type"},"Bass":{"path":"libs_cl/bass.lua#L129","libtbl":["bass_methods"],"realm":"client","methods":{"stop":{"path":"libs_cl/bass.lua#L243","realm":"client","class":"function","name":"stop","description":" Stops playing the sound and destroys it. Use pause instead if you don't want it destroyed."},"isStalled":{"path":"libs_cl/bass.lua#L470","returns":[{"type":"boolean","value":"boolean True if the sound is stalled.","description":"True if the sound is stalled."}],"realm":"client","class":"function","name":"isStalled","description":" Returns whether or not the sound is stalled."},"getBitsPerSample":{"path":"libs_cl/bass.lua#L414","returns":[{"type":"number","value":"number Floating point number of bits per sample, or 0 if unknown.","description":"Floating point number of bits per sample, or 0 if unknown."}],"realm":"client","class":"function","name":"getBitsPerSample","description":" Retrieves the number of bits per sample of the sound.\n Doesn't work for mp3 and ogg files."},"isPaused":{"path":"libs_cl/bass.lua#L464","returns":[{"type":"boolean","value":"boolean True if the sound is paused.","description":"True if the sound is paused."}],"realm":"client","class":"function","name":"isPaused","description":" Returns whether or not the sound is paused."},"setPitch":{"path":"libs_cl/bass.lua#L290","realm":"client","params":[{"type":"number","value":"number pitch Pitch to set to. (0-100) 1 is normal pitch.","name":"pitch","description":"Pitch to set to. (0-100) 1 is normal pitch."}],"class":"function","name":"setPitch","description":" Sets the pitch of the sound."},"getPos":{"path":"libs_cl/bass.lua#L303","returns":[{"type":"Vector","value":"Vector The position of the sound.","description":"The position of the sound."}],"realm":"client","class":"function","name":"getPos","description":" Gets the position of the sound in 3D space."},"isPlaying":{"path":"libs_cl/bass.lua#L458","returns":[{"type":"boolean","value":"boolean True if the sound is playing.","description":"True if the sound is playing."}],"realm":"client","class":"function","name":"isPlaying","description":" Returns whether or not the sound is playing."},"getLevels":{"path":"libs_cl/bass.lua#L390","returns":[{"type":"number","value":"number The left sound level, a value between 0 and 1.","description":"The left sound level, a value between 0 and 1."},{"type":"number","value":"number The right sound level, a value between 0 and 1.","description":"The right sound level, a value between 0 and 1."}],"realm":"client","class":"function","name":"getLevels","description":" Gets the left and right audio channel levels."},"isLooping":{"path":"libs_cl/bass.lua#L343","returns":[{"type":"boolean","value":"boolean Whether the sound loops.","description":"Whether the sound loops."}],"realm":"client","class":"function","name":"isLooping","description":" Gets whether the sound loops."},"getPan":{"path":"libs_cl/bass.lua#L397","returns":[{"type":"number","value":"number The pan. -1 to 1 for relative left to right","description":"The pan. -1 to 1 for relative left to right"}],"realm":"client","class":"function","name":"getPan","description":" Gets the relative volume between the left and right audio channels."},"setVolume":{"path":"libs_cl/bass.lua#L255","realm":"client","params":[{"type":"number","value":"number vol Volume multiplier (1 is normal), between 0x and 10x.","name":"vol","description":"Volume multiplier (1 is normal), between 0x and 10x."}],"class":"function","name":"setVolume","description":" Sets the volume of the sound."},"is3D":{"path":"libs_cl/bass.lua#L439","returns":[{"type":"boolean","value":"boolean True if the sound is 3D.","description":"True if the sound is 3D."}],"realm":"client","class":"function","name":"is3D","description":" Returns whether or not the sound is 3D."},"setLooping":{"path":"libs_cl/bass.lua#L337","realm":"client","params":[{"type":"boolean","value":"boolean loop Whether the sound should loop.","name":"loop","description":"Whether the sound should loop."}],"class":"function","name":"setLooping","description":" Sets whether the sound should loop. Requires the 'noblock' flag."},"play":{"path":"libs_cl/bass.lua#L238","realm":"client","class":"function","name":"play","description":" Starts to play the sound."},"isOnline":{"path":"libs_cl/bass.lua#L378","returns":[{"type":"boolean","value":"boolean Boolean of whether the sound is streamed online.","description":"Boolean of whether the sound is streamed online."}],"realm":"client","class":"function","name":"isOnline","description":" Gets whether the sound is streamed online."},"getFlags":{"path":"libs_cl/bass.lua#L427","returns":[{"type":"string","value":"string The flags of the sound (`3d`, `mono`, `noplay`, `noblock`).","description":"The flags of the sound (`3d`, `mono`, `noplay`, `noblock`)."}],"realm":"client","class":"function","name":"getFlags","description":" Returns the flags used to create the sound."},"getAverageBitRate":{"path":"libs_cl/bass.lua#L421","returns":[{"type":"number","value":"number The average bit rate of the sound.","description":"The average bit rate of the sound."}],"realm":"client","class":"function","name":"getAverageBitRate","description":" Returns the average bit rate of the sound."},"setPan":{"path":"libs_cl/bass.lua#L403","realm":"client","params":[{"type":"number","value":"number Relative integer volume between the left and right channels. Values must be -1 to 1 for relative left to right.","name":"Relative","description":"integer volume between the left and right channels. Values must be -1 to 1 for relative left to right."}],"class":"function","name":"setPan","description":" Sets the relative volume of the left and right channels."},"getTime":{"path":"libs_cl/bass.lua#L363","returns":[{"type":"number","value":"number Sound playback time in seconds.","description":"Sound playback time in seconds."}],"realm":"client","class":"function","name":"getTime","description":" Gets the current playback time of the sound. Requires the 'noblock' flag."},"getLength":{"path":"libs_cl/bass.lua#L349","returns":[{"type":"number","value":"number Sound length in seconds.","description":"Sound length in seconds."}],"realm":"client","class":"function","name":"getLength","description":" Gets the length of a sound."},"pause":{"path":"libs_cl/bass.lua#L250","realm":"client","class":"function","name":"pause","description":" Pauses the sound."},"getState":{"path":"libs_cl/bass.lua#L445","returns":[{"type":"number","value":"number The state enum of the sound. https://wiki.facepunch.com/gmod/Enums/GMOD_CHANNEL","description":"The state enum of the sound. https://wiki.facepunch.com/gmod/Enums/GMOD_CHANNEL"}],"realm":"client","class":"function","name":"getState","description":" Returns the state of the sound."},"isStopped":{"path":"libs_cl/bass.lua#L451","returns":[{"type":"boolean","value":"boolean True if the sound is stopped.","description":"True if the sound is stopped."}],"realm":"client","class":"function","name":"isStopped","description":" Returns whether or not the sound is stopped.\n Only true if the `noplay` flag is used and Bass:play() hasn't been called yet, since Bass:stop() will destroy the sound channel."},"getFFT":{"path":"libs_cl/bass.lua#L369","returns":[{"type":"table","value":"table Table containing DFT magnitudes, each between 0 and 1.","description":"Table containing DFT magnitudes, each between 0 and 1."}],"realm":"client","params":[{"type":"number","value":"number n Number of consecutive audio samples, between 0 and 7. Depending on this parameter you will get 256*2^n samples.","name":"n","description":"Number of consecutive audio samples, between 0 and 7. Depending on this parameter you will get 256*2^n samples."}],"class":"function","name":"getFFT","description":" Perform fast Fourier transform algorithm to compute the DFT of the sound."},"isValid":{"path":"libs_cl/bass.lua#L384","returns":[{"type":"boolean","value":"boolean Boolean of whether the bass is valid.","description":"Boolean of whether the bass is valid."}],"realm":"client","class":"function","name":"isValid","description":" Gets whether the bass is valid."},"setFade":{"path":"libs_cl/bass.lua#L309","realm":"client","params":[{"type":"number","value":"number min The distance where the sound starts to fade. (50-1,000)","name":"min","description":"The distance where the sound starts to fade. (50-1,000)"},{"type":"number","value":"number max The maximal distance, as described above. (min-20,000 for simple fading, 5,000-200,000 for non-simple fading)","name":"max","description":"The maximal distance, as described above. (min-20,000 for simple fading, 5,000-200,000 for non-simple fading)"},{"type":"boolean?","value":"boolean? useSimpleFading Whether to use simple fading for this sound. True by default.","name":"useSimpleFading","description":"Whether to use simple fading for this sound. True by default."}],"class":"function","name":"setFade","description":" Sets the fade distance of the sound in 3D space. Must have `3d` flag for this to have any effect.\n For both fading styles, the sound will be at full volume (the value of :setVolume()) at distances between 0 and min.\n If simple fading is enabled, the sound will fade towards 0 until the max distance is reached, becoming inaudible.\n If simple fading is disabled, the sound will start to fade, then lock its volume once max distance is reached. It will almost always be faintly heard."},"setTime":{"path":"libs_cl/bass.lua#L355","realm":"client","params":[{"type":"number","value":"number time Sound playback time in seconds.","name":"time","description":"Sound playback time in seconds."},{"type":"boolean?","value":"boolean? dontDecode Skip decoding to set time, which is much faster but less accurate. True by default.","name":"dontDecode","description":"Skip decoding to set time, which is much faster but less accurate. True by default."}],"class":"function","name":"setTime","description":" Sets the current playback time of the sound. Requires the 'noblock' flag."},"setPos":{"path":"libs_cl/bass.lua#L297","realm":"client","params":[{"type":"Vector","value":"Vector pos Where to position the sound.","name":"pos","description":"Where to position the sound."}],"class":"function","name":"setPos","description":" Sets the position of the sound in 3D space. Must have `3d` flag for this to have any effect."},"getFade":{"path":"libs_cl/bass.lua#L327","returns":[{"type":"number","value":"number The distance before the sound starts to fade.","description":"The distance before the sound starts to fade."},{"type":"number","value":"number The distance before the sound stops fading.","description":"The distance before the sound stops fading."},{"type":"boolean","value":"boolean Whether or not this sound uses simple fading.","description":"Whether or not this sound uses simple fading."}],"realm":"client","class":"function","name":"getFade","description":" Gets the fade distance of the sound in 3D space. "},"is2D":{"path":"libs_cl/bass.lua#L433","returns":[{"type":"boolean","value":"boolean True if the sound is 2D.","description":"True if the sound is 2D."}],"realm":"client","class":"function","name":"is2D","description":" Returns whether or not the sound is 2D."},"getVolume":{"path":"libs_cl/bass.lua#L273","returns":[{"type":"number","value":"number Volume multiplier (1 is normal), between 0x and 10x.","description":"Volume multiplier (1 is normal), between 0x and 10x."}],"realm":"client","class":"function","name":"getVolume","description":" Gets the base volume of the sound.\n This is the volume before distance fading is applied on 3D sounds."},"getFadeMultiplier":{"path":"libs_cl/bass.lua#L280","returns":[{"type":"number","value":"number Volume fade multiplier (1 is normal), between 0x and 10x.","description":"Volume fade multiplier (1 is normal), between 0x and 10x."}],"realm":"client","class":"function","name":"getFadeMultiplier","description":" Gets the distance-based fade multiplier of the sound.\n Bass:getVolume() * Bass:getFadeMultiplier() is the effective volume of the sound.\n Always 1 for 2D sounds.\n Always 1 for 3D sounds that don't use simple fading. See Bass:setFade().\n Only updates once per frame while the sound is playing."}},"class":"type","name":"Bass","description":" For playing music there is `Bass` type. You can pause and set current playback time in it. If you're looking to apply DSP effects on present game sounds, use `Sound` instead."},"Entity":{"path":"libs_sh/entities.lua#L57","libtbl":["ents_methods","ent_meta"],"realm":"shared","methods":{"localToWorld":{"path":"libs_sh/entities.lua#L1293","returns":[{"type":"Vector","value":"Vector data as world space vector","description":"data as world space vector"}],"realm":"shared","params":[{"type":"Vector","value":"Vector data Local space vector","name":"data","description":"Local space vector"}],"class":"function","name":"localToWorld","description":" Converts a vector in entity local space to world space"},"setVelocity":{"path":"libs_sv/entities.lua#L567","realm":"server","params":[{"type":"Vector","value":"Vector vel New velocity","name":"vel","description":"New velocity"}],"class":"function","name":"setVelocity","description":" Sets the entity's linear velocity. Physics entities, use physobj:setVelocity"},"obbMins":{"path":"libs_sh/entities.lua#L1187","returns":[{"type":"Vector","value":"Vector The min bounding box vector","description":"The min bounding box vector"}],"realm":"shared","class":"function","name":"obbMins","description":" Returns min local bounding box vector of the entity"},"getForward":{"path":"libs_sh/entities.lua#L1659","returns":[{"type":"Vector","value":"Vector Vector forward","description":"Vector forward"}],"realm":"shared","class":"function","name":"getForward","description":" Gets the entity's forward vector"},"emitSound":{"path":"libs_sh/entities.lua#L321","realm":"shared","params":[{"type":"string","value":"string snd Sound path","name":"snd","description":"Sound path"},{"type":"number","value":"number soundLevel Default 75","name":"soundLevel","description":"Default 75"},{"type":"number","value":"number pitchPercent Default 100","name":"pitchPercent","description":"Default 100"},{"type":"number","value":"number volume Default 1","name":"volume","description":"Default 1"},{"type":"number","value":"number channel Default CHAN_AUTO or CHAN_WEAPON for weapons","name":"channel","description":"Default CHAN_AUTO or CHAN_WEAPON for weapons"}],"class":"function","name":"emitSound","description":" Plays a sound on the entity"},"getCreationTime":{"path":"libs_sh/entities.lua#L1666","returns":[{"type":"number","value":"number Seconds relative to server map start","description":"Seconds relative to server map start"}],"realm":"shared","class":"function","name":"getCreationTime","description":" Returns the timer.curtime() time the entity was created on"},"getTable":{"path":"libs_sv/entities.lua#L1077","returns":[{"type":"table","value":"table The entity's table.","description":"The entity's table."}],"realm":"server","class":"function","name":"getTable","description":" Returns a copy of the entity's sanitized internal glua table."},"setTrails":{"path":"libs_sv/entities.lua#L957","realm":"server","params":[{"type":"number","value":"number startSize The start size of the trail (0-128)","name":"startSize","description":"The start size of the trail (0-128)"},{"type":"number","value":"number endSize The end size of the trail (0-128)","name":"endSize","description":"The end size of the trail (0-128)"},{"type":"number","value":"number length The length size of the trail","name":"length","description":"The length size of the trail"},{"type":"string","value":"string material The material of the trail","name":"material","description":"The material of the trail"},{"type":"Color","value":"Color color The color of the trail","name":"color","description":"The color of the trail"},{"type":"number?","value":"number? attachmentID Optional attachmentid the trail should attach to","name":"attachmentID","description":"Optional attachmentid the trail should attach to"},{"type":"boolean?","value":"boolean? additive If the trail's rendering is additive","name":"additive","description":"If the trail's rendering is additive"}],"class":"function","name":"setTrails","description":" Adds a trail to the entity with the specified attributes."},"getHitBoxBounds":{"path":"libs_sh/entities.lua#L1708","returns":[{"type":"Vector","value":"Vector Hitbox mins vector.","description":"Hitbox mins vector."},{"type":"Vector","value":"Vector Hitbox maxs vector.","description":"Hitbox maxs vector."}],"realm":"shared","params":[{"type":"number","value":"number hitbox The number of the hitbox.","name":"hitbox","description":"The number of the hitbox."},{"type":"number","value":"number group The number of the hitbox group, 0 in most cases.","name":"group","description":"The number of the hitbox group, 0 in most cases."}],"class":"function","name":"getHitBoxBounds","description":" Gets the bounds (min and max corners) of a hit box."},"setUnbreakable":{"path":"libs_sv/entities.lua#L996","realm":"server","params":[{"type":"boolean","value":"boolean on Whether to make the prop unbreakable","name":"on","description":"Whether to make the prop unbreakable"}],"class":"function","name":"setUnbreakable","description":" Sets a prop_physics to be unbreakable"},"addCollisionListener":{"path":"libs_sv/entities.lua#L512","realm":"server","params":[{"type":"function","value":"function func The callback function with argument, table collsiondata, http://wiki.facepunch.com/gmod/Structures/CollisionData","name":"func","description":"The callback function with argument, table collsiondata, http://wiki.facepunch.com/gmod/Structures/CollisionData"},{"type":"string?","value":"string? name Optional name to distinguish multiple collision listeners and remove them individually later. (default: \"\")","name":"name","description":"Optional name to distinguish multiple collision listeners and remove them individually later. (default: \"\")"}],"class":"function","name":"addCollisionListener","description":" Allows detecting collisions on an entity."},"isKeysOwned":{"path":"libs_sh/darkrp2.lua#L850","returns":[{"type":"boolean","value":"boolean Whether it's owned.","description":"Whether it's owned."}],"realm":"shared","class":"function","name":"isKeysOwned","description":" Get whether this door is owned by someone."},"getLinkedComponents":{"path":"libs_sh/entities.lua#L356","returns":[{"type":"table","value":"table A list of components linked to the entity","description":"A list of components linked to the entity"}],"realm":"shared","class":"function","name":"getLinkedComponents","description":" Returns a list of components linked to a processor. Can also return vehicles linked to a HUD, but only through the server."},"getVelocity":{"path":"libs_sh/entities.lua#L1259","returns":[{"type":"Vector","value":"Vector The velocity vector","description":"The velocity vector"}],"realm":"shared","class":"function","name":"getVelocity","description":" Returns the velocity of the entity"},"setPhysMaterial":{"path":"libs_sv/entities.lua#L717","realm":"server","params":[{"type":"string","value":"string materialName Material to use","name":"materialName","description":"Material to use"}],"class":"function","name":"setPhysMaterial","description":" Sets the physical material of the entity"},"getModelContents":{"path":"libs_sh/entities.lua#L1563","returns":[{"type":"number","value":"number Contents of the entity's model. https://wiki.facepunch.com/gmod/Enums/CONTENTS","description":"Contents of the entity's model. https://wiki.facepunch.com/gmod/Enums/CONTENTS"}],"realm":"shared","class":"function","name":"getModelContents","description":" Returns the contents of the entity's current model"},"setPhysicsUpdateListener":{"path":"libs_sv/entities.lua#L1048","realm":"server","params":[{"type":"function|nil","value":"function|nil func The callback function. Use nil to remove an existing callback.","name":"func","description":"The callback function. Use nil to remove an existing callback."}],"class":"function","name":"setPhysicsUpdateListener","description":" Set the function to run whenever the physics of the entity are updated.\n This won't be called if the physics object goes asleep.\n\n You can only use this function on these classes:\n - starfall_prop\n - starfall_processor"},"getMaterials":{"path":"libs_sh/entities.lua#L1637","returns":[{"type":"table","value":"table Material","description":"Material"}],"realm":"shared","class":"function","name":"getMaterials","description":" Gets an entities' material list"},"enableGravity":{"path":"libs_sv/entities.lua#L764","realm":"server","params":[{"type":"boolean","value":"boolean grav Should the entity respect gravity?","name":"grav","description":"Should the entity respect gravity?"}],"class":"function","name":"enableGravity","description":" Sets entity gravity"},"getNetworkVars":{"path":"libs_sh/entities.lua#L1941","returns":[{"type":"table?","value":"table? The networked variables table of the entity or nil if it doesn't have one.","description":"The networked variables table of the entity or nil if it doesn't have one."}],"realm":"shared","class":"function","name":"getNetworkVars","description":" Returns entity's networked variables table (data table)."},"setMesh":{"path":"libs_sh/entities.lua#L174","realm":"client","params":[{"type":"Mesh?","value":"Mesh? mesh The mesh to set it to or nil to set back to normal","name":"mesh","description":"The mesh to set it to or nil to set back to normal"}],"class":"function","name":"setMesh","description":" Sets a hologram or custom_prop model to a custom Mesh"},"setComponentLocksControls":{"path":"libs_sv/entities.lua#L248","realm":"server","params":[{"type":"boolean","value":"boolean enable Whether the component will lock the player's controls when used","name":"enable","description":"Whether the component will lock the player's controls when used"}],"class":"function","name":"setComponentLocksControls","description":" Sets a component's ability to lock a player's controls"},"getPoseRange":{"path":"libs_sh/entities.lua#L1442","returns":[{"type":"number?","value":"number? Minimum pose value or nil if pose not found","description":"Minimum pose value or nil if pose not found"},{"type":"number?","value":"number? Maximum pose value or nil if pose not found","description":"Maximum pose value or nil if pose not found"}],"realm":"shared","params":[{"type":"number","value":"number id Pose index (starting from 0)","name":"id","description":"Pose index (starting from 0)"}],"class":"function","name":"getPoseRange","description":" Returns pose value range"},"getCollisionGroup":{"path":"libs_sh/entities.lua#L712","returns":[{"type":"number","value":"number The collision group enum of the entity. https://wiki.facepunch.com/gmod/Enums/COLLISION_GROUP","description":"The collision group enum of the entity. https://wiki.facepunch.com/gmod/Enums/COLLISION_GROUP"}],"realm":"shared","class":"function","name":"getCollisionGroup","description":" Gets the collision group enum of the entity"},"setDrawShadow":{"path":"libs_sv/entities.lua#L536","realm":"server","params":[{"type":"boolean","value":"boolean draw Whether the shadow should draw","name":"draw","description":"Whether the shadow should draw"}],"class":"function","name":"setDrawShadow","description":" Sets whether an entity's shadow should be drawn"},"getBoundingRadius":{"path":"libs_sh/entities.lua#L1890","returns":[{"type":"number","value":"number The radius of the bounding box, or 0 for some entities such as worldspawn","description":"The radius of the bounding box, or 0 for some entities such as worldspawn"}],"realm":"shared","class":"function","name":"getBoundingRadius","description":" Returns the distance between the center of the entity's bounding box and whichever corner of the bounding box is farthest away."},"getCount":{"path":"libs_sh/darkrp2.lua#L878","returns":[{"type":"number?","value":"number? Number of items remaining, or nil if not a shipment","description":"Number of items remaining, or nil if not a shipment"}],"realm":"shared","class":"function","name":"getCount","description":" Get the number of items remaining in a shipment. DarkRP only.\n Equivalent to GLua Entity:Getcount."},"mapCreationID":{"path":"libs_sh/entities.lua#L1934","returns":[{"type":"number","value":"number The map creation ID or -1 if the entity is not compiled into the map.","description":"The map creation ID or -1 if the entity is not compiled into the map."}],"realm":"shared","class":"function","name":"mapCreationID","description":" Returns entity's map creation ID. Unlike Entity:entIndex or Entity:getCreationID, it will always be the same on same map, no matter how much you clean up or restart it."},"extinguish":{"path":"libs_sv/entities.lua#L632","realm":"server","class":"function","name":"extinguish","description":" Extinguishes an entity"},"getSaveTable":{"path":"libs_sh/entities.lua#L1915","returns":[{"type":"table","value":"table A table containing all save values in key/value format. The value may be a sequential table (starting to 1) if the field in question is an array in engine.","description":"A table containing all save values in key/value format. The value may be a sequential table (starting to 1) if the field in question is an array in engine."}],"realm":"shared","params":[{"type":"boolean","value":"boolean showAll If set, shows all variables, not just the ones for save.","name":"showAll","description":"If set, shows all variables, not just the ones for save."}],"class":"function","name":"getSaveTable","description":" Returns a table of save values for an entity.\n These tables are not the same between the client and the server, and different entities may have different fields."},"getPersistent":{"path":"libs_sh/entities.lua#L1693","returns":[{"type":"boolean","value":"boolean True if the entity is persistent","description":"True if the entity is persistent"}],"realm":"shared","class":"function","name":"getPersistent","description":" Checks if entity is marked as persistent"},"getNearestPoint":{"path":"libs_sh/entities.lua#L1906","returns":[{"type":"Vector","value":"Vector The nearest hit point of the entity's bounding box in world coordinates, or Vector(0, 0, 0) for some entities such as worldspawn.","description":"The nearest hit point of the entity's bounding box in world coordinates, or Vector(0, 0, 0) for some entities such as worldspawn."}],"realm":"shared","params":[{"type":"Vector","value":"Vector The vector to start the intersection from.","name":"The","description":"vector to start the intersection from."}],"class":"function","name":"getNearestPoint","description":" Performs a Ray-Orientated Bounding Box intersection from the given position to the origin of the OBBox with the entity and returns the hit position on the OBBox.\n This relies on the entity having a collision mesh (not a physics object) and will be affected by SOLID_NONE"},"isDormant":{"path":"libs_sh/entities.lua#L1897","returns":[{"type":"boolean","value":"boolean Whether entity is dormant or not.","description":"Whether entity is dormant or not."}],"realm":"shared","class":"function","name":"isDormant","description":" Returns whether the entity is dormant or not, i.e. whether or not information about the entity is being sent to your client. Not to be confused with PhysObj:isAsleep\n Clientside, this will usually be true if the object is outside of your PVS (potentially visible set).\n Serverside, this will almost always be false."},"addVelocity":{"path":"libs_sv/entities.lua#L580","realm":"server","params":[{"type":"Vector","value":"Vector vel The world velocity vector to apply","name":"vel","description":"The world velocity vector to apply"}],"class":"function","name":"addVelocity","description":" Applies velocity to an object"},"getInertia":{"path":"libs_sh/entities.lua#L1248","returns":[{"type":"Vector","value":"Vector The principle moments of inertia as a vector","description":"The principle moments of inertia as a vector"}],"realm":"shared","class":"function","name":"getInertia","description":" Returns the principle moments of inertia of the entity"},"hasInstance":{"path":"libs_sh/entities.lua#L960","returns":[{"type":"boolean","value":"boolean if has starfall instance or E2 instance","description":"if has starfall instance or E2 instance"}],"realm":"shared","class":"function","name":"hasInstance","description":" Return if the entity has a starfall instance or E2 instance"},"getInternalVariable":{"path":"libs_sh/entities.lua#L1924","returns":[{"type":"any","value":"any The internal variable associated with the name.","description":"The internal variable associated with the name."}],"realm":"shared","params":[{"type":"string","value":"string variableName Name of the internal save table variable.","name":"variableName","description":"Name of the internal save table variable."}],"class":"function","name":"getInternalVariable","description":" Returns a variable from the entity's save table."},"doorIndex":{"path":"libs_sh/darkrp2.lua#L815","returns":[{"type":"number?","value":"number? The door index, or nil if not a door.","description":"The door index, or nil if not a door."}],"realm":"server","class":"function","name":"doorIndex","description":" Get the DarkRP door index of a door. Use this to store door information in the database."},"isFrozen":{"path":"libs_sv/entities.lua#L826","returns":[{"type":"boolean","value":"boolean True if entity is frozen","description":"True if entity is frozen"}],"realm":"server","class":"function","name":"isFrozen","description":" Checks the entities frozen state"},"getNWVarTable":{"path":"libs_sh/entities.lua#L1883","returns":[{"type":"table","value":"table The table of networked objects","description":"The table of networked objects"}],"realm":"shared","class":"function","name":"getNWVarTable","description":" Gets the table of all networked things on an entity"},"getNWVar":{"path":"libs_sh/entities.lua#L1871","returns":[{"type":"any","value":"any The object associated with that key or nil if it's not set","description":"The object associated with that key or nil if it's not set"}],"realm":"shared","params":[{"type":"string","value":"string key The string key to get","name":"key","description":"The string key to get"}],"class":"function","name":"getNWVar","description":" Gets a networked variable of an entity"},"getDTVector":{"path":"libs_sh/entities.lua#L1861","returns":[{"type":"Vector?","value":"Vector? The vector or nil if it doesn't exist","description":"The vector or nil if it doesn't exist"}],"realm":"shared","params":[{"type":"number","value":"number key The number key. Valid keys are 0 - 31","name":"key","description":"The number key. Valid keys are 0 - 31"}],"class":"function","name":"getDTVector","description":" Gets a datatable vector"},"getElasticity":{"path":"libs_sh/entities.lua#L778","returns":[{"type":"number","value":"number Elasticity","description":"Elasticity"}],"realm":"shared","class":"function","name":"getElasticity","description":" Returns the elasticity of the entity"},"getRenderBounds":{"path":"libs_sh/entities.lua#L247","returns":[{"type":"Vector","value":"Vector The minimum vector of the bounds","description":"The minimum vector of the bounds"},{"type":"Vector","value":"Vector The maximum vector of the bounds","description":"The maximum vector of the bounds"}],"realm":"client","class":"function","name":"getRenderBounds","description":" Returns render bounds of the entity as local vectors\n If the render bounds are not inside players view, the entity will not be drawn!"},"getDTString":{"path":"libs_sh/entities.lua#L1851","returns":[{"type":"string?","value":"string? The string or nil if it doesn't exist","description":"The string or nil if it doesn't exist"}],"realm":"shared","params":[{"type":"number","value":"number key The number key. Valid keys are 0 - 31","name":"key","description":"The number key. Valid keys are 0 - 31"}],"class":"function","name":"getDTString","description":" Gets a datatable string"},"getSequenceCount":{"path":"libs_sh/entities.lua#L1383","returns":[{"type":"number","value":"number Count of entity's animations","description":"Count of entity's animations"}],"realm":"shared","class":"function","name":"getSequenceCount","description":" Gets the number of animations the entity has"},"getDTBool":{"path":"libs_sh/entities.lua#L1811","returns":[{"type":"boolean?","value":"boolean? The boolean or nil if it doesn't exist","description":"The boolean or nil if it doesn't exist"}],"realm":"shared","params":[{"type":"number","value":"number key The number key. Valid keys are 0 - 31","name":"key","description":"The number key. Valid keys are 0 - 31"}],"class":"function","name":"getDTBool","description":" Gets a datatable boolean"},"getUp":{"path":"libs_sh/entities.lua#L1645","returns":[{"type":"Vector","value":"Vector Vector up","description":"Vector up"}],"realm":"shared","class":"function","name":"getUp","description":" Gets the entity's up vector"},"getRenderMode":{"path":"libs_sh/entities.lua#L630","returns":[{"type":"number","value":"number rendermode https://wiki.facepunch.com/gmod/Enums/RENDERMODE","description":"rendermode https://wiki.facepunch.com/gmod/Enums/RENDERMODE"}],"realm":"shared","class":"function","name":"getRenderMode","description":" Gets the render mode of the entity"},"getHitBoxHitGroup":{"path":"libs_sh/entities.lua#L1758","returns":[{"type":"number","value":"number The hitbox group of given hitbox. See https://wiki.facepunch.com/gmod/Enums/HITGROUP","description":"The hitbox group of given hitbox. See https://wiki.facepunch.com/gmod/Enums/HITGROUP"}],"realm":"shared","params":[{"type":"number","value":"number hitbox The number of the hit box.","name":"hitbox","description":"The number of the hit box."},{"type":"number","value":"number hitboxset The number of the hit box set. This should be 0 in most cases.","name":"hitboxset","description":"The number of the hit box set. This should be 0 in most cases."}],"class":"function","name":"getHitBoxHitGroup","description":" Gets the hit group of a given hitbox in a given hitbox set."},"getDTFloat":{"path":"libs_sh/entities.lua#L1831","returns":[{"type":"number?","value":"number? The float or nil if it doesn't exist","description":"The float or nil if it doesn't exist"}],"realm":"shared","params":[{"type":"number","value":"number key The number key. Valid keys are 0 - 31","name":"key","description":"The number key. Valid keys are 0 - 31"}],"class":"function","name":"getDTFloat","description":" Gets a datatable float"},"getHitBoxCount":{"path":"libs_sh/entities.lua#L1723","returns":[{"type":"number","value":"number Number of hitboxes","description":"Number of hitboxes"}],"realm":"shared","params":[{"type":"number","value":"number group The number of the hitbox group.","name":"group","description":"The number of the hitbox group."}],"class":"function","name":"getHitBoxCount","description":" Gets number of hitboxes in a group."},"getDTEntity":{"path":"libs_sh/entities.lua#L1821","returns":[{"type":"Entity?","value":"Entity? The entity or nil if it doesn't exist","description":"The entity or nil if it doesn't exist"}],"realm":"shared","params":[{"type":"number","value":"number key The number key. Valid keys are 0 - 31","name":"key","description":"The number key. Valid keys are 0 - 31"}],"class":"function","name":"getDTEntity","description":" Gets a datatable entity"},"getDTAngle":{"path":"libs_sh/entities.lua#L1801","returns":[{"type":"Angle?","value":"Angle? The angle or nil if it doesn't exist","description":"The angle or nil if it doesn't exist"}],"realm":"shared","params":[{"type":"number","value":"number key The number key. Valid keys are 0 - 31","name":"key","description":"The number key. Valid keys are 0 - 31"}],"class":"function","name":"getDTAngle","description":" Gets a datatable angle"},"getManipulateBonePosition":{"path":"libs_sh/entities.lua#L1146","returns":[{"type":"Vector","value":"Vector Manipulate position of the bone","description":"Manipulate position of the bone"}],"realm":"shared","params":[{"type":"number","value":"number bone Bone index. (def 0)","name":"bone","description":"Bone index. (def 0)"}],"class":"function","name":"getManipulateBonePosition","description":" Returns the vector manipulate position of the bone (relative to its default position)"},"getBrushPlaneCount":{"path":"libs_sh/entities.lua#L1794","returns":[{"type":"number","value":"number The amount of brush planes","description":"The amount of brush planes"}],"realm":"shared","class":"function","name":"getBrushPlaneCount","description":" Returns the amount of planes of the brush entity"},"getOwner":{"path":"libs_sh/entities.lua#L97","returns":[{"type":"Entity","value":"Entity Owner","description":"Owner"}],"realm":"shared","class":"function","name":"getOwner","description":" Gets the owner of the entity"},"setNocollideAll":{"path":"libs_sv/entities.lua#L673","realm":"server","params":[{"type":"boolean","value":"boolean nocollide Whether to collide with nothing except world or not.","name":"nocollide","description":"Whether to collide with nothing except world or not."}],"class":"function","name":"setNocollideAll","description":" Set's the entity to collide with nothing but the world. Alias to entity:setCollisionGroup(COLLISION_GROUP_WORLD)"},"getBrushPlane":{"path":"libs_sh/entities.lua#L1782","returns":[{"type":"Vector","value":"Vector The origin of the plane","description":"The origin of the plane"},{"type":"Vector","value":"Vector The normal of the plane","description":"The normal of the plane"},{"type":"number","value":"number The distance to the plane","description":"The distance to the plane"}],"realm":"shared","params":[{"type":"number","value":"number id Plane index. Starts from 0","name":"id","description":"Plane index. Starts from 0"}],"class":"function","name":"getBrushPlane","description":" Returns info about the given brush plane"},"getBrushSurfaces":{"path":"libs_sh/entities.lua#L1769","returns":[{"type":"table","value":"table Table of SurfaceInfos if the entity has a brush model, or no value otherwise.","description":"Table of SurfaceInfos if the entity has a brush model, or no value otherwise."}],"realm":"shared","class":"function","name":"getBrushSurfaces","description":" Returns a table of brushes surfaces for brush model entities."},"getSequenceInfo":{"path":"libs_sh/entities.lua#L1364","returns":[{"type":"table","value":"table Animation info","description":"Animation info"}],"realm":"shared","params":[{"type":"number","value":"number id The ID of the animation","name":"id","description":"The ID of the animation"}],"class":"function","name":"getSequenceInfo","description":" Gets various information about the specified animation"},"getAttachmentParent":{"path":"libs_sh/entities.lua#L678","returns":[{"type":"number","value":"number Index of the attachment the entity is parented to or 0","description":"Index of the attachment the entity is parented to or 0"}],"realm":"shared","class":"function","name":"getAttachmentParent","description":" Gets the attachment index the entity is parented to"},"getDTInt":{"path":"libs_sh/entities.lua#L1841","returns":[{"type":"number?","value":"number? The int or nil if it doesn't exist","description":"The int or nil if it doesn't exist"}],"realm":"shared","params":[{"type":"number","value":"number key The number key. Valid keys are 0 - 31","name":"key","description":"The number key. Valid keys are 0 - 31"}],"class":"function","name":"getDTInt","description":" Gets a datatable int"},"isOnGround":{"path":"libs_sh/entities.lua#L884","returns":[{"type":"boolean","value":"boolean If it's flag is set or not","description":"If it's flag is set or not"}],"realm":"shared","class":"function","name":"isOnGround","description":" Checks if the entity ONGROUND flag is set"},"getHitBoxSetCount":{"path":"libs_sh/entities.lua#L1751","returns":[{"type":"number","value":"number Number of hitbox sets.","description":"Number of hitbox sets."}],"realm":"shared","class":"function","name":"getHitBoxSetCount","description":" Returns entity's number of hitbox sets."},"getCreationID":{"path":"libs_sv/entities.lua#L1036","returns":[{"type":"number","value":"number The creation ID","description":"The creation ID"}],"realm":"server","class":"function","name":"getCreationID","description":" Returns entity's creation ID (similar to entIndex, but increments monotonically)"},"getFlexScale":{"path":"libs_sh/entities.lua#L1525","returns":[{"type":"number","value":"number The scale of the flexes","description":"The scale of the flexes"}],"realm":"shared","class":"function","name":"getFlexScale","description":" Gets the scale of the entity flexes"},"getPhysicsObjectNum":{"path":"libs_sh/entities.lua#L770","returns":[{"type":"PhysObj","value":"PhysObj The physics object of the entity","description":"The physics object of the entity"}],"realm":"shared","params":[{"type":"number","value":"number id The physics object id (starts at 0)","name":"id","description":"The physics object id (starts at 0)"}],"class":"function","name":"getPhysicsObjectNum","description":" Gets a physics objects of an entity"},"lookupBodygroup":{"path":"libs_sh/entities.lua#L553","returns":[{"type":"number","value":"number The bodygroup index","description":"The bodygroup index"}],"realm":"shared","params":[{"type":"string","value":"string name The bodygroup's string name","name":"name","description":"The bodygroup's string name"}],"class":"function","name":"lookupBodygroup","description":" Returns the bodygroup index of the entity with given name"},"isVehicle":{"path":"libs_sh/entities.lua#L870","returns":[{"type":"boolean","value":"boolean True if vehicle, false if not","description":"True if vehicle, false if not"}],"realm":"shared","class":"function","name":"isVehicle","description":" Checks if an entity is a vehicle."},"toHologram":{"path":"libs_sh/hologram.lua#L89","returns":[{"type":"Hologram","value":"Hologram Hologram instance","description":"Hologram instance"}],"realm":"shared","class":"function","name":"toHologram","description":" Casts a hologram entity into the hologram type"},"setContents":{"path":"libs_sv/entities.lua#L791","realm":"server","params":[{"type":"number","value":"number contents The CONTENTS enum","name":"contents","description":"The CONTENTS enum"}],"class":"function","name":"setContents","description":" Sets the contents flag of the physobject"},"getHitBoxSet":{"path":"libs_sh/entities.lua#L1743","returns":[{"type":"number?","value":"number? Hitbox set number, nil if entity has no hitboxes.","description":"Hitbox set number, nil if entity has no hitboxes."},{"type":"string?","value":"string? Hitbox set name, nil if entity has no hitboxes.","description":"Hitbox set name, nil if entity has no hitboxes."}],"realm":"shared","class":"function","name":"getHitBoxSet","description":" Returns entity's current hit box set."},"getHitBoxBone":{"path":"libs_sh/entities.lua#L1732","returns":[{"type":"number","value":"number Bone ID","description":"Bone ID"}],"realm":"shared","params":[{"type":"number","value":"number hitbox The number of the hitbox.","name":"hitbox","description":"The number of the hitbox."},{"type":"number","value":"number group The number of the hitbox group, 0 in most cases.","name":"group","description":"The number of the hitbox group, 0 in most cases."}],"class":"function","name":"getHitBoxBone","description":" Gets the bone the given hitbox is attached to."},"getRight":{"path":"libs_sh/entities.lua#L1652","returns":[{"type":"Vector","value":"Vector Vector right","description":"Vector right"}],"realm":"shared","class":"function","name":"getRight","description":" Gets the entity's right vector"},"getErroredPlayers":{"path":"libs_sh/entities.lua#L976","returns":[{"type":"table","value":"table A table containing the errored players.","description":"A table containing the errored players."}],"realm":"server","class":"function","name":"getErroredPlayers","description":" Gets all players the specified starfall errored for.\n This excludes the owner of the starfall chip."},"entOwner":{"path":"libs_sh/entities.lua#L1700","returns":[{"type":"Entity","value":"Entity Owner","description":"Owner"}],"realm":"shared","class":"function","name":"entOwner","description":" Returns the game assigned owner of an entity. This doesn't take CPPI into account and will return nil for most standard entities.\n Used on entities with custom physics like held SWEPs and fired bullets in which case player entity should be returned."},"setPersistent":{"path":"libs_sh/entities.lua#L1683","realm":"shared","params":[{"type":"boolean","value":"boolean persist True to make persistent","name":"persist","description":"True to make persistent"}],"class":"function","name":"setPersistent","description":" Marks entity as persistent, disallowing players from physgunning it. Persistent entities save on server shutdown when sbox_persist is set"},"setFlexScale":{"path":"libs_sh/entities.lua#L1531","realm":"shared","params":[{"type":"number","value":"number scale The scale of the flexes to set","name":"scale","description":"The scale of the flexes to set"}],"class":"function","name":"setFlexScale","description":" Sets the scale of the entity flexes"},"translateBoneToPhysBone":{"path":"libs_sh/entities.lua#L742","returns":[{"type":"number","value":"number The physobj id","description":"The physobj id"}],"realm":"shared","params":[{"type":"number","value":"number boneid The ragdoll boneid","name":"boneid","description":"The ragdoll boneid"}],"class":"function","name":"translateBoneToPhysBone","description":" Converts a ragdoll bone id to the corresponding physobject id"},"getMassCenterW":{"path":"libs_sh/entities.lua#L1220","returns":[{"type":"Vector","value":"Vector The position vector of the mass center","description":"The position vector of the mass center"}],"realm":"shared","class":"function","name":"getMassCenterW","description":" Returns the world position of the entity's mass center"},"isEffectActive":{"path":"libs_sh/entities.lua#L1673","returns":[{"type":"boolean","value":"boolean True or false","description":"True or false"}],"realm":"shared","params":[{"type":"number","value":"number effect The effect to check. EF table values","name":"effect","description":"The effect to check. EF table values"}],"class":"function","name":"isEffectActive","description":" Checks if an engine effect is applied to the entity"},"getSolid":{"path":"libs_sh/entities.lua#L718","returns":[{"type":"number","value":"number The solid enum of the entity. https://wiki.facepunch.com/gmod/Enums/SOLID","description":"The solid enum of the entity. https://wiki.facepunch.com/gmod/Enums/SOLID"}],"realm":"shared","class":"function","name":"getSolid","description":" Gets the solid enum of the entity"},"isConstraint":{"path":"libs_sv/entities.lua#L757","returns":[{"type":"boolean","value":"boolean If the entity is a constraint","description":"If the entity is a constraint"}],"realm":"server","class":"function","name":"isConstraint","description":" Returns if the entity is a constraint."},"setBodygroup":{"path":"libs_sh/entities.lua#L517","realm":"shared","params":[{"type":"number","value":"number bodygroup The ID of the bodygroup you're setting.","name":"bodygroup","description":"The ID of the bodygroup you're setting."},{"type":"number","value":"number value The value you're setting the bodygroup to.","name":"value","description":"The value you're setting the bodygroup to."}],"class":"function","name":"setBodygroup","description":" Sets the bodygroup of the entity"},"setSolid":{"path":"libs_sv/entities.lua#L651","realm":"server","params":[{"type":"boolean","value":"boolean solid Should the entity be solid?","name":"solid","description":"Should the entity be solid?"}],"class":"function","name":"setSolid","description":" Sets the entity to be Solid or not."},"getModelScale":{"path":"libs_sh/entities.lua#L1577","returns":[{"type":"number","value":"number Scale of the model","description":"Scale of the model"}],"realm":"shared","class":"function","name":"getModelScale","description":" Returns the model's scale"},"isLocked":{"path":"libs_sh/darkrp2.lua#L822","returns":[{"type":"boolean","value":"boolean Whether it's locked.","description":"Whether it's locked."}],"realm":"server","class":"function","name":"isLocked","description":" Get whether this door/vehicle is locked. DarkRP only."},"getBoneParent":{"path":"libs_sh/entities.lua#L1107","returns":[{"type":"number","value":"number Parent index of the bone. Returns -1 on error","description":"Parent index of the bone. Returns -1 on error"}],"realm":"shared","params":[{"type":"number?","value":"number? bone Bone index. (def 0)","name":"bone","description":"Bone index. (def 0)"}],"class":"function","name":"getBoneParent","description":" Returns the parent index of an entity's bone"},"getEyePos":{"path":"libs_sh/entities.lua#L1605","returns":[{"type":"Vector","value":"Vector Eye position of the entity","description":"Eye position of the entity"},{"type":"Vector?","value":"Vector? In case of a ragdoll, the position of the second eye","description":"In case of a ragdoll, the position of the second eye"}],"realm":"shared","class":"function","name":"getEyePos","description":" Gets the entity's eye position"},"getPhysicsObjectCount":{"path":"libs_sh/entities.lua#L756","returns":[{"type":"number","value":"number The number of physics objects on the entity","description":"The number of physics objects on the entity"}],"realm":"shared","class":"function","name":"getPhysicsObjectCount","description":" Gets the number of physicsobjects of an entity"},"getColor":{"path":"libs_sh/entities.lua#L784","returns":[{"type":"Color","value":"Color Color","description":"Color"}],"realm":"shared","class":"function","name":"getColor","description":" Gets the color of an entity"},"ignite":{"path":"libs_sv/entities.lua#L614","realm":"server","params":[{"type":"number","value":"number length How long the fire lasts","name":"length","description":"How long the fire lasts"},{"type":"number?","value":"number? radius (optional) How large the fire hitbox is (entity obb is the max)","name":"radius","description":"(optional) How large the fire hitbox is (entity obb is the max)"}],"class":"function","name":"ignite","description":" Ignites an entity"},"linkComponent":{"path":"libs_sv/entities.lua#L219","realm":"server","params":[{"type":"Entity?","value":"Entity? e Entity to link the component to, a vehicle or starfall for huds, or a starfall for screens. nil to clear links.","name":"e","description":"Entity to link the component to, a vehicle or starfall for huds, or a starfall for screens. nil to clear links."}],"class":"function","name":"linkComponent","description":" Links starfall components to a starfall processor or vehicle. Screen can only connect to processor. HUD can connect to processor and vehicle."},"isMoneyBag":{"path":"libs_sh/darkrp2.lua#L864","returns":[{"type":"boolean","value":"boolean Whether this entity is a money bag.","description":"Whether this entity is a money bag."}],"realm":"shared","class":"function","name":"isMoneyBag","description":" Get whether this entity is a \"money bag\", i.e. dropped money from a money printer or /dropmoney. DarkRP only."},"getBoneCount":{"path":"libs_sh/entities.lua#L1091","returns":[{"type":"number","value":"number Number of bones","description":"Number of bones"}],"realm":"shared","class":"function","name":"getBoneCount","description":" Returns the number of an entity's bones"},"isSolid":{"path":"libs_sh/entities.lua#L730","returns":[{"type":"boolean","value":"boolean whether an entity is solid or not","description":"whether an entity is solid or not"}],"realm":"shared","class":"function","name":"isSolid","description":" Gets whether an entity is solid or not"},"isOnFire":{"path":"libs_sh/entities.lua#L891","returns":[{"type":"boolean","value":"boolean If the entity is on fire or not","description":"If the entity is on fire or not"}],"realm":"shared","class":"function","name":"isOnFire","description":" Returns if the entity is ignited"},"enableSphere":{"path":"libs_sv/entities.lua#L835","realm":"server","params":[{"type":"boolean","value":"boolean enabled Should the entity be spherical?","name":"enabled","description":"Should the entity be spherical?"},{"type":"number?","value":"number? radius Optional custom radius to use (max 500). Otherwise the prop's obb is used","name":"radius","description":"Optional custom radius to use (max 500). Otherwise the prop's obb is used"}],"class":"function","name":"enableSphere","description":" Sets the physics of an entity to be a sphere"},"getEyeAngles":{"path":"libs_sh/entities.lua#L1598","returns":[{"type":"Angle","value":"Angle Angles of the entity's eyes","description":"Angles of the entity's eyes"}],"realm":"shared","class":"function","name":"getEyeAngles","description":" Gets the entity's eye angles"},"getSequence":{"path":"libs_sh/entities.lua#L1350","returns":[{"type":"number","value":"number The sequence number","description":"The sequence number"}],"realm":"shared","class":"function","name":"getSequence","description":" Gets the current playing sequence"},"getHealth":{"path":"libs_sh/entities.lua#L1591","returns":[{"type":"number","value":"number Health of the entity","description":"Health of the entity"}],"realm":"shared","class":"function","name":"getHealth","description":" Gets the health of an entity"},"getMaxHealth":{"path":"libs_sh/entities.lua#L1584","returns":[{"type":"number","value":"number Max Health of the entity","description":"Max Health of the entity"}],"realm":"shared","class":"function","name":"getMaxHealth","description":" Gets the max health of an entity"},"getSolidFlags":{"path":"libs_sh/entities.lua#L724","returns":[{"type":"number","value":"number The solid flag enum of the entity. https://wiki.facepunch.com/gmod/Enums/FSOLID","description":"The solid flag enum of the entity. https://wiki.facepunch.com/gmod/Enums/FSOLID"}],"realm":"shared","class":"function","name":"getSolidFlags","description":" Gets the solid flag enum of the entity"},"getModelRadius":{"path":"libs_sh/entities.lua#L1570","returns":[{"type":"number","value":"number Radius of the model","description":"Radius of the model"}],"realm":"shared","class":"function","name":"getModelRadius","description":" Returns the model's radius"},"getModelBounds":{"path":"libs_sh/entities.lua#L1553","returns":[{"type":"Vector","value":"Vector Minimum vector of the bounds","description":"Minimum vector of the bounds"},{"type":"Vector","value":"Vector Maximum vector of the bounds","description":"Maximum vector of the bounds"}],"realm":"shared","class":"function","name":"getModelBounds","description":" Returns the entity's model bounds. This is different than the collision bounds/hull.\n This is not scaled with Entity:SetModelScale and will return the model's original, unmodified mins and maxs."},"getModel":{"path":"libs_sh/entities.lua#L1546","returns":[{"type":"string","value":"string Model of the entity","description":"Model of the entity"}],"realm":"shared","class":"function","name":"getModel","description":" Gets the model of an entity"},"setCustomPropShadowForce":{"path":"libs_sv/entities.lua#L323","realm":"server","params":[{"name":"table","description":"|false data Shadow physics data, excluding 'deltatime'. 'teleportdistance' higher than 0 requires 'entities.setPos'. Pass a falsy value to disable custom physics entirely"}],"class":"function","name":"setCustomPropShadowForce","description":" Sets a custom prop's shadow forces, moving the entity to the desired position and angles\n This gets overriden by Entity.setCustomPropForces and cannot be used together\n See available parameters here: https://wiki.facepunch.com/gmod/PhysObj:ComputeShadowControl"},"applyForceCenter":{"path":"libs_sv/entities.lua#L422","realm":"server","params":[{"type":"Vector","value":"Vector vec The force vector","name":"vec","description":"The force vector"}],"class":"function","name":"applyForceCenter","description":" Applies linear force to the entity"},"getFlexWeight":{"path":"libs_sh/entities.lua#L1486","returns":[{"type":"number","value":"number The weight of the flex","description":"The weight of the flex"}],"realm":"shared","params":[{"type":"number","value":"number flexid The id of the flex","name":"flexid","description":"The id of the flex"}],"class":"function","name":"getFlexWeight","description":" Gets the weight (value) of a flex."},"hasFlexManipulations":{"path":"libs_sh/entities.lua#L1479","returns":[{"type":"boolean","value":"boolean True if the entity has flex manipulations, false otherwise.","description":"True if the entity has flex manipulations, false otherwise."}],"realm":"shared","class":"function","name":"hasFlexManipulations","description":" Returns whether or not the the entity has had flex manipulations performed with Entity:setFlexWeight or Entity:setFlexScale."},"__tostring":{"path":"libs_sh/entities.lua#L88","returns":[{"type":"string","value":"string String representation of the entity","description":"String representation of the entity"}],"realm":"shared","class":"function","name":"__tostring","description":" Gets the string representation of the entity"},"getFlexName":{"path":"libs_sh/entities.lua#L1470","returns":[{"type":"string","value":"string The flex name","description":"The flex name"}],"realm":"shared","params":[{"type":"number","value":"number flexid The flex id to look up name of.","name":"flexid","description":"The flex id to look up name of."}],"class":"function","name":"getFlexName","description":" Returns flex name."},"getFlexByName":{"path":"libs_sh/entities.lua#L1461","returns":[{"type":"number","value":"number The ID of the flex based on given name.","description":"The ID of the flex based on given name."}],"realm":"shared","params":[{"type":"string","value":"string flexname The name of the flex to get the ID of. Case sensitive.","name":"flexname","description":"The name of the flex to get the ID of. Case sensitive."}],"class":"function","name":"getFlexByName","description":" Returns the ID of the flex based on given name."},"getRenderFX":{"path":"libs_sh/entities.lua#L656","returns":[{"type":"number","value":"number Renderfx, https://wiki.facepunch.com/gmod/Enums/kRenderFx","description":"Renderfx, https://wiki.facepunch.com/gmod/Enums/kRenderFx"}],"realm":"shared","class":"function","name":"getRenderFX","description":" Gets the renderfx of the entity"},"isWeapon":{"path":"libs_sh/entities.lua#L863","returns":[{"type":"boolean","value":"boolean True if weapon, false if not","description":"True if weapon, false if not"}],"realm":"shared","class":"function","name":"isWeapon","description":" Checks if an entity is a weapon."},"getFlexes":{"path":"libs_sh/entities.lua#L1450","returns":[{"type":"table","value":"table Table of flexes","description":"Table of flexes"}],"realm":"shared","class":"function","name":"getFlexes","description":" Returns a table of flexname -> flexid pairs for use in flex functions."},"lookupAttachment":{"path":"libs_sh/entities.lua#L685","returns":[{"type":"number","value":"number Number of the attachment index, or 0 if it doesn't exist","description":"Number of the attachment index, or 0 if it doesn't exist"}],"realm":"shared","params":[{"type":"string","value":"string name of the attachment to lookup","name":"name","description":"of the attachment to lookup"}],"class":"function","name":"lookupAttachment","description":" Gets the attachment index via the entity and it's attachment name"},"setElasticity":{"path":"libs_sv/entities.lua#L414","realm":"server","params":[{"type":"number","value":"number elasticity","name":"elasticity","description":""}],"class":"function","name":"setElasticity","description":" Sets the elasticity of the entity"},"removeCollisionListener":{"path":"libs_sv/entities.lua#L525","realm":"server","params":[{"type":"string?","value":"string? name The name of the collision listener to remove. (default: \"\")","name":"name","description":"The name of the collision listener to remove. (default: \"\")"}],"class":"function","name":"removeCollisionListener","description":" Removes a collision listener from the entity"},"getManipulateBoneAngles":{"path":"libs_sh/entities.lua#L1128","returns":[{"type":"Angle","value":"Angle Manipulate angle of the bone","description":"Manipulate angle of the bone"}],"realm":"shared","params":[{"type":"number","value":"number bone Bone index. (def 0)","name":"bone","description":"Bone index. (def 0)"}],"class":"function","name":"getManipulateBoneAngles","description":" Returns the manipulate angle of the bone (relative to its default angle)"},"getPoseIndex":{"path":"libs_sh/entities.lua#L1428","returns":[{"type":"number","value":"number Pose index or -1 if not found","description":"Pose index or -1 if not found"}],"realm":"shared","params":[{"type":"string","value":"string pose Pose name","name":"pose","description":"Pose name"}],"class":"function","name":"getPoseIndex","description":" Returns pose index corresponding to the given name"},"getPhysMaterial":{"path":"libs_sv/entities.lua#L731","returns":[{"type":"string","value":"string The physical material","description":"The physical material"}],"realm":"server","class":"function","name":"getPhysMaterial","description":" Get the physical material of the entity"},"getAngles":{"path":"libs_sh/entities.lua#L1230","returns":[{"type":"Angle","value":"Angle The angle","description":"The angle"}],"realm":"shared","class":"function","name":"getAngles","description":" Returns the angle of the entity"},"getBodygroupName":{"path":"libs_sh/entities.lua#L562","returns":[{"type":"string","value":"string The bodygroup name","description":"The bodygroup name"}],"realm":"shared","params":[{"type":"number","value":"number id The bodygroup's number index","name":"id","description":"The bodygroup's number index"}],"class":"function","name":"getBodygroupName","description":" Returns the bodygroup name of the entity with given index"},"setParent":{"path":"libs_sh/entities.lua#L381","realm":"shared","params":[{"type":"Entity?","value":"Entity? parent Entity parent (nil to unparent)","name":"parent","description":"Entity parent (nil to unparent)"},{"type":"number|string|nil","value":"number|string|nil attachment Optional attachment name or ID.","name":"attachment","description":"Optional attachment name or ID."},{"type":"number|string|nil","value":"number|string|nil bone Optional bone name or ID. Can't be used at the same time as attachment","name":"bone","description":"Optional bone name or ID. Can't be used at the same time as attachment"}],"class":"function","name":"setParent","description":" Parents or unparents an entity. Only holograms can be parented to players and clientside holograms can only be parented in the CLIENT realm."},"translatePhysBoneToBone":{"path":"libs_sh/entities.lua#L749","returns":[{"type":"number","value":"number The ragdoll bone id","description":"The ragdoll bone id"}],"realm":"shared","params":[{"type":"number","value":"number boneid The physobject id","name":"boneid","description":"The physobject id"}],"class":"function","name":"translatePhysBoneToBone","description":" Converts a physobject id to the corresponding ragdoll bone id"},"getPoseCount":{"path":"libs_sh/entities.lua#L1422","returns":[{"type":"number","value":"number Amount of poses","description":"Amount of poses"}],"realm":"shared","class":"function","name":"getPoseCount","description":" Returns the amount of pose parameters the entity has"},"getAmount":{"path":"libs_sh/darkrp2.lua#L870","returns":[{"type":"number?","value":"number? Amount of money or number of items","description":"Amount of money or number of items"}],"realm":"shared","class":"function","name":"getAmount","description":" Get the amount of money in a \"money bag\" or cheque, or number of items in a dropped item stack. DarkRP only.\n Equivalent to GLua Entity:Getamount."},"getPose":{"path":"libs_sh/entities.lua#L1415","returns":[{"type":"number","value":"number Value of the pose parameter","description":"Value of the pose parameter"}],"realm":"shared","params":[{"type":"string","value":"string pose Pose parameter name","name":"pose","description":"Pose parameter name"}],"class":"function","name":"getPose","description":" Get the pose value of an animation"},"setPose":{"path":"libs_sh/entities.lua#L1405","realm":"shared","params":[{"type":"string","value":"string pose Name of the pose parameter","name":"pose","description":"Name of the pose parameter"},{"type":"number","value":"number value Value to set it to.","name":"value","description":"Value to set it to."}],"class":"function","name":"setPose","description":" Set the pose value of an animation. Turret/Head angles for example."},"canDraw":{"path":"libs_sh/entities.lua#L271","returns":[{"type":"boolean","value":"boolean Whether the entity can be drawn","description":"Whether the entity can be drawn"}],"realm":"client","class":"function","name":"canDraw","description":" Returns whether or not the entity can be drawn using Entity.draw function\n Checks Entity against a predefined class whitelist\n Entities that have RenderOverride defined or are parented cannot be drawn"},"breakEnt":{"path":"libs_sv/entities.lua#L604","realm":"server","class":"function","name":"breakEnt","description":" Invokes the entity's breaking animation and removes it."},"sequenceDuration":{"path":"libs_sh/entities.lua#L1395","returns":[{"type":"number","value":"number Length of the animation in seconds","description":"Length of the animation in seconds"}],"realm":"shared","params":[{"type":"number?","value":"number? id (Optional) The id of the sequence, or will default to the currently playing sequence","name":"id","description":"(Optional) The id of the sequence, or will default to the currently playing sequence"}],"class":"function","name":"sequenceDuration","description":" Get the length of an animation"},"getSkin":{"path":"libs_sh/entities.lua#L598","returns":[{"type":"number","value":"number Skin number","description":"Skin number"}],"realm":"shared","class":"function","name":"getSkin","description":" Gets the skin number of the entity"},"getSequenceList":{"path":"libs_sh/entities.lua#L1377","returns":[{"type":"table","value":"table List of animations, starts at index 0 where value is the animation's name","description":"List of animations, starts at index 0 where value is the animation's name"}],"realm":"shared","class":"function","name":"getSequenceList","description":" Returns all animations of the entity"},"setSubMaterial":{"path":"libs_sh/entities.lua#L482","realm":"shared","params":[{"type":"number","value":"number index Submaterial index.","name":"index","description":"Submaterial index."},{"type":"string","value":"string material New material name.","name":"material","description":"New material name."}],"class":"function","name":"setSubMaterial","description":" Sets the submaterial of the entity"},"getClipping":{"path":"libs_sh/entities.lua#L791","returns":[{"type":"table","value":"table Table containing the clipdata","description":"Table containing the clipdata"}],"realm":"shared","class":"function","name":"getClipping","description":" Gets the clipping of an entity"},"getSequenceName":{"path":"libs_sh/entities.lua#L1356","returns":[{"type":"string","value":"string The sequence name","description":"The sequence name"}],"realm":"shared","params":[{"type":"number","value":"number id The id of the animation","name":"id","description":"The id of the animation"}],"class":"function","name":"getSequenceName","description":" Gets the name of a sequence"},"lookupSequence":{"path":"libs_sh/entities.lua#L1341","returns":[{"type":"number","value":"number Animation index or -1 if invalid","description":"Animation index or -1 if invalid"}],"realm":"shared","params":[{"type":"string","value":"string animation Name of the animation","name":"animation","description":"Name of the animation"}],"class":"function","name":"lookupSequence","description":" Gets the animation number from the animation name"},"getMoveType":{"path":"libs_sh/entities.lua#L736","returns":[{"type":"number","value":"number The movetype enum of the entity. https://wiki.facepunch.com/gmod/Enums/MOVETYPE","description":"The movetype enum of the entity. https://wiki.facepunch.com/gmod/Enums/MOVETYPE"}],"realm":"shared","class":"function","name":"getMoveType","description":" Gets the movetype enum of the entity"},"obbCenterW":{"path":"libs_sh/entities.lua#L1179","returns":[{"type":"Vector","value":"Vector The position vector of the outer bounding box center","description":"The position vector of the outer bounding box center"}],"realm":"shared","class":"function","name":"obbCenterW","description":" Returns the world position of the entity's outer bounding box"},"worldToLocal":{"path":"libs_sh/entities.lua#L1317","returns":[{"type":"Vector","value":"Vector data as local space vector","description":"data as local space vector"}],"realm":"shared","params":[{"type":"Vector","value":"Vector data World space vector","name":"data","description":"World space vector"}],"class":"function","name":"worldToLocal","description":" Converts a vector in world space to entity local space"},"getBoneMatrix":{"path":"libs_sh/entities.lua#L1060","returns":[{"type":"VMatrix","value":"VMatrix The matrix","description":"The matrix"}],"realm":"shared","params":[{"type":"number?","value":"number? bone Bone index. (def 0)","name":"bone","description":"Bone index. (def 0)"}],"class":"function","name":"getBoneMatrix","description":" Returns the matrix of the entity's bone. Note: this method is slow/doesnt work well if the entity isn't animated."},"worldToLocalVector":{"path":"libs_sh/entities.lua#L1325","returns":[{"type":"Vector","value":"Vector data as local space direction vector","description":"data as local space direction vector"}],"realm":"shared","params":[{"type":"Vector","value":"Vector data World space direction vector","name":"data","description":"World space direction vector"}],"class":"function","name":"worldToLocalVector","description":" Converts a direction vector in world space to entity local space"},"localToWorldAngles":{"path":"libs_sh/entities.lua#L1309","returns":[{"type":"Angle","value":"Angle data as world space angle","description":"data as world space angle"}],"realm":"shared","params":[{"type":"Angle","value":"Angle data Local space angle","name":"data","description":"Local space angle"}],"class":"function","name":"localToWorldAngles","description":" Converts an angle in entity local space to world space"},"setAngleVelocity":{"path":"libs_sv/entities.lua#L370","realm":"server","params":[{"type":"Vector","value":"Vector angvel The local angvel vector to set","name":"angvel","description":"The local angvel vector to set"}],"class":"function","name":"setAngleVelocity","description":" Set the angular velocity of an object"},"setSheetColor":{"path":"libs_sh/entities.lua#L213","realm":"client","params":[{"type":"Color","value":"Color clr RGB color to use, alpha channel not supported","name":"clr","description":"RGB color to use, alpha channel not supported"}],"class":"function","name":"setSheetColor","description":" Sets the sheet color of a player-model\n Can only be used on players, bots, ragdolls, holograms and Starfall NextBots"},"isValid":{"path":"libs_sh/entities.lua#L849","returns":[{"type":"boolean","value":"boolean True if valid, false if not","description":"True if valid, false if not"}],"realm":"shared","class":"function","name":"isValid","description":" Checks if an entity is valid."},"getAngleVelocityAngle":{"path":"libs_sh/entities.lua#L1283","returns":[{"type":"Angle","value":"Angle The angular velocity as an angle","description":"The angular velocity as an angle"}],"realm":"shared","class":"function","name":"getAngleVelocityAngle","description":" Returns the angular velocity of the entity"},"setLOD":{"path":"libs_sh/entities.lua#L258","realm":"client","params":[{"type":"number","value":"number lod The Level Of Detail model ID to use.","name":"lod","description":"The Level Of Detail model ID to use."}],"class":"function","name":"setLOD","description":" Sets the Level Of Detail model to use with this entity. This may not work for all models if the model doesn't include any LOD sub models.\n This function works exactly like the clientside r_lod convar and takes priority over it.\n -1 leaves the engine to automatically set the Level of Detail. The Level Of Detail may range from 0 to 8, with 0 being the highest quality and 8 the lowest."},"getLocalVelocity":{"path":"libs_sh/entities.lua#L1266","returns":[{"type":"Vector","value":"Vector Vector velocity of the physics object local to itself","description":"Vector velocity of the physics object local to itself"}],"realm":"shared","class":"function","name":"getLocalVelocity","description":" Gets the velocity of the entity in its local coordinate system"},"removeTrails":{"path":"libs_sv/entities.lua#L988","realm":"server","class":"function","name":"removeTrails","description":" Removes trails from the entity"},"getMass":{"path":"libs_sh/entities.lua#L1237","returns":[{"type":"number","value":"number The numerical mass","description":"The numerical mass"}],"realm":"shared","class":"function","name":"getMass","description":" Returns the mass of the entity"},"setMaterial":{"path":"libs_sh/entities.lua#L464","realm":"shared","params":[{"type":"string","value":"string material New material name.","name":"material","description":"New material name."}],"class":"function","name":"setMaterial","description":" Sets the material of the entity"},"setBoneMatrix":{"path":"libs_sh/entities.lua#L1070","realm":"shared","params":[{"type":"number","value":"number bone The bone ID","name":"bone","description":"The bone ID"},{"type":"VMatrix","value":"VMatrix matrix The matrix to set","name":"matrix","description":"The matrix to set"}],"class":"function","name":"setBoneMatrix","description":" Sets the bone matrix of given bone to given matrix. See also Entity:getBoneMatrix."},"testPVS":{"path":"libs_sv/entities.lua#L1018","returns":[{"type":"boolean","value":"boolean If the Entity/Vector is within the PVS","description":"If the Entity/Vector is within the PVS"}],"realm":"server","params":[{"type":"Entity|Vector","value":"Entity|Vector other Entity or Vector to test","name":"other","description":"Entity or Vector to test"}],"class":"function","name":"testPVS","description":" Check if the given Entity or Vector is within this entity's PVS (Potentially Visible Set). See: https://developer.valvesoftware.com/wiki/PVS"},"getMassCenter":{"path":"libs_sh/entities.lua#L1210","returns":[{"type":"Vector","value":"Vector The position vector of the mass center","description":"The position vector of the mass center"}],"realm":"shared","class":"function","name":"getMassCenter","description":" Returns the local position of the entity's mass center"},"draw":{"path":"libs_sh/entities.lua#L280","realm":"client","class":"function","name":"draw","description":" Draws the entity, requires 3D rendering context\n Only certain, whitelisted entities can be drawn. They can't be parented or have RenderOverride defined\n Use Entity.canDraw to check if you can draw the entity"},"localToWorldVector":{"path":"libs_sh/entities.lua#L1301","returns":[{"type":"Vector","value":"Vector data as world space vector direction","description":"data as world space vector direction"}],"realm":"shared","params":[{"type":"Vector","value":"Vector data Local space vector direction","name":"data","description":"Local space vector direction"}],"class":"function","name":"localToWorldVector","description":" Converts a direction vector in entity local space to world space"},"getDoorOwner":{"path":"libs_sh/darkrp2.lua#L830","returns":[{"type":"Player?","value":"Player? The owner of the door, or nil if the door is unowned.","description":"The owner of the door, or nil if the door is unowned."}],"realm":"shared","class":"function","name":"getDoorOwner","description":" Get the owner of a door. DarkRP only."},"getBodygroups":{"path":"libs_sh/entities.lua#L546","returns":[{"type":"table","value":"table Bodygroups as a table of BodyGroupDatas. https://wiki.facepunch.com/gmod/Structures/BodyGroupData","description":"Bodygroups as a table of BodyGroupDatas. https://wiki.facepunch.com/gmod/Structures/BodyGroupData"}],"realm":"shared","class":"function","name":"getBodygroups","description":" Returns a list of all bodygroups of the entity"},"setMaxHealth":{"path":"libs_sh/entities.lua#L1004","realm":"server","params":[{"type":"number","value":"number newmaxhealth New max health value.","name":"newmaxhealth","description":"New max health value."}],"class":"function","name":"setMaxHealth","description":" Sets the maximum health for entity. Note, that you can still set entity's health above this amount with Entity:setHealth."},"obbMaxs":{"path":"libs_sh/entities.lua#L1194","returns":[{"type":"Vector","value":"Vector The max bounding box vector","description":"The max bounding box vector"}],"realm":"shared","class":"function","name":"obbMaxs","description":" Returns max local bounding box vector of the entity"},"worldToLocalAngles":{"path":"libs_sh/entities.lua#L1333","returns":[{"type":"Angle","value":"Angle data as local space angle","description":"data as local space angle"}],"realm":"shared","params":[{"type":"Angle","value":"Angle data World space angle","name":"data","description":"World space angle"}],"class":"function","name":"worldToLocalAngles","description":" Converts an angle in world space to entity local space"},"obbCenter":{"path":"libs_sh/entities.lua#L1172","returns":[{"type":"Vector","value":"Vector The position vector of the outer bounding box center","description":"The position vector of the outer bounding box center"}],"realm":"shared","class":"function","name":"obbCenter","description":" Returns the local position of the entity's outer bounding box"},"getShipmentContents":{"path":"libs_sh/darkrp2.lua#L895","returns":[{"type":"table?","value":"table? Contents, or nil if not a shipment","description":"Contents, or nil if not a shipment"}],"realm":"shared","class":"function","name":"getShipmentContents","description":" Get the info for the contents of the shipment. DarkRP only.\n Equivalent to \"darkrp.getCustomShipments()[ent:getShipmentContentsIndex()]\""},"manipulateBoneJiggle":{"path":"libs_sh/entities.lua#L158","realm":"client","params":[{"type":"number","value":"number bone The bone ID","name":"bone","description":"The bone ID"},{"type":"boolean","value":"boolean enabled Whether to make the bone jiggly or not","name":"enabled","description":"Whether to make the bone jiggly or not"}],"class":"function","name":"manipulateBoneJiggle","description":" Allows manipulation of an entity's bones' jiggle status"},"setInertia":{"path":"libs_sv/entities.lua#L699","realm":"server","params":[{"type":"Vector","value":"Vector vec Inertia tensor","name":"vec","description":"Inertia tensor"}],"class":"function","name":"setInertia","description":" Sets the entity's inertia"},"getBodygroupCount":{"path":"libs_sh/entities.lua#L572","returns":[{"type":"number","value":"number Number of values of specified bodygroup, or 0 if there are none.","description":"Number of values of specified bodygroup, or 0 if there are none."}],"realm":"shared","params":[{"type":"number","value":"number id The ID of the bodygroup to get the count for.","name":"id","description":"The ID of the bodygroup to get the count for."}],"class":"function","name":"getBodygroupCount","description":" Returns the number of possible values for this bodygroup.\n Note that bodygroups are 0-indexed, so this will not return the maximum allowed value."},"getManipulateBoneJiggle":{"path":"libs_sh/entities.lua#L1137","returns":[{"type":"number","value":"number Manipulate jiggle of the bone","description":"Manipulate jiggle of the bone"}],"realm":"shared","params":[{"type":"number?","value":"number? bone Bone index. (def 0)","name":"bone","description":"Bone index. (def 0)"}],"class":"function","name":"getManipulateBoneJiggle","description":" Returns the number manipulate jiggle of the bone (0 - 255)"},"setCollisionGroup":{"path":"libs_sv/entities.lua#L661","realm":"server","params":[{"type":"number","value":"number group The COLLISION_GROUP value to set it to","name":"group","description":"The COLLISION_GROUP value to set it to"}],"class":"function","name":"setCollisionGroup","description":" Sets the entity's collision group"},"getPoseName":{"path":"libs_sh/entities.lua#L1435","returns":[{"type":"string","value":"string Pose name or empty string if not found","description":"Pose name or empty string if not found"}],"realm":"shared","params":[{"type":"number","value":"number id Pose index (starting from 0)","name":"id","description":"Pose index (starting from 0)"}],"class":"function","name":"getPoseName","description":" Returns pose name corresponding to the given index"},"getBonePosition":{"path":"libs_sh/entities.lua#L1116","returns":[{"type":"Vector","value":"Vector Position of the bone","description":"Position of the bone"},{"type":"Angle","value":"Angle Angle of the bone","description":"Angle of the bone"}],"realm":"shared","params":[{"type":"number?","value":"number? bone Bone index. (def 0)","name":"bone","description":"Bone index. (def 0)"}],"class":"function","name":"getBonePosition","description":" Returns the bone's position and angle in world coordinates"},"getMaterial":{"path":"libs_sh/entities.lua#L1617","returns":[{"type":"string","value":"string String material","description":"String material"}],"realm":"shared","class":"function","name":"getMaterial","description":" Gets an entities' material"},"getChipAuthor":{"path":"libs_sh/entities.lua#L909","returns":[{"type":"string","value":"string The author of the starfall chip.","description":"The author of the starfall chip."}],"realm":"shared","class":"function","name":"getChipAuthor","description":" Gets the author of the specified starfall."},"getBoneName":{"path":"libs_sh/entities.lua#L1098","returns":[{"type":"string","value":"string Name of the bone","description":"Name of the bone"}],"realm":"shared","params":[{"type":"number?","value":"number? bone Bone index. (def 0)","name":"bone","description":"Bone index. (def 0)"}],"class":"function","name":"getBoneName","description":" Returns the name of an entity's bone"},"getMatrix":{"path":"libs_sh/entities.lua#L1084","returns":[{"type":"VMatrix","value":"VMatrix The matrix","description":"The matrix"}],"realm":"shared","class":"function","name":"getMatrix","description":" Returns the world transform matrix of the entity"},"setRenderFX":{"path":"libs_sh/entities.lua#L638","realm":"shared","params":[{"type":"number","value":"number renderfx Renderfx to use. http://wiki.facepunch.com/gmod/Enums/kRenderFx","name":"renderfx","description":"Renderfx to use. http://wiki.facepunch.com/gmod/Enums/kRenderFx"}],"class":"function","name":"setRenderFX","description":" Sets the renderfx of the entity, most effects require entity's alpha to be less than 255 to take effect"},"getWaterLevel":{"path":"libs_sh/entities.lua#L1044","returns":[{"type":"number","value":"number The water level. 0 none, 1 slightly, 2 at least halfway, 3 all the way","description":"The water level. 0 none, 1 slightly, 2 at least halfway, 3 all the way"}],"realm":"shared","class":"function","name":"getWaterLevel","description":" Returns how submerged the entity is in water"},"setHealth":{"path":"libs_sh/entities.lua#L994","realm":"server","params":[{"type":"number","value":"number newhealth New health value.","name":"newhealth","description":"New health value."}],"class":"function","name":"setHealth","description":" Sets the health of the entity."},"getClass":{"path":"libs_sh/entities.lua#L1030","returns":[{"type":"string","value":"string The string class name","description":"The string class name"}],"realm":"shared","class":"function","name":"getClass","description":" Returns the class of the entity"},"setCustomPropForces":{"path":"libs_sv/entities.lua#L295","realm":"server","params":[{"type":"Vector","value":"Vector ang Angular Force (Torque)","name":"ang","description":"Angular Force (Torque)"},{"type":"Vector","value":"Vector lin Linear Force","name":"lin","description":"Linear Force"},{"type":"number","value":"number mode The physics mode to use. 0 = Off (disables custom physics entirely), 1 = Local acceleration, 2 = Local force, 3 = Global Acceleration, 4 = Global force","name":"mode","description":"The physics mode to use. 0 = Off (disables custom physics entirely), 1 = Local acceleration, 2 = Local force, 3 = Global Acceleration, 4 = Global force"}],"class":"function","name":"setCustomPropForces","description":" Sets a custom prop's physics simulation forces. Thrusters and balloons use this.\n This takes precedence over Entity.setCustomPropShadowForce and cannot be used together"},"setFrozen":{"path":"libs_sv/entities.lua#L820","realm":"server","params":[{"type":"boolean","value":"boolean freeze Should the entity be frozen?","name":"freeze","description":"Should the entity be frozen?"}],"class":"function","name":"setFrozen","description":" Sets the entity frozen state, same as `Entity.enableMotion` but inverted"},"doNotDuplicate":{"path":"libs_sh/entities.lua#L1014","realm":"server","class":"function","name":"doNotDuplicate","description":" Stops the entity from being saved on duplication or map save."},"getQuaternion":{"path":"libs_sh/quaternion.lua#L841","returns":[{"type":"Quaternion","value":"Quaternion Constructed quaternion","description":"Constructed quaternion"}],"realm":"shared","class":"function","name":"getQuaternion","description":" Converts entity angles to a quaternion"},"getPos":{"path":"libs_sh/entities.lua#L1037","returns":[{"type":"Vector","value":"Vector The position vector","description":"The position vector"}],"realm":"shared","class":"function","name":"getPos","description":" Returns the position of the entity"},"getPhysicsObject":{"path":"libs_sh/entities.lua#L762","returns":[{"type":"PhysObj","value":"PhysObj The main physics object of the entity","description":"The main physics object of the entity"}],"realm":"shared","class":"function","name":"getPhysicsObject","description":" Gets the main physics objects of an entity"},"getChipName":{"path":"libs_sh/entities.lua#L898","returns":[{"type":"string","value":"string The name of the chip","description":"The name of the chip"}],"realm":"shared","class":"function","name":"getChipName","description":" Returns the starfall or expression2's name"},"isSequenceFinished":{"path":"libs_sh/entities.lua#L1389","returns":[{"type":"boolean","value":"boolean True if the animation is currently playing, False otherwise","description":"True if the animation is currently playing, False otherwise"}],"realm":"shared","class":"function","name":"isSequenceFinished","description":" Checks whether the animation is playing"},"getRenderGroup":{"path":"libs_sh/entities.lua#L293","returns":[{"type":"number","value":"number Render group","description":"Render group"}],"realm":"client","class":"function","name":"getRenderGroup","description":" Returns the render group of the entity."},"getQuotaUsed":{"path":"libs_sh/entities.lua#L919","returns":[{"type":"number","value":"number Current quota used this Think","description":"Current quota used this Think"}],"realm":"shared","class":"function","name":"getQuotaUsed","description":" Returns the current count for this Think's CPU Time of the specified starfall.\n This value increases as more executions are done, may not be exactly as you want.\n If used on screens, will show 0 if only rendering is done. Operations must be done in the Think loop for them to be counted."},"enableMotion":{"path":"libs_sv/entities.lua#L806","realm":"server","params":[{"type":"boolean","value":"boolean move Should the entity move?","name":"move","description":"Should the entity move?"}],"class":"function","name":"enableMotion","description":" Sets the entity movement state"},"manipulateBoneScale":{"path":"libs_sh/entities.lua#L126","realm":"client","params":[{"type":"number","value":"number bone The bone ID","name":"bone","description":"The bone ID"},{"type":"Vector","value":"Vector vec The scale it should be manipulated to","name":"vec","description":"The scale it should be manipulated to"}],"class":"function","name":"manipulateBoneScale","description":" Allows manipulation of an entity's bones' scale"},"setPos":{"path":"libs_sv/entities.lua#L545","realm":"server","params":[{"type":"Vector","value":"Vector vec New position","name":"vec","description":"New position"}],"class":"function","name":"setPos","description":" Sets the entity's position. No interpolation will occur clientside, use physobj.setPos to have interpolation."},"applyAngForce":{"path":"libs_sv/entities.lua#L456","realm":"server","params":[{"type":"Angle","value":"Angle ang The force angle","name":"ang","description":"The force angle"}],"class":"function","name":"applyAngForce","description":" Applies angular force to the entity (This function is garbage, use applyTorque instead)"},"setMeshMaterial":{"path":"libs_sh/entities.lua#L191","realm":"client","params":[{"type":"Material?","value":"Material? material The material to set it to or nil to set back to default","name":"material","description":"The material to set it to or nil to set back to default"}],"class":"function","name":"setMeshMaterial","description":" Sets a hologram or custom_prop's custom mesh material"},"isNPC":{"path":"libs_sh/entities.lua#L877","returns":[{"type":"boolean","value":"boolean True if npc, false if not","description":"True if npc, false if not"}],"realm":"shared","class":"function","name":"isNPC","description":" Checks if an entity is an npc."},"use":{"path":"libs_sv/entities.lua#L640","realm":"server","params":[{"type":"number?","value":"number? usetype The USE_ enum use type. (Default: USE_ON)","name":"usetype","description":"The USE_ enum use type. (Default: USE_ON)"},{"type":"number?","value":"number? value The use value (Default: 0)","name":"value","description":"The use value (Default: 0)"}],"class":"function","name":"use","description":" Simulate a Use action on the entity by the chip owner"},"isKeysOwnedBy":{"path":"libs_sh/darkrp2.lua#L856","returns":[{"type":"boolean","value":"boolean Whether this door is (co-)owned by the player.","description":"Whether this door is (co-)owned by the player."}],"realm":"shared","params":[{"type":"Player","value":"Player ply The player to query.","name":"ply","description":"The player to query."}],"class":"function","name":"isKeysOwnedBy","description":" Get whether this door is owned or co-owned by this player."},"setFriction":{"path":"libs_sv/entities.lua#L406","realm":"server","params":[{"type":"number","value":"number friction","name":"friction","description":""}],"class":"function","name":"setFriction","description":" Sets the entity's friction multiplier"},"applyTorque":{"path":"libs_sv/entities.lua#L496","realm":"server","params":[{"type":"Vector","value":"Vector torque The torque vector","name":"torque","description":"The torque vector"}],"class":"function","name":"applyTorque","description":" Applies torque"},"getShipmentContentsIndex":{"path":"libs_sh/darkrp2.lua#L886","returns":[{"type":"number?","value":"number? Index of contents, or nil if not a shipment","description":"Index of contents, or nil if not a shipment"}],"realm":"shared","class":"function","name":"getShipmentContentsIndex","description":" Get the index of the contents of the shipment, which should then be looked up in the output of \"darkrp.getCustomShipments\". DarkRP only.\n Equivalent to GLua Entity:Getcontents.\n You may prefer to use Entity:getShipmentContents instead, although that function is slightly slower."},"worldSpaceAABB":{"path":"libs_sh/entities.lua#L1201","returns":[{"type":"Vector","value":"Vector The min bounding box vector","description":"The min bounding box vector"},{"type":"Vector","value":"Vector The max bounding box vector","description":"The max bounding box vector"}],"realm":"shared","class":"function","name":"worldSpaceAABB","description":" Returns Entity axis aligned bounding box in world coordinates"},"stopSound":{"path":"libs_sh/entities.lua#L341","realm":"shared","params":[{"type":"string","value":"string snd string Soundscript path. See http://wiki.facepunch.com/gmod/Entity:StopSound","name":"snd","description":"string Soundscript path. See http://wiki.facepunch.com/gmod/Entity:StopSound"}],"class":"function","name":"stopSound","description":" Stops a sound on the entity"},"getAllConstrained":{"path":"libs_sv/entities.lua#L904","realm":"server","params":[{"type":"table?","value":"table? filter Optional constraint type filter table where keys are the type name and values are 'true'. \"Wire\" and \"Parent\" are used for wires and parents.","name":"filter","description":"Optional constraint type filter table where keys are the type name and values are 'true'. \"Wire\" and \"Parent\" are used for wires and parents."}],"class":"function","name":"getAllConstrained","description":" Gets a table of all constrained entities to each other"},"remove":{"path":"libs_sv/entities.lua#L595","realm":"server","class":"function","name":"remove","description":" Removes an entity"},"obbSize":{"path":"libs_sh/entities.lua#L1164","returns":[{"type":"Vector","value":"Vector The outer bounding box size","description":"The outer bounding box size"}],"realm":"shared","class":"function","name":"obbSize","description":" Returns the x, y, z size of the entity's outer bounding box (local to the entity)"},"setMass":{"path":"libs_sv/entities.lua#L683","realm":"server","params":[{"type":"number","value":"number mass Mass to set to","name":"mass","description":"Mass to set to"}],"class":"function","name":"setMass","description":" Sets the entity's mass"},"getFriction":{"path":"libs_sv/entities.lua#L400","returns":[{"type":"number","value":"number friction","description":"friction"}],"realm":"server","class":"function","name":"getFriction","description":" Returns how much friction the entity has, default is 1 (100%)"},"getParent":{"path":"libs_sh/entities.lua#L664","returns":[{"type":"Entity?","value":"Entity? Entity's parent or nil if not parented","description":"Entity's parent or nil if not parented"}],"realm":"shared","class":"function","name":"getParent","description":" Gets the parent of an entity"},"getManipulateBoneScale":{"path":"libs_sh/entities.lua#L1155","returns":[{"type":"Vector","value":"Vector Manipulate scale of the bone","description":"Manipulate scale of the bone"}],"realm":"shared","params":[{"type":"number","value":"number bone Bone index. (def 0)","name":"bone","description":"Bone index. (def 0)"}],"class":"function","name":"getManipulateBoneScale","description":" Returns the vector manipulate scale of the bone"},"getKeysTitle":{"path":"libs_sh/darkrp2.lua#L837","returns":[{"type":"string?","value":"string? The title of the door or vehicle, or nil if none is set.","description":"The title of the door or vehicle, or nil if none is set."}],"realm":"shared","class":"function","name":"getKeysTitle","description":" Get the title of this door or vehicle. DarkRP only.\n If you don't know what this is referring to, that's because it's not a commonly used feature. Press F2 on a door and click \"Set Door Title\"."},"addAngleVelocity":{"path":"libs_sv/entities.lua#L385","realm":"server","params":[{"type":"Vector","value":"Vector angvel The local angvel vector to apply","name":"angvel","description":"The local angvel vector to apply"}],"class":"function","name":"addAngleVelocity","description":" Applies a angular velocity to an object"},"setColor":{"path":"libs_sh/entities.lua#L429","realm":"shared","params":[{"type":"Color","value":"Color clr New color","name":"clr","description":"New color"}],"class":"function","name":"setColor","description":" Sets the color of the entity"},"getChildren":{"path":"libs_sh/entities.lua#L671","returns":[{"type":"table","value":"table Table of parented children","description":"Table of parented children"}],"realm":"shared","class":"function","name":"getChildren","description":" Gets the children (the parented entities) of an entity"},"applyForceOffset":{"path":"libs_sv/entities.lua#L437","realm":"server","params":[{"type":"Vector","value":"Vector force The force vector in world coordinates","name":"force","description":"The force vector in world coordinates"},{"type":"Vector","value":"Vector position The force position in world coordinates","name":"position","description":"The force position in world coordinates"}],"class":"function","name":"applyForceOffset","description":" Applies linear force to the entity with an offset"},"getWirelink":{"path":"libs_sv/wire.lua#L629","returns":[{"type":"Wirelink","value":"Wirelink Wirelink of the entity","description":"Wirelink of the entity"}],"realm":"server","class":"function","name":"getWirelink","description":" Returns an entities wirelink"},"entIndex":{"path":"libs_sh/entities.lua#L1023","returns":[{"type":"number","value":"number The numerical index of the entity","description":"The numerical index of the entity"}],"realm":"shared","class":"function","name":"entIndex","description":" Returns the EntIndex of the entity"},"setFlexWeight":{"path":"libs_sh/entities.lua#L1502","realm":"shared","params":[{"type":"number","value":"number flexid The id of the flex","name":"flexid","description":"The id of the flex"},{"type":"number","value":"number weight The weight of the flex","name":"weight","description":"The weight of the flex"}],"class":"function","name":"setFlexWeight","description":" Sets the weight (value) of a flex."},"isWeldedTo":{"path":"libs_sv/entities.lua#L887","returns":[{"type":"Entity","value":"Entity The first welded/parent entity","description":"The first welded/parent entity"}],"realm":"server","class":"function","name":"isWeldedTo","description":" Gets what the entity is welded to. If the entity is parented, returns the parent."},"isPlayerHolding":{"path":"libs_sv/entities.lua#L749","returns":[{"type":"boolean","value":"boolean If the entity is being held or not","description":"If the entity is being held or not"}],"realm":"server","class":"function","name":"isPlayerHolding","description":" Returns true if the entity is being held by a player. Either by Physics gun, Gravity gun or Use-key."},"setNoDraw":{"path":"libs_sh/entities.lua#L447","realm":"shared","params":[{"type":"boolean","value":"boolean draw Whether to draw the entity or not.","name":"draw","description":"Whether to draw the entity or not."}],"class":"function","name":"setNoDraw","description":" Sets the whether an entity should be drawn or not. If serverside, will also prevent networking the entity to the client. Don't use serverside on a starfall if you want its client code to work."},"getAttachments":{"path":"libs_sh/entities.lua#L705","returns":[{"type":"table?","value":"table? Table of attachment id and attachment name or nil","description":"Table of attachment id and attachment name or nil"}],"realm":"shared","class":"function","name":"getAttachments","description":" Returns a table of attachments"},"getVar":{"path":"libs_sv/entities.lua#L1085","returns":[{"type":"any","value":"any The variable.","description":"The variable."}],"realm":"server","params":[{"type":"string","value":"string key The variable's key.","name":"key","description":"The variable's key."}],"class":"function","name":"getVar","description":" Returns a variable from the entity's internal glua table."},"manipulateBoneAngles":{"path":"libs_sh/entities.lua#L142","realm":"client","params":[{"type":"number","value":"number bone The bone ID","name":"bone","description":"The bone ID"},{"type":"Angle","value":"Angle ang The angle it should be manipulated to","name":"ang","description":"The angle it should be manipulated to"}],"class":"function","name":"manipulateBoneAngles","description":" Allows manipulation of an entity's bones' angles"},"getNoDraw":{"path":"libs_sh/entities.lua#L457","returns":[{"type":"boolean","value":"boolean True if should draw, False otherwise","description":"True if should draw, False otherwise"}],"realm":"shared","class":"function","name":"getNoDraw","description":" Checks whether the entity should be drawn"},"setRenderBounds":{"path":"libs_sh/entities.lua#L232","realm":"client","params":[{"type":"Vector","value":"Vector mins The lower bounding corner coordinate local to the hologram","name":"mins","description":"The lower bounding corner coordinate local to the hologram"},{"type":"Vector","value":"Vector maxs The upper bounding corner coordinate local to the hologram","name":"maxs","description":"The upper bounding corner coordinate local to the hologram"}],"class":"function","name":"setRenderBounds","description":" Sets a hologram or custom_prop's renderbounds"},"applyDamage":{"path":"libs_sv/entities.lua#L261","realm":"server","params":[{"type":"number","value":"number amt Damage amount","name":"amt","description":"Damage amount"},{"type":"Entity?","value":"Entity? attacker Damage attacker. Defaults to chip owner","name":"attacker","description":"Damage attacker. Defaults to chip owner"},{"type":"Entity?","value":"Entity? inflictor Damage inflictor","name":"inflictor","description":"Damage inflictor"},{"type":"number?","value":"number? dmgtype The damage type number enum","name":"dmgtype","description":"The damage type number enum"},{"type":"Vector?","value":"Vector? pos The position of the damage","name":"pos","description":"The position of the damage"}],"class":"function","name":"applyDamage","description":" Applies damage to an entity"},"getAngleVelocity":{"path":"libs_sh/entities.lua#L1274","returns":[{"type":"Vector","value":"Vector The angular velocity as a vector","description":"The angular velocity as a vector"}],"realm":"shared","class":"function","name":"getAngleVelocity","description":" Returns the angular velocity of the entity"},"getQuotaAverage":{"path":"libs_sh/entities.lua#L931","returns":[{"type":"number","value":"number Average CPU Time of the buffer of the specified starfall or expression2.","description":"Average CPU Time of the buffer of the specified starfall or expression2."}],"realm":"shared","class":"function","name":"getQuotaAverage","description":" Gets the Average CPU Time in the buffer of the specified starfall or expression2."},"setAngles":{"path":"libs_sv/entities.lua#L556","realm":"server","params":[{"type":"Angle","value":"Angle ang New angles","name":"ang","description":"New angles"}],"class":"function","name":"setAngles","description":" Sets the entity's angles"},"isValidPhys":{"path":"libs_sv/entities.lua#L741","returns":[{"type":"boolean","value":"boolean If entity has physics","description":"If entity has physics"}],"realm":"server","class":"function","name":"isValidPhys","description":" Checks whether entity has physics"},"getBodygroup":{"path":"libs_sh/entities.lua#L536","returns":[{"type":"number","value":"number The bodygroup value","description":"The bodygroup value"}],"realm":"shared","params":[{"type":"number","value":"number id The bodygroup's number index","name":"id","description":"The bodygroup's number index"}],"class":"function","name":"getBodygroup","description":" Returns the bodygroup value of the entity with given index"},"isDoor":{"path":"libs_sh/darkrp2.lua#L844","returns":[{"type":"boolean","value":"boolean Whether it's a door.","description":"Whether it's a door."}],"realm":"shared","class":"function","name":"isDoor","description":" Get whether this entity is considered a door by DarkRP."},"setSkin":{"path":"libs_sh/entities.lua#L582","realm":"shared","params":[{"type":"number","value":"number skinIndex Index of the skin to use.","name":"skinIndex","description":"Index of the skin to use."}],"class":"function","name":"setSkin","description":" Sets the skin of the entity"},"getSkinCount":{"path":"libs_sh/entities.lua#L605","returns":[{"type":"number","value":"number The amount of skins","description":"The amount of skins"}],"realm":"shared","class":"function","name":"getSkinCount","description":" Returns the amount of skins of the entity"},"setRenderMode":{"path":"libs_sh/entities.lua#L612","realm":"shared","params":[{"type":"number","value":"number rendermode Rendermode to use. http://wiki.facepunch.com/gmod/Enums/RENDERMODE","name":"rendermode","description":"Rendermode to use. http://wiki.facepunch.com/gmod/Enums/RENDERMODE"}],"class":"function","name":"setRenderMode","description":" Sets the render mode of the entity"},"getQuotaMax":{"path":"libs_sh/entities.lua#L945","returns":[{"type":"number","value":"number Max SysTime allowed to take for execution of the chip in a Think.","description":"Max SysTime allowed to take for execution of the chip in a Think."}],"realm":"shared","class":"function","name":"getQuotaMax","description":" Gets the CPU Time max of the specified starfall of the specified starfall or expression2.\n CPU Time is stored in a buffer of N elements, if the average of this exceeds quotaMax, the chip will error."},"lookupBone":{"path":"libs_sh/entities.lua#L1051","returns":[{"type":"number","value":"number The bone index","description":"The bone index"}],"realm":"shared","params":[{"type":"string","value":"string name The bone's string name","name":"name","description":"The bone's string name"}],"class":"function","name":"lookupBone","description":" Returns the ragdoll bone index given a bone name"},"enableDrag":{"path":"libs_sv/entities.lua#L778","realm":"server","params":[{"type":"boolean","value":"boolean drag Should the entity have air resistance?","name":"drag","description":"Should the entity have air resistance?"}],"class":"function","name":"enableDrag","description":" Sets the entity drag state"},"getAttachment":{"path":"libs_sh/entities.lua#L693","returns":[{"type":"Vector?","value":"Vector? Position, nil if the attachment doesn't exist","description":"Position, nil if the attachment doesn't exist"},{"type":"Angle?","value":"Angle? Orientation, nil if the attachment doesn't exist","description":"Orientation, nil if the attachment doesn't exist"}],"realm":"shared","params":[{"type":"number","value":"number index The index of the attachment","name":"index","description":"The index of the attachment"}],"class":"function","name":"getAttachment","description":" Gets the position and angle of an attachment"},"manipulateBonePosition":{"path":"libs_sh/entities.lua#L110","realm":"client","params":[{"type":"number","value":"number bone The bone ID","name":"bone","description":"The bone ID"},{"type":"Vector","value":"Vector vec The position it should be manipulated to","name":"vec","description":"The position it should be manipulated to"}],"class":"function","name":"manipulateBonePosition","description":" Allows manipulation of an entity's bones' positions"},"isPlayer":{"path":"libs_sh/entities.lua#L856","returns":[{"type":"boolean","value":"boolean True if player, false if not","description":"True if player, false if not"}],"realm":"shared","class":"function","name":"isPlayer","description":" Checks if an entity is a player."},"getSubMaterial":{"path":"libs_sh/entities.lua#L1625","returns":[{"type":"string","value":"string String material","description":"String material"}],"realm":"shared","params":[{"type":"number","value":"number index Number index of the sub material","name":"index","description":"Number index of the sub material"}],"class":"function","name":"getSubMaterial","description":" Gets an entities' submaterial"}},"class":"type","name":"Entity","description":" Entity type"},"Constraint":{"path":"libs_sv/constraint.lua#L27","libtbl":["constr_methods","constr_meta"],"realm":"server","methods":{"remove":{"path":"libs_sv/constraint.lua#L71","realm":"server","class":"function","name":"remove","description":" Removes the constraint"},"__tostring":{"path":"libs_sv/constraint.lua#L56","returns":[{"type":"string","value":"string String representation of the constraint","description":"String representation of the constraint"}],"realm":"server","class":"function","name":"__tostring","description":" Gets the string representation of the constraint"},"isValid":{"path":"libs_sv/constraint.lua#L85","returns":[{"type":"boolean","value":"boolean True if valid, false if not","description":"True if valid, false if not"}],"realm":"server","class":"function","name":"isValid","description":" Returns whether the constraint is valid or not"}},"class":"type","name":"Constraint","description":" A constraint entity returned by constraint functions"},"ParticleEffect":{"path":"libs_cl/particle_effect.lua#L17","libtbl":["particleef_methods"],"realm":"client","methods":{"setSortOrigin":{"path":"libs_cl/particle_effect.lua#L159","realm":"client","params":[{"type":"Vector","value":"Vector origin Sort Origin","name":"origin","description":"Sort Origin"}],"class":"function","name":"setSortOrigin","description":" Sets the sort origin for given particle effect system. This is used as a helper to determine which particles are in front of which."},"restart":{"path":"libs_cl/particle_effect.lua#L136","realm":"client","class":"function","name":"restart","description":" Restarts emission of the particle effect."},"stopEmission":{"path":"libs_cl/particle_effect.lua#L114","realm":"client","class":"function","name":"stopEmission","description":" Stops emission of the particle effect."},"setControlPointEntity":{"path":"libs_cl/particle_effect.lua#L184","realm":"client","params":[{"type":"number","value":"number id Child Control Point ID (0-63)","name":"id","description":"Child Control Point ID (0-63)"},{"type":"Entity","value":"Entity entity Entity parent","name":"entity","description":"Entity parent"}],"class":"function","name":"setControlPointEntity","description":" Essentially makes child control point follow the parent entity."},"isFinished":{"path":"libs_cl/particle_effect.lua#L146","returns":[{"type":"boolean","value":"boolean If the particle effect is finished","description":"If the particle effect is finished"}],"realm":"client","class":"function","name":"isFinished","description":" Returns if the particle effect is finished"},"setControlPointParent":{"path":"libs_cl/particle_effect.lua#L241","realm":"client","params":[{"type":"number","value":"number id Child Control Point ID (0-63)","name":"id","description":"Child Control Point ID (0-63)"},{"type":"number","value":"number parentid Parent control point ID (0-63)","name":"parentid","description":"Parent control point ID (0-63)"}],"class":"function","name":"setControlPointParent","description":" Sets the parent for given control point."},"setControlPoint":{"path":"libs_cl/particle_effect.lua#L170","realm":"client","params":[{"type":"number","value":"number id Control Point ID (0-63)","name":"id","description":"Control Point ID (0-63)"},{"type":"Vector","value":"Vector value Value","name":"value","description":"Value"}],"class":"function","name":"setControlPoint","description":" Sets a value for given control point."},"setUpVector":{"path":"libs_cl/particle_effect.lua#L226","realm":"client","params":[{"type":"number","value":"number id Control Point ID (0-63)","name":"id","description":"Control Point ID (0-63)"},{"type":"Vector","value":"Vector up Up vector","name":"up","description":"Up vector"}],"class":"function","name":"setUpVector","description":" Sets the up direction for given control point."},"destroy":{"path":"libs_cl/particle_effect.lua#L123","realm":"client","class":"function","name":"destroy","description":" Stops emission of the particle effect and destroys the object."},"setForwardVector":{"path":"libs_cl/particle_effect.lua#L199","realm":"client","params":[{"type":"number","value":"number id Control Point ID (0-63)","name":"id","description":"Control Point ID (0-63)"},{"type":"Vector","value":"Vector fwd Forward vector","name":"fwd","description":"Forward vector"}],"class":"function","name":"setForwardVector","description":" Sets the forward direction for given control point."},"startEmission":{"path":"libs_cl/particle_effect.lua#L104","realm":"client","class":"function","name":"startEmission","description":" Starts emission of the particle effect."},"setRightVector":{"path":"libs_cl/particle_effect.lua#L212","realm":"client","params":[{"type":"number","value":"number id Control Point ID (0-63)","name":"id","description":"Control Point ID (0-63)"},{"type":"Vector","value":"Vector right Right vector","name":"right","description":"Right vector"}],"class":"function","name":"setRightVector","description":" Sets the right direction for given control point."},"isValid":{"path":"libs_cl/particle_effect.lua#L96","returns":[{"type":"boolean","value":"boolean Is valid or not","description":"Is valid or not"}],"realm":"client","class":"function","name":"isValid","description":" Gets if the particle effect is valid or not."}},"class":"type","name":"ParticleEffect","description":" ParticleEffect type"},"ParticleEmitter":{"path":"libs_cl/particle.lua#L19","libtbl":["particleem_methods"],"realm":"client","methods":{"setBBox":{"path":"libs_cl/particle.lua#L154","realm":"client","params":[{"type":"Vector","value":"Vector mins Min vector","name":"mins","description":"Min vector"},{"type":"Vector","value":"Vector maxs Max vector","name":"maxs","description":"Max vector"}],"class":"function","name":"setBBox","description":" Sets the bounding box for this emitter. Usually the bounding box is automatically determined by the particles, but this function overrides it."},"is3D":{"path":"libs_cl/particle.lua#L142","returns":[{"type":"boolean","value":"boolean If it's 3D","description":"If it's 3D"}],"realm":"client","class":"function","name":"is3D","description":" Returns whether this emitter is 3D or not. This is set when creating the emitter with ParticleEmitter."},"getPos":{"path":"libs_cl/particle.lua#L136","returns":[{"type":"Vector","value":"Vector Position of the Emitter","description":"Position of the Emitter"}],"realm":"client","class":"function","name":"getPos","description":" Returns the position of this emitter. This is set when creating the emitter with ParticleEmitter."},"setPos":{"path":"libs_cl/particle.lua#L186","realm":"client","params":[{"type":"Vector","value":"Vector position The position","name":"position","description":"The position"}],"class":"function","name":"setPos","description":" Sets the position of the particle emitter."},"getParticlesLeft":{"path":"libs_cl/particle.lua#L130","returns":[{"type":"number","value":"number Number of particles left","description":"Number of particles left"}],"realm":"client","class":"function","name":"getParticlesLeft","description":" Returns number of particles left able to be created from the emitter"},"setParticleCullRadius":{"path":"libs_cl/particle.lua#L177","realm":"client","params":[{"type":"number","value":"number radius Particle radius","name":"radius","description":"Particle radius"}],"class":"function","name":"setParticleCullRadius","description":" The function name has not much in common with its actual function.\n It applies a radius to every particles that affects the building of the bounding box, as it usually is constructed by the particle that has the lowest x, y and z and the highest x, y and z.\n This function just adds/subtracts the radius and inflates the bounding box."},"draw":{"path":"libs_cl/particle.lua#L110","realm":"client","class":"function","name":"draw","description":" Manually renders all particles the emitter has created."},"setNoDraw":{"path":"libs_cl/particle.lua#L170","realm":"client","params":[{"type":"boolean","value":"boolean noDraw Whether not to draw","name":"noDraw","description":"Whether not to draw"}],"class":"function","name":"setNoDraw","description":" Prevents all particles of the emitter from automatically drawing. They can be manually drawn with draw()"},"destroy":{"path":"libs_cl/particle.lua#L116","realm":"client","class":"function","name":"destroy","description":" Removes the emitter, making it no longer usable from Lua. If particles remain, the emitter will be removed when all particles die."},"getNumActiveParticles":{"path":"libs_cl/particle.lua#L124","returns":[{"type":"number","value":"number Number of active particles","description":"Number of active particles"}],"realm":"client","class":"function","name":"getNumActiveParticles","description":" Returns the amount of active particles of this emitter."},"add":{"path":"libs_cl/particle.lua#L70","returns":[{"type":"Particle","value":"Particle A Particle object","description":"A Particle object"}],"realm":"client","params":[{"type":"Material","value":"Material material The material object to set the particle","name":"material","description":"The material object to set the particle"},{"type":"Vector","value":"Vector position The position to create the particle","name":"position","description":"The position to create the particle"},{"type":"number","value":"number startSize Sets the initial size value of the particle.","name":"startSize","description":"Sets the initial size value of the particle."},{"type":"number","value":"number endSize Sets the size of the particle that it will reach when it dies.","name":"endSize","description":"Sets the size of the particle that it will reach when it dies."},{"type":"number","value":"number startLength Sets the initial length value of the particle.","name":"startLength","description":"Sets the initial length value of the particle."},{"type":"number","value":"number endLength Sets the length of the particle that it will reach when it dies.","name":"endLength","description":"Sets the length of the particle that it will reach when it dies."},{"type":"number","value":"number startAlpha Sets the initial alpha value of the particle.","name":"startAlpha","description":"Sets the initial alpha value of the particle."},{"type":"number","value":"number endAlpha Sets the alpha value of the particle that it will reach when it dies.","name":"endAlpha","description":"Sets the alpha value of the particle that it will reach when it dies."},{"type":"number","value":"number dieTime Sets the time where the particle will be removed. (0-60)","name":"dieTime","description":"Sets the time where the particle will be removed. (0-60)"}],"class":"function","name":"add","description":" Creates a new Particle with the given material and position."},"setNearClip":{"path":"libs_cl/particle.lua#L161","realm":"client","params":[{"type":"number","value":"number distanceMin","name":"distanceMin","description":""},{"type":"number","value":"number distanceMax","name":"distanceMax","description":""}],"class":"function","name":"setNearClip","description":" This function sets the the distance between the render camera and the emitter at which the particles should start fading and at which distance fade ends ( alpha becomes 0 )."},"isValid":{"path":"libs_cl/particle.lua#L148","returns":[{"type":"boolean","value":"boolean If it's valid","description":"If it's valid"}],"realm":"client","class":"function","name":"isValid","description":" Returns whether this object is valid or not."}},"class":"type","name":"ParticleEmitter","description":" ParticleEmitter type"},"StringStream":{"path":"libs_sh/bit.lua#L11","libtbl":["ss_methods"],"realm":"shared","methods":{"writeInt32":{"path":"libs_sh/bit.lua#L474","realm":"shared","params":[{"type":"number","value":"number x Int32 to write","name":"x","description":"Int32 to write"}],"class":"function","name":"writeInt32","description":" Writes an int to the buffer and advances the buffer pointer."},"writeEntity":{"path":"libs_sh/bit.lua#L520","realm":"shared","params":[{"type":"Entity","value":"Entity e The entity to be written","name":"e","description":"The entity to be written"}],"class":"function","name":"writeEntity","description":" Writes an entity to the buffer and advances the buffer pointer."},"readUInt32":{"path":"libs_sh/bit.lua#L349","returns":[{"type":"number","value":"number UInt32 at this position","description":"UInt32 at this position"}],"realm":"shared","class":"function","name":"readUInt32","description":" Reads an unsigned 32 bit (four byte) integer from the byte stream and advances the buffer pointer."},"readUInt16":{"path":"libs_sh/bit.lua#L338","returns":[{"type":"number","value":"number UInt16 at this position","description":"UInt16 at this position"}],"realm":"shared","class":"function","name":"readUInt16","description":" Reads an unsigned 16 bit (two byte) integer from the byte stream and advances the buffer pointer."},"read":{"path":"libs_sh/bit.lua#L224","returns":[{"type":"string","value":"string A string containing the bytes","description":"A string containing the bytes"}],"realm":"shared","params":[{"type":"number","value":"number length How many bytes to read","name":"length","description":"How many bytes to read"}],"class":"function","name":"read","description":" Reads the specified number of bytes from the buffer and advances the buffer pointer."},"writeFloat":{"path":"libs_sh/bit.lua#L493","realm":"shared","params":[{"type":"number","value":"number x The float to write","name":"x","description":"The float to write"}],"class":"function","name":"writeFloat","description":" Writes a 4 byte IEEE754 float to the byte stream and advances the buffer pointer."},"seek":{"path":"libs_sh/bit.lua#L254","realm":"shared","params":[{"type":"number","value":"number pos Position to seek to","name":"pos","description":"Position to seek to"}],"class":"function","name":"seek","description":" Sets internal pointer to pos. The position will be clamped to [1, buffersize+1]"},"getString":{"path":"libs_sh/bit.lua#L549","returns":[{"type":"string","value":"string The buffer as a string","description":"The buffer as a string"}],"realm":"shared","class":"function","name":"getString","description":" Returns the buffer as a string"},"readEntity":{"path":"libs_sh/bit.lua#L530","returns":[{"type":"Entity","value":"Entity The entity that was read","description":"The entity that was read"}],"realm":"shared","params":[{"type":"function?","value":"function? callback (Client only) optional callback to be ran whenever the entity becomes valid; returns nothing if this is used. The callback passes the entity if it succeeds or nil if it fails.","name":"callback","description":"(Client only) optional callback to be ran whenever the entity becomes valid; returns nothing if this is used. The callback passes the entity if it succeeds or nil if it fails."}],"class":"function","name":"readEntity","description":" Reads an entity from the byte stream and advances the buffer pointer."},"writeDouble":{"path":"libs_sh/bit.lua#L503","realm":"shared","params":[{"type":"number","value":"number x The double to write","name":"x","description":"The double to write"}],"class":"function","name":"writeDouble","description":" Writes a 8 byte IEEE754 double to the byte stream and advances the buffer pointer."},"tell":{"path":"libs_sh/bit.lua#L309","returns":[{"type":"number","value":"number The buffer position","description":"The buffer position"}],"realm":"shared","class":"function","name":"tell","description":" Returns the internal position of the byte reader."},"writeUInt32":{"path":"libs_sh/bit.lua#L487","realm":"shared","params":[{"type":"number","value":"number x UInt32 to write","name":"x","description":"UInt32 to write"}],"class":"function","name":"writeUInt32","description":" Writes a unsigned long to the buffer and advances the buffer pointer."},"readInt8":{"path":"libs_sh/bit.lua#L360","returns":[{"type":"number","value":"number Int8 at this position","description":"Int8 at this position"}],"realm":"shared","class":"function","name":"readInt8","description":" Reads a signed 8-bit (one byte) integer from the byte stream and advances the buffer pointer."},"readFloat":{"path":"libs_sh/bit.lua#L384","returns":[{"type":"number","value":"number Float32 at this position","description":"Float32 at this position"}],"realm":"shared","class":"function","name":"readFloat","description":" Reads a 4 byte IEEE754 float from the byte stream and advances the buffer pointer."},"readInt16":{"path":"libs_sh/bit.lua#L368","returns":[{"type":"number","value":"number Int16 at this position","description":"Int16 at this position"}],"realm":"shared","class":"function","name":"readInt16","description":" Reads a signed 16-bit (two byte) integer from the byte stream and advances the buffer pointer."},"setEndian":{"path":"libs_sh/bit.lua#L179","realm":"shared","params":[{"type":"string","value":"string endian The endianness of number types. \"big\" or \"little\" (default \"little\")","name":"endian","description":"The endianness of number types. \"big\" or \"little\" (default \"little\")"}],"class":"function","name":"setEndian","description":" Sets the endianness of the string stream"},"writeUInt8":{"path":"libs_sh/bit.lua#L449","realm":"shared","params":[{"type":"number","value":"number x UInt8 to write","name":"x","description":"UInt8 to write"}],"class":"function","name":"writeUInt8","description":" Writes a unsigned byte to the buffer and advances the buffer pointer."},"readUInt8":{"path":"libs_sh/bit.lua#L329","returns":[{"type":"number","value":"number UInt8 at this position","description":"UInt8 at this position"}],"realm":"shared","class":"function","name":"readUInt8","description":" Reads an unsigned 8-bit (one byte) integer from the byte stream and advances the buffer pointer."},"writeInt16":{"path":"libs_sh/bit.lua#L455","realm":"shared","params":[{"type":"number","value":"number x Int16 to write","name":"x","description":"Int16 to write"}],"class":"function","name":"writeInt16","description":" Writes a short to the buffer and advances the buffer pointer."},"writeInt8":{"path":"libs_sh/bit.lua#L441","realm":"shared","params":[{"type":"number","value":"number x Int8 to write","name":"x","description":"Int8 to write"}],"class":"function","name":"writeInt8","description":" Writes a byte to the buffer and advances the buffer pointer."},"readString":{"path":"libs_sh/bit.lua#L434","returns":[{"type":"string","value":"string The string of bytes read","description":"The string of bytes read"}],"realm":"shared","class":"function","name":"readString","description":" Returns a null terminated string, reads until \"\\x00\" and advances the buffer pointer."},"size":{"path":"libs_sh/bit.lua#L319","returns":[{"type":"number","value":"number The buffer size","description":"The buffer size"}],"realm":"shared","class":"function","name":"size","description":" Tells the size of the byte stream."},"readDouble":{"path":"libs_sh/bit.lua#L394","returns":[{"type":"number","value":"number Double at this position","description":"Double at this position"}],"realm":"shared","class":"function","name":"readDouble","description":" Reads a 8 byte IEEE754 double from the byte stream and advances the buffer pointer."},"readInt32":{"path":"libs_sh/bit.lua#L376","returns":[{"type":"number","value":"number Int32 at this position","description":"Int32 at this position"}],"realm":"shared","class":"function","name":"readInt32","description":" Reads a signed 32-bit (four byte) integer from the byte stream and advances the buffer pointer."},"skip":{"path":"libs_sh/bit.lua#L272","realm":"shared","params":[{"type":"number","value":"number length The offset","name":"length","description":"The offset"}],"class":"function","name":"skip","description":" Move the internal pointer by amount i"},"writeString":{"path":"libs_sh/bit.lua#L513","realm":"shared","params":[{"type":"string","value":"string str The string of bytes to write","name":"str","description":"The string of bytes to write"}],"class":"function","name":"writeString","description":" Writes a string to the buffer putting a null at the end and advances the buffer pointer."},"readUntil":{"path":"libs_sh/bit.lua#L404","returns":[{"type":"string","value":"string The string of bytes read","description":"The string of bytes read"}],"realm":"shared","params":[{"type":"number","value":"number byte The byte to read until (in number form)","name":"byte","description":"The byte to read until (in number form)"}],"class":"function","name":"readUntil","description":" Reads until the given byte and advances the buffer pointer."},"write":{"path":"libs_sh/bit.lua#L191","realm":"shared","params":[{"type":"string","value":"string data A string of data to write","name":"data","description":"A string of data to write"}],"class":"function","name":"write","description":" Writes the given string and advances the buffer pointer."},"writeUInt16":{"path":"libs_sh/bit.lua#L468","realm":"shared","params":[{"type":"number","value":"number x UInt16 to write","name":"x","description":"UInt16 to write"}],"class":"function","name":"writeUInt16","description":" Writes a unsigned short to the buffer and advances the buffer pointer."}},"class":"type","name":"StringStream","description":" StringStream type"},"Mesh":{"path":"libs_sh/mesh.lua#L679","libtbl":["mesh_methods"],"realm":"client","methods":{"destroy":{"path":"libs_sh/mesh.lua#L1133","realm":"client","class":"function","name":"destroy","description":" Frees the mesh from memory"},"draw":{"path":"libs_sh/mesh.lua#L1122","realm":"client","class":"function","name":"draw","description":" Draws the mesh. Must be in a 3D rendering context."}},"class":"type","name":"Mesh","description":" Mesh type"},"Sound":{"path":"libs_sh/sound.lua#L25","libtbl":["sound_methods"],"realm":"shared","methods":{"stop":{"path":"libs_sh/sound.lua#L134","realm":"shared","params":[{"type":"number?","value":"number? fade Time in seconds to fade out, if nil or 0 the sound stops instantly.","name":"fade","description":"Time in seconds to fade out, if nil or 0 the sound stops instantly."}],"class":"function","name":"stop","description":" Stops the sound from being played."},"setPitch":{"path":"libs_sh/sound.lua#L170","realm":"shared","params":[{"type":"number","value":"number pitch Pitch to set to, between 0 and 255.","name":"pitch","description":"Pitch to set to, between 0 and 255."},{"type":"number?","value":"number? fade Time in seconds to transition to this new pitch. Default 0","name":"fade","description":"Time in seconds to transition to this new pitch. Default 0"}],"class":"function","name":"setPitch","description":" Sets the pitch of the sound. Won't work unless the sound is playing."},"setDSP":{"path":"libs_sh/sound.lua#L206","realm":"shared","params":[{"type":"number","value":"number dsp (0 - 133) DSP values. List can be found here https://developer.valvesoftware.com/wiki/Dsp_presets","name":"dsp","description":"(0 - 133) DSP values. List can be found here https://developer.valvesoftware.com/wiki/Dsp_presets"}],"class":"function","name":"setDSP","description":" Sets the sound dsp value"},"setSoundLevel":{"path":"libs_sh/sound.lua#L193","realm":"shared","params":[{"type":"number","value":"number level dB level, for information on the value to use see https://developer.valvesoftware.com/wiki/Soundscripts#SoundLevel","name":"level","description":"dB level, for information on the value to use see https://developer.valvesoftware.com/wiki/Soundscripts#SoundLevel"}],"class":"function","name":"setSoundLevel","description":" Sets the sound level in dB. Won't work if the sound is already playing."},"isPlaying":{"path":"libs_sh/sound.lua#L187","returns":[{"type":"boolean","value":"boolean Whether the sound is playing or not","description":"Whether the sound is playing or not"}],"realm":"shared","class":"function","name":"isPlaying","description":" Returns whether the sound is being played."},"getSoundLevel":{"path":"libs_sh/sound.lua#L200","returns":[{"type":"number","value":"number Level in dB","description":"Level in dB"}],"realm":"shared","class":"function","name":"getSoundLevel","description":" Returns the current sound level in dB."},"getDSP":{"path":"libs_sh/sound.lua#L213","returns":[{"type":"number","value":"number (0 - 133) DSP value.","description":"(0 - 133) DSP value."}],"realm":"shared","class":"function","name":"getDSP","description":" Gets the sound dsp value"},"play":{"path":"libs_sh/sound.lua#L129","realm":"shared","class":"function","name":"play","description":" Starts to play the sound."},"destroy":{"path":"libs_sh/sound.lua#L145","realm":"shared","class":"function","name":"destroy","description":" Removes the sound from the game so new one can be created if limit is reached"},"setVolume":{"path":"libs_sh/sound.lua#L153","realm":"shared","params":[{"type":"number","value":"number vol Volume to set to, between 0 and 1.","name":"vol","description":"Volume to set to, between 0 and 1."},{"type":"number?","value":"number? fade Time in seconds to transition to this new volume. Default 0","name":"fade","description":"Time in seconds to transition to this new volume. Default 0"}],"class":"function","name":"setVolume","description":" Sets the volume of the sound. Won't work unless the sound is playing."}},"class":"type","name":"Sound","description":" Sound type"},"Npc":{"path":"libs_sh/npc.lua#L13","libtbl":["npc_methods","npc_meta"],"realm":"shared","methods":{"stop":{"path":"libs_sh/npc.lua#L121","realm":"server","class":"function","name":"stop","description":" Stops the npc"},"goRun":{"path":"libs_sh/npc.lua#L155","realm":"server","params":[{"type":"Vector","value":"Vector vec The position of the destination","name":"vec","description":"The position of the destination"}],"class":"function","name":"goRun","description":" Makes the npc run to a destination"},"getEnemy":{"path":"libs_sh/npc.lua#L114","returns":[{"type":"Entity","value":"Entity Entity the npc is fighting","description":"Entity the npc is fighting"}],"realm":"server","class":"function","name":"getEnemy","description":" Gets what the npc is fighting"},"addRelationship":{"path":"libs_sh/npc.lua#L44","realm":"server","params":[{"type":"string","value":"string str The relationship string. http://wiki.facepunch.com/gmod/NPC:AddRelationship","name":"str","description":"The relationship string. http://wiki.facepunch.com/gmod/NPC:AddRelationship"}],"class":"function","name":"addRelationship","description":" Adds a relationship to the npc"},"giveWeapon":{"path":"libs_sh/npc.lua#L87","realm":"server","params":[{"type":"string","value":"string wep The classname of the weapon","name":"wep","description":"The classname of the weapon"}],"class":"function","name":"giveWeapon","description":" Gives the npc a weapon"},"attackMelee":{"path":"libs_sh/npc.lua#L129","realm":"server","class":"function","name":"attackMelee","description":" Makes the npc do a melee attack"},"goWalk":{"path":"libs_sh/npc.lua#L145","realm":"server","params":[{"type":"Vector","value":"Vector vec The position of the destination","name":"vec","description":"The position of the destination"}],"class":"function","name":"goWalk","description":" Makes the npc walk to a destination"},"attackRange":{"path":"libs_sh/npc.lua#L137","realm":"server","class":"function","name":"attackRange","description":" Makes the npc do a ranged attack"},"getRelationship":{"path":"libs_sh/npc.lua#L79","returns":[{"type":"string","value":"string Relationship of the npc with the target","description":"Relationship of the npc with the target"}],"realm":"server","params":[{"type":"Entity","value":"Entity ent Target entity","name":"ent","description":"Target entity"}],"class":"function","name":"getRelationship","description":" Gets the npc's relationship to the target"},"addEntityRelationship":{"path":"libs_sh/npc.lua#L65","realm":"server","params":[{"type":"Entity","value":"Entity ent The target entity","name":"ent","description":"The target entity"},{"type":"string","value":"string disp String of the relationship. (\"hate\", \"fear\", \"like\", \"neutral\")","name":"disp","description":"String of the relationship. (\"hate\", \"fear\", \"like\", \"neutral\")"},{"type":"number","value":"number priority How strong the relationship is. Higher number is stronger","name":"priority","description":"How strong the relationship is. Higher number is stronger"}],"class":"function","name":"addEntityRelationship","description":" Adds a relationship to the npc with an entity"},"setEnemy":{"path":"libs_sh/npc.lua#L105","realm":"server","params":[{"type":"Entity","value":"Entity ent Target entity","name":"ent","description":"Target entity"}],"class":"function","name":"setEnemy","description":" Tell the npc to fight this"}},"class":"type","name":"Npc","description":" Npc type"},"Color":{"path":"libs_sh/color.lua#L36","methods":{"setB":{"path":"libs_sh/color.lua#L261","returns":[{"type":"Color","value":"Color Color after modification","description":"Color after modification"}],"realm":"shared","params":[{"type":"number","value":"number b The blue","name":"b","description":"The blue"}],"class":"function","name":"setB","description":" Set's the color's blue and returns self."},"__mul":{"path":"libs_sh/color.lua#L155","returns":[{"type":"Color","value":"Color Multiplied color.","description":"Multiplied color."}],"realm":"shared","params":[{"type":"number|Color","value":"number|Color a Number or Color multiplicant","name":"a","description":"Number or Color multiplicant"},{"type":"number|Color","value":"number|Color b Number or Color multiplier","name":"b","description":"Number or Color multiplier"}],"class":"function","name":"__mul","description":" Multiplication metamethod"},"round":{"path":"libs_sh/color.lua#L219","realm":"shared","params":[{"type":"number?","value":"number? idp (Default 0) The integer decimal place to round to.","name":"idp","description":"(Default 0) The integer decimal place to round to."}],"class":"function","name":"round","description":" Round the color values.\n Self-Modifies. Does not return anything"},"__concat":{"path":"libs_sh/color.lua#L125","returns":[{"type":"string","value":"string Adds two colors into one string-representation","description":"Adds two colors into one string-representation"}],"realm":"shared","class":"function","name":"__concat","description":" Concatenation metamethod"},"__sub":{"path":"libs_sh/color.lua#L147","returns":[{"type":"Color","value":"Color Resultant color.","description":"Resultant color."}],"realm":"shared","params":[{"type":"Color","value":"Color c1 Initial color.","name":"c1","description":"Initial color."},{"type":"Color","value":"Color c2 Color to subtract.","name":"c2","description":"Color to subtract."}],"class":"function","name":"__sub","description":" Subtraction metamethod"},"__div":{"path":"libs_sh/color.lua#L173","returns":[{"type":"Color","value":"Color Scaled color.","description":"Scaled color."}],"realm":"shared","params":[{"type":"number|Color","value":"number|Color a Number or Color dividend","name":"a","description":"Number or Color dividend"},{"type":"number|Color","value":"number|Color b Number or Color divisor","name":"b","description":"Number or Color divisor"}],"class":"function","name":"__div","description":" Division metamethod"},"__index":{"path":"libs_sh/color.lua#L107","returns":[{"type":"number","value":"number Value at the index","description":"Value at the index"}],"realm":"shared","params":[{"type":"number|string","value":"number|string k Key. Number or string","name":"k","description":"Key. Number or string"}],"class":"function","name":"__index","description":" Gets a value at a key in the color"},"set":{"path":"libs_sh/color.lua#L235","realm":"shared","params":[{"type":"Color","value":"Color b The color to copy from.","name":"b","description":"The color to copy from."}],"class":"function","name":"set","description":" Copies r,g,b,a from color to another.\n Self-Modifies. Does not return anything"},"rgbToHSV":{"path":"libs_sh/color.lua#L191","returns":[{"type":"Color","value":"Color A triplet of numbers representing HSV.","description":"A triplet of numbers representing HSV."}],"realm":"shared","class":"function","name":"rgbToHSV","description":" Converts the color from RGB to HSV."},"setA":{"path":"libs_sh/color.lua#L269","returns":[{"type":"Color","value":"Color Color after modification","description":"Color after modification"}],"realm":"shared","params":[{"type":"number","value":"number a The alpha","name":"a","description":"The alpha"}],"class":"function","name":"setA","description":" Set's the color's alpha and returns it."},"setG":{"path":"libs_sh/color.lua#L253","returns":[{"type":"Color","value":"Color Color after modification","description":"Color after modification"}],"realm":"shared","params":[{"type":"number","value":"number g The green","name":"g","description":"The green"}],"class":"function","name":"setG","description":" Set's the color's green and returns self."},"__newindex":{"path":"libs_sh/color.lua#L96","realm":"shared","params":[{"type":"number|string","value":"number|string k Key. Number or string","name":"k","description":"Key. Number or string"},{"type":"number","value":"number v Value.","name":"v","description":"Value."}],"class":"function","name":"__newindex","description":" Sets a value at a key in the color"},"hsvToRGB":{"path":"libs_sh/color.lua#L199","returns":[{"type":"Color","value":"Color A triplet of numbers representing HSV.","description":"A triplet of numbers representing HSV."}],"realm":"shared","class":"function","name":"hsvToRGB","description":" Converts the color from HSV to RGB."},"__add":{"path":"libs_sh/color.lua#L139","returns":[{"type":"Color","value":"Color Resultant color.","description":"Resultant color."}],"realm":"shared","params":[{"type":"Color","value":"Color c1 Initial color.","name":"c1","description":"Initial color."},{"type":"Color","value":"Color c2 Color to add to the first.","name":"c2","description":"Color to add to the first."}],"class":"function","name":"__add","description":" Addition metamethod"},"__eq":{"path":"libs_sh/color.lua#L131","returns":[{"type":"boolean","value":"boolean Whether their fields are equal","description":"Whether their fields are equal"}],"realm":"shared","params":[{"type":"Color","value":"Color c1 Initial color.","name":"c1","description":"Initial color."},{"type":"Color","value":"Color c2 Color to check against.","name":"c2","description":"Color to check against."}],"class":"function","name":"__eq","description":" Equivalence metamethod"},"__tostring":{"path":"libs_sh/color.lua#L119","returns":[{"type":"string","value":"string String representation of the color","description":"String representation of the color"}],"realm":"shared","class":"function","name":"__tostring","description":" Turns the color into a string"},"toHex":{"path":"libs_sh/color.lua#L207","returns":[{"type":"string","value":"string String hexadecimal color","description":"String hexadecimal color"}],"realm":"shared","params":[{"type":"boolean?","value":"boolean? alpha Optional boolean whether to include the alpha channel, False by default","name":"alpha","description":"Optional boolean whether to include the alpha channel, False by default"}],"class":"function","name":"toHex","description":" Returns a hexadecimal string representation of the color"},"setR":{"path":"libs_sh/color.lua#L245","returns":[{"type":"Color","value":"Color Color after modification","description":"Color after modification"}],"realm":"shared","params":[{"type":"number","value":"number r The red","name":"r","description":"The red"}],"class":"function","name":"setR","description":" Set's the color's red channel and returns self."},"clone":{"path":"libs_sh/color.lua#L229","returns":[{"type":"Color","value":"Color The copy of the color","description":"The copy of the color"}],"realm":"shared","class":"function","name":"clone","description":" Copies r,g,b,a from color and returns a new color"}},"fields":[{"name":"r","description":"The 0-255 red value of the color. Can also be indexed with [1]"},{"name":"g","description":"The 0-255 green value of the color. Can also be indexed with [2]"},{"name":"b","description":"The 0-255 blue value of the color. Can also be indexed with [3]"},{"name":"a","description":"The 0-255 alpha value of the color. Can also be indexed with [4]"}],"realm":"shared","libtbl":["color_methods","color_meta"],"class":"type","name":"Color","description":" Color type"},"SurfaceInfo":{"path":"libs_sh/surfaceinfo.lua#L3","libtbl":["surfaceinfo_methods","surfaceinfo_meta"],"realm":"shared","methods":{"getMaterial":{"path":"libs_sh/surfaceinfo.lua#L25","returns":[{"type":"string|Material","value":"string|Material In SERVER, the material name, and in CLIENT, the Material object.","description":"In SERVER, the material name, and in CLIENT, the Material object."}],"realm":"shared","class":"function","name":"getMaterial","description":" Returns the brush surface's material."},"isWater":{"path":"libs_sh/surfaceinfo.lua#L68","returns":[{"type":"boolean","value":"boolean If the surface is water.","description":"If the surface is water."}],"realm":"shared","class":"function","name":"isWater","description":" Checks if the brush surface is water.\n This internally checks the SURFDRAW_WATER flag."},"getVertices":{"path":"libs_sh/surfaceinfo.lua#L39","returns":[{"type":"table","value":"table List of Vector points. This will usually be 4 corners of a quadrilateral in counter-clockwise order.","description":"List of Vector points. This will usually be 4 corners of a quadrilateral in counter-clockwise order."}],"realm":"shared","class":"function","name":"getVertices","description":" Returns a list of vertices the brush surface is built from."},"isNoDraw":{"path":"libs_sh/surfaceinfo.lua#L52","returns":[{"type":"boolean","value":"boolean If this surface won't be drawn.","description":"If this surface won't be drawn."}],"realm":"shared","class":"function","name":"isNoDraw","description":" Checks if the brush surface is a nodraw surface, meaning it will not be drawn by the engine.\n This internally checks the SURFDRAW_NODRAW flag."},"isSky":{"path":"libs_sh/surfaceinfo.lua#L60","returns":[{"type":"boolean","value":"boolean If the surface is the sky.","description":"If the surface is the sky."}],"realm":"shared","class":"function","name":"isSky","description":" Checks if the brush surface is displaying the skybox.\n This internally checks the SURFDRAW_SKY flag."}},"class":"type","name":"SurfaceInfo","description":" SurfaceInfo type"},"Wirelink":{"path":"libs_sv/wire.lua#L23","libtbl":["wirelink_methods","wirelink_meta"],"realm":"server","methods":{"inputValue":{"path":"libs_sv/wire.lua#L678","returns":[{"type":"any","value":"any Input value","description":"Input value"}],"realm":"server","params":[{"type":"string","value":"string name Input name","name":"name","description":"Input name"}],"class":"function","name":"inputValue","description":" Returns current state of the specified input"},"entity":{"path":"libs_sv/wire.lua#L706","returns":[{"type":"Entity","value":"Entity Entity the wirelink represents","description":"Entity the wirelink represents"}],"realm":"server","class":"function","name":"entity","description":" Returns the entity that the wirelink represents"},"getWiredToName":{"path":"libs_sv/wire.lua#L775","returns":[{"type":"string","value":"string String name of the output that the input is wired to.","description":"String name of the output that the input is wired to."}],"realm":"server","params":[{"type":"string","value":"string name Name of the input of the wirelink.","name":"name","description":"Name of the input of the wirelink."}],"class":"function","name":"getWiredToName","description":" Returns the name of the output an input of the wirelink is wired to."},"inputs":{"path":"libs_sv/wire.lua#L712","returns":[{"type":"table","value":"table All of the wirelink's inputs","description":"All of the wirelink's inputs"}],"realm":"server","class":"function","name":"inputs","description":" Returns a table of all of the wirelink's inputs"},"__newindex":{"path":"libs_sv/wire.lua#L655","realm":"server","params":[{"type":"any","value":"any key Key to set the value at","name":"key","description":"Key to set the value at"},{"type":"any","value":"any val Value to set at the index","name":"val","description":"Value to set at the index"}],"class":"function","name":"__newindex","description":" Writes to an input."},"inputType":{"path":"libs_sv/wire.lua#L688","returns":[{"type":"string","value":"string Type of input","description":"Type of input"}],"realm":"server","params":[{"type":"string","value":"string name Input name to search for","name":"name","description":"Input name to search for"}],"class":"function","name":"inputType","description":" Returns the type of input name, or nil if it doesn't exist"},"getWiredTo":{"path":"libs_sv/wire.lua#L763","returns":[{"type":"Entity","value":"Entity The entity the wirelink is wired to","description":"The entity the wirelink is wired to"}],"realm":"server","params":[{"type":"string","value":"string name Name of the input","name":"name","description":"Name of the input"}],"class":"function","name":"getWiredTo","description":" Returns what an input of the wirelink is wired to."},"outputType":{"path":"libs_sv/wire.lua#L697","returns":[{"type":"string","value":"string Type of output","description":"Type of output"}],"realm":"server","params":[{"type":"string","value":"string name Output name to search for","name":"name","description":"Output name to search for"}],"class":"function","name":"outputType","description":" Returns the type of output name, or nil if it doesn't exist"},"isWired":{"path":"libs_sv/wire.lua#L752","returns":[{"type":"boolean","value":"boolean Whether it is wired","description":"Whether it is wired"}],"realm":"server","params":[{"type":"string","value":"string name Name of the input to check","name":"name","description":"Name of the input to check"}],"class":"function","name":"isWired","description":" Checks if an input is wired."},"outputs":{"path":"libs_sv/wire.lua#L732","returns":[{"type":"table","value":"table All of the wirelink's outputs","description":"All of the wirelink's outputs"}],"realm":"server","class":"function","name":"outputs","description":" Returns a table of all of the wirelink's outputs"},"isValid":{"path":"libs_sv/wire.lua#L672","returns":[{"type":"boolean","value":"boolean Whether the wirelink is valid","description":"Whether the wirelink is valid"}],"realm":"server","class":"function","name":"isValid","description":" Checks if a wirelink is valid. (ie. doesn't point to an invalid entity)"},"__index":{"path":"libs_sv/wire.lua#L636","returns":[{"type":"any","value":"any Value at the index","description":"Value at the index"}],"realm":"server","params":[{"type":"any","value":"any Key to get the value at","name":"Key","description":"to get the value at"}],"class":"function","name":"__index","description":" Retrieves an output. Returns nil if the output doesn't exist."}},"class":"type","name":"Wirelink","description":" Wirelink type"},"Angle":{"path":"libs_sh/angles.lua#L5","methods":{"setZero":{"path":"libs_sh/angles.lua#L221","realm":"shared","class":"function","name":"setZero","description":" Sets p,y,r to 0. This is faster than doing it manually.\n Self-Modifies. Does not return anything"},"getQuaternion":{"path":"libs_sh/quaternion.lua#L835","returns":[{"type":"Quaternion","value":"Quaternion Constructed quaternion","description":"Constructed quaternion"}],"realm":"shared","class":"function","name":"getQuaternion","description":" Converts angle to a quaternion"},"__mul":{"path":"libs_sh/angles.lua#L85","returns":[{"type":"Angle","value":"Angle Resultant angle.","description":"Resultant angle."}],"realm":"shared","params":[{"type":"number|Angle","value":"number|Angle a1 Number or Angle multiplicand.","name":"a1","description":"Number or Angle multiplicand."},{"type":"number|Angle","value":"number|Angle a2 Number or Angle multiplier.","name":"a2","description":"Number or Angle multiplier."}],"class":"function","name":"__mul","description":" Multiplication metamethod"},"round":{"path":"libs_sh/angles.lua#L197","realm":"shared","params":[{"type":"number?","value":"number? idp (Default 0) The integer decimal place to round to.","name":"idp","description":"(Default 0) The integer decimal place to round to."}],"class":"function","name":"round","description":" Round the angle values.\n Self-Modifies. Does not return anything"},"rotateAroundAxis":{"path":"libs_sh/angles.lua#L175","returns":[{"type":"Angle","value":"Angle The modified angle","description":"The modified angle"}],"realm":"shared","params":[{"type":"Vector","value":"Vector v Vector axis","name":"v","description":"Vector axis"},{"type":"number?","value":"number? deg Number of degrees or nil if radians.","name":"deg","description":"Number of degrees or nil if radians."},{"type":"number?","value":"number? rad Number of radians or nil if degrees.","name":"rad","description":"Number of radians or nil if degrees."}],"class":"function","name":"rotateAroundAxis","description":" Return Rotated angle around the specified axis."},"__div":{"path":"libs_sh/angles.lua#L103","returns":[{"type":"Angle","value":"Angle Resultant angle.","description":"Resultant angle."}],"realm":"shared","params":[{"type":"number|Angle","value":"number|Angle a1 Number or Angle dividend.","name":"a1","description":"Number or Angle dividend."},{"type":"number|Angle","value":"number|Angle a2 Number or Angle divisor.","name":"a2","description":"Number or Angle divisor."}],"class":"function","name":"__div","description":" Division metamethod"},"__index":{"path":"libs_sh/angles.lua#L64","returns":[{"type":"number","value":"number Value","description":"Value"}],"realm":"shared","params":[{"type":"number|string","value":"number|string Key","name":"Key","description":""}],"class":"function","name":"__index","description":" Gets a value at a key in the angle\n Can be indexed with: 1, 2, 3, p, y, r, pitch, yaw, roll. 1,2,3 is most efficient."},"__tostring":{"path":"libs_sh/angles.lua#L79","returns":[{"type":"string","value":"string String representing the angle.","description":"String representing the angle."}],"realm":"shared","class":"function","name":"__tostring","description":" Turns an angle into a string."},"__unm":{"path":"libs_sh/angles.lua#L121","returns":[{"type":"Angle","value":"Angle Negative angle.","description":"Negative angle."}],"realm":"shared","class":"function","name":"__unm","description":" Unary Minus metamethod (Negative)"},"clone":{"path":"libs_sh/angles.lua#L206","returns":[{"type":"Angle","value":"Angle The copy of the angle","description":"The copy of the angle"}],"realm":"shared","class":"function","name":"clone","description":" Copies p,y,r from angle and returns a new angle"},"setY":{"path":"libs_sh/angles.lua#L237","returns":[{"type":"Angle","value":"Angle Angle after modification","description":"Angle after modification"}],"realm":"shared","params":[{"type":"number","value":"number y The yaw","name":"y","description":"The yaw"}],"class":"function","name":"setY","description":" Set's the angle's yaw and returns self."},"getRight":{"path":"libs_sh/angles.lua#L163","returns":[{"type":"Vector","value":"Vector Right direction.","description":"Right direction."}],"realm":"shared","class":"function","name":"getRight","description":" Return the Right Vector relative to the angle dir."},"setP":{"path":"libs_sh/angles.lua#L229","returns":[{"type":"Angle","value":"Angle Angle after modification","description":"Angle after modification"}],"realm":"shared","params":[{"type":"number","value":"number p The pitch","name":"p","description":"The pitch"}],"class":"function","name":"setP","description":" Set's the angle's pitch and returns self."},"set":{"path":"libs_sh/angles.lua#L212","realm":"shared","params":[{"type":"Angle","value":"Angle b The angle to copy from.","name":"b","description":"The angle to copy from."}],"class":"function","name":"set","description":" Copies p,y,r from angle to another.\n Self-Modifies. Does not return anything"},"__newindex":{"path":"libs_sh/angles.lua#L52","realm":"shared","params":[{"type":"Angle","value":"Angle Ang","name":"Ang","description":""},{"type":"number|string","value":"number|string Key","name":"Key","description":""},{"type":"number","value":"number Value","name":"Value","description":""}],"class":"function","name":"__newindex","description":" Sets a value at a key in the angle"},"__add":{"path":"libs_sh/angles.lua#L135","returns":[{"type":"Angle","value":"Angle Resultant angle.","description":"Resultant angle."}],"realm":"shared","params":[{"type":"Angle","value":"Angle a1 Initial angle.","name":"a1","description":"Initial angle."},{"type":"Angle","value":"Angle a2 Angle to add to the first.","name":"a2","description":"Angle to add to the first."}],"class":"function","name":"__add","description":" Addition metamethod"},"getUp":{"path":"libs_sh/angles.lua#L169","returns":[{"type":"Vector","value":"Vector Up direction.","description":"Up direction."}],"realm":"shared","class":"function","name":"getUp","description":" Return the Up Vector relative to the angle dir."},"isZero":{"path":"libs_sh/angles.lua#L151","returns":[{"type":"boolean","value":"boolean If they are all zero","description":"If they are all zero"}],"realm":"shared","class":"function","name":"isZero","description":" Returns if p,y,r are all 0."},"__sub":{"path":"libs_sh/angles.lua#L143","returns":[{"type":"Angle","value":"Angle Resultant angle.","description":"Resultant angle."}],"realm":"shared","params":[{"type":"Angle","value":"Angle a1 Initial angle.","name":"a1","description":"Initial angle."},{"type":"Angle","value":"Angle a2 Angle to subtract.","name":"a2","description":"Angle to subtract."}],"class":"function","name":"__sub","description":" Subtraction metamethod"},"__eq":{"path":"libs_sh/angles.lua#L127","returns":[{"type":"boolean","value":"boolean Whether their fields are equal","description":"Whether their fields are equal"}],"realm":"shared","params":[{"type":"Angle","value":"Angle a1 Initial angle.","name":"a1","description":"Initial angle."},{"type":"Angle","value":"Angle a2 Angle to check against.","name":"a2","description":"Angle to check against."}],"class":"function","name":"__eq","description":" Equivalence metamethod"},"setR":{"path":"libs_sh/angles.lua#L245","returns":[{"type":"Angle","value":"Angle Angle after modification","description":"Angle after modification"}],"realm":"shared","params":[{"type":"number","value":"number r The roll","name":"r","description":"The roll"}],"class":"function","name":"setR","description":" Set's the angle's roll and returns self."},"getForward":{"path":"libs_sh/angles.lua#L157","returns":[{"type":"Vector","value":"Vector Forward direction.","description":"Forward direction."}],"realm":"shared","class":"function","name":"getForward","description":" Return the Forward Vector ( direction the angle points )."}},"fields":[{"name":"p","description":"The -90 to 90 pitch value of the euler angle. Can also be indexed with [1]"},{"name":"y","description":"The -180 to 180 yaw value of the euler angle. Can also be indexed with [2]"},{"name":"r","description":"The -180 to 180 roll value of the euler angle. Can also be indexed with [3]"}],"realm":"shared","libtbl":["ang_methods","ang_meta"],"class":"type","name":"Angle","description":" Angle Type"}}}
\ No newline at end of file
+{"Libraries":{"coroutine":{"methods":{"status":{"path":"libs_sh/coroutine.lua#L109","returns":[{"type":"string","value":"string Either \"suspended\", \"running\", \"normal\" or \"dead\"","description":"Either \"suspended\", \"running\", \"normal\" or \"dead\""}],"realm":"shared","params":[{"type":"thread","value":"thread coroutine The coroutine","name":"coroutine","description":"The coroutine"}],"class":"function","name":"status","description":" Returns the status of the coroutine."},"yield":{"path":"libs_sh/coroutine.lua#L97","returns":[{"type":"...","value":"... Any values passed to the coroutine","description":"Any values passed to the coroutine"}],"realm":"shared","params":[{"type":"...","value":"... Optional parameters that will be returned to the main thread","name":"Optional","description":"parameters that will be returned to the main thread"}],"class":"function","name":"yield","description":" Suspends the currently running coroutine. May not be called outside a coroutine."},"running":{"path":"libs_sh/coroutine.lua#L118","returns":[{"type":"thread","value":"thread Currently running coroutine","description":"Currently running coroutine"}],"realm":"shared","class":"function","name":"running","description":" Returns the coroutine that is currently running."},"wrap":{"path":"libs_sh/coroutine.lua#L78","returns":[{"type":"function","value":"function A function that, when called, resumes the created coroutine. Any parameters to that function will be passed to the coroutine.","description":"A function that, when called, resumes the created coroutine. Any parameters to that function will be passed to the coroutine."}],"realm":"shared","params":[{"type":"function","value":"function func Function of the coroutine","name":"func","description":"Function of the coroutine"}],"class":"function","name":"wrap","description":" Creates a new coroutine."},"wait":{"path":"libs_sh/coroutine.lua#L125","realm":"shared","params":[{"type":"number","value":"number time Time in seconds to suspend the coroutine","name":"time","description":"Time in seconds to suspend the coroutine"}],"class":"function","name":"wait","description":" Suspends the coroutine for a number of seconds. Note that the coroutine will not resume automatically, but any attempts to resume the coroutine while it is waiting will not resume the coroutine and act as if the coroutine suspended itself immediately."},"create":{"path":"libs_sh/coroutine.lua#L69","returns":[{"type":"thread","value":"thread Created coroutine","description":"Created coroutine"}],"realm":"shared","params":[{"type":"function","value":"function func Function of the coroutine","name":"func","description":"Function of the coroutine"}],"class":"function","name":"create","description":" Creates a new coroutine."},"resume":{"path":"libs_sh/coroutine.lua#L87","returns":[{"type":"...","value":"... Any values the coroutine is returning to the main thread","description":"Any values the coroutine is returning to the main thread"}],"realm":"shared","params":[{"type":"thread","value":"thread coroutine to resume","name":"coroutine","description":"to resume"},{"type":"...","value":"... args Optional parameters that will be passed to the coroutine","name":"args","description":"Optional parameters that will be passed to the coroutine"}],"class":"function","name":"resume","description":" Resumes a suspended coroutine. Note that, in contrast to Lua's native coroutine.resume function, it will not run in protected mode and can throw an error."}},"tables":[],"path":"libs_sh/coroutine.lua#L5","libtbl":["coroutine_library"],"realm":"shared","fields":[],"class":"library","name":"coroutine","description":" Coroutine library"},"bass":{"methods":{"loadURL":{"path":"libs_cl/bass.lua#L212","realm":"client","params":[{"type":"string","value":"string path URL path to play from.","name":"path","description":"URL path to play from."},{"type":"string","value":"string flags Flags for the sound (`3d`, `mono`, `noplay`, `noblock`). noblock will fail if the webserver doesn't provide file length.","name":"flags","description":"Flags for the sound (`3d`, `mono`, `noplay`, `noblock`). noblock will fail if the webserver doesn't provide file length."},{"type":"function","value":"function callback Function which is called when the sound is loaded. It'll get 3 arguments: `Bass` object, error number and name.","name":"callback","description":"Function which is called when the sound is loaded. It'll get 3 arguments: `Bass` object, error number and name."}],"class":"function","name":"loadURL","description":" Loads a sound as a Bass object from a URL.\n 2D sounds require a HUD connection."},"loadFile":{"path":"libs_cl/bass.lua#L194","realm":"client","params":[{"type":"string","value":"string path File path to play from.","name":"path","description":"File path to play from."},{"type":"string","value":"string flags Flags for the sound (`3d`, `mono`, `noplay`, `noblock`).","name":"flags","description":"Flags for the sound (`3d`, `mono`, `noplay`, `noblock`)."},{"type":"function","value":"function callback Function which is called when the sound is loaded. It'll get 3 arguments: `Bass` object, error number and name.","name":"callback","description":"Function which is called when the sound is loaded. It'll get 3 arguments: `Bass` object, error number and name."}],"class":"function","name":"loadFile","description":" Loads a sound as a Bass object from a file.\n 2D sounds require a HUD connection."},"soundsLeft":{"path":"libs_cl/bass.lua#L230","returns":[{"type":"number","value":"number The number of sounds left.","description":"The number of sounds left."}],"realm":"client","class":"function","name":"soundsLeft","description":" Returns the number of sounds left that can be created."}},"tables":[],"path":"libs_cl/bass.lua#L123","libtbl":["bass_library"],"realm":"client","fields":[],"class":"library","name":"bass","description":" `bass` library is intended to be used only on client side. It's good for streaming local and remote sound files and playing them directly in player's \"2D\" context."},"hook":{"methods":{"run":{"path":"libs_sh/hook.lua#L664","returns":[{"type":"...","value":"... returns Return result(s) of the hook ran","description":"returns Return result(s) of the hook ran"}],"realm":"shared","params":[{"type":"string","value":"string hookname The hook name","name":"hookname","description":"The hook name"},{"type":"...","value":"... arguments Arguments to pass to the hook","name":"arguments","description":"Arguments to pass to the hook"}],"class":"function","name":"run","description":" Run a hook and return the result"},"add":{"path":"libs_sh/hook.lua#L644","realm":"shared","params":[{"type":"string","value":"string hookname Name of the event","name":"hookname","description":"Name of the event"},{"type":"string","value":"string name Unique identifier","name":"name","description":"Unique identifier"},{"type":"function","value":"function func Function to run","name":"func","description":"Function to run"}],"class":"function","name":"add","description":" Sets a hook function"},"remove":{"path":"libs_sh/hook.lua#L733","realm":"shared","params":[{"type":"string","value":"string hookname The hook name","name":"hookname","description":"The hook name"},{"type":"string","value":"string name The unique name for this hook","name":"name","description":"The unique name for this hook"}],"class":"function","name":"remove","description":" Remove a hook"},"runRemote":{"path":"libs_sh/hook.lua#L696","returns":[{"type":"table","value":"table A list of the resultset of each called hook","description":"A list of the resultset of each called hook"}],"realm":"shared","params":[{"type":"Entity?","value":"Entity? recipient Starfall entity to call the hook on. Nil to run on every starfall entity","name":"recipient","description":"Starfall entity to call the hook on. Nil to run on every starfall entity"},{"type":"...","value":"... payload Parameters that will be passed when calling hook functions","name":"payload","description":"Parameters that will be passed when calling hook functions"}],"class":"function","name":"runRemote","description":" Run a hook remotely.\n This will call the hook \"remote\" on either a specified entity or all instances on the server/client"}},"tables":[],"path":"libs_sh/hook.lua#L622","libtbl":["hook_library"],"realm":"shared","fields":[],"class":"library","name":"hook","description":" Deals with hooks"},"material":{"methods":{"getFloat":{"path":"libs_cl/material.lua#L479","returns":[{"type":"number?","value":"number? The float value or nil if it doesn't exist","description":"The float value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"},{"type":"string","value":"string key The key to get the float from","name":"key","description":"The key to get the float from"}],"class":"function","name":"getFloat","description":" Returns a float keyvalue of a material"},"createFromImage":{"path":"libs_cl/material.lua#L559","returns":[{"type":"Material","value":"Material The Material created.","description":"The Material created."}],"realm":"client","params":[{"type":"string","value":"string path The path to the image file, must be a jpg or png image","name":"path","description":"The path to the image file, must be a jpg or png image"},{"type":"string","value":"string params The shader parameters to apply to the material. See https://wiki.facepunch.com/gmod/Material_Parameters","name":"params","description":"The shader parameters to apply to the material. See https://wiki.facepunch.com/gmod/Material_Parameters"}],"class":"function","name":"createFromImage","description":" Creates a .jpg or .png material from file\n Can't be modified"},"create":{"path":"libs_cl/material.lua#L539","returns":[{"type":"Material","value":"Material The Material created.","description":"The Material created."}],"realm":"client","params":[{"type":"string","value":"string shader The shader of the material. Must be one of","name":"shader","description":"The shader of the material. Must be one of"}],"class":"function","name":"create","description":" Creates a new blank material\n UnlitGeneric\n VertexLitGeneric\n Refract_DX90\n Water_DX90\n Sky_DX9\n gmodscreenspace\n Modulate_DX9"},"getMatrix":{"path":"libs_cl/material.lua#L499","returns":[{"type":"VMatrix?","value":"VMatrix? The matrix value or nil if it doesn't exist","description":"The matrix value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"},{"type":"string","value":"string key The key to get the matrix from","name":"key","description":"The key to get the matrix from"}],"class":"function","name":"getMatrix","description":" Returns a matrix keyvalue of a material"},"getVectorLinear":{"path":"libs_cl/material.lua#L529","returns":[{"type":"Vector?","value":"Vector? The vector value or nil if it doesn't exist","description":"The vector value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"},{"type":"string","value":"string key The key to get the vector from","name":"key","description":"The key to get the vector from"}],"class":"function","name":"getVectorLinear","description":" Returns a linear color-corrected vector keyvalue of a material"},"getKeyValues":{"path":"libs_cl/material.lua#L427","returns":[{"type":"table","value":"table The table of keyvalues","description":"The table of keyvalues"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"}],"class":"function","name":"getKeyValues","description":" Returns a table of keyvalues from a material"},"getColor":{"path":"libs_cl/material.lua#L467","returns":[{"type":"Color","value":"Color The color value","description":"The color value"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"},{"type":"number","value":"number x The x coordinate of the pixel","name":"x","description":"The x coordinate of the pixel"},{"type":"number","value":"number y The y coordinate of the pixel","name":"y","description":"The y coordinate of the pixel"}],"class":"function","name":"getColor","description":" Returns a color pixel value of the $basetexture of a .png or .jpg material."},"getShader":{"path":"libs_cl/material.lua#L443","returns":[{"type":"string","value":"string The shader name of the material","description":"The shader name of the material"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"}],"class":"function","name":"getShader","description":" Returns the shader name of a material"},"getInt":{"path":"libs_cl/material.lua#L489","returns":[{"type":"number?","value":"number? The int value or nil if it doesn't exist","description":"The int value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"},{"type":"string","value":"string key The key to get the int from","name":"key","description":"The key to get the int from"}],"class":"function","name":"getInt","description":" Returns an int keyvalue of a material"},"load":{"path":"libs_cl/material.lua#L402","returns":[{"type":"Material","value":"Material The material object. Can't be modified.","description":"The material object. Can't be modified."}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"}],"class":"function","name":"load","description":" Loads a .vmt material or existing material. Throws an error if the material fails to load\n Existing created materials can be loaded with ! prepended to the name\n Can't be modified"},"getTexture":{"path":"libs_cl/material.lua#L416","returns":[{"type":"string?","value":"string? The texture's name or nil if texture key isn't found","description":"The texture's name or nil if texture key isn't found"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"},{"type":"string","value":"string texture The texture key to get","name":"texture","description":"The texture key to get"}],"class":"function","name":"getTexture","description":" Gets a texture from a material"},"getString":{"path":"libs_cl/material.lua#L509","returns":[{"type":"string?","value":"string? The string value or nil if it doesn't exist","description":"The string value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"},{"type":"string","value":"string key The key to get the string from","name":"key","description":"The key to get the string from"}],"class":"function","name":"getString","description":" Returns a string keyvalue"},"getVector":{"path":"libs_cl/material.lua#L519","returns":[{"type":"Vector?","value":"Vector? The vector value or nil if it doesn't exist","description":"The vector value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"},{"type":"string","value":"string key The key to get the vector from","name":"key","description":"The key to get the vector from"}],"class":"function","name":"getVector","description":" Returns a vector keyvalue of a material"},"getName":{"path":"libs_cl/material.lua#L435","returns":[{"type":"string","value":"string The name of a material. If this material is user created, add ! to the beginning of this to use it with entity.setMaterial","description":"The name of a material. If this material is user created, add ! to the beginning of this to use it with entity.setMaterial"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"}],"class":"function","name":"getName","description":" Returns a material's engine name"},"getWidth":{"path":"libs_cl/material.lua#L451","returns":[{"type":"number","value":"number The basetexture's width","description":"The basetexture's width"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"}],"class":"function","name":"getWidth","description":" Returns the width of the member texture set for $basetexture of a material"},"getHeight":{"path":"libs_cl/material.lua#L459","returns":[{"type":"number","value":"number The basetexture's height","description":"The basetexture's height"}],"realm":"client","params":[{"type":"string","value":"string path The path of the material (don't include .vmt in the path)","name":"path","description":"The path of the material (don't include .vmt in the path)"}],"class":"function","name":"getHeight","description":" Returns the height of the member texture set for $basetexture of a material"}},"tables":[],"path":"libs_cl/material.lua#L367","libtbl":["material_library"],"realm":"client","fields":[],"class":"library","name":"material","description":" `material` library is allows creating material objects which are used for controlling shaders in rendering."},"team":{"methods":{"getPlayers":{"path":"libs_sh/team.lua#L28","returns":[{"type":"table","value":"table Table of players","description":"Table of players"}],"realm":"shared","params":[{"type":"number","value":"number ind Index of the team","name":"ind","description":"Index of the team"}],"class":"function","name":"getPlayers","description":" Returns the table of players on a team"},"getScore":{"path":"libs_sh/team.lua#L48","returns":[{"type":"number","value":"number Number score of the team","description":"Number score of the team"}],"realm":"shared","params":[{"type":"number","value":"number ind Index of the team","name":"ind","description":"Index of the team"}],"class":"function","name":"getScore","description":" Returns the score of a team"},"getNumPlayers":{"path":"libs_sh/team.lua#L62","returns":[{"type":"number","value":"number Number of players on the team","description":"Number of players on the team"}],"realm":"shared","params":[{"type":"number","value":"number ind Index of the team","name":"ind","description":"Index of the team"}],"class":"function","name":"getNumPlayers","description":" Returns number of players on a team"},"getName":{"path":"libs_sh/team.lua#L41","returns":[{"type":"string","value":"string String name of the team","description":"String name of the team"}],"realm":"shared","params":[{"type":"number","value":"number ind Index of the team","name":"ind","description":"Index of the team"}],"class":"function","name":"getName","description":" Returns the name of a team"},"getJoinable":{"path":"libs_sh/team.lua#L55","returns":[{"type":"boolean","value":"boolean Whether the team is joinable","description":"Whether the team is joinable"}],"realm":"shared","params":[{"type":"number","value":"number ind Index of the team","name":"ind","description":"Index of the team"}],"class":"function","name":"getJoinable","description":" Returns whether or not a team can be joined"},"exists":{"path":"libs_sh/team.lua#L83","returns":[{"type":"boolean","value":"boolean Whether the team exists","description":"Whether the team exists"}],"realm":"shared","params":[{"type":"number","value":"number ind Index of the team","name":"ind","description":"Index of the team"}],"class":"function","name":"exists","description":" Returns whether or not the team exists"},"getNumDeaths":{"path":"libs_sh/team.lua#L69","returns":[{"type":"number","value":"number Number of deaths","description":"Number of deaths"}],"realm":"shared","params":[{"type":"number","value":"number ind Index of the team","name":"ind","description":"Index of the team"}],"class":"function","name":"getNumDeaths","description":" Returns number of deaths of all players on a team"},"getAllTeams":{"path":"libs_sh/team.lua#L15","returns":[{"type":"table","value":"table Table containing team information","description":"Table containing team information"}],"realm":"shared","class":"function","name":"getAllTeams","description":" Returns a table containing team information"},"getNumFrags":{"path":"libs_sh/team.lua#L76","returns":[{"type":"number","value":"number Number of frags","description":"Number of frags"}],"realm":"shared","params":[{"type":"number","value":"number ind Index of the team","name":"ind","description":"Index of the team"}],"class":"function","name":"getNumFrags","description":" Returns number of frags of all players on a team"},"bestAutoJoinTeam":{"path":"libs_sh/team.lua#L35","returns":[{"type":"number","value":"number Index of the best team to join","description":"Index of the best team to join"}],"realm":"shared","class":"function","name":"bestAutoJoinTeam","description":" Returns team with least players"},"getColor":{"path":"libs_sh/team.lua#L21","returns":[{"type":"Color","value":"Color Color of the team","description":"Color of the team"}],"realm":"shared","params":[{"type":"number","value":"number ind Index of the team","name":"ind","description":"Index of the team"}],"class":"function","name":"getColor","description":" Returns the color of a team"}},"tables":[],"path":"libs_sh/team.lua#L2","libtbl":["team_library"],"realm":"shared","fields":[],"class":"library","name":"team","description":" Library for retreiving information about teams"},"http":{"methods":{"base64Decode":{"path":"libs_sh/http.lua#L153","returns":[{"type":"string","value":"string The converted data","description":"The converted data"}],"realm":"shared","params":[{"type":"string","value":"string data The data to convert","name":"data","description":"The data to convert"}],"class":"function","name":"base64Decode","description":" Converts data from base64 format"},"getMaximumRequests":{"path":"libs_sh/http.lua#L44","returns":[{"type":"number","value":"number Maximum amount of concurrent active HTTP get/post requests ","description":"Maximum amount of concurrent active HTTP get/post requests "}],"realm":"shared","class":"function","name":"getMaximumRequests","description":" Gets how many get/post operations can be in progress at the same time"},"urlDecode":{"path":"libs_sh/http.lua#L172","returns":[{"type":"string","value":"string The converted data","description":"The converted data"}],"realm":"shared","params":[{"type":"string","value":"string data The data to convert","name":"data","description":"The data to convert"}],"class":"function","name":"urlDecode","description":" Decodes the % escaped chars in a url"},"urlGoogleDriveToRaw":{"path":"libs_sh/http.lua#L186","returns":[{"type":"string","value":"string The converted url","description":"The converted url"}],"realm":"shared","params":[{"type":"string","value":"string url The url to convert","name":"url","description":"The url to convert"}],"class":"function","name":"urlGoogleDriveToRaw","description":" Converts a simple google drive url to a raw one"},"getActiveRequests":{"path":"libs_sh/http.lua#L38","returns":[{"type":"number","value":"number The current amount of active HTTP get/post requests","description":"The current amount of active HTTP get/post requests"}],"realm":"shared","class":"function","name":"getActiveRequests","description":" Gets how many get/post operations are currently in progress"},"post":{"path":"libs_sh/http.lua#L76","realm":"shared","params":[{"type":"string","value":"string url Http target url","name":"url","description":"Http target url"},{"type":"table?","value":"table? payload Optional POST payload to be sent, can be both table and string. When table is used, the request body is encoded as application/x-www-form-urlencoded","name":"payload","description":"Optional POST payload to be sent, can be both table and string. When table is used, the request body is encoded as application/x-www-form-urlencoded"},{"type":"function?","value":"function? callbackSuccess Optional function to be called on request success, taking the arguments body (string), length (number), headers (table) and code (number)","name":"callbackSuccess","description":"Optional function to be called on request success, taking the arguments body (string), length (number), headers (table) and code (number)"},{"type":"function?","value":"function? callbackFail Optional function to be called on request fail, taking the failing reason as an argument","name":"callbackFail","description":"Optional function to be called on request fail, taking the failing reason as an argument"},{"type":"table?","value":"table? headers Optional POST headers to be sent","name":"headers","description":"Optional POST headers to be sent"}],"class":"function","name":"post","description":" Runs a new http POST request"},"urlDropboxToRaw":{"path":"libs_sh/http.lua#L196","returns":[{"type":"string","value":"string The converted url","description":"The converted url"}],"realm":"shared","params":[{"type":"string","value":"string url The url to convert","name":"url","description":"The url to convert"}],"class":"function","name":"urlDropboxToRaw","description":" Converts a regular dropbox url to a raw one"},"urlEncode":{"path":"libs_sh/http.lua#L160","returns":[{"type":"string","value":"string The converted data","description":"The converted data"}],"realm":"shared","params":[{"type":"string","value":"string data The data to convert","name":"data","description":"The data to convert"}],"class":"function","name":"urlEncode","description":" Encodes illegal url characters to be legal"},"base64Encode":{"path":"libs_sh/http.lua#L140","returns":[{"type":"string","value":"string The converted data","description":"The converted data"}],"realm":"shared","params":[{"type":"string","value":"string data The data to convert","name":"data","description":"The data to convert"}],"class":"function","name":"base64Encode","description":" Converts data into base64 format or nil if the string is 0 length"},"canRequest":{"path":"libs_sh/http.lua#L32","returns":[{"type":"boolean","value":"boolean If an HTTP get/post request can be made","description":"If an HTTP get/post request can be made"}],"realm":"shared","class":"function","name":"canRequest","description":" Checks if a new http request can be started"},"get":{"path":"libs_sh/http.lua#L50","realm":"shared","params":[{"type":"string","value":"string url Http target url","name":"url","description":"Http target url"},{"type":"function","value":"function callbackSuccess The function to be called on request success, taking the arguments body (string), length (number), headers (table) and code (number)","name":"callbackSuccess","description":"The function to be called on request success, taking the arguments body (string), length (number), headers (table) and code (number)"},{"type":"function?","value":"function? callbackFail The function to be called on request fail, taking the failing reason as an argument","name":"callbackFail","description":"The function to be called on request fail, taking the failing reason as an argument"},{"type":"table?","value":"table? headers GET headers to be sent","name":"headers","description":"GET headers to be sent"}],"class":"function","name":"get","description":" Runs a new http GET request"}},"tables":[],"path":"libs_sh/http.lua#L11","libtbl":["http_library"],"realm":"shared","fields":[],"class":"library","name":"http","description":" Http library. Requests content from urls."},"particle":{"methods":{"create":{"path":"libs_cl/particle.lua#L51","returns":[{"type":"ParticleEmitter","value":"ParticleEmitter ParticleEmitter Object","description":"ParticleEmitter Object"}],"realm":"client","params":[{"type":"Vector","value":"Vector position The particle emitter's position","name":"position","description":"The particle emitter's position"},{"type":"boolean","value":"boolean use3D Create the emitter in 3D mode","name":"use3D","description":"Create the emitter in 3D mode"}],"class":"function","name":"create","description":" Creates a ParticleEmitter data structure"},"particleEmittersLeft":{"path":"libs_cl/particle.lua#L64","returns":[{"type":"number","value":"number Number of particle emitters left","description":"Number of particle emitters left"}],"realm":"client","class":"function","name":"particleEmittersLeft","description":" Returns number of particle emitters left able to be created"}},"tables":[],"path":"libs_cl/particle.lua#L13","libtbl":["particle_library"],"realm":"client","fields":[],"class":"library","name":"particle","description":" Particles library."},"file":{"methods":{"exists":{"path":"libs_cl/file.lua#L313","returns":[{"type":"boolean?","value":"boolean? True if exists, false if not, nil if error","description":"True if exists, false if not, nil if error"}],"realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."}],"class":"function","name":"exists","description":" Checks if a file exists"},"find":{"path":"libs_cl/file.lua#L370","returns":[{"type":"table","value":"table Table of file names","description":"Table of file names"},{"type":"table","value":"table Table of directory names","description":"Table of directory names"}],"realm":"client","params":[{"type":"string","value":"string path The folder to enumerate, relative to data/sf_filedata/.","name":"path","description":"The folder to enumerate, relative to data/sf_filedata/."},{"type":"string?","value":"string? sorting Optional sorting argument. Either nameasc, namedesc, dateasc, datedesc","name":"sorting","description":"Optional sorting argument. Either nameasc, namedesc, dateasc, datedesc"}],"class":"function","name":"find","description":" Enumerates a directory"},"write":{"path":"libs_cl/file.lua#L234","realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."},{"type":"string","value":"string data The data to write","name":"data","description":"The data to write"}],"class":"function","name":"write","description":" Writes to a file. Throws an error if it failed to write"},"readInGame":{"path":"libs_cl/file.lua#L204","returns":[{"type":"string?","value":"string? Contents or nil if error","description":"Contents or nil if error"}],"realm":"client","params":[{"type":"string","value":"string path Filepath relative to GarrysMod/garrysmod/.","name":"path","description":"Filepath relative to GarrysMod/garrysmod/."}],"class":"function","name":"readInGame","description":" Reads a file from path relative to base GMod directory"},"read":{"path":"libs_cl/file.lua#L195","returns":[{"type":"string?","value":"string? Contents, or nil if error","description":"Contents, or nil if error"}],"realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."}],"class":"function","name":"read","description":" Reads a file from path"},"writeTemp":{"path":"libs_cl/file.lua#L263","returns":[{"type":"string","value":"string The generated path for your temp file","description":"The generated path for your temp file"}],"realm":"client","params":[{"type":"string","value":"string filename The name to give the file. Must be only a file and not a path","name":"filename","description":"The name to give the file. Must be only a file and not a path"},{"type":"string","value":"string data The data to write","name":"data","description":"The data to write"}],"class":"function","name":"writeTemp","description":" Writes a temporary file. Throws an error if it is unable to."},"existsTemp":{"path":"libs_cl/file.lua#L283","returns":[{"type":"string?","value":"string? The path to the temp file or nil if it doesn't exist","description":"The path to the temp file or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string filename The temp file name. Must be only a file and not a path","name":"filename","description":"The temp file name. Must be only a file and not a path"}],"class":"function","name":"existsTemp","description":" Returns the path of a temp file if it exists. Otherwise returns nil"},"open":{"path":"libs_cl/file.lua#L180","returns":[{"type":"File?","value":"File? File object or nil if it failed","description":"File object or nil if it failed"}],"realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."},{"type":"string","value":"string mode The file mode to use. See lua manual for explanation","name":"mode","description":"The file mode to use. See lua manual for explanation"}],"class":"function","name":"open","description":" Opens and returns a file"},"delete":{"path":"libs_cl/file.lua#L331","returns":[{"type":"boolean?","value":"boolean? True if successful, nil if it wasn't found","description":"True if successful, nil if it wasn't found"}],"realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."}],"class":"function","name":"delete","description":" Deletes a file"},"createDir":{"path":"libs_cl/file.lua#L362","realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."}],"class":"function","name":"createDir","description":" Creates a directory"},"deleteTemp":{"path":"libs_cl/file.lua#L344","returns":[{"type":"boolean?","value":"boolean? True if successful, nil if it wasn't found","description":"True if successful, nil if it wasn't found"}],"realm":"client","params":[{"type":"string","value":"string filename The temp file name. Must be only a file and not a path","name":"filename","description":"The temp file name. Must be only a file and not a path"}],"class":"function","name":"deleteTemp","description":" Deletes a temp file"},"append":{"path":"libs_cl/file.lua#L299","realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."},{"type":"string","value":"string data String that will be appended to the file.","name":"data","description":"String that will be appended to the file."}],"class":"function","name":"append","description":" Appends a string to the end of a file"},"findInGame":{"path":"libs_cl/file.lua#L382","returns":[{"type":"table","value":"table Table of file names","description":"Table of file names"},{"type":"table","value":"table Table of directory names","description":"Table of directory names"}],"realm":"client","params":[{"type":"string","value":"string path The folder to enumerate, relative to garrysmod.","name":"path","description":"The folder to enumerate, relative to garrysmod."},{"type":"string?","value":"string? sorting Optional sorting argument. Either nameasc, namedesc, dateasc, datedesc","name":"sorting","description":"Optional sorting argument. Either nameasc, namedesc, dateasc, datedesc"}],"class":"function","name":"findInGame","description":" Enumerates a directory relative to gmod"},"asyncRead":{"path":"libs_cl/file.lua#L213","realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."},{"type":"function","value":"function callback A callback function for when the read operation finishes. It has 3 arguments: `filename` string, `status` number and `data` string","name":"callback","description":"A callback function for when the read operation finishes. It has 3 arguments: `filename` string, `status` number and `data` string"}],"class":"function","name":"asyncRead","description":" Reads a file asynchronously. Can only read 'sf_file_asyncmax' files at a time"},"time":{"path":"libs_cl/file.lua#L394","returns":[{"type":"number","value":"number Last modified time in Unix time","description":"Last modified time in Unix time"}],"realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."}],"class":"function","name":"time","description":" Returns when the file or folder was last modified in Unix time.\n Can then be used with something like os.date for a human-readable date."},"isDir":{"path":"libs_cl/file.lua#L322","returns":[{"type":"boolean","value":"boolean True if given path is a directory, false if it's a file","description":"True if given path is a directory, false if it's a file"}],"realm":"client","params":[{"type":"string","value":"string path Filepath relative to data/sf_filedata/.","name":"path","description":"Filepath relative to data/sf_filedata/."}],"class":"function","name":"isDir","description":" Checks if a given file is a directory or not"},"readTemp":{"path":"libs_cl/file.lua#L250","returns":[{"type":"string?","value":"string? The data of the temp file or nil if it doesn't exist","description":"The data of the temp file or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string filename The temp file name. Must be only a file and not a path","name":"filename","description":"The temp file name. Must be only a file and not a path"}],"class":"function","name":"readTemp","description":" Reads a temp file's data if it exists. Otherwise returns nil"}},"tables":[],"path":"libs_cl/file.lua#L23","libtbl":["file_library"],"realm":"client","fields":[],"class":"library","name":"file","description":" File functions. Allows modification of files."},"constraint":{"methods":{"rope":{"path":"libs_sv/constraint.lua#L326","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"number","value":"number index Index of the rope constraint","name":"index","description":"Index of the rope constraint"},{"type":"Entity","value":"Entity e1 The first entity","name":"e1","description":"The first entity"},{"type":"Entity","value":"Entity e2 The second entity","name":"e2","description":"The second entity"},{"type":"number?","value":"number? bone1 Number bone of the first entity. Default 0","name":"bone1","description":"Number bone of the first entity. Default 0"},{"type":"number?","value":"number? bone2 Number bone of the second entity. Default 0","name":"bone2","description":"Number bone of the second entity. Default 0"},{"type":"Vector","value":"Vector v1 Position on the first entity, in its local space coordinates","name":"v1","description":"Position on the first entity, in its local space coordinates"},{"type":"Vector","value":"Vector v2 Position on the second entity, in its local space coordinates","name":"v2","description":"Position on the second entity, in its local space coordinates"},{"type":"number?","value":"number? length Length of the created rope. Default 0","name":"length","description":"Length of the created rope. Default 0"},{"type":"number?","value":"number? addlength Amount to add to the base length of the rope. Default 0","name":"addlength","description":"Amount to add to the base length of the rope. Default 0"},{"type":"number?","value":"number? force_lim Amount of force until it breaks, 0 = Unbreakable. Default 0","name":"force_lim","description":"Amount of force until it breaks, 0 = Unbreakable. Default 0"},{"type":"number?","value":"number? width Width of the rope. Default 0","name":"width","description":"Width of the rope. Default 0"},{"type":"string?","value":"string? materialName Material of the rope","name":"materialName","description":"Material of the rope"},{"type":"boolean?","value":"boolean? rigid Whether the rope is rigid. Default false","name":"rigid","description":"Whether the rope is rigid. Default false"},{"type":"Color?","value":"Color? color The color of the rope. Default white","name":"color","description":"The color of the rope. Default white"}],"class":"function","name":"rope","description":" Creates a rope between two entities"},"setElasticLength":{"path":"libs_sv/constraint.lua#L479","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"number","value":"number index Index of the elastic constraint","name":"index","description":"Index of the elastic constraint"},{"type":"Entity","value":"Entity e Entity that has the constraint","name":"e","description":"Entity that has the constraint"},{"type":"number","value":"number length New length of the constraint","name":"length","description":"New length of the constraint"}],"class":"function","name":"setElasticLength","description":" Sets the length of an elastic attached to the entity"},"slider":{"path":"libs_sv/constraint.lua#L384","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"Entity","value":"Entity e1 The first entity","name":"e1","description":"The first entity"},{"type":"Entity","value":"Entity e2 The second entity","name":"e2","description":"The second entity"},{"type":"number?","value":"number? bone1 Number bone of the first entity. Default 0","name":"bone1","description":"Number bone of the first entity. Default 0"},{"type":"number?","value":"number? bone2 Number bone of the second entity. Default 0","name":"bone2","description":"Number bone of the second entity. Default 0"},{"type":"Vector","value":"Vector v1 Position on the first entity, in its local space coordinates","name":"v1","description":"Position on the first entity, in its local space coordinates"},{"type":"Vector","value":"Vector v2 Position on the second entity, in its local space coordinates","name":"v2","description":"Position on the second entity, in its local space coordinates"},{"type":"number?","value":"number? width Width of the slider. Default 0","name":"width","description":"Width of the slider. Default 0"}],"class":"function","name":"slider","description":" Sliders two entities"},"setConstraintClean":{"path":"libs_sv/constraint.lua#L577","realm":"server","params":[{"type":"boolean","value":"boolean on Whether the constraints should be cleaned or not","name":"on","description":"Whether the constraints should be cleaned or not"}],"class":"function","name":"setConstraintClean","description":" Sets whether the chip should remove created constraints when the chip is removed"},"ballsocketadv":{"path":"libs_sv/constraint.lua#L223","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"Entity","value":"Entity e1 The first entity","name":"e1","description":"The first entity"},{"type":"Entity","value":"Entity e2 The second entity","name":"e2","description":"The second entity"},{"type":"number?","value":"number? bone1 Number bone of the first entity. Default 0","name":"bone1","description":"Number bone of the first entity. Default 0"},{"type":"number?","value":"number? bone2 Number bone of the second entity. Default 0","name":"bone2","description":"Number bone of the second entity. Default 0"},{"type":"Vector","value":"Vector v1 Position on the first entity, in its local space coordinates","name":"v1","description":"Position on the first entity, in its local space coordinates"},{"type":"Vector","value":"Vector v2 Position on the second entity, in its local space coordinates","name":"v2","description":"Position on the second entity, in its local space coordinates"},{"type":"number?","value":"number? force_lim Amount of force until it breaks, 0 = Unbreakable. Default 0","name":"force_lim","description":"Amount of force until it breaks, 0 = Unbreakable. Default 0"},{"type":"number?","value":"number? torque_lim Amount of torque until it breaks, 0 = Unbreakable. Default 0","name":"torque_lim","description":"Amount of torque until it breaks, 0 = Unbreakable. Default 0"},{"type":"Vector?","value":"Vector? minv Vector defining minimum rotation angle based on world axes. Default Vec(0)","name":"minv","description":"Vector defining minimum rotation angle based on world axes. Default Vec(0)"},{"type":"Vector?","value":"Vector? maxv Vector defining maximum rotation angle based on world axes. Default Vec(0)","name":"maxv","description":"Vector defining maximum rotation angle based on world axes. Default Vec(0)"},{"type":"Vector?","value":"Vector? frictionv Vector defining rotational friction, local to the constraint. Default Vec(0)","name":"frictionv","description":"Vector defining rotational friction, local to the constraint. Default Vec(0)"},{"type":"boolean?","value":"boolean? rotateonly If True, ballsocket will only affect the rotation allowing for free movement, otherwise it will limit both - rotation and movement. Default false","name":"rotateonly","description":"If True, ballsocket will only affect the rotation allowing for free movement, otherwise it will limit both - rotation and movement. Default false"},{"type":"boolean?","value":"boolean? nocollide Bool whether or not to nocollide the two entities. Default false","name":"nocollide","description":"Bool whether or not to nocollide the two entities. Default false"}],"class":"function","name":"ballsocketadv","description":" Ballsocket two entities together with more options"},"breakType":{"path":"libs_sv/constraint.lua#L555","realm":"server","params":[{"type":"Entity","value":"Entity e Entity to be affected","name":"e","description":"Entity to be affected"},{"type":"string","value":"string typename Name of the constraint type, ie. Weld, Elastic, NoCollide, etc.","name":"typename","description":"Name of the constraint type, ie. Weld, Elastic, NoCollide, etc."}],"class":"function","name":"breakType","description":" Breaks all constraints of a certain type on an entity"},"keepupright":{"path":"libs_sv/constraint.lua#L451","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"Entity","value":"Entity e The entity","name":"e","description":"The entity"},{"type":"Angle","value":"Angle ang The upright angle","name":"ang","description":"The upright angle"},{"type":"number","value":"number bone Number bone of the entity. Default 0","name":"bone","description":"Number bone of the entity. Default 0"},{"type":"number","value":"number lim The strength of the constraint. Default 5000","name":"lim","description":"The strength of the constraint. Default 5000"}],"class":"function","name":"keepupright","description":" Applies a keepupright constraint on an entity"},"nocollide":{"path":"libs_sv/constraint.lua#L421","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"Entity","value":"Entity e1 The first entity","name":"e1","description":"The first entity"},{"type":"Entity","value":"Entity e2 The second entity","name":"e2","description":"The second entity"},{"type":"number?","value":"number? bone1 Number bone of the first entity. Default 0","name":"bone1","description":"Number bone of the first entity. Default 0"},{"type":"number?","value":"number? bone2 Number bone of the second entity. Default 0","name":"bone2","description":"Number bone of the second entity. Default 0"}],"class":"function","name":"nocollide","description":" Nocollides two entities"},"getTable":{"path":"libs_sv/constraint.lua#L570","returns":[{"type":"table","value":"table Table of tables containing constraint information","description":"Table of tables containing constraint information"}],"realm":"server","params":[{"type":"Entity","value":"Entity ent The entity","name":"ent","description":"The entity"}],"class":"function","name":"getTable","description":" Returns the table of constraints on an entity"},"ballsocket":{"path":"libs_sv/constraint.lua#L184","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"Entity","value":"Entity e1 The first entity","name":"e1","description":"The first entity"},{"type":"Entity","value":"Entity e2 The second entity","name":"e2","description":"The second entity"},{"type":"number?","value":"number? bone1 Number bone of the first entity. Default 0","name":"bone1","description":"Number bone of the first entity. Default 0"},{"type":"number?","value":"number? bone2 Number bone of the second entity. Default 0","name":"bone2","description":"Number bone of the second entity. Default 0"},{"type":"Vector","value":"Vector pos Position of the joint, relative to the second entity","name":"pos","description":"Position of the joint, relative to the second entity"},{"type":"number?","value":"number? force_lim Amount of force until it breaks, 0 = Unbreakable. Default 0","name":"force_lim","description":"Amount of force until it breaks, 0 = Unbreakable. Default 0"},{"type":"number?","value":"number? torque_lim Amount of torque until it breaks, 0 = Unbreakable. Default 0","name":"torque_lim","description":"Amount of torque until it breaks, 0 = Unbreakable. Default 0"},{"type":"boolean?","value":"boolean? nocollide Bool whether or not to nocollide the two entities. Default false","name":"nocollide","description":"Bool whether or not to nocollide the two entities. Default false"}],"class":"function","name":"ballsocket","description":" Ballsocket two entities together. For more options, see constraint.ballsocketadv"},"removeAll":{"path":"libs_sv/constraint.lua#L79","realm":"server","class":"function","name":"removeAll","description":" Removes all constraints created by the calling chip"},"constraintsLeft":{"path":"libs_sv/constraint.lua#L583","returns":[{"type":"number","value":"number Number of constraints able to be spawned","description":"Number of constraints able to be spawned"}],"realm":"server","class":"function","name":"constraintsLeft","description":" Checks how many constraints can be spawned"},"setElasticDamping":{"path":"libs_sv/constraint.lua#L501","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"number","value":"number index Index of the elastic constraint","name":"index","description":"Index of the elastic constraint"},{"type":"Entity","value":"Entity e Entity that has the elastic","name":"e","description":"Entity that has the elastic"},{"type":"number","value":"number damping New Damping value of the elastic","name":"damping","description":"New Damping value of the elastic"}],"class":"function","name":"setElasticDamping","description":" Sets the damping of an elastic attached to the entity"},"breakAll":{"path":"libs_sv/constraint.lua#L545","realm":"server","params":[{"type":"Entity","value":"Entity e Entity to remove the constraints from","name":"e","description":"Entity to remove the constraints from"}],"class":"function","name":"breakAll","description":" Breaks all constraints on an entity"},"axis":{"path":"libs_sv/constraint.lua#L138","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"Entity","value":"Entity e1 The first entity","name":"e1","description":"The first entity"},{"type":"Entity","value":"Entity e2 The second entity","name":"e2","description":"The second entity"},{"type":"number?","value":"number? bone1 Number bone of the first entity. Default 0","name":"bone1","description":"Number bone of the first entity. Default 0"},{"type":"number?","value":"number? bone2 Number bone of the second entity. Default 0","name":"bone2","description":"Number bone of the second entity. Default 0"},{"type":"Vector","value":"Vector v1 Position to center the axis, local to e1's space coordinates","name":"v1","description":"Position to center the axis, local to e1's space coordinates"},{"type":"Vector","value":"Vector v2 The second position defining the axis, local to e2's space coordinates. The laxis may be specified instead which is local to e1's space coordinates","name":"v2","description":"The second position defining the axis, local to e2's space coordinates. The laxis may be specified instead which is local to e1's space coordinates"},{"type":"number?","value":"number? force_lim Amount of force until it breaks, 0 = Unbreakable. Default 0","name":"force_lim","description":"Amount of force until it breaks, 0 = Unbreakable. Default 0"},{"type":"number?","value":"number? torque_lim Amount of torque until it breaks, 0 = Unbreakable. Default 0","name":"torque_lim","description":"Amount of torque until it breaks, 0 = Unbreakable. Default 0"},{"type":"number?","value":"number? friction Friction of the constraint. Default 0","name":"friction","description":"Friction of the constraint. Default 0"},{"type":"boolean?","value":"boolean? nocollide Bool whether or not to nocollide the two entities. Default false","name":"nocollide","description":"Bool whether or not to nocollide the two entities. Default false"},{"type":"Vector?","value":"Vector? laxis Optional second position of the constraint, same as v2 but local to e1","name":"laxis","description":"Optional second position of the constraint, same as v2 but local to e1"}],"class":"function","name":"axis","description":" Axis two entities. v1 in e1's coordinates and v2 in e2's coordinates (or laxis in e1's coordinates again) define the axis"},"weld":{"path":"libs_sv/constraint.lua#L104","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"Entity","value":"Entity e1 The first entity","name":"e1","description":"The first entity"},{"type":"Entity","value":"Entity e2 The second entity","name":"e2","description":"The second entity"},{"type":"number?","value":"number? bone1 Number bone of the first entity. Default 0","name":"bone1","description":"Number bone of the first entity. Default 0"},{"type":"number?","value":"number? bone2 Number bone of the second entity. Default 0","name":"bone2","description":"Number bone of the second entity. Default 0"},{"type":"number?","value":"number? force_lim Max force the weld can take before breaking. Default 0","name":"force_lim","description":"Max force the weld can take before breaking. Default 0"},{"type":"boolean?","value":"boolean? nocollide Bool whether or not to nocollide the two entities. Default false","name":"nocollide","description":"Bool whether or not to nocollide the two entities. Default false"}],"class":"function","name":"weld","description":" Welds two entities"},"setElasticConstant":{"path":"libs_sv/constraint.lua#L523","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"number","value":"number index Index of the elastic constraint","name":"index","description":"Index of the elastic constraint"},{"type":"Entity","value":"Entity e Entity that has the elastic","name":"e","description":"Entity that has the elastic"},{"type":"number","value":"number constant New constant value of the elastic","name":"constant","description":"New constant value of the elastic"}],"class":"function","name":"setElasticConstant","description":" Sets the constant of an elastic attached to the entity"},"elastic":{"path":"libs_sv/constraint.lua#L272","returns":[{"type":"Constraint","value":"Constraint The constraint entity","description":"The constraint entity"}],"realm":"server","params":[{"type":"number","value":"number index Index of the elastic constraint","name":"index","description":"Index of the elastic constraint"},{"type":"Entity","value":"Entity e1 The first entity","name":"e1","description":"The first entity"},{"type":"Entity","value":"Entity e2 The second entity","name":"e2","description":"The second entity"},{"type":"number?","value":"number? bone1 Number bone of the first entity. Default 0","name":"bone1","description":"Number bone of the first entity. Default 0"},{"type":"number?","value":"number? bone2 Number bone of the second entity. Default 0","name":"bone2","description":"Number bone of the second entity. Default 0"},{"type":"Vector","value":"Vector v1 Position on the first entity, in its local space coordinates","name":"v1","description":"Position on the first entity, in its local space coordinates"},{"type":"Vector","value":"Vector v2 Position on the second entity, in its local space coordinates","name":"v2","description":"Position on the second entity, in its local space coordinates"},{"type":"number?","value":"number? const Constant of the constraint. Default 1000","name":"const","description":"Constant of the constraint. Default 1000"},{"type":"number?","value":"number? damp Damping of the constraint. Default 100","name":"damp","description":"Damping of the constraint. Default 100"},{"type":"number?","value":"number? rdamp Rotational damping of the constraint. Default 0","name":"rdamp","description":"Rotational damping of the constraint. Default 0"},{"type":"number?","value":"number? width Width of the created constraint. Default 0","name":"width","description":"Width of the created constraint. Default 0"},{"type":"boolean?","value":"boolean? stretch True to mark as stretch-only. Default false","name":"stretch","description":"True to mark as stretch-only. Default false"}],"class":"function","name":"elastic","description":" Elastic constraint between two entities"}},"tables":[],"path":"libs_sv/constraint.lua#L21","libtbl":["constraint_library"],"realm":"server","fields":[],"class":"library","name":"constraint","description":" Library for creating and manipulating constraints."},"game":{"methods":{"getAmmoData":{"path":"libs_sh/game.lua#L80","returns":[{"type":"table","value":"table AmmoData, see https://wiki.facepunch.com/gmod/Structures/AmmoData","description":"AmmoData, see https://wiki.facepunch.com/gmod/Structures/AmmoData"}],"realm":"shared","params":[{"type":"number","value":"number id See https://wiki.facepunch.com/gmod/Default_Ammo_Types","name":"id","description":"See https://wiki.facepunch.com/gmod/Default_Ammo_Types"}],"class":"function","name":"getAmmoData","description":" Returns AmmoData for given id"},"getTickInterval":{"path":"libs_sh/game.lua#L68","returns":[{"type":"number","value":"number Interval","description":"Interval"}],"realm":"shared","class":"function","name":"getTickInterval","description":" Returns the number of seconds between each gametick"},"steamIDTo64":{"path":"libs_sh/game.lua#L118","returns":[{"type":"string","value":"string 64bit Steam ID","description":"64bit Steam ID"}],"realm":"shared","params":[{"type":"string","value":"string id The STEAM_0 style id","name":"id","description":"The STEAM_0 style id"}],"class":"function","name":"steamIDTo64","description":" Given a STEAM_0 style Steam ID will return a 64bit Steam ID"},"serverFrameTime":{"path":"libs_sh/game.lua#L163","returns":[{"type":"number","value":"number Server frametime","description":"Server frametime"},{"type":"number","value":"number Server frametime standard deviation","description":"Server frametime standard deviation"}],"realm":"client","class":"function","name":"serverFrameTime","description":" Returns the server's frame time and standard deviation"},"blastDamage":{"path":"libs_sh/game.lua#L127","realm":"server","params":[{"type":"Vector","value":"Vector damageOrigin The center of the explosion","name":"damageOrigin","description":"The center of the explosion"},{"type":"number","value":"number damageRadius The radius in which entities will be damaged (0 - 1500)","name":"damageRadius","description":"The radius in which entities will be damaged (0 - 1500)"},{"type":"number","value":"number damage The amount of damage to be applied","name":"damage","description":"The amount of damage to be applied"}],"class":"function","name":"blastDamage","description":" Applies explosion damage to all entities in the specified radius"},"getHostname":{"path":"libs_sh/game.lua#L25","returns":[{"type":"string","value":"string The hostname of the server","description":"The hostname of the server"}],"realm":"shared","class":"function","name":"getHostname","description":" Returns The hostname"},"getPlayerModels":{"path":"libs_sh/game.lua#L100","returns":[{"type":"table","value":"table List of valid playermodels","description":"List of valid playermodels"}],"realm":"shared","class":"function","name":"getPlayerModels","description":" Returns a table with keys that are condensed model path names and value identifiers of said paths"},"getAmmoMax":{"path":"libs_sh/game.lua#L87","returns":[{"type":"number","value":"number The maximum amount of reserve ammo a player can hold of this ammo type","description":"The maximum amount of reserve ammo a player can hold of this ammo type"}],"realm":"shared","params":[{"type":"number","value":"number id See https://wiki.facepunch.com/gmod/Default_Ammo_Types","name":"id","description":"See https://wiki.facepunch.com/gmod/Default_Ammo_Types"}],"class":"function","name":"getAmmoMax","description":" Returns the real maximum amount of ammo of given ammo ID, regardless of the setting of gmod_maxammo convar"},"steamIDFrom64":{"path":"libs_sh/game.lua#L111","returns":[{"type":"string","value":"string STEAM_0 style Steam ID","description":"STEAM_0 style Steam ID"}],"realm":"shared","params":[{"type":"string","value":"string id The 64 bit Steam ID","name":"id","description":"The 64 bit Steam ID"}],"class":"function","name":"steamIDFrom64","description":" Given a 64bit SteamID will return a STEAM_0: style Steam ID"},"isDedicated":{"path":"libs_sh/game.lua#L43","returns":[{"type":"boolean","value":"boolean True if the game is a dedicated server","description":"True if the game is a dedicated server"}],"realm":"shared","class":"function","name":"isDedicated","description":" Returns whether or not the server is a dedicated server"},"isLan":{"path":"libs_sh/game.lua#L31","returns":[{"type":"boolean","value":"boolean True if the game is a lan game","description":"True if the game is a lan game"}],"realm":"shared","class":"function","name":"isLan","description":" Returns true if the server is on a LAN"},"getTimeScale":{"path":"libs_sh/game.lua#L62","returns":[{"type":"number","value":"number Time scale","description":"Time scale"}],"realm":"shared","class":"function","name":"getTimeScale","description":" Returns the game time scale"},"isTimingOut":{"path":"libs_sh/game.lua#L171","returns":[{"type":"boolean","value":"boolean If currently timing out","description":"If currently timing out"},{"type":"number","value":"number Time since the connection started to timeout","description":"Time since the connection started to timeout"}],"realm":"client","class":"function","name":"isTimingOut","description":" Returns if the client is currently timing out from the server"},"isSkyboxVisibleFromPoint":{"path":"libs_sh/game.lua#L155","returns":[{"type":"boolean","value":"boolean Whether the skybox is visible from the position","description":"Whether the skybox is visible from the position"}],"realm":"client","params":[{"type":"Vector","value":"Vector position The position to check the skybox visibility from","name":"position","description":"The position to check the skybox visibility from"}],"class":"function","name":"isSkyboxVisibleFromPoint","description":" Check whether the skybox is visible from the point specified"},"getTickCount":{"path":"libs_sh/game.lua#L74","returns":[{"type":"number","value":"number Ticks","description":"Ticks"}],"realm":"shared","class":"function","name":"getTickCount","description":" Returns the number of ticks since the game started"},"getSunInfo":{"path":"libs_sh/game.lua#L146","returns":[{"type":"Vector","value":"Vector The direction of the sun","description":"The direction of the sun"},{"type":"number","value":"number How obstructed the sun is 0 to 1.","description":"How obstructed the sun is 0 to 1."}],"realm":"client","class":"function","name":"getSunInfo","description":" Returns the direction and how obstructed the map's sun is or nil if it doesn't exist"},"getWorld":{"path":"libs_sh/game.lua#L94","returns":[{"type":"Entity","value":"Entity Worldspawn","description":"Worldspawn"}],"realm":"shared","class":"function","name":"getWorld","description":" Returns the worldspawn entity"},"getMap":{"path":"libs_sh/game.lua#L19","returns":[{"type":"string","value":"string The name of the current map","description":"The name of the current map"}],"realm":"shared","class":"function","name":"getMap","description":" Returns the map name"},"isSinglePlayer":{"path":"libs_sh/game.lua#L37","returns":[{"type":"boolean","value":"boolean True if the game is singleplayer","description":"True if the game is singleplayer"}],"realm":"shared","class":"function","name":"isSinglePlayer","description":" Returns whether or not the current game is single player"},"getMaxPlayers":{"path":"libs_sh/game.lua#L49","returns":[{"type":"number","value":"number The max players allowed by the server","description":"The max players allowed by the server"}],"realm":"shared","class":"function","name":"getMaxPlayers","description":" Returns the maximum player limit"},"isMounted":{"path":"libs_sh/game.lua#L55","returns":[{"type":"boolean","value":"boolean True if the game is mounted","description":"True if the game is mounted"}],"realm":"shared","params":[{"type":"string","value":"string str String identifier of the game, eg. 'cstrike'","name":"str","description":"String identifier of the game, eg. 'cstrike'"}],"class":"function","name":"isMounted","description":" Checks whether the specified game is mounted"},"hasFocus":{"path":"libs_sh/game.lua#L139","returns":[{"type":"boolean","value":"boolean True if the game is focused","description":"True if the game is focused"}],"realm":"client","class":"function","name":"hasFocus","description":" Returns if the game has focus or not, i.e. will return false if the game is minimized"}},"tables":[],"path":"libs_sh/game.lua#L6","libtbl":["game_library"],"realm":"shared","fields":[],"class":"library","name":"game","description":" Game functions"},"xinput":{"methods":{"setRumble":{"path":"libs_cl/xinput.lua#L133","realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number softPercent A number between 0.0-1.0 for how much the soft rumble motor should vibrate.","name":"softPercent","description":"A number between 0.0-1.0 for how much the soft rumble motor should vibrate."},{"type":"number","value":"number hardPercent A number between 0.0-1.0 for how much the hard rumble motor should vibrate.","name":"hardPercent","description":"A number between 0.0-1.0 for how much the hard rumble motor should vibrate."}],"class":"function","name":"setRumble","description":" Sets the rumble on the controller."},"getTrigger":{"path":"libs_cl/xinput.lua#L102","returns":[{"type":"number","value":"number 0-255 inclusive","description":"0-255 inclusive"}],"realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number trigger Which trigger to use. 0 is left","name":"trigger","description":"Which trigger to use. 0 is left"}],"class":"function","name":"getTrigger","description":" Gets the current position of the trigger on the controller."},"getStick":{"path":"libs_cl/xinput.lua#L110","returns":[{"type":"number","value":"number X Coordinate, Between -32768 - 32767 inclusive","description":"X Coordinate, Between -32768 - 32767 inclusive"},{"type":"number","value":"number Y Coordinate, Between -32768 - 32767 inclusive","description":"Y Coordinate, Between -32768 - 32767 inclusive"}],"realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number stick Which stick to use. 0 is left","name":"stick","description":"Which stick to use. 0 is left"}],"class":"function","name":"getStick","description":" Gets the current coordinates of the stick on the controller."},"getBatteryLevel":{"path":"libs_cl/xinput.lua#L119","returns":[{"type":"number|boolean","value":"number|boolean If successful: a number between 0.0-1.0 inclusive.","description":"If successful: a number between 0.0-1.0 inclusive."},{"type":"string?","value":"string? If last return was a false boolean (errored), this will be the error message.","description":"If last return was a false boolean (errored), this will be the error message."}],"realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"}],"class":"function","name":"getBatteryLevel","description":" Attempts to check the battery level of the controller."},"getState":{"path":"libs_cl/xinput.lua#L87","returns":[{"type":"table","value":"table Table containing all input data of the controller, or false if the controller is not connected. The table uses this struct: https://github.com/mitterdoo/garrysmod-xinput#xinput_gamepad","description":"Table containing all input data of the controller, or false if the controller is not connected. The table uses this struct: https://github.com/mitterdoo/garrysmod-xinput#xinput_gamepad"}],"realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"}],"class":"function","name":"getState","description":" Gets the state of the controller."},"getButton":{"path":"libs_cl/xinput.lua#L94","returns":[{"type":"boolean","value":"boolean","description":""}],"realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number button The button to check for. See https://github.com/mitterdoo/garrysmod-xinput#xinput_gamepad_","name":"button","description":"The button to check for. See https://github.com/mitterdoo/garrysmod-xinput#xinput_gamepad_"}],"class":"function","name":"getButton","description":" Gets whether the button on the controller is currently pushed down."},"getControllers":{"path":"libs_cl/xinput.lua#L127","returns":[{"type":"table","value":"table A table where each key is the ID of the controller that is connected. Disconnected controllers are not placed in the table.","description":"A table where each key is the ID of the controller that is connected. Disconnected controllers are not placed in the table."}],"realm":"client","class":"function","name":"getControllers","description":" Gets all of the connected controllers."}},"tables":[],"path":"libs_cl/xinput.lua#L60","libtbl":["xinput_library"],"realm":"client","fields":[],"class":"library","name":"xinput","description":" A simpler, hook-based, and more-powerful controller input library. Inputs are not lost between rendered frames, and there is support for rumble. Note: the client must have the XInput lua binary module installed in order to access this library. See more at https://github.com/mitterdoo/garrysmod-xinput"},"bit":{"methods":{"rol":{"path":"libs_sh/bit.lua#L613","returns":[{"type":"number","value":"number Left rotated value","description":"Left rotated value"}],"realm":"shared","params":[{"type":"number","value":"number value The value to be manipulated.","name":"value","description":"The value to be manipulated."},{"type":"number","value":"number shiftCount Amounts of bits to rotate left by.","name":"shiftCount","description":"Amounts of bits to rotate left by."}],"class":"function","name":"rol","description":" Returns the left rotated value."},"arshift":{"path":"libs_sh/bit.lua#L566","returns":[{"type":"number","value":"number shiftedValue","description":"shiftedValue"}],"realm":"shared","params":[{"type":"number","value":"number value The value to be manipulated.","name":"value","description":"The value to be manipulated."},{"type":"number","value":"number shiftCount Amount of bits to shift","name":"shiftCount","description":"Amount of bits to shift"}],"class":"function","name":"arshift","description":" Returns the arithmetically shifted value."},"compress":{"path":"libs_sh/bit.lua#L682","returns":[{"type":"string?","value":"string? Compressed string, or nil if compression failed","description":"Compressed string, or nil if compression failed"}],"realm":"shared","params":[{"type":"string","value":"string s String to compress","name":"s","description":"String to compress"}],"class":"function","name":"compress","description":" Compresses a string using LZMA."},"bnot":{"path":"libs_sh/bit.lua#L580","returns":[{"type":"number","value":"number Return value of bitwise not operation","description":"Return value of bitwise not operation"}],"realm":"shared","params":[{"type":"number","value":"number value The value to be inverted.","name":"value","description":"The value to be inverted."}],"class":"function","name":"bnot","description":" Returns the bitwise not of the value."},"lshift":{"path":"libs_sh/bit.lua#L606","returns":[{"type":"number","value":"number Return of bitwise lshift operation","description":"Return of bitwise lshift operation"}],"realm":"shared","params":[{"type":"number","value":"number value The value to be manipulated.","name":"value","description":"The value to be manipulated."},{"type":"number","value":"number shiftCount Amounts of bits to shift left by.","name":"shiftCount","description":"Amounts of bits to shift left by."}],"class":"function","name":"lshift","description":" Returns the left shifted value."},"stringstream":{"path":"libs_sh/bit.lua#L648","returns":[{"type":"StringStream","value":"StringStream StringStream object","description":"StringStream object"}],"realm":"shared","params":[{"type":"string?","value":"string? stream String to set the initial buffer to (default \"\")","name":"stream","description":"String to set the initial buffer to (default \"\")"},{"type":"number?","value":"number? i The initial buffer pointer (default 1)","name":"i","description":"The initial buffer pointer (default 1)"},{"type":"string?","value":"string? endian The endianness of number types. \"big\" or \"little\" (default \"little\")","name":"endian","description":"The endianness of number types. \"big\" or \"little\" (default \"little\")"}],"class":"function","name":"stringstream","description":" Creates a StringStream object"},"sha256":{"path":"libs_sh/bit.lua#L729","returns":[{"type":"string","value":"string The SHA-256 hex string of the checksum.","description":"The SHA-256 hex string of the checksum."}],"realm":"shared","params":[{"type":"string","value":"string s The string to calculate the checksum of.","name":"s","description":"The string to calculate the checksum of."}],"class":"function","name":"sha256","description":" Generates the SHA-256 Checksum of the specified string."},"stringToTable":{"path":"libs_sh/bit.lua#L674","returns":[{"type":"table","value":"table The deserialized table","description":"The deserialized table"}],"realm":"shared","params":[{"type":"string","value":"string s The serialized string data","name":"s","description":"The serialized string data"}],"class":"function","name":"stringToTable","description":" Converts serialized string data to table"},"sha1":{"path":"libs_sh/bit.lua#L740","returns":[{"type":"string","value":"string The SHA-1 hex string of the checksum.","description":"The SHA-1 hex string of the checksum."}],"realm":"shared","params":[{"type":"string","value":"string s The string to calculate the checksum of.","name":"s","description":"The string to calculate the checksum of."}],"class":"function","name":"sha1","description":" Generates the SHA-1 Checksum of the specified string."},"bor":{"path":"libs_sh/bit.lua#L586","returns":[{"type":"number","value":"number The bitwise OR result between all numbers.","description":"The bitwise OR result between all numbers."}],"realm":"shared","params":[{"type":"number","value":"number value1 The first value.","name":"value1","description":"The first value."},{"type":"...number","value":"...number Extra values to be evaluated. (must all be numbers)","name":"Extra","description":"values to be evaluated. (must all be numbers)"}],"class":"function","name":"bor","description":" Returns the bitwise OR of all values specified."},"md5":{"path":"libs_sh/bit.lua#L718","returns":[{"type":"string","value":"string The MD5 hex string of the checksum.","description":"The MD5 hex string of the checksum."}],"realm":"shared","params":[{"type":"string","value":"string s The string to calculate the checksum of.","name":"s","description":"The string to calculate the checksum of."}],"class":"function","name":"md5","description":" Generates the MD5 Checksum of the specified string."},"bswap":{"path":"libs_sh/bit.lua#L593","returns":[{"type":"number","value":"number Bit swapped value","description":"Bit swapped value"}],"realm":"shared","params":[{"type":"number","value":"number value The value to be byte swapped.","name":"value","description":"The value to be byte swapped."}],"class":"function","name":"bswap","description":" Swaps the byte order."},"tableToString":{"path":"libs_sh/bit.lua#L666","returns":[{"type":"string","value":"string Serialized data","description":"Serialized data"}],"realm":"shared","params":[{"type":"table","value":"table t The table to serialize","name":"t","description":"The table to serialize"}],"class":"function","name":"tableToString","description":" Converts a table to string serializing data types as best as it can"},"ror":{"path":"libs_sh/bit.lua#L620","returns":[{"type":"number","value":"number Right rotated value","description":"Right rotated value"}],"realm":"shared","params":[{"type":"number","value":"number value The value to be manipulated.","name":"value","description":"The value to be manipulated."},{"type":"number","value":"number shiftCount Amounts of bits to rotate right by.","name":"shiftCount","description":"Amounts of bits to rotate right by."}],"class":"function","name":"ror","description":" Returns the right rotated value."},"rshift":{"path":"libs_sh/bit.lua#L627","returns":[{"type":"number","value":"number Right shifted value","description":"Right shifted value"}],"realm":"shared","params":[{"type":"number","value":"number value The value to be manipulated.","name":"value","description":"The value to be manipulated."},{"type":"number","value":"number shiftCount Amounts of bits to shift right by.","name":"shiftCount","description":"Amounts of bits to shift right by."}],"class":"function","name":"rshift","description":" Returns the right shifted value."},"bxor":{"path":"libs_sh/bit.lua#L599","returns":[{"type":"number","value":"number Return value of bitwiseXOr operation","description":"Return value of bitwiseXOr operation"}],"realm":"shared","params":[{"type":"number","value":"number value The value to be manipulated.","name":"value","description":"The value to be manipulated."},{"type":"...number","value":"...number otherValues Values to bit xor with. Optional.","name":"otherValues","description":"Values to bit xor with. Optional."}],"class":"function","name":"bxor","description":" Returns the bitwise xor of all values specified."},"tobit":{"path":"libs_sh/bit.lua#L634","returns":[{"type":"number","value":"number Bit swapped value","description":"Bit swapped value"}],"realm":"shared","params":[{"type":"number","value":"number value The value to be normalized.","name":"value","description":"The value to be normalized."}],"class":"function","name":"tobit","description":" Normalizes the specified value and clamps it in the range of a signed 32bit integer."},"tohex":{"path":"libs_sh/bit.lua#L640","returns":[{"type":"string","value":"string Hex string.","description":"Hex string."}],"realm":"shared","params":[{"type":"number","value":"number value The value to be normalized.","name":"value","description":"The value to be normalized."},{"type":"number?","value":"number? digits The number of digits. Optional. (default 8)","name":"digits","description":"The number of digits. Optional. (default 8)"}],"class":"function","name":"tohex","description":" Returns the hexadecimal representation of the number with the specified digits."},"decompress":{"path":"libs_sh/bit.lua#L693","returns":[{"type":"string?","value":"string? Decompressed string, or nil if decompression failed","description":"Decompressed string, or nil if decompression failed"}],"realm":"shared","params":[{"type":"string","value":"string s String to decompress","name":"s","description":"String to decompress"},{"type":"number?","value":"number? maxSize Maximum allowed size of decompressed data","name":"maxSize","description":"Maximum allowed size of decompressed data"}],"class":"function","name":"decompress","description":" Decompresses a string using LZMA.\n XZ Utils will always produce streamed (i.e. the decompressed size is not specified in the header) LZMA data. If you're trying to compress data from outside of GMod and then decompress it inside of GMod, it probably won't work unless you use the older, deprecated 'LZMA Utils', or util.Compress."},"band":{"path":"libs_sh/bit.lua#L573","returns":[{"type":"number","value":"number Result of bitwise \"and\" operation.","description":"Result of bitwise \"and\" operation."}],"realm":"shared","params":[{"type":"number","value":"number value The value to be manipulated.","name":"value","description":"The value to be manipulated."},{"type":"...number","value":"...number otherValues Values bit to perform bitwise \"and\" with. Optional.","name":"otherValues","description":"Values bit to perform bitwise \"and\" with. Optional."}],"class":"function","name":"band","description":" Performs the bitwise \"and\" for all values specified."}},"tables":[],"path":"libs_sh/bit.lua#L556","libtbl":["bit_library"],"realm":"shared","fields":[],"class":"library","name":"bit","description":" Bit library http://wiki.facepunch.com/gmod/Category:bit"},"trace":{"methods":{"isBoxIntersectingSphere":{"path":"libs_sh/trace.lua#L139","returns":[{"type":"boolean","value":"boolean true if there is an intersection, false otherwise.","description":"true if there is an intersection, false otherwise."}],"realm":"shared","params":[{"type":"Vector","value":"Vector boxMins The minimum extents of the World Axis-Aligned box.","name":"boxMins","description":"The minimum extents of the World Axis-Aligned box."},{"type":"Vector","value":"Vector boxMaxs The maximum extents of the World Axis-Aligned box.","name":"boxMaxs","description":"The maximum extents of the World Axis-Aligned box."},{"type":"Vector","value":"Vector spherePos Position of the sphere.","name":"spherePos","description":"Position of the sphere."},{"type":"number","value":"number sphereRadius The radius of the sphere.","name":"sphereRadius","description":"The radius of the sphere."}],"class":"function","name":"isBoxIntersectingSphere","description":" Performs a box-sphere intersection and returns whether there was an intersection or not."},"canCreateDecal":{"path":"libs_sh/trace.lua#L188","returns":[{"type":"boolean","value":"boolean Whether the decal trace can be used","description":"Whether the decal trace can be used"}],"realm":"shared","class":"function","name":"canCreateDecal","description":" Returns True if player is allowed to use trace.decal"},"intersectRayWithOBB":{"path":"libs_sh/trace.lua#L117","returns":[{"type":"Vector?","value":"Vector? Hit position or nil if not hit","description":"Hit position or nil if not hit"},{"type":"Vector?","value":"Vector? Hit normal or nil if not hit","description":"Hit normal or nil if not hit"},{"type":"number?","value":"number? Hit fraction or nil if not hit","description":"Hit fraction or nil if not hit"}],"realm":"shared","params":[{"type":"Vector","value":"Vector rayStart The origin of the ray","name":"rayStart","description":"The origin of the ray"},{"type":"Vector","value":"Vector rayDelta The direction and length of the ray","name":"rayDelta","description":"The direction and length of the ray"},{"type":"Vector","value":"Vector boxOrigin The origin of the box","name":"boxOrigin","description":"The origin of the box"},{"type":"Angle","value":"Angle boxAngles The box's angles","name":"boxAngles","description":"The box's angles"},{"type":"Vector","value":"Vector boxMins The box min bounding vector","name":"boxMins","description":"The box min bounding vector"},{"type":"Vector","value":"Vector boxMaxs The box max bounding vector","name":"boxMaxs","description":"The box max bounding vector"}],"class":"function","name":"intersectRayWithOBB","description":" Does a ray box intersection returning the position hit, normal, and trace fraction, or nil if not hit."},"hull":{"path":"libs_sh/trace.lua#L89","returns":[{"type":"table","value":"table Result of the trace https://wiki.facepunch.com/gmod/Structures/TraceResult","description":"Result of the trace https://wiki.facepunch.com/gmod/Structures/TraceResult"}],"realm":"shared","params":[{"type":"Vector","value":"Vector start Start position","name":"start","description":"Start position"},{"type":"Vector","value":"Vector endpos End position","name":"endpos","description":"End position"},{"type":"Vector","value":"Vector minbox Lower box corner","name":"minbox","description":"Lower box corner"},{"type":"Vector","value":"Vector maxbox Upper box corner","name":"maxbox","description":"Upper box corner"},{"type":"Entity|table|function|nil","value":"Entity|table|function|nil filter Entity/array of entities to filter, or a function callback with an entity argument that returns whether the trace should hit","name":"filter","description":"Entity/array of entities to filter, or a function callback with an entity argument that returns whether the trace should hit"},{"type":"number?","value":"number? mask Trace mask","name":"mask","description":"Trace mask"},{"type":"number?","value":"number? colgroup The collision group of the trace","name":"colgroup","description":"The collision group of the trace"},{"type":"boolean?","value":"boolean? ignworld Whether the trace should ignore world","name":"ignworld","description":"Whether the trace should ignore world"}],"class":"function","name":"hull","description":" Does a swept-AABB trace"},"decal":{"path":"libs_sh/trace.lua#L168","realm":"shared","params":[{"type":"string","value":"string name The decal name, see https://wiki.facepunch.com/gmod/util.Decal","name":"name","description":"The decal name, see https://wiki.facepunch.com/gmod/util.Decal"},{"type":"Vector","value":"Vector start Start position","name":"start","description":"Start position"},{"type":"Vector","value":"Vector endpos End position","name":"endpos","description":"End position"},{"type":"Entity|table|nil","value":"Entity|table|nil filter (Optional) Entity/array of entities to filter","name":"filter","description":"(Optional) Entity/array of entities to filter"}],"class":"function","name":"decal","description":" Does a line trace and applies a decal to wherever is hit"},"line":{"path":"libs_sh/trace.lua#L67","returns":[{"type":"table","value":"table Result of the trace https://wiki.facepunch.com/gmod/Structures/TraceResult","description":"Result of the trace https://wiki.facepunch.com/gmod/Structures/TraceResult"}],"realm":"shared","params":[{"type":"Vector","value":"Vector start Start position","name":"start","description":"Start position"},{"type":"Vector","value":"Vector endpos End position","name":"endpos","description":"End position"},{"type":"Entity|table|function|nil","value":"Entity|table|function|nil filter Entity/array of entities to filter, or a function callback with an entity argument that returns whether the trace should hit","name":"filter","description":"Entity/array of entities to filter, or a function callback with an entity argument that returns whether the trace should hit"},{"type":"number?","value":"number? mask Trace mask","name":"mask","description":"Trace mask"},{"type":"number?","value":"number? colgroup The collision group of the trace","name":"colgroup","description":"The collision group of the trace"},{"type":"boolean?","value":"boolean? ignworld Whether the trace should ignore world","name":"ignworld","description":"Whether the trace should ignore world"}],"class":"function","name":"line","description":" Does a line trace"},"decalsLeft":{"path":"libs_sh/trace.lua#L194","returns":[{"type":"number","value":"number The number of decals left","description":"The number of decals left"}],"realm":"shared","class":"function","name":"decalsLeft","description":" Returns the number of decals player is allowed to use"},"aimVector":{"path":"libs_sh/trace.lua#L208","returns":[{"type":"Vector","value":"Vector The aim vector","description":"The aim vector"}],"realm":"shared","params":[{"type":"Angle","value":"Angle viewAngles View angles","name":"viewAngles","description":"View angles"},{"type":"number","value":"number viewFOV View field of view","name":"viewFOV","description":"View field of view"},{"type":"number","value":"number x X position on the screen","name":"x","description":"X position on the screen"},{"type":"number","value":"number y Y position on the screen","name":"y","description":"Y position on the screen"},{"type":"number","value":"number screenWidth Screen width","name":"screenWidth","description":"Screen width"},{"type":"number","value":"number screenHeight Screen height","name":"screenHeight","description":"Screen height"}],"class":"function","name":"aimVector","description":" Calculates the aim vector from a 2D screen position. This is essentially a generic version of input.screenToVector, where you can define the view angles and screen size manually."},"pointContents":{"path":"libs_sh/trace.lua#L200","returns":[{"type":"number","value":"number Contents bitflag, see the CONTENTS enums","description":"Contents bitflag, see the CONTENTS enums"}],"realm":"shared","params":[{"type":"Vector","value":"Vector position The position to get the CONTENTS of","name":"position","description":"The position to get the CONTENTS of"}],"class":"function","name":"pointContents","description":" Returns the contents of the position specified."},"intersectRayWithPlane":{"path":"libs_sh/trace.lua#L152","returns":[{"type":"Vector?","value":"Vector? Hit position or nil if not hit","description":"Hit position or nil if not hit"}],"realm":"shared","params":[{"type":"Vector","value":"Vector rayStart The origin of the ray","name":"rayStart","description":"The origin of the ray"},{"type":"Vector","value":"Vector rayDelta The direction and length of the ray","name":"rayDelta","description":"The direction and length of the ray"},{"type":"Vector","value":"Vector planeOrigin The origin of the plane","name":"planeOrigin","description":"The origin of the plane"},{"type":"Vector","value":"Vector planeNormal The normal of the plane","name":"planeNormal","description":"The normal of the plane"}],"class":"function","name":"intersectRayWithPlane","description":" Does a ray plane intersection returning the position hit or nil if not hit"}},"tables":[],"path":"libs_sh/trace.lua#L19","libtbl":["trace_library"],"realm":"shared","fields":[],"class":"library","name":"trace","description":" Provides functions for doing line/AABB traces"},"prop":{"methods":{"spawnRate":{"path":"libs_sv/prop.lua#L693","returns":[{"type":"number","value":"number Number of props per second the user can spawn","description":"Number of props per second the user can spawn"}],"realm":"server","class":"function","name":"spawnRate","description":" Returns how many props per second the user can spawn"},"setPropUndo":{"path":"libs_sv/prop.lua#L706","realm":"server","params":[{"type":"boolean","value":"boolean on Whether the props should be undo-able","name":"on","description":"Whether the props should be undo-able"}],"class":"function","name":"setPropUndo","description":" Sets whether the props should be undo-able"},"createSent":{"path":"libs_sv/prop.lua#L405","returns":[{"type":"Entity","value":"Entity The sent object","description":"The sent object"}],"realm":"server","params":[{"type":"Vector","value":"Vector pos Position of created sent","name":"pos","description":"Position of created sent"},{"type":"Angle","value":"Angle ang Angle of created sent","name":"ang","description":"Angle of created sent"},{"type":"string","value":"string class Class of created sent","name":"class","description":"Class of created sent"},{"type":"boolean?","value":"boolean? frozen True to spawn the entity in a frozen state. Default = False","name":"frozen","description":"True to spawn the entity in a frozen state. Default = False"},{"type":"table?","value":"table? data Optional table, additional entity data to be supplied to certain SENTs. See prop.SENT_Data_Structures table in Docs for list of SENTs","name":"data","description":"Optional table, additional entity data to be supplied to certain SENTs. See prop.SENT_Data_Structures table in Docs for list of SENTs"}],"class":"function","name":"createSent","description":" Creates a sent."},"create":{"path":"libs_sv/prop.lua#L46","returns":[{"type":"Entity","value":"Entity The prop object","description":"The prop object"}],"realm":"server","params":[{"type":"Vector","value":"Vector pos Initial entity position","name":"pos","description":"Initial entity position"},{"type":"Angle","value":"Angle ang Initial entity angles","name":"ang","description":"Initial entity angles"},{"type":"string","value":"string model Model path","name":"model","description":"Model path"},{"type":"boolean?","value":"boolean? frozen True to spawn the entity in a frozen state. Default = False","name":"frozen","description":"True to spawn the entity in a frozen state. Default = False"}],"class":"function","name":"create","description":" Creates a prop"},"createComponent":{"path":"libs_sv/prop.lua#L249","returns":[{"type":"Entity","value":"Entity Component entity","description":"Component entity"}],"realm":"server","params":[{"type":"Vector","value":"Vector pos Position of created component","name":"pos","description":"Position of created component"},{"type":"Angle","value":"Angle ang Angle of created component","name":"ang","description":"Angle of created component"},{"type":"string","value":"string class Class of created component","name":"class","description":"Class of created component"},{"type":"string","value":"string model Model of created component","name":"model","description":"Model of created component"},{"type":"boolean?","value":"boolean? frozen True to spawn the entity in a frozen state. Default = False","name":"frozen","description":"True to spawn the entity in a frozen state. Default = False"}],"class":"function","name":"createComponent","description":" Creates starfall component\n Allowed components:\n starfall_hud\n starfall_screen"},"createSeat":{"path":"libs_sv/prop.lua#L347","returns":[{"type":"Entity","value":"Entity The seat object","description":"The seat object"}],"realm":"server","params":[{"type":"Vector","value":"Vector pos Position of created seat","name":"pos","description":"Position of created seat"},{"type":"Angle","value":"Angle ang Angle of created seat","name":"ang","description":"Angle of created seat"},{"type":"string","value":"string model Model of created seat","name":"model","description":"Model of created seat"},{"type":"boolean?","value":"boolean? frozen True to spawn the entity in a frozen state. Default = False","name":"frozen","description":"True to spawn the entity in a frozen state. Default = False"}],"class":"function","name":"createSeat","description":" Creates a seat."},"propsLeft":{"path":"libs_sv/prop.lua#L685","returns":[{"type":"number","value":"number Number of props able to be spawned","description":"Number of props able to be spawned"}],"realm":"server","class":"function","name":"propsLeft","description":" Checks how many props can be spawned"},"createCustom":{"path":"libs_sv/prop.lua#L150","returns":[{"type":"Entity","value":"Entity The prop object","description":"The prop object"}],"realm":"server","params":[{"type":"Vector","value":"Vector pos The position to spawn the prop","name":"pos","description":"The position to spawn the prop"},{"type":"Angle","value":"Angle ang The angles to spawn the prop","name":"ang","description":"The angles to spawn the prop"},{"type":"table","value":"table vertices The table of tables of vertices that make up the physics mesh {{v1,v2,...},{v1,v2,...},...}","name":"vertices","description":"The table of tables of vertices that make up the physics mesh {{v1,v2,...},{v1,v2,...},...}"},{"type":"boolean?","value":"boolean? frozen True to spawn the entity in a frozen state. Default = False","name":"frozen","description":"True to spawn the entity in a frozen state. Default = False"}],"class":"function","name":"createCustom","description":" Creates a custom prop."},"setPropClean":{"path":"libs_sv/prop.lua#L700","realm":"server","params":[{"type":"boolean","value":"boolean on Whether the props should be cleaned or not","name":"on","description":"Whether the props should be cleaned or not"}],"class":"function","name":"setPropClean","description":" Sets whether the chip should remove created props when the chip is removed"},"canSpawn":{"path":"libs_sv/prop.lua#L677","returns":[{"type":"boolean","value":"boolean True if user can spawn props, False if not.","description":"True if user can spawn props, False if not."}],"realm":"server","class":"function","name":"canSpawn","description":" Checks if a user can spawn anymore props."},"getSpawnableSents":{"path":"libs_sv/prop.lua#L316","returns":[{"type":"table","value":"table The table","description":"The table"}],"realm":"server","params":[{"type":"boolean?","value":"boolean? categorized True to get an categorized list","name":"categorized","description":"True to get an categorized list"}],"class":"function","name":"getSpawnableSents","description":" Get a list of all spawnable sents."},"createRagdoll":{"path":"libs_sv/prop.lua#L101","returns":[{"type":"Entity","value":"Entity The ragdoll entity","description":"The ragdoll entity"}],"realm":"server","params":[{"type":"string","value":"string model Model path","name":"model","description":"Model path"},{"type":"boolean?","value":"boolean? frozen True to spawn the entity in a frozen state. Default = False","name":"frozen","description":"True to spawn the entity in a frozen state. Default = False"}],"class":"function","name":"createRagdoll","description":" Creates a ragdoll"}},"tables":{"SENT_Data_Structures":{"path":"libs_sv/prop_sent.lua#L1081","realm":"server","class":"table","name":"SENT_Data_Structures","description":" \n > gmod_balloon\n number b = 255\n number force\n number g = 255\n string Model = \"models/maxofs2d/balloon_classic.mdl\"\n number r = 255\n \n > gmod_button\n string description = \"\"\n number key\n string Model = \"models/maxofs2d/button_05.mdl\"\n boolean toggle = true\n \n > gmod_cameraprop\n number controlkey\n boolean locked = false\n string Model = \"models/dav0r/camera.mdl\"\n boolean toggle = true\n \n > gmod_dynamite\n number Damage = 200\n number delay = 0\n number key\n string Model = \"models/dav0r/tnt/tnt.mdl\"\n boolean remove = false\n \n > gmod_emitter\n number delay = 0\n string effect\n number key\n string Model = \"models/props_lab/tpplug.mdl\"\n number scale = 1\n boolean starton = false\n boolean toggle = true\n \n > gmod_hoverball\n number key_d = -1\n number key_u = -1\n string Model = \"models/dav0r/hoverball.mdl\"\n number resistance = 0\n number speed = 1\n number strength = 1\n \n > gmod_lamp\n number b = 255\n number brightness = 4\n number distance = 1024\n number fov = 90\n number g = 255\n number KeyDown = -1\n string Model = \"models/lamps/torch.mdl\"\n boolean on = false\n number r = 255\n string Texture = \"effects/flashlight001\"\n boolean toggle = true\n \n > gmod_light\n number Brightness = 2\n number KeyDown = -1\n number lightb = 255\n number lightg = 255\n number lightr = 255\n string Model = \"models/maxofs2d/light_tubular.mdl\"\n boolean on = false\n number Size = 256\n boolean toggle = true\n \n > gmod_thruster\n boolean damageable = false\n string effect = \"fire\"\n number force = 1500\n number key = -1\n number key_bck = -1\n string Model = \"models/props_phx2/garbage_metalcan001a.mdl\"\n string soundname = \"PhysicsCannister.ThrusterLoop\"\n boolean toggle = false\n \n > gmod_wire_addressbus\n number Mem1st = 0\n number Mem1sz = 0\n number Mem2st = 0\n number Mem2sz = 0\n number Mem3st = 0\n number Mem3sz = 0\n number Mem4st = 0\n number Mem4sz = 0\n string Model = \"models/jaanus/wiretool/wiretool_gate.mdl\"\n \n > gmod_wire_adv_emarker\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_adv_input\n number keyless = 1\n number keymore = 3\n string Model = \"models/beer/wiremod/numpad.mdl\"\n number speed = 1\n boolean toggle = false\n number value_max = 10\n number value_min = 0\n number value_start = 5\n \n > gmod_wire_button\n string description = \"\"\n boolean entityout = false\n string Model = \"models/props_c17/clock01.mdl\"\n boolean toggle = false\n number value_off = 0\n number value_on = 1\n \n > gmod_wire_cameracontroller\n boolean AllowZoom = false\n boolean AutoMove = false\n boolean AutoUnclip = false\n boolean AutoUnclip_IgnoreWater = false\n boolean DrawParent = true\n boolean DrawPlayer = true\n boolean FreeMove = false\n boolean LocalMove = false\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n boolean ParentLocal = false\n \n > gmod_wire_cd_disk\n number IRadius = 10\n string Model = \"models/venompapa/wirecd_medium.mdl\"\n number Precision = 4\n number Skin = 0\n \n > gmod_wire_cd_ray\n boolean DefaultZero = false\n string Model = \"models/jaanus/wiretool/wiretool_beamcaster.mdl\"\n number Range = 64\n \n > gmod_wire_clutch\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_colorer\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n boolean outColor = false\n number Range = 2000\n \n > gmod_wire_consolescreen\n string Model = \"models/props_lab/monitor01b.mdl\"\n \n > gmod_wire_damage_detector\n boolean includeconstrained = false\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_data_satellitedish\n string Model = \"models/props_wasteland/prison_lamp001c.mdl\"\n \n > gmod_wire_data_store\n string Model = \"models/jaanus/wiretool/wiretool_range.mdl\"\n \n > gmod_wire_data_transferer\n boolean DefaultZero = false\n boolean IgnoreZero = false\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n number Range = 25000\n \n > gmod_wire_dataport\n string Model = \"models/jaanus/wiretool/wiretool_gate.mdl\"\n \n > gmod_wire_datarate\n string Model = \"models/jaanus/wiretool/wiretool_gate.mdl\"\n \n > gmod_wire_datasocket\n number AttachRange = 5\n string Model = \"models/hammy/pci_slot.mdl\"\n number WeldForce = 5000\n \n > gmod_wire_detonator\n number damage = 1\n string Model = \"models/props_combine/breenclock.mdl\"\n \n > gmod_wire_dhdd\n string Model\n \n > gmod_wire_digitalscreen\n string Model = \"models/props_lab/monitor01b.mdl\"\n number ScreenHeight = 32\n number ScreenWidth = 32\n \n > gmod_wire_dual_input\n number keygroup = 7\n number keygroup2 = 4\n string Model = \"models/beer/wiremod/numpad.mdl\"\n boolean toggle = false\n number value_off = 0\n number value_on = 1\n number value_on2 = -1\n \n > gmod_wire_dynamic_button\n string description = \"\"\n boolean entityout = false\n string material_off = \"bull/dynamic_button_0\"\n string material_on = \"bull/dynamic_button_1\"\n string Model = \"models/bull/ranger.mdl\"\n number off_b = 255\n number off_g = 255\n number off_r = 255\n number on_b = 255\n number on_g = 255\n number on_r = 255\n boolean toggle = false\n number value_off = 0\n number value_on = 1\n \n > gmod_wire_egp\n string Model = \"models/kobilica/wiremonitorbig.mdl\"\n \n > gmod_wire_egp_emitter\n string Model = \"models/bull/dynamicbutton.mdl\"\n \n > gmod_wire_egp_hud\n string Model = \"models/bull/dynamicbutton.mdl\"\n \n > gmod_wire_emarker\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_exit_point\n string Model = \"models/jaanus/wiretool/wiretool_range.mdl\"\n \n > gmod_wire_explosive\n boolean affectother = false\n boolean bulletproof = false\n boolean coloreffect = true\n number damage = 200\n number delayreloadtime = 0\n number delaytime = 0\n boolean explodeatzero = true\n boolean explosionproof = false\n boolean fallproof = false\n boolean fireeffect = true\n boolean invisibleatzero = false\n number key = 1\n number maxhealth = 100\n string Model = \"models/props_c17/oildrum001_explosive.mdl\"\n boolean notaffected = false\n number radius = 300\n boolean removeafter = false\n boolean resetatexplode = true\n \n > gmod_wire_expression2\n string _name = \"Generic\"\n string _original = \"print(\"Hello World!\")\"\n table inc_files = {}\n string Model = \"models/beer/wiremod/gate_e2.mdl\"\n\n > starfall_processor\n string Model = \"models/spacecode/sfchip_medium.mdl\"\n string Code\n \n > gmod_wire_extbus\n string Model = \"models/jaanus/wiretool/wiretool_gate.mdl\"\n \n > gmod_wire_eyepod\n number ClampX = 0\n number ClampXMax = 0\n number ClampXMin = 0\n number ClampY = 0\n number ClampYMax = 0\n number ClampYMin = 0\n number DefaultToZero = 1\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n number ShowRateOfChange = 1\n \n > gmod_wire_forcer\n number Force = 1\n number Length = 100\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n boolean Reaction = false\n boolean ShowBeam = true\n \n > gmod_wire_freezer\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_friendslist\n string Model = \"models/kobilica/value.mdl\"\n boolean save_on_entity = false\n table steamids = {}\n \n > gmod_wire_fx_emitter\n number delay = 0.07\n string effect = \"sparks\"\n string Model = \"models/props_lab/tpplug.mdl\"\n \n > gmod_wire_gate\n string action = \"+\"\n string Model = \"models/jaanus/wiretool/wiretool_gate.mdl\"\n \n > gmod_wire_gimbal\n string Model = \"models/props_c17/canister01a.mdl\"\n \n > gmod_wire_gps\n string Model = \"models/beer/wiremod/gps.mdl\"\n \n > gmod_wire_gpulib_controller\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_grabber\n boolean Gravity = true\n string Model = \"models/jaanus/wiretool/wiretool_range.mdl\"\n number Range = 100\n \n > gmod_wire_graphics_tablet\n boolean draw_background = true\n boolean gmode = false\n string Model = \"models/kobilica/wiremonitorbig.mdl\"\n \n > gmod_wire_gyroscope\n string Model = \"models/bull/various/gyroscope.mdl\"\n boolean out180 = false\n \n > gmod_wire_hdd\n number DriveCap = 128\n number DriveID = 0\n string Model = \"models/jaanus/wiretool/wiretool_gate.mdl\"\n \n > gmod_wire_holoemitter\n string Model = \"models/jaanus/wiretool/wiretool_range.mdl\"\n \n > gmod_wire_hologrid\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n boolean usegps = false\n \n > gmod_wire_hoverball\n string Model = \"models/dav0r/hoverball.mdl\"\n number resistance = 0\n number speed = 1\n boolean starton = true\n number strength = 1\n \n > gmod_wire_hudindicator\n number a = 0\n number aa = 255\n number ab = 0\n number ag = 0\n boolean allowhook = true\n number ar = 255\n number b = 1\n number ba = 255\n number bb = 0\n number bg = 255\n number br = 0\n number fullcircleangle = 0\n boolean hudaddname = false\n string huddesc = \"\"\n number hudshowvalue = 0\n number hudstyle = 0\n string material = \"models/debug/debugwhite\"\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n boolean showinhud = false\n \n > gmod_wire_hydraulic\n number Bone1 = 0\n number Bone2 = 0\n Entity Ent1\n Entity Ent2\n number fixed = 0\n Vector LPos1 = Vector(0, 0, 0)\n Vector LPos2 = Vector(0, 0, 0)\n string material = \"cable/rope\"\n string Model = \"models/beer/wiremod/hydraulic.mdl\"\n number speed = 16\n boolean stretchonly = false\n number width = 3\n \n > gmod_wire_igniter\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n number Range = 2048\n boolean TargetPlayers = false\n \n > gmod_wire_indicator\n number a = 0\n number aa = 255\n number ab = 0\n number ag = 0\n number ar = 255\n number b = 1\n number ba = 255\n number bb = 0\n number bg = 255\n number br = 0\n string Model = \"models/segment.mdl\"\n \n > gmod_wire_input\n number keygroup = 7\n string Model = \"models/beer/wiremod/numpad.mdl\"\n boolean toggle = false\n number value_off = 0\n number value_on = 1\n \n > gmod_wire_keyboard\n boolean AutoBuffer = true\n boolean EnterKeyAscii = true\n string Model = \"models/jaanus/wiretool/wiretool_input.mdl\"\n boolean Synchronous = true\n \n > gmod_wire_keypad\n string Model = \"models/props_lab/keypad.mdl\"\n string Password\n boolean Secure\n \n > gmod_wire_lamp\n number b = 255\n number Brightness = 8\n number Dist = 1024\n number FOV = 90\n number g = 255\n string Model = \"models/lamps/torch.mdl\"\n boolean on = false\n number r = 255\n string Texture = \"effects/flashlight001\"\n \n > gmod_wire_las_receiver\n string Model = \"models/jaanus/wiretool/wiretool_range.mdl\"\n \n > gmod_wire_latch\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_lever\n number Max = 1\n number Min = 0\n \n > gmod_wire_light\n number B = 255\n number brightness = 2\n boolean directional = false\n number G = 255\n boolean glow = false\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n number R = 255\n boolean radiant = false\n number size = 256\n \n > gmod_wire_locator\n string Model = \"models/props_lab/powerbox02d.mdl\"\n \n > gmod_wire_motor\n number Bone1 = 0\n number Bone2 = 0\n Entity Ent1\n Entity Ent2\n number forcelimit = 0\n number friction = 1\n Vector LPos1 = Vector(0, 0, 0)\n Vector LPos2 = Vector(0, 0, 0)\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n number torque = 500\n \n > gmod_wire_nailer\n number Flim = 0\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n number Range = 100\n boolean ShowBeam = true\n \n > gmod_wire_numpad\n string Model = \"models/beer/wiremod/numpad.mdl\"\n boolean toggle = false\n number value_off = 0\n number value_on = 0\n \n > gmod_wire_oscilloscope\n string Model = \"models/props_lab/monitor01b.mdl\"\n \n > gmod_wire_output\n number key = 1\n string Model = \"models/beer/wiremod/numpad.mdl\"\n \n > gmod_wire_pixel\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_pod\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_radio\n string Channel = \"1\"\n string Model = \"models/props_lab/binderblue.mdl\"\n boolean Secure = false\n number values = 4\n \n > gmod_wire_ranger\n boolean default_zero = true\n boolean hires = false\n boolean ignore_world = false\n string Model = \"models/jaanus/wiretool/wiretool_range.mdl\"\n boolean out_ang = false\n boolean out_col = false\n boolean out_dist = true\n boolean out_eid = false\n boolean out_hnrm = false\n boolean out_pos = false\n boolean out_sid = false\n boolean out_uid = false\n boolean out_val = false\n boolean out_vel = false\n number range = 1500\n boolean show_beam = true\n boolean trace_water = false\n \n > gmod_wire_relay\n number keygroup1 = 1\n number keygroup2 = 2\n number keygroup3 = 3\n number keygroup4 = 4\n number keygroup5 = 5\n number keygroupoff = 0\n string Model = \"models/kobilica/relay.mdl\"\n boolean nokey = false\n number normclose = 0\n number poles = 1\n number throws = 2\n boolean toggle = true\n \n > gmod_wire_screen\n boolean Floor = false\n boolean FormatNumber = false\n boolean FormatTime = false\n boolean LeftAlign = false\n string Model = \"models/props_lab/monitor01b.mdl\"\n boolean SingleBigFont = true\n boolean SingleValue = false\n string TextA = \"Value A\"\n string TextB = \"Value B\"\n \n > gmod_wire_sensor\n boolean direction_normalized = false\n boolean direction_vector = false\n boolean gpscord = false\n string Model\n boolean outbrng = false\n boolean outdist = true\n boolean target_velocity = false\n boolean velocity_normalized = false\n boolean xyz_mode = false\n \n > gmod_wire_simple_explosive\n number damage = 200\n number key = 1\n string Model = \"models/props_c17/oildrum001_explosive.mdl\"\n number radius = 300\n boolean removeafter = false\n \n > gmod_wire_socket\n boolean ArrayInput = false\n number AttachRange = 5\n string Model = \"models/props_lab/tpplugholder_single.mdl\"\n number WeldForce = 5000\n \n > gmod_wire_soundemitter\n string Model = \"models/cheeze/wires/speaker.mdl\"\n string sound = \"synth/square.wav\"\n \n > gmod_wire_spawner\n number a = 255\n number b = 255\n number delay = 0\n number g = 255\n string mat = \"\"\n string Model\n number r = 255\n number skin = 0\n number spawn_effect = 0\n number undo_delay = 0\n \n > gmod_wire_speedometer\n boolean AngVel = false\n string Model\n boolean z_only = false\n \n > gmod_wire_target_finder\n boolean beacons = false\n boolean casesen = false\n boolean checkbuddylist = false\n boolean colorcheck = false\n boolean colortarget = false\n string entity = \"\"\n boolean hoverballs = false\n number maxbogeys = 1\n number maxtargets = 1\n number minrange = 1\n string Model = \"models/beer/wiremod/targetfinder.mdl\"\n boolean notargetowner = false\n boolean notownersstuff = false\n string npcname = \"\"\n boolean npcs = true\n boolean onbuddylist = false\n boolean painttarget = true\n number pcolA = 255\n number pcolB = 255\n number pcolG = 255\n number pcolR = 255\n string playername = \"\"\n boolean players = false\n string propmodel = \"\"\n boolean props = false\n number range = 1000\n boolean rpgs = false\n string steamname = \"\"\n boolean thrusters = false\n boolean vehicles = false\n \n > gmod_wire_teleporter\n string Model = \"models/props_c17/utilityconducter001.mdl\"\n boolean UseEffects = true\n boolean UseSounds = true\n \n > gmod_wire_textentry\n string Model = \"models/beer/wiremod/keyboard.mdl\"\n \n > gmod_wire_textreceiver\n boolean CaseInsensitive = true\n table Matches\n string Model = \"models/jaanus/wiretool/wiretool_range.mdl\"\n boolean UseLuaPatterns = false\n \n > gmod_wire_textscreen\n Color bgcolor = Color(0, 0, 0)\n number chrPerLine = 6\n Color fgcolor = Color(255, 255, 255)\n string Model = \"models/kobilica/wiremonitorbig.mdl\"\n string text = \"\"\n number textJust = 1\n string tfont = \"Arial\"\n number valign = 0\n \n > gmod_wire_thruster\n boolean bidir = true\n number force = 1500\n number force_max = 10000\n number force_min = 0\n string Model = \"models/props_c17/lampShade001a.mdl\"\n boolean owater = true\n string oweffect = \"fire\"\n string soundname = \"\"\n boolean uwater = true\n string uweffect = \"same\"\n \n > gmod_wire_trail\n Color Color = Color(255, 255, 255)\n number EndSize = 0\n number Length = 5\n string Material = \"trails/lol\"\n number StartSize = 32\n \n > gmod_wire_trigger\n number filter = 0\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n number offsetx = 0\n number offsety = 0\n number offsetz = 0\n boolean owneronly = false\n number sizex = 64\n number sizey = 64\n number sizez = 64\n \n > gmod_wire_turret\n number damage = 10\n number delay = 0.05\n number force = 1\n string Model = \"models/weapons/w_smg1.mdl\"\n number numbullets = 1\n string sound = \"0\"\n number spread = 0\n string tracer = \"Tracer\"\n number tracernum = 1\n \n > gmod_wire_twoway_radio\n string Model = \"models/props_lab/binderblue.mdl\"\n \n > gmod_wire_user\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n number Range = 200\n \n > gmod_wire_value\n string Model = \"models/kobilica/value.mdl\"\n table value\n \n > gmod_wire_vectorthruster\n boolean angleinputs = false\n boolean bidir = true\n number force = 1500\n number force_max = 10000\n number force_min = 0\n boolean lengthismul = false\n number mode = 0\n string Model = \"models/jaanus/wiretool/wiretool_speed.mdl\"\n boolean owater = true\n string oweffect = \"fire\"\n string soundname = \"\"\n boolean uwater = true\n string uweffect = \"same\"\n \n > gmod_wire_vehicle\n string Model = \"models/jaanus/wiretool/wiretool_siren.mdl\"\n \n > gmod_wire_watersensor\n string Model = \"models/beer/wiremod/watersensor.mdl\"\n \n > gmod_wire_waypoint\n string Model = \"models/props_lab/powerbox02d.mdl\"\n number range = 150\n \n > gmod_wire_weight\n string Model = \"models/props_interiors/pot01a.mdl\"\n \n > gmod_wire_wheel\n Entity Base\n number BaseTorque = 3000\n number bck = -1\n number Bone = 0\n number forcelimit = 0\n number friction = 1\n number fwd = 1\n Vector LAxis = Vector(0, 1, 0)\n Vector LPos = Vector(0, 0, 0)\n string Model = \"models/props_vehicles/carparts_wheel01a.mdl\"\n number stop = 0\n "}},"path":"libs_sv/prop.lua#L23","libtbl":["props_library"],"realm":"server","fields":[],"class":"library","name":"prop","description":" Library for creating and manipulating physics-less models AKA \"Props\"."},"von":{"methods":{"serialize":{"path":"libs_sh/von.lua#L817","returns":[{"type":"string","value":"string String encoded from the table","description":"String encoded from the table"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to serialize","name":"tbl","description":"Table to serialize"},{"type":"boolean?","value":"boolean? checkRecursive Enable checking for table recursion (default: false)","name":"checkRecursive","description":"Enable checking for table recursion (default: false)"}],"class":"function","name":"serialize","description":" Serialize a table"},"deserialize":{"path":"libs_sh/von.lua#L808","returns":[{"type":"table","value":"table Table","description":"Table"}],"realm":"shared","params":[{"type":"string","value":"string str String to deserialize","name":"str","description":"String to deserialize"}],"class":"function","name":"deserialize","description":" Deserialize a string"}},"tables":[],"path":"libs_sh/von.lua#L797","libtbl":["von_library"],"realm":"shared","fields":[],"class":"library","name":"von","description":" vON Library"},"nextbot":{"methods":{"canSpawn":{"path":"libs_sv/nextbot.lua#L115","returns":[{"type":"boolean","value":"boolean True if user can spawn nextbots, False if not.","description":"True if user can spawn nextbots, False if not."}],"realm":"server","class":"function","name":"canSpawn","description":" Checks if a user can spawn anymore nextbots."},"create":{"path":"libs_sv/nextbot.lua#L81","returns":[{"type":"NextBot","value":"NextBot The nextbot.","description":"The nextbot."}],"realm":"server","params":[{"type":"Vector","value":"Vector spawnpos The position the nextbot will be spawned at.","name":"spawnpos","description":"The position the nextbot will be spawned at."},{"type":"string","value":"string model The model the nextbot will use.","name":"model","description":"The model the nextbot will use."}],"class":"function","name":"create","description":" Creates a customizable NextBot"},"remove":{"path":"libs_sv/nextbot.lua#L108","realm":"server","class":"function","name":"remove","description":" Removes the given nextbot."}},"tables":[],"path":"libs_sv/nextbot.lua#L12","libtbl":["nextbot_library"],"realm":"server","fields":[],"class":"library","name":"nextbot","description":" Library for spawning NextBots."},"net":{"methods":{"readVector":{"path":"libs_sh/net.lua#L420","returns":[{"type":"Vector","value":"Vector The vector that was read","description":"The vector that was read"}],"realm":"shared","class":"function","name":"readVector","description":" Reads a vector from the net message"},"writeUInt":{"path":"libs_sh/net.lua#L298","realm":"shared","params":[{"type":"number","value":"number t The integer to be written","name":"t","description":"The integer to be written"},{"type":"number","value":"number n The amount of bits the integer consists of. Should not be greater than 32","name":"n","description":"The amount of bits the integer consists of. Should not be greater than 32"}],"class":"function","name":"writeUInt","description":" Writes an unsigned integer to the net message"},"send":{"path":"libs_sh/net.lua#L92","realm":"shared","params":[{"type":"Player|table|nil","value":"Player|table|nil target Optional target location to send the net message. Player or table of targets. If nil, sends to server on client","name":"target","description":"Optional target location to send the net message. Player or table of targets. If nil, sends to server on client"},{"type":"boolean?","value":"boolean? unreliable Optional choose whether it's more important for the message to actually reach its destination (false) or reach it as fast as possible (true).","name":"unreliable","description":"Optional choose whether it's more important for the message to actually reach its destination (false) or reach it as fast as possible (true)."}],"class":"function","name":"send","description":" Send a net message from client->server, or server->client."},"readInt":{"path":"libs_sh/net.lua#L289","returns":[{"type":"number","value":"number The integer that was read","description":"The integer that was read"}],"realm":"shared","params":[{"type":"number","value":"number n The amount of bits to read","name":"n","description":"The amount of bits to read"}],"class":"function","name":"readInt","description":" Reads an integer from the net message"},"readString":{"path":"libs_sh/net.lua#L197","returns":[{"type":"string","value":"string The string that was read","description":"The string that was read"}],"realm":"shared","class":"function","name":"readString","description":" Reads a string from the net message"},"readMatrix":{"path":"libs_sh/net.lua#L438","returns":[{"type":"VMatrix","value":"VMatrix The matrix that was read","description":"The matrix that was read"}],"realm":"shared","class":"function","name":"readMatrix","description":" Reads a matrix from the net message"},"writeDouble":{"path":"libs_sh/net.lua#L357","realm":"shared","params":[{"type":"number","value":"number t The double to be written","name":"t","description":"The double to be written"}],"class":"function","name":"writeDouble","description":" Writes a double to the net message"},"readTable":{"path":"libs_sh/net.lua#L178","returns":[{"type":"table","value":"table The table","description":"The table"}],"realm":"shared","class":"function","name":"readTable","description":" Reads an table from a net message automatically typing it\n Will throw an error if invalid type is read. Make sure to pcall it"},"readBool":{"path":"libs_sh/net.lua#L350","returns":[{"type":"boolean","value":"boolean The boolean that was read.","description":"The boolean that was read."}],"realm":"shared","class":"function","name":"readBool","description":" Reads a boolean from the net message"},"writeData":{"path":"libs_sh/net.lua#L204","realm":"shared","params":[{"type":"string","value":"string t The string to be written","name":"t","description":"The string to be written"},{"type":"number","value":"number n How much of the string to write","name":"n","description":"How much of the string to write"}],"class":"function","name":"writeData","description":" Writes string containing null characters to the net message"},"readUInt":{"path":"libs_sh/net.lua#L312","returns":[{"type":"number","value":"number The unsigned integer that was read","description":"The unsigned integer that was read"}],"realm":"shared","params":[{"type":"number","value":"number n The amount of bits to read","name":"n","description":"The amount of bits to read"}],"class":"function","name":"readUInt","description":" Reads an unsigned integer from the net message"},"readData":{"path":"libs_sh/net.lua#L218","returns":[{"type":"string","value":"string The string that was read","description":"The string that was read"}],"realm":"shared","params":[{"type":"number","value":"number n How many characters are in the data","name":"n","description":"How many characters are in the data"}],"class":"function","name":"readData","description":" Reads a string from the net message"},"writeTable":{"path":"libs_sh/net.lua#L166","realm":"shared","params":[{"type":"table","value":"table v The table to write","name":"v","description":"The table to write"}],"class":"function","name":"writeTable","description":" Writes a table to a net message automatically typing it."},"getStreamProgress":{"path":"libs_sh/net.lua#L267","returns":[{"type":"number","value":"number The progress ratio 0-1","description":"The progress ratio 0-1"}],"realm":"shared","class":"function","name":"getStreamProgress","description":" Returns the progress of a running readStream"},"readDouble":{"path":"libs_sh/net.lua#L368","returns":[{"type":"number","value":"number The double that was read","description":"The double that was read"}],"realm":"shared","class":"function","name":"readDouble","description":" Reads a double from the net message"},"getBitsLeft":{"path":"libs_sh/net.lua#L506","returns":[{"type":"number","value":"number Number of bits that can be sent","description":"Number of bits that can be sent"}],"realm":"shared","class":"function","name":"getBitsLeft","description":" Returns available bandwidth in bits"},"writeString":{"path":"libs_sh/net.lua#L186","realm":"shared","params":[{"type":"string","value":"string t The string to be written","name":"t","description":"The string to be written"}],"class":"function","name":"writeString","description":" Writes a string to the net message. Null characters will terminate the string."},"readBit":{"path":"libs_sh/net.lua#L332","returns":[{"type":"number","value":"number The bit that was read. (0 for false, 1 for true)","description":"The bit that was read. (0 for false, 1 for true)"}],"realm":"shared","class":"function","name":"readBit","description":" Reads a bit from the net message"},"writeEntity":{"path":"libs_sh/net.lua#L462","realm":"shared","params":[{"type":"Entity","value":"Entity t The entity to be written","name":"t","description":"The entity to be written"}],"class":"function","name":"writeEntity","description":" Writes an entity to the net message"},"writeInt":{"path":"libs_sh/net.lua#L275","realm":"shared","params":[{"type":"number","value":"number t The integer to be written","name":"t","description":"The integer to be written"},{"type":"number","value":"number n The amount of bits the integer consists of","name":"n","description":"The amount of bits the integer consists of"}],"class":"function","name":"writeInt","description":" Writes an integer to the net message"},"writeFloat":{"path":"libs_sh/net.lua#L375","realm":"shared","params":[{"type":"number","value":"number t The float to be written","name":"t","description":"The float to be written"}],"class":"function","name":"writeFloat","description":" Writes a float to the net message"},"writeVector":{"path":"libs_sh/net.lua#L410","realm":"shared","params":[{"type":"Vector","value":"Vector t The vector to be written","name":"t","description":"The vector to be written"}],"class":"function","name":"writeVector","description":" Writes an vector to the net message. Has significantly lower precision than writeFloat"},"readType":{"path":"libs_sh/net.lua#L158","returns":[{"type":"any","value":"any The object","description":"The object"}],"realm":"shared","class":"function","name":"readType","description":" Reads an object from a net message automatically typing it\n Will throw an error if invalid type is read. Make sure to pcall it"},"start":{"path":"libs_sh/net.lua#L78","realm":"shared","params":[{"type":"string","value":"string name The message name","name":"name","description":"The message name"}],"class":"function","name":"start","description":" Starts the net message"},"readAngle":{"path":"libs_sh/net.lua#L403","returns":[{"type":"Angle","value":"Angle The angle that was read","description":"The angle that was read"}],"realm":"shared","class":"function","name":"readAngle","description":" Reads an angle from the net message"},"cancelStream":{"path":"libs_sh/net.lua#L260","realm":"shared","class":"function","name":"cancelStream","description":" Cancels a currently running readStream"},"sendPVS":{"path":"libs_sh/net.lua#L130","realm":"server","params":[{"type":"Vector","value":"Vector pos A vector within the PVS area to send a message","name":"pos","description":"A vector within the PVS area to send a message"},{"type":"boolean?","value":"boolean? unreliable Optional choose whether it's more important for the message to actually reach its destination (false) or reach it as fast as possible (true).","name":"unreliable","description":"Optional choose whether it's more important for the message to actually reach its destination (false) or reach it as fast as possible (true)."}],"class":"function","name":"sendPVS","description":" Send net message to all players within the visible area of a vector"},"readFloat":{"path":"libs_sh/net.lua#L386","returns":[{"type":"number","value":"number The float that was read","description":"The float that was read"}],"realm":"shared","class":"function","name":"readFloat","description":" Reads a float from the net message"},"getBytesLeft":{"path":"libs_sh/net.lua#L500","returns":[{"type":"number","value":"number Number of bytes that can be sent","description":"Number of bytes that can be sent"}],"realm":"shared","class":"function","name":"getBytesLeft","description":" Returns available bandwidth in bytes"},"receive":{"path":"libs_sh/net.lua#L490","realm":"shared","params":[{"type":"string","value":"string name The name of the net message","name":"name","description":"The name of the net message"},{"type":"function","value":"function func The callback or nil to remove callback. (len - length of the net message, ply - player that sent it or nil if clientside)","name":"func","description":"The callback or nil to remove callback. (len - length of the net message, ply - player that sent it or nil if clientside)"}],"class":"function","name":"receive","description":" Like glua net.Receive, adds a callback that is called when a net message with the matching name is received. If this happens, the net hook won't be called."},"readEntity":{"path":"libs_sh/net.lua#L472","returns":[{"type":"Entity","value":"Entity The entity that was read","description":"The entity that was read"}],"realm":"shared","params":[{"type":"function?","value":"function? callback (Client only) optional callback to be ran whenever the entity becomes valid; returns nothing if this is used. The callback passes the entity if it succeeds or nil if it fails.","name":"callback","description":"(Client only) optional callback to be ran whenever the entity becomes valid; returns nothing if this is used. The callback passes the entity if it succeeds or nil if it fails."}],"class":"function","name":"readEntity","description":" Reads a entity from the net message"},"readColor":{"path":"libs_sh/net.lua#L455","returns":[{"type":"Color","value":"Color The color that was read","description":"The color that was read"}],"realm":"shared","class":"function","name":"readColor","description":" Reads a color from the net message"},"writeAngle":{"path":"libs_sh/net.lua#L393","realm":"shared","params":[{"type":"Angle","value":"Angle t The angle to be written","name":"t","description":"The angle to be written"}],"class":"function","name":"writeAngle","description":" Writes an angle to the net message"},"writeStream":{"path":"libs_sh/net.lua#L228","realm":"shared","params":[{"type":"string","value":"string str The string to be written","name":"str","description":"The string to be written"},{"type":"boolean?","value":"boolean? compress Compress the data. True by default","name":"compress","description":"Compress the data. True by default"}],"class":"function","name":"writeStream","description":" Streams up to 64MB strings. Anything over 20MB with compression enabled will throw cpu quota"},"writeColor":{"path":"libs_sh/net.lua#L447","realm":"shared","params":[{"type":"Color","value":"Color t The color to be written","name":"t","description":"The color to be written"}],"class":"function","name":"writeColor","description":" Writes an color to the net message"},"readStream":{"path":"libs_sh/net.lua#L239","realm":"shared","params":[{"type":"function","value":"function cb Callback to run when the stream is finished. The first parameter in the callback is the data. Will be nil if transfer fails or is cancelled","name":"cb","description":"Callback to run when the stream is finished. The first parameter in the callback is the data. Will be nil if transfer fails or is cancelled"}],"class":"function","name":"readStream","description":" Reads a large string stream from the net message."},"writeBit":{"path":"libs_sh/net.lua#L321","realm":"shared","params":[{"type":"number","value":"number t The bit to be written. (0 for false, 1 (or anything) for true)","name":"t","description":"The bit to be written. (0 for false, 1 (or anything) for true)"}],"class":"function","name":"writeBit","description":" Writes a bit to the net message"},"isStreaming":{"path":"libs_sh/net.lua#L512","returns":[{"type":"boolean","value":"boolean Whether we're currently reading data from a stream","description":"Whether we're currently reading data from a stream"}],"realm":"shared","class":"function","name":"isStreaming","description":" Returns whether or not the library is currently reading data from a stream"},"writeType":{"path":"libs_sh/net.lua#L147","realm":"shared","params":[{"type":"any","value":"any v The object to write","name":"v","description":"The object to write"}],"class":"function","name":"writeType","description":" Writes an object to a net message automatically typing it"},"writeBool":{"path":"libs_sh/net.lua#L339","realm":"shared","params":[{"type":"boolean","value":"boolean t The bit to be written.","name":"t","description":"The bit to be written."}],"class":"function","name":"writeBool","description":" Writes a boolean to the net message"},"writeMatrix":{"path":"libs_sh/net.lua#L427","realm":"shared","params":[{"type":"VMatrix","value":"VMatrix t The matrix to be written","name":"t","description":"The matrix to be written"}],"class":"function","name":"writeMatrix","description":" Writes an matrix to the net message"}},"tables":[],"path":"libs_sh/net.lua#L35","libtbl":["net_library"],"realm":"shared","fields":[],"class":"library","name":"net","description":" Net message library. Used for sending data from the server to the client and back"},"convar":{"methods":{"exists":{"path":"libs_cl/convar.lua#L29","returns":[{"type":"boolean","value":"boolean True if exists","description":"True if exists"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"}],"class":"function","name":"exists","description":" Check if the given ConVar exists"},"hasFlag":{"path":"libs_cl/convar.lua#L97","returns":[{"type":"boolean","value":"boolean Whether the flag is set","description":"Whether the flag is set"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"},{"type":"number","value":"number flag Convar Flag, see https://wiki.facepunch.com/gmod/Enums/FCVAR","name":"flag","description":"Convar Flag, see https://wiki.facepunch.com/gmod/Enums/FCVAR"}],"class":"function","name":"hasFlag","description":" Returns true if a given FCVAR flag is set for this ConVar."},"getInt":{"path":"libs_cl/convar.lua#L67","returns":[{"type":"number","value":"number The integer value or 0 if converting fails","description":"The integer value or 0 if converting fails"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"}],"class":"function","name":"getInt","description":" Returns value of the ConVar as a whole number.\n Floats values will be floored."},"getMax":{"path":"libs_cl/convar.lua#L52","returns":[{"type":"number?","value":"number? The maximum value or nil if not specified","description":"The maximum value or nil if not specified"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"}],"class":"function","name":"getMax","description":" Returns the maximum value of the convar"},"getString":{"path":"libs_cl/convar.lua#L82","returns":[{"type":"string","value":"string Value as a string","description":"Value as a string"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"}],"class":"function","name":"getString","description":" Returns value of the ConVar as a string."},"getFlags":{"path":"libs_cl/convar.lua#L89","returns":[{"type":"number","value":"number Number consisting of flag values","description":"Number consisting of flag values"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"}],"class":"function","name":"getFlags","description":" Returns FCVAR flags of the given ConVar.\n https://wiki.facepunch.com/gmod/Enums/FCVAR"},"getMin":{"path":"libs_cl/convar.lua#L45","returns":[{"type":"number","value":"number The minimum value or nil if not specified","description":"The minimum value or nil if not specified"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"}],"class":"function","name":"getMin","description":" Returns the minimum value of the convar"},"getDefault":{"path":"libs_cl/convar.lua#L38","returns":[{"type":"string","value":"string Default value as a string","description":"Default value as a string"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"}],"class":"function","name":"getDefault","description":" Returns default value of the ConVar"},"getFloat":{"path":"libs_cl/convar.lua#L75","returns":[{"type":"number","value":"number The float value or 0 if converting fails","description":"The float value or 0 if converting fails"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"}],"class":"function","name":"getFloat","description":" Returns value of the ConVar as a floating-point number."},"getBool":{"path":"libs_cl/convar.lua#L59","returns":[{"type":"boolean","value":"boolean The boolean value","description":"The boolean value"}],"realm":"client","params":[{"type":"string","value":"string name Name of the ConVar","name":"name","description":"Name of the ConVar"}],"class":"function","name":"getBool","description":" Returns value of the ConVar as a boolean.\n True for numeric ConVars with the value of 1, false otherwise."}},"tables":[],"path":"libs_cl/convar.lua#L7","libtbl":["convar_library"],"realm":"client","fields":[],"class":"library","name":"convar","description":" ConVar library https://wiki.facepunch.com/gmod/ConVar"},"vr":{"methods":{"getHMDAng":{"path":"libs_sh/vr.lua#L98","returns":[{"type":"Angle","value":"Angle HMD Angles","description":"HMD Angles"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to get the HMD angles from","name":"target","description":"Player to get the HMD angles from"}],"class":"function","name":"getHMDAng","description":" Returns the Head Mounted Device angles"},"isPlayerInVR":{"path":"libs_sh/vr.lua#L75","returns":[{"type":"boolean","value":"boolean True if player is in VR","description":"True if player is in VR"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to check","name":"target","description":"Player to check"}],"class":"function","name":"isPlayerInVR","description":" Checks whether the player is in VR"},"getHMDVelocities":{"path":"libs_sh/vr.lua#L199","returns":[{"type":"Vector","value":"Vector Velocity","description":"Velocity"},{"type":"Vector","value":"Vector Angular velocity","description":"Angular velocity"}],"realm":"client","class":"function","name":"getHMDVelocities","description":" Returns the HMD velocities, position and angular"},"getOrigin":{"path":"libs_sh/vr.lua#L281","returns":[{"type":"Vector","value":"Vector Position","description":"Position"},{"type":"Angle","value":"Angle Angles","description":"Angles"}],"realm":"client","class":"function","name":"getOrigin","description":" Returns the playspace position and angles"},"getHMDPos":{"path":"libs_sh/vr.lua#L91","returns":[{"type":"Vector","value":"Vector HMD Position","description":"HMD Position"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to get the HMD position from","name":"target","description":"Player to get the HMD position from"}],"class":"function","name":"getHMDPos","description":" Returns the Head Mounted Device position"},"getHMDVelocity":{"path":"libs_sh/vr.lua#L185","returns":[{"type":"Vector","value":"Vector HMD Velocity","description":"HMD Velocity"}],"realm":"client","class":"function","name":"getHMDVelocity","description":" Returns the HMD velocity"},"getRightEyePos":{"path":"libs_sh/vr.lua#L306","returns":[{"type":"Vector","value":"Vector Position","description":"Position"}],"realm":"client","class":"function","name":"getRightEyePos","description":" Returns position of the right eye"},"getHMDPose":{"path":"libs_sh/vr.lua#L105","returns":[{"type":"Vector","value":"Vector HMD Position","description":"HMD Position"},{"type":"Angle","value":"Angle HMD Angles","description":"HMD Angles"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to get the HMD pose from","name":"target","description":"Player to get the HMD pose from"}],"class":"function","name":"getHMDPose","description":" Returns the HMD pose"},"getLeftEyePos":{"path":"libs_sh/vr.lua#L299","returns":[{"type":"Vector","value":"Vector Position","description":"Position"}],"realm":"client","class":"function","name":"getLeftEyePos","description":" Returns position of the left eye"},"getEyePos":{"path":"libs_sh/vr.lua#L292","returns":[{"type":"Vector","value":"Vector Position","description":"Position"}],"realm":"client","class":"function","name":"getEyePos","description":" Returns position of the eye that is currently being used for rendering."},"getLeftHandPos":{"path":"libs_sh/vr.lua#L116","returns":[{"type":"Vector","value":"Vector Position","description":"Position"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to get the left hand position from","name":"target","description":"Player to get the left hand position from"}],"class":"function","name":"getLeftHandPos","description":" Returns the left hand position"},"getOriginPos":{"path":"libs_sh/vr.lua#L267","returns":[{"type":"Vector","value":"Vector Position","description":"Position"}],"realm":"client","class":"function","name":"getOriginPos","description":" Returns the playspace position"},"getLeftHandVelocities":{"path":"libs_sh/vr.lua#L224","returns":[{"type":"Vector","value":"Vector Velocity","description":"Velocity"},{"type":"Vector","value":"Vector Angular velocity","description":"Angular velocity"}],"realm":"client","class":"function","name":"getLeftHandVelocities","description":" Returns the left hand velocities, position and angular"},"getRightHandAng":{"path":"libs_sh/vr.lua#L148","returns":[{"type":"Angle","value":"Angle Angles","description":"Angles"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to get the right hand angles from","name":"target","description":"Player to get the right hand angles from"}],"class":"function","name":"getRightHandAng","description":" Returns the left hand angles"},"getLeftHandAng":{"path":"libs_sh/vr.lua#L123","returns":[{"type":"Angle","value":"Angle Angles","description":"Angles"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to get the left hand angles from","name":"target","description":"Player to get the left hand angles from"}],"class":"function","name":"getLeftHandAng","description":" Returns the left hand angles"},"usingEmptyHands":{"path":"libs_sh/vr.lua#L82","returns":[{"type":"boolean","value":"boolean True if player is using empty hands","description":"True if player is using empty hands"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to check","name":"target","description":"Player to check"}],"class":"function","name":"usingEmptyHands","description":" Checks whether the player is using empty hands"},"getRightHandAngularVelocity":{"path":"libs_sh/vr.lua#L242","returns":[{"type":"Vector","value":"Vector Angular velocity","description":"Angular velocity"}],"realm":"client","class":"function","name":"getRightHandAngularVelocity","description":" Returns the right hand angular velocity"},"getLeftHandPose":{"path":"libs_sh/vr.lua#L130","returns":[{"type":"Vector","value":"Vector Position","description":"Position"},{"type":"Angle","value":"Angle Angles","description":"Angles"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to get the left hand pose from","name":"target","description":"Player to get the left hand pose from"}],"class":"function","name":"getLeftHandPose","description":" Returns the left hand pose"},"getRightHandVelocity":{"path":"libs_sh/vr.lua#L235","returns":[{"type":"Vector","value":"Vector Velocity","description":"Velocity"}],"realm":"client","class":"function","name":"getRightHandVelocity","description":" Returns the right hand velocity"},"getRightHandPose":{"path":"libs_sh/vr.lua#L155","returns":[{"type":"Vector","value":"Vector Position","description":"Position"},{"type":"Angle","value":"Angle Angles","description":"Angles"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to get the right hand pose from","name":"target","description":"Player to get the right hand pose from"}],"class":"function","name":"getRightHandPose","description":" Returns the left hand pose"},"getRightHandVelocities":{"path":"libs_sh/vr.lua#L249","returns":[{"type":"Vector","value":"Vector Velocity","description":"Velocity"},{"type":"Vector","value":"Vector Angular velocity","description":"Angular velocity"}],"realm":"client","class":"function","name":"getRightHandVelocities","description":" Returns the right hand velocities, position and angular"},"getLeftHandAngularVelocity":{"path":"libs_sh/vr.lua#L217","returns":[{"type":"Vector","value":"Vector Angular velocity","description":"Angular velocity"}],"realm":"client","class":"function","name":"getLeftHandAngularVelocity","description":" Returns the left hand angular velocity"},"getInput":{"path":"libs_sh/vr.lua#L166","returns":[{"type":"boolean|Vector|number","value":"boolean|Vector|number Boolean, Vector or Number of input","description":"Boolean, Vector or Number of input"}],"realm":"client","params":[{"type":"string","value":"string actionname ActionName to check control of, see the VR enums","name":"actionname","description":"ActionName to check control of, see the VR enums"}],"class":"function","name":"getInput","description":" Returns the a controller's input state, may return boolean, number or vector."},"getRightHandPos":{"path":"libs_sh/vr.lua#L141","returns":[{"type":"Vector","value":"Vector Position","description":"Position"}],"realm":"shared","params":[{"type":"Player","value":"Player target Player to get the right hand position from","name":"target","description":"Player to get the right hand position from"}],"class":"function","name":"getRightHandPos","description":" Returns the right hand position"},"getHMDAngularVelocity":{"path":"libs_sh/vr.lua#L192","returns":[{"type":"Vector","value":"Vector Angular velocity","description":"Angular velocity"}],"realm":"client","class":"function","name":"getHMDAngularVelocity","description":" Returns the HMD angular velocity"},"getLeftHandVelocity":{"path":"libs_sh/vr.lua#L210","returns":[{"type":"Vector","value":"Vector Velocity","description":"Velocity"}],"realm":"client","class":"function","name":"getLeftHandVelocity","description":" Returns the left hand velocity"},"getOriginAng":{"path":"libs_sh/vr.lua#L274","returns":[{"type":"Angle","value":"Angle Angles","description":"Angles"}],"realm":"client","class":"function","name":"getOriginAng","description":" Returns the playspace angles"}},"tables":{"VR":{"path":"libs_sh/enum.lua#L1054","fields":[{"name":"BOOLEAN_PRIMARYFIRE","description":""},{"name":"VECTOR1_PRIMARYFIRE","description":""},{"name":"BOOLEAN_SECONDARYFIRE","description":""},{"name":"BOOLEAN_CHANGEWEAPON","description":""},{"name":"BOOLEAN_USE","description":""},{"name":"BOOLEAN_SPAWNMENU","description":""},{"name":"VECTOR2_WALKDIRECTION","description":""},{"name":"BOOLEAN_WALK","description":""},{"name":"BOOLEAN_FLASHLIGHT","description":""},{"name":"BOOLEAN_TURNLEFT","description":""},{"name":"BOOLEAN_TURNRIGHT","description":""},{"name":"VECTOR2_SMOOTHTURN","description":""},{"name":"BOOLEAN_CHAT","description":""},{"name":"BOOLEAN_RELOAD","description":""},{"name":"BOOLEAN_JUMP","description":""},{"name":"BOOLEAN_LEFT_PICKUP","description":""},{"name":"BOOLEAN_RIGHT_PICKUP","description":""},{"name":"BOOLEAN_UNDO","description":""},{"name":"BOOLEAN_SPRINT","description":""},{"name":"VECTOR1_FORWARD","description":""},{"name":"VECTOR1_REVERSE","description":""},{"name":"BOOLEAN_TURBO","description":""},{"name":"VECTOR2_STEER","description":""},{"name":"BOOLEAN_HANDBRAKE","description":""},{"name":"BOOLEAN_EXIT","description":""},{"name":"BOOLEAN_TURRET","description":""}],"realm":"shared","class":"table","name":"VR","description":" VRmod library enums"}},"path":"libs_sh/vr.lua#L5","libtbl":["vr_library"],"realm":"shared","fields":[],"class":"library","name":"vr","description":" VRMod Library\n Addon and module: https://steamcommunity.com/sharedfiles/filedetails/?id=1678408548\n Follow install instructions on the addon's page."},"input":{"methods":{"isControlLocked":{"path":"libs_sh/input.lua#L366","returns":[{"type":"boolean","value":"boolean Whether the player's control is locked","description":"Whether the player's control is locked"}],"realm":"client","class":"function","name":"isControlLocked","description":" Gets whether the player's control is currently locked"},"isKeyDown":{"path":"libs_sh/input.lua#L233","returns":[{"type":"boolean","value":"boolean True if the key is down","description":"True if the key is down"}],"realm":"client","params":[{"type":"number","value":"number key The key id, see input","name":"key","description":"The key id, see input"}],"class":"function","name":"isKeyDown","description":" Gets whether a key is down"},"getCursorPos":{"path":"libs_sh/input.lua#L288","returns":[{"type":"number","value":"number The x position of the mouse","description":"The x position of the mouse"},{"type":"number","value":"number The y position of the mouse","description":"The y position of the mouse"}],"realm":"client","class":"function","name":"getCursorPos","description":" Gets the position of the mouse"},"enableCursor":{"path":"libs_sh/input.lua#L319","realm":"client","params":[{"type":"boolean","value":"boolean enabled Whether or not the cursor should be enabled","name":"enabled","description":"Whether or not the cursor should be enabled"}],"class":"function","name":"enableCursor","description":" Sets the state of the mouse cursor"},"lookupKeyBinding":{"path":"libs_sh/input.lua#L223","returns":[{"type":"string","value":"string The command bound to the key","description":"The command bound to the key"}],"realm":"client","params":[{"type":"number","value":"number key The key id, see input","name":"key","description":"The key id, see input"}],"class":"function","name":"lookupKeyBinding","description":" Gets the command bound to a key"},"lockControls":{"path":"libs_sh/input.lua#L344","realm":"client","params":[{"type":"boolean","value":"boolean enabled Whether to lock or unlock the controls","name":"enabled","description":"Whether to lock or unlock the controls"}],"class":"function","name":"lockControls","description":" Locks game controls for typing purposes. Alt will unlock the controls. Has a 10 second cooldown."},"screenToVector":{"path":"libs_sh/input.lua#L307","returns":[{"type":"Vector","value":"Vector Aim vector","description":"Aim vector"}],"realm":"client","params":[{"type":"number","value":"number x X coordinate on the screen","name":"x","description":"X coordinate on the screen"},{"type":"number","value":"number y Y coordinate on the screen","name":"y","description":"Y coordinate on the screen"}],"class":"function","name":"screenToVector","description":" Translates position on player's screen to aim vector"},"getKeyName":{"path":"libs_sh/input.lua#L258","returns":[{"type":"string","value":"string The name of the key","description":"The name of the key"}],"realm":"client","params":[{"type":"number","value":"number key The key id, see input","name":"key","description":"The key id, see input"}],"class":"function","name":"getKeyName","description":" Gets the name of a key from the id"},"isShiftDown":{"path":"libs_sh/input.lua#L270","returns":[{"type":"boolean","value":"boolean True if the shift key is down","description":"True if the shift key is down"}],"realm":"client","class":"function","name":"isShiftDown","description":" Gets whether the shift key is down"},"getCursorVisible":{"path":"libs_sh/input.lua#L298","returns":[{"type":"boolean","value":"boolean The cursor's visibility","description":"The cursor's visibility"}],"realm":"client","class":"function","name":"getCursorVisible","description":" Gets whether the cursor is visible on the screen"},"canLockControls":{"path":"libs_sh/input.lua#L373","returns":[{"type":"boolean","value":"boolean Whether the player's control can be locked","description":"Whether the player's control can be locked"}],"realm":"client","class":"function","name":"canLockControls","description":" Gets whether the player's control can be locked"},"isMouseDown":{"path":"libs_sh/input.lua#L246","returns":[{"type":"boolean","value":"boolean True if the key is down","description":"True if the key is down"}],"realm":"client","params":[{"type":"number","value":"number key The mouse button id, see input","name":"key","description":"The mouse button id, see input"}],"class":"function","name":"isMouseDown","description":" Gets whether a mouse button is down"},"selectWeapon":{"path":"libs_sh/input.lua#L334","realm":"client","params":[{"type":"Weapon","value":"Weapon weapon The weapon entity to select","name":"weapon","description":"The weapon entity to select"}],"class":"function","name":"selectWeapon","description":" Makes the local player select a weapon"},"isControlDown":{"path":"libs_sh/input.lua#L279","returns":[{"type":"boolean","value":"boolean True if the control key is down","description":"True if the control key is down"}],"realm":"client","class":"function","name":"isControlDown","description":" Gets whether the control key is down"},"lookupBinding":{"path":"libs_sh/input.lua#L205","returns":[{"type":"number","value":"number The id of the first key bound","description":"The id of the first key bound"},{"type":"string","value":"string The name of the first key bound","description":"The name of the first key bound"}],"realm":"client","params":[{"type":"string","value":"string binding The name of the bind","name":"binding","description":"The name of the bind"}],"class":"function","name":"lookupBinding","description":" Gets the first key that is bound to the command passed"}},"tables":[],"path":"libs_sh/input.lua#L168","libtbl":["input_library"],"realm":"shared","fields":[],"class":"library","name":"input","description":" Input library."},"table":{"methods":{"maxn":{"path":"libs_sh/table.lua#L141","returns":[{"type":"number","value":"number The highest numerical key","description":"The highest numerical key"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to search","name":"tbl","description":"The table to search"}],"class":"function","name":"maxn","description":" Returns the highest numerical key."},"hasValue":{"path":"libs_sh/table.lua#L87","returns":[{"type":"boolean","value":"boolean Returns true if the table has that value, false otherwise","description":"Returns true if the table has that value, false otherwise"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to check","name":"tbl","description":"Table to check"},{"type":"any","value":"any val Value to search for","name":"val","description":"Value to search for"}],"class":"function","name":"hasValue","description":" Checks if a table has a value. This function is very inefficient for large tables (O(n))."},"collapseKeyValue":{"path":"libs_sh/table.lua#L36","returns":[{"type":"table","value":"table Output table","description":"Output table"}],"realm":"shared","params":[{"type":"table","value":"table tbl The input table","name":"tbl","description":"The input table"}],"class":"function","name":"collapseKeyValue","description":" Collapses a table with keyvalue structure"},"merge":{"path":"libs_sh/table.lua#L241","returns":[{"type":"table","value":"table Destination table","description":"Destination table"}],"realm":"shared","params":[{"type":"table","value":"table dest The table you want the source table to merge with","name":"dest","description":"The table you want the source table to merge with"},{"type":"table","value":"table source The table you want to merge with the destination table","name":"source","description":"The table you want to merge with the destination table"}],"class":"function","name":"merge","description":" Merges the contents of the second table with the content in the first one."},"reverse":{"path":"libs_sh/table.lua#L168","returns":[{"type":"table","value":"table A reversed copy of the table","description":"A reversed copy of the table"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to reverse","name":"tbl","description":"Table to reverse"}],"class":"function","name":"reverse","description":" Returns a reversed copy of a sequential table. Any non-sequential and non-numeric keyvalue pairs will not be copied"},"isSequential":{"path":"libs_sh/table.lua#L115","returns":[{"type":"boolean","value":"boolean True if sequential","description":"True if sequential"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to check","name":"tbl","description":"Table to check"}],"class":"function","name":"isSequential","description":" Returns whether or not the table's keys are sequential."},"inherit":{"path":"libs_sh/table.lua#L100","returns":[{"type":"table","value":"table The target table","description":"The target table"}],"realm":"shared","params":[{"type":"table","value":"table target Table to copy data to","name":"target","description":"Table to copy data to"},{"type":"table","value":"table base Table to copy data from","name":"base","description":"Table to copy data from"}],"class":"function","name":"inherit","description":" Copies any missing data from base to target, and sets the target's BaseClass member to the base table's pointer."},"toString":{"path":"libs_sh/table.lua#L207","realm":"shared","params":[{"type":"table","value":"table tbl The table to iterate over","name":"tbl","description":"The table to iterate over"},{"type":"string?","value":"string? displayName Optional name for the table","name":"displayName","description":"Optional name for the table"},{"type":"boolean?","value":"boolean? niceFormatting Optional, adds new lines and tabs to the string. Defaults to false","name":"niceFormatting","description":"Optional, adds new lines and tabs to the string. Defaults to false"}],"class":"function","name":"toString","description":" Converts a table into a string"},"sortDesc":{"path":"libs_sh/table.lua#L201","returns":[{"type":"table","value":"table Sorted table","description":"Sorted table"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to sort in descending order","name":"tbl","description":"The table to sort in descending order"}],"class":"function","name":"sortDesc","description":" Sorts a table in reverse order from table.sort"},"getWinningKey":{"path":"libs_sh/table.lua#L81","returns":[{"type":"any","value":"any Winning key","description":"Winning key"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to search in","name":"tbl","description":"The table to search in"}],"class":"function","name":"getWinningKey","description":" Returns a key of the supplied table with the highest number value."},"sortByKey":{"path":"libs_sh/table.lua#L188","realm":"shared","params":[{"type":"table","value":"table tbl Table to sort. All values of this table must be of same type","name":"tbl","description":"Table to sort. All values of this table must be of same type"},{"type":"boolean?","value":"boolean? descending Optional, should the order be descending? Defaults to false","name":"descending","description":"Optional, should the order be descending? Defaults to false"}],"class":"function","name":"sortByKey","description":" Returns a list of keys sorted based on values of those keys."},"copyFromTo":{"path":"libs_sh/table.lua#L51","realm":"shared","params":[{"type":"table","value":"table source The table to copy from","name":"source","description":"The table to copy from"},{"type":"table","value":"table target The table to write to","name":"target","description":"The table to write to"}],"class":"function","name":"copyFromTo","description":" Empties the target table, and merges all values from the source table into it."},"getKeys":{"path":"libs_sh/table.lua#L75","returns":[{"type":"table","value":"table Table of keys","description":"Table of keys"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to get keys of","name":"tbl","description":"The table to get keys of"}],"class":"function","name":"getKeys","description":" Returns all keys of a table"},"add":{"path":"libs_sh/table.lua#L14","returns":[{"type":"table","value":"table The target table","description":"The target table"}],"realm":"shared","params":[{"type":"table","value":"table target The table to insert the new values into","name":"target","description":"The table to insert the new values into"},{"type":"table","value":"table source The table to retrieve the values from","name":"source","description":"The table to retrieve the values from"}],"class":"function","name":"add","description":" Adds the contents from one table into another. The target table will be modified."},"sort":{"path":"libs_sh/table.lua#L179","realm":"shared","params":[{"type":"table","value":"table tbl The table to sort","name":"tbl","description":"The table to sort"},{"type":"function?","value":"function? sorter If specified, the function will be called with 2 parameters each. Return true in this function if you want the first parameter to come first in the sorted array","name":"sorter","description":"If specified, the function will be called with 2 parameters each. Return true in this function if you want the first parameter to come first in the sorted array"}],"class":"function","name":"sort","description":" Sorts a table either ascending or by the given sort function"},"insert":{"path":"libs_sh/table.lua#L107","returns":[{"type":"number","value":"number The index the variable was placed at.","description":"The index the variable was placed at."}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to insert the variable into","name":"tbl","description":"The table to insert the variable into"},{"type":"any","value":"any pos The position in the table to insert the variable. If the third argument is not provided, this argument becomes the value to insert at the end of given table","name":"pos","description":"The position in the table to insert the variable. If the third argument is not provided, this argument becomes the value to insert at the end of given table"},{"type":"any","value":"any val The variable to insert into the table","name":"val","description":"The variable to insert into the table"}],"class":"function","name":"insert","description":" Inserts a value into a table at the end of the table or at the given position."},"keysFromValue":{"path":"libs_sh/table.lua#L128","returns":[{"type":"table","value":"table Table of keys","description":"Table of keys"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to search","name":"tbl","description":"Table to search"},{"type":"any","value":"any val Value to search for","name":"val","description":"Value to search for"}],"class":"function","name":"keysFromValue","description":" Returns a table of keys containing the supplied value."},"sortByMember":{"path":"libs_sh/table.lua#L194","realm":"shared","params":[{"type":"table","value":"table tbl Table to sort","name":"tbl","description":"Table to sort"},{"type":"any","value":"any member The key used to identify the member","name":"member","description":"The key used to identify the member"},{"type":"boolean?","value":"boolean? ascending Optional, should be ascending? Defaults to false","name":"ascending","description":"Optional, should be ascending? Defaults to false"}],"class":"function","name":"sortByMember","description":" Sorts a table by a named member."},"isEmpty":{"path":"libs_sh/table.lua#L94","returns":[{"type":"boolean","value":"boolean Returns true if the table contains any value, false otherwise","description":"Returns true if the table contains any value, false otherwise"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to check","name":"tbl","description":"Table to check"}],"class":"function","name":"isEmpty","description":" Checks if a table contains any value."},"copy":{"path":"libs_sh/table.lua#L214","returns":[{"type":"table","value":"table A deep copy of the original table","description":"A deep copy of the original table"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to be copied","name":"tbl","description":"The table to be copied"}],"class":"function","name":"copy","description":" Creates a deep copy and returns that copy. This function does NOT copy userdata, such as Vectors and Angles!"},"forceInsert":{"path":"libs_sh/table.lua#L68","returns":[{"type":"table","value":"table The supplied or created table","description":"The supplied or created table"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to insert value in to. If not supplied, will create a table","name":"tbl","description":"Table to insert value in to. If not supplied, will create a table"},{"type":"any","value":"any val Value to insert","name":"val","description":"Value to insert"}],"class":"function","name":"forceInsert","description":" Inserts a value in to the given table even if the table is non-existent"},"removeByValue":{"path":"libs_sh/table.lua#L161","returns":[{"type":"any","value":"any The key at which the value was found, or false if the value was not found","description":"The key at which the value was found, or false if the value was not found"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table that will be searched","name":"tbl","description":"The table that will be searched"},{"type":"any","value":"any val The value to find within the table","name":"val","description":"The value to find within the table"}],"class":"function","name":"removeByValue","description":" Removes the first instance of a given value from the specified table with table.remove, then returns the key that the value was found at"},"shuffle":{"path":"libs_sh/table.lua#L174","realm":"shared","params":[{"type":"table","value":"table tbl Table to shuffle","name":"tbl","description":"Table to shuffle"}],"class":"function","name":"shuffle","description":" Performs an inline Fisher-Yates shuffle on the table in O(n) time"},"empty":{"path":"libs_sh/table.lua#L63","realm":"shared","params":[{"type":"table","value":"table tbl The table to empty","name":"tbl","description":"The table to empty"}],"class":"function","name":"empty","description":" Removes all values from a table"},"address":{"path":"libs_sh/table.lua#L21","returns":[{"type":"string","value":"string The table's string address","description":"The table's string address"}],"realm":"shared","params":[{"type":"table","value":"table target The target to get the address of","name":"target","description":"The target to get the address of"}],"class":"function","name":"address","description":" Returns the string address of the table"},"lowerKeyNames":{"path":"libs_sh/table.lua#L135","returns":[{"type":"table","value":"table New converted table","description":"New converted table"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to convert","name":"tbl","description":"Table to convert"}],"class":"function","name":"lowerKeyNames","description":" Returns a copy of the input table with all string keys converted to be lowercase recursively."},"remove":{"path":"libs_sh/table.lua#L154","returns":[{"type":"any","value":"any The value that was removed","description":"The value that was removed"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to remove the value from","name":"tbl","description":"The table to remove the value from"},{"type":"number?","value":"number? index Optional index of the value to remove. Defaults to #tbl","name":"index","description":"Optional index of the value to remove. Defaults to #tbl"}],"class":"function","name":"remove","description":" Removes a value from a table and shifts any other values down to fill the gap."},"clearKeys":{"path":"libs_sh/table.lua#L29","returns":[{"type":"table","value":"table Table with integer keys","description":"Table with integer keys"}],"realm":"shared","params":[{"type":"table","value":"table tbl The original table to modify","name":"tbl","description":"The original table to modify"},{"type":"boolean?","value":"boolean? saveKeys Optional save the keys within each member table. This will insert a new field __key into each value, and should not be used if the table contains non-table values. Defaults to false","name":"saveKeys","description":"Optional save the keys within each member table. This will insert a new field __key into each value, and should not be used if the table contains non-table values. Defaults to false"}],"class":"function","name":"clearKeys","description":" Changes all keys to sequential integers. This creates a new table object and does not affect the original."},"random":{"path":"libs_sh/table.lua#L147","returns":[{"type":"any","value":"any A random value from the table","description":"A random value from the table"},{"type":"any","value":"any The key associated with the random value","description":"The key associated with the random value"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to choose from","name":"tbl","description":"The table to choose from"}],"class":"function","name":"random","description":" Returns a random value from the supplied table."},"count":{"path":"libs_sh/table.lua#L57","returns":[{"type":"number","value":"number The number of keyvalue pairs","description":"The number of keyvalue pairs"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to count the keys of","name":"tbl","description":"The table to count the keys of"}],"class":"function","name":"count","description":" Counts the amount of keys in a table. This should only be used when a table is not numerically and sequentially indexed, for those table consider # operator"},"concat":{"path":"libs_sh/table.lua#L42","returns":[{"type":"string","value":"string Concatenated string","description":"Concatenated string"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to concatenate","name":"tbl","description":"The table to concatenate"},{"type":"string","value":"string concatenator A seperator to insert between each string","name":"concatenator","description":"A seperator to insert between each string"},{"type":"number?","value":"number? startPos Optional key to start at. Defaults to 1","name":"startPos","description":"Optional key to start at. Defaults to 1"},{"type":"number?","value":"number? endPos Optional key to end at. Defaults to #tbl","name":"endPos","description":"Optional key to end at. Defaults to #tbl"}],"class":"function","name":"concat","description":" Concatenates the contents of a table to a string."},"keyFromValue":{"path":"libs_sh/table.lua#L121","returns":[{"type":"any","value":"any Found key","description":"Found key"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to search","name":"tbl","description":"Table to search"},{"type":"any","value":"any val Value to search for","name":"val","description":"Value to search for"}],"class":"function","name":"keyFromValue","description":" Returns the first key found to be containing the supplied value."}},"tables":[],"path":"libs_sh/table.lua#L4","libtbl":["table_library"],"realm":"shared","fields":[],"class":"library","name":"table","description":" Lua table library https://wiki.garrysmod.com/page/Category:table"},"builtins":{"methods":{"localToWorld":{"path":"libs_sh/builtins.lua#L1158","returns":[{"type":"Vector","value":"Vector worldPos","description":"worldPos"},{"type":"Angle","value":"Angle worldAngles","description":"worldAngles"}],"realm":"shared","params":[{"type":"Vector","value":"Vector localPos The position vector that should be translated to world coordinates","name":"localPos","description":"The position vector that should be translated to world coordinates"},{"type":"Angle","value":"Angle localAng The angle that should be converted to a world angle","name":"localAng","description":"The angle that should be converted to a world angle"},{"type":"Vector","value":"Vector originPos The origin point of the source coordinate system, in world coordinates","name":"originPos","description":"The origin point of the source coordinate system, in world coordinates"},{"type":"Angle","value":"Angle originAngle The angles of the source coordinate system, as a world angle","name":"originAngle","description":"The angles of the source coordinate system, as a world angle"}],"class":"function","name":"localToWorld","description":" Translates the specified position and angle from the specified local coordinate system"},"version":{"path":"libs_sh/builtins.lua#L267","returns":[{"type":"string","value":"string Starfall version","description":"Starfall version"}],"realm":"shared","class":"function","name":"version","description":" Gets the starfall version"},"assert":{"path":"libs_sh/builtins.lua#L1119","realm":"shared","params":[{"type":"any","value":"any expression Anything that will be evaluated to be true or false","name":"expression","description":"Anything that will be evaluated to be true or false"},{"type":"string?","value":"string? msg Error message. Default \"assertion failed!\"","name":"msg","description":"Error message. Default \"assertion failed!\""},{"type":"...","value":"... args Any arguments to return if the assertion is successful","name":"args","description":"Any arguments to return if the assertion is successful"}],"class":"function","name":"assert","description":" If the result of the first argument is false or nil, an error is thrown with the second argument as the message."},"tostring":{"path":"libs_sh/builtins.lua#L100","returns":[{"type":"string","value":"string Object as a string","description":"Object as a string"}],"realm":"shared","params":[{"type":"any","value":"any obj Object to turn into a string","name":"obj","description":"Object to turn into a string"}],"class":"function","name":"tostring","description":" Attempts to convert the value to a string."},"isfunction":{"path":"libs_sh/builtins.lua#L195","returns":[{"type":"boolean","value":"boolean If the object is a function or not","description":"If the object is a function or not"}],"realm":"shared","params":[{"type":"any","value":"any x Input to check","name":"x","description":"Input to check"}],"class":"function","name":"isfunction","description":" Returns if the given input is a function"},"tonumber":{"path":"libs_sh/builtins.lua#L107","returns":[{"type":"number?","value":"number? The object as a number or nil if it couldn't be converted","description":"The object as a number or nil if it couldn't be converted"}],"realm":"shared","params":[{"type":"any","value":"any obj Object to turn into a number","name":"obj","description":"Object to turn into a number"}],"class":"function","name":"tonumber","description":" Attempts to convert the value to a number."},"throw":{"path":"libs_sh/builtins.lua#L1102","realm":"shared","params":[{"type":"string","value":"string msg Message string","name":"msg","description":"Message string"},{"type":"number?","value":"number? level Which level in the stacktrace to blame. Defaults to 1","name":"level","description":"Which level in the stacktrace to blame. Defaults to 1"},{"type":"boolean?","value":"boolean? uncatchable Makes this exception uncatchable","name":"uncatchable","description":"Makes this exception uncatchable"}],"class":"function","name":"throw","description":" Throws an exception"},"rawget":{"path":"libs_sh/builtins.lua#L441","returns":[{"type":"any","value":"any The value of the index","description":"The value of the index"}],"realm":"shared","params":[{"type":"table","value":"table table The table to get the value from","name":"table","description":"The table to get the value from"},{"type":"any","value":"any key The index of the table","name":"key","description":"The index of the table"}],"class":"function","name":"rawget","description":" Gets the value of a table index without invoking a metamethod"},"ramUsed":{"path":"libs_sh/builtins.lua#L249","returns":[{"type":"number","value":"number The ram used in kilobytes","description":"The ram used in kilobytes"}],"realm":"shared","class":"function","name":"ramUsed","description":" Gets the current ram usage of the gmod lua environment"},"Quaternion":{"path":"libs_sh/quaternion.lua#L195","returns":[{"type":"Quaternion","value":"Quaternion Quaternion object","description":"Quaternion object"}],"realm":"shared","params":[{"type":"number?","value":"number? r R (real) component","name":"r","description":"R (real) component"},{"type":"number?","value":"number? i I component","name":"i","description":"I component"},{"type":"number?","value":"number? j J component","name":"j","description":"J component"},{"type":"number?","value":"number? k K component","name":"k","description":"K component"}],"class":"function","name":"Quaternion","description":" Creates a Quaternion"},"isFirstTimePredicted":{"path":"libs_sh/builtins.lua#L229","returns":[{"type":"boolean","value":"boolean Whether this is the first time this hook was predicted","description":"Whether this is the first time this hook was predicted"}],"realm":"shared","class":"function","name":"isFirstTimePredicted","description":" Returns if this is the first time this hook was predicted."},"ipairs":{"path":"libs_sh/builtins.lua#L114","returns":[{"type":"function","value":"function Iterator function","description":"Iterator function"},{"type":"table","value":"table Table being iterated over","description":"Table being iterated over"},{"type":"number","value":"number Origin index. Equals 0.","description":"Origin index. Equals 0."}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to iterate over","name":"tbl","description":"Table to iterate over"}],"class":"function","name":"ipairs","description":" Returns an iterator function for a for loop, to return ordered key-value pairs from a table."},"cpuUsed":{"path":"libs_sh/builtins.lua#L235","returns":[{"type":"number","value":"number Current cpu time used this Think","description":"Current cpu time used this Think"}],"realm":"shared","class":"function","name":"cpuUsed","description":" Returns the current count for this Think's CPU Time.\n This value increases as more executions are done, may not be exactly as you want.\n If used on screens, will show 0 if only rendering is done. Operations must be done in the Think loop for them to be counted."},"print":{"path":"libs_sh/builtins.lua#L530","realm":"shared","params":[{"type":"...","value":"... printArgs Values to print. Colors before text will set the text color","name":"printArgs","description":"Values to print. Colors before text will set the text color"}],"class":"function","name":"print","description":" Prints a message to the player's chat."},"pcall":{"path":"libs_sh/builtins.lua#L1024","returns":[{"type":"boolean","value":"boolean If the function had no errors occur within it.","description":"If the function had no errors occur within it."},{"type":"...","value":"... If an error occurred, this will be a string containing the error message. Otherwise, this will be the return values of the function passed in.","description":"If an error occurred, this will be a string containing the error message. Otherwise, this will be the return values of the function passed in."}],"realm":"shared","params":[{"type":"function","value":"function func Function to be executed and of which the errors should be caught of","name":"func","description":"Function to be executed and of which the errors should be caught of"},{"type":"...","value":"... arguments Arguments to call the function with.","name":"arguments","description":"Arguments to call the function with."}],"class":"function","name":"pcall","description":" Lua's pcall with SF throw implementation\n Calls a function and catches an error that can be thrown while the execution of the call."},"getScript":{"path":"libs_sh/builtins.lua#L716","returns":[{"type":"string?","value":"string? Source code, or nil if could not be found","description":"Source code, or nil if could not be found"},{"type":"function?","value":"function? Compiled function, or nil if could not be found","description":"Compiled function, or nil if could not be found"}],"realm":"shared","params":[{"type":"string","value":"string path Path of file. Can be absolute or relative to calling file. Must be '--@include'-ed.","name":"path","description":"Path of file. Can be absolute or relative to calling file. Must be '--@include'-ed."}],"class":"function","name":"getScript","description":" Returns the source code of and compiled function for specified script."},"isValid":{"path":"libs_sh/builtins.lua#L1127","returns":[{"type":"boolean","value":"boolean If it is valid","description":"If it is valid"}],"realm":"shared","params":[{"type":"any","value":"any object Table to check","name":"object","description":"Table to check"}],"class":"function","name":"isValid","description":" Returns if the table has an isValid function and isValid returns true."},"getScripts":{"path":"libs_sh/builtins.lua#L727","returns":[{"type":"table","value":"table Table where keys are paths and values are strings","description":"Table where keys are paths and values are strings"},{"type":"table?","value":"table? Table where keys are paths and values are functions, or nil if another chip was specified","description":"Table where keys are paths and values are functions, or nil if another chip was specified"}],"realm":"shared","params":[{"type":"Entity?","value":"Entity? ent Optional target entity. Default: chip()","name":"ent","description":"Optional target entity. Default: chip()"}],"class":"function","name":"getScripts","description":" Returns the source code of and compiled functions for the scripts used by the chip."},"rawset":{"path":"libs_sh/builtins.lua#L432","realm":"shared","params":[{"type":"table","value":"table tbl The table to modify","name":"tbl","description":"The table to modify"},{"type":"any","value":"any key The index of the table","name":"key","description":"The index of the table"},{"type":"any","value":"any value The value to set the index equal to","name":"value","description":"The value to set the index equal to"}],"class":"function","name":"rawset","description":" Set the value of a table index without invoking a metamethod"},"Vector":{"path":"libs_sh/vectors.lua#L43","returns":[{"type":"Vector","value":"Vector Vector","description":"Vector"}],"realm":"shared","params":[{"type":"number?","value":"number? x X value","name":"x","description":"X value"},{"type":"number?","value":"number? y Y value","name":"y","description":"Y value"},{"type":"number?","value":"number? z Z value","name":"z","description":"Z value"}],"class":"function","name":"Vector","description":" Creates a Vector struct."},"setUserdata":{"path":"libs_sh/builtins.lua#L590","realm":"server","params":[{"type":"string","value":"string str String data","name":"str","description":"String data"}],"class":"function","name":"setUserdata","description":" Sets the chip's userdata that the duplicator tool saves. max 1MiB; can be changed with convar sf_userdata_max"},"setClipboardText":{"path":"libs_sh/builtins.lua#L631","realm":"client","params":[{"type":"string","value":"string txt Text to set to the clipboard","name":"txt","description":"Text to set to the clipboard"}],"class":"function","name":"setClipboardText","description":" Sets clipboard text. Only works on the owner of the chip."},"cpuAverage":{"path":"libs_sh/builtins.lua#L243","returns":[{"type":"number","value":"number Average CPU Time of the buffer.","description":"Average CPU Time of the buffer."}],"realm":"shared","class":"function","name":"cpuAverage","description":" Gets the Average CPU Time in the buffer"},"setAuthor":{"path":"libs_sh/builtins.lua#L620","realm":"client","params":[{"type":"string","value":"string author Author to set the chip's author to","name":"author","description":"Author to set the chip's author to"}],"class":"function","name":"setAuthor","description":" Sets the chip's display author"},"next":{"path":"libs_sh/builtins.lua#L141","returns":[{"type":"any","value":"any Key or nil","description":"Key or nil"},{"type":"any","value":"any Value or nil","description":"Value or nil"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to get the next key-value pair of","name":"tbl","description":"Table to get the next key-value pair of"},{"type":"any","value":"any k Previous key (can be nil)","name":"k","description":"Previous key (can be nil)"}],"class":"function","name":"next","description":" Returns the next key and value pair in a table."},"requiredir":{"path":"libs_sh/builtins.lua#L770","returns":[{"type":"table","value":"table Table of return values of the scripts","description":"Table of return values of the scripts"}],"realm":"shared","params":[{"type":"string","value":"string path The directory to include. Make sure to --@includedir it","name":"path","description":"The directory to include. Make sure to --@includedir it"},{"type":"table","value":"table loadpriority Table of files that should be loaded before any others in the directory","name":"loadpriority","description":"Table of files that should be loaded before any others in the directory"}],"class":"function","name":"requiredir","description":" Runs all included scripts in a directory and caches the results.\n The path must be an actual path, including the file extension and using slashes for directory separators instead of periods."},"sendPermissionRequest":{"path":"libs_sh/builtins.lua#L370","realm":"client","class":"function","name":"sendPermissionRequest","description":" Opens the permission request dialogue if the player is connected to HUD. setupPermissionRequest must be called first"},"setName":{"path":"libs_sh/builtins.lua#L609","realm":"client","params":[{"type":"string","value":"string name Name to set the chip's name to","name":"name","description":"Name to set the chip's name to"}],"class":"function","name":"setName","description":" Sets the chip's display name"},"type":{"path":"libs_sh/builtins.lua#L132","returns":[{"type":"string","value":"string The name of the object's type.","description":"The name of the object's type."}],"realm":"shared","params":[{"type":"any","value":"any obj Object to get type of","name":"obj","description":"Object to get type of"}],"class":"function","name":"type","description":" Returns a string representing the name of the type of the passed object."},"eyePos":{"path":"libs_sh/builtins.lua#L701","returns":[{"type":"Vector","value":"Vector The local player's camera position","description":"The local player's camera position"}],"realm":"client","class":"function","name":"eyePos","description":" Returns the local player's camera position"},"isnumber":{"path":"libs_sh/builtins.lua#L167","returns":[{"type":"boolean","value":"boolean If the object is a number or not","description":"If the object is a number or not"}],"realm":"shared","params":[{"type":"any","value":"any x Input to check","name":"x","description":"Input to check"}],"class":"function","name":"isnumber","description":" Returns if the given input is a number"},"Matrix":{"path":"libs_sh/vmatrix.lua#L25","returns":[{"type":"VMatrix","value":"VMatrix New VMatrix","description":"New VMatrix"}],"realm":"shared","params":[{"type":"table|Angle|nil","value":"table|Angle|nil t Optional data or rotation angle to initialize the Matrix with.","name":"t","description":"Optional data or rotation angle to initialize the Matrix with."},{"type":"Vector?","value":"Vector? v Optional translation to initialize the Matrix with.","name":"v","description":"Optional translation to initialize the Matrix with."}],"class":"function","name":"Matrix","description":" Returns a new VMatrix"},"permissionRequestSatisfied":{"path":"libs_sh/builtins.lua#L362","returns":[{"type":"boolean","value":"boolean Whether the client gave all permissions specified in last request or not.","description":"Whether the client gave all permissions specified in last request or not."}],"realm":"client","class":"function","name":"permissionRequestSatisfied","description":" Is permission request fully satisfied."},"shareScripts":{"path":"libs_sh/builtins.lua#L751","realm":"shared","params":[{"type":"boolean","value":"boolean enable If true, allow sharing scripts","name":"enable","description":"If true, allow sharing scripts"}],"class":"function","name":"shareScripts","description":" Sets the chip to allow other chips to view its sources"},"ramAverage":{"path":"libs_sh/builtins.lua#L255","returns":[{"type":"number","value":"number The ram used in kilobytes","description":"The ram used in kilobytes"}],"realm":"shared","class":"function","name":"ramAverage","description":" Gets the moving average of ram usage of the gmod lua environment"},"xpcall":{"path":"libs_sh/builtins.lua#L1053","returns":[{"type":"boolean","value":"boolean Status of the execution; true for success, false for failure.","description":"Status of the execution; true for success, false for failure."},{"type":"...","value":"... The returns of the first function if execution succeeded, otherwise the return values of the error callback.","description":"The returns of the first function if execution succeeded, otherwise the return values of the error callback."}],"realm":"shared","params":[{"type":"function","value":"function func The function to call initially.","name":"func","description":"The function to call initially."},{"type":"function","value":"function callback The function to be called if execution of the first fails; the error message and stack trace are passed.","name":"callback","description":"The function to be called if execution of the first fails; the error message and stack trace are passed."},{"type":"...","value":"... passArgs Varargs to pass to the initial function.","name":"passArgs","description":"Varargs to pass to the initial function."}],"class":"function","name":"xpcall","description":" Lua's xpcall with SF throw implementation, and a traceback for debugging.\n Attempts to call the first function. If the execution succeeds, this returns true followed by the returns of the function.\n If execution fails, this returns false and the second function is called with the error message, and the stack trace."},"isbool":{"path":"libs_sh/builtins.lua#L188","returns":[{"type":"boolean","value":"boolean If the object is a boolean or not","description":"If the object is a boolean or not"}],"realm":"shared","params":[{"type":"any","value":"any x Input to check","name":"x","description":"Input to check"}],"class":"function","name":"isbool","description":" Returns if the given input is a boolean"},"restart":{"path":"libs_sh/builtins.lua#L1197","realm":"shared","params":[{"type":"Entity?","value":"Entity? chip The chip to restart. If nil, it will restart the current chip.","name":"chip","description":"The chip to restart. If nil, it will restart the current chip."}],"class":"function","name":"restart","description":" Restarts a chip owned by yourself.\n Only restarts the realm that this gets called in."},"WebSocket":{"path":"libs_cl/websocket.lua#L112","returns":[{"type":"WebSocket","value":"WebSocket The websocket object. Use WebSocket:connect() to connect.","description":"The websocket object. Use WebSocket:connect() to connect."}],"realm":"client","params":[{"type":"string","value":"string domain Domain of the websocket server.","name":"domain","description":"Domain of the websocket server."},{"type":"number?","value":"number? port Port of the websocket server. (Default 443)","name":"port","description":"Port of the websocket server. (Default 443)"},{"type":"boolean?","value":"boolean? secure Whether to use secure connection (wss). (Default false)","name":"secure","description":"Whether to use secure connection (wss). (Default false)"},{"type":"string?","value":"string? path Optional path of the websocket.","name":"path","description":"Optional path of the websocket."}],"class":"function","name":"WebSocket","description":" Creates a new websocket object.\n Add onMessage, onConnected, onDisconnected functions for callbacks.\n Also see the websocket example."},"class":{"path":"libs_sh/builtins.lua#L1221","realm":"shared","params":[{"type":"string","value":"string name The string name of the class","name":"name","description":"The string name of the class"},{"type":"table?","value":"table? super The (optional) parent class to inherit from","name":"super","description":"The (optional) parent class to inherit from"}],"class":"function","name":"class","description":" Creates a 'middleclass' class object that can be used similarly to Java/C++ classes. See https://github.com/kikito/middleclass for examples."},"enableHud":{"path":"libs_sh/builtins.lua#L1177","realm":"shared","params":[{"type":"Player","value":"Player ply The player to enable the hud on. If CLIENT, will be forced to player()","name":"ply","description":"The player to enable the hud on. If CLIENT, will be forced to player()"},{"type":"boolean","value":"boolean active Whether hud hooks should be active. true to force on, false to force off.","name":"active","description":"Whether hud hooks should be active. true to force on, false to force off."}],"class":"function","name":"enableHud","description":" Sets the current instance to allow HUD drawing. Only works if player is in your vehicle or\n if it's ran on yourself or if the player is connected to your hud and you want to disconnect them"},"chip":{"path":"libs_sh/builtins.lua#L57","returns":[{"type":"Entity","value":"Entity Starfall chip entity","description":"Starfall chip entity"}],"realm":"shared","class":"function","name":"chip","description":" Returns the entity representing a processor that this script is running on."},"worldToLocal":{"path":"libs_sh/builtins.lua#L1139","returns":[{"type":"Vector","value":"Vector localPos","description":"localPos"},{"type":"Angle","value":"Angle localAngles","description":"localAngles"}],"realm":"shared","params":[{"type":"Vector","value":"Vector pos The position that should be translated from the current to the new system","name":"pos","description":"The position that should be translated from the current to the new system"},{"type":"Angle","value":"Angle ang The angles that should be translated from the current to the new system","name":"ang","description":"The angles that should be translated from the current to the new system"},{"type":"Vector","value":"Vector newSystemOrigin The origin of the system to translate to","name":"newSystemOrigin","description":"The origin of the system to translate to"},{"type":"Angle","value":"Angle newSystemAngles The angles of the system to translate to","name":"newSystemAngles","description":"The angles of the system to translate to"}],"class":"function","name":"worldToLocal","description":" Translates the specified position and angle into the specified coordinate system"},"dodir":{"path":"libs_sh/builtins.lua#L825","returns":[{"type":"table","value":"table Table of return values of the scripts","description":"Table of return values of the scripts"}],"realm":"shared","params":[{"type":"string","value":"string path The directory to include. Make sure to --@includedir it","name":"path","description":"The directory to include. Make sure to --@includedir it"},{"type":"table","value":"table loadpriority Table of files that should be loaded before any others in the directory","name":"loadpriority","description":"Table of files that should be loaded before any others in the directory"}],"class":"function","name":"dodir","description":" Runs all included scripts in directory, but does not cache the result."},"error":{"path":"libs_sh/builtins.lua#L1110","realm":"shared","params":[{"type":"string","value":"string msg Message string","name":"msg","description":"Message string"},{"type":"number?","value":"number? level Which level in the stacktrace to blame. Defaults to 1. 0 for no stacktrace.","name":"level","description":"Which level in the stacktrace to blame. Defaults to 1. 0 for no stacktrace."}],"class":"function","name":"error","description":" Throws an error. Similar to 'throw' but throws whatever you want instead of an SF Error."},"try":{"path":"libs_sh/builtins.lua#L1081","realm":"shared","params":[{"type":"function","value":"function func Function to execute","name":"func","description":"Function to execute"},{"type":"function?","value":"function? catch Optional function to execute in case func fails","name":"catch","description":"Optional function to execute in case func fails"}],"class":"function","name":"try","description":" Try to execute a function and catch possible exceptions\n Similar to xpcall, but a bit more in-depth"},"Color":{"path":"libs_sh/color.lua#L64","returns":[{"type":"Color","value":"Color New color","description":"New color"}],"realm":"shared","params":[{"name":"number","description":"|string? r Red component or string hexadecimal color. Defaults to 255."},{"type":"number?","value":"number? g Green component. Defaults to 255.","name":"g","description":"Green component. Defaults to 255."},{"type":"number?","value":"number? b Blue component. Defaults to 255.","name":"b","description":"Blue component. Defaults to 255."},{"type":"number?","value":"number? a Alpha component. Defaults to 255.","name":"a","description":"Alpha component. Defaults to 255."}],"class":"function","name":"Color","description":" Creates a table struct that resembles a Color"},"loadstring":{"path":"libs_sh/builtins.lua#L872","returns":[{"type":"function?","value":"function? Compiled function, or nil if failed to compile","description":"Compiled function, or nil if failed to compile"},{"type":"string?","value":"string? Error string, or nil if successfully compiled","description":"Error string, or nil if successfully compiled"}],"realm":"shared","params":[{"type":"string","value":"string code String to compile","name":"code","description":"String to compile"},{"type":"string?","value":"string? identifier Name of compiled function","name":"identifier","description":"Name of compiled function"},{"type":"table?","value":"table? env Environment of compiled function","name":"env","description":"Environment of compiled function"}],"class":"function","name":"loadstring","description":" Like Lua 5.2 or LuaJIT's load/loadstring, except it has no mode parameter and, of course, the resulting function is in your instance's environment by default.\n For compatibility with older versions of Starfall, loadstring is NOT an alias of this function like it is in vanilla Lua 5.2/LuaJIT."},"getMethods":{"path":"libs_sh/builtins.lua#L944","returns":[{"type":"table","value":"table Table of the type's methods which can be edited or iterated","description":"Table of the type's methods which can be edited or iterated"}],"realm":"shared","params":[{"type":"string","value":"string sfType Name of SF type","name":"sfType","description":"Name of SF type"}],"class":"function","name":"getMethods","description":" Gets an SF type's methods table"},"Angle":{"path":"libs_sh/angles.lua#L33","returns":[{"type":"Angle","value":"Angle Angle struct","description":"Angle struct"}],"realm":"shared","params":[{"type":"number?","value":"number? p Pitch","name":"p","description":"Pitch"},{"type":"number?","value":"number? y Yaw","name":"y","description":"Yaw"},{"type":"number?","value":"number? r Roll","name":"r","description":"Roll"}],"class":"function","name":"Angle","description":" Creates an Angle struct."},"concmd":{"path":"libs_sh/builtins.lua#L579","realm":"shared","params":[{"type":"string","value":"string cmd Command to execute","name":"cmd","description":"Command to execute"}],"class":"function","name":"concmd","description":" Execute a console command"},"getfenv":{"path":"libs_sh/builtins.lua#L925","returns":[{"type":"table?","value":"table? Environment table (or nil, if restricted)","description":"Environment table (or nil, if restricted)"}],"realm":"shared","params":[{"type":"function|number","value":"function|number funcOrStackLevel Function or stack level to get the environment of","name":"funcOrStackLevel","description":"Function or stack level to get the environment of"}],"class":"function","name":"getfenv","description":" Lua's getfenv\n Returns the environment of either the stack level or the function specified.\n Note that this function will return nil if the return value would be anything other than builtins_library or an environment you have passed to setfenv."},"eyeVector":{"path":"libs_sh/builtins.lua#L708","returns":[{"type":"Vector","value":"Vector The local player's camera forward vector","description":"The local player's camera forward vector"}],"realm":"client","class":"function","name":"eyeVector","description":" Returns the local player's camera forward vector"},"setfenv":{"path":"libs_sh/builtins.lua#L904","returns":[{"type":"function","value":"function Function with environment set to tbl","description":"Function with environment set to tbl"}],"realm":"shared","params":[{"type":"function|number","value":"function|number funcOrStackLevel Function or stack level to set the environment of","name":"funcOrStackLevel","description":"Function or stack level to set the environment of"},{"type":"table","value":"table tbl New environment","name":"tbl","description":"New environment"}],"class":"function","name":"setfenv","description":" Lua's setfenv\n Sets the environment of either the stack level or the function specified.\n Note that this function will throw an error if you try to use it on anything outside of your sandbox."},"pairs":{"path":"libs_sh/builtins.lua#L123","returns":[{"type":"function","value":"function Iterator function","description":"Iterator function"},{"type":"table","value":"table Table being iterated over","description":"Table being iterated over"},{"type":"any","value":"any Nil as current index (for the constructor)","description":"Nil as current index (for the constructor)"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to iterate over","name":"tbl","description":"Table to iterate over"}],"class":"function","name":"pairs","description":" Returns an iterator function for a for loop that will return the values of the specified table in an arbitrary order."},"getLibraries":{"path":"libs_sh/builtins.lua#L426","returns":[{"type":"table","value":"table Table where each key is the library name and value is table of the library","description":"Table where each key is the library name and value is table of the library"}],"realm":"shared","class":"function","name":"getLibraries","description":" Gets all libraries"},"printHud":{"path":"libs_sh/builtins.lua#L552","realm":"shared","params":[{"type":"Player","value":"Player ply The target player. If in CLIENT, then ply is the client player and this param is omitted","name":"ply","description":"The target player. If in CLIENT, then ply is the client player and this param is omitted"},{"type":"...","value":"... printArgs Values to print. Colors before text will set the text color","name":"printArgs","description":"Values to print. Colors before text will set the text color"}],"class":"function","name":"printHud","description":" Prints a message to a target player's chat as long as they're connected to a hud."},"isstring":{"path":"libs_sh/builtins.lua#L174","returns":[{"type":"boolean","value":"boolean If the object is a string or not","description":"If the object is a string or not"}],"realm":"shared","params":[{"type":"any","value":"any x Input to check","name":"x","description":"Input to check"}],"class":"function","name":"isstring","description":" Returns if the given input is a string"},"player":{"path":"libs_sh/builtins.lua#L70","returns":[{"type":"Player","value":"Player Returns player with given UserID or if none specified then returns either the owner (server) or the local player (client)","description":"Returns player with given UserID or if none specified then returns either the owner (server) or the local player (client)"}],"realm":"shared","params":[{"type":"number?","value":"number? num UserID to get the player with.","name":"num","description":"UserID to get the player with."}],"class":"function","name":"player","description":" Same as owner() on the server. On the client, returns the local player"},"crc":{"path":"libs_sh/builtins.lua#L212","returns":[{"type":"string","value":"string The unsigned 32 bit checksum as a string","description":"The unsigned 32 bit checksum as a string"}],"realm":"shared","params":[{"type":"string","value":"string stringToHash The string to calculate the checksum of","name":"stringToHash","description":"The string to calculate the checksum of"}],"class":"function","name":"crc","description":" Generates the CRC checksum of the specified string. (https://en.wikipedia.org/wiki/Cyclic_redundancy_check)"},"cpuMax":{"path":"libs_sh/builtins.lua#L297","returns":[{"type":"number","value":"number Max SysTime allowed to take for execution of the chip in a Think.","description":"Max SysTime allowed to take for execution of the chip in a Think."}],"realm":"shared","class":"function","name":"cpuMax","description":" Gets the CPU Time max.\n CPU Time is stored in a buffer of N elements, if the average of this exceeds cpuMax, the chip will error."},"dofile":{"path":"libs_sh/builtins.lua#L812","returns":[{"type":"...","value":"... Return value(s) of the script","description":"Return value(s) of the script"}],"realm":"shared","params":[{"type":"string","value":"string path The file path to include. Make sure to --@include it","name":"path","description":"The file path to include. Make sure to --@include it"}],"class":"function","name":"dofile","description":" Runs an included script, but does not cache the result.\n Pretty much like standard Lua dofile()"},"printConsole":{"path":"libs_sh/builtins.lua#L543","realm":"shared","params":[{"type":"...","value":"... printArgs Values to print. Colors before text will set the text color","name":"printArgs","description":"Values to print. Colors before text will set the text color"}],"class":"function","name":"printConsole","description":" Prints a message to the player's console."},"printTable":{"path":"libs_sh/builtins.lua#L572","realm":"shared","params":[{"type":"table","value":"table tbl Table to print","name":"tbl","description":"Table to print"}],"class":"function","name":"printTable","description":" Prints a table to player's chat"},"getmetatable":{"path":"libs_sh/builtins.lua#L202","returns":[{"type":"table?","value":"table? The metatable of tbl","description":"The metatable of tbl"}],"realm":"shared","params":[{"type":"any","value":"any tbl Table to get metatable of","name":"tbl","description":"Table to get metatable of"}],"class":"function","name":"getmetatable","description":" Returns the metatable of an object or nil.\n Doesn't work on most internal metatables.\n For any types other than table, nil will be returned."},"ramMax":{"path":"libs_sh/builtins.lua#L261","returns":[{"type":"number","value":"number The max ram usage in kilobytes","description":"The max ram usage in kilobytes"}],"realm":"shared","class":"function","name":"ramMax","description":" Gets the max allowed ram usage of the gmod lua environment"},"unpack":{"path":"libs_sh/builtins.lua#L150","returns":[{"type":"...","value":"... Elements of tbl","description":"Elements of tbl"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to get elements out of","name":"tbl","description":"Table to get elements out of"},{"type":"number?","value":"number? startIndex Which index to start from (default 1)","name":"startIndex","description":"Which index to start from (default 1)"},{"type":"number?","value":"number? endIndex Which index to end at (default #tbl)","name":"endIndex","description":"Which index to end at (default #tbl)"}],"class":"function","name":"unpack","description":" This function takes a numeric indexed table and return all the members as a vararg."},"Vector2":{"path":"libs_sv/wire.lua#L163","returns":[{"type":"Vector2","value":"Vector2 Vector2","description":"Vector2"}],"realm":"server","params":[{"type":"number?","value":"number? x X value","name":"x","description":"X value"},{"type":"number?","value":"number? y Y value","name":"y","description":"Y value"}],"class":"function","name":"Vector2","description":" Creates a Vector2 struct for use with wire xv2 type"},"istable":{"path":"libs_sh/builtins.lua#L181","returns":[{"type":"boolean","value":"boolean If the object is a table or not","description":"If the object is a table or not"}],"realm":"shared","params":[{"type":"any","value":"any x Input to check","name":"x","description":"Input to check"}],"class":"function","name":"istable","description":" Returns if the given input is a table"},"owner":{"path":"libs_sh/builtins.lua#L63","returns":[{"type":"Player","value":"Player Owner of the chip","description":"Owner of the chip"}],"realm":"shared","class":"function","name":"owner","description":" Returns whoever created the chip"},"entity":{"path":"libs_sh/builtins.lua#L83","returns":[{"type":"Entity","value":"Entity Entity at the index","description":"Entity at the index"}],"realm":"shared","params":[{"type":"number","value":"number num Entity index","name":"num","description":"Entity index"}],"class":"function","name":"entity","description":" Returns the entity with index 'num'"},"hasPermission":{"path":"libs_sh/builtins.lua#L311","returns":[{"type":"boolean","value":"boolean Whether the client has granted the specified permission.","description":"Whether the client has granted the specified permission."},{"type":"string","value":"string The reason the permission check failed","description":"The reason the permission check failed"}],"realm":"shared","params":[{"type":"string","value":"string perm The permission id to check","name":"perm","description":"The permission id to check"},{"type":"any","value":"any obj Optional object to pass to the permission system.","name":"obj","description":"Optional object to pass to the permission system."}],"class":"function","name":"hasPermission","description":" Checks if the chip is capable of performing an action."},"cpuTotalAverage":{"path":"libs_sh/builtins.lua#L287","returns":[{"type":"number","value":"number Total average CPU Time of all your chips.","description":"Total average CPU Time of all your chips."}],"realm":"shared","class":"function","name":"cpuTotalAverage","description":" Returns the total average time for all chips by the player."},"setupPermissionRequest":{"path":"libs_sh/builtins.lua#L329","realm":"client","params":[{"type":"table","value":"table perms Table of overridable permissions' names.","name":"perms","description":"Table of overridable permissions' names."},{"type":"string","value":"string desc Description attached to request.","name":"desc","description":"Description attached to request."},{"type":"boolean","value":"boolean showOnUse Whether request will popup when player uses chip or linked screen.","name":"showOnUse","description":"Whether request will popup when player uses chip or linked screen."}],"class":"function","name":"setupPermissionRequest","description":" Setups request for overriding permissions."},"cpuTotalUsed":{"path":"libs_sh/builtins.lua#L277","returns":[{"type":"number","value":"number Total used CPU time of all your chips.","description":"Total used CPU time of all your chips."}],"realm":"shared","class":"function","name":"cpuTotalUsed","description":" Returns the total used time for all chips by the player."},"setmetatable":{"path":"libs_sh/builtins.lua#L159","returns":[{"type":"table","value":"table tbl with metatable set to meta","description":"tbl with metatable set to meta"}],"realm":"shared","params":[{"type":"table","value":"table tbl The table to set the metatable of","name":"tbl","description":"The table to set the metatable of"},{"type":"table","value":"table meta The metatable to use","name":"meta","description":"The metatable to use"}],"class":"function","name":"setmetatable","description":" Sets, changes or removes a table's metatable. Doesn't work on most internal metatables"},"select":{"path":"libs_sh/builtins.lua#L92","returns":[{"type":"any","value":"any Returns a number or vararg, depending on the select method.","description":"Returns a number or vararg, depending on the select method."}],"realm":"shared","params":[{"type":"any","value":"any parameter","name":"parameter","description":""},{"type":"...","value":"... vararg Args to select from","name":"vararg","description":"Args to select from"}],"class":"function","name":"select","description":" Used to select single values from a vararg or get the count of values in it."},"setSoftQuota":{"path":"libs_sh/builtins.lua#L304","realm":"shared","params":[{"type":"number","value":"number quota The threshold where the soft error will be thrown. Ratio of current cpu to the max cpu usage. 0.5 is 50%","name":"quota","description":"The threshold where the soft error will be thrown. Ratio of current cpu to the max cpu usage. 0.5 is 50%"}],"class":"function","name":"setSoftQuota","description":" Sets a soft cpu quota which will trigger a catchable error if the cpu goes over a certain amount."},"getUserdata":{"path":"libs_sh/builtins.lua#L602","returns":[{"type":"string","value":"string String data","description":"String data"}],"realm":"server","class":"function","name":"getUserdata","description":" Gets the chip's userdata that the duplicator tool loads"},"require":{"path":"libs_sh/builtins.lua#L757","returns":[{"type":"any","value":"any Return value of the script","description":"Return value of the script"}],"realm":"shared","params":[{"type":"string","value":"string path The file path to include. Make sure to --@include it","name":"path","description":"The file path to include. Make sure to --@include it"}],"class":"function","name":"require","description":" Runs an included script and caches the result.\n The path must be an actual path, including the file extension and using slashes for directory separators instead of periods."},"eyeAngles":{"path":"libs_sh/builtins.lua#L694","returns":[{"type":"Angle","value":"Angle The local player's camera angles","description":"The local player's camera angles"}],"realm":"client","class":"function","name":"eyeAngles","description":" Returns the local player's camera angles"},"printMessage":{"path":"libs_sh/builtins.lua#L640","realm":"client","params":[{"type":"number","value":"number mtype How the message should be displayed. See http://wiki.facepunch.com/gmod/Enums/HUD","name":"mtype","description":"How the message should be displayed. See http://wiki.facepunch.com/gmod/Enums/HUD"},{"type":"string","value":"string text The message text.","name":"text","description":"The message text."}],"class":"function","name":"printMessage","description":" Prints a message to your chat, console, or the center of your screen."}},"tables":{"FSASYNC":{"path":"libs_sh/enum.lua#L1188","fields":[{"name":"ERR_NOT_MINE","description":""},{"name":"ERR_RETRY_LATER","description":""},{"name":"ERR_ALIGNMENT","description":""},{"name":"ERR_FAILURE","description":""},{"name":"ERR_READING","description":""},{"name":"ERR_NOMEMORY","description":""},{"name":"ERR_UNKNOWNID","description":""},{"name":"ERR_FILEOPEN","description":""},{"name":"OK","description":""},{"name":"STATUS_PENDING","description":""},{"name":"STATUS_INPROGRESS","description":""},{"name":"STATUS_ABORTED","description":""},{"name":"STATUS_UNSERVICED","description":""}],"realm":"shared","class":"table","name":"FSASYNC","description":" file.asyncRead ENUMs"},"TEXT_ALIGN":{"path":"libs_sh/enum.lua#L22","fields":[{"name":"LEFT","description":"Align the text on the left"},{"name":"CENTER","description":"Align the text in center"},{"name":"RIGHT","description":"Align the text on the right"},{"name":"TOP","description":"Align the text on the top"},{"name":"BOTTOM","description":"Align the text on the bottom"}],"realm":"shared","class":"table","name":"TEXT_ALIGN","description":" Align enum for drawing text"},"FSOLID":{"path":"libs_sh/enum.lua#L652","fields":[{"name":"CUSTOMRAYTEST","description":""},{"name":"CUSTOMBOXTEST","description":""},{"name":"NOT_SOLID","description":""},{"name":"TRIGGER","description":""},{"name":"NOT_STANDABLE","description":""},{"name":"VOLUME_CONTENTS","description":""},{"name":"FORCE_WORLD_ALIGNED","description":""},{"name":"USE_TRIGGER_BOUNDS","description":""},{"name":"ROOT_PARENT_ALIGNED","description":""},{"name":"TRIGGER_TOUCH_DEBRIS","description":""}],"realm":"shared","class":"table","name":"FSOLID","description":" ENUMs of solid flags for use with entity:getSolidFlags"},"RENDERGROUP":{"path":"libs_sh/enum.lua#L1028","fields":[{"name":"STATIC_HUGE","description":""},{"name":"OPAQUE_HUGE","description":""},{"name":"STATIC","description":""},{"name":"OPAQUE","description":""},{"name":"TRANSLUCENT","description":""},{"name":"BOTH","description":""},{"name":"VIEWMODEL","description":""},{"name":"VIEWMODEL_TRANSLUCENT","description":""},{"name":"OPAQUE_BRUSH","description":""},{"name":"OTHER","description":""}],"realm":"shared","class":"table","name":"RENDERGROUP","description":" ENUMs of entity rendergroups"},"BOX":{"path":"libs_sh/enum.lua#L868","fields":[{"name":"FRONT","description":""},{"name":"BACK","description":""},{"name":"RIGHT","description":""},{"name":"LEFT","description":""},{"name":"TOP","description":""},{"name":"BOTTOM","description":""}],"realm":"shared","class":"table","name":"BOX","description":" ENUMs used by render.SetModelLighting"},"EF":{"path":"libs_sh/enum.lua#L400","fields":[{"name":"BONEMERGE","description":""},{"name":"BONEMERGE_FASTCULL","description":""},{"name":"BRIGHTLIGHT","description":""},{"name":"DIMLIGHT","description":""},{"name":"NOINTERP","description":""},{"name":"NOSHADOW","description":""},{"name":"NODRAW","description":""},{"name":"NORECEIVESHADOW","description":""},{"name":"ITEM_BLINK","description":""},{"name":"PARENT_ANIMATES","description":""},{"name":"FOLLOWBONE","description":""}],"realm":"shared","class":"table","name":"EF","description":" ENUMs of ef for use with hologram:addEffects hologram:removeEffects entity:isEffectActive"},"FVPHYSICS":{"path":"libs_sh/enum.lua#L428","fields":[{"name":"CONSTRAINT_STATIC","description":""},{"name":"DMG_DISSOLVE","description":""},{"name":"DMG_SLICE","description":""},{"name":"HEAVY_OBJECT","description":""},{"name":"MULTIOBJECT_ENTITY","description":""},{"name":"NO_IMPACT_DMG","description":""},{"name":"NO_NPC_IMPACT_DMG","description":""},{"name":"NO_PLAYER_PICKUP","description":""},{"name":"NO_SELF_COLLISIONS","description":""},{"name":"PART_OF_RAGDOLL","description":""},{"name":"PENETRATING","description":""},{"name":"PLAYER_HELD","description":""},{"name":"WAS_THROWN","description":""}],"realm":"shared","class":"table","name":"FVPHYSICS","description":" ENUMs of physics object flags"},"DAMAGE":{"path":"libs_sh/enum.lua#L1340","fields":[{"name":"GENERIC","description":""},{"name":"CRUSH","description":""},{"name":"BULLET","description":""},{"name":"SLASH","description":""},{"name":"BURN","description":""},{"name":"VEHICLE","description":""},{"name":"FALL","description":""},{"name":"BLAST","description":""},{"name":"CLUB","description":""},{"name":"SHOCK","description":""},{"name":"SONIC","description":""},{"name":"ENERGYBEAM","description":""},{"name":"PREVENTPHYSICSFORCE","description":""},{"name":"NEVERGIB","description":""},{"name":"ALWAYSGIB","description":""},{"name":"DROWN","description":""},{"name":"PARALYZE","description":""},{"name":"NERVEGAS","description":""},{"name":"POISON","description":""},{"name":"RADIATION","description":""},{"name":"DROWNRECOVER","description":""},{"name":"ACID","description":""},{"name":"SLOWBURN","description":""},{"name":"REMOVENORAGDOLL","description":""},{"name":"PHYSGUN","description":""},{"name":"PLASMA","description":""},{"name":"AIRBOAT","description":""},{"name":"DISSOLVE","description":""},{"name":"BLASTSURFACE","description":""},{"name":"DIRECT","description":""},{"name":"BUCKSHOT","description":""},{"name":"SNIPER","description":""},{"name":"MISSILEDEFENSE","description":""}],"realm":"shared","class":"table","name":"DAMAGE","description":" ENUMs used for anything that returns a damage type."},"PATTACH":{"path":"libs_sh/enum.lua#L382","fields":[{"name":"ABSORIGIN","description":""},{"name":"ABSORIGIN_FOLLOW","description":""},{"name":"CUSTOMORIGIN","description":""},{"name":"POINT","description":""},{"name":"POINT_FOLLOW","description":""},{"name":"WORLDORIGIN","description":""}],"realm":"shared","class":"table","name":"PATTACH","description":" PATTACH enum for particle library"},"COLLISION_GROUP":{"path":"libs_sh/enum.lua#L582","fields":[{"name":"NONE","description":""},{"name":"DEBRIS","description":""},{"name":"DEBRIS_TRIGGER","description":""},{"name":"INTERACTIVE_DEBRIS","description":""},{"name":"INTERACTIVE","description":""},{"name":"PLAYER","description":""},{"name":"BREAKABLE_GLASS","description":""},{"name":"VEHICLE","description":""},{"name":"PLAYER_MOVEMENT","description":""},{"name":"NPC","description":""},{"name":"IN_VEHICLE","description":""},{"name":"WEAPON","description":""},{"name":"VEHICLE_CLIP","description":""},{"name":"PROJECTILE","description":""},{"name":"DOOR_BLOCKER","description":""},{"name":"PASSABLE_DOOR","description":""},{"name":"DISSOLVING","description":""},{"name":"PUSHAWAY","description":""},{"name":"NPC_ACTOR","description":""},{"name":"NPC_SCRIPTED","description":""},{"name":"WORLD","description":""}],"realm":"shared","class":"table","name":"COLLISION_GROUP","description":" ENUMs of collision groups for use with entity:setCollisionGroup"},"RENDERMODE":{"path":"libs_sh/enum.lua#L944","fields":[{"name":"NORMAL","description":""},{"name":"TRANSCOLOR","description":""},{"name":"TRANSTEXTURE","description":""},{"name":"GLOW","description":""},{"name":"TRANSALPHA","description":""},{"name":"TRANSADD","description":""},{"name":"ENVIROMENTAL","description":""},{"name":"TRANSADDFRAMEBLEND","description":""},{"name":"TRANSALPHADD","description":""},{"name":"WORLDGLOW","description":""},{"name":"NONE","description":""}],"realm":"shared","class":"table","name":"RENDERMODE","description":" ENUMs of entity render modes to be used with Entity.setRenderMode"},"RENDERFX":{"path":"libs_sh/enum.lua#L972","fields":[{"name":"NONE","description":""},{"name":"PULSESLOW","description":""},{"name":"PULSEFAST","description":""},{"name":"PULSESLOWWIDE","description":""},{"name":"PULSEFASTWIDE","description":""},{"name":"FADESLOW","description":""},{"name":"FADEFAST","description":""},{"name":"SOLIDSLOW","description":""},{"name":"SOLIDFAST","description":""},{"name":"STROBESLOW","description":""},{"name":"STROBEFAST","description":""},{"name":"STROBEFASTER","description":""},{"name":"FLICKERSLOW","description":""},{"name":"FLICKERFAST","description":""},{"name":"NODISSIPATION","description":""},{"name":"DISTORT","description":""},{"name":"HOLOGRAM","description":""},{"name":"EXPLODE","description":""},{"name":"GLOWSHELL","description":""},{"name":"CLAMPMINSCALE","description":""},{"name":"RAIN","description":""},{"name":"SNOW","description":""},{"name":"SPOTLIGHT","description":""},{"name":"RAGDOLL","description":""},{"name":"PULSEFASTWIDER","description":""}],"realm":"shared","class":"table","name":"RENDERFX","description":" ENUMs of entity renderfx to be used with Entity.setRenderFX"},"SOLID":{"path":"libs_sh/enum.lua#L631","fields":[{"name":"NONE","description":""},{"name":"BSP","description":""},{"name":"BBOX","description":""},{"name":"OBB","description":""},{"name":"OBB_YAW","description":""},{"name":"CUSTOM","description":""},{"name":"VPHYSICS","description":""}],"realm":"shared","class":"table","name":"SOLID","description":" ENUMs of solid for use with entity:getSolid"},"CONTENTS":{"path":"libs_sh/enum.lua#L760","fields":[{"name":"CURRENT_270","description":""},{"name":"DETAIL","description":""},{"name":"IGNORE_NODRAW_OPAQUE","description":""},{"name":"BLOCKLOS","description":""},{"name":"GRATE","description":""},{"name":"CURRENT_0","description":""},{"name":"AREAPORTAL","description":""},{"name":"DEBRIS","description":""},{"name":"MONSTERCLIP","description":""},{"name":"SLIME","description":""},{"name":"WINDOW","description":""},{"name":"LADDER","description":""},{"name":"CURRENT_180","description":""},{"name":"TRANSLUCENT","description":""},{"name":"EMPTY","description":""},{"name":"TEAM2","description":""},{"name":"CURRENT_UP","description":""},{"name":"TESTFOGVOLUME","description":""},{"name":"TEAM1","description":""},{"name":"AUX","description":""},{"name":"CURRENT_DOWN","description":""},{"name":"ORIGIN","description":""},{"name":"TEAM3","description":""},{"name":"MOVEABLE","description":""},{"name":"PLAYERCLIP","description":""},{"name":"SOLID","description":""},{"name":"TEAM4","description":""},{"name":"MONSTER","description":""},{"name":"HITBOX","description":""},{"name":"CURRENT_90","description":""},{"name":"OPAQUE","description":""},{"name":"WATER","description":""}],"realm":"shared","class":"table","name":"CONTENTS","description":" ENUMs used as masks in the trace library."},"MATERIAL_FOG":{"path":"libs_sh/enum.lua#L700","fields":[{"name":"NONE","description":""},{"name":"LINEAR","description":""},{"name":"LINEAR_BELOW_FOG_Z","description":""}],"realm":"shared","class":"table","name":"MATERIAL_FOG","description":" ENUMs of fog modes to use with render.setFogMode."},"MAT":{"path":"libs_sh/enum.lua#L1112","fields":[{"name":"ANTLION","description":""},{"name":"BLOODYFLESH","description":""},{"name":"CONCRETE","description":""},{"name":"DIRT","description":""},{"name":"EGGSHELL","description":""},{"name":"FLESH","description":""},{"name":"GRATE","description":""},{"name":"ALIENFLESH","description":""},{"name":"CLIP","description":""},{"name":"SNOW","description":""},{"name":"PLASTIC","description":""},{"name":"METAL","description":""},{"name":"SAND","description":""},{"name":"FOLIAGE","description":""},{"name":"COMPUTER","description":""},{"name":"SLOSH","description":""},{"name":"TILE","description":""},{"name":"GRASS","description":""},{"name":"VENT","description":""},{"name":"WOOD","description":""},{"name":"DEFAULT","description":""},{"name":"GLASS","description":""},{"name":"WARPSHIELD","description":""}],"realm":"shared","class":"table","name":"MAT","description":" ENUMs describing surface material. Used in TraceResult"},"BLENDFUNC":{"path":"libs_sh/enum.lua#L928","fields":[{"name":"ADD","description":""},{"name":"SUBTRACT","description":""},{"name":"REVERSE_SUBTRACT","description":""},{"name":"MIN","description":""},{"name":"MAX","description":""}],"realm":"shared","class":"table","name":"BLENDFUNC","description":" ENUMs of blend modes"},"NOTIFY":{"path":"libs_sh/enum.lua#L6","fields":[{"name":"GENERIC","description":""},{"name":"ERROR","description":""},{"name":"UNDO","description":""},{"name":"HINT","description":""},{"name":"CLEANUP","description":""}],"realm":"shared","class":"table","name":"NOTIFY","description":" Notification library enums"},"GMOD_CHANNEL":{"path":"libs_sh/enum.lua#L1412","fields":[{"name":"STOPPED","description":"0"},{"name":"PLAYING","description":"1"},{"name":"PAUSED","description":"2"},{"name":"STALLED","description":"3"}],"realm":"shared","class":"table","name":"GMOD_CHANNEL","description":" ENUMs used by Bass:getState()"},"HITGROUP":{"path":"libs_sh/enum.lua#L1164","fields":[{"name":"GENERIC","description":""},{"name":"HEAD","description":""},{"name":"CHEST","description":""},{"name":"STOMACH","description":""},{"name":"LEFTARM","description":""},{"name":"RIGHTARM","description":""},{"name":"LEFTLEG","description":""},{"name":"RIGHTLEG","description":""},{"name":"GEAR","description":""}],"realm":"shared","class":"table","name":"HITGROUP","description":" Player and NPC hitgroup ENUMs"},"BLEND":{"path":"libs_sh/enum.lua#L900","fields":[{"name":"ZERO","description":""},{"name":"ONE","description":""},{"name":"DST_COLOR","description":""},{"name":"ONE_MINUS_DST_COLOR","description":""},{"name":"SRC_ALPHA","description":""},{"name":"ONE_MINUS_SRC_ALPHA","description":""},{"name":"DST_ALPHA","description":""},{"name":"ONE_MINUS_DST_ALPHA","description":""},{"name":"SRC_ALPHA_SATURATE","description":""},{"name":"SRC_COLOR","description":""},{"name":"ONE_MINUS_SRC_COLOR","description":""}],"realm":"shared","class":"table","name":"BLEND","description":" ENUMs of blend functions"},"KEY":{"path":"libs_sh/enum.lua#L38","fields":[{"name":"FIRST","description":""},{"name":"NONE","description":""},{"name":"0","description":""},{"name":"KEY0","description":""},{"name":"1","description":""},{"name":"KEY1","description":""},{"name":"2","description":""},{"name":"KEY2","description":""},{"name":"3","description":""},{"name":"KEY3","description":""},{"name":"4","description":""},{"name":"KEY4","description":""},{"name":"5","description":""},{"name":"KEY5","description":""},{"name":"6","description":""},{"name":"KEY6","description":""},{"name":"7","description":""},{"name":"KEY7","description":""},{"name":"8","description":""},{"name":"KEY8","description":""},{"name":"9","description":""},{"name":"KEY9","description":""},{"name":"A","description":""},{"name":"B","description":""},{"name":"C","description":""},{"name":"D","description":""},{"name":"E","description":""},{"name":"F","description":""},{"name":"G","description":""},{"name":"H","description":""},{"name":"I","description":""},{"name":"J","description":""},{"name":"K","description":""},{"name":"L","description":""},{"name":"M","description":""},{"name":"N","description":""},{"name":"O","description":""},{"name":"P","description":""},{"name":"Q","description":""},{"name":"R","description":""},{"name":"S","description":""},{"name":"T","description":""},{"name":"U","description":""},{"name":"V","description":""},{"name":"W","description":""},{"name":"X","description":""},{"name":"Y","description":""},{"name":"Z","description":""},{"name":"KP_INS","description":""},{"name":"PAD_0","description":""},{"name":"KP_END","description":""},{"name":"PAD_1","description":""},{"name":"KP_DOWNARROW","description":""},{"name":"PAD_2","description":""},{"name":"KP_PGDN","description":""},{"name":"PAD_3","description":""},{"name":"KP_LEFTARROW","description":""},{"name":"PAD_4","description":""},{"name":"KP_5","description":""},{"name":"PAD_5","description":""},{"name":"KP_RIGHTARROW","description":""},{"name":"PAD_6","description":""},{"name":"KP_HOME","description":""},{"name":"PAD_7","description":""},{"name":"KP_UPARROW","description":""},{"name":"PAD_8","description":""},{"name":"KP_PGUP","description":""},{"name":"PAD_9","description":""},{"name":"PAD_DIVIDE","description":""},{"name":"KP_SLASH","description":""},{"name":"KP_MULTIPLY","description":""},{"name":"PAD_MULTIPLY","description":""},{"name":"KP_MINUS","description":""},{"name":"PAD_MINUS","description":""},{"name":"KP_PLUS","description":""},{"name":"PAD_PLUS","description":""},{"name":"KP_ENTER","description":""},{"name":"PAD_ENTER","description":""},{"name":"KP_DEL","description":""},{"name":"PAD_DECIMAL","description":""},{"name":"LBRACKET","description":""},{"name":"RBRACKET","description":""},{"name":"SEMICOLON","description":""},{"name":"APOSTROPHE","description":""},{"name":"BACKQUOTE","description":""},{"name":"COMMA","description":""},{"name":"PERIOD","description":""},{"name":"SLASH","description":""},{"name":"BACKSLASH","description":""},{"name":"MINUS","description":""},{"name":"EQUAL","description":""},{"name":"ENTER","description":""},{"name":"SPACE","description":""},{"name":"BACKSPACE","description":""},{"name":"TAB","description":""},{"name":"CAPSLOCK","description":""},{"name":"NUMLOCK","description":""},{"name":"ESCAPE","description":""},{"name":"SCROLLLOCK","description":""},{"name":"INS","description":""},{"name":"INSERT","description":""},{"name":"DEL","description":""},{"name":"DELETE","description":""},{"name":"HOME","description":""},{"name":"END","description":""},{"name":"PGUP","description":""},{"name":"PAGEUP","description":""},{"name":"PGDN","description":""},{"name":"PAGEDOWN","description":""},{"name":"PAUSE","description":""},{"name":"BREAK","description":""},{"name":"SHIFT","description":""},{"name":"LSHIFT","description":""},{"name":"RSHIFT","description":""},{"name":"ALT","description":""},{"name":"LALT","description":""},{"name":"RALT","description":""},{"name":"CTRL","description":""},{"name":"LCONTROL","description":""},{"name":"RCTRL","description":""},{"name":"RCONTROL","description":""},{"name":"LWIN","description":""},{"name":"RWIN","description":""},{"name":"APP","description":""},{"name":"UPARROW","description":""},{"name":"UP","description":""},{"name":"LEFTARROW","description":""},{"name":"LEFT","description":""},{"name":"DOWNARROW","description":""},{"name":"DOWN","description":""},{"name":"RIGHTARROW","description":""},{"name":"RIGHT","description":""},{"name":"F1","description":""},{"name":"F2","description":""},{"name":"F3","description":""},{"name":"F4","description":""},{"name":"F5","description":""},{"name":"F6","description":""},{"name":"F7","description":""},{"name":"F8","description":""},{"name":"F9","description":""},{"name":"F10","description":""},{"name":"F11","description":""},{"name":"F12","description":""},{"name":"CAPSLOCKTOGGLE","description":""},{"name":"NUMLOCKTOGGLE","description":""},{"name":"SCROLLLOCKTOGGLE","description":""},{"name":"LAST","description":""},{"name":"COUNT","description":""}],"realm":"shared","class":"table","name":"KEY","description":" ENUMs of keyboard keys for use with input library"},"STENCIL":{"path":"libs_sh/enum.lua#L830","fields":[{"name":"NEVER","description":""},{"name":"LESS","description":""},{"name":"EQUAL","description":""},{"name":"LESSEQUAL","description":""},{"name":"GREATER","description":""},{"name":"NOTEQUAL","description":""},{"name":"GREATEREQUAL","description":""},{"name":"ALWAYS","description":""},{"name":"KEEP","description":""},{"name":"ZERO","description":""},{"name":"REPLACE","description":""},{"name":"INCRSAT","description":""},{"name":"DECRSAT","description":""},{"name":"INVERT","description":""},{"name":"INCR","description":""},{"name":"DECR","description":""}],"realm":"shared","class":"table","name":"STENCIL","description":" ENUMs of stencil comparisons and operations"},"MASK":{"path":"libs_sh/enum.lua#L712","fields":[{"name":"OPAQUE_AND_NPCS","description":""},{"name":"SOLID","description":""},{"name":"OPAQUE","description":""},{"name":"PLAYERSOLID_BRUSHONLY","description":""},{"name":"BLOCKLOS","description":""},{"name":"SHOT_HULL","description":""},{"name":"ALL","description":""},{"name":"VISIBLE","description":""},{"name":"NPCWORLDSTATIC","description":""},{"name":"DEADSOLID","description":""},{"name":"SPLITAREAPORTAL","description":""},{"name":"CURRENT","description":""},{"name":"BLOCKLOS_AND_NPCS","description":""},{"name":"SHOT","description":""},{"name":"NPCSOLID","description":""},{"name":"SOLID_BRUSHONLY","description":""},{"name":"VISIBLE_AND_NPCS","description":""},{"name":"NPCSOLID_BRUSHONLY","description":""},{"name":"SHOT_PORTAL","description":""},{"name":"WATER","description":""},{"name":"PLAYERSOLID","description":""}],"realm":"shared","class":"table","name":"MASK","description":" ENUMs used as trace masks in the trace library. These are simply combinations of the CONTENTS enums."},"MOVETYPE":{"path":"libs_sh/enum.lua#L460","fields":[{"name":"NONE","description":""},{"name":"ISOMETRIC","description":""},{"name":"WALK","description":""},{"name":"STEP","description":""},{"name":"FLY","description":""},{"name":"FLYGRAVITY","description":""},{"name":"VPHYSICS","description":""},{"name":"PUSH","description":""},{"name":"NOCLIP","description":""},{"name":"LADDER","description":""},{"name":"OBSERVER","description":""},{"name":"CUSTOM","description":""}],"realm":"shared","class":"table","name":"MOVETYPE","description":" ENUMs of entity move types"},"IN_KEY":{"path":"libs_sh/enum.lua#L506","fields":[{"name":"ALT1","description":""},{"name":"ALT2","description":""},{"name":"ATTACK","description":""},{"name":"ATTACK2","description":""},{"name":"BACK","description":""},{"name":"DUCK","description":""},{"name":"FORWARD","description":""},{"name":"JUMP","description":""},{"name":"LEFT","description":""},{"name":"MOVELEFT","description":""},{"name":"MOVERIGHT","description":""},{"name":"RELOAD","description":""},{"name":"RIGHT","description":""},{"name":"SCORE","description":""},{"name":"SPEED","description":""},{"name":"USE","description":""},{"name":"WALK","description":""},{"name":"ZOOM","description":""},{"name":"GRENADE1","description":""},{"name":"GRENADE2","description":""},{"name":"WEAPON1","description":""},{"name":"WEAPON2","description":""},{"name":"BULLRUSH","description":""},{"name":"CANCEL","description":""},{"name":"RUN","description":""}],"realm":"shared","class":"table","name":"IN_KEY","description":" ENUMs of in_keys for use with player:keyDown"},"TEXFILTER":{"path":"libs_sh/enum.lua#L886","fields":[{"name":"NONE","description":""},{"name":"POINT","description":""},{"name":"LINEAR","description":""},{"name":"ANISOTROPIC","description":""}],"realm":"shared","class":"table","name":"TEXFILTER","description":" ENUMs of texture filtering modes"},"SIM":{"path":"libs_sh/enum.lua#L490","fields":[{"name":"NOTHING","description":""},{"name":"LOCAL_ACCELERATION","description":""},{"name":"LOCAL_FORCE","description":""},{"name":"GLOBAL_ACCELERATION","description":""},{"name":"GLOBAL_FORCE","description":""}],"realm":"shared","class":"table","name":"SIM","description":" ENUMs used by Entity.setCustomPropForces (Entity.PhysicsSimulate internally)"},"GESTURE_SLOT":{"path":"libs_sh/enum.lua#L562","fields":[{"name":"ATTACK_AND_RELOAD","description":""},{"name":"GRENADE","description":""},{"name":"JUMP","description":""},{"name":"SWIM","description":""},{"name":"FLINCH","description":""},{"name":"VCD","description":""},{"name":"CUSTOM","description":""}],"realm":"shared","class":"table","name":"GESTURE_SLOT","description":" ENUMs of gesture_slot for use with player:playGesture player:resetGesture"},"MOUSE":{"path":"libs_sh/enum.lua#L342","fields":[{"name":"MOUSE1","description":""},{"name":"LEFT","description":""},{"name":"MOUSE2","description":""},{"name":"RIGHT","description":""},{"name":"MOUSE3","description":""},{"name":"MIDDLE","description":""},{"name":"MOUSE4","description":""},{"name":"4","description":""},{"name":"MOUSE5","description":""},{"name":"5","description":""},{"name":"MWHEELUP","description":""},{"name":"WHEEL_UP","description":""},{"name":"MWHEELDOWN","description":""},{"name":"WHEEL_DOWN","description":""},{"name":"COUNT","description":""},{"name":"FIRST","description":""},{"name":"LAST","description":""}],"realm":"shared","class":"table","name":"MOUSE","description":" ENUMs of mouse buttons for use with input library"},"MATERIAL":{"path":"libs_sh/enum.lua#L678","fields":[{"name":"LINES","description":""},{"name":"LINE_LOOP","description":""},{"name":"LINE_STRIP","description":""},{"name":"POINTS","description":""},{"name":"POLYGON","description":""},{"name":"QUADS","description":""},{"name":"TRIANGLES","description":""},{"name":"TRIANGLE_STRIP","description":""}],"realm":"shared","class":"table","name":"MATERIAL","description":" ENUMs of mesh types. To be used with mesh.generate."}},"path":"libs_sh/builtins.lua#L51","libtbl":["builtins_library"],"realm":"shared","fields":{"SERVER":{"path":"libs_sh/builtins.lua#L224","realm":"shared","class":"field","name":"SERVER","description":" Constant that denotes whether the code is executed on the server"},"CLIENT":{"path":"libs_sh/builtins.lua#L219","realm":"shared","class":"field","name":"CLIENT","description":" Constant that denotes whether the code is executed on the client"}},"class":"library","name":"builtins","description":" Built in values. These don't need to be loaded; they are in the default builtins_library."},"mesh":{"methods":{"generate":{"path":"libs_sh/mesh.lua#L1003","realm":"client","params":[{"type":"Mesh?","value":"Mesh? mesh_obj Optional Mesh object, mesh to build. (default: nil)","name":"mesh_obj","description":"Optional Mesh object, mesh to build. (default: nil)"},{"type":"number","value":"number prim_type Int, primitive type, see MATERIAL","name":"prim_type","description":"Int, primitive type, see MATERIAL"},{"type":"number","value":"number prim_count Int, the amount of primitives","name":"prim_count","description":"Int, the amount of primitives"},{"type":"function","value":"function func The function provided that will generate the mesh vertices","name":"func","description":"The function provided that will generate the mesh vertices"}],"class":"function","name":"generate","description":" Generates mesh data. If an Mesh object is passed, it will populate that mesh with the data. Otherwise, it will render directly to renderer."},"parseObj":{"path":"libs_sh/mesh.lua#L705","returns":[{"type":"table","value":"table Table of Mesh tables. The keys correspond to the objs object names, and the values are tables of vertices that can be passed to mesh.createFromTable","description":"Table of Mesh tables. The keys correspond to the objs object names, and the values are tables of vertices that can be passed to mesh.createFromTable"},{"type":"table","value":"table Table of Mesh data. {positions = positionData, normals = normalData, texturecoords = texturecoordData, faces = faceData}","description":"Table of Mesh data. {positions = positionData, normals = normalData, texturecoords = texturecoordData, faces = faceData}"}],"realm":"shared","params":[{"type":"string","value":"string obj The obj data","name":"obj","description":"The obj data"},{"type":"boolean?","value":"boolean? threaded Optional bool, use threading object that can be used to load the mesh over time to prevent hitting quota limit","name":"threaded","description":"Optional bool, use threading object that can be used to load the mesh over time to prevent hitting quota limit"},{"type":"boolean?","value":"boolean? triangulate Whether to triangulate the faces","name":"triangulate","description":"Whether to triangulate the faces"}],"class":"function","name":"parseObj","description":" Parses obj data into a table of vertices, normals, texture coordinates, colors, and tangents"},"writeNormal":{"path":"libs_sh/mesh.lua#L1063","realm":"client","params":[{"type":"Vector","value":"Vector normal Normal","name":"normal","description":"Normal"}],"class":"function","name":"writeNormal","description":" Sets the vertex normal"},"writeUV":{"path":"libs_sh/mesh.lua#L1077","realm":"client","params":[{"type":"number","value":"number stage Stage of the texture coordinate","name":"stage","description":"Stage of the texture coordinate"},{"type":"number","value":"number u U coordinate","name":"u","description":"U coordinate"},{"type":"number","value":"number v V coordinate","name":"v","description":"V coordinate"}],"class":"function","name":"writeUV","description":" Sets the vertex texture coordinates"},"getModelMeshes":{"path":"libs_sh/mesh.lua#L941","returns":[{"type":"table","value":"table A table of tables with the following format:  string material - The material of the specific mesh table triangles - A table of MeshVertex structures ready to be fed into IMesh:BuildFromTriangles table verticies - A table of MeshVertex structures representing all the vertexes of the mesh. This table is used internally to generate the \"triangles\" table. Each MeshVertex structure returned also has an extra table of tables field called \"weights\" with the following data:  number boneID - The bone this vertex is attached to number weight - How \"strong\" this vertex is attached to the bone. A vertex can be attached to multiple bones at once.","description":"A table of tables with the following format:  string material - The material of the specific mesh table triangles - A table of MeshVertex structures ready to be fed into IMesh:BuildFromTriangles table verticies - A table of MeshVertex structures representing all the vertexes of the mesh. This table is used internally to generate the \"triangles\" table. Each MeshVertex structure returned also has an extra table of tables field called \"weights\" with the following data:  number boneID - The bone this vertex is attached to number weight - How \"strong\" this vertex is attached to the bone. A vertex can be attached to multiple bones at once."},{"type":"table","value":"table A table of tables with bone id keys with the following format:  number parent - The parent bone id Matrix matrix - pretransformed bone matrix","description":"A table of tables with bone id keys with the following format:  number parent - The parent bone id Matrix matrix - pretransformed bone matrix"}],"realm":"client","params":[{"type":"string","value":"string model The full path to a model to get the visual meshes of.","name":"model","description":"The full path to a model to get the visual meshes of."},{"type":"number?","value":"number? lod The lod of the model to use. Default 0.","name":"lod","description":"The lod of the model to use. Default 0."},{"type":"number?","value":"number? bodygroupMask The bodygroupMask of the model to use. Default 0.","name":"bodygroupMask","description":"The bodygroupMask of the model to use. Default 0."}],"class":"function","name":"getModelMeshes","description":" Returns a table of visual meshes of given model or nil if the model is invalid"},"trianglesLeft":{"path":"libs_sh/mesh.lua#L977","returns":[{"type":"number","value":"number Number of triangles that can be created","description":"Number of triangles that can be created"}],"realm":"client","class":"function","name":"trianglesLeft","description":" Returns how many triangles can be created"},"writeColor":{"path":"libs_sh/mesh.lua#L1053","realm":"client","params":[{"type":"number","value":"number r Number, red value","name":"r","description":"Number, red value"},{"type":"number","value":"number g Number, green value","name":"g","description":"Number, green value"},{"type":"number","value":"number b Number, blue value","name":"b","description":"Number, blue value"},{"type":"number","value":"number a Number, alpha value","name":"a","description":"Number, alpha value"}],"class":"function","name":"writeColor","description":" Sets the vertex color by RGBA values"},"writePosition":{"path":"libs_sh/mesh.lua#L1070","realm":"client","params":[{"type":"Vector","value":"Vector position Position","name":"position","description":"Position"}],"class":"function","name":"writePosition","description":" Sets the vertex position"},"trianglesLeftRender":{"path":"libs_sh/mesh.lua#L984","returns":[{"type":"number","value":"number Number of triangles that can be rendered","description":"Number of triangles that can be rendered"}],"realm":"client","class":"function","name":"trianglesLeftRender","description":" Returns how many triangles can be rendered"},"createFromObj":{"path":"libs_sh/mesh.lua#L885","returns":[{"type":"table","value":"table Table of Mesh objects. The keys correspond to the objs object names","description":"Table of Mesh objects. The keys correspond to the objs object names"}],"realm":"client","params":[{"type":"string","value":"string obj The obj file data","name":"obj","description":"The obj file data"},{"type":"boolean?","value":"boolean? threaded Optional bool, use threading object that can be used to load the mesh over time to prevent hitting quota limit","name":"threaded","description":"Optional bool, use threading object that can be used to load the mesh over time to prevent hitting quota limit"},{"type":"boolean?","value":"boolean? triangulate Whether to triangulate faces. (Consumes more CPU)","name":"triangulate","description":"Whether to triangulate faces. (Consumes more CPU)"}],"class":"function","name":"createFromObj","description":" Creates a mesh from an obj file. Only supports triangular meshes with normals and texture coordinates."},"generateNormals":{"path":"libs_sh/mesh.lua#L719","realm":"shared","params":[{"type":"table","value":"table vertices The table of vertices","name":"vertices","description":"The table of vertices"},{"type":"boolean?","value":"boolean? inverted Optional bool, invert the normal","name":"inverted","description":"Optional bool, invert the normal"},{"type":"number?","value":"number? smooth_limit Optional number, smooths the normal based on the limit in radians","name":"smooth_limit","description":"Optional number, smooths the normal based on the limit in radians"}],"class":"function","name":"generateNormals","description":" Generates normal vectors for the provided vertices table"},"advanceVertex":{"path":"libs_sh/mesh.lua#L1116","realm":"client","class":"function","name":"advanceVertex","description":" Pushes the vertex data onto the render stack"},"writeQuadEasy":{"path":"libs_sh/mesh.lua#L1106","realm":"client","params":[{"type":"Vector","value":"Vector position","name":"position","description":""},{"type":"Vector","value":"Vector normal","name":"normal","description":""},{"type":"number","value":"number w","name":"w","description":""},{"type":"number","value":"number h","name":"h","description":""}],"class":"function","name":"writeQuadEasy","description":" Draws a quad using a position, normal and size"},"writeQuad":{"path":"libs_sh/mesh.lua#L1096","realm":"client","params":[{"type":"Vector","value":"Vector v1 Vertex1 position","name":"v1","description":"Vertex1 position"},{"type":"Vector","value":"Vector v2 Vertex2 position","name":"v2","description":"Vertex2 position"},{"type":"Vector","value":"Vector v3 Vertex3 position","name":"v3","description":"Vertex3 position"},{"type":"Vector","value":"Vector v4 Vertex4 position","name":"v4","description":"Vertex4 position"}],"class":"function","name":"writeQuad","description":" Draws a quad using 4 vertices"},"generateTangents":{"path":"libs_sh/mesh.lua#L745","realm":"shared","params":[{"type":"table","value":"table vertices The table of vertices","name":"vertices","description":"The table of vertices"}],"class":"function","name":"generateTangents","description":" Generates the tangents for the provided vertices table"},"generateUV":{"path":"libs_sh/mesh.lua#L733","realm":"shared","params":[{"type":"table","value":"table vertices The table of vertices","name":"vertices","description":"The table of vertices"},{"type":"number","value":"number scale The scale of the uvs","name":"scale","description":"The scale of the uvs"}],"class":"function","name":"generateUV","description":" Generates the uv for the provided vertices table"},"createEmpty":{"path":"libs_sh/mesh.lua#L914","returns":[{"type":"Mesh","value":"Mesh Mesh object","description":"Mesh object"}],"realm":"client","class":"function","name":"createEmpty","description":" Creates a mesh without any vertex data."},"createFromTable":{"path":"libs_sh/mesh.lua#L844","returns":[{"type":"Mesh","value":"Mesh Mesh object","description":"Mesh object"}],"realm":"client","params":[{"type":"table","value":"table vertices Table containing vertex data. http://wiki.facepunch.com/gmod/Structures/MeshVertex","name":"vertices","description":"Table containing vertex data. http://wiki.facepunch.com/gmod/Structures/MeshVertex"},{"type":"boolean?","value":"boolean? threaded Optional bool, use threading object that can be used to load the mesh over time to prevent hitting quota limit. The thread will yield with number of vertices remaining to be processed. After 0 is yielded, the final expensive phase starts.","name":"threaded","description":"Optional bool, use threading object that can be used to load the mesh over time to prevent hitting quota limit. The thread will yield with number of vertices remaining to be processed. After 0 is yielded, the final expensive phase starts."}],"class":"function","name":"createFromTable","description":" Creates a mesh from vertex data."},"findConvexHull":{"path":"libs_sh/mesh.lua#L755","returns":[{"type":"table","value":"table The mesh table which can be passed to mesh.createFromTable","description":"The mesh table which can be passed to mesh.createFromTable"},{"type":"table","value":"table The table of vertices which can be passed to prop.createCustom","description":"The table of vertices which can be passed to prop.createCustom"}],"realm":"shared","params":[{"type":"table","value":"table vertices The table of vertices (vectors) or vertex data (http://wiki.facepunch.com/gmod/Structures/MeshVertex)","name":"vertices","description":"The table of vertices (vectors) or vertex data (http://wiki.facepunch.com/gmod/Structures/MeshVertex)"},{"type":"boolean?","value":"boolean? threaded Optional bool, use threading object that can be used to run algorithm over time to prevent hitting quota limit","name":"threaded","description":"Optional bool, use threading object that can be used to run algorithm over time to prevent hitting quota limit"}],"class":"function","name":"findConvexHull","description":" Finds the convex hull of provided vertices table."},"writeUserData":{"path":"libs_sh/mesh.lua#L1086","realm":"client","params":[{"type":"number","value":"number x x","name":"x","description":"x"},{"type":"number","value":"number y y","name":"y","description":"y"},{"type":"number","value":"number z z","name":"z","description":"z"},{"type":"number","value":"number handedness","name":"handedness","description":""}],"class":"function","name":"writeUserData","description":" Sets the vertex tangent user data"}},"tables":[],"path":"libs_sh/mesh.lua#L672","libtbl":["mesh_library"],"realm":"shared","fields":[],"class":"library","name":"mesh","description":" Mesh library."},"debug":{"methods":{"traceback":{"path":"libs_sh/builtins.lua#L958","returns":[{"type":"string","value":"string A dump of the execution stack.","description":"A dump of the execution stack."}],"realm":"shared","params":[{"type":"thread?","value":"thread? A thread to get the stack trace of. If nil, this argument will be used as the message and the current thread becomes the target.","name":"A","description":"thread to get the stack trace of. If nil, this argument will be used as the message and the current thread becomes the target."},{"type":"string?","value":"string? message A message to be included at the beginning of the stack trace. Default: \"\"","name":"message","description":"A message to be included at the beginning of the stack trace. Default: \"\""},{"type":"number?","value":"number? stacklevel Which position in the execution stack to start the traceback at. Default: 1","name":"stacklevel","description":"Which position in the execution stack to start the traceback at. Default: 1"}],"class":"function","name":"traceback","description":" GLua's debug.traceback()\n Returns a string containing a stack trace of the given thread"},"getlocal":{"path":"libs_sh/builtins.lua#L1001","returns":[{"type":"string","value":"string The name of the local","description":"The name of the local"}],"realm":"shared","params":[{"type":"function|number","value":"function|number funcOrStackLevel Function or stack level to get info about. Defaults to stack level 0.","name":"funcOrStackLevel","description":"Function or stack level to get info about. Defaults to stack level 0."},{"type":"number","value":"number index The index of the local to get","name":"index","description":"The index of the local to get"}],"class":"function","name":"getlocal","description":" GLua's debug.getlocal()\n Returns the name of a function or stack's locals"},"getinfo":{"path":"libs_sh/builtins.lua#L985","returns":[{"type":"table","value":"table DebugInfo table","description":"DebugInfo table"}],"realm":"shared","params":[{"type":"function|number","value":"function|number funcOrStackLevel Function or stack level to get info about. Defaults to stack level 0.","name":"funcOrStackLevel","description":"Function or stack level to get info about. Defaults to stack level 0."},{"type":"string?","value":"string? fields A string that specifies the information to be retrieved. Defaults to all (flnSu).","name":"fields","description":"A string that specifies the information to be retrieved. Defaults to all (flnSu)."}],"class":"function","name":"getinfo","description":" GLua's debug.getinfo()\n Returns a DebugInfo structure containing the passed function's info https://wiki.facepunch.com/gmod/Structures/DebugInfo"}},"tables":[],"path":"libs_sh/builtins.lua#L26","libtbl":["debug_library"],"realm":"shared","fields":[],"class":"library","name":"debug","description":" Lua debug library https://wiki.garrysmod.com/page/Category:debug"},"physenv":{"methods":{"getAirDensity":{"path":"libs_sh/physenv.lua#L15","returns":[{"type":"number","value":"number Air Density","description":"Air Density"}],"realm":"shared","class":"function","name":"getAirDensity","description":" Gets the air density."},"getPerformanceSettings":{"path":"libs_sh/physenv.lua#L27","returns":[{"type":"table","value":"table Performance Settings Table.","description":"Performance Settings Table."}],"realm":"shared","class":"function","name":"getPerformanceSettings","description":" Gets the performance settings.\n See http://wiki.facepunch.com/gmod/Structures/PhysEnvPerformanceSettings for table structure."},"getGravity":{"path":"libs_sh/physenv.lua#L21","returns":[{"type":"Vector","value":"Vector Gravity Vector ( eg Vector(0,0,-600) )","description":"Gravity Vector ( eg Vector(0,0,-600) )"}],"realm":"shared","class":"function","name":"getGravity","description":" Gets the gravity vector"}},"tables":[],"path":"libs_sh/physenv.lua#L3","libtbl":["physenv_lib"],"realm":"shared","fields":[],"class":"library","name":"physenv","description":" Physenv functions"},"find":{"methods":{"all":{"path":"libs_sh/find.lua#L183","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"shared","params":[{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"all","description":" Finds all entities"},"closest":{"path":"libs_sh/find.lua#L192","returns":[{"type":"Entity","value":"Entity The closest entity","description":"The closest entity"}],"realm":"shared","params":[{"type":"table","value":"table ents The array of entities","name":"ents","description":"The array of entities"},{"type":"Vector","value":"Vector pos The position","name":"pos","description":"The position"}],"class":"function","name":"closest","description":" Finds the closest entity to a point"},"byName":{"path":"libs_sh/find.lua#L139","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"shared","params":[{"type":"string","value":"string name The targetname","name":"name","description":"The targetname"},{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"byName","description":" Finds entities by their targetname"},"inSphere":{"path":"libs_sh/find.lua#L76","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"shared","params":[{"type":"Vector","value":"Vector center Center of the sphere","name":"center","description":"Center of the sphere"},{"type":"number","value":"number radius Sphere radius","name":"radius","description":"Sphere radius"},{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"inSphere","description":" Finds entities in a sphere"},"inRay":{"path":"libs_sh/find.lua#L107","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"shared","params":[{"type":"Vector","value":"Vector startpos The ray start","name":"startpos","description":"The ray start"},{"type":"Vector","value":"Vector endpos The ray end","name":"endpos","description":"The ray end"},{"type":"Vector?","value":"Vector? mins If not nil, will define a lower bound of the ray's hull","name":"mins","description":"If not nil, will define a lower bound of the ray's hull"},{"type":"Vector?","value":"Vector? maxs If not nil, will define a upper bound of the ray's hull","name":"maxs","description":"If not nil, will define a upper bound of the ray's hull"},{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"inRay","description":" Finds entities in a ray"},"allPlayers":{"path":"libs_sh/find.lua#L174","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"shared","params":[{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"allPlayers","description":" Finds all players (including bots)"},"inCone":{"path":"libs_sh/find.lua#L90","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"shared","params":[{"type":"Vector","value":"Vector pos The cone vertex position","name":"pos","description":"The cone vertex position"},{"type":"Vector","value":"Vector dir The direction to project the cone","name":"dir","description":"The direction to project the cone"},{"type":"number","value":"number distance The length to project the cone","name":"distance","description":"The length to project the cone"},{"type":"number","value":"number radius The cosine of angle of the cone. 1 makes a 0° cone, 0.707 makes approximately 90°, 0 makes 180°, and so on.","name":"radius","description":"The cosine of angle of the cone. 1 makes a 0° cone, 0.707 makes approximately 90°, 0 makes 180°, and so on."},{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"inCone","description":" Finds entities in a cone"},"inPVS":{"path":"libs_sh/find.lua#L162","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"server","params":[{"type":"Vector","value":"Vector pos Vector view point","name":"pos","description":"Vector view point"},{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"inPVS","description":" Finds entities that are in the PVS (Potentially Visible Set). See: https://developer.valvesoftware.com/wiki/PVS"},"inBox":{"path":"libs_sh/find.lua#L63","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"shared","params":[{"type":"Vector","value":"Vector min Bottom corner","name":"min","description":"Bottom corner"},{"type":"Vector","value":"Vector max Top corner","name":"max","description":"Top corner"},{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"inBox","description":" Finds entities in a box"},"sortByClosest":{"path":"libs_sh/find.lua#L211","returns":[{"type":"table","value":"table A table of the closest entities","description":"A table of the closest entities"}],"realm":"shared","params":[{"type":"table","value":"table ents The array of entities","name":"ents","description":"The array of entities"},{"type":"Vector","value":"Vector pos The position","name":"pos","description":"The position"},{"type":"boolean","value":"boolean furthest Whether to have the further entities first","name":"furthest","description":"Whether to have the further entities first"}],"class":"function","name":"sortByClosest","description":" Returns a sorted array of entities by how close they are to a point"},"playerBySteamID64":{"path":"libs_sh/find.lua#L280","returns":[{"type":"Player?","value":"Player? The player with matching steamid","description":"The player with matching steamid"}],"realm":"shared","params":[{"type":"string","value":"string steamid 64-bit steam id to search for","name":"steamid","description":"64-bit steam id to search for"}],"class":"function","name":"playerBySteamID64","description":" Finds the player with the given a 64-bit steamid. Returns nil if not found"},"getMapCreatedEntity":{"path":"libs_sh/find.lua#L288","returns":[{"type":"Entity?","value":"Entity? The found entity or nil if not found","description":"The found entity or nil if not found"}],"realm":"shared","params":[{"type":"number","value":"number num Entity's creation id","name":"num","description":"Entity's creation id"}],"class":"function","name":"getMapCreatedEntity","description":" Returns entity that has given Entity:mapCreationID."},"byClass":{"path":"libs_sh/find.lua#L128","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"shared","params":[{"type":"string","value":"string class The class name","name":"class","description":"The class name"},{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"byClass","description":" Finds entities by class name"},"byModel":{"path":"libs_sh/find.lua#L150","returns":[{"type":"table","value":"table An array of found entities","description":"An array of found entities"}],"realm":"shared","params":[{"type":"string","value":"string model The model file","name":"model","description":"The model file"},{"type":"function?","value":"function? filter Optional function to filter results","name":"filter","description":"Optional function to filter results"}],"class":"function","name":"byModel","description":" Finds entities by model"},"playerBySteamID":{"path":"libs_sh/find.lua#L272","returns":[{"type":"Player?","value":"Player? The player with matching steamid","description":"The player with matching steamid"}],"realm":"shared","params":[{"type":"string","value":"string steamid Steam Id to search for","name":"steamid","description":"Steam Id to search for"}],"class":"function","name":"playerBySteamID","description":" Finds the player with the given a steamid. Returns nil if not found"},"playersByName":{"path":"libs_sh/find.lua#L235","returns":[{"type":"table","value":"table Table of found players","description":"Table of found players"}],"realm":"shared","params":[{"type":"string","value":"string name Name to search for","name":"name","description":"Name to search for"},{"type":"boolean?","value":"boolean? casesensitive Boolean should the match be case sensitive?","name":"casesensitive","description":"Boolean should the match be case sensitive?"},{"type":"boolean?","value":"boolean? exact Boolean should the name match exactly","name":"exact","description":"Boolean should the name match exactly"}],"class":"function","name":"playersByName","description":" Finds the first player with the given name"}},"tables":[],"path":"libs_sh/find.lua#L7","libtbl":["find_library"],"realm":"shared","fields":[],"class":"library","name":"find","description":" Find library. Finds entities in various shapes."},"particleEffect":{"methods":{"attach":{"path":"libs_cl/particle_effect.lua#L62","returns":[{"type":"ParticleEffect","value":"ParticleEffect ParticleEffect type.","description":"ParticleEffect type."}],"realm":"client","params":[{"type":"Entity","value":"Entity entity Entity to attach to","name":"entity","description":"Entity to attach to"},{"type":"string","value":"string name Name of the particle effect","name":"name","description":"Name of the particle effect"},{"type":"number","value":"number pattach PATTACH enum","name":"pattach","description":"PATTACH enum"},{"type":"table","value":"table options Table of options","name":"options","description":"Table of options"}],"class":"function","name":"attach","description":" Attaches a particleEffect to an entity."}},"tables":[],"path":"libs_cl/particle_effect.lua#L11","libtbl":["particleef_library"],"realm":"client","fields":[],"class":"library","name":"particleEffect","description":" ParticleEffect library."},"effect":{"methods":{"canCreate":{"path":"libs_sh/effect.lua#L57","returns":[{"type":"boolean","value":"boolean If an effect can be played","description":"If an effect can be played"}],"realm":"shared","class":"function","name":"canCreate","description":" Returns whether there are any effects able to be played"},"create":{"path":"libs_sh/effect.lua#L45","returns":[{"type":"Effect","value":"Effect Effect Object","description":"Effect Object"}],"realm":"shared","class":"function","name":"create","description":" Creates an effect data structure"},"effectsLeft":{"path":"libs_sh/effect.lua#L51","returns":[{"type":"number","value":"number Number of effects able to be created","description":"Number of effects able to be created"}],"realm":"shared","class":"function","name":"effectsLeft","description":" Returns number of effects able to be created"}},"tables":[],"path":"libs_sh/effect.lua#L17","libtbl":["effect_library"],"realm":"shared","fields":[],"class":"library","name":"effect","description":" Effects library."},"hologram":{"methods":{"removeAll":{"path":"libs_sh/hologram.lua#L555","realm":"shared","class":"function","name":"removeAll","description":" Removes all holograms created by the calling chip"},"canSpawn":{"path":"libs_sh/hologram.lua#L158","returns":[{"type":"boolean","value":"boolean True if user can spawn holograms, False if not.","description":"True if user can spawn holograms, False if not."}],"realm":"shared","class":"function","name":"canSpawn","description":" Checks if a user can spawn anymore holograms."},"create":{"path":"libs_sh/hologram.lua#L99","returns":[{"type":"Hologram","value":"Hologram The hologram object","description":"The hologram object"}],"realm":"shared","params":[{"type":"Vector","value":"Vector pos The position to create the hologram","name":"pos","description":"The position to create the hologram"},{"type":"Angle","value":"Angle ang The angle to create the hologram","name":"ang","description":"The angle to create the hologram"},{"type":"string","value":"string model The model to give the hologram","name":"model","description":"The model to give the hologram"},{"type":"Vector?","value":"Vector? scale (Optional) The scale to give the hologram","name":"scale","description":"(Optional) The scale to give the hologram"}],"class":"function","name":"create","description":" Creates a hologram."},"hologramsLeft":{"path":"libs_sh/hologram.lua#L165","returns":[{"type":"number","value":"number Number of holograms able to be spawned","description":"Number of holograms able to be spawned"}],"realm":"shared","class":"function","name":"hologramsLeft","description":" Checks how many holograms can be spawned"}},"tables":[],"path":"libs_sh/hologram.lua#L36","libtbl":["hologram_library"],"realm":"shared","fields":[],"class":"library","name":"hologram","description":" Library for creating and manipulating physics-less models AKA \"Holograms\"."},"navmesh":{"methods":{"clearWalkableSeeds":{"path":"libs_sv/navmesh.lua#L108","realm":"server","class":"function","name":"clearWalkableSeeds","description":" Clears all the walkable positions, used before calling navmesh.beginGeneration.\n Requires the `navmesh.modify` permission"},"find":{"path":"libs_sv/navmesh.lua#L175","returns":[{"type":"table","value":"table A table of immutable `NavArea`s","description":"A table of immutable `NavArea`s"}],"realm":"server","params":[{"type":"Vector","value":"Vector pos The position to search around","name":"pos","description":"The position to search around"},{"type":"number","value":"number radius Radius to search within (max 100000)","name":"radius","description":"Radius to search within (max 100000)"},{"type":"number","value":"number stepdown Maximum fall distance allowed (max 50000)","name":"stepdown","description":"Maximum fall distance allowed (max 50000)"},{"type":"number","value":"number stepup Maximum jump height allowed (max 50000)","name":"stepup","description":"Maximum jump height allowed (max 50000)"}],"class":"function","name":"find","description":" Returns a bunch of areas within distance, used to find hiding spots by NextBots for example."},"setMarkedArea":{"path":"libs_sv/navmesh.lua#L127","realm":"server","params":[{"type":"NavArea","value":"NavArea area The CNavArea to set as the marked area.","name":"area","description":"The CNavArea to set as the marked area."}],"class":"function","name":"setMarkedArea","description":" Sets the CNavArea as marked, so it can be used with editing console commands.\n Requires the `navmesh.modify` permission"},"isLoaded":{"path":"libs_sv/navmesh.lua#L72","returns":[{"type":"boolean","value":"boolean Whether a navmesh has been loaded when loading the map.","description":"Whether a navmesh has been loaded when loading the map."}],"realm":"server","class":"function","name":"isLoaded","description":" Returns true if a navmesh has been loaded when loading the map."},"save":{"path":"libs_sv/navmesh.lua#L92","realm":"server","class":"function","name":"save","description":" Saves any changes made to navmesh to the .nav file.\n Requires the 'navmesh.save' privilege"},"getNavAreaCount":{"path":"libs_sv/navmesh.lua#L197","returns":[{"type":"number","value":"number The highest ID of all nav areas on the map.","description":"The highest ID of all nav areas on the map."}],"realm":"server","class":"function","name":"getNavAreaCount","description":" Returns the highest ID of all nav areas on the map.\n While this can be used to get all nav areas, this number may not actually be the actual number of nav areas on the map."},"reset":{"path":"libs_sv/navmesh.lua#L85","realm":"server","class":"function","name":"reset","description":" Deletes every NavArea and NavLadder on the map without saving the changes.\n Requires the 'navmesh.reset' privilege"},"getGetEditCursorPosition":{"path":"libs_sv/navmesh.lua#L233","returns":[{"type":"Vector","value":"Vector The position of the edit cursor.","description":"The position of the edit cursor."}],"realm":"server","class":"function","name":"getGetEditCursorPosition","description":" Returns the position of the edit cursor when nav_edit is set to 1."},"getNearestNavArea":{"path":"libs_sv/navmesh.lua#L221","returns":[{"type":"NavArea","value":"NavArea The closest NavArea found with the given parameters, or a NULL NavArea if one was not found.","description":"The closest NavArea found with the given parameters, or a NULL NavArea if one was not found."}],"realm":"server","params":[{"type":"Vector","value":"Vector pos The position to look from","name":"pos","description":"The position to look from"},{"type":"number","value":"number maxDist Maximum distance from the given position that the function will look for a CNavArea (Default 10000)","name":"maxDist","description":"Maximum distance from the given position that the function will look for a CNavArea (Default 10000)"},{"type":"boolean","value":"boolean checkLOS If this is set to true then the function will internally do a trace from the starting position to each potential CNavArea with a MASK_NPCSOLID_BRUSHONLY. If the trace fails then the CNavArea is ignored. If this is set to false then the function will find the closest CNavArea through anything, including the world. (Default false)","name":"checkLOS","description":"If this is set to true then the function will internally do a trace from the starting position to each potential CNavArea with a MASK_NPCSOLID_BRUSHONLY. If the trace fails then the CNavArea is ignored. If this is set to false then the function will find the closest CNavArea through anything, including the world. (Default false)"},{"type":"boolean","value":"boolean checkGround If checkGround is true then this function will internally call navmesh.getNavArea to check if there is a CNavArea directly below the position, and return it if so, before checking anywhere else. (Default true)","name":"checkGround","description":"If checkGround is true then this function will internally call navmesh.getNavArea to check if there is a CNavArea directly below the position, and return it if so, before checking anywhere else. (Default true)"}],"class":"function","name":"getNearestNavArea","description":" Returns the closest NavArea to given position at the same height, or beneath it.\n This function will ignore blocked NavAreas.\n See navmesh.getNavArea for a function that does see blocked areas."},"getPlayerSpawnName":{"path":"libs_sv/navmesh.lua#L121","returns":[{"type":"string","value":"string The classname of the spawn point entity. By default returns \"info_player_start\"","description":"The classname of the spawn point entity. By default returns \"info_player_start\""}],"realm":"server","class":"function","name":"getPlayerSpawnName","description":" Returns the classname of the player spawn entity."},"getMarkedArea":{"path":"libs_sv/navmesh.lua#L115","returns":[{"type":"NavArea","value":"NavArea The currently marked NavArea.","description":"The currently marked NavArea."}],"realm":"server","class":"function","name":"getMarkedArea","description":" Returns the currently marked NavArea, for use with editing console commands."},"isGenerating":{"path":"libs_sv/navmesh.lua#L66","returns":[{"type":"boolean","value":"boolean Whether we're generating a nav mesh or not.","description":"Whether we're generating a nav mesh or not."}],"realm":"server","class":"function","name":"isGenerating","description":" Whether we're currently generating a new navmesh with navmesh.beginGeneration"},"getNavAreaByID":{"path":"libs_sv/navmesh.lua#L204","returns":[{"type":"NavArea","value":"NavArea The NavArea with given ID.","description":"The NavArea with given ID."}],"realm":"server","params":[{"type":"number","value":"number id ID of the NavArea to get. Starts with 1.","name":"id","description":"ID of the NavArea to get. Starts with 1."}],"class":"function","name":"getNavAreaByID","description":" Returns the NavArea at the given id."},"load":{"path":"libs_sv/navmesh.lua#L78","realm":"server","class":"function","name":"load","description":" Loads a new navmesh from the .nav file for current map discarding any changes made to the navmesh previously.\n Requires the 'navmesh.load' privilege"},"beginGeneration":{"path":"libs_sv/navmesh.lua#L60","realm":"server","class":"function","name":"beginGeneration","description":" Starts the generation of a new navmesh"},"getNavArea":{"path":"libs_sv/navmesh.lua#L212","returns":[{"type":"NavArea","value":"NavArea The NavArea.","description":"The NavArea."}],"realm":"server","params":[{"type":"Vector","value":"Vector pos The position to search for.","name":"pos","description":"The position to search for."},{"type":"number","value":"number limit The elevation limit at which the NavArea will be searched.","name":"limit","description":"The elevation limit at which the NavArea will be searched."}],"class":"function","name":"getNavArea","description":" Returns the NavArea contained in this position that also satisfies the elevation limit."},"addWalkableSeed":{"path":"libs_sv/navmesh.lua#L99","realm":"server","params":[{"type":"Vector","value":"Vector pos The terrain position.","name":"pos","description":"The terrain position."},{"type":"Vector","value":"Vector normal The terrain normal.","name":"normal","description":"The terrain normal."}],"class":"function","name":"addWalkableSeed","description":" Add this position and normal to the list of walkable positions, used before map generation with navmesh.beginGeneration\n Requires the `navmesh.modify` permission"},"setPlayerSpawnName":{"path":"libs_sv/navmesh.lua#L135","realm":"server","params":[{"type":"string","value":"string spawnPointClass The classname of what the player uses to spawn, automatically adds it to the walkable positions during map generation.","name":"spawnPointClass","description":"The classname of what the player uses to spawn, automatically adds it to the walkable positions during map generation."}],"class":"function","name":"setPlayerSpawnName","description":" Sets the classname of the default spawn point entity, used before generating a new navmesh with navmesh.beginGeneration."},"createNavArea":{"path":"libs_sv/navmesh.lua#L143","returns":[{"type":"NavArea?","value":"NavArea? The new NavArea or nil if we failed for some reason","description":"The new NavArea or nil if we failed for some reason"}],"realm":"server","params":[{"type":"Vector","value":"Vector corner The first corner of the new NavArea","name":"corner","description":"The first corner of the new NavArea"},{"type":"Vector","value":"Vector opposite_corner The opposite (diagonally) corner of the new NavArea","name":"opposite_corner","description":"The opposite (diagonally) corner of the new NavArea"}],"class":"function","name":"createNavArea","description":" Creates a new NavArea"},"getAllNavAreas":{"path":"libs_sv/navmesh.lua#L163","returns":[{"type":"table","value":"table A table of all the `NavArea`s on the current map","description":"A table of all the `NavArea`s on the current map"}],"realm":"server","class":"function","name":"getAllNavAreas","description":" Returns an integer indexed table of all `NavArea`s on the current map.\n If the map doesn't have a navmesh generated then this will return an empty table.\n The navareas will be immutable."}},"tables":{"NAV_MESH":{"path":"libs_sh/enum.lua#L1254","fields":[{"name":"INVALID","description":"The nav area is invalid."},{"name":"CROUCH","description":"Must crouch to use this node/area"},{"name":"JUMP","description":"Must jump to traverse this area (only used during generation)"},{"name":"PRECISE","description":"Do not adjust for obstacles, just move along area"},{"name":"NO_JUMP","description":"Inhibit discontinuity jumping"},{"name":"STOP","description":"Must stop when entering this area"},{"name":"RUN","description":"Must run to traverse this area"},{"name":"WALK","description":"Must walk to traverse this area"},{"name":"AVOID","description":"Avoid this area unless alternatives are too dangerous"},{"name":"TRANSIENT","description":"Area may become blocked, and should be periodically checked"},{"name":"DONT_HIDE","description":"Area should not be considered for hiding spot generation"},{"name":"STAND","description":"Bots hiding in this area should stand"},{"name":"NO_HOSTAGES","description":"Hostages shouldn't use this area"},{"name":"STAIRS","description":"This area represents stairs, do not attempt to climb or jump them - just walk up"},{"name":"NO_MERGE","description":"Don't merge this area with adjacent areas"},{"name":"OBSTACLE_TOP","description":"This nav area is the climb point on the tip of an obstacle"},{"name":"CLIFF","description":"This nav area is adjacent to a drop of at least CliffHeight"},{"name":"FUNC_COST","description":"Area has designer specified cost controlled by func_nav_cost entities"},{"name":"HAS_ELEVATOR","description":"Area is in an elevator's path"},{"name":"NAV_BLOCKER","description":"-2147483648"}],"realm":"shared","class":"table","name":"NAV_MESH","description":" ENUMs used by NavArea:getAttributes and NavArea:hasAttributes"},"NAV_CORNER":{"path":"libs_sh/enum.lua#L1300","fields":[{"name":"NORTH_WEST","description":"0"},{"name":"NORTH_EAST","description":"1"},{"name":"SOUTH_EAST","description":"2"},{"name":"SOUTH_WEST","description":"3"},{"name":"NUM_CORNERS","description":"Represents all corners, only applicable to certain functions, such as NavArea:placeOnGround."}],"realm":"shared","class":"table","name":"NAV_CORNER","description":" ENUMs used by NavArea methods. These Enums correspond to each corner of a CNavArea"},"NAV_DIR":{"path":"libs_sh/enum.lua#L1240","fields":[{"name":"NORTH","description":"0"},{"name":"SOUTH","description":"1"},{"name":"EAST","description":"2"},{"name":"WEST","description":"3"}],"realm":"shared","class":"table","name":"NAV_DIR","description":" NavArea direction ENUMs"},"NAV_TRAVERSE_TYPE":{"path":"libs_sh/enum.lua#L1316","fields":[{"name":"GO_NORTH","description":"0"},{"name":"GO_EAST","description":"1"},{"name":"GO_SOUTH","description":"2"},{"name":"GO_WEST","description":"3"},{"name":"GO_LADDER_UP","description":"4"},{"name":"GO_LADDER_DOWN","description":"5"},{"name":"GO_JUMP","description":"6"},{"name":"GO_ELEVATOR_UP","description":"7"},{"name":"GO_ELEVATOR_DOWN","description":"8"}],"realm":"shared","class":"table","name":"NAV_TRAVERSE_TYPE","description":" ENUMs used by NavArea:getParentHow."}},"path":"libs_sv/navmesh.lua#L17","libtbl":["navmesh_library"],"realm":"server","fields":[],"class":"library","name":"navmesh","description":" Library for navmesh navigation with the NavArea type"},"json":{"methods":{"decode":{"path":"libs_sh/json.lua#L23","returns":[{"type":"table","value":"table Table representing the JSON object","description":"Table representing the JSON object"}],"realm":"shared","params":[{"type":"string","value":"string s String to decode","name":"s","description":"String to decode"}],"class":"function","name":"decode","description":" Convert JSON string to table"},"encode":{"path":"libs_sh/json.lua#L14","returns":[{"type":"string","value":"string JSON encoded string representation of the table","description":"JSON encoded string representation of the table"}],"realm":"shared","params":[{"type":"table","value":"table tbl Table to encode","name":"tbl","description":"Table to encode"},{"type":"boolean?","value":"boolean? prettyPrint Optional. If true, formats and indents the resulting JSON","name":"prettyPrint","description":"Optional. If true, formats and indents the resulting JSON"}],"class":"function","name":"encode","description":" Convert table to JSON string"}},"tables":[],"path":"libs_sh/json.lua#L4","libtbl":["json_library"],"realm":"shared","fields":[],"class":"library","name":"json","description":" JSON library"},"sql":{"methods":{"query":{"path":"libs_cl/sql.lua#L17","returns":[{"type":"table?","value":"table? Query results as a table, nil if the query returned no data.","description":"Query results as a table, nil if the query returned no data."}],"realm":"client","params":[{"type":"string","value":"string query The query to execute.","name":"query","description":"The query to execute."}],"class":"function","name":"query","description":" Performs a query on the local SQLite database."},"SQLStr":{"path":"libs_cl/sql.lua#L54","returns":[{"type":"string","value":"string The escaped input.","description":"The escaped input."}],"realm":"client","params":[{"type":"string","value":"string str The string to be escaped.","name":"str","description":"The string to be escaped."},{"type":"boolean","value":"boolean bNoQuotes Set this as true, and the function will not wrap the input string in apostrophes.","name":"bNoQuotes","description":"Set this as true, and the function will not wrap the input string in apostrophes."}],"class":"function","name":"SQLStr","description":" Escapes dangerous characters and symbols from user input used in an SQLite SQL Query."},"tableExists":{"path":"libs_cl/sql.lua#L32","returns":[{"type":"boolean","value":"boolean False if the table does not exist, true if it does.","description":"False if the table does not exist, true if it does."}],"realm":"client","params":[{"type":"string","value":"string tabname The table to check for.","name":"tabname","description":"The table to check for."}],"class":"function","name":"tableExists","description":" Checks if a table exists within the local SQLite database."},"tableRemove":{"path":"libs_cl/sql.lua#L42","returns":[{"type":"boolean","value":"boolean True if the table was successfully removed, false if not.","description":"True if the table was successfully removed, false if not."}],"realm":"client","params":[{"type":"string","value":"string tabname The table to remove.","name":"tabname","description":"The table to remove."}],"class":"function","name":"tableRemove","description":" Removes a table within the local SQLite database."}},"tables":[],"path":"libs_cl/sql.lua#L5","libtbl":["sql_library"],"realm":"client","fields":[],"class":"library","name":"sql","description":" SQL library."},"light":{"methods":{"create":{"path":"libs_cl/light.lua#L117","returns":[{"type":"Light","value":"Light Dynamic light","description":"Dynamic light"}],"realm":"client","params":[{"type":"Vector","value":"Vector pos The position of the light","name":"pos","description":"The position of the light"},{"type":"number","value":"number size The size of the light. Must be lower than sf_light_maxsize","name":"size","description":"The size of the light. Must be lower than sf_light_maxsize"},{"type":"number","value":"number brightness The brightness of the light","name":"brightness","description":"The brightness of the light"},{"type":"Color","value":"Color color The color of the light","name":"color","description":"The color of the light"}],"class":"function","name":"create","description":" Creates a dynamic light (make sure to draw it)"}},"tables":[],"path":"libs_cl/light.lua#L74","libtbl":["light_library"],"realm":"client","fields":[],"class":"library","name":"light","description":" Light library."},"joystick":{"methods":{"numJoysticks":{"path":"libs_cl/joystick.lua#L60","returns":[{"type":"number","value":"number Number of joysticks","description":"Number of joysticks"}],"realm":"client","class":"function","name":"numJoysticks","description":" Gets the number of detected joysticks."},"numButtons":{"path":"libs_cl/joystick.lua#L82","returns":[{"type":"number","value":"number Number of buttons","description":"Number of buttons"}],"realm":"client","params":[{"type":"number","value":"number enum Joystick number. Starts at 0","name":"enum","description":"Joystick number. Starts at 0"}],"class":"function","name":"numButtons","description":" Gets the number of detected buttons on a joystick"},"numPovs":{"path":"libs_cl/joystick.lua#L74","returns":[{"type":"number","value":"number Number of povs","description":"Number of povs"}],"realm":"client","params":[{"type":"number","value":"number enum Joystick number. Starts at 0","name":"enum","description":"Joystick number. Starts at 0"}],"class":"function","name":"numPovs","description":" Gets the number of detected povs on a joystick"},"numAxes":{"path":"libs_cl/joystick.lua#L66","returns":[{"type":"number","value":"number Number of axes","description":"Number of axes"}],"realm":"client","params":[{"type":"number","value":"number enum Joystick number. Starts at 0","name":"enum","description":"Joystick number. Starts at 0"}],"class":"function","name":"numAxes","description":" Gets the number of detected axes on a joystick"},"getAxis":{"path":"libs_cl/joystick.lua#L25","returns":[{"type":"number","value":"number 0 - 65535 where 32767 is the middle.","description":"0 - 65535 where 32767 is the middle."}],"realm":"client","params":[{"type":"number","value":"number enum Joystick number. Starts at 0","name":"enum","description":"Joystick number. Starts at 0"},{"type":"number","value":"number axis Joystick axis number. Ranges from 0 to 7.","name":"axis","description":"Joystick axis number. Ranges from 0 to 7."}],"class":"function","name":"getAxis","description":" Gets the axis data value."},"getButton":{"path":"libs_cl/joystick.lua#L43","returns":[{"type":"number","value":"number 0 or 1","description":"0 or 1"}],"realm":"client","params":[{"type":"number","value":"number enum Joystick number. Starts at 0","name":"enum","description":"Joystick number. Starts at 0"},{"type":"number","value":"number button Joystick button number. Starts at 0","name":"button","description":"Joystick button number. Starts at 0"}],"class":"function","name":"getButton","description":" Returns if the button is pushed or not"},"getName":{"path":"libs_cl/joystick.lua#L52","returns":[{"type":"string","value":"string Name of the device","description":"Name of the device"}],"realm":"client","params":[{"type":"number","value":"number enum Joystick number. Starts at 0","name":"enum","description":"Joystick number. Starts at 0"}],"class":"function","name":"getName","description":" Gets the hardware name of the joystick"},"getPov":{"path":"libs_cl/joystick.lua#L34","returns":[{"type":"number","value":"number 0 - 65535 where 32767 is the middle.","description":"0 - 65535 where 32767 is the middle."}],"realm":"client","params":[{"type":"number","value":"number enum Joystick number. Starts at 0","name":"enum","description":"Joystick number. Starts at 0"},{"type":"number","value":"number pov Joystick pov number. Ranges from 0 to 7.","name":"pov","description":"Joystick pov number. Ranges from 0 to 7."}],"class":"function","name":"getPov","description":" Gets the pov data value."}},"tables":[],"path":"libs_cl/joystick.lua#L14","libtbl":["joystick_library"],"realm":"client","fields":[],"class":"library","name":"joystick","description":" Joystick library."},"notification":{"methods":{"addProgress":{"path":"libs_cl/notification.lua#L51","realm":"client","params":[{"type":"string","value":"string id String index of the notification","name":"id","description":"String index of the notification"},{"type":"string","value":"string text The text to display","name":"text","description":"The text to display"},{"type":"number?","value":"number? progress An optional progress val 0-1 indicating progress.","name":"progress","description":"An optional progress val 0-1 indicating progress."}],"class":"function","name":"addProgress","description":" Displays a notification with an animated progress bar, will persist unless killed or chip is removed."},"kill":{"path":"libs_cl/notification.lua#L84","realm":"client","params":[{"type":"string","value":"string id String index of the notification to kill","name":"id","description":"String index of the notification to kill"}],"class":"function","name":"kill","description":" Removes the notification with the given index after 0.8 seconds"},"addLegacy":{"path":"libs_cl/notification.lua#L28","realm":"client","params":[{"type":"string","value":"string text The text to display","name":"text","description":"The text to display"},{"type":"number","value":"number type Determines the notification method.","name":"type","description":"Determines the notification method."},{"type":"number","value":"number length Time in seconds to display the notification (Max length of 30)","name":"length","description":"Time in seconds to display the notification (Max length of 30)"}],"class":"function","name":"addLegacy","description":" Displays a standard notification.\nNOTIFY.GENERIC\nNOTIFY.ERROR\nNOTIFY.UNDO\nNOTIFY.HINT\nNOTIFY.CLEANUP"}},"tables":[],"path":"libs_cl/notification.lua#L9","libtbl":["notification_library"],"realm":"client","fields":[],"class":"library","name":"notification","description":" Notification library. Allows the user to display hints on the bottom right of their screen"},"math":{"methods":{"ceil":{"path":"libs_sh/math.lua#L96","returns":[{"type":"number","value":"number Rounded number","description":"Rounded number"}],"realm":"shared","params":[{"type":"number","value":"number n Number to be rounded","name":"n","description":"Number to be rounded"}],"class":"function","name":"ceil","description":" Rounds a number up."},"tan":{"path":"libs_sh/math.lua#L296","returns":[{"type":"number","value":"number The tangent of the given angle","description":"The tangent of the given angle"}],"realm":"shared","params":[{"type":"number","value":"number ang Angle in radians","name":"ang","description":"Angle in radians"}],"class":"function","name":"tan","description":" Calculates the tangent of the given angle."},"lerp":{"path":"libs_sh/math.lua#L333","returns":[{"type":"number","value":"number The result of the linear interpolation, (1 - t) * from + t * to","description":"The result of the linear interpolation, (1 - t) * from + t * to"}],"realm":"shared","params":[{"type":"number","value":"number t The fraction for finding the result. This number is clamped between 0 and 1","name":"t","description":"The fraction for finding the result. This number is clamped between 0 and 1"},{"type":"number","value":"number from The starting number. The result will be equal to this if value t is 0","name":"from","description":"The starting number. The result will be equal to this if value t is 0"},{"type":"number","value":"number to The ending number. The result will be equal to this if value t is 1","name":"to","description":"The ending number. The result will be equal to this if value t is 1"}],"class":"function","name":"lerp","description":" Performs a linear interpolation from the start number to the end number."},"sinh":{"path":"libs_sh/math.lua#L284","returns":[{"type":"number","value":"number The hyperbolic sine of the given angle","description":"The hyperbolic sine of the given angle"}],"realm":"shared","params":[{"type":"number","value":"number ang Angle in radians","name":"ang","description":"Angle in radians"}],"class":"function","name":"sinh","description":" Calculates the hyperbolic sine of the given angle."},"approach":{"path":"libs_sh/math.lua#L46","returns":[{"type":"number","value":"number New current value, closer to the target than it was previously","description":"New current value, closer to the target than it was previously"}],"realm":"shared","params":[{"type":"number","value":"number current The value we're currently at","name":"current","description":"The value we're currently at"},{"type":"number","value":"number target The target value. This function will never overshoot this value","name":"target","description":"The target value. This function will never overshoot this value"},{"type":"number","value":"number change The amount that the current value is allowed to change by to approach the target (positive or negative)","name":"change","description":"The amount that the current value is allowed to change by to approach the target (positive or negative)"}],"class":"function","name":"approach","description":" Gradually approaches the target value by the specified amount."},"distance":{"path":"libs_sh/math.lua#L128","returns":[{"type":"number","value":"number Distance between the two points","description":"Distance between the two points"}],"realm":"shared","params":[{"type":"number","value":"number x1 X position of first point","name":"x1","description":"X position of first point"},{"type":"number","value":"number y1 Y position of first point","name":"y1","description":"Y position of first point"},{"type":"number","value":"number x2 X position of second point","name":"x2","description":"X position of second point"},{"type":"number","value":"number y2 Y position of second point","name":"y2","description":"Y position of second point"}],"class":"function","name":"distance","description":" Calculates the difference between two points in 2D space"},"truncate":{"path":"libs_sh/math.lua#L316","returns":[{"type":"number","value":"number Rounded number","description":"Rounded number"}],"realm":"shared","params":[{"type":"number","value":"number val The number to truncate","name":"val","description":"The number to truncate"},{"type":"number?","value":"number? digits The amount of digits to keep after the point. Default 0","name":"digits","description":"The amount of digits to keep after the point. Default 0"}],"class":"function","name":"truncate","description":" Rounds towards zero"},"easeInOutBack":{"path":"libs_sh/math.lua#L470","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutBack","description":" Eases in and out by reversing the direction of the ease slightly before returning on both ends."},"easeInExpo":{"path":"libs_sh/math.lua#L464","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInExpo","description":" Eases in using an exponential equation with a base of 2 and where the fraction is used in the exponent."},"min":{"path":"libs_sh/math.lua#L206","returns":[{"type":"number","value":"number The smallest number","description":"The smallest number"}],"realm":"shared","params":[{"type":"...number","value":"...number numbers Any amount of number values","name":"numbers","description":"Any amount of number values"}],"class":"function","name":"min","description":" Picks the smallest value of all provided arguments."},"frexp":{"path":"libs_sh/math.lua#L164","returns":[{"type":"number","value":"number Multiplier between 0.5 and 1","description":"Multiplier between 0.5 and 1"},{"type":"number","value":"number Exponent integer","description":"Exponent integer"}],"realm":"shared","params":[{"type":"number","value":"number x The value to get the normalized fraction and the exponent from","name":"x","description":"The value to get the normalized fraction and the exponent from"}],"class":"function","name":"frexp","description":" Used to split the number value into a normalized fraction and an exponent"},"easeInOutExpo":{"path":"libs_sh/math.lua#L500","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutExpo","description":" Eases in and out using an exponential equation with a base of 2 and where the fraction is used in the exponent."},"easeInOutCubic":{"path":"libs_sh/math.lua#L488","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutCubic","description":" Eases in and out by cubing the fraction."},"sin":{"path":"libs_sh/math.lua#L278","returns":[{"type":"number","value":"number Sine for given angle","description":"Sine for given angle"}],"realm":"shared","params":[{"type":"number","value":"number ang Angle in radians","name":"ang","description":"Angle in radians"}],"class":"function","name":"sin","description":" Calculates the sine of given angle."},"easeInBack":{"path":"libs_sh/math.lua#L434","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInBack","description":" Eases in by reversing the direction of the ease slightly before returning."},"lerpVector":{"path":"libs_sh/math.lua#L357","returns":[{"type":"Vector","value":"Vector The interpolated vector","description":"The interpolated vector"}],"realm":"shared","params":[{"type":"number","value":"number ratio Ratio of progress through values","name":"ratio","description":"Ratio of progress through values"},{"type":"Vector","value":"Vector from Vector to begin from","name":"from","description":"Vector to begin from"},{"type":"Vector","value":"Vector Vector to end at","name":"Vector","description":"to end at"}],"class":"function","name":"lerpVector","description":" Calculates point between first and second vector using given fraction and linear interpolation."},"easeInBounce":{"path":"libs_sh/math.lua#L440","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInBounce","description":" Eases in like a bouncy ball."},"bSplinePoint":{"path":"libs_sh/math.lua#L323","returns":[{"type":"number","value":"number Point on Bezier curve, related to tDiff","description":"Point on Bezier curve, related to tDiff"}],"realm":"shared","params":[{"type":"number","value":"number tDiff From 0 to tMax, where alongside the spline the point will be","name":"tDiff","description":"From 0 to tMax, where alongside the spline the point will be"},{"type":"number","value":"number tPoints A table of Vectors. The amount cannot be less than 4","name":"tPoints","description":"A table of Vectors. The amount cannot be less than 4"},{"type":"number","value":"number tMax Dictates maximum value for tDiff","name":"tMax","description":"Dictates maximum value for tDiff"}],"class":"function","name":"bSplinePoint","description":" Calculates B-Spline point."},"easeInQuint":{"path":"libs_sh/math.lua#L542","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInQuint","description":" Eases in by raising the fraction to the power of 5."},"easeInCirc":{"path":"libs_sh/math.lua#L446","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInCirc","description":" Eases in using a circular function."},"tanh":{"path":"libs_sh/math.lua#L302","returns":[{"type":"number","value":"number The hyperbolic tangent of the given angle","description":"The hyperbolic tangent of the given angle"}],"realm":"shared","params":[{"type":"number","value":"number ang Angle in radians","name":"ang","description":"Angle in radians"}],"class":"function","name":"tanh","description":" Calculates hyperbolic tangent of the given angle."},"easeInQuart":{"path":"libs_sh/math.lua#L536","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInQuart","description":" Eases in by raising the fraction to the power of 4."},"pow":{"path":"libs_sh/math.lua#L227","returns":[{"type":"number","value":"number Exponent power of base","description":"Exponent power of base"}],"realm":"shared","params":[{"type":"number","value":"number base The Base number","name":"base","description":"The Base number"},{"type":"number","value":"number exp The Exponent","name":"exp","description":"The Exponent"}],"class":"function","name":"pow","description":" Returns x raised to the power y"},"easeInOutSine":{"path":"libs_sh/math.lua#L524","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutSine","description":" Eases in and out using math.sin."},"acos":{"path":"libs_sh/math.lua#L33","returns":[{"type":"number","value":"number Angle in radians or nothing if the argument is out of range","description":"Angle in radians or nothing if the argument is out of range"}],"realm":"shared","params":[{"type":"number","value":"number cos Cosine value in range of -1 to 1","name":"cos","description":"Cosine value in range of -1 to 1"}],"class":"function","name":"acos","description":" Calculates an angle in radians, between 0 and pi, which has the given cos value."},"distanceToLine":{"path":"libs_sh/math.lua#L368","returns":[{"type":"number","value":"number Distance from line","description":"Distance from line"},{"type":"Vector","value":"Vector Nearest point on line","description":"Nearest point on line"},{"type":"number","value":"number Distance along line from start","description":"Distance along line from start"}],"realm":"shared","params":[{"type":"Vector","value":"Vector lineStart Start of the line","name":"lineStart","description":"Start of the line"},{"type":"Vector","value":"Vector lineEnd End of the line","name":"lineEnd","description":"End of the line"},{"type":"Vector","value":"Vector pointPos Position of the point","name":"pointPos","description":"Position of the point"}],"class":"function","name":"distanceToLine","description":" Gets the distance between a line and a point in 3d space"},"normalizeAngle":{"path":"libs_sh/math.lua#L219","returns":[{"type":"number","value":"number The normalized angle","description":"The normalized angle"}],"realm":"shared","params":[{"type":"number","value":"number ang The angle in degrees","name":"ang","description":"The angle in degrees"}],"class":"function","name":"normalizeAngle","description":" Normalizes angle, so it returns value between -180 and 180."},"timeFraction":{"path":"libs_sh/math.lua#L308","returns":[{"type":"number","value":"number The time fraction","description":"The time fraction"}],"realm":"shared","params":[{"type":"number","value":"number start Start time in seconds","name":"start","description":"Start time in seconds"},{"type":"number","value":"number end End time in seconds","name":"end","description":"End time in seconds"},{"type":"number","value":"number current Current time in seconds","name":"current","description":"Current time in seconds"}],"class":"function","name":"timeFraction","description":" Calculates the fraction of where the current time is relative to the start and end times."},"factorial":{"path":"libs_sh/math.lua#L234","returns":[{"type":"number","value":"number Factorial of value","description":"Factorial of value"}],"realm":"shared","params":[{"type":"number","value":"number value The number value","name":"value","description":"The number value"}],"class":"function","name":"factorial","description":" Returns factorial of given value"},"log10":{"path":"libs_sh/math.lua#L194","returns":[{"type":"number","value":"number Logarithm of x to the base 10","description":"Logarithm of x to the base 10"}],"realm":"shared","params":[{"type":"number","value":"number x The value to get the base from exponent from","name":"x","description":"The value to get the base from exponent from"}],"class":"function","name":"log10","description":" Returns the base-10 logarithm of x. This is usually more accurate than math.log(x, 10)."},"sign":{"path":"libs_sh/math.lua#L25","returns":[{"type":"number","value":"number -1 if negative, 1 if positive, 0 if 0","description":"-1 if negative, 1 if positive, 0 if 0"}],"realm":"shared","params":[{"type":"number","value":"number x The number to get the sign of","name":"x","description":"The number to get the sign of"}],"class":"function","name":"sign","description":" Calculates the sign of a number"},"easeInOutCirc":{"path":"libs_sh/math.lua#L482","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutCirc","description":" Eases in and out using a circular function."},"round":{"path":"libs_sh/math.lua#L272","realm":"shared","params":[{"type":"number","value":"number value The number to be rounded","name":"value","description":"The number to be rounded"},{"type":"number?","value":"number? decimals Optional decimal places to round to. Defaults to 0","name":"decimals","description":"Optional decimal places to round to. Defaults to 0"}],"class":"function","name":"round","description":" Rounds the given value to the nearest whole number or to the given decimal places."},"easeInOutQuint":{"path":"libs_sh/math.lua#L518","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutQuint","description":" Eases in and out by raising the fraction to the power of 5."},"ldexp":{"path":"libs_sh/math.lua#L179","returns":[{"type":"number","value":"number Floating point reperesentation","description":"Floating point reperesentation"}],"realm":"shared","params":[{"type":"number","value":"number normalizedFraction The value to get the normalized fraction and the exponent from","name":"normalizedFraction","description":"The value to get the normalized fraction and the exponent from"},{"type":"number","value":"number exponent The value to get the normalized fraction and the exponent from","name":"exponent","description":"The value to get the normalized fraction and the exponent from"}],"class":"function","name":"ldexp","description":" Takes a normalised number and returns the floating point representation."},"deg":{"path":"libs_sh/math.lua#L122","returns":[{"type":"number","value":"number Angle in degrees","description":"Angle in degrees"}],"realm":"shared","params":[{"type":"number","value":"number rad Angle in radians to be converted","name":"rad","description":"Angle in radians to be converted"}],"class":"function","name":"deg","description":" Converts radians to degrees"},"nlerpQuaternion":{"path":"libs_sh/quaternion.lua#L875","returns":[{"type":"Quaternion","value":"Quaternion Interpolated quaternion","description":"Interpolated quaternion"}],"realm":"shared","params":[{"type":"Quaternion","value":"Quaternion quat1 Quaternion to start with","name":"quat1","description":"Quaternion to start with"},{"type":"Quaternion","value":"Quaternion quat2 Quaternion to end with","name":"quat2","description":"Quaternion to end with"},{"type":"number","value":"number t Ratio, 0 = quat1; 1 = quat2","name":"t","description":"Ratio, 0 = quat1; 1 = quat2"}],"class":"function","name":"nlerpQuaternion","description":" Performs normalized linear interpolation between two quaternions"},"intToBin":{"path":"libs_sh/math.lua#L173","returns":[{"type":"string","value":"string Binary number string. The length of this will always be a multiple of 3","description":"Binary number string. The length of this will always be a multiple of 3"}],"realm":"shared","params":[{"type":"number","value":"number int Number to be converted","name":"int","description":"Number to be converted"}],"class":"function","name":"intToBin","description":" Converts an integer to a binary (base-2) string."},"rand":{"path":"libs_sh/math.lua#L246","returns":[{"type":"number","value":"number Random float between min and max","description":"Random float between min and max"}],"realm":"shared","params":[{"type":"number","value":"number min The minimum value","name":"min","description":"The minimum value"},{"type":"number","value":"number max The maximum value","name":"max","description":"The maximum value"}],"class":"function","name":"rand","description":" Returns a random float between min and max."},"atan2":{"path":"libs_sh/math.lua#L74","returns":[{"type":"number","value":"number Angle of the line from (0, 0) to (x, y) in radians, in the range -pi to pi","description":"Angle of the line from (0, 0) to (x, y) in radians, in the range -pi to pi"}],"realm":"shared","params":[{"type":"number","value":"number y The Y coordinate","name":"y","description":"The Y coordinate"},{"type":"number","value":"number x The X coordinate","name":"x","description":"The X coordinate"}],"class":"function","name":"atan2","description":" Functions like math.atan(y / x), except it also takes into account the quadrant of the angle and so doesn't have a limited range of output."},"easeOutElastic":{"path":"libs_sh/math.lua#L578","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeOutElastic","description":" Eases out like a rubber band."},"easeOutQuint":{"path":"libs_sh/math.lua#L590","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeOutQuint","description":" Eases out by raising the fraction to the power of 5."},"calcBSplineN":{"path":"libs_sh/math.lua#L87","returns":[{"type":"number","value":"number Number value","description":"Number value"}],"realm":"shared","params":[{"type":"number","value":"number i","name":"i","description":""},{"type":"number","value":"number k","name":"k","description":""},{"type":"number","value":"number t","name":"t","description":""},{"type":"number","value":"number tinc","name":"tinc","description":""}],"class":"function","name":"calcBSplineN","description":" Basic code for Bezier-Spline algorithm."},"slerpQuaternion":{"path":"libs_sh/quaternion.lua#L848","returns":[{"type":"Quaternion","value":"Quaternion Interpolated quaternion","description":"Interpolated quaternion"}],"realm":"shared","params":[{"type":"Quaternion","value":"Quaternion quat1 Quaternion to start with","name":"quat1","description":"Quaternion to start with"},{"type":"Quaternion","value":"Quaternion quat2 Quaternion to end with","name":"quat2","description":"Quaternion to end with"},{"type":"number","value":"number t Ratio, 0 = quat1; 1 = quat2","name":"t","description":"Ratio, 0 = quat1; 1 = quat2"}],"class":"function","name":"slerpQuaternion","description":" Performs spherical linear interpolation between two quaternions"},"easeOutSine":{"path":"libs_sh/math.lua#L596","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeOutSine","description":" Eases out using math.sin."},"easeInOutElastic":{"path":"libs_sh/math.lua#L494","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutElastic","description":" Eases in and out like a rubber band."},"random":{"path":"libs_sh/math.lua#L253","returns":[{"type":"number","value":"number Random value","description":"Random value"}],"realm":"shared","params":[{"type":"number?","value":"number? m Optional integer value. If n is not provided - upper limit; if n is provided - lower limit","name":"m","description":"Optional integer value. If n is not provided - upper limit; if n is provided - lower limit"},{"type":"number?","value":"number? n Optional integer value. Upper value","name":"n","description":"Optional integer value. Upper value"}],"class":"function","name":"random","description":" When called without arguments, returns a uniform pseudo-random real number in the range 0 to 1 which includes 0 but excludes 1.\n When called with an integer number m, returns a uniform pseudo-random integer in the range 1 to m inclusive.\n When called with two integer numbers m and n, returns a uniform pseudo-random integer in the range m to n inclusive."},"max":{"path":"libs_sh/math.lua#L200","returns":[{"type":"number","value":"number The largest number","description":"The largest number"}],"realm":"shared","params":[{"type":"...number","value":"...number numbers Any amount of number values","name":"numbers","description":"Any amount of number values"}],"class":"function","name":"max","description":" Picks the largest value of all provided arguments."},"bezierVectorCubic":{"path":"libs_sh/math.lua#L398","returns":[{"type":"Vector","value":"Vector Vector representing the point along the curve.","description":"Vector representing the point along the curve."}],"realm":"shared","params":[{"type":"number","value":"number ratio Number representing how far along the curve, 0-1.","name":"ratio","description":"Number representing how far along the curve, 0-1."},{"type":"Vector","value":"Vector start The start position of the curve.","name":"start","description":"The start position of the curve."},{"type":"Vector","value":"Vector tangent1 First tangent","name":"tangent1","description":"First tangent"},{"type":"Vector","value":"Vector tangent2 Second tangent","name":"tangent2","description":"Second tangent"},{"type":"Vector","value":"Vector end The end position of the curve.","name":"end","description":"The end position of the curve."}],"class":"function","name":"bezierVectorCubic","description":" Returns a point along a cubic bezier curve."},"lerpAngle":{"path":"libs_sh/math.lua#L346","returns":[{"type":"Angle","value":"Angle The interpolated angle","description":"The interpolated angle"}],"realm":"shared","params":[{"type":"number","value":"number ratio Ratio of progress through values","name":"ratio","description":"Ratio of progress through values"},{"type":"Angle","value":"Angle from Angle to begin from","name":"from","description":"Angle to begin from"},{"type":"Angle","value":"Angle to Angle to end at","name":"to","description":"Angle to end at"}],"class":"function","name":"lerpAngle","description":" Calculates point between first and second angle using given fraction and linear interpolation."},"sharedRandom":{"path":"libs_sh/math.lua#L422","returns":[{"type":"number","value":"number The random float value","description":"The random float value"}],"realm":"shared","params":[{"type":"string","value":"string uniqueName The seed for the random value","name":"uniqueName","description":"The seed for the random value"},{"type":"number","value":"number Min The minimum value of the random range","name":"Min","description":"The minimum value of the random range"},{"type":"number","value":"number Max The maximum value of the random range","name":"Max","description":"The maximum value of the random range"},{"type":"number?","value":"number? additionalSeed The additional seed. Default 0","name":"additionalSeed","description":"The additional seed. Default 0"}],"class":"function","name":"sharedRandom","description":" Generates a random float value that should be the same on client and server"},"easeOutBounce":{"path":"libs_sh/math.lua#L560","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeOutBounce","description":" Eases out like a bouncy ball."},"easeOutBack":{"path":"libs_sh/math.lua#L554","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeOutBack","description":" Eases out by reversing the direction of the ease slightly before finishing."},"easeInQuad":{"path":"libs_sh/math.lua#L530","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInQuad","description":" Eases in by squaring the fraction."},"easeInSine":{"path":"libs_sh/math.lua#L548","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInSine","description":" Eases in using math.sin."},"angleDifference":{"path":"libs_sh/math.lua#L39","returns":[{"type":"number","value":"number The difference between the angles between -180 and 180","description":"The difference between the angles between -180 and 180"}],"realm":"shared","params":[{"type":"number","value":"number a The first angle","name":"a","description":"The first angle"},{"type":"number","value":"number b The second angle","name":"b","description":"The second angle"}],"class":"function","name":"angleDifference","description":" Calculates the difference between two angles."},"cos":{"path":"libs_sh/math.lua#L110","returns":[{"type":"number","value":"number Cosine of the angle","description":"Cosine of the angle"}],"realm":"shared","params":[{"type":"number","value":"number angle Angle in radians","name":"angle","description":"Angle in radians"}],"class":"function","name":"cos","description":" Calculates cosine of the given angle."},"easeInCubic":{"path":"libs_sh/math.lua#L452","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInCubic","description":" Eases in by cubing the fraction."},"easeInOutQuart":{"path":"libs_sh/math.lua#L512","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutQuart","description":" Eases in and out by raising the fraction to the power of 4."},"easeOutQuart":{"path":"libs_sh/math.lua#L584","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeOutQuart","description":" Eases out by raising the fraction to the power of 4."},"easeOutCirc":{"path":"libs_sh/math.lua#L566","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeOutCirc","description":" Eases out using a circular function."},"fmod":{"path":"libs_sh/math.lua#L157","returns":[{"type":"number","value":"number The calculated modulus","description":"The calculated modulus"}],"realm":"shared","params":[{"type":"number","value":"number base The base value","name":"base","description":"The base value"},{"type":"number","value":"number mod The modulator","name":"mod","description":"The modulator"}],"class":"function","name":"fmod","description":" Calculates the modulus of the specified values."},"atan":{"path":"libs_sh/math.lua#L68","returns":[{"type":"number","value":"number Angle in radians","description":"Angle in radians"}],"realm":"shared","params":[{"type":"number","value":"number tan Tangent value","name":"tan","description":"Tangent value"}],"class":"function","name":"atan","description":" Calculates an angle in radians, in the range -pi/2 to pi/2, which has the given tangent."},"floor":{"path":"libs_sh/math.lua#L151","returns":[{"type":"number","value":"number Rounded number","description":"Rounded number"}],"realm":"shared","params":[{"type":"number","value":"number n Number to be rounded","name":"n","description":"Number to be rounded"}],"class":"function","name":"floor","description":" Rounds a number down."},"asin":{"path":"libs_sh/math.lua#L62","returns":[{"type":"number","value":"number Angle in radians or nothing if the argument is out of range","description":"Angle in radians or nothing if the argument is out of range"}],"realm":"shared","params":[{"type":"number","value":"number sin Sine value in the range of -1 to 1","name":"sin","description":"Sine value in the range of -1 to 1"}],"class":"function","name":"asin","description":" Calculates an angle in radians, in the range -pi/2 to pi/2, which has the given sine value."},"easeInOut":{"path":"libs_sh/math.lua#L137","returns":[{"type":"number","value":"number Eased value","description":"Eased value"}],"realm":"shared","params":[{"type":"number","value":"number progress Fraction of the progress to ease","name":"progress","description":"Fraction of the progress to ease"},{"type":"number","value":"number easeIn Fraction of how much easing to begin with","name":"easeIn","description":"Fraction of how much easing to begin with"},{"type":"number","value":"number easeOut Fraction of how much easing to end with","name":"easeOut","description":"Fraction of how much easing to end with"}],"class":"function","name":"easeInOut","description":" Calculates the progress of a value fraction, taking in to account given easing fractions."},"binToInt":{"path":"libs_sh/math.lua#L81","returns":[{"type":"number","value":"number Base 10 number","description":"Base 10 number"}],"realm":"shared","params":[{"type":"string","value":"string str Binary string to convert","name":"str","description":"Binary string to convert"}],"class":"function","name":"binToInt","description":" Converts a binary string into a number."},"modf":{"path":"libs_sh/math.lua#L212","returns":[{"type":"number","value":"number The integral component","description":"The integral component"},{"type":"number","value":"number The fractional component","description":"The fractional component"}],"realm":"shared","params":[{"type":"number","value":"number base The base value","name":"base","description":"The base value"}],"class":"function","name":"modf","description":" Returns the integral and fractional component of the modulo operation."},"approachAngle":{"path":"libs_sh/math.lua#L54","returns":[{"type":"number","value":"number Modified angle","description":"Modified angle"}],"realm":"shared","params":[{"type":"number","value":"number currentAngle The current angle to increase","name":"currentAngle","description":"The current angle to increase"},{"type":"number","value":"number targetAngle The angle to increase towards","name":"targetAngle","description":"The angle to increase towards"},{"type":"number","value":"number rate The amount to approach the target angle by","name":"rate","description":"The amount to approach the target angle by"}],"class":"function","name":"approachAngle","description":" Increments an angle towards another by specified rate."},"cosh":{"path":"libs_sh/math.lua#L116","returns":[{"type":"number","value":"number The hyperbolic cosine of the angle","description":"The hyperbolic cosine of the angle"}],"realm":"shared","params":[{"type":"number","value":"number angle Angle in radians","name":"angle","description":"Angle in radians"}],"class":"function","name":"cosh","description":" Calculates hyperbolic cosine of the given angle."},"easeInOutQuad":{"path":"libs_sh/math.lua#L506","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutQuad","description":" Eases in and out by squaring the fraction."},"abs":{"path":"libs_sh/math.lua#L19","returns":[{"type":"number","value":"number Absolute value","description":"Absolute value"}],"realm":"shared","params":[{"type":"number","value":"number x The number to get the absolute value of","name":"x","description":"The number to get the absolute value of"}],"class":"function","name":"abs","description":" Calculates the absolute value of a number (effectively removes any negative sign)."},"easeOutCubic":{"path":"libs_sh/math.lua#L572","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeOutCubic","description":" Eases out by cubing the fraction."},"sqrt":{"path":"libs_sh/math.lua#L290","returns":[{"type":"number","value":"number Square root of the provided value","description":"Square root of the provided value"}],"realm":"shared","params":[{"type":"number","value":"number value The value to get the square root of","name":"value","description":"The value to get the square root of"}],"class":"function","name":"sqrt","description":" Calculates square root of the number."},"clamp":{"path":"libs_sh/math.lua#L102","returns":[{"type":"number","value":"number Clamped number","description":"Clamped number"}],"realm":"shared","params":[{"type":"number","value":"number current Input number","name":"current","description":"Input number"},{"type":"number","value":"number min Minimum value","name":"min","description":"Minimum value"},{"type":"number","value":"number max Maximum value","name":"max","description":"Maximum value"}],"class":"function","name":"clamp","description":" Clamps a number between a minimum and maximum value."},"log":{"path":"libs_sh/math.lua#L186","returns":[{"type":"number","value":"number Logarithm of x to the given base","description":"Logarithm of x to the given base"}],"realm":"shared","params":[{"type":"number","value":"number x The value to get the base from exponent from","name":"x","description":"The value to get the base from exponent from"},{"type":"number?","value":"number? base Optional logarithmic base. Default 'e'","name":"base","description":"Optional logarithmic base. Default 'e'"}],"class":"function","name":"log","description":" With one argument, returns the natural logarithm of x (to base e).\n With two arguments, return the logarithm of x to the given base, calculated as log(x) / log(base)."},"rad":{"path":"libs_sh/math.lua#L240","returns":[{"type":"number","value":"number Angle in radians","description":"Angle in radians"}],"realm":"shared","params":[{"type":"number","value":"number deg Angle in degrees","name":"deg","description":"Angle in degrees"}],"class":"function","name":"rad","description":" Converts an angle from degrees to radians."},"bezierVector":{"path":"libs_sh/math.lua#L380","returns":[{"type":"Vector","value":"Vector Vector representing the point along the curve.","description":"Vector representing the point along the curve."}],"realm":"shared","params":[{"type":"number","value":"number ratio Number representing how far along the curve, 0-1.","name":"ratio","description":"Number representing how far along the curve, 0-1."},{"type":"Vector","value":"Vector start The start position of the curve.","name":"start","description":"The start position of the curve."},{"type":"Vector","value":"Vector middle The middle position of the curve.","name":"middle","description":"The middle position of the curve."},{"type":"Vector","value":"Vector end The end position of the curve.","name":"end","description":"The end position of the curve."}],"class":"function","name":"bezierVector","description":" Returns a point along a bezier curve."},"easeInOutBounce":{"path":"libs_sh/math.lua#L476","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInOutBounce","description":" Eases in and out like a bouncy ball."},"exp":{"path":"libs_sh/math.lua#L145","returns":[{"type":"number","value":"number e to the specific power","description":"e to the specific power"}],"realm":"shared","params":[{"type":"number","value":"number x The exponent of the function","name":"x","description":"The exponent of the function"}],"class":"function","name":"exp","description":" Returns the x power of the Euler constant."},"remap":{"path":"libs_sh/math.lua#L262","returns":[{"type":"number","value":"number The number in the new range","description":"The number in the new range"}],"realm":"shared","params":[{"type":"number","value":"number value The number value","name":"value","description":"The number value"},{"type":"number","value":"number inMin The minimum of the initial range","name":"inMin","description":"The minimum of the initial range"},{"type":"number","value":"number inMax The maximum of the initial range","name":"inMax","description":"The maximum of the initial range"},{"type":"number","value":"number outMin The minimum of new range","name":"outMin","description":"The minimum of new range"},{"type":"number","value":"number outMax The maximum of new range","name":"outMax","description":"The maximum of new range"}],"class":"function","name":"remap","description":" Remaps the value from one range to another."},"easeInElastic":{"path":"libs_sh/math.lua#L458","returns":[{"type":"number","value":"number \"Eased\" Value","description":"\"Eased\" Value"}],"realm":"shared","params":[{"type":"number","value":"number fraction Fraction of the progress to ease, from 0 to 1","name":"fraction","description":"Fraction of the progress to ease, from 0 to 1"}],"class":"function","name":"easeInElastic","description":" Eases in like a rubber band."}},"tables":[],"path":"libs_sh/math.lua#L4","fields":[],"realm":"shared","libtbl":["math_library"],"class":"library","name":"math","description":" Lua math library https://wiki.garrysmod.com/page/Category:math"},"midi":{"methods":{"closePort":{"path":"libs_cl/midi.lua#L80","returns":[{"type":"string","value":"string the name of the midi device closed at the given port.","description":"the name of the midi device closed at the given port."}],"realm":"client","params":[{"type":"number","value":"number port the midi port to close.","name":"port","description":"the midi port to close."}],"class":"function","name":"closePort","description":" Closes the specified midi port."},"getCode":{"path":"libs_cl/midi.lua#L87","returns":[{"type":"number","value":"number the command code","description":"the command code"}],"realm":"client","params":[{"type":"number","value":"number command the command","name":"command","description":"the command"}],"class":"function","name":"getCode","description":" Grabs the midi command code from the command."},"openPort":{"path":"libs_cl/midi.lua#L48","returns":[{"type":"string","value":"string the name of the midi device opened at the given port.","description":"the name of the midi device opened at the given port."}],"realm":"client","params":[{"type":"number","value":"number port the midi port to open. Passing nothing defaults to 0.","name":"port","description":"the midi port to open. Passing nothing defaults to 0."}],"class":"function","name":"openPort","description":" Opens the midi port to make it available to grab events from.  This must be called before the hook."},"isPortOpen":{"path":"libs_cl/midi.lua#L59","returns":[{"type":"boolean","value":"boolean if the port is open","description":"if the port is open"}],"realm":"client","class":"function","name":"isPortOpen","description":" Checks if the specified midi port is currently opened."},"getPorts":{"path":"libs_cl/midi.lua#L74","returns":[{"type":"table","value":"table the table of midi ports.  Starts at index 0","description":"the table of midi ports.  Starts at index 0"}],"realm":"client","class":"function","name":"getPorts","description":" Gets a table of all midi devices' ports."},"getChannel":{"path":"libs_cl/midi.lua#L94","returns":[{"type":"number","value":"number the midi channel","description":"the midi channel"}],"realm":"client","params":[{"type":"number","value":"number command the command","name":"command","description":"the command"}],"class":"function","name":"getChannel","description":" Grabs the midi channel from the command."},"getName":{"path":"libs_cl/midi.lua#L101","returns":[{"type":"string","value":"string command name","description":"command name"}],"realm":"client","params":[{"type":"number","value":"number command the command","name":"command","description":"the command"}],"class":"function","name":"getName","description":" Grabs the command code in a readable name."},"closeAllPorts":{"path":"libs_cl/midi.lua#L66","realm":"client","class":"function","name":"closeAllPorts","description":" Closes all midi ports."}},"tables":{"MIDI":{"path":"libs_sh/enum.lua#L1220","fields":[{"name":"NOTE_OFF","description":""},{"name":"NOTE_ON","description":""},{"name":"AFTERTOUCH","description":""},{"name":"CONTINUOUS_CONTROLLER","description":""},{"name":"PATCH_CHANGE","description":""},{"name":"CHANNEL_PRESSURE","description":""},{"name":"PITCH_BEND","description":""}],"realm":"shared","class":"table","name":"MIDI","description":" Midi Command ENUMS"}},"path":"libs_cl/midi.lua#L5","libtbl":["midi_library"],"realm":"client","fields":[],"class":"library","name":"midi","description":" Midi Library\n Polls midi event information from midi devices.\n Requires a custom binary -> https://github.com/FPtje/gmcl_midi/releases/tag/v0.2.0\n GNU/Linux and MacOS users will have to compile their own binaries.\n Instructions here -> https://github.com/FPtje/gmcl_midi/blob/master/Compiling.md"},"os":{"methods":{"date":{"path":"libs_sh/builtins.lua#L396","returns":[{"type":"string|table","value":"string|table If format is equal to '*t' or '!*t' then it will return a table with DateData structure, otherwise a string","description":"If format is equal to '*t' or '!*t' then it will return a table with DateData structure, otherwise a string"}],"realm":"shared","params":[{"type":"string","value":"string format The format string. If starts with an '!', it will use UTC timezone rather than the local timezone","name":"format","description":"The format string. If starts with an '!', it will use UTC timezone rather than the local timezone"},{"type":"number?","value":"number? time Time to use for the format. Default os.time()","name":"time","description":"Time to use for the format. Default os.time()"}],"class":"function","name":"date","description":" Returns the date/time as a formatted string or in a table.\n See https://wiki.facepunch.com/gmod/Structures/DateData for the table structure"},"time":{"path":"libs_sh/builtins.lua#L416","returns":[{"type":"number","value":"number Seconds passed since Unix epoch","description":"Seconds passed since Unix epoch"}],"realm":"shared","params":[{"type":"table?","value":"table? dateData Optional table to generate the time from. This table's data is interpreted as being in the local timezone","name":"dateData","description":"Optional table to generate the time from. This table's data is interpreted as being in the local timezone"}],"class":"function","name":"time","description":" Returns the system time in seconds past the unix epoch.\n If a table is supplied, the function attempts to build a system time with the specified table members"},"clock":{"path":"libs_sh/builtins.lua#L390","returns":[{"type":"number","value":"number The runtime","description":"The runtime"}],"realm":"shared","class":"function","name":"clock","description":" Returns the approximate cpu time the application ran.\n This function has different precision on Linux (1/100)."},"difftime":{"path":"libs_sh/builtins.lua#L409","returns":[{"type":"number","value":"number Time difference","description":"Time difference"}],"realm":"shared","params":[{"type":"number","value":"number timeA The first value","name":"timeA","description":"The first value"},{"type":"number","value":"number timeB The value to subtract","name":"timeB","description":"The value to subtract"}],"class":"function","name":"difftime","description":" Subtracts the second of the first value and rounds the result"}},"tables":[],"path":"libs_sh/builtins.lua#L20","libtbl":["os_library"],"realm":"shared","fields":[],"class":"library","name":"os","description":" Lua os library https://wiki.garrysmod.com/page/Category:os"},"timer":{"methods":{"exists":{"path":"libs_sh/timer.lua#L134","returns":[{"type":"boolean","value":"boolean if the timer exists","description":"if the timer exists"}],"realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"}],"class":"function","name":"exists","description":" Checks if a timer exists"},"toggle":{"path":"libs_sh/timer.lua#L199","returns":[{"type":"boolean","value":"boolean Status of the timer.","description":"Status of the timer."}],"realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"}],"class":"function","name":"toggle","description":" Runs either timer.pause or timer.unpause based on the timer's current status."},"create":{"path":"libs_sh/timer.lua#L98","realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"},{"type":"number","value":"number delay The time, in seconds, to set the timer to.","name":"delay","description":"The time, in seconds, to set the timer to."},{"type":"number","value":"number reps The repetitions of the timer. 0 = infinite","name":"reps","description":"The repetitions of the timer. 0 = infinite"},{"type":"function","value":"function func The function to call when the timer is fired","name":"func","description":"The function to call when the timer is fired"}],"class":"function","name":"create","description":" Creates (and starts) a timer"},"getTimersLeft":{"path":"libs_sh/timer.lua#L226","returns":[{"type":"number","value":"number Number of available timers","description":"Number of available timers"}],"realm":"shared","class":"function","name":"getTimersLeft","description":" Returns number of available timers"},"start":{"path":"libs_sh/timer.lua#L150","returns":[{"type":"boolean","value":"boolean True if the timer exists, false if it doesn't.","description":"True if the timer exists, false if it doesn't."}],"realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"}],"class":"function","name":"start","description":" Starts a timer"},"timeleft":{"path":"libs_sh/timer.lua#L208","returns":[{"type":"number","value":"number The amount of time left (in seconds). If the timer is paused, the amount will be negative. Nil if timer doesnt exist","description":"The amount of time left (in seconds). If the timer is paused, the amount will be negative. Nil if timer doesnt exist"}],"realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"}],"class":"function","name":"timeleft","description":" Returns amount of time left (in seconds) before the timer executes its function."},"frametime":{"path":"libs_sh/timer.lua#L51","returns":[{"type":"number","value":"number The time between frames / ticks depending on realm","description":"The time between frames / ticks depending on realm"}],"realm":"shared","class":"function","name":"frametime","description":" Returns time between frames on client and ticks on server. Same thing as G.FrameTime in GLua"},"adjust":{"path":"libs_sh/timer.lua#L159","returns":[{"type":"boolean","value":"boolean True if succeeded","description":"True if succeeded"}],"realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"},{"type":"number","value":"number delay The time, in seconds, to set the timer to.","name":"delay","description":"The time, in seconds, to set the timer to."},{"type":"number?","value":"number? reps (Optional) The repetitions of the timer. 0 = infinite, nil = 1","name":"reps","description":"(Optional) The repetitions of the timer. 0 = infinite, nil = 1"},{"type":"function?","value":"function? func (Optional) The function to call when the timer is fired","name":"func","description":"(Optional) The function to call when the timer is fired"}],"class":"function","name":"adjust","description":" Adjusts a timer"},"pause":{"path":"libs_sh/timer.lua#L181","returns":[{"type":"boolean","value":"boolean false if the timer didn't exist or was already paused, true otherwise.","description":"false if the timer didn't exist or was already paused, true otherwise."}],"realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"}],"class":"function","name":"pause","description":" Pauses a timer"},"systime":{"path":"libs_sh/timer.lua#L45","returns":[{"type":"number","value":"number The time in seconds since start up","description":"The time in seconds since start up"}],"realm":"shared","class":"function","name":"systime","description":" Returns a highly accurate time in seconds since the start up, ideal for benchmarking."},"repsleft":{"path":"libs_sh/timer.lua#L217","returns":[{"type":"number","value":"number The amount of executions left. Nil if timer doesnt exist","description":"The amount of executions left. Nil if timer doesnt exist"}],"realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"}],"class":"function","name":"repsleft","description":" Returns amount of repetitions/executions left before the timer destroys itself."},"remove":{"path":"libs_sh/timer.lua#L121","realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"}],"class":"function","name":"remove","description":" Stops and removes the timer."},"realtime":{"path":"libs_sh/timer.lua#L38","returns":[{"type":"number","value":"number Realtime in seconds","description":"Realtime in seconds"}],"realm":"shared","class":"function","name":"realtime","description":" Returns the uptime of the game/server in seconds (to at least 4 decimal places)\n Ideal for timing real world events since it updates local to the realm thinking, being clientside FPS or server tickrate"},"stop":{"path":"libs_sh/timer.lua#L142","returns":[{"type":"boolean","value":"boolean False if the timer didn't exist or was already stopped, true otherwise.","description":"False if the timer didn't exist or was already stopped, true otherwise."}],"realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"}],"class":"function","name":"stop","description":" Stops a timer"},"curtime":{"path":"libs_sh/timer.lua#L31","returns":[{"type":"number","value":"number Curtime in seconds","description":"Curtime in seconds"}],"realm":"shared","class":"function","name":"curtime","description":" Returns the uptime of the server in seconds (to at least 4 decimal places)\n You should not use this for timing real world events as it is synchronized with the server, use realtime instead"},"simple":{"path":"libs_sh/timer.lua#L112","realm":"shared","params":[{"type":"number","value":"number delay The time, in second, to set the timer to","name":"delay","description":"The time, in second, to set the timer to"},{"type":"function","value":"function func The function to call when the timer is fired","name":"func","description":"The function to call when the timer is fired"}],"class":"function","name":"simple","description":" Creates a simple timer, has no name, can't be stopped, paused, or destroyed."},"unpause":{"path":"libs_sh/timer.lua#L190","returns":[{"type":"boolean","value":"boolean false if the timer didn't exist or was already running, true otherwise.","description":"false if the timer didn't exist or was already running, true otherwise."}],"realm":"shared","params":[{"type":"string","value":"string name The timer name","name":"name","description":"The timer name"}],"class":"function","name":"unpause","description":" Unpauses a timer"}},"tables":[],"path":"libs_sh/timer.lua#L8","libtbl":["timer_library"],"realm":"shared","fields":[],"class":"library","name":"timer","description":" Deals with time and timers."},"darkrp":{"methods":{"openF1Menu":{"path":"libs_sh/darkrp2.lua#L755","realm":"client","class":"function","name":"openF1Menu","description":" Open the F1 help menu. Roughly equivalent to pressing F1 (or running gm_showhelp), but won't close it if it's already open.\n Only works if the local player is the owner of the chip, or if the chip is running in superuser mode."},"doorIndexToEnt":{"path":"libs_sh/darkrp2.lua#L642","returns":[{"type":"Entity?","value":"Entity? The door entity, or nil if the index is invalid or the door was removed.","description":"The door entity, or nil if the index is invalid or the door was removed."}],"realm":"server","params":[{"type":"number","value":"number doorIndex The door index","name":"doorIndex","description":"The door index"}],"class":"function","name":"doorIndexToEnt","description":" Get the entity corresponding to a door index. Note: The door MUST have been created by the map!"},"canMakeMoneyRequest":{"path":"libs_sh/darkrp2.lua#L726","returns":[{"type":"boolean","value":"boolean If you can make another money request","description":"If you can make another money request"}],"realm":"server","params":[{"type":"Player?","value":"Player? sender Player you intend to ask for money from later (if nil, will only check your money request rate)","name":"sender","description":"Player you intend to ask for money from later (if nil, will only check your money request rate)"}],"class":"function","name":"canMakeMoneyRequest","description":" Returns whether you can make another money request this tick.\n If a player is provided as a parameter, will also check if you can request money from that particular player this tick."},"canGiveMoney":{"path":"libs_sh/darkrp2.lua#L748","returns":[{"type":"boolean","value":"boolean If you can give someone money","description":"If you can give someone money"}],"realm":"server","class":"function","name":"canGiveMoney","description":" Returns whether you can give someone money this tick."},"closeF4Menu":{"path":"libs_sh/darkrp2.lua#L779","realm":"client","class":"function","name":"closeF4Menu","description":" Close the F4 menu (the one where you can choose your job, buy shipments, ammo, money printers, etc).\n Only works if the local player is the owner of the chip, or if the chip is running in superuser mode."},"getFoodItems":{"path":"libs_sh/darkrp2.lua#L614","returns":[{"type":"table?","value":"table? Table with food items, or nil if there are none.","description":"Table with food items, or nil if there are none."}],"realm":"shared","class":"function","name":"getFoodItems","description":" Get all food items."},"requestMoney":{"path":"libs_sh/darkrp2.lua#L683","realm":"server","params":[{"type":"Player","value":"Player sender The player who may or may not send the money.","name":"sender","description":"The player who may or may not send the money."},{"type":"number","value":"number amount The amount of money to ask for.","name":"amount","description":"The amount of money to ask for."},{"type":"string?","value":"string? message An optional custom message that will be shown in the money request prompt. May not exceed 60 bytes in length.","name":"message","description":"An optional custom message that will be shown in the money request prompt. May not exceed 60 bytes in length."},{"type":"function?","value":"function? callbackSuccess Optional function to call if request succeeds. Args (string: The request message, player: The money sender, number: The amount)","name":"callbackSuccess","description":"Optional function to call if request succeeds. Args (string: The request message, player: The money sender, number: The amount)"},{"type":"function?","value":"function? callbackFailure Optional function to call if request fails. Args (string: why it failed)","name":"callbackFailure","description":"Optional function to call if request fails. Args (string: why it failed)"},{"type":"Player?","value":"Player? receiver The player who may or may not receive the money, or the owner of the chip if not specified. Superuser only.","name":"receiver","description":"The player who may or may not receive the money, or the owner of the chip if not specified. Superuser only."}],"class":"function","name":"requestMoney","description":" Request money from a player.\n This is subject to a burst limit, and a limit of one money request per sender per receiver at a time. Use \"darkrp.canMakeMoneyRequest\" to check if you can request money that tick for that player."},"moneyRequestsLeft":{"path":"libs_sh/darkrp2.lua#L717","returns":[{"type":"number","value":"number Number of money requests able to be created. This could be a decimal, so floor it first","description":"Number of money requests able to be created. This could be a decimal, so floor it first"}],"realm":"server","class":"function","name":"moneyRequestsLeft","description":" Returns number of money requests left.\n By default, this replenishes at a rate of 1 every 2 seconds, up to a maximum of 1.\n In other words, you can make a maximum of 1 money request every 2 seconds. May vary from server to server."},"openPocketMenu":{"path":"libs_sh/darkrp2.lua#L803","realm":"client","class":"function","name":"openPocketMenu","description":" Open the DarkRP pocket menu. This refers to DarkRP's built-in \"pocket\", and probably not your server's custom inventory system.\n Only works if the local player is the owner of the chip, or if the chip is running in superuser mode."},"payPlayer":{"path":"libs_sh/darkrp2.lua#L661","realm":"server","params":[{"type":"Player","value":"Player sender The player who gives the money.","name":"sender","description":"The player who gives the money."},{"type":"Player","value":"Player receiver The player who receives the money.","name":"receiver","description":"The player who receives the money."},{"type":"number","value":"number amount The amount of money.","name":"amount","description":"The amount of money."}],"class":"function","name":"payPlayer","description":" Make one player give money to the other player.\n This is subject to a burst limit. Use \"darkrp.canGiveMoney\" to check if you can give out money that tick.\n Only works if the sender is the owner of the chip, or if the chip is running in superuser mode."},"formatMoney":{"path":"libs_sh/darkrp2.lua#L594","returns":[{"type":"string","value":"string The money as a nice string, e.g. \"$100,000\".","description":"The money as a nice string, e.g. \"$100,000\"."}],"realm":"shared","params":[{"type":"number","value":"number amount The money to format, e.g. 100000.","name":"amount","description":"The money to format, e.g. 100000."}],"class":"function","name":"formatMoney","description":" Format a number as a money value. Includes currency symbol."},"isDarkRPVarBlacklisted":{"path":"libs_sh/darkrp2.lua#L633","returns":[{"type":"boolean","value":"boolean If the variable is blacklisted","description":"If the variable is blacklisted"}],"realm":"shared","params":[{"type":"string","value":"string var The name of the variable","name":"var","description":"The name of the variable"}],"class":"function","name":"isDarkRPVarBlacklisted","description":" Get whether a DarkRPVar is blacklisted from being read by Starfall."},"moneyGivingsLeft":{"path":"libs_sh/darkrp2.lua#L739","returns":[{"type":"number","value":"number Number of money requests able to be created. This could be a decimal, so floor it first","description":"Number of money requests able to be created. This could be a decimal, so floor it first"}],"realm":"server","class":"function","name":"moneyGivingsLeft","description":" Returns number of times you can give someone money.\n By default, this replenishes at a rate of 1 every 2 seconds, up to a maximum of 2.\n In other words, you can give out money two times at once, then you have to wait two seconds. May vary from server to server."},"toggleF4Menu":{"path":"libs_sh/darkrp2.lua#L787","realm":"client","class":"function","name":"toggleF4Menu","description":" Toggle the state of the F4 menu (open or closed). Equivalent to pressing F4 (or running gm_showspare2).\n Only works if the local player is the owner of the chip, or if the chip is running in superuser mode."},"openF4Menu":{"path":"libs_sh/darkrp2.lua#L771","realm":"client","class":"function","name":"openF4Menu","description":" Open the F4 menu (the one where you can choose your job, buy shipments, ammo, money printers, etc). Roughly equivalent to pressing F4 (or running gm_showspare2), but won't close it if it's already open.\n Only works if the local player is the owner of the chip, or if the chip is running in superuser mode."},"getLaws":{"path":"libs_sh/darkrp2.lua#L621","returns":[{"type":"table","value":"table A table of all current laws.","description":"A table of all current laws."}],"realm":"shared","class":"function","name":"getLaws","description":" Get the table of all current laws."},"getAvailableVehicles":{"path":"libs_sh/darkrp2.lua#L602","returns":[{"type":"table","value":"table Names, models and classnames of all supported vehicles.","description":"Names, models and classnames of all supported vehicles."}],"realm":"shared","class":"function","name":"getAvailableVehicles","description":" Get the available vehicles that DarkRP supports."},"getCategories":{"path":"libs_sh/darkrp2.lua#L608","returns":[{"type":"table","value":"table All categories.","description":"All categories."}],"realm":"shared","class":"function","name":"getCategories","description":" Get all categories for all F4 menu tabs, including all jobs and every entity available for purchase."},"closeF1Menu":{"path":"libs_sh/darkrp2.lua#L763","realm":"client","class":"function","name":"closeF1Menu","description":" Close the F1 help menu.\n Only works if the local player is the owner of the chip, or if the chip is running in superuser mode."},"getCustomShipments":{"path":"libs_sh/darkrp2.lua#L627","returns":[{"type":"table?","value":"table? A table with the contents of the GLua global \"CustomShipments\", or nil if it doesn't exist.","description":"A table with the contents of the GLua global \"CustomShipments\", or nil if it doesn't exist."}],"realm":"shared","class":"function","name":"getCustomShipments","description":" Get a list of possible shipments."},"openKeysMenu":{"path":"libs_sh/darkrp2.lua#L795","realm":"client","class":"function","name":"openKeysMenu","description":" Buy the door the local player is looking at, or open the menu if it's already bought. Equivalent to pressing F2 (or running gm_showteam).\n Only works if the local player is the owner of the chip, or if the chip is running in superuser mode."},"jailPosCount":{"path":"libs_sh/darkrp2.lua#L654","returns":[{"type":"number","value":"number The number of jail positions in the current map.","description":"The number of jail positions in the current map."}],"realm":"server","class":"function","name":"jailPosCount","description":" Get the number of jail positions in the current map."}},"tables":[],"path":"libs_sh/darkrp2.lua#L566","libtbl":["darkrp_library"],"realm":"shared","fields":[],"class":"library","name":"darkrp","description":" Functions relating to DarkRP. These functions WILL NOT EXIST if DarkRP is not in use."},"string":{"methods":{"getPathFromFilename":{"path":"libs_sh/string.lua#L113","returns":[{"type":"string","value":"string The path","description":"The path"}],"realm":"shared","params":[{"type":"string","value":"string str File-path to get the file extensions from","name":"str","description":"File-path to get the file extensions from"}],"class":"function","name":"getPathFromFilename","description":" Returns the path only from a file's path, excluding the file itself."},"format":{"path":"libs_sh/string.lua#L86","returns":[{"type":"string","value":"string The formatted string","description":"The formatted string"}],"realm":"shared","params":[{"type":"string","value":"string str The string to be formatted","name":"str","description":"The string to be formatted"},{"type":"...","value":"... params Vararg values to be formatted into the string","name":"params","description":"Vararg values to be formatted into the string"}],"class":"function","name":"format","description":" Formats the specified values into the string given. http://www.cplusplus.com/reference/cstdio/printf/"},"len":{"path":"libs_sh/string.lua#L149","returns":[{"type":"number","value":"number Length of the string","description":"Length of the string"}],"realm":"shared","params":[{"type":"string","value":"string str The string to find the length of","name":"str","description":"The string to find the length of"}],"class":"function","name":"len","description":" Counts the number of characters in the string. This is equivalent to using the # operator."},"comma":{"path":"libs_sh/string.lua#L47","returns":[{"type":"string","value":"string String with commas inserted","description":"String with commas inserted"}],"realm":"shared","params":[{"type":"number","value":"number num The number to be separated by commas","name":"num","description":"The number to be separated by commas"}],"class":"function","name":"comma","description":" Inserts commas for every third digit."},"javascriptSafe":{"path":"libs_sh/string.lua#L136","returns":[{"type":"string","value":"string The safe string","description":"The safe string"}],"realm":"shared","params":[{"type":"string","value":"string str The string that should be escaped","name":"str","description":"The string that should be escaped"}],"class":"function","name":"javascriptSafe","description":" Escapes special characters for JavaScript in a string, making the string safe for inclusion in to JavaScript strings."},"gsub":{"path":"libs_sh/string.lua#L126","returns":[{"type":"string","value":"string String with replaced parts","description":"String with replaced parts"},{"type":"number","value":"number Replacements count","description":"Replacements count"}],"realm":"shared","params":[{"type":"string","value":"string str String which should be modified.","name":"str","description":"String which should be modified."},{"type":"string","value":"string pattern The pattern that defines what should be matched and eventually be replaced.","name":"pattern","description":"The pattern that defines what should be matched and eventually be replaced."},{"type":"string|table|function","value":"string|table|function replacement If string: matched sequence will be replaced with it; If table: matched sequence will be used as key; If function: matches will be passed as parameters to the function (return to replace)","name":"replacement","description":"If string: matched sequence will be replaced with it; If table: matched sequence will be used as key; If function: matches will be passed as parameters to the function (return to replace)"},{"type":"number?","value":"number? max Optional maximum number of replacements to be made","name":"max","description":"Optional maximum number of replacements to be made"}],"class":"function","name":"gsub","description":" This functions main purpose is to replace certain character sequences in a string using Patterns."},"replace":{"path":"libs_sh/string.lua#L203","returns":[{"type":"string","value":"string String with parts replaced","description":"String with parts replaced"}],"realm":"shared","params":[{"type":"string","value":"string str The string we are seeking to replace an occurrence(s)","name":"str","description":"The string we are seeking to replace an occurrence(s)"},{"type":"string","value":"string find What we are seeking to replace","name":"find","description":"What we are seeking to replace"},{"type":"string","value":"string replace What to replace find with","name":"replace","description":"What to replace find with"}],"class":"function","name":"replace","description":" Replaces all occurrences of the supplied second string."},"formattedTime":{"path":"libs_sh/string.lua#L93","returns":[{"type":"string|table","value":"string|table Formatted string or a table","description":"Formatted string or a table"}],"realm":"shared","params":[{"type":"number","value":"number time The time in seconds to format","name":"time","description":"The time in seconds to format"},{"type":"string?","value":"string? format An optional formatting to use. If no format it specified, a table will be returned instead","name":"format","description":"An optional formatting to use. If no format it specified, a table will be returned instead"}],"class":"function","name":"formattedTime","description":" Returns the time as a formatted string or table. http://www.cplusplus.com/reference/cstdio/printf/\n If format is not specified, the table will contain the following keys: ms (milliseconds); s (seconds); m (minutes); h (hours)."},"char":{"path":"libs_sh/string.lua#L41","returns":[{"type":"string","value":"string String built from given bytes","description":"String built from given bytes"}],"realm":"shared","params":[{"type":"...","value":"... bytes The bytes to create the string from","name":"bytes","description":"The bytes to create the string from"}],"class":"function","name":"char","description":" Takes the given numerical bytes and converts them to a string."},"toHoursMinutesSeconds":{"path":"libs_sh/string.lua#L276","returns":[{"type":"string","value":"string Given time in \"HH:MM:SS\" format","description":"Given time in \"HH:MM:SS\" format"}],"realm":"shared","params":[{"type":"number","value":"number time Time in seconds","name":"time","description":"Time in seconds"}],"class":"function","name":"toHoursMinutesSeconds","description":" Converts time to hours, minutes and seconds string."},"setChar":{"path":"libs_sh/string.lua#L224","returns":[{"type":"string","value":"string Modified string","description":"Modified string"}],"realm":"shared","params":[{"type":"string","value":"string str The input string","name":"str","description":"The input string"},{"type":"number","value":"number index The character index, 1 is the first from left","name":"index","description":"The character index, 1 is the first from left"},{"type":"string","value":"string replacement String to replace with","name":"replacement","description":"String to replace with"}],"class":"function","name":"setChar","description":" Sets the character at the specific index of the string."},"split":{"path":"libs_sh/string.lua#L232","returns":[{"type":"table","value":"table Table with the separated strings in numerical sequential order","description":"Table with the separated strings in numerical sequential order"}],"realm":"shared","params":[{"type":"string","value":"string str String to split","name":"str","description":"String to split"},{"type":"string","value":"string separator Character(s) to split with","name":"separator","description":"Character(s) to split with"}],"class":"function","name":"split","description":" Splits the string into a table of strings, separated by the second argument"},"escapeMarkup":{"path":"libs_sh/string.lua#L187","returns":[{"type":"string","value":"string Sanitized text","description":"Sanitized text"}],"realm":"shared","params":[{"type":"string","value":"string str Text to sanitize","name":"str","description":"Text to sanitize"}],"class":"function","name":"escapeMarkup","description":" Sanitizes text to be used in `render.parseMarkup`"},"getFileFromFilename":{"path":"libs_sh/string.lua#L107","returns":[{"type":"string","value":"string The filename along with it's extension","description":"The filename along with it's extension"}],"realm":"shared","params":[{"type":"string","value":"string str File-path to get the file extensions from","name":"str","description":"File-path to get the file extensions from"}],"class":"function","name":"getFileFromFilename","description":" Returns file name and extension."},"rep":{"path":"libs_sh/string.lua#L195","returns":[{"type":"string","value":"string String result","description":"String result"}],"realm":"shared","params":[{"type":"string","value":"string str The string to repeat","name":"str","description":"The string to repeat"},{"type":"number","value":"number rep Number of times to repeat the string","name":"rep","description":"Number of times to repeat the string"},{"type":"string?","value":"string? sep (Optional) seperator string between each repeated string","name":"sep","description":"(Optional) seperator string between each repeated string"}],"class":"function","name":"rep","description":" Repeats the given string n times"},"utf8force":{"path":"libs_sh/string.lua#L360","returns":[{"type":"string","value":"string The UTF-8 string","description":"The UTF-8 string"}],"realm":"shared","params":[{"type":"string","value":"string str The string that will become a valid UTF-8 string","name":"str","description":"The string that will become a valid UTF-8 string"}],"class":"function","name":"utf8force","description":" Forces a string to contain only valid UTF-8 data. Invalid sequences are replaced with U+FFFD (the Unicode replacement character)."},"gmatch":{"path":"libs_sh/string.lua#L119","returns":[{"type":"function","value":"function The iterator function that can be used in a for-in loop","description":"The iterator function that can be used in a for-in loop"}],"realm":"shared","params":[{"type":"string","value":"string data The string to search in","name":"data","description":"The string to search in"},{"type":"string","value":"string pattern The pattern to search for","name":"pattern","description":"The pattern to search for"}],"class":"function","name":"gmatch","description":" Using Patterns, returns an iterator which will return either one value if no capture groups are defined, or any capture group matches."},"reverse":{"path":"libs_sh/string.lua#L211","returns":[{"type":"string","value":"string Reversed string","description":"Reversed string"}],"realm":"shared","params":[{"type":"string","value":"string str String to be reversed","name":"str","description":"String to be reversed"}],"class":"function","name":"reverse","description":" Reverses a string."},"toMinutesSecondsMilliseconds":{"path":"libs_sh/string.lua#L270","returns":[{"type":"string","value":"string Returns given time in \"MM:SS:MS\" format","description":"Returns given time in \"MM:SS:MS\" format"}],"realm":"shared","params":[{"type":"number","value":"number time Time in seconds","name":"time","description":"Time in seconds"}],"class":"function","name":"toMinutesSecondsMilliseconds","description":" Converts time to minutes, seconds and milliseconds string."},"startsWith":{"path":"libs_sh/string.lua#L239","returns":[{"type":"boolean","value":"boolean True if the first string starts with the second","description":"True if the first string starts with the second"}],"realm":"shared","params":[{"type":"string","value":"string str String to be checked","name":"str","description":"String to be checked"},{"type":"string","value":"string start String to check with","name":"start","description":"String to check with"}],"class":"function","name":"startsWith","description":" Whether or not the first string starts with the second"},"right":{"path":"libs_sh/string.lua#L217","returns":[{"type":"string","value":"string String containing a specified number of characters from the right side of a string","description":"String containing a specified number of characters from the right side of a string"}],"realm":"shared","params":[{"type":"string","value":"string str The string to extract from","name":"str","description":"The string to extract from"},{"type":"number","value":"number num Amount of chars relative to the end (starting from 1)","name":"num","description":"Amount of chars relative to the end (starting from 1)"}],"class":"function","name":"right","description":" Returns the last n-th characters of the string."},"fromColor":{"path":"libs_sh/string.lua#L17","returns":[{"type":"string","value":"string String with the color RGBA values separated by spaces","description":"String with the color RGBA values separated by spaces"}],"realm":"shared","params":[{"type":"Color","value":"Color col The color to put in the string","name":"col","description":"The color to put in the string"}],"class":"function","name":"fromColor","description":" Converts color to a string."},"utf8offset":{"path":"libs_sh/string.lua#L376","returns":[{"type":"number","value":"number Starting byte-index of the given position","description":"Starting byte-index of the given position"}],"realm":"shared","params":[{"type":"string","value":"string str The string that you will get the byte position from","name":"str","description":"The string that you will get the byte position from"},{"type":"number","value":"number n The position to get the beginning byte position from","name":"n","description":"The position to get the beginning byte position from"},{"type":"number?","value":"number? startPos The offset for n. Defaults to 1 if n >= 0, otherwise -1","name":"startPos","description":"The offset for n. Defaults to 1 if n >= 0, otherwise -1"}],"class":"function","name":"utf8offset","description":" Returns the byte-index of the n'th UTF-8-character after the given startPos (nil if none).\n startPos defaults to 1 when n is positive and -1 when n is negative. If n is zero,\n this function instead returns the byte-index of the UTF-8-character startPos lies within."},"utf8len":{"path":"libs_sh/string.lua#L366","returns":[{"type":"number|boolean","value":"number|boolean The number of UTF-8 characters in the string. If there are invalid bytes, this will be false","description":"The number of UTF-8 characters in the string. If there are invalid bytes, this will be false"},{"type":"number?","value":"number? The position of the first invalid byte. If there were no invalid bytes, this will be nil","description":"The position of the first invalid byte. If there were no invalid bytes, this will be nil"}],"realm":"shared","params":[{"type":"string","value":"string str The string to calculate the length of","name":"str","description":"The string to calculate the length of"},{"type":"number?","value":"number? startPos The starting position to get the length from","name":"startPos","description":"The starting position to get the length from"},{"type":"number?","value":"number? endPos The ending position to get the length from","name":"endPos","description":"The ending position to get the length from"}],"class":"function","name":"utf8len","description":" Returns the number of UTF-8 sequences in the given string between positions startPos and endPos (both inclusive).\n If it finds any invalid UTF-8 byte sequence, returns false as well as the position of the first invalid byte."},"utf8codes":{"path":"libs_sh/string.lua#L353","returns":[{"type":"function","value":"function The iterator (to be used in a for loop)","description":"The iterator (to be used in a for loop)"}],"realm":"shared","params":[{"type":"string","value":"string str The string that you will get the codes from","name":"str","description":"The string that you will get the codes from"}],"class":"function","name":"utf8codes","description":" Returns an iterator (like string.gmatch) which returns both the position and codepoint of each utf8 character in the string.\n It raises an error if it meets any invalid byte sequence."},"toMinutesSeconds":{"path":"libs_sh/string.lua#L264","returns":[{"type":"string","value":"string Given time in \"MM:SS\" format","description":"Given time in \"MM:SS\" format"}],"realm":"shared","params":[{"type":"number","value":"number time Time in seconds","name":"time","description":"Time in seconds"}],"class":"function","name":"toMinutesSeconds","description":" Converts time to minutes and seconds string."},"utf8codepoint":{"path":"libs_sh/string.lua#L344","returns":[{"type":"...","value":"... The codepoint number(s)","description":"The codepoint number(s)"}],"realm":"shared","params":[{"type":"string","value":"string str The string that you will get the code(s) from","name":"str","description":"The string that you will get the code(s) from"},{"type":"number?","value":"number? startPos The starting byte of the string to get the codepoint of","name":"startPos","description":"The starting byte of the string to get the codepoint of"},{"type":"number?","value":"number? endPos The ending byte of the string to get the codepoint of","name":"endPos","description":"The ending byte of the string to get the codepoint of"}],"class":"function","name":"utf8codepoint","description":" Returns the codepoints (as numbers) from all characters in the given string that start between byte position startPos and endPos.\n It raises an error if it meets any invalid byte sequence."},"niceTime":{"path":"libs_sh/string.lua#L175","returns":[{"type":"string","value":"string A nicely formatted time string","description":"A nicely formatted time string"}],"realm":"shared","params":[{"type":"number","value":"number time The number to format, in seconds","name":"time","description":"The number to format, in seconds"}],"class":"function","name":"niceTime","description":" Formats the supplied number (in seconds) to the highest possible time unit"},"upper":{"path":"libs_sh/string.lua#L323","returns":[{"type":"string","value":"string String with all letters upper case","description":"String with all letters upper case"}],"realm":"shared","params":[{"type":"string","value":"string str The string to convert","name":"str","description":"The string to convert"}],"class":"function","name":"upper","description":" Changes any lower-case letters in a string to upper-case letters."},"sub":{"path":"libs_sh/string.lua#L254","returns":[{"type":"string","value":"string The sub-string","description":"The sub-string"}],"realm":"shared","params":[{"type":"string","value":"string str The string you'll take a sub-string out of","name":"str","description":"The string you'll take a sub-string out of"},{"type":"number","value":"number startPos The position of the first character that will be included in the sub-string","name":"startPos","description":"The position of the first character that will be included in the sub-string"},{"type":"number?","value":"number? endPos The position of the last character to be included in the sub-string. It can be negative to count from the end","name":"endPos","description":"The position of the last character to be included in the sub-string. It can be negative to count from the end"}],"class":"function","name":"sub","description":" Returns a sub-string, starting from the character at position startPos of the string (inclusive)\n and optionally ending at the character at position endPos of the string (also inclusive).\n If EndPos is not given, the rest of the string is returned."},"normalizePath":{"path":"libs_sh/string.lua#L329","returns":[{"type":"string","value":"string Path with all .. replaced","description":"Path with all .. replaced"}],"realm":"shared","params":[{"type":"string","value":"string str Path","name":"str","description":"Path"}],"class":"function","name":"normalizePath","description":" Returns a path with all .. accounted for"},"utf8char":{"path":"libs_sh/string.lua#L337","returns":[{"type":"string","value":"string UTF-8 string generated from given arguments","description":"UTF-8 string generated from given arguments"}],"realm":"shared","params":[{"type":"...","value":"... codepoints Unicode code points to be converted in to a UTF-8 string","name":"codepoints","description":"Unicode code points to be converted in to a UTF-8 string"}],"class":"function","name":"utf8char","description":" Receives zero or more integers, converts each one to its corresponding UTF-8 byte sequence\n and returns a string with the concatenation of all these sequences"},"trimRight":{"path":"libs_sh/string.lua#L316","returns":[{"type":"string","value":"string Trimmed string","description":"Trimmed string"}],"realm":"shared","params":[{"type":"string","value":"string str The string to trim","name":"str","description":"The string to trim"},{"type":"string","value":"string char Optional character to be trimmed. Defaults to space character","name":"char","description":"Optional character to be trimmed. Defaults to space character"}],"class":"function","name":"trimRight","description":" Removes trailing spaces/characters from a string."},"patternSafe":{"path":"libs_sh/string.lua#L181","returns":[{"type":"string","value":"string The sanitized string","description":"The sanitized string"}],"realm":"shared","params":[{"type":"string","value":"string str The string to be sanitized","name":"str","description":"The string to be sanitized"}],"class":"function","name":"patternSafe","description":" Escapes all special characters within a string, making the string safe for inclusion in a Lua pattern."},"trimLeft":{"path":"libs_sh/string.lua#L309","returns":[{"type":"string","value":"string Trimmed string","description":"Trimmed string"}],"realm":"shared","params":[{"type":"string","value":"string str The string to trim","name":"str","description":"The string to trim"},{"type":"string?","value":"string? char Optional character to be trimmed. Defaults to space character","name":"char","description":"Optional character to be trimmed. Defaults to space character"}],"class":"function","name":"trimLeft","description":" Removes leading spaces/characters from a string"},"trim":{"path":"libs_sh/string.lua#L302","returns":[{"type":"string","value":"string Trimmed string","description":"Trimmed string"}],"realm":"shared","params":[{"type":"string","value":"string str The string to trim","name":"str","description":"The string to trim"},{"type":"string?","value":"string? char Optional character to be trimmed. Defaults to space character","name":"char","description":"Optional character to be trimmed. Defaults to space character"}],"class":"function","name":"trim","description":" Removes leading and trailing spaces/characters of a string"},"endsWith":{"path":"libs_sh/string.lua#L60","returns":[{"type":"boolean","value":"boolean True if the first string ends with the second, or the second is empty","description":"True if the first string ends with the second, or the second is empty"}],"realm":"shared","params":[{"type":"string","value":"string str The string whose end is to be checked","name":"str","description":"The string whose end is to be checked"},{"type":"string","value":"string end The string to be matched with the end of the first","name":"end","description":"The string to be matched with the end of the first"}],"class":"function","name":"endsWith","description":" Whether or not the second passed string matches the end of the first."},"left":{"path":"libs_sh/string.lua#L142","returns":[{"type":"string","value":"string Returns a string containing a specified number of characters from the left side of a string","description":"Returns a string containing a specified number of characters from the left side of a string"}],"realm":"shared","params":[{"type":"string","value":"string str The string to extract from","name":"str","description":"The string to extract from"},{"type":"number","value":"number num Amount of chars relative to the beginning (starting from 1)","name":"num","description":"Amount of chars relative to the beginning (starting from 1)"}],"class":"function","name":"left","description":" Returns everything left of supplied place of that string."},"stripExtension":{"path":"libs_sh/string.lua#L248","returns":[{"type":"string","value":"string Path without the extension","description":"Path without the extension"}],"realm":"shared","params":[{"type":"string","value":"string path The file-path to change","name":"path","description":"The file-path to change"}],"class":"function","name":"stripExtension","description":" Removes the extension of a path"},"toColor":{"path":"libs_sh/string.lua#L25","returns":[{"type":"Color","value":"Color The color object","description":"The color object"}],"realm":"shared","params":[{"type":"string","value":"string str The string to convert from","name":"str","description":"The string to convert from"}],"class":"function","name":"toColor","description":" Converts string with RGBA values separated by spaces into a color."},"lower":{"path":"libs_sh/string.lua#L155","returns":[{"type":"string","value":"string String with all uppercase letters replaced with their lowercase variants","description":"String with all uppercase letters replaced with their lowercase variants"}],"realm":"shared","params":[{"type":"string","value":"string str The string to convert","name":"str","description":"The string to convert"}],"class":"function","name":"lower","description":" Changes any upper-case letters in a string to lower-case letters."},"dump":{"path":"libs_sh/string.lua#L53","returns":[{"type":"string","value":"string The bytecode","description":"The bytecode"}],"realm":"shared","params":[{"type":"function","value":"function func The function to get the bytecode of","name":"func","description":"The function to get the bytecode of"},{"type":"boolean?","value":"boolean? strip True to strip the debug data, false to keep it. Defaults to false","name":"strip","description":"True to strip the debug data, false to keep it. Defaults to false"}],"class":"function","name":"dump","description":" Returns the binary bytecode of the given function."},"getExtensionFromFilename":{"path":"libs_sh/string.lua#L101","returns":[{"type":"string","value":"string The extension","description":"The extension"}],"realm":"shared","params":[{"type":"string","value":"string str File-path to get the file extensions from","name":"str","description":"File-path to get the file extensions from"}],"class":"function","name":"getExtensionFromFilename","description":" Returns extension of the file-path."},"find":{"path":"libs_sh/string.lua#L75","returns":[{"type":"number?","value":"number? Starting position of the found text, or nil if the text wasn't found","description":"Starting position of the found text, or nil if the text wasn't found"},{"type":"number?","value":"number? Ending position of found text, or nil if the text wasn't found","description":"Ending position of found text, or nil if the text wasn't found"},{"type":"string?","value":"string? Matched text for each group if patterns are enabled and used, or nil if the text wasn't found","description":"Matched text for each group if patterns are enabled and used, or nil if the text wasn't found"}],"realm":"shared","params":[{"type":"string","value":"string haystack The string to search in","name":"haystack","description":"The string to search in"},{"type":"string","value":"string needle The string to find, can contain patterns if enabled","name":"needle","description":"The string to find, can contain patterns if enabled"},{"type":"number","value":"number start The position to start the search from, negative start position will be relative to the end position","name":"start","description":"The position to start the search from, negative start position will be relative to the end position"},{"type":"boolean?","value":"boolean? noPatterns Disable patterns. Defaults to false","name":"noPatterns","description":"Disable patterns. Defaults to false"}],"class":"function","name":"find","description":" Attempts to find the specified substring in a string, uses Patterns by default. https://wiki.facepunch.com/gmod/Patterns"},"explode":{"path":"libs_sh/string.lua#L67","returns":[{"type":"table","value":"table Table with the separated strings in numerical sequential order","description":"Table with the separated strings in numerical sequential order"}],"realm":"shared","params":[{"type":"string","value":"string separator The separator that will split the string","name":"separator","description":"The separator that will split the string"},{"type":"string","value":"string str The string to split up","name":"str","description":"The string to split up"},{"type":"boolean?","value":"boolean? patterns Set this to true if your separator is a pattern. Defaults to false","name":"patterns","description":"Set this to true if your separator is a pattern. Defaults to false"}],"class":"function","name":"explode","description":" Splits a string up wherever it finds the given separator"},"byte":{"path":"libs_sh/string.lua#L33","returns":[{"type":"...","value":"... Vararg numerical bytes","description":"Vararg numerical bytes"}],"realm":"shared","params":[{"type":"string","value":"string str The string to get the chars from","name":"str","description":"The string to get the chars from"},{"type":"number","value":"number start The first character of the string to get the byte of","name":"start","description":"The first character of the string to get the byte of"},{"type":"number","value":"number end The last character of the string to get the byte of","name":"end","description":"The last character of the string to get the byte of"}],"class":"function","name":"byte","description":" Returns the given string's characters in their numeric ASCII representation."},"toTable":{"path":"libs_sh/string.lua#L294","returns":[{"type":"table","value":"table A sequential table where each value is a character from the given string","description":"A sequential table where each value is a character from the given string"}],"realm":"shared","params":[{"type":"string","value":"string str The string to turn into a table","name":"str","description":"The string to turn into a table"}],"class":"function","name":"toTable","description":" Splits the string into characters and creates a sequential table of characters.\n As a result of the encoding, non-ASCII characters will be split into more than one character in the output table.\n Each character value in the output table will always be 1 byte."},"toHoursMinutesSecondsMilliseconds":{"path":"libs_sh/string.lua#L285","returns":[{"type":"string","value":"string Returns given time in \"HH:MM:SS.MS\" format","description":"Returns given time in \"HH:MM:SS.MS\" format"}],"realm":"shared","params":[{"type":"number","value":"number time Time in seconds","name":"time","description":"Time in seconds"}],"class":"function","name":"toHoursMinutesSecondsMilliseconds","description":" Converts time to hours, minutes, seconds and milliseconds string."},"match":{"path":"libs_sh/string.lua#L161","returns":[{"type":"...","value":"... Vararg matched string(s)","description":"Vararg matched string(s)"}],"realm":"shared","params":[{"type":"string","value":"string str String which should be searched in for matches","name":"str","description":"String which should be searched in for matches"},{"type":"string","value":"string pattern The pattern that defines what should be matched","name":"pattern","description":"The pattern that defines what should be matched"},{"type":"number?","value":"number? start The start index to start the matching from, negative to start the match from a position relative to the end. Default 1","name":"start","description":"The start index to start the matching from, negative to start the match from a position relative to the end. Default 1"}],"class":"function","name":"match","description":" Finds a Pattern in a string."},"niceSize":{"path":"libs_sh/string.lua#L169","returns":[{"type":"string","value":"string The human-readable filesize, in Bytes/KB/MB/GB (whichever is appropriate)","description":"The human-readable filesize, in Bytes/KB/MB/GB (whichever is appropriate)"}],"realm":"shared","params":[{"type":"number","value":"number size The filesize in bytes","name":"size","description":"The filesize in bytes"}],"class":"function","name":"niceSize","description":" Converts a digital filesize to human-readable text."}},"tables":[],"path":"libs_sh/string.lua#L4","libtbl":["string_library"],"realm":"shared","fields":[],"class":"library","name":"string","description":" Lua string library https://wiki.garrysmod.com/page/Category:string"},"sound":{"methods":{"exists":{"path":"libs_sh/sound.lua#L119","returns":[{"type":"boolean","value":"boolean True if exists, false if not","description":"True if exists, false if not"}],"realm":"shared","params":[{"type":"string","value":"string path String path to the sound file","name":"path","description":"String path to the sound file"}],"class":"function","name":"exists","description":" Returns true if the sound or sound property exists."},"duration":{"path":"libs_sh/sound.lua#L111","returns":[{"type":"number","value":"number Number duration in seconds","description":"Number duration in seconds"}],"realm":"shared","params":[{"type":"string","value":"string path String path to the sound file","name":"path","description":"String path to the sound file"}],"class":"function","name":"duration","description":" Returns the sound duration in seconds. May not work for all file-types on linux/macos"},"emitSoundsLeft":{"path":"libs_sh/entities.lua#L315","returns":[{"type":"number","value":"number The number of sounds left","description":"The number of sounds left"}],"realm":"shared","class":"function","name":"emitSoundsLeft","description":" Returns the number of sound emits left"},"soundsLeft":{"path":"libs_sh/sound.lua#L105","returns":[{"type":"number","value":"number The number of sounds left","description":"The number of sounds left"}],"realm":"shared","class":"function","name":"soundsLeft","description":" Returns the number of sounds left that can be created"},"canEmitSound":{"path":"libs_sh/entities.lua#L309","returns":[{"type":"boolean","value":"boolean If it is possible to emit a sound","description":"If it is possible to emit a sound"}],"realm":"shared","class":"function","name":"canEmitSound","description":" Returns if a sound is able to be emitted from an entity"},"create":{"path":"libs_sh/sound.lua#L70","returns":[{"type":"Sound","value":"Sound Sound Object","description":"Sound Object"}],"realm":"shared","params":[{"type":"Entity","value":"Entity ent Entity to attach sound to.","name":"ent","description":"Entity to attach sound to."},{"type":"string","value":"string path Filepath to the sound file.","name":"path","description":"Filepath to the sound file."},{"type":"boolean?","value":"boolean? nofilter (Optional) Boolean Make the sound play for everyone regardless of range or location. Only affects Server-side sounds.","name":"nofilter","description":"(Optional) Boolean Make the sound play for everyone regardless of range or location. Only affects Server-side sounds."}],"class":"function","name":"create","description":" Creates a sound and attaches it to an entity"},"canCreate":{"path":"libs_sh/sound.lua#L99","returns":[{"type":"boolean","value":"boolean If it is possible to make a sound","description":"If it is possible to make a sound"}],"realm":"shared","class":"function","name":"canCreate","description":" Returns if a sound is able to be created"}},"tables":[],"path":"libs_sh/sound.lua#L19","libtbl":["sound_library"],"realm":"shared","fields":[],"class":"library","name":"sound","description":" Sound library."},"render":{"methods":{"setFogEnd":{"path":"libs_cl/render.lua#L2652","realm":"client","params":[{"type":"number","value":"number distance End distance","name":"distance","description":"End distance"}],"class":"function","name":"setFogEnd","description":" Sets distance at which the fog will reach it's target density"},"setRGBA":{"path":"libs_cl/render.lua#L889","realm":"client","params":[{"type":"number","value":"number r Number, red value","name":"r","description":"Number, red value"},{"type":"number","value":"number g Number, green value","name":"g","description":"Number, green value"},{"type":"number","value":"number b Number, blue value","name":"b","description":"Number, blue value"},{"type":"number","value":"number a Number, alpha value","name":"a","description":"Number, alpha value"}],"class":"function","name":"setRGBA","description":" Sets the draw color by RGBA values"},"getTintRGBA":{"path":"libs_cl/render.lua#L913","returns":[{"type":"number","value":"number The red channel value. Color The current color & blend modulation as a color","description":"The red channel value. Color The current color & blend modulation as a color"},{"type":"number","value":"number The green channel value.","description":"The green channel value."},{"type":"number","value":"number The blue channel value.","description":"The blue channel value."},{"type":"number","value":"number The alpha channel value.","description":"The alpha channel value."}],"realm":"client","class":"function","name":"getTintRGBA","description":" Gets the drawing tint. Internally, calls render.getColorModulation and render.getBlend, multiplies the values by 255, then returns a color object."},"clearBuffersObeyStencil":{"path":"libs_cl/render.lua#L619","realm":"client","params":[{"type":"number","value":"number r Value of the red channel to clear the current rt with.","name":"r","description":"Value of the red channel to clear the current rt with."},{"type":"number","value":"number g Value of the green channel to clear the current rt with.","name":"g","description":"Value of the green channel to clear the current rt with."},{"type":"number","value":"number b Value of the blue channel to clear the current rt with.","name":"b","description":"Value of the blue channel to clear the current rt with."},{"type":"number","value":"number a Value of the alpha channel to clear the current rt with.","name":"a","description":"Value of the alpha channel to clear the current rt with."},{"type":"boolean","value":"boolean Clear the depth buffer.","name":"Clear","description":"the depth buffer."}],"class":"function","name":"clearBuffersObeyStencil","description":" Clears the current rendertarget for obeying the current stencil buffer conditions."},"popViewMatrix":{"path":"libs_cl/render.lua#L817","realm":"client","class":"function","name":"popViewMatrix","description":" Pops a view matrix from the matrix stack."},"overrideBlend":{"path":"libs_cl/render.lua#L1939","realm":"client","params":[{"type":"boolean","value":"boolean on Whether to control the blend mode of upcoming rendering","name":"on","description":"Whether to control the blend mode of upcoming rendering"},{"type":"number","value":"number srcBlend http://wiki.facepunch.com/gmod/Enums/BLEND","name":"srcBlend","description":"http://wiki.facepunch.com/gmod/Enums/BLEND"},{"type":"number","value":"number destBlend","name":"destBlend","description":""},{"type":"number","value":"number blendFunc http://wiki.facepunch.com/gmod/Enums/BLENDFUNC","name":"blendFunc","description":"http://wiki.facepunch.com/gmod/Enums/BLENDFUNC"},{"type":"number?","value":"number? srcBlendAlpha http://wiki.facepunch.com/gmod/Enums/BLEND","name":"srcBlendAlpha","description":"http://wiki.facepunch.com/gmod/Enums/BLEND"},{"type":"number?","value":"number? destBlendAlpha","name":"destBlendAlpha","description":""},{"type":"number?","value":"number? blendFuncAlpha http://wiki.facepunch.com/gmod/Enums/BLENDFUNC","name":"blendFuncAlpha","description":"http://wiki.facepunch.com/gmod/Enums/BLENDFUNC"}],"class":"function","name":"overrideBlend","description":" Enables blend mode control. Read OpenGL or DirectX docs for more info"},"setFogHeight":{"path":"libs_cl/render.lua#L2661","realm":"client","params":[{"type":"number","value":"number height The fog height","name":"height","description":"The fog height"}],"class":"function","name":"setFogHeight","description":" Sets the height below which fog will be rendered. Only works with fog mode 2, MATERIAL_FOG.LINEAR_BELOW_FOG_Z"},"drawPixelsRGB":{"path":"libs_cl/render.lua#L1640","realm":"client","params":[{"type":"number","value":"number w Width of image to be drawn.","name":"w","description":"Width of image to be drawn."},{"type":"number","value":"number h Height of image to be drawn.","name":"h","description":"Height of image to be drawn."},{"type":"table","value":"table dataR Red channel data.","name":"dataR","description":"Red channel data."},{"type":"table","value":"table dataG Green channel data.","name":"dataG","description":"Green channel data."},{"type":"table","value":"table dataB Blue channel data.","name":"dataB","description":"Blue channel data."}],"class":"function","name":"drawPixelsRGB","description":" Draws RGB color channel tables to current render target."},"draw3DSprite":{"path":"libs_cl/render.lua#L1980","realm":"client","params":[{"type":"Vector","value":"Vector pos Position of the sprite.","name":"pos","description":"Position of the sprite."},{"type":"number","value":"number width Width of the sprite.","name":"width","description":"Width of the sprite."},{"type":"number","value":"number height Height of the sprite.","name":"height","description":"Height of the sprite."},{"type":"Color?","value":"Color? Color tint to give the sprite. Default: white","name":"Color","description":"tint to give the sprite. Default: white"}],"class":"function","name":"draw3DSprite","description":" Draws a sprite in 3d space."},"clearRGBA":{"path":"libs_cl/render.lua#L1298","returns":[{"type":"number","value":"number The red channel value.","description":"The red channel value."},{"type":"number","value":"number The green channel value.","description":"The green channel value."},{"type":"number","value":"number The blue channel value.","description":"The blue channel value."},{"type":"number","value":"number The alpha channel value.","description":"The alpha channel value."}],"realm":"client","params":[{"type":"boolean?","value":"boolean? depth Boolean if should clear depth. Default false","name":"depth","description":"Boolean if should clear depth. Default false"}],"class":"function","name":"clearRGBA","description":" Clears the active render target"},"drawTexturedRectRotatedFast":{"path":"libs_cl/render.lua#L1583","realm":"client","params":[{"type":"number","value":"number x X coordinate of center of rect","name":"x","description":"X coordinate of center of rect"},{"type":"number","value":"number y Y coordinate of center of rect","name":"y","description":"Y coordinate of center of rect"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"},{"type":"number","value":"number rot Rotation in degrees","name":"rot","description":"Rotation in degrees"}],"class":"function","name":"drawTexturedRectRotatedFast","description":" Draws a rotated, textured rectangle.\n Faster, but uses integer coordinates and will get clipped by user's screen resolution"},"drawPixelsRGBA":{"path":"libs_cl/render.lua#L1656","realm":"client","params":[{"type":"number","value":"number w Width of image to be drawn.","name":"w","description":"Width of image to be drawn."},{"type":"number","value":"number h Height of image to be drawn.","name":"h","description":"Height of image to be drawn."},{"type":"table","value":"table dataR Red channel data.","name":"dataR","description":"Red channel data."},{"type":"table","value":"table dataG Green channel data.","name":"dataG","description":"Green channel data."},{"type":"table","value":"table dataB Blue channel data.","name":"dataB","description":"Blue channel data."},{"type":"table","value":"table dataA Alpha channel data.","name":"dataA","description":"Alpha channel data."}],"class":"function","name":"drawPixelsRGBA","description":" Draws RGBA color channel tables to current render target."},"popCustomClipPlane":{"path":"libs_cl/render.lua#L2572","realm":"client","class":"function","name":"popCustomClipPlane","description":" Removes the current active clipping plane from the clip plane stack."},"drawRoundedBox":{"path":"libs_cl/render.lua#L1312","realm":"client","params":[{"type":"number","value":"number r The corner radius","name":"r","description":"The corner radius"},{"type":"number","value":"number x Top left corner x coordinate","name":"x","description":"Top left corner x coordinate"},{"type":"number","value":"number y Top left corner y coordinate","name":"y","description":"Top left corner y coordinate"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"}],"class":"function","name":"drawRoundedBox","description":" Draws a rounded rectangle using the current color"},"enableClipping":{"path":"libs_cl/render.lua#L2541","returns":[{"type":"boolean","value":"boolean Previous clipping state.","description":"Previous clipping state."}],"realm":"client","params":[{"type":"boolean","value":"boolean state New clipping state.","name":"state","description":"New clipping state."}],"class":"function","name":"enableClipping","description":" Sets the status of the clip renderer, returning previous state."},"draw3DBox":{"path":"libs_cl/render.lua#L2031","realm":"client","params":[{"type":"Vector","value":"Vector origin Origin of the box.","name":"origin","description":"Origin of the box."},{"type":"Angle","value":"Angle angle Orientation of the box","name":"angle","description":"Orientation of the box"},{"type":"Vector","value":"Vector mins Start position of the box, relative to origin.","name":"mins","description":"Start position of the box, relative to origin."},{"type":"Vector","value":"Vector maxs End position of the box, relative to origin.","name":"maxs","description":"End position of the box, relative to origin."}],"class":"function","name":"draw3DBox","description":" Draws a box in 3D space"},"draw3DQuadEasy":{"path":"libs_cl/render.lua#L2120","realm":"client","params":[{"type":"Vector","value":"Vector pos Origin of the quad.","name":"pos","description":"Origin of the quad."},{"type":"Vector","value":"Vector normal The face direction of the quad.","name":"normal","description":"The face direction of the quad."},{"type":"number","value":"number width The width of the quad.","name":"width","description":"The width of the quad."},{"type":"number","value":"number height The height of the quad.","name":"height","description":"The height of the quad."},{"type":"number?","value":"number? rot The rotation of the quad counter-clockwise in degrees around the normal axis. In other words, the quad will always face the same way but this will rotate its corners.","name":"rot","description":"The rotation of the quad counter-clockwise in degrees around the normal axis. In other words, the quad will always face the same way but this will rotate its corners."}],"class":"function","name":"draw3DQuadEasy","description":" Draws a quad."},"add3DBeam":{"path":"libs_cl/render.lua#L2084","realm":"client","params":[{"type":"Vector","value":"Vector startPos Beam start position.","name":"startPos","description":"Beam start position."},{"type":"number","value":"number width The width of the beam.","name":"width","description":"The width of the beam."},{"type":"number","value":"number textureEnd The end coordinate of the texture used.","name":"textureEnd","description":"The end coordinate of the texture used."},{"type":"Color","value":"Color color The color to be used.","name":"color","description":"The color to be used."}],"class":"function","name":"add3DBeam","description":" Adds a beam segment to the beam started by render.start3DBeam."},"drawRectOutline":{"path":"libs_cl/render.lua#L1402","realm":"client","params":[{"type":"number","value":"number x Top left corner x integer coordinate","name":"x","description":"Top left corner x integer coordinate"},{"type":"number","value":"number y Top left corner y integer coordinate","name":"y","description":"Top left corner y integer coordinate"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"},{"type":"number?","value":"number? thickness Optional inset border width","name":"thickness","description":"Optional inset border width"}],"class":"function","name":"drawRectOutline","description":" Draws a rectangle outline using the current color."},"start3DBeam":{"path":"libs_cl/render.lua#L2077","realm":"client","params":[{"type":"number","value":"number segmentCount The number of Beam Segments that this multi-segment Beam will contain","name":"segmentCount","description":"The number of Beam Segments that this multi-segment Beam will contain"}],"class":"function","name":"start3DBeam","description":" Begin drawing a multi-segment beam."},"drawTexturedTriangleUV":{"path":"libs_cl/render.lua#L1626","realm":"client","params":[{"type":"table","value":"table vert1 First vertex. {x = x1, y = y1, u = u1, v = v1}","name":"vert1","description":"First vertex. {x = x1, y = y1, u = u1, v = v1}"},{"type":"table","value":"table vert2 The second vertex.","name":"vert2","description":"The second vertex."},{"type":"table","value":"table vert3 The third vertex.","name":"vert3","description":"The third vertex."}],"class":"function","name":"drawTexturedTriangleUV","description":" Draws a textured triangle with UV coordinates"},"getResolution":{"path":"libs_cl/render.lua#L2355","returns":[{"type":"number","value":"number the X size of the current render context","description":"the X size of the current render context"},{"type":"number","value":"number the Y size of the current render context","description":"the Y size of the current render context"}],"realm":"client","class":"function","name":"getResolution","description":" Returns the render context's width and height. If a rendertarget is selected, will return 1024, 1024"},"traceSurfaceColor":{"path":"libs_cl/render.lua#L2376","returns":[{"type":"Color","value":"Color The color","description":"The color"}],"realm":"client","params":[{"type":"Vector","value":"Vector startpos The starting vector","name":"startpos","description":"The starting vector"},{"type":"Vector","value":"Vector endpos The ending vector","name":"endpos","description":"The ending vector"}],"class":"function","name":"traceSurfaceColor","description":" Does a trace and returns the color of the textel the trace hits."},"setStencilPassOperation":{"path":"libs_cl/render.lua#L659","realm":"client","params":[{"type":"number","value":"number operation","name":"operation","description":""}],"class":"function","name":"setStencilPassOperation","description":" Sets the operation to be performed on the stencil buffer values if the compare function was successful. More: http://wiki.facepunch.com/gmod/render.SetStencilPassOperation"},"drawTexturedRectRotated":{"path":"libs_cl/render.lua#L1596","realm":"client","params":[{"type":"number","value":"number x X coordinate of center of rect","name":"x","description":"X coordinate of center of rect"},{"type":"number","value":"number y Y coordinate of center of rect","name":"y","description":"Y coordinate of center of rect"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"},{"type":"number","value":"number rot Rotation in degrees","name":"rot","description":"Rotation in degrees"}],"class":"function","name":"drawTexturedRectRotated","description":" Draws a rotated, textured rectangle."},"getViewSetup":{"path":"libs_cl/render.lua#L2290","returns":[{"type":"table","value":"table A table describing the current view setup. See https://wiki.facepunch.com/gmod/Structures/ViewSetup for more information.","description":"A table describing the current view setup. See https://wiki.facepunch.com/gmod/Structures/ViewSetup for more information."}],"realm":"client","params":[{"type":"boolean?","value":"boolean? curview If true, returns the current calculated view setup, otherwise returns original player view setup","name":"curview","description":"If true, returns the current calculated view setup, otherwise returns original player view setup"}],"class":"function","name":"getViewSetup","description":" Returns information about the current view setup."},"setStencilReferenceValue":{"path":"libs_cl/render.lua#L675","realm":"client","params":[{"type":"number","value":"number referenceValue Reference value.","name":"referenceValue","description":"Reference value."}],"class":"function","name":"setStencilReferenceValue","description":" Sets the reference value which will be used for all stencil operations. This is an unsigned integer."},"draw3DLine":{"path":"libs_cl/render.lua#L2018","realm":"client","params":[{"type":"Vector","value":"Vector startPos Starting position","name":"startPos","description":"Starting position"},{"type":"Vector","value":"Vector endPos Ending position","name":"endPos","description":"Ending position"},{"type":"boolean?","value":"boolean? writeZ Optional should the line be drawn with depth considered (default: true)","name":"writeZ","description":"Optional should the line be drawn with depth considered (default: true)"}],"class":"function","name":"draw3DLine","description":" Draws a 3D Line"},"getMatrix":{"path":"libs_cl/render.lua#L756","returns":[{"type":"VMatrix","value":"VMatrix The currently active matrix.","description":"The currently active matrix."}],"realm":"client","class":"function","name":"getMatrix","description":" Returns a copy of the model matrix that is at the top of the stack."},"setModelLighting":{"path":"libs_cl/render.lua#L600","realm":"client","params":[{"type":"number","value":"number lightDirection The light source to edit, builtins.BOX enumeration.","name":"lightDirection","description":"The light source to edit, builtins.BOX enumeration."},{"type":"number","value":"number r The red component of the light color.","name":"r","description":"The red component of the light color."},{"type":"number","value":"number g The green component of the light color.","name":"g","description":"The green component of the light color."},{"type":"number","value":"number b The blue component of the light color.","name":"b","description":"The blue component of the light color."}],"class":"function","name":"setModelLighting","description":" Sets up the ambient lighting for any upcoming render operation. Ambient lighting can be seen as a cube enclosing the object to be drawn, each of its faces representing a directional light source that shines towards the object."},"draw3DWireframeBox":{"path":"libs_cl/render.lua#L2046","realm":"client","params":[{"type":"Vector","value":"Vector origin Origin of the box.","name":"origin","description":"Origin of the box."},{"type":"Angle","value":"Angle angle Orientation of the box","name":"angle","description":"Orientation of the box"},{"type":"Vector","value":"Vector mins Start position of the box, relative to origin.","name":"mins","description":"Start position of the box, relative to origin."},{"type":"Vector","value":"Vector maxs End position of the box, relative to origin.","name":"maxs","description":"End position of the box, relative to origin."},{"type":"boolean?","value":"boolean? writeZ Optional should the box be drawn with depth considered (default: true)","name":"writeZ","description":"Optional should the box be drawn with depth considered (default: true)"}],"class":"function","name":"draw3DWireframeBox","description":" Draws a wireframe box in 3D space"},"draw3DWireframeSphere":{"path":"libs_cl/render.lua#L2003","realm":"client","params":[{"type":"Vector","value":"Vector pos Position of the sphere","name":"pos","description":"Position of the sphere"},{"type":"number","value":"number radius Radius of the sphere","name":"radius","description":"Radius of the sphere"},{"type":"number","value":"number longitudeSteps The amount of longitude steps. The larger this number is, the smoother the sphere is","name":"longitudeSteps","description":"The amount of longitude steps. The larger this number is, the smoother the sphere is"},{"type":"number","value":"number latitudeSteps The amount of latitude steps. The larger this number is, the smoother the sphere is","name":"latitudeSteps","description":"The amount of latitude steps. The larger this number is, the smoother the sphere is"},{"type":"boolean?","value":"boolean? writeZ Optional should the sphere be drawn with depth considered (default: true)","name":"writeZ","description":"Optional should the sphere be drawn with depth considered (default: true)"}],"class":"function","name":"draw3DWireframeSphere","description":" Draws a wireframe sphere"},"drawRectFast":{"path":"libs_cl/render.lua#L1352","realm":"client","params":[{"type":"number","value":"number x Top left corner x","name":"x","description":"Top left corner x"},{"type":"number","value":"number y Top left corner y","name":"y","description":"Top left corner y"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"}],"class":"function","name":"drawRectFast","description":" Draws a rectangle using the current color\n Faster, but uses integer coordinates and will get clipped by user's screen resolution"},"setScreenDimensions":{"path":"libs_cl/render.lua#L2691","realm":"client","params":[{"type":"Entity","value":"Entity screen The custom screen to be resized","name":"screen","description":"The custom screen to be resized"},{"type":"number","value":"number x The x offset of the screen","name":"x","description":"The x offset of the screen"},{"type":"number","value":"number y The y offset of the screen","name":"y","description":"The y offset of the screen"},{"type":"number","value":"number w The width of the screen","name":"w","description":"The width of the screen"},{"type":"number","value":"number h The height of the screen","name":"h","description":"The height of the screen"}],"class":"function","name":"setScreenDimensions","description":" Using the custom screen model, sets the screen offset and size as long as its within bounds of -1024 to 1024 units"},"setColor":{"path":"libs_cl/render.lua#L862","realm":"client","params":[{"type":"Color","value":"Color clr Color type","name":"clr","description":"Color type"}],"class":"function","name":"setColor","description":" Sets the draw color"},"setChipOverlay":{"path":"libs_cl/render.lua#L2679","realm":"client","params":[{"type":"string?","value":"string? name The name of the RT to use or nil to set it back to normal","name":"name","description":"The name of the RT to use or nil to set it back to normal"}],"class":"function","name":"setChipOverlay","description":" Sets the overlay of the chip to a user's rendertarget"},"setBackgroundColor":{"path":"libs_cl/render.lua#L830","realm":"client","params":[{"type":"Color","value":"Color col Color of background","name":"col","description":"Color of background"},{"type":"Entity?","value":"Entity? screen (Optional) entity of screen","name":"screen","description":"(Optional) entity of screen"}],"class":"function","name":"setBackgroundColor","description":" Sets background color of screen"},"pushCustomClipPlane":{"path":"libs_cl/render.lua#L2556","realm":"client","params":[{"type":"Vector","value":"Vector normal The normal of the clipping plane.","name":"normal","description":"The normal of the clipping plane."},{"type":"number","value":"number distance The normal of the clipping plane.","name":"distance","description":"The normal of the clipping plane."}],"class":"function","name":"pushCustomClipPlane","description":" Pushes a new clipping plane of the clip plane stack."},"setMaterialEffectSub":{"path":"libs_cl/render.lua#L1003","realm":"client","params":[{"type":"Material","value":"Material mat The material object to use the texture of, or the name of a rendertarget to use instead.","name":"mat","description":"The material object to use the texture of, or the name of a rendertarget to use instead."}],"class":"function","name":"setMaterialEffectSub","description":" Sets the current render material to the given material or the rendertarget, applying a subtractive shader when drawn."},"readPixel":{"path":"libs_cl/render.lua#L2334","returns":[{"type":"Color","value":"Color Color object with ( r, g, b, a ) from the specified pixel.","description":"Color object with ( r, g, b, a ) from the specified pixel."}],"realm":"client","params":[{"type":"number","value":"number x Pixel x-coordinate.","name":"x","description":"Pixel x-coordinate."},{"type":"number","value":"number y Pixel y-coordinate.","name":"y","description":"Pixel y-coordinate."}],"class":"function","name":"readPixel","description":" Reads the color of the specified pixel."},"pushMatrix":{"path":"libs_cl/render.lua#L715","realm":"client","params":[{"type":"VMatrix","value":"VMatrix transform The matrix","name":"transform","description":"The matrix"},{"type":"boolean?","value":"boolean? absolute (default false) Should the transformation be absolute with respect to world or multipled with existing stack?","name":"absolute","description":"(default false) Should the transformation be absolute with respect to world or multipled with existing stack?"}],"class":"function","name":"pushMatrix","description":" Pushes a matrix onto the model matrix stack."},"depthRange":{"path":"libs_cl/render.lua#L2728","realm":"client","params":[{"type":"number","value":"number min The minimum depth of the upcoming render. 0.0 = render normally; 1.0 = render nothing.","name":"min","description":"The minimum depth of the upcoming render. 0.0 = render normally; 1.0 = render nothing."},{"type":"number","value":"number max The maximum depth of the upcoming render. 0.0 = render everything (through walls); 1.0 = render normally.","name":"max","description":"The maximum depth of the upcoming render. 0.0 = render everything (through walls); 1.0 = render normally."}],"class":"function","name":"depthRange","description":" Set's the depth range of the upcoming render."},"destroyRenderTarget":{"path":"libs_cl/render.lua#L1153","realm":"client","params":[{"type":"string","value":"string name Rendertarget name","name":"name","description":"Rendertarget name"}],"class":"function","name":"destroyRenderTarget","description":" Releases the rendertarget. Required if you reach the maximum rendertargets."},"pushViewMatrix":{"path":"libs_cl/render.lua#L771","realm":"client","params":[{"type":"table","value":"table tbl The view matrix data. See http://wiki.facepunch.com/gmod/Structures/RenderCamData","name":"tbl","description":"The view matrix data. See http://wiki.facepunch.com/gmod/Structures/RenderCamData"}],"class":"function","name":"pushViewMatrix","description":" Pushes a perspective matrix onto the view matrix stack."},"getTextSize":{"path":"libs_cl/render.lua#L1795","returns":[{"type":"number","value":"number width of the text","description":"width of the text"},{"type":"number","value":"number height of the text","description":"height of the text"}],"realm":"client","params":[{"type":"string","value":"string text Text to get the size of","name":"text","description":"Text to get the size of"}],"class":"function","name":"getTextSize","description":" Gets the size of the specified text. Don't forget to use setFont before calling this function"},"disableScissorRect":{"path":"libs_cl/render.lua#L742","realm":"client","class":"function","name":"disableScissorRect","description":" Disables a scissoring rect which limits the drawing area."},"setMaterialEffectAdd":{"path":"libs_cl/render.lua#L989","realm":"client","params":[{"type":"Material","value":"Material mat The material object to use the texture of, or the name of a rendertarget to use instead.","name":"mat","description":"The material object to use the texture of, or the name of a rendertarget to use instead."}],"class":"function","name":"setMaterialEffectAdd","description":" Sets the current render material to the given material or the rendertarget, applying an additive shader when drawn."},"draw3DSphere":{"path":"libs_cl/render.lua#L1990","realm":"client","params":[{"type":"Vector","value":"Vector pos Position of the sphere","name":"pos","description":"Position of the sphere"},{"type":"number","value":"number radius Radius of the sphere","name":"radius","description":"Radius of the sphere"},{"type":"number","value":"number longitudeSteps The amount of longitude steps. The larger this number is, the smoother the sphere is","name":"longitudeSteps","description":"The amount of longitude steps. The larger this number is, the smoother the sphere is"},{"type":"number","value":"number latitudeSteps The amount of latitude steps. The larger this number is, the smoother the sphere is","name":"latitudeSteps","description":"The amount of latitude steps. The larger this number is, the smoother the sphere is"}],"class":"function","name":"draw3DSphere","description":" Draws a sphere"},"setMaterialEffectBloom":{"path":"libs_cl/render.lua#L1017","realm":"client","params":[{"type":"Material","value":"Material mat The material object to use the texture of, or the name of a rendertarget to use instead.","name":"mat","description":"The material object to use the texture of, or the name of a rendertarget to use instead."},{"type":"number","value":"number levelr Multiplier for all red pixels. 1 = unchanged","name":"levelr","description":"Multiplier for all red pixels. 1 = unchanged"},{"type":"number","value":"number levelg Multiplier for all green pixels. 1 = unchanged","name":"levelg","description":"Multiplier for all green pixels. 1 = unchanged"},{"type":"number","value":"number levelb Multiplier for all blue pixels. 1 = unchanged","name":"levelb","description":"Multiplier for all blue pixels. 1 = unchanged"},{"type":"number","value":"number colormul Multiplier for all three colors. 1 = unchanged","name":"colormul","description":"Multiplier for all three colors. 1 = unchanged"}],"class":"function","name":"setMaterialEffectBloom","description":" Sets the current render material to the given material or the rendertarget, applying a bloom shader to the texture."},"setFogMode":{"path":"libs_cl/render.lua#L2616","realm":"client","params":[{"type":"number","value":"number mode Fog mode","name":"mode","description":"Fog mode"}],"class":"function","name":"setFogMode","description":" Sets the fog mode. See: https://wiki.facepunch.com/gmod/Enums/MATERIAL_FOG"},"clearStencil":{"path":"libs_cl/render.lua#L579","realm":"client","class":"function","name":"clearStencil","description":" Resets all values in the stencil buffer to zero."},"draw3DQuadUV":{"path":"libs_cl/render.lua#L2153","realm":"client","params":[{"type":"table","value":"table vert1 First vertex. {x, y, z, u, v}","name":"vert1","description":"First vertex. {x, y, z, u, v}"},{"type":"table","value":"table vert2 The second vertex.","name":"vert2","description":"The second vertex."},{"type":"table","value":"table vert3 The third vertex.","name":"vert3","description":"The third vertex."},{"type":"table","value":"table vert4 The fourth vertex.","name":"vert4","description":"The fourth vertex."}],"class":"function","name":"draw3DQuadUV","description":" Draws 2 connected triangles with custom UVs."},"drawLine":{"path":"libs_cl/render.lua#L1720","realm":"client","params":[{"type":"number","value":"number x1 X start float coordinate","name":"x1","description":"X start float coordinate"},{"type":"number","value":"number y1 Y start float coordinate","name":"y1","description":"Y start float coordinate"},{"type":"number","value":"number x2 X end float coordinate","name":"x2","description":"X end float coordinate"},{"type":"number","value":"number y2 Y end float coordinate","name":"y2","description":"Y end float coordinate"}],"class":"function","name":"drawLine","description":" Draws a line."},"setRenderTargetTexture":{"path":"libs_cl/render.lua#L1214","realm":"client","params":[{"type":"string?","value":"string? name Name of the render target to use","name":"name","description":"Name of the render target to use"}],"class":"function","name":"setRenderTargetTexture","description":" Sets the active texture to the render target with the specified name.\n Nil to reset."},"getScreenEntity":{"path":"libs_cl/render.lua#L2297","returns":[{"type":"Entity","value":"Entity Entity of the screen or hud being rendered","description":"Entity of the screen or hud being rendered"}],"realm":"client","class":"function","name":"getScreenEntity","description":" Returns the entity currently being rendered to"},"setStencilCompareFunction":{"path":"libs_cl/render.lua#L643","realm":"client","params":[{"type":"number","value":"number compareFunction","name":"compareFunction","description":""}],"class":"function","name":"setStencilCompareFunction","description":" Sets the compare function of the stencil. More: https://wiki.facepunch.com/gmod/render.SetStencilCompareFunction"},"enableScissorRect":{"path":"libs_cl/render.lua#L732","realm":"client","params":[{"type":"number","value":"number startX X start coordinate of the scissor rect.","name":"startX","description":"X start coordinate of the scissor rect."},{"type":"number","value":"number startY Y start coordinate of the scissor rect.","name":"startY","description":"Y start coordinate of the scissor rect."},{"type":"number","value":"number endX X end coordinate of the scissor rect.","name":"endX","description":"X end coordinate of the scissor rect."},{"type":"number","value":"number endY Y end coordinate of the scissor rect.","name":"endY","description":"Y end coordinate of the scissor rect."}],"class":"function","name":"enableScissorRect","description":" Enables a scissoring rect which limits the drawing area. Only works 2D contexts such as HUD or render targets."},"getAngles":{"path":"libs_cl/render.lua#L557","returns":[{"type":"Angle","value":"Angle The angles of the current render context as calculated by calcview.","description":"The angles of the current render context as calculated by calcview."}],"realm":"client","class":"function","name":"getAngles","description":" Call EyeAngles()"},"setFont":{"path":"libs_cl/render.lua#L1804","realm":"client","params":[{"type":"string","value":"string font The font to use","name":"font","description":"The font to use"}],"class":"function","name":"setFont","description":" Sets the font\n Use a font created by render.createFont or use one of these already defined fonts:\n \\- DebugFixed\n \\- DebugFixedSmall\n \\- Default\n \\- Marlett\n \\- Trebuchet18\n \\- Trebuchet24\n \\- HudHintTextLarge\n \\- HudHintTextSmall\n \\- CenterPrintText\n \\- HudSelectionText\n \\- CloseCaption_Normal\n \\- CloseCaption_Bold\n \\- CloseCaption_BoldItalic\n \\- ChatFont\n \\- TargetID\n \\- TargetIDSmall\n \\- HL2MPTypeDeath\n \\- BudgetLabel\n \\- HudNumbers\n \\- DermaDefault\n \\- DermaDefaultBold\n \\- DermaLarge"},"drawRectRotatedFast":{"path":"libs_cl/render.lua#L1375","realm":"client","params":[{"type":"number","value":"number x X coordinate of center of rect","name":"x","description":"X coordinate of center of rect"},{"type":"number","value":"number y Y coordinate of center of rect","name":"y","description":"Y coordinate of center of rect"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"},{"type":"number","value":"number rot Rotation in degrees","name":"rot","description":"Rotation in degrees"}],"class":"function","name":"drawRectRotatedFast","description":" Draws a rotated, rectangle using the current color\n Faster, but uses integer coordinates and will get clipped by user's screen resolution"},"getEyePos":{"path":"libs_cl/render.lua#L549","returns":[{"type":"Vector","value":"Vector The origin of the current render context as calculated by calcview.","description":"The origin of the current render context as calculated by calcview."}],"realm":"client","class":"function","name":"getEyePos","description":" Call EyePos()"},"renderViewsLeft":{"path":"libs_cl/render.lua#L2535","returns":[{"type":"number","value":"number How many render.renderView calls are left","description":"How many render.renderView calls are left"}],"realm":"client","class":"function","name":"renderViewsLeft","description":" Returns how many render.renderView calls can be done in the current frame."},"getEyeVector":{"path":"libs_cl/render.lua#L563","returns":[{"type":"Vector","value":"Vector The normal vector of the current render context as calculated by calcview, similar to render.getAngles.","description":"The normal vector of the current render context as calculated by calcview, similar to render.getAngles."}],"realm":"client","class":"function","name":"getEyeVector","description":" Call EyeVector()"},"setLightingMode":{"path":"libs_cl/render.lua#L854","realm":"client","params":[{"type":"number","value":"number mode The lighting mode. 0 - Default, 1 - Fullbright, 2 - Increased Fullbright","name":"mode","description":"The lighting mode. 0 - Default, 1 - Fullbright, 2 - Increased Fullbright"}],"class":"function","name":"setLightingMode","description":" Sets the lighting mode"},"setTint":{"path":"libs_cl/render.lua#L925","realm":"client","params":[{"type":"Color","value":"Color c A color","name":"c","description":"A color"}],"class":"function","name":"setTint","description":" Sets the drawing tint. Internally, calls render.setColorModulation and render.setBlend with the color parameters divided by 255."},"drawCircle":{"path":"libs_cl/render.lua#L1413","realm":"client","params":[{"type":"number","value":"number x Center x coordinate","name":"x","description":"Center x coordinate"},{"type":"number","value":"number y Center y coordinate","name":"y","description":"Center y coordinate"},{"type":"number","value":"number radius Radius","name":"radius","description":"Radius"}],"class":"function","name":"drawCircle","description":" Draws a circle outline"},"getBlend":{"path":"libs_cl/render.lua#L1958","returns":[{"type":"number","value":"number Blending in the range 0 to 1","description":"Blending in the range 0 to 1"}],"realm":"client","class":"function","name":"getBlend","description":" Returns the current alpha blending"},"getDefaultFont":{"path":"libs_cl/render.lua#L1835","returns":[{"type":"string","value":"string Default font","description":"Default font"}],"realm":"client","class":"function","name":"getDefaultFont","description":" Gets the default font"},"setFilterMin":{"path":"libs_cl/render.lua#L1265","realm":"client","params":[{"type":"number","value":"number val The filter function to use http://wiki.facepunch.com/gmod/Enums/TEXFILTER","name":"val","description":"The filter function to use http://wiki.facepunch.com/gmod/Enums/TEXFILTER"}],"class":"function","name":"setFilterMin","description":" Sets the texture filtering function when viewing a far texture"},"setBlend":{"path":"libs_cl/render.lua#L1965","realm":"client","params":[{"type":"number","value":"number alpha Blending in the range 0 to 1","name":"alpha","description":"Blending in the range 0 to 1"}],"class":"function","name":"setBlend","description":" Changes alpha blending for the upcoming model drawing operations"},"renderView":{"path":"libs_cl/render.lua#L2393","realm":"client","params":[{"type":"table","value":"table tbl view The view data to be used in the rendering. See http://wiki.facepunch.com/gmod/Structures/ViewData. There's an additional key drawviewer used to tell the engine whether the local player model should be rendered.","name":"tbl","description":"view The view data to be used in the rendering. See http://wiki.facepunch.com/gmod/Structures/ViewData. There's an additional key drawviewer used to tell the engine whether the local player model should be rendered."}],"class":"function","name":"renderView","description":" Renders the scene with the specified viewData to the current active render target."},"setFogColor":{"path":"libs_cl/render.lua#L2625","realm":"client","params":[{"type":"Color","value":"Color col Color (alpha won't have any effect)","name":"col","description":"Color (alpha won't have any effect)"}],"class":"function","name":"setFogColor","description":" Changes color of the fog"},"drawSimpleText":{"path":"libs_cl/render.lua#L1854","returns":[{"type":"number","value":"number Width of the drawn text. Same as calling render.getTextSize","description":"Width of the drawn text. Same as calling render.getTextSize"},{"type":"number","value":"number Height of the drawn text. Same as calling render.getTextSize","description":"Height of the drawn text. Same as calling render.getTextSize"}],"realm":"client","params":[{"type":"number","value":"number x X coordinate","name":"x","description":"X coordinate"},{"type":"number","value":"number y Y coordinate","name":"y","description":"Y coordinate"},{"type":"string","value":"string text Text to draw","name":"text","description":"Text to draw"},{"type":"number?","value":"number? xalign Horizontal text alignment. Default TEXT_ALIGN.LEFT","name":"xalign","description":"Horizontal text alignment. Default TEXT_ALIGN.LEFT"},{"type":"number?","value":"number? yalign Vertical text alignment. Default TEXT_ALIGN.TOP","name":"yalign","description":"Vertical text alignment. Default TEXT_ALIGN.TOP"}],"class":"function","name":"drawSimpleText","description":" Draws text more easily and quickly but no new lines or tabs."},"draw3DTriangleUV":{"path":"libs_cl/render.lua#L2217","realm":"client","params":[{"type":"table","value":"table vert1 First vertex. {x = x1, y = y1, z = z1, u = u1, v = v1}","name":"vert1","description":"First vertex. {x = x1, y = y1, z = z1, u = u1, v = v1}"},{"type":"table","value":"table vert2 The second vertex.","name":"vert2","description":"The second vertex."},{"type":"table","value":"table vert3 The third vertex.","name":"vert3","description":"The third vertex."}],"class":"function","name":"draw3DTriangleUV","description":" Draws a triangle with UV coordinates in 3D space"},"drawRoundedBoxEx":{"path":"libs_cl/render.lua#L1323","realm":"client","params":[{"type":"number","value":"number r The corner radius","name":"r","description":"The corner radius"},{"type":"number","value":"number x Top left corner x coordinate","name":"x","description":"Top left corner x coordinate"},{"type":"number","value":"number y Top left corner y coordinate","name":"y","description":"Top left corner y coordinate"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"},{"type":"boolean?","value":"boolean? tl Top left corner. Default false","name":"tl","description":"Top left corner. Default false"},{"type":"boolean?","value":"boolean? tr Top right corner. Default false","name":"tr","description":"Top right corner. Default false"},{"type":"boolean?","value":"boolean? bl Bottom left corner. Default false","name":"bl","description":"Bottom left corner. Default false"},{"type":"boolean?","value":"boolean? br Bottom right corner. Default false","name":"br","description":"Bottom right corner. Default false"}],"class":"function","name":"drawRoundedBoxEx","description":" Draws a rounded rectangle using the current color"},"drawTriangle":{"path":"libs_cl/render.lua#L1476","realm":"client","params":[{"type":"number","value":"number x1 X of the first vertex","name":"x1","description":"X of the first vertex"},{"type":"number","value":"number y1 Y of the first vertex","name":"y1","description":"Y of the first vertex"},{"type":"number","value":"number x2 X of the second vertex","name":"x2","description":"X of the second vertex"},{"type":"number","value":"number y2 Y of the second vertex","name":"y2","description":"Y of the second vertex"},{"type":"number","value":"number x3 X of the third vertex","name":"x3","description":"X of the third vertex"},{"type":"number","value":"number y3 Y of the third vertex","name":"y3","description":"Y of the third vertex"}],"class":"function","name":"drawTriangle","description":" Draws a triangle using the current color"},"parseMarkup":{"path":"libs_cl/render.lua#L1888","returns":[{"type":"Markup","value":"Markup The markup object. See https://wiki.facepunch.com/gmod/markup.Parse","description":"The markup object. See https://wiki.facepunch.com/gmod/markup.Parse"}],"realm":"client","params":[{"type":"string","value":"string str The markup string to parse","name":"str","description":"The markup string to parse"},{"type":"number?","value":"number? maxsize The max width of the markup. Default nil","name":"maxsize","description":"The max width of the markup. Default nil"}],"class":"function","name":"parseMarkup","description":" Constructs a markup object for quick styled text drawing."},"computeLighting":{"path":"libs_cl/render.lua#L2582","returns":[{"type":"Vector","value":"Vector Vector representing color of the light","description":"Vector representing color of the light"}],"realm":"client","params":[{"type":"Vector","value":"Vector pos Vector position to sample from","name":"pos","description":"Vector position to sample from"},{"type":"Vector","value":"Vector normal Normal vector of the surface","name":"normal","description":"Normal vector of the surface"}],"class":"function","name":"computeLighting","description":" Calculates the light color of a certain surface"},"setWriteDepthToDestAlpha":{"path":"libs_cl/render.lua#L592","realm":"client","params":[{"type":"boolean","value":"boolean enable True to write depth to destination alpha.","name":"enable","description":"True to write depth to destination alpha."}],"class":"function","name":"setWriteDepthToDestAlpha","description":" Sets the internal parameter INT_RENDERPARM_WRITE_DEPTH_TO_DESTALPHA. Allows creation of RTs with alpha masks.\n Check https://wiki.facepunch.com/gmod/render.SetWriteDepthToDestAlpha for example."},"drawPixelsSubrectRGB":{"path":"libs_cl/render.lua#L1672","realm":"client","params":[{"type":"number","value":"number dstX Destination x coordinate","name":"dstX","description":"Destination x coordinate"},{"type":"number","value":"number dstY Destination y coordinate","name":"dstY","description":"Destination y coordinate"},{"type":"number","value":"number srcX Source x coordinate","name":"srcX","description":"Source x coordinate"},{"type":"number","value":"number srcY Source y coordinate","name":"srcY","description":"Source y coordinate"},{"type":"number","value":"number srcW Source original width","name":"srcW","description":"Source original width"},{"type":"number","value":"number srcH Source original height","name":"srcH","description":"Source original height"},{"type":"number","value":"number subrectW Width of subrect","name":"subrectW","description":"Width of subrect"},{"type":"number","value":"number subrectH Height of subrect","name":"subrectH","description":"Height of subrect"},{"type":"table","value":"table dataR Red channel data.","name":"dataR","description":"Red channel data."},{"type":"table","value":"table dataG Green channel data.","name":"dataG","description":"Green channel data."},{"type":"table","value":"table dataB Blue channel data.","name":"dataB","description":"Blue channel data."}],"class":"function","name":"drawPixelsSubrectRGB","description":" Draws region of RGB color channel tables to current render target."},"drawRect":{"path":"libs_cl/render.lua#L1363","realm":"client","params":[{"type":"number","value":"number x Top left corner x","name":"x","description":"Top left corner x"},{"type":"number","value":"number y Top left corner y","name":"y","description":"Top left corner y"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"}],"class":"function","name":"drawRect","description":" Draws a rectangle using the current color"},"resetModelLighting":{"path":"libs_cl/render.lua#L610","realm":"client","params":[{"type":"number","value":"number r The red part of the color, 0-1","name":"r","description":"The red part of the color, 0-1"},{"type":"number","value":"number g The green part of the color, 0-1","name":"g","description":"The green part of the color, 0-1"},{"type":"number","value":"number b The blue part of the color, 0-1","name":"b","description":"The blue part of the color, 0-1"}],"class":"function","name":"resetModelLighting","description":" Resets the model lighting to the specified color."},"clear":{"path":"libs_cl/render.lua#L1284","realm":"client","params":[{"type":"Color?","value":"Color? clr Color type to clear with","name":"clr","description":"Color type to clear with"},{"type":"boolean?","value":"boolean? depth Boolean if should clear depth. Default false","name":"depth","description":"Boolean if should clear depth. Default false"}],"class":"function","name":"clear","description":" Clears the active render target"},"getLightColor":{"path":"libs_cl/render.lua#L2602","returns":[{"type":"Vector","value":"Vector Vector representing color of the light","description":"Vector representing color of the light"}],"realm":"client","params":[{"type":"Vector","value":"Vector pos Vector position to sample from","name":"pos","description":"Vector position to sample from"}],"class":"function","name":"getLightColor","description":" Gets the light exposure on the specified position"},"pixelVisible":{"path":"libs_cl/render.lua#L2736","returns":[{"type":"number","value":"number Percentage visible, from 0-1","description":"Percentage visible, from 0-1"}],"realm":"client","params":[{"type":"Vector","value":"Vector position","name":"position","description":""},{"type":"number","value":"number radius","name":"radius","description":""}],"class":"function","name":"pixelVisible","description":" Returns the visibility of a sphere in the world."},"screenShake":{"path":"libs_cl/render.lua#L2719","realm":"client","params":[{"type":"number","value":"number amplitude The strength of the effect","name":"amplitude","description":"The strength of the effect"},{"type":"number","value":"number frequency The frequency of the effect in hertz","name":"frequency","description":"The frequency of the effect in hertz"},{"type":"number","value":"number duration The duration of the effect in seconds, max 10.","name":"duration","description":"The duration of the effect in seconds, max 10."}],"class":"function","name":"screenShake","description":" Makes the screen shake, client must be connected to a HUD."},"setFogStart":{"path":"libs_cl/render.lua#L2643","realm":"client","params":[{"type":"number","value":"number distance Start distance","name":"distance","description":"Start distance"}],"class":"function","name":"setFogStart","description":" Sets distance at which the fog will start appearing"},"resetStencil":{"path":"libs_cl/render.lua#L699","realm":"client","class":"function","name":"resetStencil","description":" Resets stencil operations to their default behavior"},"drawTexturedRect":{"path":"libs_cl/render.lua#L1505","realm":"client","params":[{"type":"number","value":"number x Top left corner x","name":"x","description":"Top left corner x"},{"type":"number","value":"number y Top left corner y","name":"y","description":"Top left corner y"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"}],"class":"function","name":"drawTexturedRect","description":" Draws a textured rectangle"},"setFogDensity":{"path":"libs_cl/render.lua#L2634","realm":"client","params":[{"type":"number","value":"number density Density between 0 and 1","name":"density","description":"Density between 0 and 1"}],"class":"function","name":"setFogDensity","description":" Changes density of the fog"},"getGameResolution":{"path":"libs_cl/render.lua#L2366","returns":[{"type":"number","value":"number the X size of the game window","description":"the X size of the game window"},{"type":"number","value":"number the Y size of the game window","description":"the Y size of the game window"}],"realm":"client","class":"function","name":"getGameResolution","description":" Returns width and height of the game window"},"getAmbientLightColor":{"path":"libs_cl/render.lua#L2610","returns":[{"type":"Vector","value":"Vector Vector representing color of the light","description":"Vector representing color of the light"}],"realm":"client","class":"function","name":"getAmbientLightColor","description":" Returns the ambient color of the map"},"isInRenderView":{"path":"libs_cl/render.lua#L2529","returns":[{"type":"boolean","value":"boolean Whether render.renderView is being executed","description":"Whether render.renderView is being executed"}],"realm":"client","class":"function","name":"isInRenderView","description":" Returns whether render.renderView is being executed."},"renderTargetExists":{"path":"libs_cl/render.lua#L1131","realm":"client","params":[{"type":"string","value":"string name The name of the render target","name":"name","description":"The name of the render target"}],"class":"function","name":"renderTargetExists","description":" Check if the specified render target exists."},"drawText":{"path":"libs_cl/render.lua#L1841","realm":"client","params":[{"type":"number","value":"number x X coordinate","name":"x","description":"X coordinate"},{"type":"number","value":"number y Y coordinate","name":"y","description":"Y coordinate"},{"type":"string","value":"string text Text to draw","name":"text","description":"Text to draw"},{"type":"number","value":"number alignment Horizontal text alignment. Default TEXT_ALIGN.LEFT","name":"alignment","description":"Horizontal text alignment. Default TEXT_ALIGN.LEFT"}],"class":"function","name":"drawText","description":" Draws text with newlines and tabs"},"setTextureFromScreen":{"path":"libs_cl/render.lua#L1237","realm":"client","params":[{"type":"Entity","value":"Entity ent Screen entity","name":"ent","description":"Screen entity"}],"class":"function","name":"setTextureFromScreen","description":" Sets the texture of a screen entity"},"getScreenInfo":{"path":"libs_cl/render.lua#L2280","returns":[{"type":"table","value":"table A table describing the screen.","description":"A table describing the screen."}],"realm":"client","params":[{"type":"Entity","value":"Entity e The screen to get info from.","name":"e","description":"The screen to get info from."}],"class":"function","name":"getScreenInfo","description":" Returns information about the screen, such as world offsets, dimensions, and rotation.\n Note: this does a table copy so move it out of your draw hook"},"setMaterialEffectColorModify":{"path":"libs_cl/render.lua#L1076","realm":"client","params":[{"type":"Material","value":"Material mat The material object to use the texture of, or the name of a rendertarget to use instead.","name":"mat","description":"The material object to use the texture of, or the name of a rendertarget to use instead."},{"type":"table","value":"table cmStructure A table where each key must be of \"addr\", \"addg\", \"addb\", \"brightness\", \"color\" or \"colour\", \"contrast\", \"mulr\", \"mulg\", and \"mulb\". All keys are optional.","name":"cmStructure","description":"A table where each key must be of \"addr\", \"addg\", \"addb\", \"brightness\", \"color\" or \"colour\", \"contrast\", \"mulr\", \"mulg\", and \"mulb\". All keys are optional."}],"class":"function","name":"setMaterialEffectColorModify","description":" Sets the current render material to the given material or the rendertarget, applying a color modification shader to the texture. Alias: render.setMaterialEffectColourModify"},"setStencilZFailOperation":{"path":"libs_cl/render.lua#L667","realm":"client","params":[{"type":"number","value":"number operation","name":"operation","description":""}],"class":"function","name":"setStencilZFailOperation","description":" Sets the operation to be performed on the stencil buffer values if the stencil test is passed but the depth buffer test fails. More: http://wiki.facepunch.com/gmod/render.SetStencilZFailOperation"},"capturePixels":{"path":"libs_cl/render.lua#L2303","realm":"client","class":"function","name":"capturePixels","description":" Dumps the current render target and allows the pixels to be accessed by render.readPixel."},"drawTexturedRectFast":{"path":"libs_cl/render.lua#L1494","realm":"client","params":[{"type":"number","value":"number x Top left corner x","name":"x","description":"Top left corner x"},{"type":"number","value":"number y Top left corner y","name":"y","description":"Top left corner y"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"}],"class":"function","name":"drawTexturedRectFast","description":" Draws a textured rectangle\n Faster, but uses integer coordinates and will get clipped by user's screen resolution"},"drawBlurEffect":{"path":"libs_cl/render.lua#L1109","realm":"client","params":[{"type":"number","value":"number blurx The amount of horizontal blur to apply.","name":"blurx","description":"The amount of horizontal blur to apply."},{"type":"number","value":"number blury The amount of vertical blur to apply.","name":"blury","description":"The amount of vertical blur to apply."},{"type":"number","value":"number passes The number of times the blur effect is applied.","name":"passes","description":"The number of times the blur effect is applied."}],"class":"function","name":"drawBlurEffect","description":" Applies a blur effect to the active rendertarget. This must be used with a rendertarget created beforehand."},"draw3DBeam":{"path":"libs_cl/render.lua#L2063","realm":"client","params":[{"type":"Vector","value":"Vector startPos Beam start position.","name":"startPos","description":"Beam start position."},{"type":"Vector","value":"Vector endPos Beam end position.","name":"endPos","description":"Beam end position."},{"type":"number","value":"number width The width of the beam.","name":"width","description":"The width of the beam."},{"type":"number","value":"number textureStart The start coordinate of the texture used.","name":"textureStart","description":"The start coordinate of the texture used."},{"type":"number","value":"number textureEnd The end coordinate of the texture used.","name":"textureEnd","description":"The end coordinate of the texture used."}],"class":"function","name":"draw3DBeam","description":" Draws textured beam."},"setStencilEnable":{"path":"libs_cl/render.lua#L571","realm":"client","params":[{"type":"boolean","value":"boolean enable True to enable, false to disable","name":"enable","description":"True to enable, false to disable"}],"class":"function","name":"setStencilEnable","description":" Sets whether stencil tests are carried out for each rendered pixel. Only pixels passing the stencil test are written to the render target."},"destroyTexture":{"path":"libs_cl/render.lua#L953","realm":"client","params":[{"type":"Material","value":"Material mat The material object","name":"mat","description":"The material object"}],"class":"function","name":"destroyTexture","description":" Releases the texture. Required if you reach the maximum url textures."},"createRenderTarget":{"path":"libs_cl/render.lua#L1138","realm":"client","params":[{"type":"string","value":"string name The name of the render target","name":"name","description":"The name of the render target"}],"class":"function","name":"createRenderTarget","description":" Creates a new render target to draw onto.\n The dimensions will always be 1024x1024"},"drawPoly":{"path":"libs_cl/render.lua#L1927","realm":"client","params":[{"type":"table","value":"table poly Table of polygon vertices. Texture coordinates are optional. {{x=x1, y=y1, u=u1, v=v1}, ... }","name":"poly","description":"Table of polygon vertices. Texture coordinates are optional. {{x=x1, y=y1, u=u1, v=v1}, ... }"}],"class":"function","name":"drawPoly","description":" Draws a polygon."},"captureImage":{"path":"libs_cl/render.lua#L2310","returns":[{"type":"string","value":"string Image binary data","description":"Image binary data"}],"realm":"client","params":[{"type":"table","value":"table captureData Parameters of the capture. See https://wiki.facepunch.com/gmod/Structures/RenderCaptureData","name":"captureData","description":"Parameters of the capture. See https://wiki.facepunch.com/gmod/Structures/RenderCaptureData"}],"class":"function","name":"captureImage","description":" Captures a part of the current render target and returns the data as a binary string in the given format."},"cursorPos":{"path":"libs_cl/render.lua#L2232","returns":[{"type":"number","value":"number X position","description":"X position"},{"type":"number","value":"number Y position","description":"Y position"}],"realm":"client","params":[{"type":"Player?","value":"Player? ply player to get cursor position from. Default player()","name":"ply","description":"player to get cursor position from. Default player()"},{"type":"Entity?","value":"Entity? screen An explicit screen to get the cursor pos of (default: The current rendering screen using 'render' hook)","name":"screen","description":"An explicit screen to get the cursor pos of (default: The current rendering screen using 'render' hook)"}],"class":"function","name":"cursorPos","description":" Gets a 2D cursor position where ply is aiming at the current rendered screen or nil if they aren't aiming at it."},"getTint":{"path":"libs_cl/render.lua#L904","returns":[{"type":"Color","value":"Color The current color & blend modulation as a color","description":"The current color & blend modulation as a color"}],"realm":"client","class":"function","name":"getTint","description":" Gets the drawing tint. Internally, calls render.getColorModulation and render.getBlend, multiplies the values by 255, then returns a color object."},"setStencilFailOperation":{"path":"libs_cl/render.lua#L651","realm":"client","params":[{"type":"number","value":"number operation","name":"operation","description":""}],"class":"function","name":"setStencilFailOperation","description":" Sets the operation to be performed on the stencil buffer values if the compare function was not successful. More: http://wiki.facepunch.com/gmod/render.SetStencilFailOperation"},"suppressEngineLighting":{"path":"libs_cl/render.lua#L585","realm":"client","params":[{"type":"boolean","value":"boolean suppress True to suppress false to enable.","name":"suppress","description":"True to suppress false to enable."}],"class":"function","name":"suppressEngineLighting","description":" Suppresses or enables any engine lighting for any upcoming render operation."},"end3DBeam":{"path":"libs_cl/render.lua#L2097","realm":"client","class":"function","name":"end3DBeam","description":" Ends the beam mesh of a beam started with render.start3DBeam."},"setStencilTestMask":{"path":"libs_cl/render.lua#L683","realm":"client","params":[{"type":"number","value":"number mask The mask bitflag.","name":"mask","description":"The mask bitflag."}],"class":"function","name":"setStencilTestMask","description":" Sets the unsigned 8-bit test bitflag mask to be used for any stencil testing."},"clearStencilBufferRectangle":{"path":"libs_cl/render.lua#L631","realm":"client","params":[{"type":"number","value":"number originX X origin of the rectangle.","name":"originX","description":"X origin of the rectangle."},{"type":"number","value":"number originY Y origin of the rectangle.","name":"originY","description":"Y origin of the rectangle."},{"type":"number","value":"number endX The end X coordinate of the rectangle.","name":"endX","description":"The end X coordinate of the rectangle."},{"type":"number","value":"number endY The end Y coordinate of the rectangle.","name":"endY","description":"The end Y coordinate of the rectangle."},{"type":"number","value":"number stencilValue Value to set cleared stencil buffer to.","name":"stencilValue","description":"Value to set cleared stencil buffer to."}],"class":"function","name":"clearStencilBufferRectangle","description":" Sets the stencil value in a specified rect."},"drawSimpleTextOutlined":{"path":"libs_cl/render.lua#L1870","returns":[{"type":"number","value":"number Width of the drawn text. Same as calling render.getTextSize","description":"Width of the drawn text. Same as calling render.getTextSize"},{"type":"number","value":"number Height of the drawn text. Same as calling render.getTextSize","description":"Height of the drawn text. Same as calling render.getTextSize"}],"realm":"client","params":[{"type":"number","value":"number x X coordinate","name":"x","description":"X coordinate"},{"type":"number","value":"number y Y coordinate","name":"y","description":"Y coordinate"},{"type":"string","value":"string text Text to draw","name":"text","description":"Text to draw"},{"type":"number","value":"number outlinewidth Width of the outline.","name":"outlinewidth","description":"Width of the outline."},{"type":"Color","value":"Color outlinecolor The color of the text.","name":"outlinecolor","description":"The color of the text."},{"type":"number?","value":"number? xalign Horizontal text alignment. Default TEXT_ALIGN.LEFT","name":"xalign","description":"Horizontal text alignment. Default TEXT_ALIGN.LEFT"},{"type":"number?","value":"number? yalign Vertical text alignment. Default TEXT_ALIGN.TOP","name":"yalign","description":"Vertical text alignment. Default TEXT_ALIGN.TOP"}],"class":"function","name":"drawSimpleTextOutlined","description":" Draws outlined text more easily but no new lines or tabs."},"setFilterMag":{"path":"libs_cl/render.lua#L1254","realm":"client","params":[{"type":"number","value":"number val The filter function to use http://wiki.facepunch.com/gmod/Enums/TEXFILTER","name":"val","description":"The filter function to use http://wiki.facepunch.com/gmod/Enums/TEXFILTER"}],"class":"function","name":"setFilterMag","description":" Sets the texture filtering function when viewing a close texture"},"selectRenderTarget":{"path":"libs_cl/render.lua#L1166","realm":"client","params":[{"type":"string?","value":"string? name Name of the render target to use","name":"name","description":"Name of the render target to use"}],"class":"function","name":"selectRenderTarget","description":" Selects the render target to draw on.\n Nil for the visible RT."},"drawTexturedRectUV":{"path":"libs_cl/render.lua#L1554","realm":"client","params":[{"type":"number","value":"number x Top left corner x","name":"x","description":"Top left corner x"},{"type":"number","value":"number y Top left corner y","name":"y","description":"Top left corner y"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"},{"type":"number","value":"number startU Texture mapping at rectangle origin","name":"startU","description":"Texture mapping at rectangle origin"},{"type":"number","value":"number startV Texture mapping at rectangle origin","name":"startV","description":"Texture mapping at rectangle origin"},{"type":"number","value":"number endU Texture mapping at rectangle end","name":"endU","description":"Texture mapping at rectangle end"},{"type":"number","value":"number endV Texture mapping at rectangle end","name":"endV","description":"Texture mapping at rectangle end"}],"class":"function","name":"drawTexturedRectUV","description":" Draws a textured rectangle with UV coordinates"},"setMaterialEffectDownsample":{"path":"libs_cl/render.lua#L1043","realm":"client","params":[{"type":"Material","value":"Material mat The material object to use the texture of, or the name of a rendertarget to use instead.","name":"mat","description":"The material object to use the texture of, or the name of a rendertarget to use instead."},{"type":"number","value":"number darken The amount to darken the texture by. -1 to 1 inclusive.","name":"darken","description":"The amount to darken the texture by. -1 to 1 inclusive."},{"type":"number","value":"number multiply The amount to multiply the pixel colors by. (0-1024)","name":"multiply","description":"The amount to multiply the pixel colors by. (0-1024)"}],"class":"function","name":"setMaterialEffectDownsample","description":" Sets the current render material to the given material or the rendertarget, darkening the texture, and scaling up color values."},"drawFilledCircle":{"path":"libs_cl/render.lua#L1423","realm":"client","params":[{"type":"number","value":"number x Center x coordinate","name":"x","description":"Center x coordinate"},{"type":"number","value":"number y Center y coordinate","name":"y","description":"Center y coordinate"},{"type":"number","value":"number radius Radius","name":"radius","description":"Radius"}],"class":"function","name":"drawFilledCircle","description":" Draws a filled circle"},"drawPixelsSubrectRGBA":{"path":"libs_cl/render.lua#L1695","realm":"client","params":[{"type":"number","value":"number dstX Destination x coordinate","name":"dstX","description":"Destination x coordinate"},{"type":"number","value":"number dstY Destination y coordinate","name":"dstY","description":"Destination y coordinate"},{"type":"number","value":"number srcX Source x coordinate","name":"srcX","description":"Source x coordinate"},{"type":"number","value":"number srcY Source y coordinate","name":"srcY","description":"Source y coordinate"},{"type":"number","value":"number srcW Source original width","name":"srcW","description":"Source original width"},{"type":"number","value":"number srcH Source original height","name":"srcH","description":"Source original height"},{"type":"number","value":"number subrectW Width of subrect","name":"subrectW","description":"Width of subrect"},{"type":"number","value":"number subrectH Height of subrect","name":"subrectH","description":"Height of subrect"},{"type":"table","value":"table dataR Red channel data.","name":"dataR","description":"Red channel data."},{"type":"table","value":"table dataG Green channel data.","name":"dataG","description":"Green channel data."},{"type":"table","value":"table dataB Blue channel data.","name":"dataB","description":"Blue channel data."},{"type":"table","value":"table dataA Alpha channel data.","name":"dataA","description":"Alpha channel data."}],"class":"function","name":"drawPixelsSubrectRGBA","description":" Draws region of RGBA color channel tables to current render target."},"setCullMode":{"path":"libs_cl/render.lua#L1276","realm":"client","params":[{"type":"number","value":"number mode Cull mode. 0 for counter clock wise, 1 for clock wise","name":"mode","description":"Cull mode. 0 for counter clock wise, 1 for clock wise"}],"class":"function","name":"setCullMode","description":" Changes the cull mode"},"createFont":{"path":"libs_cl/render.lua#L1730","returns":[{"type":"string","value":"string The font name that can be used with the rest of the font functions.","description":"The font name that can be used with the rest of the font functions."}],"realm":"client","params":[{"type":"string","value":"string font Base font to use","name":"font","description":"Base font to use"},{"type":"number?","value":"number? size Font size. Default 16","name":"size","description":"Font size. Default 16"},{"type":"number?","value":"number? weight Font weight. Default 400","name":"weight","description":"Font weight. Default 400"},{"type":"boolean?","value":"boolean? antialias Antialias font? Default false","name":"antialias","description":"Antialias font? Default false"},{"type":"boolean?","value":"boolean? additive If true, adds brightness to pixels behind it rather than drawing over them. Default false","name":"additive","description":"If true, adds brightness to pixels behind it rather than drawing over them. Default false"},{"type":"boolean?","value":"boolean? shadow Enable drop shadow? Default false","name":"shadow","description":"Enable drop shadow? Default false"},{"type":"boolean?","value":"boolean? outline Enable outline? Default false","name":"outline","description":"Enable outline? Default false"},{"type":"boolean?","value":"boolean? blursize The size of the blur Default 0","name":"blursize","description":"The size of the blur Default 0"},{"type":"boolean?","value":"boolean? extended Allows the font to display glyphs outside of Latin-1 range. Unicode code points above 0xFFFF are not supported. Required to use FontAwesome","name":"extended","description":"Allows the font to display glyphs outside of Latin-1 range. Unicode code points above 0xFFFF are not supported. Required to use FontAwesome"},{"type":"number?","value":"number? scanlines Scanline interval. Must be greater than 1 to work. Shares uniqueness with blursize so you cannot create more than one scanline type of font with the same blursize. Default 0","name":"scanlines","description":"Scanline interval. Must be greater than 1 to work. Shares uniqueness with blursize so you cannot create more than one scanline type of font with the same blursize. Default 0"}],"class":"function","name":"createFont","description":" Creates a font. Does not require rendering hook\n Base font can be one of (keep in mind that these may not exist on all clients if they are not shipped with starfall):\n \\- Akbar\n \\- Coolvetica\n \\- Roboto\n \\- Roboto Mono\n \\- FontAwesome\n \\- Courier New\n \\- Verdana\n \\- Arial\n \\- HalfLife2\n \\- hl2mp\n \\- csd\n \\- Tahoma\n \\- Trebuchet\n \\- Trebuchet MS\n \\- DejaVu Sans Mono\n \\- Lucida Console\n \\- Times New Roman"},"drawRectRotated":{"path":"libs_cl/render.lua#L1388","realm":"client","params":[{"type":"number","value":"number x X coordinate of center of rect","name":"x","description":"X coordinate of center of rect"},{"type":"number","value":"number y Y coordinate of center of rect","name":"y","description":"Y coordinate of center of rect"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"},{"type":"number","value":"number rot Rotation in degrees","name":"rot","description":"Rotation in degrees"}],"class":"function","name":"drawRectRotated","description":" Draws a rotated, rectangle using the current color"},"clearDepth":{"path":"libs_cl/render.lua#L1972","realm":"client","class":"function","name":"clearDepth","description":" Resets the depth buffer"},"setColorModulation":{"path":"libs_cl/render.lua#L877","realm":"client","params":[{"type":"number","value":"number r Red channel","name":"r","description":"Red channel"},{"type":"number","value":"number g Green channel","name":"g","description":"Green channel"},{"type":"number","value":"number b Blue channel","name":"b","description":"Blue channel"}],"class":"function","name":"setColorModulation","description":" Sets the draw color modulation."},"popMatrix":{"path":"libs_cl/render.lua#L748","realm":"client","class":"function","name":"popMatrix","description":" Pops a matrix from the model matrix stack."},"computeDynamicLighting":{"path":"libs_cl/render.lua#L2592","returns":[{"type":"Vector","value":"Vector Vector representing color of the light","description":"Vector representing color of the light"}],"realm":"client","params":[{"type":"Vector","value":"Vector pos Vector position to sample from","name":"pos","description":"Vector position to sample from"},{"type":"Vector","value":"Vector normal Normal vector of the surface","name":"normal","description":"Normal vector of the surface"}],"class":"function","name":"computeDynamicLighting","description":" Calculates the lighting caused by dynamic lights for the specified surface"},"draw3DQuad":{"path":"libs_cl/render.lua#L2103","realm":"client","params":[{"type":"Vector","value":"Vector vert1 First vertex.","name":"vert1","description":"First vertex."},{"type":"Vector","value":"Vector vert2 The second vertex.","name":"vert2","description":"The second vertex."},{"type":"Vector","value":"Vector vert3 The third vertex.","name":"vert3","description":"The third vertex."},{"type":"Vector","value":"Vector vert4 The fourth vertex.","name":"vert4","description":"The fourth vertex."}],"class":"function","name":"draw3DQuad","description":" Draws 2 connected triangles."},"getColorModulation":{"path":"libs_cl/render.lua#L868","returns":[{"type":"number","value":"number Red channel","description":"Red channel"},{"type":"number","value":"number Green channel","description":"Green channel"},{"type":"number","value":"number Blue channel","description":"Blue channel"}],"realm":"client","class":"function","name":"getColorModulation","description":" Gets the draw color modulation."},"enableDepth":{"path":"libs_cl/render.lua#L1932","realm":"client","params":[{"type":"boolean","value":"boolean enable True to enable","name":"enable","description":"True to enable"}],"class":"function","name":"enableDepth","description":" Enables or disables Depth Buffer"},"draw3DTriangle":{"path":"libs_cl/render.lua#L2184","realm":"client","params":[{"type":"Vector","value":"Vector vert1 Position of the first vertex.","name":"vert1","description":"Position of the first vertex."},{"type":"Vector","value":"Vector vert2 Position of the the second vertex.","name":"vert2","description":"Position of the the second vertex."},{"type":"Vector","value":"Vector vert3 Position of the the third vertex.","name":"vert3","description":"Position of the the third vertex."}],"class":"function","name":"draw3DTriangle","description":" Draws a triangle in 3D space"},"drawTexturedRectUVFast":{"path":"libs_cl/render.lua#L1516","realm":"client","params":[{"type":"number","value":"number x Top left corner x","name":"x","description":"Top left corner x"},{"type":"number","value":"number y Top left corner y","name":"y","description":"Top left corner y"},{"type":"number","value":"number w Width","name":"w","description":"Width"},{"type":"number","value":"number h Height","name":"h","description":"Height"},{"type":"number","value":"number startU Texture mapping at rectangle's origin U","name":"startU","description":"Texture mapping at rectangle's origin U"},{"type":"number","value":"number startV Texture mapping at rectangle's origin V","name":"startV","description":"Texture mapping at rectangle's origin V"},{"type":"number","value":"number endU Texture mapping at rectangle's end U","name":"endU","description":"Texture mapping at rectangle's end U"},{"type":"number","value":"number endV Texture mapping at rectangle's end V","name":"endV","description":"Texture mapping at rectangle's end V"},{"type":"boolean?","value":"boolean? UVHack If enabled, will scale the UVs to compensate for internal bug. Should be true for user created materials.","name":"UVHack","description":"If enabled, will scale the UVs to compensate for internal bug. Should be true for user created materials."}],"class":"function","name":"drawTexturedRectUVFast","description":" Draws a textured rectangle with UV coordinates\n Faster, but uses integer coordinates and will get clipped by user's screen resolution"},"createMaterial":{"path":"libs_cl/render.lua#L932","returns":[{"type":"Material","value":"Material The material. Use with render.setMaterial to draw with it.","description":"The material. Use with render.setMaterial to draw with it."}],"realm":"client","params":[{"type":"string","value":"string tx Texture file path, a http url, or image data: https://en.wikipedia.org/wiki/Data_URI_scheme","name":"tx","description":"Texture file path, a http url, or image data: https://en.wikipedia.org/wiki/Data_URI_scheme"},{"type":"function?","value":"function? cb An optional callback called when loading is done. Passes nil if it fails or Passes the material, url, width, height, and layout function which can be called with x, y, w, h to reposition the image in the texture.","name":"cb","description":"An optional callback called when loading is done. Passes nil if it fails or Passes the material, url, width, height, and layout function which can be called with x, y, w, h to reposition the image in the texture."},{"type":"function?","value":"function? done An optional callback called when the image is done loading. Passes the material, url","name":"done","description":"An optional callback called when the image is done loading. Passes the material, url"}],"class":"function","name":"createMaterial","description":" Looks up a texture by file name and creates an UnlitGeneric material with it.\n Also supports image URLs or image data (These will create a rendertarget for the $basetexture): https://en.wikipedia.org/wiki/Data_URI_scheme\n Make sure to store the material to use it rather than calling this slow function repeatedly.\n NOTE: This no longer supports material names. Use texture names instead (Textures are .vtf, material are .vmt)"},"readPixelRGBA":{"path":"libs_cl/render.lua#L2343","returns":[{"type":"number","value":"number The red channel value.","description":"The red channel value."},{"type":"number","value":"number The green channel value.","description":"The green channel value."},{"type":"number","value":"number The blue channel value.","description":"The blue channel value."},{"type":"number","value":"number The alpha channel value.","description":"The alpha channel value."}],"realm":"client","params":[{"type":"number","value":"number x Pixel x-coordinate.","name":"x","description":"Pixel x-coordinate."},{"type":"number","value":"number y Pixel y-coordinate.","name":"y","description":"Pixel y-coordinate."}],"class":"function","name":"readPixelRGBA","description":" Reads the color of the specified pixel."},"setMaterial":{"path":"libs_cl/render.lua#L964","realm":"client","params":[{"type":"Material","value":"Material mat The material object","name":"mat","description":"The material object"}],"class":"function","name":"setMaterial","description":" Sets the current render material"},"setViewPort":{"path":"libs_cl/render.lua#L2323","realm":"client","params":[{"type":"number","value":"number x Pixel x-coordinate.","name":"x","description":"Pixel x-coordinate."},{"type":"number","value":"number y Pixel y-coordinate.","name":"y","description":"Pixel y-coordinate."},{"type":"number","value":"number w Width of the viewport.","name":"w","description":"Width of the viewport."},{"type":"number","value":"number h Height of the viewport.","name":"h","description":"Height of the viewport."}],"class":"function","name":"setViewPort","description":" Changes the view port position and size."},"isHUDActive":{"path":"libs_cl/render.lua#L2387","returns":[{"type":"boolean","value":"boolean True if a HUD component is connected and active, nil otherwise","description":"True if a HUD component is connected and active, nil otherwise"}],"realm":"client","class":"function","name":"isHUDActive","description":" Checks if the client is connected to a HUD component that's linked to this chip"},"setStencilWriteMask":{"path":"libs_cl/render.lua#L691","realm":"client","params":[{"type":"number","value":"number mask The mask bitflag.","name":"mask","description":"The mask bitflag."}],"class":"function","name":"setStencilWriteMask","description":" Sets the unsigned 8-bit write bitflag mask to be used for any writes to the stencil buffer."}},"tables":{"Screen":{"path":"libs_cl/render.lua#L2752","fields":[{"name":"Name","description":"Pretty name of model"},{"name":"offset","description":"Offset of screen from prop"},{"name":"RS","description":"Resolution/scale"},{"name":"RatioX","description":"Inverted Aspect ratio (height divided by width)"},{"name":"x1","description":"Corner of screen in local coordinates (relative to offset?)"},{"name":"x2","description":"Corner of screen in local coordinates (relative to offset?)"},{"name":"y1","description":"Corner of screen in local coordinates (relative to offset?)"},{"name":"y2","description":"Corner of screen in local coordinates (relative to offset?)"},{"name":"z","description":"Screen plane offset in local coordinates (relative to offset?)"},{"name":"rot","description":"Screen rotation"}],"realm":"client","class":"table","name":"Screen","description":""},"Vertex":{"path":"libs_cl/render.lua#L2766","fields":[{"name":"x","description":"X coordinate"},{"name":"y","description":"Y coordinate"},{"name":"u","description":"U coordinate (optional, default is 0)"},{"name":"v","description":"V coordinate (optional, default is 0)"}],"realm":"client","class":"table","name":"Vertex","description":" Vertex format"}},"path":"libs_cl/render.lua#L413","libtbl":["render_library"],"realm":"client","fields":[],"class":"library","name":"render","description":" Render library. Screens are 512x512 units. Most functions require\n that you be in the rendering hook to call, otherwise an error is\n thrown. +x is right, +y is down"},"wire":{"methods":{"self":{"path":"libs_sv/wire.lua#L496","returns":[{"type":"Wirelink","value":"Wirelink Wirelink representing this entity","description":"Wirelink representing this entity"}],"realm":"server","class":"function","name":"self","description":" Returns the wirelink representing this entity."},"getWirelink":{"path":"libs_sv/wire.lua#L615","returns":[{"type":"Wirelink","value":"Wirelink Wirelink of the entity","description":"Wirelink of the entity"}],"realm":"server","params":[{"type":"Entity","value":"Entity ent Wire entity","name":"ent","description":"Wire entity"}],"class":"function","name":"getWirelink","description":" Returns a wirelink to a wire entity"},"adjustInputs":{"path":"libs_sv/wire.lua#L345","realm":"server","params":[{"type":"table","value":"table names An array of input names. May be modified by the function.","name":"names","description":"An array of input names. May be modified by the function."},{"type":"table","value":"table types An array of input types. Can be shortcuts. May be modified by the function.","name":"types","description":"An array of input types. Can be shortcuts. May be modified by the function."},{"type":"table?","value":"table? descriptions An optional array of input descriptions. ","name":"descriptions","description":"An optional array of input descriptions. "}],"class":"function","name":"adjustInputs","description":" Creates/Modifies wire inputs. All wire ports must begin with an uppercase\n letter and contain only alphabetical characters or numbers but may not begin with a number."},"create":{"path":"libs_sv/wire.lua#L511","realm":"server","params":[{"type":"Entity","value":"Entity entI Entity with input","name":"entI","description":"Entity with input"},{"type":"Entity","value":"Entity entO Entity with output","name":"entO","description":"Entity with output"},{"type":"string","value":"string inputname Input to be wired","name":"inputname","description":"Input to be wired"},{"type":"string","value":"string outputname Output to be wired","name":"outputname","description":"Output to be wired"},{"type":"number?","value":"number? width Width of the wire(optional)","name":"width","description":"Width of the wire(optional)"},{"type":"Color?","value":"Color? color Color of the wire(optional)","name":"color","description":"Color of the wire(optional)"},{"type":"string?","value":"string? materialName Material of the wire(optional), Valid materials are cable/rope, cable/cable2, cable/xbeam, cable/redlaser, cable/blue_elec, cable/physbeam, cable/hydra, arrowire/arrowire, arrowire/arrowire2","name":"materialName","description":"Material of the wire(optional), Valid materials are cable/rope, cable/cable2, cable/xbeam, cable/redlaser, cable/blue_elec, cable/physbeam, cable/hydra, arrowire/arrowire, arrowire/arrowire2"}],"class":"function","name":"create","description":" Wires two entities together"},"serverUUID":{"path":"libs_sv/wire.lua#L504","returns":[{"type":"string","value":"string Server UUID","description":"Server UUID"}],"realm":"server","class":"function","name":"serverUUID","description":" Returns the server's UUID."},"delete":{"path":"libs_sv/wire.lua#L563","realm":"server","params":[{"type":"Entity","value":"Entity entI Entity with input","name":"entI","description":"Entity with input"},{"type":"string","value":"string inputname Input to be un-wired","name":"inputname","description":"Input to be un-wired"}],"class":"function","name":"delete","description":" Unwires an entity's input"},"getOutputs":{"path":"libs_sv/wire.lua#L607","returns":[{"type":"table","value":"table Table of entity's output names","description":"Table of entity's output names"},{"type":"table","value":"table Table of entity's output types","description":"Table of entity's output types"}],"realm":"server","params":[{"type":"Entity","value":"Entity entO Entity with output(s)","name":"entO","description":"Entity with output(s)"}],"class":"function","name":"getOutputs","description":" Returns a table of entity's outputs"},"adjustPorts":{"path":"libs_sv/wire.lua#L440","realm":"server","params":[{"type":"table?","value":"table? inputs (Optional) A key-value table with input port names as keys and types as values. e.g. {MyInput=\"number\"} or {MyInput={type=\"number\"}}. If nil, input ports won't be changed. If you use the latter syntax for defining ports, you can also specify description alongside the type, ex. {MyInput={type=\"number\", description=\"Description for this input.\"}}","name":"inputs","description":"(Optional) A key-value table with input port names as keys and types as values. e.g. {MyInput=\"number\"} or {MyInput={type=\"number\"}}. If nil, input ports won't be changed. If you use the latter syntax for defining ports, you can also specify description alongside the type, ex. {MyInput={type=\"number\", description=\"Description for this input.\"}}"},{"type":"table?","value":"table? outputs (Optional) A key-value table with output port names as keys and types as values. The above behavior for inputs also applies for outputs.","name":"outputs","description":"(Optional) A key-value table with output port names as keys and types as values. The above behavior for inputs also applies for outputs."}],"class":"function","name":"adjustPorts","description":" Creates/Modifies wire inputs/outputs. All wire ports must begin with an uppercase\n letter and contain only alphabetical characters or numbers but may not begin with a number."},"getInputs":{"path":"libs_sv/wire.lua#L599","returns":[{"type":"table","value":"table Table of entity's input names","description":"Table of entity's input names"},{"type":"table","value":"table Table of entity's input types","description":"Table of entity's input types"}],"realm":"server","params":[{"type":"Entity","value":"Entity entI Entity with input(s)","name":"entI","description":"Entity with input(s)"}],"class":"function","name":"getInputs","description":" Returns a table of entity's inputs"},"adjustOutputs":{"path":"libs_sv/wire.lua#L388","realm":"server","params":[{"type":"table","value":"table names An array of output names. May be modified by the function.","name":"names","description":"An array of output names. May be modified by the function."},{"type":"table","value":"table types An array of output types. Can be shortcuts. May be modified by the function.","name":"types","description":"An array of output types. Can be shortcuts. May be modified by the function."},{"type":"table?","value":"table? descriptions An optional array of output descriptions. ","name":"descriptions","description":"An optional array of output descriptions. "}],"class":"function","name":"adjustOutputs","description":" Creates/Modifies wire outputs. All wire ports must begin with an uppercase\n letter and contain only alphabetical characters or numbers but may not begin with a number."}},"tables":{"ports":{"path":"libs_sv/wire.lua#L787","realm":"server","class":"table","name":"ports","description":" Ports table. Reads from this table will read from the wire input\n of the same name. Writes will write to the wire output of the same name."}},"path":"libs_sv/wire.lua#L17","libtbl":["wire_library"],"realm":"server","fields":[],"class":"library","name":"wire","description":" Wire library. Handles wire inputs/outputs, wirelinks, etc."},"socket":{"methods":{"connect4":{"path":"libs_cl/socket.lua#L241","returns":[{"type":"table","value":"table client TCPClient object. Nil if error","description":"client TCPClient object. Nil if error"},{"type":"string?","value":"string? error Error string if the previous return was nil, else nil","description":"error Error string if the previous return was nil, else nil"}],"realm":"client","params":[{"type":"number","value":"number addr Address to connect to","name":"addr","description":"Address to connect to"},{"type":"number","value":"number port Port to connect to","name":"port","description":"Port to connect to"},{"type":"number?","value":"number? laddr Local address to bind to","name":"laddr","description":"Local address to bind to"},{"type":"number?","value":"number? lport Local port to bind to","name":"lport","description":"Local port to bind to"}],"class":"function","name":"connect4","description":" This function is a shortcut that creates and returns a TCP client object connected to a remote address at a given port.\n Optionally, the user can also specify the local address and port to bind (locaddr and locport)"},"tcp6":{"path":"libs_cl/socket.lua#L189","returns":[{"type":"table","value":"table New IPv6 TCP Master Object, or nil if error","description":"New IPv6 TCP Master Object, or nil if error"},{"type":"string?","value":"string? The error message, or nil if no error","description":"The error message, or nil if no error"}],"realm":"client","class":"function","name":"tcp6","description":" Creates and returns an IPv6 TCP master object.\n A master object can be transformed into a server object with the method listen (after a call to bind) or into a client object with the method connect.\n The only other method supported by a master object is the close method.\n Note: The TCP object returned will have the option \"ipv6-v6only\" set to true."},"udp4":{"path":"libs_cl/socket.lua#L208","returns":[{"type":"table","value":"table New IPv4 UDP master object, or nil in case of error.","description":"New IPv4 UDP master object, or nil in case of error."},{"type":"string?","value":"string? The error string if errored, else nil","description":"The error string if errored, else nil"}],"realm":"client","class":"function","name":"udp4","description":" Creates and returns an unconnected IPv4 UDP object.\n Unconnected objects support the sendto, receive, receivefrom, getoption, getsockname, setoption, settimeout, setpeername, setsockname, and close methods.\n The setpeername method is used to connect the object."},"connect":{"path":"libs_cl/socket.lua#L227","returns":[{"type":"table","value":"table client TCPClient object. Nil if error","description":"client TCPClient object. Nil if error"},{"type":"string?","value":"string? error Error string if the previous return was nil, else nil","description":"error Error string if the previous return was nil, else nil"}],"realm":"client","params":[{"type":"number","value":"number addr Address to connect to","name":"addr","description":"Address to connect to"},{"type":"number","value":"number port Port to connect to","name":"port","description":"Port to connect to"},{"type":"number?","value":"number? laddr Local address to bind to","name":"laddr","description":"Local address to bind to"},{"type":"number?","value":"number? lport Local port to bind to","name":"lport","description":"Local port to bind to"},{"type":"string?","value":"string? family Socket family, either \"inet\" or \"inet6\".","name":"family","description":"Socket family, either \"inet\" or \"inet6\"."}],"class":"function","name":"connect","description":" This function is a shortcut that creates and returns a TCP client object connected to a remote address at a given port.\n Optionally, the user can also specify the local address and port to bind (locaddr and locport), or restrict the socket family to \"inet\" or \"inet6\".\n Without specifying family to connect, whether a tcp or tcp6 connection is created depends on your system configuration."},"udp":{"path":"libs_cl/socket.lua#L199","returns":[{"type":"table","value":"table New IPv4 TCP master object, or nil in case of error.","description":"New IPv4 TCP master object, or nil in case of error."},{"type":"string?","value":"string? The error string if errored, else nil","description":"The error string if errored, else nil"}],"realm":"client","class":"function","name":"udp","description":" Creates and returns an unconnected IPv4 UDP object.\n Unconnected objects support the sendto, receive, receivefrom, getoption, getsockname, setoption, settimeout, setpeername, setsockname, and close methods.\n The setpeername method is used to connect the object."},"tcp4":{"path":"libs_cl/socket.lua#L180","returns":[{"type":"table","value":"table New IPv4 TCP Master Object, or nil if error","description":"New IPv4 TCP Master Object, or nil if error"},{"type":"string?","value":"string? The error message, or nil if no error","description":"The error message, or nil if no error"}],"realm":"client","class":"function","name":"tcp4","description":" Creates and returns an IPv4 TCP master object.\n A master object can be transformed into a server object with the method listen (after a call to bind) or into a client object with the method connect.\n The only other method supported by a master object is the close method."},"tcp":{"path":"libs_cl/socket.lua#L171","returns":[{"type":"table","value":"table New IPv4 TCP Master Object, or nil if error","description":"New IPv4 TCP Master Object, or nil if error"},{"type":"string?","value":"string? The error message, or nil if no error","description":"The error message, or nil if no error"}],"realm":"client","class":"function","name":"tcp","description":" Creates and returns an IPv4 TCP master object.\n A master object can be transformed into a server object with the method listen (after a call to bind) or into a client object with the method connect.\n The only other method supported by a master object is the close method."},"udp6":{"path":"libs_cl/socket.lua#L217","returns":[{"type":"table","value":"table New IPv6 UDP master object, or nil in case of error.","description":"New IPv6 UDP master object, or nil in case of error."},{"type":"string?","value":"string? The error string if errored, else nil","description":"The error string if errored, else nil"}],"realm":"client","class":"function","name":"udp6","description":" Creates and returns an unconnected IPv4 UDP object.\n Unconnected objects support the sendto, receive, receivefrom, getoption, getsockname, setoption, settimeout, setpeername, setsockname, and close methods.\n The setpeername method is used to connect the object.\n Note: The UDP object returned will have the option \"ipv6-v6only\" set to true."},"connect6":{"path":"libs_cl/socket.lua#L253","returns":[{"type":"table","value":"table client TCPClient object. Nil if error","description":"client TCPClient object. Nil if error"},{"type":"string?","value":"string? error Error string if the previous return was nil, else nil","description":"error Error string if the previous return was nil, else nil"}],"realm":"client","params":[{"type":"number","value":"number addr Address to connect to","name":"addr","description":"Address to connect to"},{"type":"number","value":"number port Port to connect to","name":"port","description":"Port to connect to"},{"type":"number?","value":"number? laddr Local address to bind to","name":"laddr","description":"Local address to bind to"},{"type":"number?","value":"number? lport Local port to bind to","name":"lport","description":"Local port to bind to"}],"class":"function","name":"connect6","description":" This function is a shortcut that creates and returns a TCP client object connected to a remote address at a given port.\n Optionally, the user can also specify the local address and port to bind (locaddr and locport)"}},"tables":[],"path":"libs_cl/socket.lua#L134","libtbl":["socket_library"],"realm":"client","fields":[],"class":"library","name":"socket","description":" Socket library. Only usable by owner of starfall.\n See the WebSocket type for a version of this that doesn't require a DLL, and supports secure websockets (wss)\n Beware \"Blocking\" functions; they will freeze the game. See http://w3.impa.br/~diego/software/luasocket/socket.html\n Install the gmcl_socket.core_*.dll binary file to lua/bin and create a 'gm_socket_whitelist.txt' file in steamapps/common\n Each line in the whitelist will allow luasocket to access the specified domain and port. They are formatted as 'domain:port' e.g. 'garrysmod.com:80', '*.com:80' '95.123.12.22:27015'"}},"Hooks":{"OnPhysgunPickup":{"path":"libs_sh/hook.lua#L73","realm":"server","params":[{"type":"Player","value":"Player ply The player that has picked up something using the physics gun.","name":"ply","description":"The player that has picked up something using the physics gun."},{"type":"Entity","value":"Entity ent The entity that was picked up","name":"ent","description":"The entity that was picked up"}],"class":"hook","name":"OnPhysgunPickup","description":" Called when a player has successfully picked up an entity with their Physics Gun.\n Not to be confused with PhysgunPickup which is a predicted hook"},"setupskyboxfog":{"path":"libs_cl/render.lua#L331","realm":"client","params":[{"type":"number","value":"number scale Skybox scale","name":"scale","description":"Skybox scale"}],"class":"hook","name":"setupskyboxfog","description":" Called when skybox fog is drawn."},"PlayerEnteredVehicle":{"path":"libs_sh/hook.lua#L141","realm":"server","params":[{"type":"Player","value":"Player ply Player who entered a vehicle","name":"ply","description":"Player who entered a vehicle"},{"type":"Vehicle","value":"Vehicle vehicle Vehicle that was entered","name":"vehicle","description":"Vehicle that was entered"},{"type":"number","value":"number num Role. The seat number","name":"num","description":"Role. The seat number"}],"class":"hook","name":"PlayerEnteredVehicle","description":" Called when a players enters a vehicle"},"OnPlayerPhysicsPickup":{"path":"libs_sh/hook.lua#L37","realm":"server","params":[{"type":"Player","value":"Player ply Player picking up an object","name":"ply","description":"Player picking up an object"},{"type":"Entity","value":"Entity ent Entity being picked up","name":"ent","description":"Entity being picked up"}],"class":"hook","name":"OnPlayerPhysicsPickup","description":" Called when an entity is being picked up by +use"},"postdrawhud":{"path":"libs_cl/render.lua#L298","realm":"client","class":"hook","name":"postdrawhud","description":" Called after drawing HUD (2D Context)"},"writecell":{"path":"libs_sv/wire.lua#L837","realm":"server","params":[{"type":"any","value":"any address The address written to","name":"address","description":"The address written to"},{"type":"table","value":"table data The data being written","name":"data","description":"The data being written"}],"class":"hook","name":"writecell","description":" Called when a high speed device writes to a wired SF chip"},"remote":{"path":"libs_sh/hook.lua#L685","realm":"shared","params":[{"type":"Entity","value":"Entity sender The entity that caused the hook to run","name":"sender","description":"The entity that caused the hook to run"},{"type":"Player","value":"Player owner The owner of the sender","name":"owner","description":"The owner of the sender"},{"type":"...","value":"... payload The payload that was supplied when calling the hook","name":"payload","description":"The payload that was supplied when calling the hook"}],"class":"hook","name":"remote","description":" Remote hook.\n This hook can be called from other instances"},"EntityRemoved":{"path":"libs_sh/hook.lua#L486","realm":"shared","params":[{"type":"Entity","value":"Entity ent Entity being removed","name":"ent","description":"Entity being removed"},{"type":"boolean","value":"boolean fullupdate If clientside, will be true if the entity was removed by a fullupdate","name":"fullupdate","description":"If clientside, will be true if the entity was removed by a fullupdate"}],"class":"hook","name":"EntityRemoved","description":" Called when an entity is removed"},"addLaw":{"path":"libs_sh/darkrp2.lua#L489","realm":"shared","params":[{"type":"number","value":"number index Index of the law","name":"index","description":"Index of the law"},{"type":"string","value":"string law Law string","name":"law","description":"Law string"},{"type":"Player?","value":"Player? player The player who added the law.","name":"player","description":"The player who added the law."}],"class":"hook","name":"addLaw","description":" Called when a law is added. DarkRP only."},"hudshoulddraw":{"path":"libs_cl/render.lua#L241","returns":[{"type":"boolean","value":"boolean Return false to not draw the element","description":"Return false to not draw the element"}],"realm":"client","params":[{"type":"string","value":"string str The name of the hud element trying to be drawn","name":"str","description":"The name of the hud element trying to be drawn"}],"class":"hook","name":"hudshoulddraw","description":" Called when a hud element is attempting to be drawn"},"onLockpickCompleted":{"path":"libs_sh/darkrp2.lua#L544","realm":"server","params":[{"type":"Player","value":"Player ply The player attempting to lockpick the entity.","name":"ply","description":"The player attempting to lockpick the entity."},{"type":"boolean","value":"boolean success Whether the player succeeded in lockpicking the entity.","name":"success","description":"Whether the player succeeded in lockpicking the entity."},{"type":"Entity","value":"Entity ent The entity that was lockpicked.","name":"ent","description":"The entity that was lockpicked."}],"class":"hook","name":"onLockpickCompleted","description":" Called when a player has finished picking a lock, successfully or otherwise. DarkRP only.\n Will only be called if the lockpicker is the owner of the chip, or if the chip is running in superuser mode."},"renderoffscreen":{"path":"libs_cl/render.lua#L195","realm":"client","class":"hook","name":"renderoffscreen","description":" Called when a frame is requested to be drawn. Doesn't require a screen or HUD but only works on rendertargets. (2D Context)"},"PlayerStartVoice":{"path":"libs_sh/hook.lua#L321","returns":[{"type":"boolean?","value":"boolean? Return true to hide CHudVoiceStatus (Voice Chat HUD Element).","description":"Return true to hide CHudVoiceStatus (Voice Chat HUD Element)."}],"realm":"client","params":[{"type":"Player","value":"Player ply Player who started using voice chat","name":"ply","description":"Player who started using voice chat"}],"class":"hook","name":"PlayerStartVoice","description":" Called when a player starts using voice chat."},"VRPreRenderRight":{"path":"libs_sh/vr.lua#L51","realm":"client","class":"hook","name":"VRPreRenderRight","description":" Called before rendering the right eye. This along with the previous hook can be used to render different things in different eyes. HUD is required."},"KeyRelease":{"path":"libs_sh/hook.lua#L411","realm":"shared","params":[{"type":"Player","value":"Player ply Player releasing the key","name":"ply","description":"Player releasing the key"},{"type":"number","value":"number key The key being released","name":"key","description":"The key being released"}],"class":"hook","name":"KeyRelease","description":" Called when a player releases a key"},"PhysgunPickup":{"path":"libs_sh/hook.lua#L427","realm":"shared","params":[{"type":"Player","value":"Player ply Player picking up the entity","name":"ply","description":"Player picking up the entity"},{"type":"Entity","value":"Entity ent Entity being picked up","name":"ent","description":"Entity being picked up"}],"class":"hook","name":"PhysgunPickup","description":" Called when an entity gets picked up by a physgun\n This hook is predicted."},"PlayerAmmoChanged":{"path":"libs_sh/hook.lua#L453","realm":"shared","params":[{"type":"Player","value":"Player ply The player whose ammo is being affected.","name":"ply","description":"The player whose ammo is being affected."},{"type":"number","value":"number ammoID The ammo type ID","name":"ammoID","description":"The ammo type ID"},{"type":"number","value":"number oldcount Previous ammo count","name":"oldcount","description":"Previous ammo count"},{"type":"number","value":"number newcount The new ammo count","name":"newcount","description":"The new ammo count"}],"class":"hook","name":"PlayerAmmoChanged","description":" Called when a player's reserve ammo count changes."},"StartChat":{"path":"libs_sh/hook.lua#L259","realm":"client","params":[{"type":"boolean","value":"boolean isTeamChat Whether they're typing in team chat","name":"isTeamChat","description":"Whether they're typing in team chat"}],"class":"hook","name":"StartChat","description":" Called when the local player opens their chat window."},"lockpickStarted":{"path":"libs_sh/darkrp2.lua#L524","realm":"server","params":[{"type":"Player","value":"Player ply The player that is about to pick a lock.","name":"ply","description":"The player that is about to pick a lock."},{"type":"Entity","value":"Entity ent The entity being lockpicked.","name":"ent","description":"The entity being lockpicked."},{"type":"table","value":"table trace The trace result.","name":"trace","description":"The trace result."}],"class":"hook","name":"lockpickStarted","description":" Called when a player is about to pick a lock. DarkRP only.\n Will only be called if the lockpicker is the owner of the chip, or if the chip is running in superuser mode."},"FinishChat":{"path":"libs_sh/hook.lua#L266","realm":"client","class":"hook","name":"FinishChat","description":" Called when the local player closes their chat window."},"moneyPrinterPrintMoney":{"path":"libs_sh/darkrp2.lua#L433","realm":"server","params":[{"type":"Entity","value":"Entity moneyprinter The money printer","name":"moneyprinter","description":"The money printer"},{"type":"number","value":"number amount The amount to be printed","name":"amount","description":"The amount to be printed"}],"class":"hook","name":"moneyPrinterPrintMoney","description":" Called when a money printer is about to print money. DarkRP only.\n Not guaranteed to work for non-vanilla money printers.\n You should use moneyPrinterPrinted instead, as the printer is not guaranteed to print money even if this hook is called.\n Only works if the owner of the chip also owns the money printer, or if the chip is running in superuser mode."},"Removed":{"path":"libs_sh/hook.lua#L761","realm":"shared","class":"hook","name":"Removed","description":" Called when the starfall chip is removed"},"xinputPressed":{"path":"libs_cl/xinput.lua#L21","realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number button The button that was pushed. See https://github.com/mitterdoo/garrysmod-xinput#xinput_gamepad_","name":"button","description":"The button that was pushed. See https://github.com/mitterdoo/garrysmod-xinput#xinput_gamepad_"},{"type":"number","value":"number when The timer.realtime() at which this event occurred.","name":"when","description":"The timer.realtime() at which this event occurred."}],"class":"hook","name":"xinputPressed","description":" Called when a controller button has been pressed. Client must have XInput Lua binary installed."},"PlayerChangename":{"path":"libs_sh/hook.lua#L583","realm":"shared","params":[{"type":"Player","value":"Player player Player entity of the player.","name":"player","description":"Player entity of the player."},{"type":"string","value":"string oldname Name before change.","name":"oldname","description":"Name before change."},{"type":"string","value":"string newname Name after change.","name":"newname","description":"Name after change."}],"class":"hook","name":"PlayerChangename","description":" Called when a player changes their Steam name. (Game Event)"},"DupeFinished":{"path":"libs_sh/hook.lua#L766","realm":"server","params":[{"type":"table","value":"table entTbl A table of entities duped with the chip mapped to their previous indices.","name":"entTbl","description":"A table of entities duped with the chip mapped to their previous indices."}],"class":"hook","name":"DupeFinished","description":" Called after the starfall chip is duplicated and the duplication is finished."},"VRInput":{"path":"libs_sh/vr.lua#L26","realm":"client","params":[{"type":"string","value":"string actionname Name of the input","name":"actionname","description":"Name of the input"},{"type":"boolean","value":"boolean state State of the input","name":"state","description":"State of the input"}],"class":"hook","name":"VRInput","description":" This gets called every time a boolean controller input action changes state"},"PlayerHurt":{"path":"libs_sh/hook.lua#L107","realm":"shared","params":[{"type":"Player","value":"Player ply Player being hurt","name":"ply","description":"Player being hurt"},{"type":"Entity","value":"Entity attacker Entity causing damage to the player","name":"attacker","description":"Entity causing damage to the player"},{"type":"number","value":"number newHealth New health of the player","name":"newHealth","description":"New health of the player"},{"type":"number","value":"number damageTaken On server, Amount of damage the player has taken, nil on client.","name":"damageTaken","description":"On server, Amount of damage the player has taken, nil on client."}],"class":"hook","name":"PlayerHurt","description":" Called when a player gets hurt, uses the player_hurt game event clientside."},"xinputDisconnected":{"path":"libs_cl/xinput.lua#L13","realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number when The timer.realtime() at which this event occurred.","name":"when","description":"The timer.realtime() at which this event occurred."}],"class":"hook","name":"xinputDisconnected","description":" Called when a controller has been disconnected. Client must have XInput Lua binary installed."},"VRExit":{"path":"libs_sh/vr.lua#L19","realm":"shared","params":[{"type":"Player","value":"Player ply Player exiting VR","name":"ply","description":"Player exiting VR"}],"class":"hook","name":"VRExit","description":" Called when a player exits VR"},"VRStart":{"path":"libs_sh/vr.lua#L13","realm":"shared","params":[{"type":"Player","value":"Player ply Player entering VR","name":"ply","description":"Player entering VR"}],"class":"hook","name":"VRStart","description":" Called when a player enters VR"},"PlayerSwitchWeapon":{"path":"libs_sh/hook.lua#L444","realm":"shared","params":[{"type":"Player","value":"Player ply Player changing weapon","name":"ply","description":"Player changing weapon"},{"type":"Weapon","value":"Weapon oldwep Old weapon","name":"oldwep","description":"Old weapon"},{"type":"Weapon","value":"Weapon newweapon New weapon","name":"newweapon","description":"New weapon"}],"class":"hook","name":"PlayerSwitchWeapon","description":" Called when a player switches their weapon"},"think":{"path":"libs_sh/hook.lua#L756","realm":"shared","class":"hook","name":"think","description":" Think hook. Called each frame on the client and each game tick on the server."},"OnPhysgunFreeze":{"path":"libs_sh/hook.lua#L54","realm":"server","params":[{"type":"Weapon","value":"Weapon physgun The Physgun freezing the entity","name":"physgun","description":"The Physgun freezing the entity"},{"type":"PhysObj","value":"PhysObj physobj PhysObj of the entity","name":"physobj","description":"PhysObj of the entity"},{"type":"Entity","value":"Entity ent Entity being frozen","name":"ent","description":"Entity being frozen"},{"type":"Player","value":"Player ply Player freezing the entity","name":"ply","description":"Player freezing the entity"}],"class":"hook","name":"OnPhysgunFreeze","description":" Called when an entity is being frozen\n Note this is not called for players or NPCs held with the physgun (bug)"},"mouseWheeled":{"path":"libs_sh/input.lua#L141","realm":"client","params":[{"type":"number","value":"number delta Rotate delta","name":"delta","description":"Rotate delta"}],"class":"hook","name":"mouseWheeled","description":" Called when the mouse wheel is rotated"},"EntityFireBullets":{"path":"libs_sh/hook.lua#L502","returns":[{"type":"function?","value":"function? Optional callback to called as if it were the Bullet structure's Callback. Called before the bullet deals damage with attacker, traceResult.","description":"Optional callback to called as if it were the Bullet structure's Callback. Called before the bullet deals damage with attacker, traceResult."}],"realm":"shared","params":[{"type":"Entity","value":"Entity ent The entity that fired the bullet","name":"ent","description":"The entity that fired the bullet"},{"type":"table","value":"table data The bullet data. See http://wiki.facepunch.com/gmod/Structures/Bullet","name":"data","description":"The bullet data. See http://wiki.facepunch.com/gmod/Structures/Bullet"}],"class":"hook","name":"EntityFireBullets","description":" Called every time a bullet is fired from an entity"},"mousemoved":{"path":"libs_sh/input.lua#L125","realm":"client","params":[{"type":"number","value":"number x X coordinate moved","name":"x","description":"X coordinate moved"},{"type":"number","value":"number y Y coordinate moved","name":"y","description":"Y coordinate moved"}],"class":"hook","name":"mousemoved","description":" Called when the mouse is moved"},"OnContextMenuOpen":{"path":"libs_sh/hook.lua#L340","realm":"client","class":"hook","name":"OnContextMenuOpen","description":" Called when the player opens the context menu"},"PlayerChat":{"path":"libs_sh/hook.lua#L272","returns":[{"type":"boolean","value":"boolean Return true to hide the message. Can only be done for the owner of the chip","description":"Return true to hide the message. Can only be done for the owner of the chip"}],"realm":"shared","params":[{"type":"Player","value":"Player ply Player that said the message","name":"ply","description":"Player that said the message"},{"type":"string","value":"string text The message","name":"text","description":"The message"},{"type":"boolean","value":"boolean team Whether the message was team only","name":"team","description":"Whether the message was team only"},{"type":"boolean","value":"boolean isdead Whether the message was send from a dead player","name":"isdead","description":"Whether the message was send from a dead player"}],"class":"hook","name":"PlayerChat","description":" Called when a chat message is printed your chat window (chip owner only)"},"huddisconnected":{"path":"libs_sh/hook.lua#L790","realm":"shared","params":[{"type":"Entity","value":"Entity ent The hud component entity","name":"ent","description":"The hud component entity"},{"type":"Player","value":"Player ply The player who disconnected","name":"ply","description":"The player who disconnected"}],"class":"hook","name":"huddisconnected","description":" Called when the player disconnects from a HUD component linked to the Starfall Chip"},"OnPlayerPhysicsDrop":{"path":"libs_sh/hook.lua#L45","realm":"server","params":[{"type":"Player","value":"Player ply Player dropping the object","name":"ply","description":"Player dropping the object"},{"type":"Entity","value":"Entity ent Entity being dropped","name":"ent","description":"Entity being dropped"},{"type":"boolean","value":"boolean thrown Whether the entity was thrown or dropped","name":"thrown","description":"Whether the entity was thrown or dropped"}],"class":"hook","name":"OnPlayerPhysicsDrop","description":" Called when an entity is being dropped or thrown by +use"},"inputPressed":{"path":"libs_sh/input.lua#L110","realm":"client","params":[{"type":"number","value":"number button Number of the button","name":"button","description":"Number of the button"}],"class":"hook","name":"inputPressed","description":" Called when a button is pressed"},"GravGunPunt":{"path":"libs_sh/hook.lua#L419","realm":"shared","params":[{"type":"Player","value":"Player ply Player punting the gravgun","name":"ply","description":"Player punting the gravgun"},{"type":"Entity","value":"Entity ent Entity being punted","name":"ent","description":"Entity being punted"}],"class":"hook","name":"GravGunPunt","description":" Called when a player punts with the gravity gun"},"PlayerSpray":{"path":"libs_sh/hook.lua#L176","realm":"server","params":[{"type":"Player","value":"Player ply Player that sprayed","name":"ply","description":"Player that sprayed"}],"class":"hook","name":"PlayerSpray","description":" Called when a players sprays their logo"},"GravGunOnPickedUp":{"path":"libs_sh/hook.lua#L21","realm":"server","params":[{"type":"Player","value":"Player ply Player picking up an object","name":"ply","description":"Player picking up an object"},{"type":"Entity","value":"Entity ent Entity being picked up","name":"ent","description":"Entity being picked up"}],"class":"hook","name":"GravGunOnPickedUp","description":" Called when an entity is being picked up by a gravity gun"},"xinputStick":{"path":"libs_cl/xinput.lua#L49","realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number x The X coordinate of the trigger. -32768 - 32767 inclusive","name":"x","description":"The X coordinate of the trigger. -32768 - 32767 inclusive"},{"type":"number","value":"number y The Y coordinate of the trigger. -32768 - 32767 inclusive","name":"y","description":"The Y coordinate of the trigger. -32768 - 32767 inclusive"},{"type":"number","value":"number stick The stick that was moved. 0 is left","name":"stick","description":"The stick that was moved. 0 is left"},{"type":"number","value":"number when The timer.realtime() at which this event occurred.","name":"when","description":"The timer.realtime() at which this event occurred."}],"class":"hook","name":"xinputStick","description":" Called when a stick on the controller has moved. Client must have XInput Lua binary installed."},"PlayerEndVoice":{"path":"libs_sh/hook.lua#L333","realm":"client","params":[{"type":"Player","value":"Player ply Player who stopped talking","name":"ply","description":"Player who stopped talking"}],"class":"hook","name":"PlayerEndVoice","description":" Called when a player stops using voice chat."},"OnEntityWaterLevelChanged":{"path":"libs_sh/hook.lua#L248","realm":"server","params":[{"type":"Entity","value":"Entity ent The entity","name":"ent","description":"The entity"},{"type":"number","value":"number old Previous water level","name":"old","description":"Previous water level"},{"type":"number","value":"number new New water level","name":"new","description":"New water level"}],"class":"hook","name":"OnEntityWaterLevelChanged","description":" Called when the Entity:getWaterLevel of an entity is changed."},"PlayerNoClip":{"path":"libs_sh/hook.lua#L357","realm":"shared","params":[{"type":"Player","value":"Player ply Player toggling noclip","name":"ply","description":"Player toggling noclip"},{"type":"boolean","value":"boolean newState New noclip state. True if on.","name":"newState","description":"New noclip state. True if on."}],"class":"hook","name":"PlayerNoClip","description":" Called when a player toggles noclip"},"xinputTrigger":{"path":"libs_cl/xinput.lua#L39","realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number value The position of the trigger. 0-255 inclusive","name":"value","description":"The position of the trigger. 0-255 inclusive"},{"type":"number","value":"number trigger The trigger that was moved. 0 is left","name":"trigger","description":"The trigger that was moved. 0 is left"},{"type":"number","value":"number when The timer.realtime() at which this event occurred.","name":"when","description":"The timer.realtime() at which this event occurred."}],"class":"hook","name":"xinputTrigger","description":" Called when a trigger on the controller has moved. Client must have XInput Lua binary installed."},"StartEntityDriving":{"path":"libs_sh/hook.lua#L556","realm":"shared","params":[{"type":"Entity","value":"Entity ent Entity being driven","name":"ent","description":"Entity being driven"},{"type":"Player","value":"Player ply Player that is driving the entity","name":"ply","description":"Player that is driving the entity"}],"class":"hook","name":"StartEntityDriving","description":" Called when a player starts driving an entity"},"readcell":{"path":"libs_sv/wire.lua#L830","returns":[{"type":"any","value":"any The value read","description":"The value read"}],"realm":"server","params":[{"type":"any","value":"any address The address requested","name":"address","description":"The address requested"}],"class":"hook","name":"readcell","description":" Called when a high speed device reads from a wired SF chip"},"NetworkEntityCreated":{"path":"libs_sh/hook.lua#L298","realm":"client","params":[{"type":"Entity","value":"Entity ent New entity","name":"ent","description":"New entity"}],"class":"hook","name":"NetworkEntityCreated","description":" Called when a clientside entity gets created or re-created via lag/PVS"},"xinputConnected":{"path":"libs_cl/xinput.lua#L5","realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number when The timer.realtime() at which this event occurred.","name":"when","description":"The timer.realtime() at which this event occurred."}],"class":"hook","name":"xinputConnected","description":" Called when a controller has been connected. Client must have XInput Lua binary installed."},"ComponentUnlinked":{"path":"libs_sh/hook.lua#L784","realm":"shared","params":[{"type":"Entity","value":"Entity ent The component entity","name":"ent","description":"The component entity"}],"class":"hook","name":"ComponentUnlinked","description":" Called when a component is unlinked to the starfall"},"OnPhysgunReload":{"path":"libs_sh/hook.lua#L65","realm":"server","params":[{"type":"Weapon","value":"Weapon physgun The Physgun the player is reloading with","name":"physgun","description":"The Physgun the player is reloading with"},{"type":"Player","value":"Player ply Player reloading the physgun","name":"ply","description":"Player reloading the physgun"}],"class":"hook","name":"OnPhysgunReload","description":" Called when a player reloads their physgun"},"postdrawskybox":{"path":"libs_cl/render.lua#L364","realm":"client","class":"hook","name":"postdrawskybox","description":" Called after the 3D skybox is drawn. This will not be called if PreDrawSkyBox has prevented rendering of the skybox"},"postdraw2dskybox":{"path":"libs_cl/render.lua#L358","realm":"client","class":"hook","name":"postdraw2dskybox","description":" Called right after the 2D skybox has been drawn - allowing you to draw over it."},"starfallUsed":{"path":"libs_sh/hook.lua#L804","realm":"shared","params":[{"type":"Player","value":"Player activator Player who used the screen or chip","name":"activator","description":"Player who used the screen or chip"},{"type":"Entity","value":"Entity used The screen or chip entity that was used","name":"used","description":"The screen or chip entity that was used"}],"class":"hook","name":"starfallUsed","description":" Called when a player uses the screen"},"render":{"path":"libs_sh/hook.lua#L810","realm":"client","class":"hook","name":"render","description":" Called when a frame is requested to be drawn on screen. (2D/3D Context)"},"predrawskybox":{"path":"libs_cl/render.lua#L348","returns":[{"type":"boolean","value":"boolean Return true to not predraw the skybox both 2d and 3d","description":"Return true to not predraw the skybox both 2d and 3d"}],"realm":"client","class":"hook","name":"predrawskybox","description":" Called before the 3D skybox is drawn. This will not be called for maps with no 3D skybox, or when the 3d skybox is disabled"},"NotifyShouldTransmit":{"path":"libs_sh/hook.lua#L305","realm":"client","params":[{"type":"Entity","value":"Entity ent The entity","name":"ent","description":"The entity"},{"type":"boolean","value":"boolean shouldtransmit Whether it is now transmitting or not","name":"shouldtransmit","description":"Whether it is now transmitting or not"}],"class":"hook","name":"NotifyShouldTransmit","description":" Called when a clientside entity transmit state is changed. Usually when changing PVS\n If you want clientside render changes to persist on an entity you have to re-apply them\n each time it begins transmitting again"},"StarfallError":{"path":"libs_sh/hook.lua#L570","realm":"shared","params":[{"type":"Entity","value":"Entity ent Starfall chip that errored","name":"ent","description":"Starfall chip that errored"},{"type":"Player|Entity","value":"Player|Entity ply Who's fault it errored. World-entity if it was a server error, or player that the script errored if on client","name":"ply","description":"Who's fault it errored. World-entity if it was a server error, or player that the script errored if on client"},{"type":"string","value":"string err Error message","name":"err","description":"Error message"}],"class":"hook","name":"StarfallError","description":" Called when starfall chip errors"},"predrawviewmodels":{"path":"libs_cl/render.lua#L309","realm":"client","class":"hook","name":"predrawviewmodels","description":" Called before drawing the viewmodel rendergroup (3D Context)"},"drawhud":{"path":"libs_cl/render.lua#L235","realm":"client","class":"hook","name":"drawhud","description":" Called when a frame is requested to be drawn on hud. (2D Context)"},"predrawhud":{"path":"libs_cl/render.lua#L292","realm":"client","class":"hook","name":"predrawhud","description":" Called before drawing HUD (2D Context)"},"tick":{"path":"libs_sh/hook.lua#L564","realm":"shared","class":"hook","name":"tick","description":" Tick hook. Called each game tick on both the server and client."},"PostEntityFireBullets":{"path":"libs_sh/hook.lua#L520","realm":"shared","params":[{"type":"Entity","value":"Entity ent The entity that fired the bullet","name":"ent","description":"The entity that fired the bullet"},{"type":"table","value":"table data A table containing Trace (See http://wiki.facepunch.com/gmod/Structures/TraceResult) and AmmoType, Tracer, Damage, Force, Attacker, TracerName (see http://wiki.facepunch.com/gmod/Structures/Bullet)","name":"data","description":"A table containing Trace (See http://wiki.facepunch.com/gmod/Structures/TraceResult) and AmmoType, Tracer, Damage, Force, Attacker, TracerName (see http://wiki.facepunch.com/gmod/Structures/Bullet)"}],"class":"hook","name":"PostEntityFireBullets","description":" Called after a bullet is fired and it's trace has been calculated"},"removeLaw":{"path":"libs_sh/darkrp2.lua#L501","realm":"server","params":[{"type":"number","value":"number index Index of the law","name":"index","description":"Index of the law"},{"type":"string","value":"string law Law string","name":"law","description":"Law string"},{"type":"Player?","value":"Player? player The player who removed the law.","name":"player","description":"The player who removed the law."}],"class":"hook","name":"removeLaw","description":" Called when a law is removed. DarkRP only. Not usually called when /resetlaws is used."},"predrawtranslucentrenderables":{"path":"libs_cl/render.lua#L274","realm":"client","params":[{"type":"boolean","value":"boolean depth Whether the current draw is writing depth","name":"depth","description":"Whether the current draw is writing depth"},{"type":"boolean","value":"boolean skybox Whether the current draw is drawing the skybox","name":"skybox","description":"Whether the current draw is drawing the skybox"},{"type":"boolean","value":"boolean skybox3d Whether the current draw is drawing the 3D skybox","name":"skybox3d","description":"Whether the current draw is drawing the 3D skybox"}],"class":"hook","name":"predrawtranslucentrenderables","description":" Called before translucent entities are drawn. (Only works with HUD) (3D context)"},"PhysgunDrop":{"path":"libs_sh/hook.lua#L436","realm":"shared","params":[{"type":"Player","value":"Player ply Player dropping the entity","name":"ply","description":"Player dropping the entity"},{"type":"Entity","value":"Entity ent Entity being dropped","name":"ent","description":"Entity being dropped"}],"class":"hook","name":"PhysgunDrop","description":" Called when an entity being held by a physgun gets dropped"},"PlayerFootstep":{"path":"libs_sh/hook.lua#L365","returns":[{"type":"boolean?","value":"boolean? Return true to prevent default step sound (only on chip owner)","description":"Return true to prevent default step sound (only on chip owner)"}],"realm":"shared","params":[{"type":"Player","value":"Player ply The stepping player","name":"ply","description":"The stepping player"},{"type":"Vector","value":"Vector pos The position of the step","name":"pos","description":"The position of the step"},{"type":"number","value":"number foot Foot that is stepped. 0 for left, 1 for right","name":"foot","description":"Foot that is stepped. 0 for left, 1 for right"},{"type":"string","value":"string sound Sound that is going to play","name":"sound","description":"Sound that is going to play"},{"type":"number","value":"number volume Volume of the footstep","name":"volume","description":"Volume of the footstep"}],"class":"hook","name":"PlayerFootstep","description":" Called whenever a player steps"},"postdrawopaquerenderables":{"path":"libs_cl/render.lua#L265","realm":"client","params":[{"type":"boolean","value":"boolean depth Whether the current draw is writing depth","name":"depth","description":"Whether the current draw is writing depth"},{"type":"boolean","value":"boolean skybox Whether the current draw is drawing the skybox","name":"skybox","description":"Whether the current draw is drawing the skybox"},{"type":"boolean","value":"boolean skybox3d Whether the current draw is drawing the 3D skybox","name":"skybox3d","description":"Whether the current draw is drawing the 3D skybox"}],"class":"hook","name":"postdrawopaquerenderables","description":" Called after opaque entities are drawn. (Only works with HUD) (3D context)"},"predrawopaquerenderables":{"path":"libs_cl/render.lua#L256","realm":"client","params":[{"type":"boolean","value":"boolean depth Whether the current draw is writing depth","name":"depth","description":"Whether the current draw is writing depth"},{"type":"boolean","value":"boolean skybox Whether the current draw is drawing the skybox","name":"skybox","description":"Whether the current draw is drawing the skybox"},{"type":"boolean","value":"boolean skybox3d Whether the current draw is drawing the 3D skybox","name":"skybox3d","description":"Whether the current draw is drawing the 3D skybox"}],"class":"hook","name":"predrawopaquerenderables","description":" Called before opaque entities are drawn. (Only works with HUD) (3D context)"},"hologrammatrix":{"path":"libs_cl/render.lua#L227","realm":"client","class":"hook","name":"hologrammatrix","description":" Called before entities are drawn. You can't render anything, but you can edit hologram matrices before they are drawn."},"OnPlayerJump":{"path":"libs_sh/hook.lua#L385","realm":"shared","params":[{"type":"Player","value":"Player ply Player who jumped","name":"ply","description":"Player who jumped"},{"type":"number","value":"number speed The velocity/impulse of the jump","name":"speed","description":"The velocity/impulse of the jump"}],"class":"hook","name":"OnPlayerJump","description":" Called when a player jumps."},"resetLaws":{"path":"libs_sh/darkrp2.lua#L514","realm":"server","params":[{"type":"Player?","value":"Player? player The player resetting the laws.","name":"player","description":"The player resetting the laws."}],"class":"hook","name":"resetLaws","description":" Called when laws are reset. DarkRP only. Usually the only hook called when /resetlaws is used."},"renderscene":{"path":"libs_cl/render.lua#L207","realm":"client","params":[{"type":"Vector","value":"Vector origin View origin","name":"origin","description":"View origin"},{"type":"Angle","value":"Angle angles View angles","name":"angles","description":"View angles"},{"type":"number","value":"number fov View FOV","name":"fov","description":"View FOV"}],"class":"hook","name":"renderscene","description":" Called when a scene is requested to be drawn. This is used for the render.renderview function."},"PropBreak":{"path":"libs_sh/hook.lua#L494","realm":"shared","params":[{"type":"Player","value":"Player ply Player who broke it","name":"ply","description":"Player who broke it"},{"type":"Entity","value":"Entity ent Entity broken","name":"ent","description":"Entity broken"}],"class":"hook","name":"PropBreak","description":" Called when an entity is broken"},"net":{"path":"libs_sh/net.lua#L520","realm":"shared","params":[{"type":"string","value":"string name Name of the arriving net message","name":"name","description":"Name of the arriving net message"},{"type":"number","value":"number len Length of the arriving net message in bits","name":"len","description":"Length of the arriving net message in bits"},{"type":"Player?","value":"Player? ply On server, the player that sent the message. Nil on client.","name":"ply","description":"On server, the player that sent the message. Nil on client."}],"class":"hook","name":"net","description":" Called when a net message arrives"},"xinputReleased":{"path":"libs_cl/xinput.lua#L30","realm":"client","params":[{"type":"number","value":"number id Controller number. Starts at 0","name":"id","description":"Controller number. Starts at 0"},{"type":"number","value":"number button The button that was released. See https://github.com/mitterdoo/garrysmod-xinput#xinput_gamepad_","name":"button","description":"The button that was released. See https://github.com/mitterdoo/garrysmod-xinput#xinput_gamepad_"},{"type":"number","value":"number when The timer.realtime() at which this event occurred.","name":"when","description":"The timer.realtime() at which this event occurred."}],"class":"hook","name":"xinputReleased","description":" Called when a controller button has been released. Client must have XInput Lua binary installed."},"input":{"path":"libs_sv/wire.lua#L824","realm":"server","params":[{"type":"string","value":"string input The input name","name":"input","description":"The input name"},{"type":"any","value":"any value The value of the input","name":"value","description":"The value of the input"}],"class":"hook","name":"input","description":" Called when an input on a wired SF chip is written to"},"midi":{"path":"libs_cl/midi.lua#L27","libtbl":["midi_library"],"realm":"client","params":[{"type":"number","value":"number time the exact systime which the event occured","name":"time","description":"the exact systime which the event occured"},{"type":"number","value":"number command the command code of the event.  First 4 bits are the command code and last 4 are the channel","name":"command","description":"the command code of the event.  First 4 bits are the command code and last 4 are the channel"},{"type":"number","value":"number param1 Each command has their own set of parameters, see above","name":"param1","description":"Each command has their own set of parameters, see above"},{"type":"number","value":"number param2 Each command has their own set of parameters, see above","name":"param2","description":"Each command has their own set of parameters, see above"}],"class":"hook","name":"midi","description":" Event hook for midi devices.  \n Everytime a midi device outputs a signal, the callback function on the hook is called.\n Read up on the MIDI protocol to make better sense of everything -> https://ccrma.stanford.edu/~craig/articles/linuxmidi/misc/essenmidi.html\n Commands and their parameters:\n 0x80 NOTE_OFF              : param1 = key;                         param2 = velocity\n 0x90 NOTE_ON               : param1 = key;                         param2 = velocity\n 0xA0 AFTERTOUCH            : param1 = key;                         param2 = touch\n 0xB0 CONTINUOUS_CONTROLLER : param1 = button_number;               param2 = button_value\n 0xC0 PATCH_CHANGE          : param1 = patch number;\n 0xD0 CHANNEL_PRESSURE      : param1 = pressure;\n 0xE0 PITCH_BEND            : param1 = lsb(least signifigant bit);  param2 = msb(most signifigant bit)"},"PlayerLeaveVehicle":{"path":"libs_sh/hook.lua#L150","realm":"server","params":[{"type":"Player","value":"Player ply Player who left a vehicle","name":"ply","description":"Player who left a vehicle"},{"type":"Vehicle","value":"Vehicle vehicle Vehicle that was left","name":"vehicle","description":"Vehicle that was left"}],"class":"hook","name":"PlayerLeaveVehicle","description":" Called when a players leaves a vehicle"},"hudconnected":{"path":"libs_sh/hook.lua#L797","realm":"shared","params":[{"type":"Entity","value":"Entity ent The hud component entity","name":"ent","description":"The hud component entity"},{"type":"Player","value":"Player ply The player who connected","name":"ply","description":"The player who connected"}],"class":"hook","name":"hudconnected","description":" Called when the player connects to a HUD component linked to the Starfall Chip"},"DoAnimationEvent":{"path":"libs_sh/hook.lua#L463","realm":"shared","params":[{"type":"Player","value":"Player ply The player being animated","name":"ply","description":"The player being animated"},{"type":"number","value":"number event The event id","name":"event","description":"The event id"},{"type":"number","value":"number data The event data","name":"data","description":"The event data"}],"class":"hook","name":"DoAnimationEvent","description":" Called when a player animation event occurs"},"inputReleased":{"path":"libs_sh/input.lua#L117","realm":"client","params":[{"type":"number","value":"number button Number of the button","name":"button","description":"Number of the button"}],"class":"hook","name":"inputReleased","description":" Called when a button is released"},"ComponentLinked":{"path":"libs_sh/hook.lua#L778","realm":"shared","params":[{"type":"Entity","value":"Entity ent The component entity","name":"ent","description":"The component entity"}],"class":"hook","name":"ComponentLinked","description":" Called when a component is linked to the starfall"},"lockdownEnded":{"path":"libs_sh/darkrp2.lua#L469","realm":"server","params":[{"type":"Player?","value":"Player? actor The player who ended the lockdown, or nil.","name":"actor","description":"The player who ended the lockdown, or nil."}],"class":"hook","name":"lockdownEnded","description":" Called when a lockdown has ended. DarkRP only."},"PlayerDisconnect":{"path":"libs_sh/hook.lua#L608","realm":"shared","params":[{"type":"string","value":"string networkid The SteamID the player had. Will be \"BOT\" for bots and \"STEAM_0:0:0\" in single-player.","name":"networkid","description":"The SteamID the player had. Will be \"BOT\" for bots and \"STEAM_0:0:0\" in single-player."},{"type":"string","value":"string name The name the player had.","name":"name","description":"The name the player had."},{"type":"Player","value":"Player player Player entity the player had.","name":"player","description":"Player entity the player had."},{"type":"string","value":"string reason Reason for disconnecting.","name":"reason","description":"Reason for disconnecting."},{"type":"boolean","value":"boolean isbot False if the player isn't a bot, true if they are.","name":"isbot","description":"False if the player isn't a bot, true if they are."}],"class":"hook","name":"PlayerDisconnect","description":" Called when a player disconnects from the server. (Game Event)"},"PlayerChangedTeam":{"path":"libs_sh/hook.lua#L132","realm":"server","params":[{"type":"Player","value":"Player ply Player whose team has changed","name":"ply","description":"Player whose team has changed"},{"type":"number","value":"number oldTeam Index of the team the player was originally in. See team.getName and the team library","name":"oldTeam","description":"Index of the team the player was originally in. See team.getName and the team library"},{"type":"number","value":"number newTeam Index of the team the player has changed to.","name":"newTeam","description":"Index of the team the player has changed to."}],"class":"hook","name":"PlayerChangedTeam","description":" Called when a player has changed team using Player:SetTeam"},"PlayerConnect":{"path":"libs_sh/hook.lua#L595","realm":"shared","params":[{"type":"string","value":"string networkid The SteamID the player had. Will be \"BOT\" for bots and \"STEAM_0:0:0\" in single-player.","name":"networkid","description":"The SteamID the player had. Will be \"BOT\" for bots and \"STEAM_0:0:0\" in single-player."},{"type":"string","value":"string name The name the player had.","name":"name","description":"The name the player had."},{"type":"number","value":"number userid The UserID the player has.","name":"userid","description":"The UserID the player has."},{"type":"boolean","value":"boolean isbot False if the player isn't a bot, true if they are.","name":"isbot","description":"False if the player isn't a bot, true if they are."}],"class":"hook","name":"PlayerConnect","description":" Called when a player connects to the server. (Game Event)"},"VRPreRender":{"path":"libs_sh/vr.lua#L45","realm":"client","class":"hook","name":"VRPreRender","description":" Called before rendering the game. Any code that you want to run once per frame should be put here. HUD is required."},"EntityTakeDamage":{"path":"libs_sh/hook.lua#L211","returns":[{"type":"boolean?","value":"boolean? Return true to prevent the entity from taking damage","description":"Return true to prevent the entity from taking damage"}],"realm":"server","params":[{"type":"Entity","value":"Entity target Entity that is hurt","name":"target","description":"Entity that is hurt"},{"type":"Entity","value":"Entity attacker Entity that attacked","name":"attacker","description":"Entity that attacked"},{"type":"Entity","value":"Entity inflictor Entity that inflicted the damage","name":"inflictor","description":"Entity that inflicted the damage"},{"type":"number","value":"number amount How much damage","name":"amount","description":"How much damage"},{"type":"number","value":"number type Type of the damage","name":"type","description":"Type of the damage"},{"type":"Vector","value":"Vector position Position of the damage","name":"position","description":"Position of the damage"},{"type":"Vector","value":"Vector force Force of the damage","name":"force","description":"Force of the damage"}],"class":"hook","name":"EntityTakeDamage","description":" Called when an entity is damaged"},"setupworldfog":{"path":"libs_cl/render.lua#L315","realm":"client","class":"hook","name":"setupworldfog","description":" Called when world fog is drawn."},"postdrawtranslucentrenderables":{"path":"libs_cl/render.lua#L283","realm":"client","params":[{"type":"boolean","value":"boolean depth Whether the current draw is writing depth","name":"depth","description":"Whether the current draw is writing depth"},{"type":"boolean","value":"boolean skybox Whether the current draw is drawing the skybox","name":"skybox","description":"Whether the current draw is drawing the skybox"},{"type":"boolean","value":"boolean skybox3d Whether the current draw is drawing the 3D skybox","name":"skybox3d","description":"Whether the current draw is drawing the 3D skybox"}],"class":"hook","name":"postdrawtranslucentrenderables","description":" Called after translucent entities are drawn. (Only works with HUD) (3D context)"},"ChatTextChanged":{"path":"libs_sh/hook.lua#L285","realm":"client","params":[{"type":"string","value":"string txt Text it was changed to","name":"txt","description":"Text it was changed to"}],"class":"hook","name":"ChatTextChanged","description":" Called when the player's chat box text changes.\n Requires the 'input' permission."},"OnEntityCreated":{"path":"libs_sh/hook.lua#L474","realm":"shared","params":[{"type":"Entity","value":"Entity ent New entity","name":"ent","description":"New entity"}],"class":"hook","name":"OnEntityCreated","description":" Called when an entity gets created"},"moneyPrinterCatchFire":{"path":"libs_sh/darkrp2.lua#L400","realm":"server","params":[{"type":"Entity","value":"Entity moneyprinter The money printer that is about to catch fire","name":"moneyprinter","description":"The money printer that is about to catch fire"}],"class":"hook","name":"moneyPrinterCatchFire","description":" Called when a money printer is about to catch fire. DarkRP only. Called between moneyPrinterPrintMoney and moneyPrinterPrinted.\n Not guaranteed to work for non-vanilla money printers.\n Only works if the owner of the chip also owns the money printer, or if the chip is running in superuser mode."},"lockdownStarted":{"path":"libs_sh/darkrp2.lua#L479","realm":"server","params":[{"type":"Player?","value":"Player? actor The player who started the lockdown, or nil.","name":"actor","description":"The player who started the lockdown, or nil."}],"class":"hook","name":"lockdownStarted","description":" Called when a lockdown has started. DarkRP only."},"PlayerDeath":{"path":"libs_sh/hook.lua#L91","realm":"server","params":[{"type":"Player","value":"Player ply Player who died","name":"ply","description":"Player who died"},{"type":"Entity","value":"Entity inflictor Entity used to kill the player","name":"inflictor","description":"Entity used to kill the player"},{"type":"Entity","value":"Entity attacker Entity that killed the player","name":"attacker","description":"Entity that killed the player"}],"class":"hook","name":"PlayerDeath","description":" Called when a player dies"},"OnPlayerHitGround":{"path":"libs_sh/hook.lua#L393","realm":"shared","params":[{"type":"Player","value":"Player ply Player that hit the ground","name":"ply","description":"Player that hit the ground"},{"type":"boolean","value":"boolean inWater Did the player land in water?","name":"inWater","description":"Did the player land in water?"},{"type":"boolean","value":"boolean onFloater Did the player land on an object floating in the water?","name":"onFloater","description":"Did the player land on an object floating in the water?"},{"type":"number","value":"number speed The speed at which the player hit the ground","name":"speed","description":"The speed at which the player hit the ground"}],"class":"hook","name":"OnPlayerHitGround","description":" Called when a player makes contact with the ground after a jump or a fall."},"EndEntityDriving":{"path":"libs_sh/hook.lua#L548","realm":"shared","params":[{"type":"Entity","value":"Entity ent Entity that had been driven","name":"ent","description":"Entity that had been driven"},{"type":"Player","value":"Player ply Player that drove the entity","name":"ply","description":"Player that drove the entity"}],"class":"hook","name":"EndEntityDriving","description":" Called when a player stops driving an entity"},"EntityEmitSound":{"path":"libs_sh/hook.lua#L532","returns":[{"type":"boolean?","value":"boolean? Return false to prevent the sound from playing or nothing to play the sound without altering it.","description":"Return false to prevent the sound from playing or nothing to play the sound without altering it."}],"realm":"shared","params":[{"type":"table","value":"table data Information about the played sound. Changes done to this table can be applied by returning true from this hook. See https://wiki.facepunch.com/gmod/Structures/EmitSoundInfo.","name":"data","description":"Information about the played sound. Changes done to this table can be applied by returning true from this hook. See https://wiki.facepunch.com/gmod/Structures/EmitSoundInfo."}],"class":"hook","name":"EntityEmitSound","description":" Called whenever a sound has been played. This will not be called clientside if the server played the sound without the client also calling Entity:EmitSound."},"PlayerSpawn":{"path":"libs_sh/hook.lua#L125","realm":"server","params":[{"type":"Player","value":"Player ply Player who spawned","name":"ply","description":"Player who spawned"}],"class":"hook","name":"PlayerSpawn","description":" Called when a player spawns"},"PlayerDisconnected":{"path":"libs_sh/hook.lua#L100","realm":"server","params":[{"type":"Player","value":"Player ply Player that disconnected","name":"ply","description":"Player that disconnected"}],"class":"hook","name":"PlayerDisconnected","description":" Called when a player disconnects"},"OnContextMenuClose":{"path":"libs_sh/hook.lua#L346","realm":"client","class":"hook","name":"OnContextMenuClose","description":" Called when the player closes the context menu"},"PlayerUnfrozeObject":{"path":"libs_sh/hook.lua#L82","realm":"server","params":[{"type":"Player","value":"Player ply The player who has unfrozen an entity","name":"ply","description":"The player who has unfrozen an entity"},{"type":"Entity","value":"Entity ent The unfrozen entity","name":"ent","description":"The unfrozen entity"},{"type":"PhysObj","value":"PhysObj physobj The physics object of the unfrozen entity ","name":"physobj","description":"The physics object of the unfrozen entity "}],"class":"hook","name":"PlayerUnfrozeObject","description":" Called when a player unfreezes an object"},"playerWalletChanged":{"path":"libs_sh/darkrp2.lua#L452","realm":"server","params":[{"type":"Player","value":"Player ply The player who is getting money.","name":"ply","description":"The player who is getting money."},{"type":"number","value":"number amount The amount of money given to the player.","name":"amount","description":"The amount of money given to the player."},{"type":"number","value":"number wallet How much money the player had before receiving the money.","name":"wallet","description":"How much money the player had before receiving the money."}],"class":"hook","name":"playerWalletChanged","description":" Called when a player receives money. DarkRP only.\n Will only be called if the recipient is the owner of the chip, or if the chip is running in superuser mode."},"ClientInitialized":{"path":"libs_sh/hook.lua#L772","realm":"server","params":[{"type":"Player","value":"Player ply The player that initialized","name":"ply","description":"The player that initialized"}],"class":"hook","name":"ClientInitialized","description":" Called after a client's starfall has initialized. Use this to know when it's safe to send net messages to the client."},"OnNPCKilled":{"path":"libs_sh/hook.lua#L239","realm":"server","params":[{"type":"Npc","value":"Npc npc NPC that was killed","name":"npc","description":"NPC that was killed"},{"type":"Entity","value":"Entity attacker The NPCs attacker, the entity that gets the kill credit, for example a player or an NPC.","name":"attacker","description":"The NPCs attacker, the entity that gets the kill credit, for example a player or an NPC."},{"type":"Entity","value":"Entity inflictor Entity that did the killing","name":"inflictor","description":"Entity that did the killing"}],"class":"hook","name":"OnNPCKilled","description":" Called whenever an NPC is killed."},"moneyPrinterPrinted":{"path":"libs_sh/darkrp2.lua#L416","realm":"server","params":[{"type":"Entity","value":"Entity moneyprinter The money printer","name":"moneyprinter","description":"The money printer"},{"type":"Entity","value":"Entity moneybag The moneybag produed by the printer.","name":"moneybag","description":"The moneybag produed by the printer."}],"class":"hook","name":"moneyPrinterPrinted","description":" Called after a money printer is has printed money. DarkRP only.\n Not guaranteed to work for non-vanilla money printers.\n Only works if the owner of the chip also owns the money printer, or if the chip is running in superuser mode."},"PlayerCanPickupWeapon":{"path":"libs_sh/hook.lua#L200","realm":"server","params":[{"type":"Player","value":"Player ply Player","name":"ply","description":"Player"},{"type":"Weapon","value":"Weapon wep Weapon","name":"wep","description":"Weapon"}],"class":"hook","name":"PlayerCanPickupWeapon","description":" Called when a wants to pick up a weapon"},"calcview":{"path":"libs_cl/render.lua#L370","returns":[{"type":"table","value":"table Table containing information for the camera. {origin=camera origin, angles=camera angles, fov=camera fov, znear=znear, zfar=zfar, drawviewer=drawviewer, ortho=ortho table}","description":"Table containing information for the camera. {origin=camera origin, angles=camera angles, fov=camera fov, znear=znear, zfar=zfar, drawviewer=drawviewer, ortho=ortho table}"}],"realm":"client","params":[{"type":"Vector","value":"Vector pos Current position of the camera","name":"pos","description":"Current position of the camera"},{"type":"Angle","value":"Angle ang Current angles of the camera","name":"ang","description":"Current angles of the camera"},{"type":"number","value":"number fov Current fov of the camera","name":"fov","description":"Current fov of the camera"},{"type":"number","value":"number znear Current near plane of the camera","name":"znear","description":"Current near plane of the camera"},{"type":"number","value":"number zfar Current far plane of the camera","name":"zfar","description":"Current far plane of the camera"}],"class":"hook","name":"calcview","description":" Called when the engine wants to calculate the player's view. Only works if connected to Starfall HUD"},"PlayerSwitchFlashlight":{"path":"libs_sh/hook.lua#L192","realm":"server","params":[{"type":"Player","value":"Player ply Player switching flashlight","name":"ply","description":"Player switching flashlight"},{"type":"boolean","value":"boolean state New flashlight state. True if on.","name":"state","description":"New flashlight state. True if on."}],"class":"hook","name":"PlayerSwitchFlashlight","description":" Called when a players turns their flashlight on or off"},"PlayerSay":{"path":"libs_sh/hook.lua#L159","returns":[{"type":"string?","value":"string? New text. \"\" to stop from displaying. Nil to keep original.","description":"New text. \"\" to stop from displaying. Nil to keep original."}],"realm":"server","params":[{"type":"Player","value":"Player ply Player that sent the message","name":"ply","description":"Player that sent the message"},{"type":"string","value":"string text Content of the message","name":"text","description":"Content of the message"},{"type":"boolean","value":"boolean teamChat True if team chat","name":"teamChat","description":"True if team chat"}],"class":"hook","name":"PlayerSay","description":" Called when a player sends a chat message"},"PlayerInitialSpawn":{"path":"libs_sh/hook.lua#L117","realm":"server","params":[{"type":"Player","value":"Player ply Player who spawned","name":"ply","description":"Player who spawned"},{"type":"boolean","value":"boolean transition If true, the player just spawned from a map transition.","name":"transition","description":"If true, the player just spawned from a map transition."}],"class":"hook","name":"PlayerInitialSpawn","description":" Called when a player spawns for the first time"},"permissionrequest":{"path":"libs_sh/builtins.lua#L324","realm":"client","class":"hook","name":"permissionrequest","description":" Called when local client changed instance permissions"},"PlayerUse":{"path":"libs_sh/hook.lua#L183","realm":"server","params":[{"type":"Player","value":"Player ply Player using the entity","name":"ply","description":"Player using the entity"},{"type":"Entity","value":"Entity ent Entity being used","name":"ent","description":"Entity being used"}],"class":"hook","name":"PlayerUse","description":" Called when a player holds their use key and looks at an entity.\n Will continuously run."},"KeyPress":{"path":"libs_sh/hook.lua#L403","realm":"shared","params":[{"type":"Player","value":"Player ply Player pressing the key","name":"ply","description":"Player pressing the key"},{"type":"number","value":"number key The key being pressed","name":"key","description":"The key being pressed"}],"class":"hook","name":"KeyPress","description":" Called when a player presses a key"},"GravGunOnDropped":{"path":"libs_sh/hook.lua#L29","realm":"server","params":[{"type":"Player","value":"Player ply Player dropping the object","name":"ply","description":"Player dropping the object"},{"type":"Entity","value":"Entity ent Entity being dropped","name":"ent","description":"Entity being dropped"}],"class":"hook","name":"GravGunOnDropped","description":" Called when an entity is being dropped by a gravity gun"}},"Version":"master","Directives":{"server":{"path":"libs_sh/builtins.lua#L1272","realm":"shared","class":"directive","name":"server","description":" Set the current file to only run on the server. Shared is default. --@server"},"shared":{"path":"libs_sh/builtins.lua#L1280","realm":"shared","class":"directive","name":"shared","description":" Set the current file to run on both the server and client. This is enabled by default. --@shared"},"owneronly":{"path":"libs_sh/builtins.lua#L1295","realm":"shared","class":"directive","name":"owneronly","description":" Set the current file to only be sent to the owner. --@owneronly"},"model":{"path":"libs_sh/builtins.lua#L1262","realm":"shared","params":[{"type":"model","value":"model String of the model","name":"String","description":"of the model"}],"class":"directive","name":"model","description":" Set the model of the processor entity. --@model models/props_junk/watermelon01.mdl"},"precachemodel":{"path":"libs_sh/builtins.lua#L1267","realm":"shared","params":[{"type":"model","value":"model String of the model to precache","name":"String","description":"of the model to precache"}],"class":"directive","name":"precachemodel","description":" Precaches models that may take a while to load (max 16). --@precachemodel models/props_junk/watermelon01.mdl"},"includedata":{"path":"libs_sh/builtins.lua#L1243","realm":"shared","params":[{"type":"path","value":"path Path to the file","name":"Path","description":"to the file"}],"class":"directive","name":"includedata","description":" Mark a file to be included in the upload.\n Different from include in that the file does not have to have valid syntax.\n Cannot be used with require() or dofile(), can only be used with getScripts()."},"superuser":{"path":"libs_sh/builtins.lua#L1291","realm":"shared","class":"directive","name":"superuser","description":" Lets the chip run with no restrictions and the chip owner becomes SF.Superuser. Can only be used in the main file. --@superuser"},"includedir":{"path":"libs_sh/builtins.lua#L1237","realm":"shared","params":[{"type":"path","value":"path Path to the directory","name":"Path","description":"to the directory"}],"class":"directive","name":"includedir","description":" Mark a directory to be included in the upload.\n This is optional to include all files in the directory in require() and dofile()"},"clientmain":{"path":"libs_sh/builtins.lua#L1284","realm":"shared","params":[{"type":"filename","value":"filename The file to run as main on client","name":"The","description":"file to run as main on client"}],"class":"directive","name":"clientmain","description":" Set the client file to run as main. Can only be used in the main file. The client file must be --@include'ed. The main file will not be sent to the client if you use this directive.\n --@include somefile.txt\n --@clientmain somefile.txt"},"client":{"path":"libs_sh/builtins.lua#L1276","realm":"shared","class":"directive","name":"client","description":" Set the current file to only run on the client. Shared is default. --@client"},"name":{"path":"libs_sh/builtins.lua#L1250","realm":"shared","params":[{"type":"name","value":"name Name of the script","name":"Name","description":"of the script"}],"class":"directive","name":"name","description":" Set the name of the script.\n This will become the name of the tab and will show on the overlay of the processor. --@name Awesome script"},"include":{"path":"libs_sh/builtins.lua#L1230","realm":"shared","params":[{"type":"path","value":"path Path to the file, or URL of the single-file library to be included","name":"Path","description":"to the file, or URL of the single-file library to be included"}],"class":"directive","name":"include","description":" Mark a file to be included in the upload.\n URL is also supported, e.g. --@include http://mydomain.com/myfile as myfile.txt\n This is required to use the file in require() and dofile()"},"author":{"path":"libs_sh/builtins.lua#L1256","realm":"shared","params":[{"type":"author","value":"author Author of the script","name":"Author","description":"of the script"}],"class":"directive","name":"author","description":" Set the author of the script.\n This will set the author that will be shown on the overlay of the processor. --@author TheAuthor"}},"Types":{"NavArea":{"path":"libs_sv/navmesh.lua#L23","libtbl":["navarea_methods","navarea_meta"],"realm":"server","methods":{"getCenter":{"path":"libs_sv/navmesh.lua#L390","returns":[{"type":"Vector","value":"Vector The center vector.","description":"The center vector."}],"realm":"server","class":"function","name":"getCenter","description":" Returns the center position of the CNavArea."},"getSizeX":{"path":"libs_sv/navmesh.lua#L518","returns":[{"type":"number","value":"number Width","description":"Width"}],"realm":"server","class":"function","name":"getSizeX","description":" Returns the width this Nav Area."},"getAdjacentAreas":{"path":"libs_sv/navmesh.lua#L337","returns":[{"type":"table","value":"table A table of all CNavArea that have a ( one and two way ) connection from this CNavArea.","description":"A table of all CNavArea that have a ( one and two way ) connection from this CNavArea."}],"realm":"server","class":"function","name":"getAdjacentAreas","description":" Returns a table of all the CNavAreas that have a ( one and two way ) connection from this NavArea.\n If an area has a one-way incoming connection to this NavArea, then it will not be returned from this function, use NavArea:getIncomingConnections to get all one-way incoming connections.\n See NavArea:getAdjacentAreasAtSide for a function that only returns areas from one side/direction."},"isConnectedAtSide":{"path":"libs_sv/navmesh.lua#L295","returns":[{"type":"boolean","value":"boolean","description":""}],"realm":"server","params":[{"type":"NavArea","value":"NavArea other The other NavArea to check for connection to.","name":"other","description":"The other NavArea to check for connection to."},{"type":"number","value":"number navDirType The direction, in which to look for the connection. See NAV_DIR enums","name":"navDirType","description":"The direction, in which to look for the connection. See NAV_DIR enums"}],"class":"function","name":"isConnectedAtSide","description":" Returns whether this NavArea has an outgoing ( one or two way ) connection to given NavArea in given direction."},"setParent":{"path":"libs_sv/navmesh.lua#L687","realm":"server","params":[{"type":"NavArea","value":"NavArea parent The new parent to set","name":"parent","description":"The new parent to set"},{"type":"number","value":"number how How we get from parent to us using NAV_TRAVERSE_TYPE","name":"how","description":"How we get from parent to us using NAV_TRAVERSE_TYPE"}],"class":"function","name":"setParent","description":" Sets the new parent of this CNavArea."},"hasAttributes":{"path":"libs_sv/navmesh.lua#L547","returns":[{"type":"boolean","value":"boolean True if the CNavArea matches the given mask. False otherwise.","description":"True if the CNavArea matches the given mask. False otherwise."}],"realm":"server","params":[{"type":"number","value":"number attributes Attribute mask to check for, see NAV_MESH enums","name":"attributes","description":"Attribute mask to check for, see NAV_MESH enums"}],"class":"function","name":"hasAttributes","description":" Returns true if the given CNavArea has this attribute flag set."},"getParentHow":{"path":"libs_sv/navmesh.lua#L488","returns":[{"type":"number","value":"number","description":""}],"realm":"server","class":"function","name":"getParentHow","description":" Returns how this CNavArea is connected to its parent."},"getCorner":{"path":"libs_sv/navmesh.lua#L405","returns":[{"type":"Vector","value":"Vector The vector position of the corner.","description":"The vector position of the corner."}],"realm":"server","params":[{"type":"number","value":"number cornerId The target corner to get the position of, takes NAV_CORNER.","name":"cornerId","description":"The target corner to get the position of, takes NAV_CORNER."}],"class":"function","name":"getCorner","description":" Returns the vector position of the corner for the given CNavArea."},"computeGroundHeightChange":{"path":"libs_sv/navmesh.lua#L321","returns":[{"type":"number","value":"number","description":""}],"realm":"server","params":[{"type":"NavArea","value":"NavArea other The nav area to test against.","name":"other","description":"The nav area to test against."}],"class":"function","name":"computeGroundHeightChange","description":" Returns the height difference on the Z axis of the two CNavAreas. This is calculated from the center most point on both CNavAreas."},"clearSearchLists":{"path":"libs_sv/navmesh.lua#L749","realm":"server","class":"function","name":"clearSearchLists","description":" Clears the open and closed lists for a new search."},"isOpen":{"path":"libs_sv/navmesh.lua#L239","returns":[{"type":"boolean","value":"boolean Whether this area is in the Open List.","description":"Whether this area is in the Open List."}],"realm":"server","class":"function","name":"isOpen","description":" Returns whether this area is in the Open List.\n Used in pathfinding via the A* algorithm.\n More information can be found here: https://wiki.facepunch.com/gmod/Simple_Pathfinding"},"addToOpenList":{"path":"libs_sv/navmesh.lua#L742","realm":"server","class":"function","name":"addToOpenList","description":" Adds this CNavArea to the Open List.\n Requires `navarea.openlist` permission"},"addToClosedList":{"path":"libs_sv/navmesh.lua#L737","realm":"server","class":"function","name":"addToClosedList","description":" Adds this CNavArea to the closed list, a list of areas that have been checked by A* pathfinding algorithm."},"getClosestPointOnArea":{"path":"libs_sv/navmesh.lua#L397","returns":[{"type":"Vector","value":"Vector The closest point on the NavArea.","description":"The closest point on the NavArea."}],"realm":"server","params":[{"type":"Vector","value":"Vector pos The given position, can be outside of the NavArea bounds.","name":"pos","description":"The given position, can be outside of the NavArea bounds."}],"class":"function","name":"getClosestPointOnArea","description":" Returns the closest point of this NavArea from the given position."},"addHidingSpot":{"path":"libs_sv/navmesh.lua#L722","realm":"server","params":[{"type":"Vector","value":"Vector pos The position of the hiding spot on the nav area","name":"pos","description":"The position of the hiding spot on the nav area"},{"type":"number","value":"number flags Flags describing what kind of hiding spot this is.","name":"flags","description":"Flags describing what kind of hiding spot this is."}],"class":"function","name":"addHidingSpot","description":" Adds a hiding spot onto this nav area.\n There's a limit of 255 hiding spots per area.\n 0 = None (not recommended)\n 1 = In Cover/basically a hiding spot, in a corner with good hard cover nearby\n 2 = good sniper spot, had at least one decent sniping corridor\n 4 = perfect sniper spot, can see either very far, or a large area, or both\n 8 = exposed, spot in the open, usually on a ledge or cliff\n Values over 255 will be clamped."},"disconnect":{"path":"libs_sv/navmesh.lua#L715","realm":"server","params":[{"type":"NavArea","value":"NavArea other The other NavArea to disconnect from.","name":"other","description":"The other NavArea to disconnect from."}],"class":"function","name":"disconnect","description":" Disconnects this nav area from given area or ladder. (Only disconnects one way)"},"updateOnOpenList":{"path":"libs_sv/navmesh.lua#L710","realm":"server","class":"function","name":"updateOnOpenList","description":" Moves this open list to appropriate position based on its CNavArea:getTotalCost compared to the total cost of other areas in the open list."},"getAttributes":{"path":"libs_sv/navmesh.lua#L383","returns":[{"type":"number","value":"number Attribute mask for this CNavArea, see NAV_MESH for the specific flags.","description":"Attribute mask for this CNavArea, see NAV_MESH for the specific flags."}],"realm":"server","class":"function","name":"getAttributes","description":" Returns the attribute mask for the given CNavArea."},"setTotalCost":{"path":"libs_sv/navmesh.lua#L703","realm":"server","params":[{"type":"number","value":"number cost The total cost of the path to set. (>= 0)","name":"cost","description":"The total cost of the path to set. (>= 0)"}],"class":"function","name":"setTotalCost","description":" Sets the total cost when passing from starting area to the goal area through this node."},"computeDirection":{"path":"libs_sv/navmesh.lua#L313","returns":[{"type":"number","value":"number The direction the vector is in relation to this NavArea. See NAV_DIR enums","description":"The direction the vector is in relation to this NavArea. See NAV_DIR enums"}],"realm":"server","params":[{"type":"Vector","value":"Vector pos The position to compute direction towards.","name":"pos","description":"The position to compute direction towards."}],"class":"function","name":"computeDirection","description":" Returns the NAV_DIR direction that the given vector faces on this NavArea."},"getRandomPoint":{"path":"libs_sv/navmesh.lua#L511","returns":[{"type":"Vector","value":"Vector The random point on the nav area.","description":"The random point on the nav area."}],"realm":"server","class":"function","name":"getRandomPoint","description":" Returns a random point on the nav area."},"placeOnGround":{"path":"libs_sv/navmesh.lua#L636","realm":"server","params":[{"type":"number","value":"number corner The corner(s) to drop, uses NAV_CORNER enums","name":"corner","description":"The corner(s) to drop, uses NAV_CORNER enums"}],"class":"function","name":"placeOnGround","description":" Drops a corner or all corners of a CNavArea to the ground below it."},"connectTo":{"path":"libs_sv/navmesh.lua#L754","realm":"server","params":[{"type":"NavArea","value":"NavArea other The CNavArea this area leads to.","name":"other","description":"The CNavArea this area leads to."}],"class":"function","name":"connectTo","description":" Connects this CNavArea to another CNavArea with a one way connection. ( From this area to the target )"},"setPlace":{"path":"libs_sv/navmesh.lua#L695","returns":[{"type":"boolean","value":"boolean True if operation succeeded, false otherwise.","description":"True if operation succeeded, false otherwise."}],"realm":"server","params":[{"type":"string?","value":"string? place Place to set. Leave as nil to remove place from NavArea","name":"place","description":"Place to set. Leave as nil to remove place from NavArea"}],"class":"function","name":"setPlace","description":" Sets the Place of the nav area.\n There is a limit of 256 Places per nav file"},"setCorner":{"path":"libs_sv/navmesh.lua#L672","realm":"server","params":[{"type":"number","value":"number corner The corner to set, uses NAV_CORNER enums","name":"corner","description":"The corner to set, uses NAV_CORNER enums"},{"type":"Vector","value":"Vector pos The new position to set.","name":"pos","description":"The new position to set."}],"class":"function","name":"setCorner","description":" Sets the position of a corner of a nav area."},"getIncomingConnections":{"path":"libs_sv/navmesh.lua#L452","returns":[{"type":"table","value":"table Table of all CNavAreas with one-way connection to this CNavArea.","description":"Table of all CNavAreas with one-way connection to this CNavArea."}],"realm":"server","class":"function","name":"getIncomingConnections","description":" Returns a table of all the CNavAreas that have a one-way connection to this CNavArea.\n If a CNavArea has a two-way connection to or from this CNavArea then it will not be returned from this function, use CNavArea:GetAdjacentAreas to get outgoing ( one and two way ) connections.\n See CNavArea:getIncomingConnectionsAtSide for a function that returns one-way incoming connections from only one side/direction."},"isOpenListEmpty":{"path":"libs_sv/navmesh.lua#L248","returns":[{"type":"boolean","value":"boolean Whether the Open List is empty or not.","description":"Whether the Open List is empty or not."}],"realm":"server","class":"function","name":"isOpenListEmpty","description":" Returns whether the Open List is empty or not.\n Used in pathfinding via the A* algorithm.\n More information can be found here: https://wiki.facepunch.com/gmod/Simple_Pathfinding"},"getParent":{"path":"libs_sv/navmesh.lua#L481","returns":[{"type":"NavArea","value":"NavArea The parent NavArea","description":"The parent NavArea"}],"realm":"server","class":"function","name":"getParent","description":" Returns the parent NavArea"},"getIncomingConnectionsAtSide":{"path":"libs_sv/navmesh.lua#L465","returns":[{"type":"table","value":"table Table of all CNavAreas with one-way connection to this CNavArea from given direction.","description":"Table of all CNavAreas with one-way connection to this CNavArea from given direction."}],"realm":"server","params":[{"type":"number","value":"number navDir The direction, from which to look for CNavAreas, see NAV_DIR enums.","name":"navDir","description":"The direction, from which to look for CNavAreas, see NAV_DIR enums."}],"class":"function","name":"getIncomingConnectionsAtSide","description":" Returns a table of all the CNavAreas that have a one-way connection to this CNavArea from given direction.\n If a CNavArea has a two-way connection to or from this CNavArea then it will not be returned from this function, use CNavArea:getAdjacentAreas to get outgoing ( one and two way ) connections.\n See CNavArea:getIncomingConnections for a function that returns one-way incoming connections from all sides/directions."},"isValid":{"path":"libs_sv/navmesh.lua#L257","returns":[{"type":"boolean","value":"boolean Whether this NavArea is valid or not","description":"Whether this NavArea is valid or not"}],"realm":"server","class":"function","name":"isValid","description":" Returns whether this NavArea is valid or not."},"isConnected":{"path":"libs_sv/navmesh.lua#L286","returns":[{"type":"boolean","value":"boolean Whether this NavArea has an outgoing ( one or two way ) connection to given NavArea.","description":"Whether this NavArea has an outgoing ( one or two way ) connection to given NavArea."}],"realm":"server","params":[{"type":"NavArea","value":"NavArea other The other NavArea to check for connection to.","name":"other","description":"The other NavArea to check for connection to."}],"class":"function","name":"isConnected","description":" Returns whether this NavArea has an outgoing ( one or two way ) connection to given NavArea.\n See NavArea:isConnectedAtSide for a function that only checks for outgoing connections in one direction."},"isFlat":{"path":"libs_sv/navmesh.lua#L279","returns":[{"type":"boolean","value":"boolean Whether this NavArea is mostly flat.","description":"Whether this NavArea is mostly flat."}],"realm":"server","class":"function","name":"isFlat","description":" Returns whether this Nav Area is flat within the tolerance of the nav_coplanar_slope_limit_displacement and nav_coplanar_slope_limit convars."},"setCostSoFar":{"path":"libs_sv/navmesh.lua#L680","realm":"server","params":[{"type":"number","value":"number cost The cost so far","name":"cost","description":"The cost so far"}],"class":"function","name":"setCostSoFar","description":" Sets the cost from starting area this area when pathfinding."},"removeFromClosedList":{"path":"libs_sv/navmesh.lua#L660","realm":"server","class":"function","name":"removeFromClosedList","description":" Removes the given NavArea from the Closed List"},"remove":{"path":"libs_sv/navmesh.lua#L652","realm":"server","class":"function","name":"remove","description":" Removes the given NavArea."},"isCompletelyVisible":{"path":"libs_sv/navmesh.lua#L575","returns":[{"type":"boolean","value":"boolean Whether this CNavArea can see the given CNavArea.","description":"Whether this CNavArea can see the given CNavArea."}],"realm":"server","params":[{"type":"NavArea","value":"NavArea area The area to test visibility with.","name":"area","description":"The area to test visibility with."}],"class":"function","name":"isCompletelyVisible","description":" Returns whether this CNavArea can completely (i.e. all corners of this area can see all corners of the given area) see the given CNavArea."},"getExtentInfo":{"path":"libs_sv/navmesh.lua#L433","returns":[{"type":"table","value":"table Struct containing the above keys","description":"Struct containing the above keys"}],"realm":"server","class":"function","name":"getExtentInfo","description":" Returns size info about the nav area.\n Vector hi\n Vector lo\n number SizeX\n number SizeY\n number SizeZ"},"popOpenList":{"path":"libs_sv/navmesh.lua#L643","returns":[{"type":"NavArea","value":"NavArea The CNavArea from the Open List with the lowest cost to traverse to from the starting node.","description":"The CNavArea from the Open List with the lowest cost to traverse to from the starting node."}],"realm":"server","class":"function","name":"popOpenList","description":" Removes a CNavArea from the Open List with the lowest cost to traverse to from the starting node, and returns it.\n Requires the `navarea.openlist` permission"},"isVisible":{"path":"libs_sv/navmesh.lua#L626","returns":[{"type":"boolean","value":"boolean Whether we can be seen or not.","description":"Whether we can be seen or not."},{"type":"Vector","value":"Vector If we can be seen, this is returned with either the center or one of the corners of the Nav Area.","description":"If we can be seen, this is returned with either the center or one of the corners of the Nav Area."}],"realm":"server","params":[{"type":"Vector","value":"Vector pos The position to check.","name":"pos","description":"The position to check."}],"class":"function","name":"isVisible","description":" Returns whether we can be seen from the given position."},"getID":{"path":"libs_sv/navmesh.lua#L445","returns":[{"type":"number","value":"number The unique ID.","description":"The unique ID."}],"realm":"server","class":"function","name":"getID","description":" Returns this CNavAreas unique ID."},"isBlocked":{"path":"libs_sv/navmesh.lua#L556","returns":[{"type":"boolean","value":"boolean Whether the area is blocked or not","description":"Whether the area is blocked or not"}],"realm":"server","params":[{"type":"number?","value":"number? teamID The team ID to test, -2 = any team. Only 2 actual teams are available, 0 and 1. (Default -2)","name":"teamID","description":"The team ID to test, -2 = any team. Only 2 actual teams are available, 0 and 1. (Default -2)"},{"type":"boolean?","value":"boolean? ignoreNavBlockers Whether to ignore func_nav_blocker entities. (Default false)","name":"ignoreNavBlockers","description":"Whether to ignore func_nav_blocker entities. (Default false)"}],"class":"function","name":"isBlocked","description":" Returns whether the nav area is blocked or not, i.e. whether it can be walked through or not."},"isUnderwater":{"path":"libs_sv/navmesh.lua#L264","returns":[{"type":"boolean","value":"boolean Whether we're underwater or not.","description":"Whether we're underwater or not."}],"realm":"server","class":"function","name":"isUnderwater","description":" Whether this NavArea is placed underwater."},"isOverlappingArea":{"path":"libs_sv/navmesh.lua#L594","returns":[{"type":"boolean","value":"boolean True if the given CNavArea overlaps this CNavArea at any point.","description":"True if the given CNavArea overlaps this CNavArea at any point."}],"realm":"server","params":[{"type":"NavArea","value":"NavArea area The area to test.","name":"area","description":"The area to test."}],"class":"function","name":"isOverlappingArea","description":" Returns true if this CNavArea is overlapping the given CNavArea."},"getExposedSpots":{"path":"libs_sv/navmesh.lua#L421","returns":[{"type":"table","value":"table A table of Vectors","description":"A table of Vectors"}],"realm":"server","class":"function","name":"getExposedSpots","description":" Returns a table of very bad hiding spots in this area.\n See also NavArea:getHidingSpots"},"isPotentiallyVisible":{"path":"libs_sv/navmesh.lua#L611","returns":[{"type":"boolean","value":"boolean Whether the given area is visible from this area","description":"Whether the given area is visible from this area"}],"realm":"server","params":[{"type":"NavArea","value":"NavArea area The area to test.","name":"area","description":"The area to test."}],"class":"function","name":"isPotentiallyVisible","description":" Returns whether this CNavArea can potentially see the given CNavArea."},"setAttributes":{"path":"libs_sv/navmesh.lua#L665","realm":"server","params":[{"type":"number","value":"number attributes The attribute bitflag. See NAV_MESH enums","name":"attributes","description":"The attribute bitflag. See NAV_MESH enums"}],"class":"function","name":"setAttributes","description":" Sets the attributes for given CNavArea."},"getRandomAdjacentAreaAtSide":{"path":"libs_sv/navmesh.lua#L502","returns":[{"type":"NavArea","value":"NavArea The random CNavArea that has an outgoing ( one or two way ) connection from this CNavArea in given direction, if any.","description":"The random CNavArea that has an outgoing ( one or two way ) connection from this CNavArea in given direction, if any."}],"realm":"server","params":[{"type":"number","value":"number navDir The direction, from which to look for CNavAreas, see NAV_DIR enums.","name":"navDir","description":"The direction, from which to look for CNavAreas, see NAV_DIR enums."}],"class":"function","name":"getRandomAdjacentAreaAtSide","description":" Returns a random CNavArea that has an outgoing ( one or two way ) connection from this CNavArea in given direction."},"isRoughlySquare":{"path":"libs_sv/navmesh.lua#L619","returns":[{"type":"boolean","value":"boolean If we're a square or not.","description":"If we're a square or not."}],"realm":"server","class":"function","name":"isRoughlySquare","description":" Returns if we're shaped like a square."},"contains":{"path":"libs_sv/navmesh.lua#L271","returns":[{"type":"boolean","value":"boolean If the vector is inside the area","description":"If the vector is inside the area"}],"realm":"server","params":[{"type":"Vector","value":"Vector v The position to check","name":"v","description":"The position to check"}],"class":"function","name":"contains","description":" Returns true if this NavArea contains the given vector."},"getZ":{"path":"libs_sv/navmesh.lua#L539","returns":[{"type":"number","value":"number Elevation","description":"Elevation"}],"realm":"server","params":[{"type":"Vector","value":"Vector The position to get the elevation from, the z value from this position is ignored and only the X and Y values are used to this task.","name":"The","description":"position to get the elevation from, the z value from this position is ignored and only the X and Y values are used to this task."}],"class":"function","name":"getZ","description":" Returns the elevation of this Nav Area at the given position."},"isCoplanar":{"path":"libs_sv/navmesh.lua#L305","returns":[{"type":"boolean","value":"boolean Whether we're coplanar or not.","description":"Whether we're coplanar or not."}],"realm":"server","params":[{"type":"NavArea","value":"NavArea other The other NavArea to check against","name":"other","description":"The other NavArea to check against"}],"class":"function","name":"isCoplanar","description":" Returns whether this Nav Area is in the same plane as the given one."},"getAdjacentCount":{"path":"libs_sv/navmesh.lua#L365","returns":[{"type":"number","value":"number The amount of CNavAreas that have a connection ( one and two way ) from this CNavArea.","description":"The amount of CNavAreas that have a connection ( one and two way ) from this CNavArea."}],"realm":"server","class":"function","name":"getAdjacentCount","description":" Returns the amount of CNavAreas that have a connection ( one and two way ) from this CNavArea.\n See CNavArea:GetAdjacentCountAtSide for a function that only returns area count from one side/direction."},"computeAdjacentConnectionHeightChange":{"path":"libs_sv/navmesh.lua#L329","returns":[{"type":"number","value":"number The height change","description":"The height change"}],"realm":"server","params":[{"type":"NavArea","value":"NavArea other The nav area to test against.","name":"other","description":"The nav area to test against."}],"class":"function","name":"computeAdjacentConnectionHeightChange","description":" Returns the height difference between the edges of two connected navareas."},"isOverlapping":{"path":"libs_sv/navmesh.lua#L583","returns":[{"type":"number","value":"number Whether the given position overlaps the NavArea or not.","description":"Whether the given position overlaps the NavArea or not."}],"realm":"server","params":[{"type":"Vector","value":"Vector pos The position to test.","name":"pos","description":"The position to test."},{"type":"number?","value":"number? tolerance The tolerance of the overlapping, set to 0 for no tolerance. (Default 0)","name":"tolerance","description":"The tolerance of the overlapping, set to 0 for no tolerance. (Default 0)"}],"class":"function","name":"isOverlapping","description":" Returns if this position overlaps the NavArea within the given tolerance."},"isPartiallyVisible":{"path":"libs_sv/navmesh.lua#L602","returns":[{"type":"boolean","value":"boolean Whether the given position is visible from this area","description":"Whether the given position is visible from this area"}],"realm":"server","params":[{"type":"Vector","value":"Vector pos The position to test.","name":"pos","description":"The position to test."},{"type":"Entity?","value":"Entity? ignoreEnt If set, the given entity will be ignored when doing LOS tests (Default NULL)","name":"ignoreEnt","description":"If set, the given entity will be ignored when doing LOS tests (Default NULL)"}],"class":"function","name":"isPartiallyVisible","description":" Returns whether this CNavArea can see given position."},"getAdjacentAreasAtSide":{"path":"libs_sv/navmesh.lua#L350","returns":[{"type":"table","value":"table A table of all CNavArea that have a ( one and two way ) connection from this CNavArea in given direction.","description":"A table of all CNavArea that have a ( one and two way ) connection from this CNavArea in given direction."}],"realm":"server","params":[{"type":"number","value":"number navDir The direction, in which to look for CNavAreas, see NAV_DIR enums","name":"navDir","description":"The direction, in which to look for CNavAreas, see NAV_DIR enums"}],"class":"function","name":"getAdjacentAreasAtSide","description":" Returns a table of all the CNavAreas that have a ( one and two way ) connection from this CNavArea in given direction.\n If an area has a one-way incoming connection to this CNavArea, then it will not be returned from this function, use CNavArea:GetIncomingConnections to get all incoming connections.\n See CNavArea:getAdjacentAreas for a function that returns all areas from all sides/directions."},"getAdjacentCountAtSide":{"path":"libs_sv/navmesh.lua#L373","returns":[{"type":"number","value":"number The amount of CNavAreas that have a connection ( one or two way ) from this CNavArea in given direction.","description":"The amount of CNavAreas that have a connection ( one or two way ) from this CNavArea in given direction."}],"realm":"server","params":[{"type":"number","value":"number The direction, in which to look for CNavAreas, see NAV_DIR enums.","name":"The","description":"direction, in which to look for CNavAreas, see NAV_DIR enums."}],"class":"function","name":"getAdjacentCountAtSide","description":" Returns the amount of CNavAreas that have a connection ( one or two way ) from this CNavArea in given direction.\n See CNavArea:getAdjacentCount for a function that returns CNavArea count from/in all sides/directions."},"isClosed":{"path":"libs_sv/navmesh.lua#L568","returns":[{"type":"boolean","value":"boolean Whether this node is in the Closed List.","description":"Whether this node is in the Closed List."}],"realm":"server","class":"function","name":"isClosed","description":" Returns whether this node is in the Closed List."},"getTotalCost":{"path":"libs_sv/navmesh.lua#L532","returns":[{"type":"number","value":"number The total cost","description":"The total cost"}],"realm":"server","class":"function","name":"getTotalCost","description":" Returns the total cost when passing from starting area to the goal area through this node. Set by NavArea:setTotalCost."},"getPlace":{"path":"libs_sv/navmesh.lua#L495","returns":[{"type":"string","value":"string The place of the nav area, or no value if it doesn't have a place set.","description":"The place of the nav area, or no value if it doesn't have a place set."}],"realm":"server","class":"function","name":"getPlace","description":" Returns the place of the NavArea"},"getSizeY":{"path":"libs_sv/navmesh.lua#L525","returns":[{"type":"number","value":"number Height","description":"Height"}],"realm":"server","class":"function","name":"getSizeY","description":" Returns the height this Nav Area."},"getCostSoFar":{"path":"libs_sv/navmesh.lua#L414","returns":[{"type":"number","value":"number The cost so far.","description":"The cost so far."}],"realm":"server","class":"function","name":"getCostSoFar","description":" Returns the cost from starting area this area when pathfinding. Set by NavArea:setCostSoFar"}},"class":"type","name":"NavArea","description":" NavArea type, returned by navmesh library functions"},"NextBot":{"path":"libs_sv/nextbot.lua#L4","libtbl":["nb_methods","nb_meta"],"realm":"server","methods":{"removeApproachPos":{"path":"libs_sv/nextbot.lua#L132","realm":"server","class":"function","name":"removeApproachPos","description":" Removes the \"approach\" position from the NextBot."},"setRunAct":{"path":"libs_sv/nextbot.lua#L207","realm":"server","params":[{"type":"number","value":"number runact The activity the nextbot will use.","name":"runact","description":"The activity the nextbot will use."}],"class":"function","name":"setRunAct","description":" Sets the activity the nextbot uses for running."},"setVelocity":{"path":"libs_sv/nextbot.lua#L247","realm":"server","params":[{"type":"Vector","value":"Vector newvel Velocity.","name":"newvel","description":"Velocity."}],"class":"function","name":"setVelocity","description":" Sets the nextbot's velocity. Seems to work only when used if nextbot is in air after using nextbot:jump()"},"setJumpGapsAllowed":{"path":"libs_sv/nextbot.lua#L650","realm":"server","params":[{"type":"boolean","value":"boolean jumpgapsallowed Whether this bot should be allowed to jump gaps.","name":"jumpgapsallowed","description":"Whether this bot should be allowed to jump gaps."}],"class":"function","name":"setJumpGapsAllowed","description":" Sets whether the Nextbot is allowed to jump gaps or not. This is used during path generation. Works similarly to nb_allow_gap_jumping convar. By default bots are allowed to jump gaps."},"getRunAct":{"path":"libs_sv/nextbot.lua#L219","returns":[{"type":"number","value":"number The run activity.","description":"The run activity."}],"realm":"server","class":"function","name":"getRunAct","description":" Gets the activity the nextbot uses for running."},"setStepHeight":{"path":"libs_sv/nextbot.lua#L569","realm":"server","params":[{"type":"number","value":"number stepheight Height (default is 18)","name":"stepheight","description":"Height (default is 18)"}],"class":"function","name":"setStepHeight","description":" Sets the max height the bot can step up."},"removeGotoPos":{"path":"libs_sv/nextbot.lua#L160","realm":"server","class":"function","name":"removeGotoPos","description":" Removes the \"go to\" position from the NextBot."},"getMaxYawRate":{"path":"libs_sv/nextbot.lua#L515","realm":"server","params":[{"type":"number","value":"number The NextBot's max yaw rate.","name":"The","description":"NextBot's max yaw rate."}],"class":"function","name":"getMaxYawRate","description":" Gets the max rate at which the NextBot can visually rotate."},"getDeathDropHeight":{"path":"libs_sv/nextbot.lua#L561","returns":[{"type":"number","value":"number Height nextbot is afraid of.","description":"Height nextbot is afraid of."}],"realm":"server","class":"function","name":"getDeathDropHeight","description":" Gets the height the nextbot is scared to fall from."},"playSequence":{"path":"libs_sv/nextbot.lua#L179","realm":"server","params":[{"type":"string","value":"string seqtoplay The name of the sequence to play.","name":"seqtoplay","description":"The name of the sequence to play."}],"class":"function","name":"playSequence","description":" Makes the nextbot play a sequence. This takes priority over movement. Will go to set pos after animation plays."},"removeDeathCallback":{"path":"libs_sv/nextbot.lua#L308","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID of the callback to remove.","name":"callbackid","description":"The unique ID of the callback to remove."}],"class":"function","name":"removeDeathCallback","description":" Removes a death callback function from the NextBot."},"setGravity":{"path":"libs_sv/nextbot.lua#L541","realm":"server","params":[{"type":"number","value":"number newgravity NB's new gravity. Default is 1000","name":"newgravity","description":"NB's new gravity. Default is 1000"}],"class":"function","name":"setGravity","description":" Sets the gravity of the NextBot."},"addLeaveGroundCallback":{"path":"libs_sv/nextbot.lua#L362","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID this callback will use.","name":"callbackid","description":"The unique ID this callback will use."},{"type":"function","value":"function callback The function to run when the NB leaves the ground. The arguments are: (The entity the NB \"jumped\" from.)","name":"callback","description":"The function to run when the NB leaves the ground. The arguments are: (The entity the NB \"jumped\" from.)"}],"class":"function","name":"addLeaveGroundCallback","description":" Adds a callback function that will be run when this nextbot leaves the ground."},"addInjuredCallback":{"path":"libs_sv/nextbot.lua#L318","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID this callback will use.","name":"callbackid","description":"The unique ID this callback will use."},{"type":"function","value":"function callback The function to run when the NB gets injured. The arguments are: (Damage, Attacker, Inflictor, Damage Pos, Damage Force, Damage Type)","name":"callback","description":"The function to run when the NB gets injured. The arguments are: (Damage, Attacker, Inflictor, Damage Pos, Damage Force, Damage Type)"}],"class":"function","name":"addInjuredCallback","description":" Adds a callback function that will be run when this nextbot is injured."},"removeNavChangeCallback":{"path":"libs_sv/nextbot.lua#L418","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID of the callback to remove.","name":"callbackid","description":"The unique ID of the callback to remove."}],"class":"function","name":"removeNavChangeCallback","description":" Removes a nav area change callback function from the NextBot."},"jumpAcrossGap":{"path":"libs_sv/nextbot.lua#L686","realm":"server","params":[{"type":"Vector","value":"Vector landGoal The goal the nextbot should aim for.","name":"landGoal","description":"The goal the nextbot should aim for."},{"type":"Vector","value":"Vector landForward Presumably the direction vector the entity should be aiming in when landing.","name":"landForward","description":"Presumably the direction vector the entity should be aiming in when landing."}],"class":"function","name":"jumpAcrossGap","description":" Makes the bot jump across a gap. The bot must be on ground (Entity:isOnGround). Its model must have the ACT_JUMP activity for proper animation."},"addDeathCallback":{"path":"libs_sv/nextbot.lua#L296","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID this callback will use.","name":"callbackid","description":"The unique ID this callback will use."},{"type":"function","value":"function callback The function to run when the NB dies. The arguments are: (Damage, Attacker, Inflictor, Damage Pos, Damage Force, Damage Type)","name":"callback","description":"The function to run when the NB dies. The arguments are: (Damage, Attacker, Inflictor, Damage Pos, Damage Force, Damage Type)"}],"class":"function","name":"addDeathCallback","description":" Adds a callback function that will be run when this nextbot dies."},"setGotoPos":{"path":"libs_sv/nextbot.lua#L151","realm":"server","params":[{"type":"Vector","value":"Vector gotopos The position the nextbot will continuosly try to go to.","name":"gotopos","description":"The position the nextbot will continuosly try to go to."}],"class":"function","name":"setGotoPos","description":" Makes the nextbot try to go to a specified position using navmesh pathfinding."},"getVelocity":{"path":"libs_sv/nextbot.lua#L256","returns":[{"type":"Vector","value":"Vector NB's velocity.","description":"NB's velocity."}],"realm":"server","class":"function","name":"getVelocity","description":" Gets the nextbot's velocity as a vector."},"getAvoidAllowed":{"path":"libs_sv/nextbot.lua#L624","returns":[{"type":"boolean","value":"boolean Whether this bot is allowed to try to avoid obstacles.","description":"Whether this bot is allowed to try to avoid obstacles."}],"realm":"server","class":"function","name":"getAvoidAllowed","description":" Returns whether the Nextbot is allowed to avoid obstacles or not."},"isAreaTraversable":{"path":"libs_sv/nextbot.lua#L603","returns":[{"type":"boolean","value":"boolean Whether this nextbot can traverse given NavArea.","description":"Whether this nextbot can traverse given NavArea."}],"realm":"server","params":[{"type":"NavArea","value":"NavArea NavArea to check.","name":"NavArea","description":"to check."}],"class":"function","name":"isAreaTraversable","description":" Returns whether this nextbot can reach and/or traverse/move in given NavArea."},"getJumpGapsAllowed":{"path":"libs_sv/nextbot.lua#L660","returns":[{"type":"boolean","value":"boolean Whether this bot is allowed to jump gaps.","description":"Whether this bot is allowed to jump gaps."}],"realm":"server","class":"function","name":"getJumpGapsAllowed","description":" Returns whether the Nextbot is allowed to jump gaps or not."},"getGravity":{"path":"libs_sv/nextbot.lua#L533","returns":[{"type":"number","value":"number The nextbot's current gravity value.","description":"The nextbot's current gravity value."}],"realm":"server","class":"function","name":"getGravity","description":" Gets the gravity of the NextBot."},"getClimbAllowed":{"path":"libs_sv/nextbot.lua#L642","returns":[{"type":"boolean","value":"boolean Whether this bot is allowed to climb.","description":"Whether this bot is allowed to climb."}],"realm":"server","class":"function","name":"getClimbAllowed","description":" Returns whether the Nextbot is allowed to climb or not."},"setClimbAllowed":{"path":"libs_sv/nextbot.lua#L632","realm":"server","params":[{"type":"boolean","value":"boolean climballowed Whether this bot should be allowed to climb.","name":"climballowed","description":"Whether this bot should be allowed to climb."}],"class":"function","name":"setClimbAllowed","description":" Sets whether the Nextbot is allowed to climb or not. This is used during path generation. Works similarly to nb_allow_climbing convar. By default bots are allowed to climb."},"setAvoidAllowed":{"path":"libs_sv/nextbot.lua#L614","realm":"server","params":[{"type":"boolean","value":"boolean avoidallowed Whether this bot should be allowed to try to avoid obstacles.","name":"avoidallowed","description":"Whether this bot should be allowed to try to avoid obstacles."}],"class":"function","name":"setAvoidAllowed","description":" Sets whether the Nextbot is allowed try to to avoid obstacles or not. This is used during path generation. Works similarly to nb_allow_avoiding convar. By default bots are allowed to try to avoid obstacles."},"addLandCallback":{"path":"libs_sv/nextbot.lua#L340","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID this callback will use.","name":"callbackid","description":"The unique ID this callback will use."},{"type":"function","value":"function callback The function to run when the NB lands on the ground. The arguments are: (The entity the NB landed on.)","name":"callback","description":"The function to run when the NB lands on the ground. The arguments are: (The entity the NB landed on.)"}],"class":"function","name":"addLandCallback","description":" Adds a callback function that will be run when this nextbot lands on the ground."},"setJumpHeight":{"path":"libs_sv/nextbot.lua#L668","realm":"server","params":[{"type":"number","value":"number jumpheight Height (default is 58)","name":"jumpheight","description":"Height (default is 58)"}],"class":"function","name":"setJumpHeight","description":" Sets the height of the bot's jump"},"isOnGround":{"path":"libs_sv/nextbot.lua#L595","returns":[{"type":"boolean","value":"boolean Whether the nextbot is on ground or not.","description":"Whether the nextbot is on ground or not."}],"realm":"server","class":"function","name":"isOnGround","description":" Returns whether the nextbot this locomotion is attached to is on ground or not."},"addNavChangeCallback":{"path":"libs_sv/nextbot.lua#L406","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID this callback will use.","name":"callbackid","description":"The unique ID this callback will use."},{"type":"function","value":"function callback The function to run when the NB enters a new nav area. The arguments are: (Old Nav Area, New Nav Area)","name":"callback","description":"The function to run when the NB enters a new nav area. The arguments are: (Old Nav Area, New Nav Area)"}],"class":"function","name":"addNavChangeCallback","description":" Adds a callback function that will be run when the nextbot enters a new nav area."},"getGroundMotionVector":{"path":"libs_sv/nextbot.lua#L587","returns":[{"type":"Vector","value":"Vector A vector representing the X and Y movement.","description":"A vector representing the X and Y movement."}],"realm":"server","class":"function","name":"getGroundMotionVector","description":" Return unit vector in XY plane describing our direction of motion - even if we are currently not moving"},"getJumpHeight":{"path":"libs_sv/nextbot.lua#L678","returns":[{"type":"number","value":"number Jump height","description":"Jump height"}],"realm":"server","class":"function","name":"getJumpHeight","description":" Gets the height of the bot's jump"},"setDeathDropHeight":{"path":"libs_sv/nextbot.lua#L551","realm":"server","params":[{"type":"number","value":"number newdeathdropheight New height nextbot is afraid of. Default is 200.","name":"newdeathdropheight","description":"New height nextbot is afraid of. Default is 200."}],"class":"function","name":"setDeathDropHeight","description":" Sets the height the nextbot is scared to fall from."},"addIgniteCallback":{"path":"libs_sv/nextbot.lua#L384","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID this callback will use.","name":"callbackid","description":"The unique ID this callback will use."},{"type":"function","value":"function callback The function to run when the NB gets ignited.","name":"callback","description":"The function to run when the NB gets ignited."}],"class":"function","name":"addIgniteCallback","description":" Adds a callback function that will be run when this nextbot gets ignited."},"setMaxYawRate":{"path":"libs_sv/nextbot.lua#L523","realm":"server","params":[{"type":"number","value":"number newmaxyawrate Desired new maximum yaw rate","name":"newmaxyawrate","description":"Desired new maximum yaw rate"}],"class":"function","name":"setMaxYawRate","description":" Sets the max rate at which the NextBot can visually rotate. This will not affect moving or pathing."},"getDeceleration":{"path":"libs_sv/nextbot.lua#L507","returns":[{"type":"number","value":"number NB's deceleration value.","description":"NB's deceleration value."}],"realm":"server","class":"function","name":"getDeceleration","description":" Gets the deceleration speed of the NextBot."},"ragdollOnDeath":{"path":"libs_sv/nextbot.lua#L450","realm":"server","params":[{"type":"boolean","value":"boolean ragdollondeath Whether the nextbot should ragdoll on death.","name":"ragdollondeath","description":"Whether the nextbot should ragdoll on death."}],"class":"function","name":"ragdollOnDeath","description":" Enable or disable ragdolling on death for the NextBot."},"setDeceleration":{"path":"libs_sv/nextbot.lua#L497","realm":"server","params":[{"type":"number","value":"number newaccel NB's new deceleration. Default is 400","name":"newaccel","description":"NB's new deceleration. Default is 400"}],"class":"function","name":"setDeceleration","description":" Sets the deceleration speed of the NextBot."},"removeInjuredCallback":{"path":"libs_sv/nextbot.lua#L330","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID of the callback to remove.","name":"callbackid","description":"The unique ID of the callback to remove."}],"class":"function","name":"removeInjuredCallback","description":" Removes a injury callback function from the NextBot."},"getMoveSpeed":{"path":"libs_sv/nextbot.lua#L471","returns":[{"type":"number","value":"number NB's move speed.","description":"NB's move speed."}],"realm":"server","class":"function","name":"getMoveSpeed","description":" Gets the move speed of the NextBot."},"setMoveSpeed":{"path":"libs_sv/nextbot.lua#L460","realm":"server","params":[{"type":"number","value":"number newmovespeed NB's new move speed. Default is 200.","name":"newmovespeed","description":"NB's new move speed. Default is 200."}],"class":"function","name":"setMoveSpeed","description":" Sets the move speed of the NextBot."},"getAcceleration":{"path":"libs_sv/nextbot.lua#L489","returns":[{"type":"number","value":"number NB's acceleration value.","description":"NB's acceleration value."}],"realm":"server","class":"function","name":"getAcceleration","description":" Gets the acceleration speed of the NextBot."},"faceTowards":{"path":"libs_sv/nextbot.lua#L198","realm":"server","params":[{"type":"Vector","value":"Vector facepos Position to face towards.","name":"facepos","description":"Position to face towards."}],"class":"function","name":"faceTowards","description":" Makes the nextbot face towards a specified position. Has to be called continuously to be effective."},"removeIgniteCallback":{"path":"libs_sv/nextbot.lua#L396","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID of the callback to remove.","name":"callbackid","description":"The unique ID of the callback to remove."}],"class":"function","name":"removeIgniteCallback","description":" Removes a ignite callback function from the NextBot."},"jump":{"path":"libs_sv/nextbot.lua#L264","realm":"server","params":[{"type":"number?","value":"number? jumpAct The activity ID of the anim to play when jumping.","name":"jumpAct","description":"The activity ID of the anim to play when jumping."}],"class":"function","name":"jump","description":" Forces the nextbot to jump."},"setAcceleration":{"path":"libs_sv/nextbot.lua#L479","realm":"server","params":[{"type":"number","value":"number newaccel NB's new acceleration. Default is 400","name":"newaccel","description":"NB's new acceleration. Default is 400"}],"class":"function","name":"setAcceleration","description":" Sets the acceleration speed of the NextBot."},"setApproachPos":{"path":"libs_sv/nextbot.lua#L123","realm":"server","params":[{"type":"Vector","value":"Vector goal The vector we want to get to.","name":"goal","description":"The vector we want to get to."}],"class":"function","name":"setApproachPos","description":" Makes the nextbot try to go to a specified position without using navmesh pathfinding (in a straight line).\n setGotoPos takes priority."},"getApproachPos":{"path":"libs_sv/nextbot.lua#L140","returns":[{"type":"Vector?","value":"Vector? Where the nextbot is trying to go to if it exists, else returns nil.","description":"Where the nextbot is trying to go to if it exists, else returns nil."}],"realm":"server","class":"function","name":"getApproachPos","description":" Returns the Vector the nextbot is trying to go to, set by setApproachPos"},"addContactCallback":{"path":"libs_sv/nextbot.lua#L428","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID this callback will use.","name":"callbackid","description":"The unique ID this callback will use."},{"type":"function","value":"function callback The function to run when the NB touches another entity. The arguments are: (The entity the NB touched.)","name":"callback","description":"The function to run when the NB touches another entity. The arguments are: (The entity the NB touched.)"}],"class":"function","name":"addContactCallback","description":" Sets a callback function that will be run when this nextbot touches another entity. Only 1 per NB. Setting a new callback will replace the old one."},"removeContactCallback":{"path":"libs_sv/nextbot.lua#L440","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID of the callback to remove.","name":"callbackid","description":"The unique ID of the callback to remove."}],"class":"function","name":"removeContactCallback","description":" Removes the contact callback function from the NextBot if present."},"removeReachCallback":{"path":"libs_sv/nextbot.lua#L286","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID of the callback to remove.","name":"callbackid","description":"The unique ID of the callback to remove."}],"class":"function","name":"removeReachCallback","description":" Removes a reach callback function from the NextBot."},"startActivity":{"path":"libs_sv/nextbot.lua#L189","realm":"server","params":[{"type":"number","value":"number act The ACT enum to play.","name":"act","description":"The ACT enum to play."}],"class":"function","name":"startActivity","description":" Start doing an activity (animation)."},"removeLandCallback":{"path":"libs_sv/nextbot.lua#L352","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID of the callback to remove.","name":"callbackid","description":"The unique ID of the callback to remove."}],"class":"function","name":"removeLandCallback","description":" Removes a landing callback function from the NextBot."},"addReachCallback":{"path":"libs_sv/nextbot.lua#L274","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID this callback will use.","name":"callbackid","description":"The unique ID this callback will use."},{"type":"function","value":"function callback The function to run when the NB reaches its destination.","name":"callback","description":"The function to run when the NB reaches its destination."}],"class":"function","name":"addReachCallback","description":" Adds a callback function that will be run when this nextbot reaches a destination set by setApproachPos or setGotoPos."},"getStepHeight":{"path":"libs_sv/nextbot.lua#L579","returns":[{"type":"number","value":"number The max height the bot can step up.","description":"The max height the bot can step up."}],"realm":"server","class":"function","name":"getStepHeight","description":" Gets the max height the bot can step up."},"removeLeaveGroundCallback":{"path":"libs_sv/nextbot.lua#L374","realm":"server","params":[{"type":"string","value":"string callbackid The unique ID of the callback to remove.","name":"callbackid","description":"The unique ID of the callback to remove."}],"class":"function","name":"removeLeaveGroundCallback","description":" Removes a landing callback function from the NextBot."},"getGotoPos":{"path":"libs_sv/nextbot.lua#L168","returns":[{"type":"Vector?","value":"Vector? Where the nextbot is trying to go to if it exists, else returns nil.","description":"Where the nextbot is trying to go to if it exists, else returns nil."}],"realm":"server","class":"function","name":"getGotoPos","description":" Returns the Vector the nextbot is trying to go to, set by setGotoPos"},"getIdleAct":{"path":"libs_sv/nextbot.lua#L239","returns":[{"type":"number","value":"number The idle activity.","description":"The idle activity."}],"realm":"server","class":"function","name":"getIdleAct","description":" Gets the activity the nextbot uses for idling."},"setIdleAct":{"path":"libs_sv/nextbot.lua#L227","realm":"server","params":[{"type":"number","value":"number runact The activity the nextbot will use.","name":"runact","description":"The activity the nextbot will use."}],"class":"function","name":"setIdleAct","description":" Sets the activity the nextbot uses for idling."}},"class":"type","name":"NextBot","description":" NextBot type"},"Vector2":{"path":"libs_sv/wire.lua#L30","libtbl":["vec2_meta"],"realm":"server","methods":[],"class":"type","name":"Vector2","description":" Vector2 type for wire xv2"},"Vehicle":{"path":"libs_sh/vehicles.lua#L15","libtbl":["vehicle_methods","vehicle_meta"],"realm":"shared","methods":{"getDriver":{"path":"libs_sh/vehicles.lua#L42","returns":[{"type":"Player","value":"Player Driver of vehicle","description":"Driver of vehicle"}],"realm":"shared","class":"function","name":"getDriver","description":" Returns the driver of the vehicle"},"getPassenger":{"path":"libs_sh/vehicles.lua#L48","returns":[{"type":"Player","value":"Player The passenger or NULL if empty","description":"The passenger or NULL if empty"}],"realm":"shared","params":[{"type":"number","value":"number n The index of the passenger to get","name":"n","description":"The index of the passenger to get"}],"class":"function","name":"getPassenger","description":" Returns a passenger of a vehicle"},"ejectDriver":{"path":"libs_sh/vehicles.lua#L57","realm":"server","class":"function","name":"ejectDriver","description":" Ejects the driver of the vehicle"},"unlock":{"path":"libs_sh/vehicles.lua#L105","realm":"server","class":"function","name":"unlock","description":" Will unlock the vehicle."},"lock":{"path":"libs_sh/vehicles.lua#L94","realm":"server","class":"function","name":"lock","description":" Will lock the vehicle preventing players from entering or exiting the vehicle."},"killDriver":{"path":"libs_sh/vehicles.lua#L66","realm":"server","class":"function","name":"killDriver","description":" Kills the driver of the vehicle"},"stripDriver":{"path":"libs_sh/vehicles.lua#L77","realm":"server","params":[{"type":"string?","value":"string? class Optional weapon class to strip. Otherwise all are stripped.","name":"class","description":"Optional weapon class to strip. Otherwise all are stripped."}],"class":"function","name":"stripDriver","description":" Strips weapons of the driver"}},"class":"type","name":"Vehicle","description":" Vehicle type"},"Player":{"path":"libs_sh/players.lua#L81","libtbl":["player_methods"],"realm":"shared","methods":{"getShootPos":{"path":"libs_sh/players.lua#L294","returns":[{"type":"Vector","value":"Vector Shoot position","description":"Shoot position"}],"realm":"shared","class":"function","name":"getShootPos","description":" Returns the player's shoot position"},"shouldDrawLocalPlayer":{"path":"libs_sh/players.lua#L1134","returns":[{"type":"boolean","value":"boolean True if the player's playermodel is visible","description":"True if the player's playermodel is visible"}],"realm":"client","class":"function","name":"shouldDrawLocalPlayer","description":" Returns whether the player's player model will be drawn at the time the function is called."},"getVehicle":{"path":"libs_sh/players.lua#L308","returns":[{"type":"Vehicle","value":"Vehicle Vehicle if player in vehicle or nil","description":"Vehicle if player in vehicle or nil"}],"realm":"shared","class":"function","name":"getVehicle","description":" Returns the vehicle the player is driving"},"getAnimationProgress":{"path":"libs_sh/players.lua#L1112","returns":[{"type":"number","value":"number Progress ranging 0-1","description":"Progress ranging 0-1"}],"realm":"client","class":"function","name":"getAnimationProgress","description":" Gets the progress of the animation ranging 0-1"},"isPlayingAnimation":{"path":"libs_sh/players.lua#L1104","returns":[{"type":"boolean","value":"boolean If an animation is playing","description":"If an animation is playing"}],"realm":"client","class":"function","name":"isPlayingAnimation","description":" Gets whether a animation is playing"},"setAnimationRange":{"path":"libs_sh/players.lua#L1085","realm":"client","params":[{"type":"number","value":"number min Min. Ranging from 0-1","name":"min","description":"Min. Ranging from 0-1"},{"type":"number","value":"number max Max. Ranging from 0-1","name":"max","description":"Max. Ranging from 0-1"}],"class":"function","name":"setAnimationRange","description":" Sets the animation range"},"setWalkSpeed":{"path":"libs_sh/players.lua#L771","realm":"server","params":[{"type":"number","value":"number newwalkspeed New Walk speed.","name":"newwalkspeed","description":"New Walk speed."}],"class":"function","name":"setWalkSpeed","description":" Sets Walk Speed"},"getGroundEntity":{"path":"libs_sh/players.lua#L470","returns":[{"type":"Entity","value":"Entity Ground entity","description":"Ground entity"}],"realm":"shared","class":"function","name":"getGroundEntity","description":" Returns the entity that the player is standing on"},"setAnimationBounce":{"path":"libs_sh/players.lua#L1055","realm":"client","params":[{"type":"boolean","value":"boolean bounce Should the animation bounce instead of loop?","name":"bounce","description":"Should the animation bounce instead of loop?"}],"class":"function","name":"setAnimationBounce","description":" Sets the animation bounce"},"getTeam":{"path":"libs_sh/players.lua#L387","returns":[{"type":"number","value":"number Team Index, from TEAM enums or custom teams","description":"Team Index, from TEAM enums or custom teams"}],"realm":"shared","class":"function","name":"getTeam","description":" Returns the player's current team"},"setAnimationAutoAdvance":{"path":"libs_sh/players.lua#L1040","realm":"client","params":[{"type":"boolean","value":"boolean auto_advance Should the animation handle advancing itself?","name":"auto_advance","description":"Should the animation handle advancing itself?"}],"class":"function","name":"setAnimationAutoAdvance","description":" Sets the animation auto advance"},"getSteamID":{"path":"libs_sh/players.lua#L365","returns":[{"type":"string","value":"string SteamID","description":"SteamID"}],"realm":"shared","class":"function","name":"getSteamID","description":" Returns the player's SteamID"},"isMuted":{"path":"libs_sh/players.lua#L842","returns":[{"type":"boolean","value":"boolean True if the player was muted","description":"True if the player was muted"}],"realm":"client","class":"function","name":"isMuted","description":" Returns whether the local player has muted the player"},"isCrouching":{"path":"libs_sh/players.lua#L224","returns":[{"type":"boolean","value":"boolean True if player crouching","description":"True if player crouching"}],"realm":"shared","class":"function","name":"isCrouching","description":" Returns whether the player is crouching"},"setLadderClimbSpeed":{"path":"libs_sh/players.lua#L731","realm":"server","params":[{"type":"number","value":"number newladderclimbspeed New Ladder Climb speed.","name":"newladderclimbspeed","description":"New Ladder Climb speed."}],"class":"function","name":"setLadderClimbSpeed","description":" Sets Ladder Climb Speed, probably unstable"},"getMoney":{"path":"libs_sh/darkrp2.lua#L1076","returns":[{"type":"number?","value":"number? The amount of money, or nil if not accessible.","description":"The amount of money, or nil if not accessible."}],"realm":"shared","class":"function","name":"getMoney","description":" Get the amount of money this player has. DarkRP only.\n Equivalent to \"ply:getDarkRPVar('money')\""},"stripWeapon":{"path":"libs_sh/players.lua#L570","realm":"server","params":[{"type":"string","value":"string weapon The weapon class name of the weapon to strip","name":"weapon","description":"The weapon class name of the weapon to strip"}],"class":"function","name":"stripWeapon","description":" Strips the player's weapon"},"playGesture":{"path":"libs_sh/players.lua#L863","realm":"client","params":[{"type":"string|number","value":"string|number animation Sequence string or act number. https://wiki.facepunch.com/gmod/Enums/ACT","name":"animation","description":"Sequence string or act number. https://wiki.facepunch.com/gmod/Enums/ACT"},{"type":"boolean?","value":"boolean? loop Optional boolean (Default true), should the gesture loop","name":"loop","description":"Optional boolean (Default true), should the gesture loop"},{"type":"number?","value":"number? slot Optional int (Default GESTURE_SLOT.CUSTOM), the gesture slot to use. GESTURE_SLOT table values","name":"slot","description":"Optional int (Default GESTURE_SLOT.CUSTOM), the gesture slot to use. GESTURE_SLOT table values"},{"type":"number?","value":"number? weight Optional float (Default 1), the weight of the gesture. Ranging from 0-1","name":"weight","description":"Optional float (Default 1), the weight of the gesture. Ranging from 0-1"}],"class":"function","name":"playGesture","description":" Plays gesture animations on a player"},"getWalkSpeed":{"path":"libs_sh/players.lua#L196","returns":[{"type":"number","value":"number Walk Speed value","description":"Walk Speed value"}],"realm":"shared","class":"function","name":"getWalkSpeed","description":" Returns the players Walk Speed"},"isHitman":{"path":"libs_sh/darkrp2.lua#L1052","returns":[{"type":"boolean?","value":"boolean? Whether this player is a hitman. May be nil instead of false.","description":"Whether this player is a hitman. May be nil instead of false."}],"realm":"shared","class":"function","name":"isHitman","description":" Whether this player is a hitman. DarkRP only."},"setAnimationTime":{"path":"libs_sh/players.lua#L1010","realm":"client","params":[{"type":"number","value":"number time The time of the animation in seconds. Float","name":"time","description":"The time of the animation in seconds. Float"}],"class":"function","name":"setAnimationTime","description":" Sets the animation time"},"getJobTable":{"path":"libs_sh/darkrp2.lua#L1003","returns":[{"type":"table","value":"table Table with the job information.","description":"Table with the job information."}],"realm":"shared","class":"function","name":"getJobTable","description":" Get the job table of a player. DarkRP only."},"getWeaponColor":{"path":"libs_sh/players.lua#L452","returns":[{"type":"Vector","value":"Vector The color","description":"The color"}],"realm":"shared","class":"function","name":"getWeaponColor","description":" Returns a player's weapon color\n The part of the model that is colored is determined by the model itself, and is different for each model\n The format is Vector(r,g,b), and each color should be between 0 and 1"},"getAnimationTime":{"path":"libs_sh/players.lua#L1123","returns":[{"type":"number","value":"number Time in seconds","description":"Time in seconds"}],"realm":"client","class":"function","name":"getAnimationTime","description":" Gets the animation time"},"getViewPunchAngles":{"path":"libs_sh/players.lua#L430","returns":[{"type":"Angle","value":"Angle The angle of the view offset","description":"The angle of the view offset"}],"realm":"shared","class":"function","name":"getViewPunchAngles","description":" Returns the camera punch offset angle"},"isHUDActive":{"path":"libs_sh/players.lua#L526","returns":[{"type":"boolean","value":"boolean True if a HUD component is connected and active for the player, nil otherwise","description":"True if a HUD component is connected and active for the player, nil otherwise"}],"realm":"server","class":"function","name":"isHUDActive","description":" Checks if the player is connected to a HUD component that's linked to this chip"},"setAnimationActivity":{"path":"libs_sh/players.lua#L976","realm":"client","params":[{"type":"number|string|nil","value":"number|string|nil activity Activity, nil to use the current animation sequence","name":"activity","description":"Activity, nil to use the current animation sequence"}],"class":"function","name":"setAnimationActivity","description":" Sets the animation activity"},"isWalking":{"path":"libs_sh/players.lua#L501","returns":[{"type":"boolean","value":"boolean Whether they are walking","description":"Whether they are walking"}],"realm":"shared","class":"function","name":"isWalking","description":" Returns whether the player is walking\n In singleplayer, this will return false clientside"},"isSuperAdmin":{"path":"libs_sh/players.lua#L336","returns":[{"type":"boolean","value":"boolean True if player is super admin","description":"True if player is super admin"}],"realm":"shared","class":"function","name":"isSuperAdmin","description":" Returns whether the player is a super admin"},"getPocketItems":{"path":"libs_sh/darkrp2.lua#L1009","returns":[{"type":"table","value":"table A table containing information about the items in the pocket.","description":"A table containing information about the items in the pocket."}],"realm":"shared","class":"function","name":"getPocketItems","description":" Get a player's pocket items. DarkRP only."},"getUserID":{"path":"libs_sh/players.lua#L401","returns":[{"type":"number","value":"number UserID","description":"UserID"}],"realm":"shared","class":"function","name":"getUserID","description":" Returns the player's UserID"},"setAnimation":{"path":"libs_sh/players.lua#L919","realm":"client","params":[{"type":"number|string","value":"number|string sequence Sequence number or string name","name":"sequence","description":"Sequence number or string name"},{"type":"number?","value":"number? progress Optional float (Default 0), the progress of the animation. Ranging from 0-1","name":"progress","description":"Optional float (Default 0), the progress of the animation. Ranging from 0-1"},{"type":"number?","value":"number? rate Optional float (Default 1), the playback rate of the animation","name":"rate","description":"Optional float (Default 1), the playback rate of the animation"},{"type":"boolean?","value":"boolean? loop Optional boolean (Default false), should the animation loop","name":"loop","description":"Optional boolean (Default false), should the animation loop"},{"type":"boolean?","value":"boolean? auto_advance Optional boolean (Default true), should the animation handle advancing itself","name":"auto_advance","description":"Optional boolean (Default true), should the animation handle advancing itself"},{"type":"number|string|nil","value":"number|string|nil act Optional number or string name (Default sequence value), the activity the player should use","name":"act","description":"Optional number or string name (Default sequence value), the activity the player should use"}],"class":"function","name":"setAnimation","description":" Plays an animation on the player"},"isConnected":{"path":"libs_sh/players.lua#L659","returns":[{"type":"boolean","value":"boolean True if player is connected","description":"True if player is connected"}],"realm":"server","class":"function","name":"isConnected","description":" Returns whether the player is connected"},"isUserGroup":{"path":"libs_sh/players.lua#L343","returns":[{"type":"boolean","value":"boolean True if player belongs to group","description":"True if player belongs to group"}],"realm":"shared","params":[{"type":"string","value":"string groupName Group to check against","name":"groupName","description":"Group to check against"}],"class":"function","name":"isUserGroup","description":" Returns whether the player belongs to a usergroup"},"getLadderClimbSpeed":{"path":"libs_sh/players.lua#L168","returns":[{"type":"number","value":"number Ladder Climb Speed value","description":"Ladder Climb Speed value"}],"realm":"shared","class":"function","name":"getLadderClimbSpeed","description":" Returns the players Ladder Climb Speed, probably unstable"},"isNoclipped":{"path":"libs_sh/players.lua#L245","returns":[{"type":"boolean","value":"boolean True if the player is noclipped","description":"True if the player is noclipped"}],"realm":"shared","class":"function","name":"isNoclipped","description":" Returns true if the player is noclipped"},"resetGesture":{"path":"libs_sh/players.lua#L893","realm":"client","params":[{"type":"number?","value":"number? slot Optional int (Default GESTURE_SLOT.CUSTOM), the gesture slot to use. GESTURE_SLOT table values","name":"slot","description":"Optional int (Default GESTURE_SLOT.CUSTOM), the gesture slot to use. GESTURE_SLOT table values"}],"class":"function","name":"resetGesture","description":" Resets gesture animations on a player"},"getDarkRPVar":{"path":"libs_sh/darkrp2.lua#L991","returns":[{"type":"any","value":"any The value of the DarkRP var.","description":"The value of the DarkRP var."}],"realm":"shared","params":[{"type":"string","value":"string var The name of the variable.","name":"var","description":"The name of the variable."}],"class":"function","name":"getDarkRPVar","description":" Get the value of a DarkRPVar, which is shared between server and client. Case-sensitive.\n Possible variables include (but are not limited to): AFK, AFKDemoted, money, salaryRL, rpname, job, HasGunlicense, Arrested, wanted, wantedReason, agenda, zombieToggle, hitTarget, hitPrice, lastHitTime, Energy\n For money specifically, you may optionally use Player:getMoney instead.\n Some variables may be blacklisted so that you can't read their value."},"setAnimationRate":{"path":"libs_sh/players.lua#L1025","realm":"client","params":[{"type":"number","value":"number rate The playback rate of the animation. Float","name":"rate","description":"The playback rate of the animation. Float"}],"class":"function","name":"setAnimationRate","description":" Sets the animation playback rate"},"getTeamName":{"path":"libs_sh/players.lua#L394","returns":[{"type":"string","value":"string Team Name","description":"Team Name"}],"realm":"shared","class":"function","name":"getTeamName","description":" Returns the name of the player's current team"},"voiceVolume":{"path":"libs_sh/players.lua#L856","returns":[{"type":"number","value":"number Returns the players voice volume, how loud the player's voice communication currently is, as a normal number. Doesn't work on local player unless the voice_loopback convar is set to 1.","description":"Returns the players voice volume, how loud the player's voice communication currently is, as a normal number. Doesn't work on local player unless the voice_loopback convar is set to 1."}],"realm":"client","class":"function","name":"voiceVolume","description":" Returns the voice volume of the player"},"isChief":{"path":"libs_sh/darkrp2.lua#L1034","returns":[{"type":"boolean?","value":"boolean? Whether this player is a Chief. May be nil instead of false.","description":"Whether this player is a Chief. May be nil instead of false."}],"realm":"shared","class":"function","name":"isChief","description":" Whether this player is a Chief. DarkRP only."},"isSpeaking":{"path":"libs_sh/players.lua#L849","returns":[{"type":"boolean","value":"boolean Whether they are speaking and able to be heard by LocalPlayer","description":"Whether they are speaking and able to be heard by LocalPlayer"}],"realm":"client","class":"function","name":"isSpeaking","description":" Returns whether the player is heard by the local player."},"getEyeTrace":{"path":"libs_sh/players.lua#L408","returns":[{"type":"table","value":"table Trace data https://wiki.facepunch.com/gmod/Structures/TraceResult","description":"Trace data https://wiki.facepunch.com/gmod/Structures/TraceResult"}],"realm":"shared","class":"function","name":"getEyeTrace","description":" Returns a table with information of what the player is looking at"},"isMedic":{"path":"libs_sh/darkrp2.lua#L1064","returns":[{"type":"boolean?","value":"boolean? Whether this player is a medic. May be nil instead of false.","description":"Whether this player is a medic. May be nil instead of false."}],"realm":"shared","class":"function","name":"isMedic","description":" Whether this player is a medic. DarkRP only."},"requestMoney":{"path":"libs_sh/darkrp2.lua#L929","realm":"server","params":[{"type":"string?","value":"string? message An optional custom message that will be shown in the money request prompt. May not exceed 60 bytes in length.","name":"message","description":"An optional custom message that will be shown in the money request prompt. May not exceed 60 bytes in length."},{"type":"number","value":"number amount The amount of money to ask for.","name":"amount","description":"The amount of money to ask for."},{"type":"function?","value":"function? callbackSuccess Optional function to call if request succeeds.","name":"callbackSuccess","description":"Optional function to call if request succeeds."},{"type":"function?","value":"function? callbackFailure Optional function to call if request fails.","name":"callbackFailure","description":"Optional function to call if request fails."},{"type":"Player?","value":"Player? receiver The player who may or may not receive the money, or the owner of the chip if not specified. Superuser only.","name":"receiver","description":"The player who may or may not receive the money, or the owner of the chip if not specified. Superuser only."}],"class":"function","name":"requestMoney","description":" Request money from a player.\n This is subject to a burst limit. Use the darkrp.canMakeMoneyRequest function to check if you can request money that tick."},"setAnimationProgress":{"path":"libs_sh/players.lua#L995","realm":"client","params":[{"type":"number","value":"number progress The progress of the animation. Ranging from 0-1","name":"progress","description":"The progress of the animation. Ranging from 0-1"}],"class":"function","name":"setAnimationProgress","description":" Sets the animation progress"},"getMaxArmor":{"path":"libs_sh/players.lua#L140","returns":[{"type":"number","value":"number Armor limit","description":"Armor limit"}],"realm":"shared","class":"function","name":"getMaxArmor","description":" Returns the players maximum armor capacity"},"getViewModel":{"path":"libs_sh/players.lua#L422","returns":[{"type":"Entity","value":"Entity Player's view model","description":"Player's view model"}],"realm":"shared","class":"function","name":"getViewModel","description":" Returns the player's view model\n In the Client realm, other players' viewmodels are not available unless they are being spectated"},"isFrozen":{"path":"libs_sh/players.lua#L329","returns":[{"type":"boolean","value":"boolean True if player is frozen","description":"True if player is frozen"}],"realm":"shared","class":"function","name":"isFrozen","description":" Returns whether the player is frozen"},"keyDown":{"path":"libs_sh/players.lua#L823","returns":[{"type":"boolean","value":"boolean Whether they key is down","description":"Whether they key is down"}],"realm":"shared","params":[{"type":"number","value":"number key Key to check. IN_KEY table values","name":"key","description":"Key to check. IN_KEY table values"}],"class":"function","name":"keyDown","description":" Returns whether or not the player is pushing the key."},"setMaxSpeed":{"path":"libs_sh/players.lua#L741","realm":"server","params":[{"type":"number","value":"number newmaxspeed New Max speed.","name":"newmaxspeed","description":"New Max speed."}],"class":"function","name":"setMaxSpeed","description":" Sets Max Speed"},"teamBanTimeLeft":{"path":"libs_sh/darkrp2.lua#L916","returns":[{"type":"number?","value":"number? The time left on the team ban in seconds, or nil if not banned.","description":"The time left on the team ban in seconds, or nil if not banned."}],"realm":"server","params":[{"type":"number?","value":"number? team The number of the job (e.g. TEAM_MEDIC). Uses the player's team if nil.","name":"team","description":"The number of the job (e.g. TEAM_MEDIC). Uses the player's team if nil."}],"class":"function","name":"teamBanTimeLeft","description":" Returns the time left on a player's team ban. DarkRP only.\n Only works if the player is the owner of the chip, or if the chip is running in superuser mode."},"kill":{"path":"libs_sh/players.lua#L811","realm":"server","class":"function","name":"kill","description":" Kills the target.\n Requires 'entities.setHealth' permission."},"getPacketLoss":{"path":"libs_sh/players.lua#L631","returns":[{"type":"number","value":"number Packets lost","description":"Packets lost"}],"realm":"server","class":"function","name":"getPacketLoss","description":" Returns the packet loss of the client"},"getMaxSpeed":{"path":"libs_sh/players.lua#L175","returns":[{"type":"number","value":"number Max Speed value","description":"Max Speed value"}],"realm":"shared","class":"function","name":"getMaxSpeed","description":" Returns the players Max Speed, probably unstable"},"setStepSize":{"path":"libs_sh/players.lua#L791","realm":"server","params":[{"type":"number","value":"number newstepsize New Step Size.","name":"newstepsize","description":"New Step Size."}],"class":"function","name":"setStepSize","description":" Sets Step Size"},"setJumpPower":{"path":"libs_sh/players.lua#L781","realm":"server","params":[{"type":"number","value":"number newjumppower New Jump Power.","name":"newjumppower","description":"New Jump Power."}],"class":"function","name":"setJumpPower","description":" Sets Jump Power"},"getTimeoutSeconds":{"path":"libs_sh/players.lua#L645","returns":[{"type":"number","value":"number Timeout seconds","description":"Timeout seconds"}],"realm":"server","class":"function","name":"getTimeoutSeconds","description":" Returns the number of seconds that the player has been timing out for"},"resetAnimation":{"path":"libs_sh/players.lua#L967","realm":"client","class":"function","name":"resetAnimation","description":" Resets the animation"},"getPing":{"path":"libs_sh/players.lua#L358","returns":[{"type":"number","value":"number The player's ping","description":"The player's ping"}],"realm":"shared","class":"function","name":"getPing","description":" Returns the player's current ping"},"setUnDuckSpeed":{"path":"libs_sh/players.lua#L721","realm":"server","params":[{"type":"number","value":"number newunduckspeed New UnDuck speed, This is a multiplier from 0 to 1.","name":"newunduckspeed","description":"New UnDuck speed, This is a multiplier from 0 to 1."}],"class":"function","name":"setUnDuckSpeed","description":" Sets UnDuck Speed"},"setDuckSpeed":{"path":"libs_sh/players.lua#L711","realm":"server","params":[{"type":"number","value":"number newduckspeed New Duck speed, This is a multiplier from 0 to 1.","name":"newduckspeed","description":"New Duck speed, This is a multiplier from 0 to 1."}],"class":"function","name":"setDuckSpeed","description":" Sets Duck Speed"},"isCP":{"path":"libs_sh/darkrp2.lua#L1046","returns":[{"type":"boolean","value":"boolean Whether this player is a part of the police force.","description":"Whether this player is a part of the police force."}],"realm":"shared","class":"function","name":"isCP","description":" Whether this player is part of the police force (Mayor, CP, Chief). DarkRP only."},"stripWeapons":{"path":"libs_sh/players.lua#L580","realm":"server","class":"function","name":"stripWeapons","description":" Strips all the player's weapons"},"setMaxArmor":{"path":"libs_sh/players.lua#L691","realm":"server","params":[{"type":"number","value":"number newmaxarmor New max armor value.","name":"newmaxarmor","description":"New max armor value."}],"class":"function","name":"setMaxArmor","description":" Sets the maximum armor for player. You can still set a player's armor above this amount with Player:setArmor."},"getJumpPower":{"path":"libs_sh/players.lua#L203","returns":[{"type":"number","value":"number Jump Power value","description":"Jump Power value"}],"realm":"shared","class":"function","name":"getJumpPower","description":" Returns the players Jump Power"},"dropWeapon":{"path":"libs_sh/players.lua#L550","realm":"server","params":[{"type":"Weapon|string","value":"Weapon|string weapon The weapon instance or class name of the weapon to drop","name":"weapon","description":"The weapon instance or class name of the weapon to drop"},{"type":"Vector?","value":"Vector? target If set, launches the weapon at the given position","name":"target","description":"If set, launches the weapon at the given position"},{"type":"Vector?","value":"Vector? velocity If set and target is unset, launches the weapon with the given velocity","name":"velocity","description":"If set and target is unset, launches the weapon with the given velocity"}],"class":"function","name":"dropWeapon","description":" Drops the player's weapon"},"setRunSpeed":{"path":"libs_sh/players.lua#L751","realm":"server","params":[{"type":"number","value":"number newrunspeed New Run speed.","name":"newrunspeed","description":"New Run speed."}],"class":"function","name":"setRunSpeed","description":" Sets Run Speed ( +speed )"},"isFlashlightOn":{"path":"libs_sh/players.lua#L238","returns":[{"type":"boolean","value":"boolean True if player has flashlight on","description":"True if player has flashlight on"}],"realm":"shared","class":"function","name":"isFlashlightOn","description":" Returns whether the player's flashlight is on"},"say":{"path":"libs_sh/players.lua#L666","realm":"server","params":[{"type":"string","value":"string text The text to force the player to say","name":"text","description":"The text to force the player to say"},{"type":"boolean?","value":"boolean? teamOnly Team chat only?, Defaults to false.","name":"teamOnly","description":"Team chat only?, Defaults to false."}],"class":"function","name":"say","description":" Forces the player to say the first argument\n Only works on the chip's owner."},"isInRoom":{"path":"libs_sh/darkrp2.lua#L959","returns":[{"type":"boolean","value":"boolean Whether this player is in the same room.","description":"Whether this player is in the same room."}],"realm":"client","class":"function","name":"isInRoom","description":" Whether this player is in the same room as the LocalPlayer. DarkRP only."},"isTyping":{"path":"libs_sh/players.lua#L487","returns":[{"type":"boolean","value":"boolean Whether they are typing in the chat","description":"Whether they are typing in the chat"}],"realm":"shared","class":"function","name":"isTyping","description":" Returns whether the player is typing in their chat"},"setAmmo":{"path":"libs_sh/players.lua#L588","realm":"server","params":[{"type":"number","value":"number amount The ammo value","name":"amount","description":"The ammo value"},{"type":"number|string","value":"number|string ammoType Ammo type id or name","name":"ammoType","description":"Ammo type id or name"}],"class":"function","name":"setAmmo","description":" Sets the player's ammo"},"isTimingOut":{"path":"libs_sh/players.lua#L652","returns":[{"type":"boolean","value":"boolean isTimingOut","description":"isTimingOut"}],"realm":"server","class":"function","name":"isTimingOut","description":" Returns true if the player is timing out"},"getFrags":{"path":"libs_sh/players.lua#L252","returns":[{"type":"number","value":"number Amount of kills","description":"Amount of kills"}],"realm":"shared","class":"function","name":"getFrags","description":" Returns the amount of kills of the player"},"setSlowWalkSpeed":{"path":"libs_sh/players.lua#L761","realm":"server","params":[{"type":"number","value":"number newslowwalkspeed New Slow Walk speed.","name":"newslowwalkspeed","description":"New Slow Walk speed."}],"class":"function","name":"setSlowWalkSpeed","description":" Sets Slow Walk Speed ( +walk )"},"keysUnOwnAll":{"path":"libs_sh/darkrp2.lua#L907","realm":"server","class":"function","name":"keysUnOwnAll","description":" Unown every door and vehicle owned by this player. DarkRP only."},"getSlowWalkSpeed":{"path":"libs_sh/players.lua#L189","returns":[{"type":"number","value":"number Slow Walk Speed value","description":"Slow Walk Speed value"}],"realm":"shared","class":"function","name":"getSlowWalkSpeed","description":" Returns the players Slow Walk Speed, which is +walk"},"getWeapons":{"path":"libs_sh/players.lua#L436","returns":[{"type":"table","value":"table Table of weapons","description":"Table of weapons"}],"realm":"shared","class":"function","name":"getWeapons","description":" Returns a table of weapons the player is carrying"},"getAmmoCount":{"path":"libs_sh/players.lua#L477","returns":[{"type":"number","value":"number The amount of ammo player has in reserve.","description":"The amount of ammo player has in reserve."}],"realm":"shared","params":[{"type":"string|number","value":"string|number idOrName The string ammo name or number id of the ammo","name":"idOrName","description":"The string ammo name or number id of the ammo"}],"class":"function","name":"getAmmoCount","description":" Gets the amount of ammo the player has."},"getWeapon":{"path":"libs_sh/players.lua#L443","returns":[{"type":"Weapon","value":"Weapon Weapon","description":"Weapon"}],"realm":"shared","params":[{"type":"string","value":"string wep Weapon class name","name":"wep","description":"Weapon class name"}],"class":"function","name":"getWeapon","description":" Returns the specified weapon or nil if the player doesn't have it"},"setFriction":{"path":"libs_sh/players.lua#L801","realm":"server","params":[{"type":"number","value":"number newfriction New Friction.","name":"newfriction","description":"New Friction."}],"class":"function","name":"setFriction","description":" Sets Friction"},"setEyeAngles":{"path":"libs_sh/players.lua#L619","realm":"server","params":[{"type":"Angle","value":"Angle ang New angles","name":"ang","description":"New angles"}],"class":"function","name":"setEyeAngles","description":" Sets a player's eye angles"},"getUserGroup":{"path":"libs_sh/players.lua#L351","returns":[{"type":"string","value":"string Usergroup, \"user\" if player has no group","description":"Usergroup, \"user\" if player has no group"}],"realm":"shared","class":"function","name":"getUserGroup","description":" Returns the usergroup of the player"},"isAdmin":{"path":"libs_sh/players.lua#L315","returns":[{"type":"boolean","value":"boolean True if player is admin","description":"True if player is admin"}],"realm":"shared","class":"function","name":"isAdmin","description":" Returns whether the player is an admin"},"getName":{"path":"libs_sh/players.lua#L280","returns":[{"type":"string","value":"string Name","description":"Name"}],"realm":"shared","class":"function","name":"getName","description":" Returns the player's name"},"isWanted":{"path":"libs_sh/darkrp2.lua#L1070","returns":[{"type":"boolean?","value":"boolean? Whether this player is wanted. May be nil instead of false.","description":"Whether this player is wanted. May be nil instead of false."}],"realm":"shared","class":"function","name":"isWanted","description":" Whether this player is wanted. DarkRP only. Use Player:getWantedReason if you want to know the reason."},"stripAmmo":{"path":"libs_sh/players.lua#L604","realm":"server","class":"function","name":"stripAmmo","description":" Removes all a player's ammo"},"hasGodMode":{"path":"libs_sh/players.lua#L543","returns":[{"type":"boolean","value":"boolean True if the player has godmode","description":"True if the player has godmode"}],"realm":"server","class":"function","name":"hasGodMode","description":" Returns whether or not the player has godmode"},"setViewEntity":{"path":"libs_sh/players.lua#L533","realm":"server","params":[{"type":"Entity","value":"Entity ent Entity to set the player's view entity to, or nothing to reset it","name":"ent","description":"Entity to set the player's view entity to, or nothing to reset it"}],"class":"function","name":"setViewEntity","description":" Sets the view entity of the player. Only works if they are linked to a hud."},"canAfford":{"path":"libs_sh/darkrp2.lua#L969","returns":[{"type":"boolean","value":"boolean Whether the player can afford it","description":"Whether the player can afford it"}],"realm":"shared","params":[{"type":"number","value":"number amount The amount of money","name":"amount","description":"The amount of money"}],"class":"function","name":"canAfford","description":" Get whether the player can afford the given amount of money. DarkRP only."},"getUnDuckSpeed":{"path":"libs_sh/players.lua#L161","returns":[{"type":"number","value":"number UnDuck Speed value","description":"UnDuck Speed value"}],"realm":"shared","class":"function","name":"getUnDuckSpeed","description":" Returns the players UnDuck Speed, a rate from 0-1 for how quickly they can uncrouch"},"getDeathRagdoll":{"path":"libs_sh/players.lua#L509","returns":[{"type":"Entity?","value":"Entity? The entity or nil if it doesn't exist","description":"The entity or nil if it doesn't exist"}],"realm":"shared","class":"function","name":"getDeathRagdoll","description":" Gets the player's death ragdoll"},"isSprinting":{"path":"libs_sh/players.lua#L494","returns":[{"type":"boolean","value":"boolean Whether they are sprinting","description":"Whether they are sprinting"}],"realm":"shared","class":"function","name":"isSprinting","description":" Returns whether the player is sprinting"},"canKeysLock":{"path":"libs_sh/darkrp2.lua#L977","returns":[{"type":"boolean?","value":"boolean? Whether the player is allowed to lock the door. May be nil instead of false.","description":"Whether the player is allowed to lock the door. May be nil instead of false."}],"realm":"shared","params":[{"type":"Entity","value":"Entity door The door","name":"door","description":"The door"}],"class":"function","name":"canKeysLock","description":" Get whether the player can lock a given door. DarkRP only."},"getRunSpeed":{"path":"libs_sh/players.lua#L182","returns":[{"type":"number","value":"number Run Speed value","description":"Run Speed value"}],"realm":"shared","class":"function","name":"getRunSpeed","description":" Returns the players Run Speed, which is +speed"},"getViewEntity":{"path":"libs_sh/players.lua#L415","returns":[{"type":"Entity","value":"Entity Player's current view entity","description":"Player's current view entity"}],"realm":"shared","class":"function","name":"getViewEntity","description":" Returns the player's current view entity"},"giveMoney":{"path":"libs_sh/darkrp2.lua#L942","realm":"server","params":[{"type":"number","value":"number amount The amount of money to give.","name":"amount","description":"The amount of money to give."}],"class":"function","name":"giveMoney","description":" Give this player money.\n This is subject to a burst limit. Use the darkrp.canGiveMoney function to check if you can request money that tick."},"setAnimationLoop":{"path":"libs_sh/players.lua#L1070","realm":"client","params":[{"type":"boolean","value":"boolean loop Should the animation loop?","name":"loop","description":"Should the animation loop?"}],"class":"function","name":"setAnimationLoop","description":" Sets the animation loop"},"setArmor":{"path":"libs_sh/players.lua#L681","realm":"server","params":[{"type":"number","value":"number newarmor New armor value.","name":"newarmor","description":"New armor value."}],"class":"function","name":"setArmor","description":" Sets the armor of the player."},"getSteamID64":{"path":"libs_sh/players.lua#L372","returns":[{"type":"string","value":"string SteamID64 aka Community ID","description":"SteamID64 aka Community ID"}],"realm":"shared","params":[{"type":"boolean?","value":"boolean? owner Return the actual game owner account id","name":"owner","description":"Return the actual game owner account id"}],"class":"function","name":"getSteamID64","description":" Returns the player's SteamID64 / Community ID\n In singleplayer, this will return no value serverside.\n For bots, this will return 90071996842377216 (equivalent to STEAM_0:0:0) for the first bot to join, and adds 1 to the id for the bot id.\n Returns no value for bots clientside."},"getFriendStatus":{"path":"libs_sh/players.lua#L834","returns":[{"type":"string","value":"string One of: \"friend\", \"blocked\", \"none\", \"requested\"","description":"One of: \"friend\", \"blocked\", \"none\", \"requested\""}],"realm":"client","class":"function","name":"getFriendStatus","description":" Returns the relationship of the player to the local client"},"lastHitGroup":{"path":"libs_sh/players.lua#L612","returns":[{"type":"number","value":"number Hitgroup, see https://wiki.facepunch.com/gmod/Enums/HITGROUP","description":"Hitgroup, see https://wiki.facepunch.com/gmod/Enums/HITGROUP"}],"realm":"server","class":"function","name":"lastHitGroup","description":" Returns the hitgroup where the player was last hit."},"isArrested":{"path":"libs_sh/darkrp2.lua#L1028","returns":[{"type":"boolean?","value":"boolean? Whether this player is arrested. May be nil instead of false.","description":"Whether this player is arrested. May be nil instead of false."}],"realm":"shared","class":"function","name":"isArrested","description":" Whether this player is arrested. DarkRP only."},"inVehicle":{"path":"libs_sh/players.lua#L301","returns":[{"type":"boolean","value":"boolean True if player in vehicle","description":"True if player in vehicle"}],"realm":"shared","class":"function","name":"inVehicle","description":" Returns whether the player is in a vehicle"},"getCrouchedWalkSpeed":{"path":"libs_sh/players.lua#L147","returns":[{"type":"number","value":"number Crouch Walk Speed value","description":"Crouch Walk Speed value"}],"realm":"shared","class":"function","name":"getCrouchedWalkSpeed","description":" Returns the players Crouched Walk Speed"},"isAlive":{"path":"libs_sh/players.lua#L126","returns":[{"type":"boolean","value":"boolean True if player alive","description":"True if player alive"}],"realm":"shared","class":"function","name":"isAlive","description":" Returns whether the player is alive"},"hasDarkRPPrivilege":{"path":"libs_sh/darkrp2.lua#L1021","returns":[{"type":"boolean","value":"boolean Whether the player has the privilege.","description":"Whether the player has the privilege."}],"realm":"shared","class":"function","name":"hasDarkRPPrivilege","description":" Whether the player has a certain DarkRP privilege."},"setModelScale":{"path":"libs_sh/players.lua#L516","realm":"server","params":[{"type":"number","value":"number scale The scale to apply, will be truncated to the first two decimal places (min 0.01, max 100)","name":"scale","description":"The scale to apply, will be truncated to the first two decimal places (min 0.01, max 100)"}],"class":"function","name":"setModelScale","description":" Lets you change the size of yourself if the server has sf_permissions_entity_owneraccess 1"},"getWantedReason":{"path":"libs_sh/darkrp2.lua#L1015","returns":[{"type":"string?","value":"string? The reason, or nil if not wanted","description":"The reason, or nil if not wanted"}],"realm":"shared","class":"function","name":"getWantedReason","description":" Get the reason why someone is wanted. DarkRP only."},"isBot":{"path":"libs_sh/players.lua#L322","returns":[{"type":"boolean","value":"boolean True if player is a bot","description":"True if player is a bot"}],"realm":"shared","class":"function","name":"isBot","description":" Returns whether the player is a bot"},"getDeaths":{"path":"libs_sh/players.lua#L231","returns":[{"type":"number","value":"number Amount of deaths","description":"Amount of deaths"}],"realm":"shared","class":"function","name":"getDeaths","description":" Returns the amount of deaths of the player"},"getDuckSpeed":{"path":"libs_sh/players.lua#L154","returns":[{"type":"number","value":"number Duck Speed value","description":"Duck Speed value"}],"realm":"shared","class":"function","name":"getDuckSpeed","description":" Returns the players Duck Speed, a rate from 0-1 for how quickly they can crouch"},"getTimeConnected":{"path":"libs_sh/players.lua#L638","returns":[{"type":"number","value":"number Time connected","description":"Time connected"}],"realm":"server","class":"function","name":"getTimeConnected","description":" Returns the time in seconds since the player connected"},"getEntityInUse":{"path":"libs_sh/players.lua#L287","returns":[{"type":"Entity","value":"Entity Entity","description":"Entity"}],"realm":"shared","class":"function","name":"getEntityInUse","description":" Returns the entity the player is currently using, like func_tank mounted turrets or +use prop pickups."},"isMayor":{"path":"libs_sh/darkrp2.lua#L1058","returns":[{"type":"boolean?","value":"boolean? Whether this player is the Mayor. May be nil instead of false.","description":"Whether this player is the Mayor. May be nil instead of false."}],"realm":"shared","class":"function","name":"isMayor","description":" Whether this player is the Mayor. DarkRP only."},"getPlayerColor":{"path":"libs_sh/players.lua#L461","returns":[{"type":"Vector","value":"Vector The color","description":"The color"}],"realm":"shared","class":"function","name":"getPlayerColor","description":" Returns a player's color\n The part of the model that is colored is determined by the model itself, and is different for each model\n The format is Vector(r,g,b), and each color should be between 0 and 1"},"getFriction":{"path":"libs_sh/players.lua#L210","returns":[{"type":"number","value":"number Friction value","description":"Friction value"}],"realm":"shared","class":"function","name":"getFriction","description":" Returns the players Friction"},"getStepSize":{"path":"libs_sh/players.lua#L217","returns":[{"type":"number","value":"number Step Size Value","description":"Step Size Value"}],"realm":"shared","class":"function","name":"getStepSize","description":" Returns the players Step Size"},"getArmor":{"path":"libs_sh/players.lua#L133","returns":[{"type":"number","value":"number Armor","description":"Armor"}],"realm":"shared","class":"function","name":"getArmor","description":" Returns the players armor"},"getAimVector":{"path":"libs_sh/players.lua#L266","returns":[{"type":"Vector","value":"Vector Aim vector","description":"Aim vector"}],"realm":"shared","class":"function","name":"getAimVector","description":" Returns the player's aim vector"},"getFOV":{"path":"libs_sh/players.lua#L273","returns":[{"type":"number","value":"number Field of view as a float","description":"Field of view as a float"}],"realm":"shared","class":"function","name":"getFOV","description":" Returns the player's field of view"},"canKeysUnlock":{"path":"libs_sh/darkrp2.lua#L984","returns":[{"type":"boolean?","value":"boolean? Whether the player is allowed to unlock the door. May be nil instead of false.","description":"Whether the player is allowed to unlock the door. May be nil instead of false."}],"realm":"shared","params":[{"type":"Entity","value":"Entity door The door","name":"door","description":"The door"}],"class":"function","name":"canKeysUnlock","description":" Get whether the player can unlock a given door. DarkRP only."},"setCrouchedWalkSpeed":{"path":"libs_sh/players.lua#L701","realm":"server","params":[{"type":"number","value":"number newcwalkspeed New Crouch Walk speed, This is a multiplier from 0 to 1.","name":"newcwalkspeed","description":"New Crouch Walk speed, This is a multiplier from 0 to 1."}],"class":"function","name":"setCrouchedWalkSpeed","description":" Sets Crouched Walk Speed"},"isCook":{"path":"libs_sh/darkrp2.lua#L1040","returns":[{"type":"boolean?","value":"boolean? Whether this player is a cook. May be nil instead of false.","description":"Whether this player is a cook. May be nil instead of false."}],"realm":"shared","class":"function","name":"isCook","description":" Whether this player is a cook. DarkRP only. Only works if hungermod is enabled."},"getActiveWeapon":{"path":"libs_sh/players.lua#L259","returns":[{"type":"Weapon","value":"Weapon The weapon","description":"The weapon"}],"realm":"shared","class":"function","name":"getActiveWeapon","description":" Returns the name of the player's active weapon"},"setGestureWeight":{"path":"libs_sh/players.lua#L905","realm":"client","params":[{"type":"number?","value":"number? slot Optional int (Default GESTURE_SLOT.CUSTOM), the gesture slot to use. GESTURE_SLOT table values","name":"slot","description":"Optional int (Default GESTURE_SLOT.CUSTOM), the gesture slot to use. GESTURE_SLOT table values"},{"type":"number?","value":"number? weight Optional float (Default 1), the weight of the gesture. Ranging from 0-1","name":"weight","description":"Optional float (Default 1), the weight of the gesture. Ranging from 0-1"}],"class":"function","name":"setGestureWeight","description":" Sets the weight of the gesture animation in the given gesture slot"}},"class":"type","name":"Player","description":" Player type"},"Vector":{"path":"libs_sh/vectors.lua#L6","methods":{"isEqualTol":{"path":"libs_sh/vectors.lua#L251","returns":[{"type":"boolean","value":"boolean Whether the vector is equal to v within the tolerance.","description":"Whether the vector is equal to v within the tolerance."}],"realm":"shared","params":[{"type":"Vector","value":"Vector v Second Vector","name":"v","description":"Second Vector"},{"type":"number","value":"number t Tolerance number.","name":"t","description":"Tolerance number."}],"class":"function","name":"isEqualTol","description":" Is this vector and v equal within tolerance t."},"getQuaternion":{"path":"libs_sh/quaternion.lua#L781","returns":[{"type":"Quaternion","value":"Quaternion Quaternion from the given vector","description":"Quaternion from the given vector"}],"realm":"shared","params":[{"type":"Vector","value":"Vector up Upward direction. If specified, the original vector will act like a forward pointing one","name":"up","description":"Upward direction. If specified, the original vector will act like a forward pointing one"}],"class":"function","name":"getQuaternion","description":" Converts vector to quaternion"},"getLength2D":{"path":"libs_sh/vectors.lua#L279","returns":[{"type":"number","value":"number Vector length","description":"Vector length"}],"realm":"shared","class":"function","name":"getLength2D","description":" Returns the length of the vector in two dimensions, without the Z axis."},"__mul":{"path":"libs_sh/vectors.lua#L122","returns":[{"type":"Vector","value":"Vector Multiplied vector.","description":"Multiplied vector."}],"realm":"shared","params":[{"type":"number|Vector","value":"number|Vector a Number or Vector multiplicand.","name":"a","description":"Number or Vector multiplicand."},{"type":"number|Vector","value":"number|Vector b Number or Vector multiplier.","name":"b","description":"Number or Vector multiplier."}],"class":"function","name":"__mul","description":" Multiplication metamethod"},"round":{"path":"libs_sh/vectors.lua#L455","realm":"shared","params":[{"type":"number","value":"number idp (Default 0) The integer decimal place to round to.","name":"idp","description":"(Default 0) The integer decimal place to round to."}],"class":"function","name":"round","description":" Round the vector values.\n Self-Modifies. Does not return anything"},"getQuaternionFromRotation":{"path":"libs_sh/quaternion.lua#L819","returns":[{"type":"Quaternion","value":"Quaternion Rotated quaternion","description":"Rotated quaternion"}],"realm":"shared","class":"function","name":"getQuaternionFromRotation","description":" Constructs a quaternion from the rotation vector. Vector direction is axis of rotation, it's magnitude is angle in degrees"},"withinAABox":{"path":"libs_sh/vectors.lua#L485","returns":[{"type":"boolean","value":"boolean True/False.","description":"True/False."}],"realm":"shared","params":[{"type":"Vector","value":"Vector v1 Vector used to define AABox","name":"v1","description":"Vector used to define AABox"},{"type":"Vector","value":"Vector v2 Second Vector to define AABox","name":"v2","description":"Second Vector to define AABox"}],"class":"function","name":"withinAABox","description":" Returns whenever the given vector is in a box created by the 2 other vectors."},"__sub":{"path":"libs_sh/vectors.lua#L170","returns":[{"type":"Vector","value":"Vector Resultant vector after subtraction operation.","description":"Resultant vector after subtraction operation."}],"realm":"shared","params":[{"type":"Vector","value":"Vector v1 Initial Vector","name":"v1","description":"Initial Vector"},{"type":"Vector","value":"Vector v2 Vector to subtract","name":"v2","description":"Vector to subtract"}],"class":"function","name":"__sub","description":" Subtraction metamethod"},"__unm":{"path":"libs_sh/vectors.lua#L178","returns":[{"type":"Vector","value":"Vector Negative vector.","description":"Negative vector."}],"realm":"shared","class":"function","name":"__unm","description":" Unary Minus metamethod (Negative)"},"getLength":{"path":"libs_sh/vectors.lua#L267","returns":[{"type":"number","value":"number Length of the vector.","description":"Length of the vector."}],"realm":"shared","class":"function","name":"getLength","description":" Get the vector's Length."},"getLengthSqr":{"path":"libs_sh/vectors.lua#L273","returns":[{"type":"number","value":"number length squared.","description":"length squared."}],"realm":"shared","class":"function","name":"getLengthSqr","description":" Get the vector's length squared ( Saves computation by skipping the square root )."},"vdiv":{"path":"libs_sh/vectors.lua#L340","realm":"shared","params":[{"type":"Vector","value":"Vector v Vector to divide by","name":"v","description":"Vector to divide by"}],"class":"function","name":"vdiv","description":" Divide self by a Vector.\n Self-Modifies. Does not return anything"},"mul":{"path":"libs_sh/vectors.lua#L309","realm":"shared","params":[{"type":"number","value":"number n Scalar to multiply with.","name":"n","description":"Scalar to multiply with."}],"class":"function","name":"mul","description":" Scalar Multiplication of the vector.\n Self-Modifies. Does not return anything"},"__eq":{"path":"libs_sh/vectors.lua#L184","returns":[{"type":"boolean","value":"boolean Whether both sides are equal.","description":"Whether both sides are equal."}],"realm":"shared","params":[{"type":"Vector","value":"Vector v1 Initial vector.","name":"v1","description":"Initial vector."},{"type":"Vector","value":"Vector v2 Vector to check against.","name":"v2","description":"Vector to check against."}],"class":"function","name":"__eq","description":" Equivalence metamethod"},"rotate":{"path":"libs_sh/vectors.lua#L394","realm":"shared","params":[{"type":"Angle","value":"Angle b Angle to rotate by.","name":"b","description":"Angle to rotate by."}],"class":"function","name":"rotate","description":" Rotate the vector by Angle b.\n Self-Modifies. Does not return anything"},"normalize":{"path":"libs_sh/vectors.lua#L381","realm":"shared","class":"function","name":"normalize","description":" Normalise the vector, same direction, length 1.\n Self-Modifies. Does not return anything"},"getNormalized":{"path":"libs_sh/vectors.lua#L243","returns":[{"type":"Vector","value":"Vector Normalized vector","description":"Normalized vector"}],"realm":"shared","class":"function","name":"getNormalized","description":" Returns a new vector with the same direction by length of 1."},"getQuaternionFromAxis":{"path":"libs_sh/quaternion.lua#L808","returns":[{"type":"Quaternion","value":"Quaternion Rotated quaternion","description":"Rotated quaternion"}],"realm":"shared","params":[{"type":"number","value":"number ang Number rotation angle","name":"ang","description":"Number rotation angle"}],"class":"function","name":"getQuaternionFromAxis","description":" Returns quaternion for rotation about axis represented by the vector by an angle"},"setX":{"path":"libs_sh/vectors.lua#L357","returns":[{"type":"Vector","value":"Vector Modified vector after setting X.","description":"Modified vector after setting X."}],"realm":"shared","params":[{"type":"number","value":"number x The x coordinate","name":"x","description":"The x coordinate"}],"class":"function","name":"setX","description":" Set's the vector's x coordinate and returns the vector after modifying."},"setY":{"path":"libs_sh/vectors.lua#L365","returns":[{"type":"Vector","value":"Vector Modified vector after setting Y.","description":"Modified vector after setting Y."}],"realm":"shared","params":[{"type":"number","value":"number y The y coordinate","name":"y","description":"The y coordinate"}],"class":"function","name":"setY","description":" Set's the vector's y coordinate and returns the vector after modifying."},"getDistanceSqr":{"path":"libs_sh/vectors.lua#L229","returns":[{"type":"number","value":"number Vector distance from v","description":"Vector distance from v"}],"realm":"shared","params":[{"type":"Vector","value":"Vector v Second Vector","name":"v","description":"Second Vector"}],"class":"function","name":"getDistanceSqr","description":" Returns the squared distance of 2 vectors, this is faster Vector:getDistance as calculating the square root is an expensive process."},"getColor":{"path":"libs_sh/vectors.lua#L479","returns":[{"type":"Color","value":"Color New color object","description":"New color object"}],"realm":"shared","class":"function","name":"getColor","description":" Converts vector to color"},"cross":{"path":"libs_sh/vectors.lua#L215","returns":[{"type":"Vector","value":"Vector Vector from cross product","description":"Vector from cross product"}],"realm":"shared","params":[{"type":"Vector","value":"Vector v Second Vector","name":"v","description":"Second Vector"}],"class":"function","name":"cross","description":" Calculates the cross product of the 2 vectors, creates a unique perpendicular vector to both input vectors."},"isInWorld":{"path":"libs_sh/vectors.lua#L498","returns":[{"type":"boolean","value":"boolean True/False.","description":"True/False."}],"realm":"server","class":"function","name":"isInWorld","description":" Returns whether the vector is in world"},"set":{"path":"libs_sh/vectors.lua#L470","realm":"shared","params":[{"type":"Vector","value":"Vector v Second Vector","name":"v","description":"Second Vector"}],"class":"function","name":"set","description":" Copies the values from the second vector to the first vector.\n Self-Modifies. Does not return anything"},"setZ":{"path":"libs_sh/vectors.lua#L373","returns":[{"type":"Vector","value":"Vector Modified vector after setting Z.","description":"Modified vector after setting Z."}],"realm":"shared","params":[{"type":"number","value":"number z The z coordinate","name":"z","description":"The z coordinate"}],"class":"function","name":"setZ","description":" Set's the vector's z coordinate and returns the vector after modifying."},"sub":{"path":"libs_sh/vectors.lua#L300","realm":"shared","params":[{"type":"Vector","value":"Vector v Vector to subtract.","name":"v","description":"Vector to subtract."}],"class":"function","name":"sub","description":" Subtract v from this Vector.\n Self-Modifies. Does not return anything"},"add":{"path":"libs_sh/vectors.lua#L291","realm":"shared","params":[{"type":"Vector","value":"Vector v Vector to add","name":"v","description":"Vector to add"}],"class":"function","name":"add","description":" Add v to this vector\n Self-Modifies. Does not return anything"},"__div":{"path":"libs_sh/vectors.lua#L144","returns":[{"type":"Vector","value":"Vector Scaled vector.","description":"Scaled vector."}],"realm":"shared","params":[{"type":"number|Vector","value":"number|Vector v1 Number or Vector dividend.","name":"v1","description":"Number or Vector dividend."},{"type":"number|Vector","value":"number|Vector v2 Number or Vector divisor.","name":"v2","description":"Number or Vector divisor."}],"class":"function","name":"__div","description":" Division metamethod"},"rotateAroundAxis":{"path":"libs_sh/vectors.lua#L432","returns":[{"type":"Vector","value":"Vector Rotated vector","description":"Rotated vector"}],"realm":"shared","params":[{"type":"Vector","value":"Vector axis Axis the rotate around","name":"axis","description":"Axis the rotate around"},{"type":"number?","value":"number? degrees Angle to rotate by in degrees or nil if radians.","name":"degrees","description":"Angle to rotate by in degrees or nil if radians."},{"type":"number?","value":"number? radians Angle to rotate by in radians or nil if degrees.","name":"radians","description":"Angle to rotate by in radians or nil if degrees."}],"class":"function","name":"rotateAroundAxis","description":" Return rotated vector by an axis"},"__index":{"path":"libs_sh/vectors.lua#L89","returns":[{"type":"number","value":"number The value at the index","description":"The value at the index"}],"realm":"shared","params":[{"type":"number|string","value":"number|string Key to get the value at","name":"Key","description":"to get the value at"}],"class":"function","name":"__index","description":" Gets a value at a key in the vector\n Can be indexed with: 1, 2, 3, x, y, z, xx, xy, xz, xxx, xyz, zyx, etc.. 1,2,3 is most efficient."},"dot":{"path":"libs_sh/vectors.lua#L236","returns":[{"type":"number","value":"number Dot product result between the two vectors","description":"Dot product result between the two vectors"}],"realm":"shared","params":[{"type":"Vector","value":"Vector v Second Vector","name":"v","description":"Second Vector"}],"class":"function","name":"dot","description":" Dot product is the cosine of the angle between both vectors multiplied by their lengths. A.B = ||A||||B||cosA."},"getRotated":{"path":"libs_sh/vectors.lua#L409","returns":[{"type":"Vector","value":"Vector Rotated Vector","description":"Rotated Vector"}],"realm":"shared","params":[{"type":"Angle","value":"Angle b Angle to rotate by.","name":"b","description":"Angle to rotate by."}],"class":"function","name":"getRotated","description":" Returns Rotated vector by Angle b"},"getDistance":{"path":"libs_sh/vectors.lua#L222","returns":[{"type":"number","value":"number Vector distance from v","description":"Vector distance from v"}],"realm":"shared","params":[{"type":"Vector","value":"Vector v Second Vector","name":"v","description":"Second Vector"}],"class":"function","name":"getDistance","description":" Returns the pythagorean distance between the vector and the other vector."},"clone":{"path":"libs_sh/vectors.lua#L464","returns":[{"type":"Vector","value":"Vector The copy of the vector","description":"The copy of the vector"}],"realm":"shared","class":"function","name":"clone","description":" Copies x,y,z from a vector and returns a new vector"},"__tostring":{"path":"libs_sh/vectors.lua#L116","returns":[{"type":"string","value":"string String representation of the vector.","description":"String representation of the vector."}],"realm":"shared","class":"function","name":"__tostring","description":" Turns a vector into a string."},"getAngle":{"path":"libs_sh/vectors.lua#L195","returns":[{"type":"Angle","value":"Angle Angle representing the vector","description":"Angle representing the vector"}],"realm":"shared","class":"function","name":"getAngle","description":" Get the vector's angle."},"vmul":{"path":"libs_sh/vectors.lua#L331","realm":"shared","params":[{"type":"Vector","value":"Vector v Vector to multiply with","name":"v","description":"Vector to multiply with"}],"class":"function","name":"vmul","description":" Multiply self with a Vector.\n Self-Modifies. Does not return anything"},"isZero":{"path":"libs_sh/vectors.lua#L261","returns":[{"type":"boolean","value":"boolean Whether all fields are zero","description":"Whether all fields are zero"}],"realm":"shared","class":"function","name":"isZero","description":" Returns whether all fields are zero"},"toScreen":{"path":"libs_sh/vectors.lua#L505","returns":[{"type":"table","value":"table A table {x=screenx,y=screeny,visible=visible}","description":"A table {x=screenx,y=screeny,visible=visible}"}],"realm":"client","class":"function","name":"toScreen","description":" Translates the vectors position into 2D user screen coordinates."},"__newindex":{"path":"libs_sh/vectors.lua#L63","realm":"shared","params":[{"type":"Vector","value":"Vector Vec","name":"Vec","description":""},{"type":"number|string","value":"number|string Key","name":"Key","description":""},{"type":"number","value":"number Value","name":"Value","description":""}],"class":"function","name":"__newindex","description":" Sets a value at a key in the vector"},"__add":{"path":"libs_sh/vectors.lua#L162","returns":[{"type":"Vector","value":"Vector Resultant vector after addition operation.","description":"Resultant vector after addition operation."}],"realm":"shared","params":[{"type":"Vector","value":"Vector v1 Initial vector.","name":"v1","description":"Initial vector."},{"type":"Vector","value":"Vector v2 Vector to add to the first.","name":"v2","description":"Vector to add to the first."}],"class":"function","name":"__add","description":" Addition metamethod"},"div":{"path":"libs_sh/vectors.lua#L320","realm":"shared","params":[{"type":"number","value":"number n Scalar to divide by.","name":"n","description":"Scalar to divide by."}],"class":"function","name":"div","description":" \"Scalar Division\" of the vector.\n Self-Modifies. Does not return anything"},"getLength2DSqr":{"path":"libs_sh/vectors.lua#L285","returns":[{"type":"number","value":"number Length squared.","description":"Length squared."}],"realm":"shared","class":"function","name":"getLength2DSqr","description":" Returns the length squared of the vector in two dimensions, without the Z axis. ( Saves computation by skipping the square root )"},"getBasis":{"path":"libs_sh/vectors.lua#L419","returns":[{"type":"number","value":"number Basis 1","description":"Basis 1"},{"type":"number","value":"number Basis 2","description":"Basis 2"}],"realm":"shared","class":"function","name":"getBasis","description":" Returns an arbitrary orthogonal basis from the direction of the vector. Input must be a normalized vector"},"getAngleEx":{"path":"libs_sh/vectors.lua#L208","returns":[{"type":"Angle","value":"Angle Angle","description":"Angle"}],"realm":"shared","params":[{"type":"Vector","value":"Vector v Second Vector","name":"v","description":"Second Vector"}],"class":"function","name":"getAngleEx","description":" Returns the vector's euler angle with respect to the other vector as if it were the new vertical axis."},"setZero":{"path":"libs_sh/vectors.lua#L349","realm":"shared","class":"function","name":"setZero","description":" Set's all vector fields to 0.\n Self-Modifies. Does not return anything"}},"fields":[{"name":"x","description":"The x value of the vector. Can also be indexed with [1]"},{"name":"y","description":"The y value of the vector. Can also be indexed with [2]"},{"name":"z","description":"The z value of the vector. Can also be indexed with [3]"}],"realm":"shared","libtbl":["vec_methods","vec_meta"],"class":"type","name":"Vector","description":" Vector type"},"Markup":{"path":"libs_cl/render.lua#L422","libtbl":["markup_methods"],"realm":"client","methods":{"getSize":{"path":"libs_cl/render.lua#L1920","returns":[{"type":"number","value":"number The width of the object","description":"The width of the object"},{"type":"number","value":"number The height of the object","description":"The height of the object"}],"realm":"client","class":"function","name":"getSize","description":" Get the object size"},"draw":{"path":"libs_cl/render.lua#L1896","realm":"client","params":[{"type":"number","value":"number x number The x offset","name":"x","description":"number The x offset"},{"type":"number","value":"number y number The x offset","name":"y","description":"number The x offset"},{"type":"number?","value":"number? xAlign number The x TEXT_ALIGN. Default TEXT_ALIGN.LEFT","name":"xAlign","description":"number The x TEXT_ALIGN. Default TEXT_ALIGN.LEFT"},{"type":"number?","value":"number? yAlign number The y TEXT_ALIGN. Default TEXT_ALIGN.TOP","name":"yAlign","description":"number The y TEXT_ALIGN. Default TEXT_ALIGN.TOP"},{"type":"number?","value":"number? alpha The alpha to draw it with. Default 255","name":"alpha","description":"The alpha to draw it with. Default 255"},{"type":"number?","value":"number? contentAlign The content alignment TEXT_ALIGN. Default TEXT_ALIGN.LEFT","name":"contentAlign","description":"The content alignment TEXT_ALIGN. Default TEXT_ALIGN.LEFT"}],"class":"function","name":"draw","description":" Draw the markup object"},"getWidth":{"path":"libs_cl/render.lua#L1908","returns":[{"type":"number","value":"number The width of the object","description":"The width of the object"}],"realm":"client","class":"function","name":"getWidth","description":" Get the object width"},"getHeight":{"path":"libs_cl/render.lua#L1914","returns":[{"type":"number","value":"number The height of the object","description":"The height of the object"}],"realm":"client","class":"function","name":"getHeight","description":" Get the object height"}},"class":"type","name":"Markup","description":" The Markup type is used to easily format and draw text. Use render.parseMarkup(str, maxwidth) to create one."},"Hologram":{"path":"libs_sh/hologram.lua#L42","libtbl":["hologram_methods"],"realm":"shared","methods":{"setCullMode":{"path":"libs_sh/hologram.lua#L491","realm":"shared","params":[{"type":"number","value":"number mode Cull mode. 0 for counter clock wise, 1 for clock wise","name":"mode","description":"Cull mode. 0 for counter clock wise, 1 for clock wise"}],"class":"function","name":"setCullMode","description":" Set the cull mode for a hologram."},"setAngVel":{"path":"libs_sh/hologram.lua#L186","realm":"server","params":[{"type":"Angle","value":"Angle angvel *Vector* angular velocity.","name":"angvel","description":"*Vector* angular velocity."}],"class":"function","name":"setAngVel","description":" Sets the hologram's angular velocity."},"setAnimation":{"path":"libs_sh/hologram.lua#L461","realm":"shared","params":[{"type":"number|string","value":"number|string animation Animation number or string name.","name":"animation","description":"Animation number or string name."},{"type":"number?","value":"number? frame Optional int (Default 0) The starting frame number. Does nothing if nil","name":"frame","description":"Optional int (Default 0) The starting frame number. Does nothing if nil"},{"type":"number?","value":"number? rate Optional float (Default 1) Frame speed. Does nothing if nil","name":"rate","description":"Optional float (Default 1) Frame speed. Does nothing if nil"}],"class":"function","name":"setAnimation","description":" Animates a hologram"},"suppressEngineLighting":{"path":"libs_sh/hologram.lua#L427","realm":"shared","params":[{"type":"boolean","value":"boolean suppress Boolean to represent if shading should be set or not.","name":"suppress","description":"Boolean to represent if shading should be set or not."}],"class":"function","name":"suppressEngineLighting","description":" Suppress Engine Lighting of a hologram. Disabled by default."},"setScale":{"path":"libs_sh/hologram.lua#L394","realm":"shared","params":[{"type":"Vector","value":"Vector scale Vector new scale","name":"scale","description":"Vector new scale"}],"class":"function","name":"setScale","description":" Sets the hologram scale. Basically the same as setRenderMatrix() with a scaled matrix"},"setRenderGroup":{"path":"libs_sh/hologram.lua#L504","realm":"shared","params":[{"type":"number|nil","value":"number|nil group Render group. If unset, the engine will decide the render group based on the entity's materials. Can be RENDERGROUP.OPAQUE RENDERGROUP.TRANSLUCENT RENDERGROUP.BOTH RENDERGROUP.VIEWMODEL RENDERGROUP.VIEWMODEL.TRANSLUCENT RENDERGROUP.OPAQUE.BRUSH","name":"group","description":"Render group. If unset, the engine will decide the render group based on the entity's materials. Can be RENDERGROUP.OPAQUE RENDERGROUP.TRANSLUCENT RENDERGROUP.BOTH RENDERGROUP.VIEWMODEL RENDERGROUP.VIEWMODEL.TRANSLUCENT RENDERGROUP.OPAQUE.BRUSH"}],"class":"function","name":"setRenderGroup","description":" Set the render group for a hologram."},"getScale":{"path":"libs_sh/hologram.lua#L420","returns":[{"type":"Vector","value":"Vector Vector scale","description":"Vector scale"}],"realm":"shared","class":"function","name":"getScale","description":" Gets the hologram scale."},"setClip":{"path":"libs_sh/hologram.lua#L358","realm":"shared","params":[{"type":"number","value":"number index Whatever number you want the clip to be","name":"index","description":"Whatever number you want the clip to be"},{"type":"boolean","value":"boolean enabled Whether the clip is enabled","name":"enabled","description":"Whether the clip is enabled"},{"type":"Vector?","value":"Vector? origin The center of the clip plane in world coordinates, or local to entity if it is specified. Only used if enabled.","name":"origin","description":"The center of the clip plane in world coordinates, or local to entity if it is specified. Only used if enabled."},{"type":"Vector?","value":"Vector? normal The the direction of the clip plane in world coordinates, or local to entity if it is specified. Only used if enabled.","name":"normal","description":"The the direction of the clip plane in world coordinates, or local to entity if it is specified. Only used if enabled."},{"type":"Entity?","value":"Entity? entity (Optional) The entity to make coordinates local to, otherwise the world is used. Only used if enabled.","name":"entity","description":"(Optional) The entity to make coordinates local to, otherwise the world is used. Only used if enabled."}],"class":"function","name":"setClip","description":" Updates a clip plane"},"setFilterMag":{"path":"libs_sh/hologram.lua#L242","realm":"client","params":[{"type":"number","value":"number val The filter function to use http://wiki.facepunch.com/gmod/Enums/TEXFILTER","name":"val","description":"The filter function to use http://wiki.facepunch.com/gmod/Enums/TEXFILTER"}],"class":"function","name":"setFilterMag","description":" Sets the texture filtering function when viewing a close texture"},"addEffects":{"path":"libs_sh/hologram.lua#L520","realm":"shared","params":[{"type":"number","value":"number effect The effects to add. See EF Enums","name":"effect","description":"The effects to add. See EF Enums"}],"class":"function","name":"addEffects","description":" Applies engine effects to the hologram"},"setRenderMatrix":{"path":"libs_sh/hologram.lua#L276","realm":"client","params":[{"type":"VMatrix","value":"VMatrix mat Starfall matrix to use","name":"mat","description":"Starfall matrix to use"}],"class":"function","name":"setRenderMatrix","description":" Sets a hologram entity's rendermatrix"},"setPos":{"path":"libs_sh/hologram.lua#L210","realm":"shared","params":[{"type":"Vector","value":"Vector vec New position","name":"vec","description":"New position"}],"class":"function","name":"setPos","description":" Sets the hologram's position."},"setAngles":{"path":"libs_sh/hologram.lua#L226","realm":"shared","params":[{"type":"Angle","value":"Angle ang New angles","name":"ang","description":"New angles"}],"class":"function","name":"setAngles","description":" Sets the hologram's angles."},"setMoveType":{"path":"libs_sh/hologram.lua#L197","realm":"server","params":[{"type":"number","value":"number Movetype to set, either MOVETYPE.NOCLIP (default) or MOVETYPE.NONE","name":"Movetype","description":"to set, either MOVETYPE.NOCLIP (default) or MOVETYPE.NONE"}],"class":"function","name":"setMoveType","description":" Sets the hologram's movetype"},"setModel":{"path":"libs_sh/hologram.lua#L447","realm":"shared","params":[{"type":"string","value":"string model string model path","name":"model","description":"string model path"}],"class":"function","name":"setModel","description":" Sets the model of a hologram"},"getPlayerColor":{"path":"libs_sh/hologram.lua#L344","returns":[{"type":"Vector?","value":"Vector? color The player color to use, or nil if disabled","description":"color The player color to use, or nil if disabled"}],"realm":"shared","class":"function","name":"getPlayerColor","description":" Gets the player color of a hologram\n The part of the model that is colored is determined by the model itself, and is different for each model\n The format is Vector(r,g,b), and each color should be between 0 and 1"},"getSuppressEngineLighting":{"path":"libs_sh/hologram.lua#L440","returns":[{"type":"boolean","value":"boolean Whether engine lighting is suppressed","description":"Whether engine lighting is suppressed"}],"realm":"shared","class":"function","name":"getSuppressEngineLighting","description":" Suppress Engine Lighting of a hologram. Disabled by default."},"removeEffects":{"path":"libs_sh/hologram.lua#L532","realm":"shared","params":[{"type":"number","value":"number effect The effects to remove. See EF Enums","name":"effect","description":"The effects to remove. See EF Enums"}],"class":"function","name":"removeEffects","description":" Removes engine effects from the hologram"},"remove":{"path":"libs_sh/hologram.lua#L544","realm":"shared","class":"function","name":"remove","description":" Removes a hologram"},"setVel":{"path":"libs_sh/hologram.lua#L173","realm":"server","params":[{"type":"Vector","value":"Vector vel New velocity","name":"vel","description":"New velocity"}],"class":"function","name":"setVel","description":" Sets the hologram linear velocity"},"setPlayerColor":{"path":"libs_sh/hologram.lua#L329","realm":"shared","params":[{"type":"Vector?","value":"Vector? color The player color to use, or nil to disable","name":"color","description":"The player color to use, or nil to disable"}],"class":"function","name":"setPlayerColor","description":" Sets the player color of a hologram\n The part of the model that is colored is determined by the model itself, and is different for each model\n The format is Vector(r,g,b), and each color should be between 0 and 1"},"draw":{"path":"libs_sh/hologram.lua#L302","realm":"client","params":[{"type":"boolean?","value":"boolean? noTint If true, renders the hologram without its color and opacity. The default is for holograms to render with color or opacity, so use this argument if you need that behavior.","name":"noTint","description":"If true, renders the hologram without its color and opacity. The default is for holograms to render with color or opacity, so use this argument if you need that behavior."}],"class":"function","name":"draw","description":" Manually draws a hologram, requires a 3d render context"},"setSize":{"path":"libs_sh/hologram.lua#L406","realm":"shared","params":[{"type":"Vector","value":"Vector size Vector new size in game units","name":"size","description":"Vector new size in game units"}],"class":"function","name":"setSize","description":" Sets the hologram size in game units"},"setFilterMin":{"path":"libs_sh/hologram.lua#L259","realm":"client","params":[{"type":"number","value":"number val The filter function to use http://wiki.facepunch.com/gmod/Enums/TEXFILTER","name":"val","description":"The filter function to use http://wiki.facepunch.com/gmod/Enums/TEXFILTER"}],"class":"function","name":"setFilterMin","description":" Sets the texture filtering function when viewing a far texture"}},"class":"type","name":"Hologram","description":" Hologram type"},"Light":{"path":"libs_cl/light.lua#L80","libtbl":["light_methods"],"realm":"client","methods":{"setNoWorld":{"path":"libs_cl/light.lua#L211","realm":"client","params":[{"type":"boolean","value":"boolean on Whether the light shouldn't cast onto the world","name":"on","description":"Whether the light shouldn't cast onto the world"}],"class":"function","name":"setNoWorld","description":" Sets whether the light should cast onto the world or not"},"setOuterAngle":{"path":"libs_cl/light.lua#L197","realm":"client","params":[{"type":"number","value":"number ang Outer angle of the light","name":"ang","description":"Outer angle of the light"}],"class":"function","name":"setOuterAngle","description":" Sets the light outer angle (used with setDirection and setInnerAngle)"},"setInnerAngle":{"path":"libs_cl/light.lua#L190","realm":"client","params":[{"type":"number","value":"number ang Inner angle of the light","name":"ang","description":"Inner angle of the light"}],"class":"function","name":"setInnerAngle","description":" Sets the light inner angle (used with setDirection and setOuterAngle)"},"destroy":{"path":"libs_cl/light.lua#L255","realm":"client","class":"function","name":"destroy","description":" Destroys the light object freeing up whatever slot it was using"},"setStyle":{"path":"libs_cl/light.lua#L238","realm":"client","params":[{"type":"number","value":"number style The number of the flicker style","name":"style","description":"The number of the flicker style"}],"class":"function","name":"setStyle","description":" Sets the flicker style of the light https://developer.valvesoftware.com/wiki/Light_dynamic#Appearances"},"setColor":{"path":"libs_cl/light.lua#L245","realm":"client","params":[{"type":"Color","value":"Color col The color of the light","name":"col","description":"The color of the light"}],"class":"function","name":"setColor","description":" Sets the color of the light"},"setBrightness":{"path":"libs_cl/light.lua#L163","realm":"client","params":[{"type":"number","value":"number brightness The light's brightness","name":"brightness","description":"The light's brightness"}],"class":"function","name":"setBrightness","description":" Sets the light brightness"},"setDieTime":{"path":"libs_cl/light.lua#L177","realm":"client","params":[{"type":"number","value":"number dietime The how long the light will stay alive after turning it off.","name":"dietime","description":"The how long the light will stay alive after turning it off."}],"class":"function","name":"setDieTime","description":" Sets the light lifespan (Required for fade effect i.e. decay)"},"draw":{"path":"libs_cl/light.lua#L143","realm":"client","class":"function","name":"draw","description":" Draws the light. Typically used in the think hook. Will throw an error if it fails (use pcall)"},"setSize":{"path":"libs_cl/light.lua#L231","realm":"client","params":[{"type":"number","value":"number size The size of the light","name":"size","description":"The size of the light"}],"class":"function","name":"setSize","description":" Sets the size of the light (max is sf_light_maxsize)"},"setMinLight":{"path":"libs_cl/light.lua#L204","realm":"client","params":[{"type":"number","value":"number min The minimum light","name":"min","description":"The minimum light"}],"class":"function","name":"setMinLight","description":" Sets the minimum light amount"},"setDecay":{"path":"libs_cl/light.lua#L170","realm":"client","params":[{"type":"number","value":"number decay The light's decay speed","name":"decay","description":"The light's decay speed"}],"class":"function","name":"setDecay","description":" Sets the light decay speed in thousandths per second. 1000 lasts for 1 second, 2000 lasts for 0.5 seconds"},"setPos":{"path":"libs_cl/light.lua#L225","realm":"client","params":[{"type":"Vector","value":"Vector pos The position of the light","name":"pos","description":"The position of the light"}],"class":"function","name":"setPos","description":" Sets the light position"},"setNoModel":{"path":"libs_cl/light.lua#L218","realm":"client","params":[{"type":"boolean","value":"boolean on Whether the light shouldn't cast onto the models","name":"on","description":"Whether the light shouldn't cast onto the models"}],"class":"function","name":"setNoModel","description":" Sets whether the light should cast onto models or not"},"setDirection":{"path":"libs_cl/light.lua#L184","realm":"client","params":[{"type":"Vector","value":"Vector dir Direction of the light","name":"dir","description":"Direction of the light"}],"class":"function","name":"setDirection","description":" Sets the light direction (used with setInnerAngle and setOuterAngle)"}},"class":"type","name":"Light","description":" Light type"},"WebSocket":{"path":"libs_cl/websocket.lua#L97","libtbl":["websocket_methods","websocket_meta"],"realm":"client","methods":{"close":{"path":"libs_cl/websocket.lua#L132","realm":"client","class":"function","name":"close","description":" Closes the websocket connection. Does nothing if already closed"},"write":{"path":"libs_cl/websocket.lua#L137","realm":"client","params":[{"type":"string","value":"string msg What to send","name":"msg","description":"What to send"}],"class":"function","name":"write","description":" Sends a message to the connected websocket stream."},"__tostring":{"path":"libs_cl/websocket.lua#L180","realm":"client","class":"function","name":"__tostring","description":" Returns \"WebSocket: \" alongside the address of the websocket."},"getState":{"path":"libs_cl/websocket.lua#L148","returns":[{"type":"number","value":"number The current state of the websocket.","description":"The current state of the websocket."}],"realm":"client","class":"function","name":"getState","description":" Returns the current state of the websocket.\n https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/readyState\n * 0 - CONNECTING\n * 1 - OPEN\n * 2 - CLOSING\n * 3 - CLOSED"},"__newindex":{"path":"libs_cl/websocket.lua#L159","realm":"client","params":[{"type":"string","value":"string k onMessage, onConnected, onDisconnected","name":"k","description":"onMessage, onConnected, onDisconnected"},{"type":"function","value":"function v The callback function, which will be called with the websocket as the first argument.","name":"v","description":"The callback function, which will be called with the websocket as the first argument."}],"class":"function","name":"__newindex","description":" Sets a callback for the websocket.\n Can be used with the following callbacks:\n * onMessage - Called when a message is received.\n * onConnected - Called when the websocket initially connects.\n * onDisconnected - Called when the websocket is disconnected, with the only param being if it was caused by an 'error' event."},"connect":{"path":"libs_cl/websocket.lua#L143","realm":"client","class":"function","name":"connect","description":" Connects to the websocket server."}},"class":"type","name":"WebSocket","description":" Websocket Type. Create a websocket with WebSocket(...)"},"Material":{"path":"libs_cl/material.lua#L373","libtbl":["material_methods"],"realm":"client","methods":{"getFloat":{"path":"libs_cl/material.lua#L644","returns":[{"type":"number?","value":"number? The float value or nil if it doesn't exist","description":"The float value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string key The key to get the float from","name":"key","description":"The key to get the float from"}],"class":"function","name":"getFloat","description":" Returns a float keyvalue"},"recompute":{"path":"libs_cl/material.lua#L715","realm":"client","class":"function","name":"recompute","description":" Refreshes the material. Sometimes needed for certain parameters to update"},"getMatrix":{"path":"libs_cl/material.lua#L669","returns":[{"type":"VMatrix?","value":"VMatrix? The matrix value or nil if it doesn't exist","description":"The matrix value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string key The key to get the matrix from","name":"key","description":"The key to get the matrix from"}],"class":"function","name":"getMatrix","description":" Returns a matrix keyvalue"},"getColor":{"path":"libs_cl/material.lua#L633","returns":[{"type":"Color","value":"Color The color value","description":"The color value"}],"realm":"client","params":[{"type":"number","value":"number x The x coordinate of the pixel","name":"x","description":"The x coordinate of the pixel"},{"type":"number","value":"number y The y coordinate of the pixel","name":"y","description":"The y coordinate of the pixel"}],"class":"function","name":"getColor","description":" Returns a color pixel value of the $basetexture of a .png or .jpg material."},"getInt":{"path":"libs_cl/material.lua#L653","returns":[{"type":"number?","value":"number? The int value or nil if it doesn't exist","description":"The int value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string key The key to get the int from","name":"key","description":"The key to get the int from"}],"class":"function","name":"getInt","description":" Returns an int keyvalue"},"setInt":{"path":"libs_cl/material.lua#L729","realm":"client","params":[{"type":"string","value":"string key The key name to set","name":"key","description":"The key name to set"},{"type":"number","value":"number v The value to set it to","name":"v","description":"The value to set it to"}],"class":"function","name":"setInt","description":" Sets an int keyvalue"},"getTexture":{"path":"libs_cl/material.lua#L687","returns":[{"type":"string?","value":"string? The string id of the texture or nil if it doesn't exist","description":"The string id of the texture or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string key The key to get the texture from","name":"key","description":"The key to get the texture from"}],"class":"function","name":"getTexture","description":" Returns a texture id keyvalue"},"setFloat":{"path":"libs_cl/material.lua#L720","realm":"client","params":[{"type":"string","value":"string key The key name to set","name":"key","description":"The key name to set"},{"type":"number","value":"number v The value to set it to","name":"v","description":"The value to set it to"}],"class":"function","name":"setFloat","description":" Sets a float keyvalue"},"setTexture":{"path":"libs_cl/material.lua#L755","realm":"client","params":[{"type":"string","value":"string key The key name to set. $basetexture is the key name for most purposes.","name":"key","description":"The key name to set. $basetexture is the key name for most purposes."},{"type":"string","value":"string v The texture name to set it to.","name":"v","description":"The texture name to set it to."}],"class":"function","name":"setTexture","description":" Sets a texture keyvalue"},"setUndefined":{"path":"libs_cl/material.lua#L835","realm":"client","params":[{"type":"string","value":"string key The key name to set","name":"key","description":"The key name to set"}],"class":"function","name":"setUndefined","description":" Sets a keyvalue to be undefined"},"getString":{"path":"libs_cl/material.lua#L678","returns":[{"type":"string?","value":"string? The string value or nil if it doesn't exist","description":"The string value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string key The key to get the string from","name":"key","description":"The key to get the string from"}],"class":"function","name":"getString","description":" Returns a string keyvalue"},"getVectorLinear":{"path":"libs_cl/material.lua#L706","returns":[{"type":"Vector?","value":"Vector? The vector value or nil if it doesn't exist","description":"The vector value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string key The key to get the vector from","name":"key","description":"The key to get the vector from"}],"class":"function","name":"getVectorLinear","description":" Returns a linear color-corrected vector keyvalue"},"setTextureURL":{"path":"libs_cl/material.lua#L765","realm":"client","params":[{"type":"string","value":"string key The key name to set. $basetexture is the key name for most purposes.","name":"key","description":"The key name to set. $basetexture is the key name for most purposes."},{"type":"string","value":"string url The url or base64 data","name":"url","description":"The url or base64 data"},{"type":"function?","value":"function? cb An optional callback called when image is loaded. Passes nil if it fails or Passes the material, url, width, height, and layout function which can be called with x, y, w, h, pixelated to reposition the image in the texture. Setting the optional 'pixelated' argument to True tells the image to use nearest-neighbor interpolation","name":"cb","description":"An optional callback called when image is loaded. Passes nil if it fails or Passes the material, url, width, height, and layout function which can be called with x, y, w, h, pixelated to reposition the image in the texture. Setting the optional 'pixelated' argument to True tells the image to use nearest-neighbor interpolation"},{"type":"function?","value":"function? done An optional callback called when the image is done loading. Passes the material, url","name":"done","description":"An optional callback called when the image is done loading. Passes the material, url"}],"class":"function","name":"setTextureURL","description":" Loads an online image or base64 data to the specified texture key\n If the texture in key is not set to a rendertarget, a rendertarget will be created and used."},"getKeyValues":{"path":"libs_cl/material.lua#L662","returns":[{"type":"table","value":"table The table of keyvalues","description":"The table of keyvalues"}],"realm":"client","class":"function","name":"getKeyValues","description":" Returns a table of material keyvalues"},"getName":{"path":"libs_cl/material.lua#L605","returns":[{"type":"string","value":"string The name of the material. If this material is user created, add ! to the beginning of this to use it with entity.setMaterial","description":"The name of the material. If this material is user created, add ! to the beginning of this to use it with entity.setMaterial"}],"realm":"client","class":"function","name":"getName","description":" Returns the material's engine name"},"destroy":{"path":"libs_cl/material.lua#L587","realm":"client","class":"function","name":"destroy","description":" Frees a user created material allowing you to create others"},"setVector":{"path":"libs_cl/material.lua#L842","realm":"client","params":[{"type":"string","value":"string key The key name to set","name":"key","description":"The key name to set"},{"type":"Vector","value":"Vector v The value to set it to","name":"v","description":"The value to set it to"}],"class":"function","name":"setVector","description":" Sets a vector keyvalue"},"setString":{"path":"libs_cl/material.lua#L746","realm":"client","params":[{"type":"string","value":"string key The key name to set","name":"key","description":"The key name to set"},{"type":"string","value":"string v The value to set it to","name":"v","description":"The value to set it to"}],"class":"function","name":"setString","description":" Sets a string keyvalue"},"setMatrix":{"path":"libs_cl/material.lua#L738","realm":"client","params":[{"type":"string","value":"string key The key name to set","name":"key","description":"The key name to set"},{"type":"VMatrix","value":"VMatrix v The value to set it to","name":"v","description":"The value to set it to"}],"class":"function","name":"setMatrix","description":" Sets a matrix keyvalue"},"getShader":{"path":"libs_cl/material.lua#L612","returns":[{"type":"string","value":"string The shader name of the material","description":"The shader name of the material"}],"realm":"client","class":"function","name":"getShader","description":" Returns the shader name of the material"},"getVector":{"path":"libs_cl/material.lua#L697","returns":[{"type":"Vector?","value":"Vector? The vector value or nil if it doesn't exist","description":"The vector value or nil if it doesn't exist"}],"realm":"client","params":[{"type":"string","value":"string key The key to get the vector from","name":"key","description":"The key to get the vector from"}],"class":"function","name":"getVector","description":" Returns a vector keyvalue"},"setTextureRenderTarget":{"path":"libs_cl/material.lua#L821","realm":"client","params":[{"type":"string","value":"string key The key name to set. $basetexture is the key name for most purposes.","name":"key","description":"The key name to set. $basetexture is the key name for most purposes."},{"type":"string","value":"string name The name of the rendertarget","name":"name","description":"The name of the rendertarget"}],"class":"function","name":"setTextureRenderTarget","description":" Sets a rendertarget texture to the specified texture key"},"getWidth":{"path":"libs_cl/material.lua#L619","returns":[{"type":"number","value":"number The basetexture's width","description":"The basetexture's width"}],"realm":"client","class":"function","name":"getWidth","description":" Gets the base texture set to the material's width"},"getHeight":{"path":"libs_cl/material.lua#L626","returns":[{"type":"number","value":"number The basetexture's height","description":"The basetexture's height"}],"realm":"client","class":"function","name":"getHeight","description":" Gets the base texture set to the material's height"}},"class":"type","name":"Material","description":" The `Material` type is used to control shaders in rendering.\n For a list of shader parameters, see https://developer.valvesoftware.com/wiki/Category:List_of_Shader_Parameters\n For a list of $flags and $flags2, see https://developer.valvesoftware.com/wiki/Material_Flags"},"File":{"path":"libs_cl/file.lua#L29","libtbl":["file_methods"],"realm":"client","methods":{"readUInt64":{"path":"libs_cl/file.lua#L504","returns":[{"type":"string","value":"string UInt64 number","description":"UInt64 number"}],"realm":"client","class":"function","name":"readUInt64","description":" Reads an unsigned 64-bit integer and advances the file position\n Note: Since Lua cannot store full 64-bit integers, this function returns a string."},"write":{"path":"libs_cl/file.lua#L511","realm":"client","params":[{"type":"string","value":"string str The data to write","name":"str","description":"The data to write"}],"class":"function","name":"write","description":" Writes a string to the file and advances the file position"},"readShort":{"path":"libs_cl/file.lua#L492","returns":[{"type":"number","value":"number Int16 number","description":"Int16 number"}],"realm":"client","class":"function","name":"readShort","description":" Reads a short and advances the file position"},"readUShort":{"path":"libs_cl/file.lua#L498","returns":[{"type":"number","value":"number UInt16 number","description":"UInt16 number"}],"realm":"client","class":"function","name":"readUShort","description":" Reads an unsigned short and advances the file position"},"seek":{"path":"libs_cl/file.lua#L416","realm":"client","params":[{"type":"number","value":"number n The position to set it to","name":"n","description":"The position to set it to"}],"class":"function","name":"seek","description":" Sets the file position"},"readULong":{"path":"libs_cl/file.lua#L486","returns":[{"type":"number","value":"number UInt32 number","description":"UInt32 number"}],"realm":"client","class":"function","name":"readULong","description":" Reads an unsigned long and advances the file position"},"writeLong":{"path":"libs_cl/file.lua#L546","realm":"client","params":[{"type":"number","value":"number x The long to write","name":"x","description":"The long to write"}],"class":"function","name":"writeLong","description":" Writes a long and advances the file position"},"flush":{"path":"libs_cl/file.lua#L404","realm":"client","class":"function","name":"flush","description":" Wait until all changes to the file are complete"},"writeDouble":{"path":"libs_cl/file.lua#L532","realm":"client","params":[{"type":"number","value":"number x The double to write","name":"x","description":"The double to write"}],"class":"function","name":"writeDouble","description":" Writes a double and advances the file position"},"readLine":{"path":"libs_cl/file.lua#L474","returns":[{"type":"string","value":"string Line contents","description":"Line contents"}],"realm":"client","class":"function","name":"readLine","description":" Reads a line and advances the file position"},"readBool":{"path":"libs_cl/file.lua#L450","returns":[{"type":"boolean","value":"boolean Boolean","description":"Boolean"}],"realm":"client","class":"function","name":"readBool","description":" Reads a boolean and advances the file position"},"writeUInt64":{"path":"libs_cl/file.lua#L574","realm":"client","params":[{"type":"string","value":"string x The unsigned 64-bit integer to write","name":"x","description":"The unsigned 64-bit integer to write"}],"class":"function","name":"writeUInt64","description":" Writes an unsigned 64-bit integer and advances the file position\n Note: Since Lua cannot store full 64-bit integers, this function takes a string."},"writeByte":{"path":"libs_cl/file.lua#L525","realm":"client","params":[{"type":"number","value":"number x The byte to write","name":"x","description":"The byte to write"}],"class":"function","name":"writeByte","description":" Writes a byte and advances the file position"},"size":{"path":"libs_cl/file.lua#L437","returns":[{"type":"number","value":"number The file's size","description":"The file's size"}],"realm":"client","class":"function","name":"size","description":" Returns the file's size in bytes"},"readByte":{"path":"libs_cl/file.lua#L456","returns":[{"type":"number","value":"number UInt8 number","description":"UInt8 number"}],"realm":"client","class":"function","name":"readByte","description":" Reads a byte and advances the file position"},"readFloat":{"path":"libs_cl/file.lua#L468","returns":[{"type":"number","value":"number Float32 number","description":"Float32 number"}],"realm":"client","class":"function","name":"readFloat","description":" Reads a float and advances the file position"},"writeULong":{"path":"libs_cl/file.lua#L553","realm":"client","params":[{"type":"number","value":"number x The unsigned long to write","name":"x","description":"The unsigned long to write"}],"class":"function","name":"writeULong","description":" Writes an unsigned long and advances the file position"},"writeFloat":{"path":"libs_cl/file.lua#L539","realm":"client","params":[{"type":"number","value":"number x The float to write","name":"x","description":"The float to write"}],"class":"function","name":"writeFloat","description":" Writes a float and advances the file position"},"writeUShort":{"path":"libs_cl/file.lua#L567","realm":"client","params":[{"type":"number","value":"number x The unsigned short to write","name":"x","description":"The unsigned short to write"}],"class":"function","name":"writeUShort","description":" Writes an unsigned short and advances the file position"},"readLong":{"path":"libs_cl/file.lua#L480","returns":[{"type":"number","value":"number Int32 number","description":"Int32 number"}],"realm":"client","class":"function","name":"readLong","description":" Reads a long and advances the file position"},"readDouble":{"path":"libs_cl/file.lua#L462","returns":[{"type":"number","value":"number Float64 number","description":"Float64 number"}],"realm":"client","class":"function","name":"readDouble","description":" Reads a double and advances the file position"},"writeBool":{"path":"libs_cl/file.lua#L518","realm":"client","params":[{"type":"boolean","value":"boolean x The boolean to write","name":"x","description":"The boolean to write"}],"class":"function","name":"writeBool","description":" Writes a boolean and advances the file position"},"skip":{"path":"libs_cl/file.lua#L423","returns":[{"type":"number","value":"number The resulting position","description":"The resulting position"}],"realm":"client","params":[{"type":"number","value":"number n How much to move the position","name":"n","description":"How much to move the position"}],"class":"function","name":"skip","description":" Moves the file position relative to its current position"},"writeShort":{"path":"libs_cl/file.lua#L560","realm":"client","params":[{"type":"number","value":"number x The short to write","name":"x","description":"The short to write"}],"class":"function","name":"writeShort","description":" Writes a short and advances the file position"},"tell":{"path":"libs_cl/file.lua#L431","returns":[{"type":"number","value":"number The current file position","description":"The current file position"}],"realm":"client","class":"function","name":"tell","description":" Returns the current file position"},"close":{"path":"libs_cl/file.lua#L409","realm":"client","class":"function","name":"close","description":" Flushes and closes the file. The file must be opened again to use a new file object."},"read":{"path":"libs_cl/file.lua#L443","returns":[{"type":"string","value":"string The data","description":"The data"}],"realm":"client","params":[{"type":"number","value":"number n The length to read","name":"n","description":"The length to read"}],"class":"function","name":"read","description":" Reads a certain length of the file's bytes"}},"class":"type","name":"File","description":" File type"},"Quaternion":{"path":"libs_sh/quaternion.lua#L157","methods":{"getMatrix":{"path":"libs_sh/quaternion.lua#L668","returns":[{"type":"VMatrix","value":"VMatrix Transformation matrix","description":"Transformation matrix"}],"realm":"shared","params":[{"type":"boolean?","value":"boolean? Optional bool, normalizes the quaternion","name":"Optional","description":"bool, normalizes the quaternion"}],"class":"function","name":"getMatrix","description":" Converts quaternion to a matrix"},"getMod":{"path":"libs_sh/quaternion.lua#L624","returns":[{"type":"Quaternion","value":"Quaternion Quaternion with contained rotation","description":"Quaternion with contained rotation"}],"realm":"shared","class":"function","name":"getMod","description":" Gets the quaternion representing rotation contained within an angle between 0 and 180 degrees"},"__mul":{"path":"libs_sh/quaternion.lua#L275","returns":[{"type":"Quaternion","value":"Quaternion Product","description":"Product"}],"realm":"shared","params":[{"type":"Quaternion|number","value":"Quaternion|number lhs Left side of equation. Quaternion or number","name":"lhs","description":"Left side of equation. Quaternion or number"},{"type":"Quaternion|number","value":"Quaternion|number rhs Right side of equation. Quaternion or number","name":"rhs","description":"Right side of equation. Quaternion or number"}],"class":"function","name":"__mul","description":" Multiplication metamethod"},"getForward":{"path":"libs_sh/quaternion.lua#L570","returns":[{"type":"Vector","value":"Vector Vector pointing forward","description":"Vector pointing forward"}],"realm":"shared","class":"function","name":"getForward","description":" Calculates forward direction of the quaternion"},"__sub":{"path":"libs_sh/quaternion.lua#L407","returns":[{"type":"Quaternion","value":"Quaternion Difference","description":"Difference"}],"realm":"shared","params":[{"type":"Quaternion|number","value":"Quaternion|number lhs Left side of equation. Quaternion or number","name":"lhs","description":"Left side of equation. Quaternion or number"},{"type":"Quaternion|number","value":"Quaternion|number rhs Right side of equation. Quaternion or number","name":"rhs","description":"Right side of equation. Quaternion or number"}],"class":"function","name":"__sub","description":" Subtraction metamethod"},"__unm":{"path":"libs_sh/quaternion.lua#L428","returns":[{"type":"Quaternion","value":"Quaternion Negated quaternion","description":"Negated quaternion"}],"realm":"shared","class":"function","name":"__unm","description":" Unary minus metamethod"},"set":{"path":"libs_sh/quaternion.lua#L475","realm":"shared","params":[{"type":"Quaternion","value":"Quaternion quat Quaternion to copy from","name":"quat","description":"Quaternion to copy from"}],"class":"function","name":"set","description":" Copies components of the second quaternion to the first quaternion.\n Self-Modifies. Does not return anything"},"getRight":{"path":"libs_sh/quaternion.lua#L558","returns":[{"type":"Vector","value":"Vector Vector pointing right","description":"Vector pointing right"}],"realm":"shared","class":"function","name":"getRight","description":" Calculates right direction of the quaternion"},"getRotationVector":{"path":"libs_sh/quaternion.lua#L759","returns":[{"type":"Vector","value":"Vector Rotation vector","description":"Rotation vector"}],"realm":"shared","class":"function","name":"getRotationVector","description":" Returns the rotation vector - rotation axis where magnitude is the angle of rotation in degrees"},"__pow":{"path":"libs_sh/quaternion.lua#L349","returns":[{"type":"Quaternion","value":"Quaternion Power","description":"Power"}],"realm":"shared","params":[{"type":"Quaternion|number","value":"Quaternion|number lhs Left side of equation. Quaternion or number","name":"lhs","description":"Left side of equation. Quaternion or number"},{"type":"Quaternion|number","value":"Quaternion|number rhs Right side of equation. Quaternion or number","name":"rhs","description":"Right side of equation. Quaternion or number"}],"class":"function","name":"__pow","description":" Involution metamethod"},"__newindex":{"path":"libs_sh/quaternion.lua#L215","realm":"shared","params":[{"type":"number|string","value":"number|string Key","name":"Key","description":""},{"type":"number","value":"number Value to set","name":"Value","description":"to set"}],"class":"function","name":"__newindex","description":" Newindex metamethod"},"conjugate":{"path":"libs_sh/quaternion.lua#L604","realm":"shared","class":"function","name":"conjugate","description":" Conjugates the quaternion.\n Self-Modifies. Does not return anything"},"getExp":{"path":"libs_sh/quaternion.lua#L516","returns":[{"type":"Quaternion","value":"Quaternion Constant e raised to the quaternion","description":"Constant e raised to the quaternion"}],"realm":"shared","class":"function","name":"getExp","description":" Raises Euler's constant e to the quaternion's power"},"pack":{"path":"libs_sh/quaternion.lua#L450","realm":"shared","params":[{"type":"number","value":"number r R component","name":"r","description":"R component"},{"type":"number","value":"number i I component","name":"i","description":"I component"},{"type":"number","value":"number j J component","name":"j","description":"J component"},{"type":"number","value":"number k K component","name":"k","description":"K component"}],"class":"function","name":"pack","description":" Set components of the quaternion\n Self-Modifies. Does not return anything"},"getNormalized":{"path":"libs_sh/quaternion.lua#L638","returns":[{"type":"Quaternion","value":"Quaternion Normalized quaternion","description":"Normalized quaternion"}],"realm":"shared","class":"function","name":"getNormalized","description":" Returns new normalized quaternion"},"setK":{"path":"libs_sh/quaternion.lua#L506","returns":[{"type":"Quaternion","value":"Quaternion self","description":"self"}],"realm":"shared","params":[{"type":"number","value":"number k Value of the K component","name":"k","description":"Value of the K component"}],"class":"function","name":"setK","description":" Sets K component of the quaternion and returns self after modification"},"log":{"path":"libs_sh/quaternion.lua#L538","realm":"shared","class":"function","name":"log","description":" Calculates natural logarithm of the quaternion.\n Self-Modifies. Does not return anything"},"setR":{"path":"libs_sh/quaternion.lua#L482","returns":[{"type":"Quaternion","value":"Quaternion self","description":"self"}],"realm":"shared","params":[{"type":"number","value":"number r Value of the R component","name":"r","description":"Value of the R component"}],"class":"function","name":"setR","description":" Sets R (real) component of the quaternion and returns self after modification"},"getRotationAngle":{"path":"libs_sh/quaternion.lua#L723","returns":[{"type":"number","value":"number Angle number","description":"Angle number"}],"realm":"shared","params":[{"type":"boolean?","value":"boolean? full Optional bool, if true returned angle will be between -180 and 180, otherwise between 0 and 360","name":"full","description":"Optional bool, if true returned angle will be between -180 and 180, otherwise between 0 and 360"}],"class":"function","name":"getRotationAngle","description":" Returns the angle of rotation in degrees"},"mod":{"path":"libs_sh/quaternion.lua#L632","realm":"shared","class":"function","name":"mod","description":" Contains quaternion's represented rotation within an angle between 0 and 180 degrees.\n Self-Modifies. Does not return anything"},"getEulerAngle":{"path":"libs_sh/quaternion.lua#L692","returns":[{"type":"Angle","value":"Angle Angle object","description":"Angle object"}],"realm":"shared","class":"function","name":"getEulerAngle","description":" Returns the euler angle of rotation in degrees"},"getVector":{"path":"libs_sh/quaternion.lua#L661","returns":[{"type":"Vector","value":"Vector Vector from the quaternion","description":"Vector from the quaternion"}],"realm":"shared","class":"function","name":"getVector","description":" Converts quaternion to a vector by dropping the R (real) component"},"setI":{"path":"libs_sh/quaternion.lua#L490","returns":[{"type":"Quaternion","value":"Quaternion self","description":"self"}],"realm":"shared","params":[{"type":"number","value":"number i Value of the I component","name":"i","description":"Value of the I component"}],"class":"function","name":"setI","description":" Sets I component of the quaternion and returns self after modification"},"getNormSqr":{"path":"libs_sh/quaternion.lua#L590","returns":[{"type":"number","value":"number squared norm/absolute value","description":"squared norm/absolute value"}],"realm":"shared","class":"function","name":"getNormSqr","description":" Returns squared norm of the quaternion"},"getNorm":{"path":"libs_sh/quaternion.lua#L584","returns":[{"type":"number","value":"number norm value","description":"norm value"}],"realm":"shared","class":"function","name":"getNorm","description":" Returns norm of the quaternion"},"__index":{"path":"libs_sh/quaternion.lua#L248","returns":[{"type":"number","value":"number Found value","description":"Found value"}],"realm":"shared","params":[{"type":"number|string","value":"number|string Key","name":"Key","description":""}],"class":"function","name":"__index","description":" Index metamethod\n Can be indexed with: 1, 2, 3, 4, r, i, j, k, rr, ri, rj, rk, rrr, rijk, kjir, etc. Numerical lookup is the most efficient"},"dot":{"path":"libs_sh/quaternion.lua#L652","returns":[{"type":"number","value":"number The dot product","description":"The dot product"}],"realm":"shared","params":[{"type":"Quaternion","value":"Quaternion quat Second quaternion","name":"quat","description":"Second quaternion"}],"class":"function","name":"dot","description":" Returns dot product of two quaternions"},"normalize":{"path":"libs_sh/quaternion.lua#L646","realm":"shared","class":"function","name":"normalize","description":" Normalizes the quaternion.\n Self-Modifies. Does not return anything"},"setJ":{"path":"libs_sh/quaternion.lua#L498","returns":[{"type":"Quaternion","value":"Quaternion self","description":"self"}],"realm":"shared","params":[{"type":"number","value":"number j Value of the J component","name":"j","description":"Value of the J component"}],"class":"function","name":"setJ","description":" Sets J component of the quaternion and returns self after modification"},"clone":{"path":"libs_sh/quaternion.lua#L469","returns":[{"type":"Quaternion","value":"Quaternion Duplicate quaternion","description":"Duplicate quaternion"}],"realm":"shared","class":"function","name":"clone","description":" Creates a copy of the quaternion"},"getRotationAxis":{"path":"libs_sh/quaternion.lua#L746","returns":[{"type":"Vector","value":"Vector Vector axis","description":"Vector axis"}],"realm":"shared","class":"function","name":"getRotationAxis","description":" Returns the axis of rotation"},"__add":{"path":"libs_sh/quaternion.lua#L380","returns":[{"type":"Quaternion","value":"Quaternion Sum","description":"Sum"}],"realm":"shared","params":[{"type":"Quaternion|number","value":"Quaternion|number lhs Left side of equation. Quaternion or number","name":"lhs","description":"Left side of equation. Quaternion or number"},{"type":"Quaternion|number","value":"Quaternion|number rhs Right side of equation. Quaternion or number","name":"rhs","description":"Right side of equation. Quaternion or number"}],"class":"function","name":"__add","description":" Addition metamethod"},"getLog":{"path":"libs_sh/quaternion.lua#L530","returns":[{"type":"Quaternion","value":"Quaternion Logarithmic quaternion","description":"Logarithmic quaternion"}],"realm":"shared","class":"function","name":"getLog","description":" Calculates natural logarithm of the quaternion"},"exp":{"path":"libs_sh/quaternion.lua#L524","realm":"shared","class":"function","name":"exp","description":" Raises Euler's constant e to the quaternion's power.\n Self-Modifies. Does not return anything"},"inverse":{"path":"libs_sh/quaternion.lua#L618","realm":"shared","class":"function","name":"inverse","description":" Calculates inverse of the quaternion.\n Self-Modifies. Does not return anything"},"__eq":{"path":"libs_sh/quaternion.lua#L434","returns":[{"type":"boolean","value":"boolean True if both sides are equal","description":"True if both sides are equal"}],"realm":"shared","params":[{"type":"Quaternion","value":"Quaternion rhs Quaternion to compare to","name":"rhs","description":"Quaternion to compare to"}],"class":"function","name":"__eq","description":" Equivalence metamethod"},"getUp":{"path":"libs_sh/quaternion.lua#L546","returns":[{"type":"Vector","value":"Vector Vector pointing up","description":"Vector pointing up"}],"realm":"shared","class":"function","name":"getUp","description":" Calculates upward direction of the quaternion"},"__tostring":{"path":"libs_sh/quaternion.lua#L441","returns":[{"type":"string","value":"string Quaternion represented as a string","description":"Quaternion represented as a string"}],"realm":"shared","params":[{"type":"Quaternion","value":"Quaternion q Quaternion","name":"q","description":"Quaternion"}],"class":"function","name":"__tostring","description":" Tostring metamethod"},"unpack":{"path":"libs_sh/quaternion.lua#L460","returns":[{"type":"number","value":"number r","description":"r"},{"type":"number","value":"number i","description":"i"},{"type":"number","value":"number j","description":"j"},{"type":"number","value":"number k","description":"k"}],"realm":"shared","class":"function","name":"unpack","description":" Returns components of the quaternion"},"__div":{"path":"libs_sh/quaternion.lua#L314","returns":[{"type":"Quaternion","value":"Quaternion Quotient","description":"Quotient"}],"realm":"shared","params":[{"type":"Quaternion|number","value":"Quaternion|number lhs Left side of equation. Quaternion or number","name":"lhs","description":"Left side of equation. Quaternion or number"},{"type":"Quaternion|number","value":"Quaternion|number rhs Right side of equation. Quaternion or number","name":"rhs","description":"Right side of equation. Quaternion or number"}],"class":"function","name":"__div","description":" Division metamethod"},"getInverse":{"path":"libs_sh/quaternion.lua#L610","returns":[{"type":"Quaternion","value":"Quaternion Inverse of the quaternion","description":"Inverse of the quaternion"}],"realm":"shared","class":"function","name":"getInverse","description":" Calculates inverse of the quaternion"},"getConjugate":{"path":"libs_sh/quaternion.lua#L596","returns":[{"type":"Quaternion","value":"Quaternion Quaternion's conjugate","description":"Quaternion's conjugate"}],"realm":"shared","class":"function","name":"getConjugate","description":" Returns conjugate of the quaternion"}},"fields":[{"name":"r","description":"The r value of the quaternion. Can also be indexed with [1]"},{"name":"i","description":"The i value of the quaternion. Can also be indexed with [2]"},{"name":"j","description":"The j value of the quaternion. Can also be indexed with [3]"},{"name":"k","description":"The k value of the quaternion. Can also be indexed with [4]"}],"realm":"shared","libtbl":["quat_methods","quat_meta"],"class":"type","name":"Quaternion","description":" Quaternion type. Recently reworked, for full changelist visit: https://github.com/thegrb93/StarfallEx/pull/953"},"Effect":{"path":"libs_sh/effect.lua#L23","libtbl":["effect_methods"],"realm":"shared","methods":{"setAttachment":{"path":"libs_sh/effect.lua#L180","realm":"shared","params":[{"type":"number","value":"number attachment The new attachment ID of the effect","name":"attachment","description":"The new attachment ID of the effect"}],"class":"function","name":"setAttachment","description":" Sets the effect's attachment"},"setRadius":{"path":"libs_sh/effect.lua#L255","realm":"shared","params":[{"type":"number","value":"number radius The radius","name":"radius","description":"The radius"}],"class":"function","name":"setRadius","description":" Sets the effect's radius"},"getAttachment":{"path":"libs_sh/effect.lua#L84","returns":[{"type":"number","value":"number The effect's attachment ID","description":"The effect's attachment ID"}],"realm":"shared","class":"function","name":"getAttachment","description":" Returns the effect's attachment"},"getRadius":{"path":"libs_sh/effect.lua#L150","returns":[{"type":"number","value":"number The effect's radius","description":"The effect's radius"}],"realm":"shared","class":"function","name":"getRadius","description":" Returns the effect's radius"},"getScale":{"path":"libs_sh/effect.lua#L156","returns":[{"type":"number","value":"number The effect's scale","description":"The effect's scale"}],"realm":"shared","class":"function","name":"getScale","description":" Returns the effect's scale"},"getSurfaceProp":{"path":"libs_sh/effect.lua#L168","returns":[{"type":"number","value":"number The effect's surface property index","description":"The effect's surface property index"}],"realm":"shared","class":"function","name":"getSurfaceProp","description":" Returns the effect's surface prop"},"getMaterialIndex":{"path":"libs_sh/effect.lua#L132","returns":[{"type":"number","value":"number The effect's material index","description":"The effect's material index"}],"realm":"shared","class":"function","name":"getMaterialIndex","description":" Returns the effect's material index"},"setColor":{"path":"libs_sh/effect.lua#L187","realm":"shared","params":[{"type":"number","value":"number color The color represented by a byte 0-255.","name":"color","description":"The color represented by a byte 0-255."}],"class":"function","name":"setColor","description":" Sets the effect's color\n Internally stored as an integer, but only first 8 bits are networked, effectively limiting this function to 0-255 range."},"setOrigin":{"path":"libs_sh/effect.lua#L249","realm":"shared","params":[{"type":"Vector","value":"Vector origin The vector origin","name":"origin","description":"The vector origin"}],"class":"function","name":"setOrigin","description":" Sets the effect's origin"},"setMaterialIndex":{"path":"libs_sh/effect.lua#L236","realm":"shared","params":[{"type":"number","value":"number mat The material index","name":"mat","description":"The material index"}],"class":"function","name":"setMaterialIndex","description":" Sets the effect's material index"},"setSurfaceProp":{"path":"libs_sh/effect.lua#L276","realm":"shared","params":[{"type":"number","value":"number prop The surface property index","name":"prop","description":"The surface property index"}],"class":"function","name":"setSurfaceProp","description":" Sets the effect's surface property\n Internally stored as an integer, but only first 8 bits are networked, effectively limiting this function to -1-254 range.(yes, that's not a mistake)"},"getStart":{"path":"libs_sh/effect.lua#L162","returns":[{"type":"Vector","value":"Vector The effect's start position","description":"The effect's start position"}],"realm":"shared","class":"function","name":"getStart","description":" Returns the effect's start position"},"setHitBox":{"path":"libs_sh/effect.lua#L222","realm":"shared","params":[{"type":"number","value":"number hitbox The hitbox","name":"hitbox","description":"The hitbox"}],"class":"function","name":"setHitBox","description":" Sets the effect's hitbox"},"setNormal":{"path":"libs_sh/effect.lua#L243","realm":"shared","params":[{"type":"Vector","value":"Vector normal The vector normal","name":"normal","description":"The vector normal"}],"class":"function","name":"setNormal","description":" Sets the effect's normal"},"getColor":{"path":"libs_sh/effect.lua#L90","returns":[{"type":"number","value":"number The effect's color as a byte","description":"The effect's color as a byte"}],"realm":"shared","class":"function","name":"getColor","description":" Returns byte which represents the color of the effect."},"getOrigin":{"path":"libs_sh/effect.lua#L144","returns":[{"type":"Vector","value":"Vector The effect's origin","description":"The effect's origin"}],"realm":"shared","class":"function","name":"getOrigin","description":" Returns the effect's origin"},"setEntIndex":{"path":"libs_sh/effect.lua#L202","realm":"shared","params":[{"type":"number","value":"number index The entity index","name":"index","description":"The entity index"}],"class":"function","name":"setEntIndex","description":" Sets the effect's entity index"},"setStart":{"path":"libs_sh/effect.lua#L269","realm":"shared","params":[{"type":"Vector","value":"Vector start The vector start","name":"start","description":"The vector start"}],"class":"function","name":"setStart","description":" Sets the effect's start pos\n Limited to world bounds (+-16386 on every axis) and has horrible networking precision. (17 bit float per component)"},"play":{"path":"libs_sh/effect.lua#L63","realm":"shared","params":[{"type":"string","value":"string eff The effect type name to play","name":"eff","description":"The effect type name to play"}],"class":"function","name":"play","description":" Plays the effect"},"setMagnitude":{"path":"libs_sh/effect.lua#L229","realm":"shared","params":[{"type":"number","value":"number magnitude The magnitude","name":"magnitude","description":"The magnitude"}],"class":"function","name":"setMagnitude","description":" Sets the effect's magnitude"},"setAngles":{"path":"libs_sh/effect.lua#L174","realm":"shared","params":[{"type":"Angle","value":"Angle ang The angles","name":"ang","description":"The angles"}],"class":"function","name":"setAngles","description":" Sets the effect's angles"},"getEntity":{"path":"libs_sh/effect.lua#L108","returns":[{"type":"Entity","value":"Entity The effect's entity","description":"The effect's entity"}],"realm":"shared","class":"function","name":"getEntity","description":" Returns the effect's entity"},"getAngles":{"path":"libs_sh/effect.lua#L78","returns":[{"type":"Angle","value":"Angle The effect's angle","description":"The effect's angle"}],"realm":"shared","class":"function","name":"getAngles","description":" Returns the effect's angle"},"getHitBox":{"path":"libs_sh/effect.lua#L120","returns":[{"type":"number","value":"number The effect's hitbox ID","description":"The effect's hitbox ID"}],"realm":"shared","class":"function","name":"getHitBox","description":" Returns the effect's hitbox ID"},"setDamageType":{"path":"libs_sh/effect.lua#L195","realm":"shared","params":[{"type":"number","value":"number dmgtype The damage type, see the DMG enums","name":"dmgtype","description":"The damage type, see the DMG enums"}],"class":"function","name":"setDamageType","description":" Sets the effect's damage type"},"getNormal":{"path":"libs_sh/effect.lua#L138","returns":[{"type":"Vector","value":"Vector The effect's normal","description":"The effect's normal"}],"realm":"shared","class":"function","name":"getNormal","description":" Returns the effect's normal"},"getDamageType":{"path":"libs_sh/effect.lua#L96","returns":[{"type":"number","value":"number The effect's damagetype","description":"The effect's damagetype"}],"realm":"shared","class":"function","name":"getDamageType","description":" Returns the effect's damagetype"},"getFlags":{"path":"libs_sh/effect.lua#L114","returns":[{"type":"number","value":"number The effect's flags","description":"The effect's flags"}],"realm":"shared","class":"function","name":"getFlags","description":" Returns the effect's flags"},"setFlags":{"path":"libs_sh/effect.lua#L215","realm":"shared","params":[{"type":"number","value":"number flags The flags","name":"flags","description":"The flags"}],"class":"function","name":"setFlags","description":" Sets the effect's flags"},"getMagnitude":{"path":"libs_sh/effect.lua#L126","returns":[{"type":"number","value":"number The effect's magnitude","description":"The effect's magnitude"}],"realm":"shared","class":"function","name":"getMagnitude","description":" Returns the effect's magnitude"},"setEntity":{"path":"libs_sh/effect.lua#L209","realm":"shared","params":[{"type":"Entity","value":"Entity ent The entity","name":"ent","description":"The entity"}],"class":"function","name":"setEntity","description":" Sets the effect's entity"},"getEntIndex":{"path":"libs_sh/effect.lua#L102","returns":[{"type":"number","value":"number The effect's entindex","description":"The effect's entindex"}],"realm":"shared","class":"function","name":"getEntIndex","description":" Returns the effect's entindex"},"setScale":{"path":"libs_sh/effect.lua#L262","realm":"shared","params":[{"type":"number","value":"number scale The number scale","name":"scale","description":"The number scale"}],"class":"function","name":"setScale","description":" Sets the effect's scale"}},"class":"type","name":"Effect","description":" Effect type"},"Weapon":{"path":"libs_sh/weapons.lua#L6","libtbl":["weapon_methods","weapon_meta"],"realm":"shared","methods":{"getNextSecondaryFire":{"path":"libs_sh/weapons.lua#L83","returns":[{"type":"number","value":"number The time, relative to CurTime","description":"The time, relative to CurTime"}],"realm":"shared","class":"function","name":"getNextSecondaryFire","description":" Gets the next time the weapon can secondary fire."},"lastShootTime":{"path":"libs_sh/weapons.lua#L111","returns":[{"type":"number","value":"number Time the weapon was last shot","description":"Time the weapon was last shot"}],"realm":"shared","class":"function","name":"lastShootTime","description":" Returns the time since a weapon was last fired at a float variable"},"clip1":{"path":"libs_sh/weapons.lua#L34","returns":[{"type":"number","value":"number Amount of ammo","description":"Amount of ammo"}],"realm":"shared","class":"function","name":"clip1","description":" Returns Ammo in primary clip"},"maxClip1":{"path":"libs_sh/weapons.lua#L41","returns":[{"type":"number","value":"number Amount of ammo","description":"Amount of ammo"}],"realm":"shared","class":"function","name":"maxClip1","description":" Returns Maximum ammo in primary clip"},"getActivity":{"path":"libs_sh/weapons.lua#L62","returns":[{"type":"number","value":"number Current activity","description":"Current activity"}],"realm":"shared","class":"function","name":"getActivity","description":" Returns the sequence enumeration number that the weapon is playing. Must be used on a view model."},"maxClip2":{"path":"libs_sh/weapons.lua#L55","returns":[{"type":"number","value":"number Amount of ammo","description":"Amount of ammo"}],"realm":"shared","class":"function","name":"maxClip2","description":" Returns Maximum ammo in secondary clip"},"getNextPrimaryFire":{"path":"libs_sh/weapons.lua#L76","returns":[{"type":"number","value":"number The time, relative to CurTime","description":"The time, relative to CurTime"}],"realm":"shared","class":"function","name":"getNextPrimaryFire","description":" Gets the next time the weapon can primary fire."},"isCarriedByLocalPlayer":{"path":"libs_sh/weapons.lua#L134","returns":[{"type":"boolean","value":"boolean Whether or not the weapon is carried by the local player","description":"Whether or not the weapon is carried by the local player"}],"realm":"client","class":"function","name":"isCarriedByLocalPlayer","description":" Returns if the weapon is carried by the local player."},"getPrintName":{"path":"libs_sh/weapons.lua#L127","returns":[{"type":"string","value":"string Display name of weapon","description":"Display name of weapon"}],"realm":"client","class":"function","name":"getPrintName","description":" Gets Display name of weapon"},"getToolMode":{"path":"libs_sh/weapons.lua#L118","returns":[{"type":"string","value":"string The tool mode of the toolgun","description":"The tool mode of the toolgun"}],"realm":"shared","class":"function","name":"getToolMode","description":" Returns the tool mode of the toolgun"},"isWeaponVisible":{"path":"libs_sh/weapons.lua#L104","returns":[{"type":"boolean","value":"boolean Whether the weapon is visible or not","description":"Whether the weapon is visible or not"}],"realm":"shared","class":"function","name":"isWeaponVisible","description":" Returns whether the weapon is visible"},"clip2":{"path":"libs_sh/weapons.lua#L48","returns":[{"type":"number","value":"number Amount of ammo","description":"Amount of ammo"}],"realm":"shared","class":"function","name":"clip2","description":" Returns Ammo in secondary clip"},"getSecondaryAmmoType":{"path":"libs_sh/weapons.lua#L97","returns":[{"type":"number","value":"number Ammo number type","description":"Ammo number type"}],"realm":"shared","class":"function","name":"getSecondaryAmmoType","description":" Gets the secondary ammo type of the given weapon."},"getHoldType":{"path":"libs_sh/weapons.lua#L69","returns":[{"type":"string","value":"string Holdtype","description":"Holdtype"}],"realm":"shared","class":"function","name":"getHoldType","description":" Returns the hold type of the weapon."},"getPrimaryAmmoType":{"path":"libs_sh/weapons.lua#L90","returns":[{"type":"number","value":"number Ammo number type","description":"Ammo number type"}],"realm":"shared","class":"function","name":"getPrimaryAmmoType","description":" Gets the primary ammo type of the given weapon."}},"class":"type","name":"Weapon","description":" Weapon type"},"Particle":{"path":"libs_cl/particle.lua#L25","libtbl":["particle_methods"],"realm":"client","methods":{"setVelocity":{"path":"libs_cl/particle.lua#L295","realm":"client","params":[{"type":"Vector","value":"Vector vel Velocity to set to","name":"vel","description":"Velocity to set to"}],"class":"function","name":"setVelocity","description":" Sets the velocity of the particle."},"setAngleVelocity":{"path":"libs_cl/particle.lua#L235","realm":"client","params":[{"type":"Angle","value":"Angle angVel Angular velocity to set the particle's to","name":"angVel","description":"Angular velocity to set the particle's to"}],"class":"function","name":"setAngleVelocity","description":" Sets the angular velocity of the the particle."},"getPos":{"path":"libs_cl/particle.lua#L211","returns":[{"type":"Vector","value":"Vector Position of the particle","description":"Position of the particle"}],"realm":"client","class":"function","name":"getPos","description":" Returns the absolute position of the particle."},"getAngles":{"path":"libs_cl/particle.lua#L193","returns":[{"type":"Angle","value":"Angle Angles of the particle","description":"Angles of the particle"}],"realm":"client","class":"function","name":"getAngles","description":" Returns the current orientation of the particle."},"setBounce":{"path":"libs_cl/particle.lua#L241","realm":"client","params":[{"type":"number","value":"number bounce Bounciness to set to","name":"bounce","description":"Bounciness to set to"}],"class":"function","name":"setBounce","description":" Sets the 'bounciness' of the the particle."},"setPos":{"path":"libs_cl/particle.lua#L275","realm":"client","params":[{"type":"Vector","value":"Vector pos Vector position to set to","name":"pos","description":"Vector position to set to"}],"class":"function","name":"setPos","description":" Sets the absolute position of the particle."},"getRoll":{"path":"libs_cl/particle.lua#L217","returns":[{"type":"number","value":"number Roll","description":"Roll"}],"realm":"client","class":"function","name":"getRoll","description":" Returns the current rotation of the particle in radians, this should only be used for 2D particles."},"setRoll":{"path":"libs_cl/particle.lua#L281","realm":"client","params":[{"type":"number","value":"number roll Roll","name":"roll","description":"Roll"}],"class":"function","name":"setRoll","description":" Sets the roll of the particle in radians. This should only be used for 2D particles."},"getAngleVelocity":{"path":"libs_cl/particle.lua#L199","returns":[{"type":"Angle","value":"Angle Angular velocity of the particle","description":"Angular velocity of the particle"}],"realm":"client","class":"function","name":"getAngleVelocity","description":" Returns the angular velocity of the particle"},"setAngles":{"path":"libs_cl/particle.lua#L229","realm":"client","params":[{"type":"Angle","value":"Angle ang Angles to set the particle's angles to","name":"ang","description":"Angles to set the particle's angles to"}],"class":"function","name":"setAngles","description":" Sets the angles of the particle."},"setVelocityScale":{"path":"libs_cl/particle.lua#L314","realm":"client","params":[{"type":"boolean","value":"boolean doScale Whether it should scale","name":"doScale","description":"Whether it should scale"}],"class":"function","name":"setVelocityScale","description":" Scales the velocity based on the particle speed."},"getVelocity":{"path":"libs_cl/particle.lua#L223","returns":[{"type":"Vector","value":"Vector Velocity","description":"Velocity"}],"realm":"client","class":"function","name":"getVelocity","description":" Returns the current velocity of the particle."},"setRollDelta":{"path":"libs_cl/particle.lua#L288","realm":"client","params":[{"type":"number","value":"number rollDelta Rolldelta","name":"rollDelta","description":"Rolldelta"}],"class":"function","name":"setRollDelta","description":" Sets the rotation speed of the particle in radians. This should only be used for 2D particles."},"setGravity":{"path":"libs_cl/particle.lua#L308","realm":"client","params":[{"type":"Vector","value":"Vector gravity Directional gravity","name":"gravity","description":"Directional gravity"}],"class":"function","name":"setGravity","description":" Sets the directional gravity aka. acceleration of the particle."},"setAirResistance":{"path":"libs_cl/particle.lua#L301","realm":"client","params":[{"type":"number","value":"number airResistance AirResistance to set to","name":"airResistance","description":"AirResistance to set to"}],"class":"function","name":"setAirResistance","description":" Sets the air resistance of the the particle."},"setColor":{"path":"libs_cl/particle.lua#L255","realm":"client","params":[{"type":"Color","value":"Color col Color to set to","name":"col","description":"Color to set to"}],"class":"function","name":"setColor","description":" Sets the color of the particle."},"setMaterial":{"path":"libs_cl/particle.lua#L269","realm":"client","params":[{"type":"Material","value":"Material mat Material to set","name":"mat","description":"Material to set"}],"class":"function","name":"setMaterial","description":" Sets the material of the particle."},"setCollide":{"path":"libs_cl/particle.lua#L248","realm":"client","params":[{"type":"boolean","value":"boolean shouldCollide Whether it should collide","name":"shouldCollide","description":"Whether it should collide"}],"class":"function","name":"setCollide","description":" Sets the whether the particle should collide with the world or not."},"setLighting":{"path":"libs_cl/particle.lua#L262","realm":"client","params":[{"type":"boolean","value":"boolean useLighting Whether the particle should be affected by lighting","name":"useLighting","description":"Whether the particle should be affected by lighting"}],"class":"function","name":"setLighting","description":" Sets whether the particle should be affected by lighting."},"getColor":{"path":"libs_cl/particle.lua#L205","returns":[{"type":"Color","value":"Color Color of the particle","description":"Color of the particle"}],"realm":"client","class":"function","name":"getColor","description":" Returns the color of the particle."}},"class":"type","name":"Particle","description":" Particle type"},"PhysObj":{"path":"libs_sh/physobj.lua#L22","libtbl":["physobj_methods"],"realm":"shared","methods":{"localToWorld":{"path":"libs_sh/physobj.lua#L150","returns":[{"type":"Vector","value":"Vector The transformed vector","description":"The transformed vector"}],"realm":"shared","params":[{"type":"Vector","value":"Vector vec The vector to transform","name":"vec","description":"The vector to transform"}],"class":"function","name":"localToWorld","description":" Returns a vector in the reference frame of the world from the local frame of the physicsobject"},"setDamping":{"path":"libs_sh/physobj.lua#L494","realm":"shared","params":[{"type":"number","value":"number linear Number of the linear damping","name":"linear","description":"Number of the linear damping"},{"type":"number","value":"number angular Number of the angular damping","name":"angular","description":"Number of the angular damping"}],"class":"function","name":"setDamping","description":" Sets the movement damping of the bone. Unlike air drag, it doesn't take into account the cross-section of the object."},"getMatrix":{"path":"libs_sh/physobj.lua#L61","returns":[{"type":"VMatrix","value":"VMatrix The matrix","description":"The matrix"}],"realm":"shared","class":"function","name":"getMatrix","description":" Returns the world transform matrix of the physobj"},"setAngleVelocity":{"path":"libs_sh/physobj.lua#L324","realm":"server","params":[{"type":"Vector","value":"Vector angvel The local angvel vector to set","name":"angvel","description":"The local angvel vector to set"}],"class":"function","name":"setAngleVelocity","description":" Sets the angular velocity of an object"},"getPos":{"path":"libs_sh/physobj.lua#L54","returns":[{"type":"Vector","value":"Vector Vector position of the physics object","description":"Vector position of the physics object"}],"realm":"shared","class":"function","name":"getPos","description":" Gets the position of the physics object"},"getAngles":{"path":"libs_sh/physobj.lua#L68","returns":[{"type":"Angle","value":"Angle Angle angles of the physics object","description":"Angle angles of the physics object"}],"realm":"shared","class":"function","name":"getAngles","description":" Gets the angles of the physics object"},"addGameFlags":{"path":"libs_sh/physobj.lua#L395","realm":"shared","params":[{"type":"number","value":"number flags The flags to add. FVPHYSICS enum.","name":"flags","description":"The flags to add. FVPHYSICS enum."}],"class":"function","name":"addGameFlags","description":" Adds game flags to the physics object. Some flags cannot be modified. Can be:\n FVPHYSICS.DMG_DISSOLVE\n FVPHYSICS.DMG_SLICE\n FVPHYSICS.HEAVY_OBJECT\n FVPHYSICS.NO_IMPACT_DMG\n FVPHYSICS.NO_NPC_IMPACT_DMG\n FVPHYSICS.NO_PLAYER_PICKUP"},"enableMotion":{"path":"libs_sh/physobj.lua#L507","realm":"shared","params":[{"type":"boolean","value":"boolean move Should the bone move?","name":"move","description":"Should the bone move?"}],"class":"function","name":"enableMotion","description":" Sets the bone movement state"},"calculateVelocityOffset":{"path":"libs_sh/physobj.lua#L596","returns":[{"type":"Vector","value":"Vector The calculated linear velocity from the impulse on the physics object's center of mass in source_unit/s. (World frame)","description":"The calculated linear velocity from the impulse on the physics object's center of mass in source_unit/s. (World frame)"},{"type":"Vector","value":"Vector The calculated angular velocity from the impulse on the physics object's center of mass in degrees/s. (Local frame)","description":"The calculated angular velocity from the impulse on the physics object's center of mass in degrees/s. (Local frame)"}],"realm":"server","params":[{"type":"Vector","value":"Vector impulse The impulse acting on the object in world coordinates (kg*source_unit/s)","name":"impulse","description":"The impulse acting on the object in world coordinates (kg*source_unit/s)"},{"type":"Vector","value":"Vector position The location of the impulse in world coordinates","name":"position","description":"The location of the impulse in world coordinates"}],"class":"function","name":"calculateVelocityOffset","description":" Calculates the linear and angular velocities on the center of mass for an offset impulse.\n The outputs can be directly passed to PhysObj:addVelocity and PhysObj:addAngleVelocity, respectively."},"setPos":{"path":"libs_sh/physobj.lua#L219","realm":"server","params":[{"type":"Vector","value":"Vector pos The position vector to set it to","name":"pos","description":"The position vector to set it to"}],"class":"function","name":"setPos","description":" Sets the position of the physics object. Will cause interpolation of the entity in clientside, use entity.setPos to avoid this."},"isDragEnabled":{"path":"libs_sh/physobj.lua#L461","returns":[{"type":"boolean","value":"boolean If bone is affected by drag","description":"If bone is affected by drag"}],"realm":"shared","class":"function","name":"isDragEnabled","description":" Check if bone is affected by air resistance"},"setAngleDragCoefficient":{"path":"libs_sh/physobj.lua#L477","realm":"shared","params":[{"type":"number","value":"number coeff How much drag affects the bone when rotating","name":"coeff","description":"How much drag affects the bone when rotating"}],"class":"function","name":"setAngleDragCoefficient","description":" Sets coefficient of air resistance affecting the bone when rotating. Air resistance depends on the cross-section of the object."},"setContents":{"path":"libs_sh/physobj.lua#L285","realm":"server","params":[{"type":"number","value":"number contents The CONTENTS enum","name":"contents","description":"The CONTENTS enum"}],"class":"function","name":"setContents","description":" Sets the contents flag of the physobject"},"applyTorque":{"path":"libs_sh/physobj.lua#L350","realm":"server","params":[{"type":"Vector","value":"Vector torque The world torque vector to apply","name":"torque","description":"The world torque vector to apply"}],"class":"function","name":"applyTorque","description":" Applies a torque to a physics object"},"calculateForceOffset":{"path":"libs_sh/physobj.lua#L574","returns":[{"type":"Vector","value":"Vector The calculated linear impulse on the physics object's center of mass in kg*source_unit/s. (World frame)","description":"The calculated linear impulse on the physics object's center of mass in kg*source_unit/s. (World frame)"},{"type":"Vector","value":"Vector The calculated angular impulse on the physics object's center of mass in kg*m^2*degrees/s. (Local frame)","description":"The calculated angular impulse on the physics object's center of mass in kg*m^2*degrees/s. (Local frame)"}],"realm":"server","params":[{"type":"Vector","value":"Vector impulse The impulse acting on the object in world coordinates (kg*source_unit/s)","name":"impulse","description":"The impulse acting on the object in world coordinates (kg*source_unit/s)"},{"type":"Vector","value":"Vector position The location of the impulse in world coordinates","name":"position","description":"The location of the impulse in world coordinates"}],"class":"function","name":"calculateForceOffset","description":" Calculates the linear and angular impulse on the object's center of mass for an offset impulse.\n The outputs can be used with PhysObj:applyForceCenter and PhysObj:applyTorque, respectively.\n\n Be careful to convert the angular impulse to world frame (PhysObj:localToWorldVector)\n if you are going to use it with applyTorque."},"getVelocity":{"path":"libs_sh/physobj.lua#L75","returns":[{"type":"Vector","value":"Vector Vector velocity of the physics object","description":"Vector velocity of the physics object"}],"realm":"shared","class":"function","name":"getVelocity","description":" Gets the velocity of the physics object"},"getStress":{"path":"libs_sh/physobj.lua#L566","returns":[{"type":"number","value":"number External stress. Usually about the mass of the object if on the ground, usually 0 if in freefall.","description":"External stress. Usually about the mass of the object if on the ground, usually 0 if in freefall."},{"type":"number","value":"number Internal stress. Usually about the mass of every object resting on top of it combined.","description":"Internal stress. Usually about the mass of every object resting on top of it combined."}],"realm":"server","class":"function","name":"getStress","description":" Returns the stress of the entity."},"worldToLocal":{"path":"libs_sh/physobj.lua#L143","returns":[{"type":"Vector","value":"Vector The transformed vector","description":"The transformed vector"}],"realm":"shared","params":[{"type":"Vector","value":"Vector vec The vector to transform","name":"vec","description":"The vector to transform"}],"class":"function","name":"worldToLocal","description":" Returns a vector in the local reference frame of the physicsobject from the world frame"},"sleep":{"path":"libs_sh/physobj.lua#L524","realm":"server","class":"function","name":"sleep","description":" Makes a physobj go to sleep. (like it's frozen but interacting wakes it back up)"},"getFrictionSnapshot":{"path":"libs_sh/physobj.lua#L540","returns":[{"type":"table","value":"table Table of tables of data. Each table will contain:","description":"Table of tables of data. Each table will contain:"}],"realm":"server","class":"function","name":"getFrictionSnapshot","description":" Returns table of tables of friction data of a contact against the physobj\n PhysObj Other - The other physics object we came in contact with\n number EnergyAbsorbed -\n number FrictionCoefficient -\n number NormalForce -\n Vector Normal - Direction of the friction event\n Vector ContactPoint - Contact point of the friction event\n number Material - Surface Property ID of our physics obj\n number MaterialOther - Surface Property ID of the physics obj we came in contact with"},"setDragCoefficient":{"path":"libs_sh/physobj.lua#L468","realm":"shared","params":[{"type":"number","value":"number coeff How much drag affects the bone","name":"coeff","description":"How much drag affects the bone"}],"class":"function","name":"setDragCoefficient","description":" Sets coefficient of air resistance affecting the bone. Air resistance depends on the cross-section of the object."},"getMassCenter":{"path":"libs_sh/physobj.lua#L122","returns":[{"type":"Vector","value":"Vector Center of mass vector in the physobject's local reference frame.","description":"Center of mass vector in the physobject's local reference frame."}],"realm":"shared","class":"function","name":"getMassCenter","description":" Gets the center of mass of the physics object in the local reference frame."},"getVolume":{"path":"libs_sh/physobj.lua#L559","returns":[{"type":"number?","value":"number? The volume or nil if the PhysObj is a generated sphere or box.","description":"The volume or nil if the PhysObj is a generated sphere or box."}],"realm":"shared","class":"function","name":"getVolume","description":" Returns the volume in source units cubed. Or nil if the PhysObj is a generated sphere or box."},"getMesh":{"path":"libs_sh/physobj.lua#L171","returns":[{"type":"table","value":"table Table of MeshVertex structures","description":"Table of MeshVertex structures"}],"realm":"shared","class":"function","name":"getMesh","description":" Returns a table of MeshVertex structures where each 3 vertices represent a triangle. See: http://wiki.facepunch.com/gmod/Structures/MeshVertex"},"addAngleVelocity":{"path":"libs_sh/physobj.lua#L337","realm":"server","params":[{"type":"Vector","value":"Vector angvel The local angvel vector to apply","name":"angvel","description":"The local angvel vector to apply"}],"class":"function","name":"addAngleVelocity","description":" Applies a angular velocity to an object"},"isAsleep":{"path":"libs_sh/physobj.lua#L516","returns":[{"type":"boolean","value":"boolean If the physobj is asleep","description":"If the physobj is asleep"}],"realm":"server","class":"function","name":"isAsleep","description":" Returns whether the physobj is asleep"},"getLocalVelocity":{"path":"libs_sh/physobj.lua#L82","returns":[{"type":"Vector","value":"Vector Vector velocity of the physics object local to itself","description":"Vector velocity of the physics object local to itself"}],"realm":"shared","class":"function","name":"getLocalVelocity","description":" Gets the velocity of the physics object in coordinates local to itself"},"applyForceOffset":{"path":"libs_sh/physobj.lua#L308","realm":"server","params":[{"type":"Vector","value":"Vector force The force vector in world coordinates","name":"force","description":"The force vector in world coordinates"},{"type":"Vector","value":"Vector position The force position in world coordinates","name":"position","description":"The force position in world coordinates"}],"class":"function","name":"applyForceOffset","description":" Applies an offset force to a physics object"},"setBuoyancyRatio":{"path":"libs_sh/physobj.lua#L270","realm":"server","params":[{"type":"number","value":"number ratio The buoyancy ratio to use","name":"ratio","description":"The buoyancy ratio to use"}],"class":"function","name":"setBuoyancyRatio","description":" Sets the buoyancy ratio of a physobject"},"setMaterial":{"path":"libs_sh/physobj.lua#L185","realm":"shared","params":[{"type":"string","value":"string materialName The physical material to set it to","name":"materialName","description":"The physical material to set it to"}],"class":"function","name":"setMaterial","description":" Sets the physical material of a physics object"},"isMoveable":{"path":"libs_sh/physobj.lua#L204","returns":[{"type":"boolean","value":"boolean Whether the object is moveable","description":"Whether the object is moveable"}],"realm":"shared","class":"function","name":"isMoveable","description":" Returns whether the entity is able to move.\n Inverse of Entity:isFrozen"},"getMass":{"path":"libs_sh/physobj.lua#L115","returns":[{"type":"number","value":"number Mass of the physics object","description":"Mass of the physics object"}],"realm":"shared","class":"function","name":"getMass","description":" Gets the mass of the physics object"},"isValid":{"path":"libs_sh/physobj.lua#L40","returns":[{"type":"boolean","value":"boolean If the physics object is valid","description":"If the physics object is valid"}],"realm":"shared","class":"function","name":"isValid","description":" Checks if the physics object is valid"},"wake":{"path":"libs_sh/physobj.lua#L532","realm":"server","class":"function","name":"wake","description":" Makes a sleeping physobj wakeup"},"localToWorldVector":{"path":"libs_sh/physobj.lua#L164","returns":[{"type":"Vector","value":"Vector The transformed vector","description":"The transformed vector"}],"realm":"shared","params":[{"type":"Vector","value":"Vector vec The normal vector to transform","name":"vec","description":"The normal vector to transform"}],"class":"function","name":"localToWorldVector","description":" Returns a normal vector in the reference frame of the world from the local frame of the physicsobject"},"enableDrag":{"path":"libs_sh/physobj.lua#L453","realm":"shared","params":[{"type":"boolean","value":"boolean drag Should the bone have air resistance?","name":"drag","description":"Should the bone have air resistance?"}],"class":"function","name":"enableDrag","description":" Sets the bone drag state"},"addVelocity":{"path":"libs_sh/physobj.lua#L258","realm":"server","params":[{"type":"Vector","value":"Vector vel The world velocity vector to apply","name":"vel","description":"The world velocity vector to apply"}],"class":"function","name":"addVelocity","description":" Applies velocity to an object"},"applyForceCenter":{"path":"libs_sh/physobj.lua#L295","realm":"server","params":[{"type":"Vector","value":"Vector force The force vector to apply","name":"force","description":"The force vector to apply"}],"class":"function","name":"applyForceCenter","description":" Applies a force to the center of the physics object"},"getVelocityAtPoint":{"path":"libs_sh/physobj.lua#L99","returns":[{"type":"Vector","value":"Vector Vector Local velocity of the physics object at the point","description":"Vector Local velocity of the physics object at the point"}],"realm":"shared","params":[{"type":"Vector","value":"Vector vec The point to get velocity of in local reference frame","name":"vec","description":"The point to get velocity of in local reference frame"}],"class":"function","name":"getVelocityAtPoint","description":" Gets the velocity of the physics object at an arbitrary point in its local reference frame\n This includes velocity at the point induced by rotational velocity"},"isGravityEnabled":{"path":"libs_sh/physobj.lua#L211","returns":[{"type":"boolean","value":"boolean Whether the object is affect gravity","description":"Whether the object is affect gravity"}],"realm":"shared","class":"function","name":"isGravityEnabled","description":" Returns whether the entity is affected by gravity."},"getAngleVelocity":{"path":"libs_sh/physobj.lua#L108","returns":[{"type":"Vector","value":"Vector Vector angular velocity of the physics object","description":"Vector angular velocity of the physics object"}],"realm":"shared","class":"function","name":"getAngleVelocity","description":" Gets the angular velocity of the physics object"},"setInertia":{"path":"libs_sh/physobj.lua#L376","realm":"server","params":[{"type":"Vector","value":"Vector inertia The inertia vector to set it to","name":"inertia","description":"The inertia vector to set it to"}],"class":"function","name":"setInertia","description":" Sets the inertia of a physics object"},"setAngles":{"path":"libs_sh/physobj.lua#L232","realm":"server","params":[{"type":"Angle","value":"Angle ang The angle to set it to","name":"ang","description":"The angle to set it to"}],"class":"function","name":"setAngles","description":" Sets the angles of the physics object. Will cause interpolation of the entity in clientside, use entity.setAngles to avoid this."},"getEntity":{"path":"libs_sh/physobj.lua#L47","returns":[{"type":"Entity","value":"Entity The entity attached to the physics object","description":"The entity attached to the physics object"}],"realm":"shared","class":"function","name":"getEntity","description":" Gets the entity attached to the physics object"},"enableGravity":{"path":"libs_sh/physobj.lua#L444","realm":"shared","params":[{"type":"boolean","value":"boolean grav Should the bone respect gravity?","name":"grav","description":"Should the bone respect gravity?"}],"class":"function","name":"enableGravity","description":" Sets bone gravity"},"getDamping":{"path":"libs_sh/physobj.lua#L486","returns":[{"type":"number","value":"number Linear damping","description":"Linear damping"},{"type":"number","value":"number Angular damping","description":"Angular damping"}],"realm":"shared","class":"function","name":"getDamping","description":" Returns Movement damping of the bone."},"clearGameFlags":{"path":"libs_sh/physobj.lua#L415","realm":"shared","params":[{"type":"number","value":"number flags The flags to clear. FVPHYSICS enum.","name":"flags","description":"The flags to clear. FVPHYSICS enum."}],"class":"function","name":"clearGameFlags","description":" Clears game flags from the physics object. Some flags cannot be modified. Can be:\n FVPHYSICS.DMG_DISSOLVE\n FVPHYSICS.DMG_SLICE\n FVPHYSICS.HEAVY_OBJECT\n FVPHYSICS.NO_IMPACT_DMG\n FVPHYSICS.NO_NPC_IMPACT_DMG\n FVPHYSICS.NO_PLAYER_PICKUP"},"setMass":{"path":"libs_sh/physobj.lua#L363","realm":"server","params":[{"type":"number","value":"number mass The mass to set it to","name":"mass","description":"The mass to set it to"}],"class":"function","name":"setMass","description":" Sets the mass of a physics object"},"hasGameFlags":{"path":"libs_sh/physobj.lua#L435","returns":[{"type":"boolean","value":"boolean If the flags are set","description":"If the flags are set"}],"realm":"shared","params":[{"type":"number","value":"number flags The flags to test. FVPHYSICS enum.","name":"flags","description":"The flags to test. FVPHYSICS enum."}],"class":"function","name":"hasGameFlags","description":" Returns whether the game flags of the physics object are set."},"getMaterial":{"path":"libs_sh/physobj.lua#L136","returns":[{"type":"string","value":"string The physics material of the physics object","description":"The physics material of the physics object"}],"realm":"shared","class":"function","name":"getMaterial","description":" Gets the material of the physics object"},"worldToLocalVector":{"path":"libs_sh/physobj.lua#L157","returns":[{"type":"Vector","value":"Vector The transformed vector","description":"The transformed vector"}],"realm":"shared","params":[{"type":"Vector","value":"Vector vec The normal vector to transform","name":"vec","description":"The normal vector to transform"}],"class":"function","name":"worldToLocalVector","description":" Returns a normal vector in the local reference frame of the physicsobject from the world frame"},"getSurfaceArea":{"path":"libs_sh/physobj.lua#L198","returns":[{"type":"number?","value":"number? Surface area, or nil if a generated sphere or box","description":"Surface area, or nil if a generated sphere or box"}],"realm":"shared","class":"function","name":"getSurfaceArea","description":" Returns the surface area of the object in Hammer units squared."},"getAABB":{"path":"libs_sh/physobj.lua#L90","returns":[{"type":"Vector","value":"Vector The mins of the AABB","description":"The mins of the AABB"},{"type":"Vector","value":"Vector The maxs of the AABB","description":"The maxs of the AABB"}],"realm":"shared","class":"function","name":"getAABB","description":" Gets the axis aligned bounding box of the physics object"},"getMeshConvexes":{"path":"libs_sh/physobj.lua#L178","returns":[{"type":"table","value":"table Table of MeshVertex structures","description":"Table of MeshVertex structures"}],"realm":"shared","class":"function","name":"getMeshConvexes","description":" Returns a structured table, the physics mesh of the physics object. See: http://wiki.facepunch.com/gmod/Structures/MeshVertex"},"getInertia":{"path":"libs_sh/physobj.lua#L129","returns":[{"type":"Vector","value":"Vector Vector Inertia of the physics object","description":"Vector Inertia of the physics object"}],"realm":"shared","class":"function","name":"getInertia","description":" Gets the inertia of the physics object"},"setVelocity":{"path":"libs_sh/physobj.lua#L245","realm":"server","params":[{"type":"Vector","value":"Vector vel The velocity vector to set it to","name":"vel","description":"The velocity vector to set it to"}],"class":"function","name":"setVelocity","description":" Sets the velocity of the physics object"}},"class":"type","name":"PhysObj","description":" PhysObj Type"},"VMatrix":{"path":"libs_sh/vmatrix.lua#L6","libtbl":["vmatrix_methods","vmatrix_meta"],"realm":"shared","methods":{"setRight":{"path":"libs_sh/vmatrix.lua#L172","realm":"shared","params":[{"type":"Vector","value":"Vector right The right vector","name":"right","description":"The right vector"}],"class":"function","name":"setRight","description":" Sets the right direction of the matrix. Negated second column\n Self-Modifies. Does not return anything"},"invert":{"path":"libs_sh/vmatrix.lua#L239","returns":[{"type":"boolean","value":"boolean Whether the matrix was inverted or not","description":"Whether the matrix was inverted or not"}],"realm":"shared","class":"function","name":"invert","description":" Inverts the matrix. Inverting the matrix will fail if its determinant is 0 or close to 0\n Self-Modifies."},"getInverse":{"path":"libs_sh/vmatrix.lua#L99","returns":[{"type":"VMatrix","value":"VMatrix Inverted matrix","description":"Inverted matrix"}],"realm":"shared","class":"function","name":"getInverse","description":" Returns an inverted matrix. Inverting the matrix will fail if its determinant is 0 or close to 0"},"setForward":{"path":"libs_sh/vmatrix.lua#L165","realm":"shared","params":[{"type":"Vector","value":"Vector forward The forward vector","name":"forward","description":"The forward vector"}],"class":"function","name":"setForward","description":" Sets the forward direction of the matrix. First column\n Self-Modifies. Does not return anything"},"getAngles":{"path":"libs_sh/vmatrix.lua#L56","returns":[{"type":"Angle","value":"Angle Angles","description":"Angles"}],"realm":"shared","class":"function","name":"getAngles","description":" Returns angles"},"__mul":{"path":"libs_sh/vmatrix.lua#L360","returns":[{"type":"VMatrix","value":"VMatrix Result matrix","description":"Result matrix"}],"realm":"shared","params":[{"type":"VMatrix","value":"VMatrix lhs Matrix multiplicand","name":"lhs","description":"Matrix multiplicand"},{"type":"VMatrix|Vector","value":"VMatrix|Vector rhs Matrix or Vector multiplier","name":"rhs","description":"Matrix or Vector multiplier"}],"class":"function","name":"__mul","description":" Multiplies two matrices (Left must be a VMatrix)"},"getScale":{"path":"libs_sh/vmatrix.lua#L62","returns":[{"type":"Vector","value":"Vector Scale","description":"Scale"}],"realm":"shared","class":"function","name":"getScale","description":" Returns scale"},"getForward":{"path":"libs_sh/vmatrix.lua#L111","returns":[{"type":"Vector","value":"Vector Translation","description":"Translation"}],"realm":"shared","class":"function","name":"getForward","description":" Returns forward vector of matrix. First matrix column"},"__sub":{"path":"libs_sh/vmatrix.lua#L352","returns":[{"type":"VMatrix","value":"VMatrix Subtracted matrix","description":"Subtracted matrix"}],"realm":"shared","params":[{"type":"VMatrix","value":"VMatrix lhs Initial Matrix","name":"lhs","description":"Initial Matrix"},{"type":"VMatrix","value":"VMatrix rhs Matrix to subtract from the first","name":"rhs","description":"Matrix to subtract from the first"}],"class":"function","name":"__sub","description":" Subtracts two matrices (why would you do this?)"},"setAxisAngle":{"path":"libs_sh/vmatrix.lua#L264","realm":"shared","params":[{"type":"Vector","value":"Vector axis The normalized axis of rotation","name":"axis","description":"The normalized axis of rotation"},{"type":"number","value":"number angle The angle of rotation in radians","name":"angle","description":"The angle of rotation in radians"}],"class":"function","name":"setAxisAngle","description":" Sets the rotation or the matrix to the rotation by an axis and angle\n Self-Modifies. Does not return anything"},"getField":{"path":"libs_sh/vmatrix.lua#L74","returns":[{"type":"number","value":"number Value of the specified field","description":"Value of the specified field"}],"realm":"shared","params":[{"type":"number","value":"number row A number from 1 to 4","name":"row","description":"A number from 1 to 4"},{"type":"number","value":"number column A number from 1 to 4","name":"column","description":"A number from 1 to 4"}],"class":"function","name":"getField","description":" Returns a specific field in the matrix"},"set":{"path":"libs_sh/vmatrix.lua#L214","realm":"shared","params":[{"type":"VMatrix","value":"VMatrix src Second matrix","name":"src","description":"Second matrix"}],"class":"function","name":"set","description":" Copies the values from the second matrix to the first matrix.\n Self-Modifies. Does not return anything"},"translate":{"path":"libs_sh/vmatrix.lua#L252","realm":"shared","params":[{"type":"Vector","value":"Vector vec Vector to translate by","name":"vec","description":"Vector to translate by"}],"class":"function","name":"translate","description":" Translate the matrix"},"getRight":{"path":"libs_sh/vmatrix.lua#L117","returns":[{"type":"Vector","value":"Vector Translation","description":"Translation"}],"realm":"shared","class":"function","name":"getRight","description":" Returns right vector of matrix. Negated second matrix column"},"setTranslation":{"path":"libs_sh/vmatrix.lua#L158","realm":"shared","params":[{"type":"Vector","value":"Vector vec New translation","name":"vec","description":"New translation"}],"class":"function","name":"setTranslation","description":" Sets the translation\n Self-Modifies. Does not return anything"},"invertTR":{"path":"libs_sh/vmatrix.lua#L246","realm":"shared","class":"function","name":"invertTR","description":" Inverts the matrix efficiently for translations and rotations\n Self-Modifies. Does not return anything"},"isRotationMatrix":{"path":"libs_sh/vmatrix.lua#L233","returns":[{"type":"boolean","value":"boolean True/False","description":"True/False"}],"realm":"shared","class":"function","name":"isRotationMatrix","description":" Returns whether the matrix is a rotation matrix or not. Checks if the forward, right and up vectors are orthogonal and normalized."},"rotate":{"path":"libs_sh/vmatrix.lua#L82","realm":"shared","params":[{"type":"Angle","value":"Angle ang Angle to rotate by","name":"ang","description":"Angle to rotate by"}],"class":"function","name":"rotate","description":" Rotate the matrix\n Self-Modifies. Does not return anything"},"scale":{"path":"libs_sh/vmatrix.lua#L136","realm":"shared","params":[{"type":"Vector","value":"Vector vec Vector to scale by","name":"vec","description":"Vector to scale by"}],"class":"function","name":"scale","description":" Scale the matrix\n Self-Modifies. Does not return anything"},"setScale":{"path":"libs_sh/vmatrix.lua#L129","realm":"shared","params":[{"type":"Vector","value":"Vector vec New scale","name":"vec","description":"New scale"}],"class":"function","name":"setScale","description":" Sets the scale\n Self-Modifies. Does not return anything"},"__add":{"path":"libs_sh/vmatrix.lua#L344","returns":[{"type":"VMatrix","value":"VMatrix Added matrix","description":"Added matrix"}],"realm":"shared","params":[{"type":"VMatrix","value":"VMatrix lhs Initial Matrix","name":"lhs","description":"Initial Matrix"},{"type":"VMatrix","value":"VMatrix rhs Matrix to add to the first","name":"rhs","description":"Matrix to add to the first"}],"class":"function","name":"__add","description":" Adds two matrices (why would you do this?)"},"getAxisAngle":{"path":"libs_sh/vmatrix.lua#L289","returns":[{"type":"Vector","value":"Vector The axis of rotation","description":"The axis of rotation"},{"type":"number","value":"number The angle of rotation","description":"The angle of rotation"}],"realm":"shared","class":"function","name":"getAxisAngle","description":" Gets the rotation axis and angle of rotation of the rotation matrix"},"isIdentity":{"path":"libs_sh/vmatrix.lua#L227","returns":[{"type":"boolean","value":"boolean True/False","description":"True/False"}],"realm":"shared","class":"function","name":"isIdentity","description":" Returns whether the matrix is equal to Identity matrix or not"},"getRotatedAroundAxis":{"path":"libs_sh/vmatrix.lua#L89","returns":[{"type":"VMatrix","value":"VMatrix The rotated matrix","description":"The rotated matrix"}],"realm":"shared","params":[{"type":"Vector","value":"Vector axis Axis to rotate around","name":"axis","description":"Axis to rotate around"},{"type":"number","value":"number ang Angle to rotate by in radians","name":"ang","description":"Angle to rotate by in radians"}],"class":"function","name":"getRotatedAroundAxis","description":" Returns the input matrix rotated by an axis"},"clone":{"path":"libs_sh/vmatrix.lua#L195","returns":[{"type":"VMatrix","value":"VMatrix The copy of the matrix","description":"The copy of the matrix"}],"realm":"shared","class":"function","name":"clone","description":" Copies The matrix and returns a new matrix"},"setIdentity":{"path":"libs_sh/vmatrix.lua#L221","realm":"shared","class":"function","name":"setIdentity","description":" Initializes the matrix as Identity matrix\n Self-Modifies. Does not return anything"},"setUnpacked":{"path":"libs_sh/vmatrix.lua#L207","realm":"shared","params":[{"type":"...number","value":"...number fields The 16 fields","name":"fields","description":"The 16 fields"}],"class":"function","name":"setUnpacked","description":" Allows you to set all 16 fields in row-major order\n Self-Modifies. Does not return anything"},"getUp":{"path":"libs_sh/vmatrix.lua#L123","returns":[{"type":"Vector","value":"Vector Translation","description":"Translation"}],"realm":"shared","class":"function","name":"getUp","description":" Returns up vector of matrix. Third matrix column"},"setUp":{"path":"libs_sh/vmatrix.lua#L179","realm":"shared","params":[{"type":"Vector","value":"Vector up The up vector","name":"up","description":"The up vector"}],"class":"function","name":"setUp","description":" Sets the up direction of the matrix. Third column\n Self-Modifies. Does not return anything"},"getTranslation":{"path":"libs_sh/vmatrix.lua#L68","returns":[{"type":"Vector","value":"Vector Translation","description":"Translation"}],"realm":"shared","class":"function","name":"getTranslation","description":" Returns translation"},"getInverseTR":{"path":"libs_sh/vmatrix.lua#L105","returns":[{"type":"VMatrix","value":"VMatrix Inverted matrix","description":"Inverted matrix"}],"realm":"shared","class":"function","name":"getInverseTR","description":" Returns an inverted matrix. Efficiently for translations and rotations"},"__tostring":{"path":"libs_sh/vmatrix.lua#L50","returns":[{"type":"string","value":"string String representing the matrix.","description":"String representing the matrix."}],"realm":"shared","class":"function","name":"__tostring","description":" tostring metamethod"},"setAngles":{"path":"libs_sh/vmatrix.lua#L151","realm":"shared","params":[{"type":"Angle","value":"Angle ang New angles","name":"ang","description":"New angles"}],"class":"function","name":"setAngles","description":" Sets the angles\n Self-Modifies. Does not return anything"},"toTable":{"path":"libs_sh/vmatrix.lua#L258","returns":[{"type":"table","value":"table The 4x4 table","description":"The 4x4 table"}],"realm":"shared","class":"function","name":"toTable","description":" Converts the matrix to a 4x4 table"},"unpack":{"path":"libs_sh/vmatrix.lua#L201","returns":[{"type":"...number","value":"...number The 16 fields","description":"The 16 fields"}],"realm":"shared","class":"function","name":"unpack","description":" Returns all 16 fields of the matrix in row-major order"},"setField":{"path":"libs_sh/vmatrix.lua#L186","realm":"shared","params":[{"type":"number","value":"number row A number from 1 to 4","name":"row","description":"A number from 1 to 4"},{"type":"number","value":"number column A number from 1 to 4","name":"column","description":"A number from 1 to 4"},{"type":"number","value":"number value Value to set","name":"value","description":"Value to set"}],"class":"function","name":"setField","description":" Sets a specific field in the matrix\n Self-Modifies. Does not return anything"},"scaleTranslation":{"path":"libs_sh/vmatrix.lua#L143","realm":"shared","params":[{"type":"number","value":"number num Amount to scale by","name":"num","description":"Amount to scale by"}],"class":"function","name":"scaleTranslation","description":" Scales the absolute translation\n Self-Modifies. Does not return anything"}},"class":"type","name":"VMatrix","description":" VMatrix type"},"Bass":{"path":"libs_cl/bass.lua#L129","libtbl":["bass_methods"],"realm":"client","methods":{"stop":{"path":"libs_cl/bass.lua#L243","realm":"client","class":"function","name":"stop","description":" Stops playing the sound and destroys it. Use pause instead if you don't want it destroyed."},"isStalled":{"path":"libs_cl/bass.lua#L470","returns":[{"type":"boolean","value":"boolean True if the sound is stalled.","description":"True if the sound is stalled."}],"realm":"client","class":"function","name":"isStalled","description":" Returns whether or not the sound is stalled."},"getBitsPerSample":{"path":"libs_cl/bass.lua#L414","returns":[{"type":"number","value":"number Floating point number of bits per sample, or 0 if unknown.","description":"Floating point number of bits per sample, or 0 if unknown."}],"realm":"client","class":"function","name":"getBitsPerSample","description":" Retrieves the number of bits per sample of the sound.\n Doesn't work for mp3 and ogg files."},"isPaused":{"path":"libs_cl/bass.lua#L464","returns":[{"type":"boolean","value":"boolean True if the sound is paused.","description":"True if the sound is paused."}],"realm":"client","class":"function","name":"isPaused","description":" Returns whether or not the sound is paused."},"setPitch":{"path":"libs_cl/bass.lua#L290","realm":"client","params":[{"type":"number","value":"number pitch Pitch to set to. (0-100) 1 is normal pitch.","name":"pitch","description":"Pitch to set to. (0-100) 1 is normal pitch."}],"class":"function","name":"setPitch","description":" Sets the pitch of the sound."},"getPos":{"path":"libs_cl/bass.lua#L303","returns":[{"type":"Vector","value":"Vector The position of the sound.","description":"The position of the sound."}],"realm":"client","class":"function","name":"getPos","description":" Gets the position of the sound in 3D space."},"isPlaying":{"path":"libs_cl/bass.lua#L458","returns":[{"type":"boolean","value":"boolean True if the sound is playing.","description":"True if the sound is playing."}],"realm":"client","class":"function","name":"isPlaying","description":" Returns whether or not the sound is playing."},"getLevels":{"path":"libs_cl/bass.lua#L390","returns":[{"type":"number","value":"number The left sound level, a value between 0 and 1.","description":"The left sound level, a value between 0 and 1."},{"type":"number","value":"number The right sound level, a value between 0 and 1.","description":"The right sound level, a value between 0 and 1."}],"realm":"client","class":"function","name":"getLevels","description":" Gets the left and right audio channel levels."},"isLooping":{"path":"libs_cl/bass.lua#L343","returns":[{"type":"boolean","value":"boolean Whether the sound loops.","description":"Whether the sound loops."}],"realm":"client","class":"function","name":"isLooping","description":" Gets whether the sound loops."},"getPan":{"path":"libs_cl/bass.lua#L397","returns":[{"type":"number","value":"number The pan. -1 to 1 for relative left to right","description":"The pan. -1 to 1 for relative left to right"}],"realm":"client","class":"function","name":"getPan","description":" Gets the relative volume between the left and right audio channels."},"setVolume":{"path":"libs_cl/bass.lua#L255","realm":"client","params":[{"type":"number","value":"number vol Volume multiplier (1 is normal), between 0x and 10x.","name":"vol","description":"Volume multiplier (1 is normal), between 0x and 10x."}],"class":"function","name":"setVolume","description":" Sets the volume of the sound."},"is3D":{"path":"libs_cl/bass.lua#L439","returns":[{"type":"boolean","value":"boolean True if the sound is 3D.","description":"True if the sound is 3D."}],"realm":"client","class":"function","name":"is3D","description":" Returns whether or not the sound is 3D."},"setLooping":{"path":"libs_cl/bass.lua#L337","realm":"client","params":[{"type":"boolean","value":"boolean loop Whether the sound should loop.","name":"loop","description":"Whether the sound should loop."}],"class":"function","name":"setLooping","description":" Sets whether the sound should loop. Requires the 'noblock' flag."},"play":{"path":"libs_cl/bass.lua#L238","realm":"client","class":"function","name":"play","description":" Starts to play the sound."},"isOnline":{"path":"libs_cl/bass.lua#L378","returns":[{"type":"boolean","value":"boolean Boolean of whether the sound is streamed online.","description":"Boolean of whether the sound is streamed online."}],"realm":"client","class":"function","name":"isOnline","description":" Gets whether the sound is streamed online."},"getFlags":{"path":"libs_cl/bass.lua#L427","returns":[{"type":"string","value":"string The flags of the sound (`3d`, `mono`, `noplay`, `noblock`).","description":"The flags of the sound (`3d`, `mono`, `noplay`, `noblock`)."}],"realm":"client","class":"function","name":"getFlags","description":" Returns the flags used to create the sound."},"getAverageBitRate":{"path":"libs_cl/bass.lua#L421","returns":[{"type":"number","value":"number The average bit rate of the sound.","description":"The average bit rate of the sound."}],"realm":"client","class":"function","name":"getAverageBitRate","description":" Returns the average bit rate of the sound."},"setPan":{"path":"libs_cl/bass.lua#L403","realm":"client","params":[{"type":"number","value":"number Relative integer volume between the left and right channels. Values must be -1 to 1 for relative left to right.","name":"Relative","description":"integer volume between the left and right channels. Values must be -1 to 1 for relative left to right."}],"class":"function","name":"setPan","description":" Sets the relative volume of the left and right channels."},"getTime":{"path":"libs_cl/bass.lua#L363","returns":[{"type":"number","value":"number Sound playback time in seconds.","description":"Sound playback time in seconds."}],"realm":"client","class":"function","name":"getTime","description":" Gets the current playback time of the sound. Requires the 'noblock' flag."},"getLength":{"path":"libs_cl/bass.lua#L349","returns":[{"type":"number","value":"number Sound length in seconds.","description":"Sound length in seconds."}],"realm":"client","class":"function","name":"getLength","description":" Gets the length of a sound."},"pause":{"path":"libs_cl/bass.lua#L250","realm":"client","class":"function","name":"pause","description":" Pauses the sound."},"getState":{"path":"libs_cl/bass.lua#L445","returns":[{"type":"number","value":"number The state enum of the sound. https://wiki.facepunch.com/gmod/Enums/GMOD_CHANNEL","description":"The state enum of the sound. https://wiki.facepunch.com/gmod/Enums/GMOD_CHANNEL"}],"realm":"client","class":"function","name":"getState","description":" Returns the state of the sound."},"isStopped":{"path":"libs_cl/bass.lua#L451","returns":[{"type":"boolean","value":"boolean True if the sound is stopped.","description":"True if the sound is stopped."}],"realm":"client","class":"function","name":"isStopped","description":" Returns whether or not the sound is stopped.\n Only true if the `noplay` flag is used and Bass:play() hasn't been called yet, since Bass:stop() will destroy the sound channel."},"getFFT":{"path":"libs_cl/bass.lua#L369","returns":[{"type":"table","value":"table Table containing DFT magnitudes, each between 0 and 1.","description":"Table containing DFT magnitudes, each between 0 and 1."}],"realm":"client","params":[{"type":"number","value":"number n Number of consecutive audio samples, between 0 and 7. Depending on this parameter you will get 256*2^n samples.","name":"n","description":"Number of consecutive audio samples, between 0 and 7. Depending on this parameter you will get 256*2^n samples."}],"class":"function","name":"getFFT","description":" Perform fast Fourier transform algorithm to compute the DFT of the sound."},"isValid":{"path":"libs_cl/bass.lua#L384","returns":[{"type":"boolean","value":"boolean Boolean of whether the bass is valid.","description":"Boolean of whether the bass is valid."}],"realm":"client","class":"function","name":"isValid","description":" Gets whether the bass is valid."},"setFade":{"path":"libs_cl/bass.lua#L309","realm":"client","params":[{"type":"number","value":"number min The distance where the sound starts to fade. (50-1,000)","name":"min","description":"The distance where the sound starts to fade. (50-1,000)"},{"type":"number","value":"number max The maximal distance, as described above. (min-20,000 for simple fading, 5,000-200,000 for non-simple fading)","name":"max","description":"The maximal distance, as described above. (min-20,000 for simple fading, 5,000-200,000 for non-simple fading)"},{"type":"boolean?","value":"boolean? useSimpleFading Whether to use simple fading for this sound. True by default.","name":"useSimpleFading","description":"Whether to use simple fading for this sound. True by default."}],"class":"function","name":"setFade","description":" Sets the fade distance of the sound in 3D space. Must have `3d` flag for this to have any effect.\n For both fading styles, the sound will be at full volume (the value of :setVolume()) at distances between 0 and min.\n If simple fading is enabled, the sound will fade towards 0 until the max distance is reached, becoming inaudible.\n If simple fading is disabled, the sound will start to fade, then lock its volume once max distance is reached. It will almost always be faintly heard."},"setTime":{"path":"libs_cl/bass.lua#L355","realm":"client","params":[{"type":"number","value":"number time Sound playback time in seconds.","name":"time","description":"Sound playback time in seconds."},{"type":"boolean?","value":"boolean? dontDecode Skip decoding to set time, which is much faster but less accurate. True by default.","name":"dontDecode","description":"Skip decoding to set time, which is much faster but less accurate. True by default."}],"class":"function","name":"setTime","description":" Sets the current playback time of the sound. Requires the 'noblock' flag."},"setPos":{"path":"libs_cl/bass.lua#L297","realm":"client","params":[{"type":"Vector","value":"Vector pos Where to position the sound.","name":"pos","description":"Where to position the sound."}],"class":"function","name":"setPos","description":" Sets the position of the sound in 3D space. Must have `3d` flag for this to have any effect."},"getFade":{"path":"libs_cl/bass.lua#L327","returns":[{"type":"number","value":"number The distance before the sound starts to fade.","description":"The distance before the sound starts to fade."},{"type":"number","value":"number The distance before the sound stops fading.","description":"The distance before the sound stops fading."},{"type":"boolean","value":"boolean Whether or not this sound uses simple fading.","description":"Whether or not this sound uses simple fading."}],"realm":"client","class":"function","name":"getFade","description":" Gets the fade distance of the sound in 3D space. "},"is2D":{"path":"libs_cl/bass.lua#L433","returns":[{"type":"boolean","value":"boolean True if the sound is 2D.","description":"True if the sound is 2D."}],"realm":"client","class":"function","name":"is2D","description":" Returns whether or not the sound is 2D."},"getVolume":{"path":"libs_cl/bass.lua#L273","returns":[{"type":"number","value":"number Volume multiplier (1 is normal), between 0x and 10x.","description":"Volume multiplier (1 is normal), between 0x and 10x."}],"realm":"client","class":"function","name":"getVolume","description":" Gets the base volume of the sound.\n This is the volume before distance fading is applied on 3D sounds."},"getFadeMultiplier":{"path":"libs_cl/bass.lua#L280","returns":[{"type":"number","value":"number Volume fade multiplier (1 is normal), between 0x and 10x.","description":"Volume fade multiplier (1 is normal), between 0x and 10x."}],"realm":"client","class":"function","name":"getFadeMultiplier","description":" Gets the distance-based fade multiplier of the sound.\n Bass:getVolume() * Bass:getFadeMultiplier() is the effective volume of the sound.\n Always 1 for 2D sounds.\n Always 1 for 3D sounds that don't use simple fading. See Bass:setFade().\n Only updates once per frame while the sound is playing."}},"class":"type","name":"Bass","description":" For playing music there is `Bass` type. You can pause and set current playback time in it. If you're looking to apply DSP effects on present game sounds, use `Sound` instead."},"Entity":{"path":"libs_sh/entities.lua#L57","libtbl":["ents_methods","ent_meta"],"realm":"shared","methods":{"localToWorld":{"path":"libs_sh/entities.lua#L1293","returns":[{"type":"Vector","value":"Vector data as world space vector","description":"data as world space vector"}],"realm":"shared","params":[{"type":"Vector","value":"Vector data Local space vector","name":"data","description":"Local space vector"}],"class":"function","name":"localToWorld","description":" Converts a vector in entity local space to world space"},"setVelocity":{"path":"libs_sv/entities.lua#L567","realm":"server","params":[{"type":"Vector","value":"Vector vel New velocity","name":"vel","description":"New velocity"}],"class":"function","name":"setVelocity","description":" Sets the entity's linear velocity. Physics entities, use physobj:setVelocity"},"obbMins":{"path":"libs_sh/entities.lua#L1187","returns":[{"type":"Vector","value":"Vector The min bounding box vector","description":"The min bounding box vector"}],"realm":"shared","class":"function","name":"obbMins","description":" Returns min local bounding box vector of the entity"},"getForward":{"path":"libs_sh/entities.lua#L1659","returns":[{"type":"Vector","value":"Vector Vector forward","description":"Vector forward"}],"realm":"shared","class":"function","name":"getForward","description":" Gets the entity's forward vector"},"emitSound":{"path":"libs_sh/entities.lua#L321","realm":"shared","params":[{"type":"string","value":"string snd Sound path","name":"snd","description":"Sound path"},{"type":"number","value":"number soundLevel Default 75","name":"soundLevel","description":"Default 75"},{"type":"number","value":"number pitchPercent Default 100","name":"pitchPercent","description":"Default 100"},{"type":"number","value":"number volume Default 1","name":"volume","description":"Default 1"},{"type":"number","value":"number channel Default CHAN_AUTO or CHAN_WEAPON for weapons","name":"channel","description":"Default CHAN_AUTO or CHAN_WEAPON for weapons"}],"class":"function","name":"emitSound","description":" Plays a sound on the entity"},"getCreationTime":{"path":"libs_sh/entities.lua#L1666","returns":[{"type":"number","value":"number Seconds relative to server map start","description":"Seconds relative to server map start"}],"realm":"shared","class":"function","name":"getCreationTime","description":" Returns the timer.curtime() time the entity was created on"},"getTable":{"path":"libs_sv/entities.lua#L1077","returns":[{"type":"table","value":"table The entity's table.","description":"The entity's table."}],"realm":"server","class":"function","name":"getTable","description":" Returns a copy of the entity's sanitized internal glua table."},"setTrails":{"path":"libs_sv/entities.lua#L957","realm":"server","params":[{"type":"number","value":"number startSize The start size of the trail (0-128)","name":"startSize","description":"The start size of the trail (0-128)"},{"type":"number","value":"number endSize The end size of the trail (0-128)","name":"endSize","description":"The end size of the trail (0-128)"},{"type":"number","value":"number length The length size of the trail","name":"length","description":"The length size of the trail"},{"type":"string","value":"string material The material of the trail","name":"material","description":"The material of the trail"},{"type":"Color","value":"Color color The color of the trail","name":"color","description":"The color of the trail"},{"type":"number?","value":"number? attachmentID Optional attachmentid the trail should attach to","name":"attachmentID","description":"Optional attachmentid the trail should attach to"},{"type":"boolean?","value":"boolean? additive If the trail's rendering is additive","name":"additive","description":"If the trail's rendering is additive"}],"class":"function","name":"setTrails","description":" Adds a trail to the entity with the specified attributes."},"getHitBoxBounds":{"path":"libs_sh/entities.lua#L1708","returns":[{"type":"Vector","value":"Vector Hitbox mins vector.","description":"Hitbox mins vector."},{"type":"Vector","value":"Vector Hitbox maxs vector.","description":"Hitbox maxs vector."}],"realm":"shared","params":[{"type":"number","value":"number hitbox The number of the hitbox.","name":"hitbox","description":"The number of the hitbox."},{"type":"number","value":"number group The number of the hitbox group, 0 in most cases.","name":"group","description":"The number of the hitbox group, 0 in most cases."}],"class":"function","name":"getHitBoxBounds","description":" Gets the bounds (min and max corners) of a hit box."},"setUnbreakable":{"path":"libs_sv/entities.lua#L996","realm":"server","params":[{"type":"boolean","value":"boolean on Whether to make the prop unbreakable","name":"on","description":"Whether to make the prop unbreakable"}],"class":"function","name":"setUnbreakable","description":" Sets a prop_physics to be unbreakable"},"addCollisionListener":{"path":"libs_sv/entities.lua#L512","realm":"server","params":[{"type":"function","value":"function func The callback function with argument, table collsiondata, http://wiki.facepunch.com/gmod/Structures/CollisionData","name":"func","description":"The callback function with argument, table collsiondata, http://wiki.facepunch.com/gmod/Structures/CollisionData"},{"type":"string?","value":"string? name Optional name to distinguish multiple collision listeners and remove them individually later. (default: \"\")","name":"name","description":"Optional name to distinguish multiple collision listeners and remove them individually later. (default: \"\")"}],"class":"function","name":"addCollisionListener","description":" Allows detecting collisions on an entity."},"isKeysOwned":{"path":"libs_sh/darkrp2.lua#L850","returns":[{"type":"boolean","value":"boolean Whether it's owned.","description":"Whether it's owned."}],"realm":"shared","class":"function","name":"isKeysOwned","description":" Get whether this door is owned by someone."},"getLinkedComponents":{"path":"libs_sh/entities.lua#L356","returns":[{"type":"table","value":"table A list of components linked to the entity","description":"A list of components linked to the entity"}],"realm":"shared","class":"function","name":"getLinkedComponents","description":" Returns a list of components linked to a processor. Can also return vehicles linked to a HUD, but only through the server."},"getVelocity":{"path":"libs_sh/entities.lua#L1259","returns":[{"type":"Vector","value":"Vector The velocity vector","description":"The velocity vector"}],"realm":"shared","class":"function","name":"getVelocity","description":" Returns the velocity of the entity"},"setPhysMaterial":{"path":"libs_sv/entities.lua#L717","realm":"server","params":[{"type":"string","value":"string materialName Material to use","name":"materialName","description":"Material to use"}],"class":"function","name":"setPhysMaterial","description":" Sets the physical material of the entity"},"getModelContents":{"path":"libs_sh/entities.lua#L1563","returns":[{"type":"number","value":"number Contents of the entity's model. https://wiki.facepunch.com/gmod/Enums/CONTENTS","description":"Contents of the entity's model. https://wiki.facepunch.com/gmod/Enums/CONTENTS"}],"realm":"shared","class":"function","name":"getModelContents","description":" Returns the contents of the entity's current model"},"setPhysicsUpdateListener":{"path":"libs_sv/entities.lua#L1048","realm":"server","params":[{"type":"function|nil","value":"function|nil func The callback function. Use nil to remove an existing callback.","name":"func","description":"The callback function. Use nil to remove an existing callback."}],"class":"function","name":"setPhysicsUpdateListener","description":" Set the function to run whenever the physics of the entity are updated.\n This won't be called if the physics object goes asleep.\n\n You can only use this function on these classes:\n - starfall_prop\n - starfall_processor"},"getMaterials":{"path":"libs_sh/entities.lua#L1637","returns":[{"type":"table","value":"table Material","description":"Material"}],"realm":"shared","class":"function","name":"getMaterials","description":" Gets an entities' material list"},"enableGravity":{"path":"libs_sv/entities.lua#L764","realm":"server","params":[{"type":"boolean","value":"boolean grav Should the entity respect gravity?","name":"grav","description":"Should the entity respect gravity?"}],"class":"function","name":"enableGravity","description":" Sets entity gravity"},"getNetworkVars":{"path":"libs_sh/entities.lua#L1941","returns":[{"type":"table?","value":"table? The networked variables table of the entity or nil if it doesn't have one.","description":"The networked variables table of the entity or nil if it doesn't have one."}],"realm":"shared","class":"function","name":"getNetworkVars","description":" Returns entity's networked variables table (data table)."},"setMesh":{"path":"libs_sh/entities.lua#L174","realm":"client","params":[{"type":"Mesh?","value":"Mesh? mesh The mesh to set it to or nil to set back to normal","name":"mesh","description":"The mesh to set it to or nil to set back to normal"}],"class":"function","name":"setMesh","description":" Sets a hologram or custom_prop model to a custom Mesh"},"setComponentLocksControls":{"path":"libs_sv/entities.lua#L248","realm":"server","params":[{"type":"boolean","value":"boolean enable Whether the component will lock the player's controls when used","name":"enable","description":"Whether the component will lock the player's controls when used"}],"class":"function","name":"setComponentLocksControls","description":" Sets a component's ability to lock a player's controls"},"getPoseRange":{"path":"libs_sh/entities.lua#L1442","returns":[{"type":"number?","value":"number? Minimum pose value or nil if pose not found","description":"Minimum pose value or nil if pose not found"},{"type":"number?","value":"number? Maximum pose value or nil if pose not found","description":"Maximum pose value or nil if pose not found"}],"realm":"shared","params":[{"type":"number","value":"number id Pose index (starting from 0)","name":"id","description":"Pose index (starting from 0)"}],"class":"function","name":"getPoseRange","description":" Returns pose value range"},"getCollisionGroup":{"path":"libs_sh/entities.lua#L712","returns":[{"type":"number","value":"number The collision group enum of the entity. https://wiki.facepunch.com/gmod/Enums/COLLISION_GROUP","description":"The collision group enum of the entity. https://wiki.facepunch.com/gmod/Enums/COLLISION_GROUP"}],"realm":"shared","class":"function","name":"getCollisionGroup","description":" Gets the collision group enum of the entity"},"setDrawShadow":{"path":"libs_sv/entities.lua#L536","realm":"server","params":[{"type":"boolean","value":"boolean draw Whether the shadow should draw","name":"draw","description":"Whether the shadow should draw"}],"class":"function","name":"setDrawShadow","description":" Sets whether an entity's shadow should be drawn"},"getBoundingRadius":{"path":"libs_sh/entities.lua#L1890","returns":[{"type":"number","value":"number The radius of the bounding box, or 0 for some entities such as worldspawn","description":"The radius of the bounding box, or 0 for some entities such as worldspawn"}],"realm":"shared","class":"function","name":"getBoundingRadius","description":" Returns the distance between the center of the entity's bounding box and whichever corner of the bounding box is farthest away."},"getCount":{"path":"libs_sh/darkrp2.lua#L878","returns":[{"type":"number?","value":"number? Number of items remaining, or nil if not a shipment","description":"Number of items remaining, or nil if not a shipment"}],"realm":"shared","class":"function","name":"getCount","description":" Get the number of items remaining in a shipment. DarkRP only.\n Equivalent to GLua Entity:Getcount."},"mapCreationID":{"path":"libs_sh/entities.lua#L1934","returns":[{"type":"number","value":"number The map creation ID or -1 if the entity is not compiled into the map.","description":"The map creation ID or -1 if the entity is not compiled into the map."}],"realm":"shared","class":"function","name":"mapCreationID","description":" Returns entity's map creation ID. Unlike Entity:entIndex or Entity:getCreationID, it will always be the same on same map, no matter how much you clean up or restart it."},"extinguish":{"path":"libs_sv/entities.lua#L632","realm":"server","class":"function","name":"extinguish","description":" Extinguishes an entity"},"getSaveTable":{"path":"libs_sh/entities.lua#L1915","returns":[{"type":"table","value":"table A table containing all save values in key/value format. The value may be a sequential table (starting to 1) if the field in question is an array in engine.","description":"A table containing all save values in key/value format. The value may be a sequential table (starting to 1) if the field in question is an array in engine."}],"realm":"shared","params":[{"type":"boolean","value":"boolean showAll If set, shows all variables, not just the ones for save.","name":"showAll","description":"If set, shows all variables, not just the ones for save."}],"class":"function","name":"getSaveTable","description":" Returns a table of save values for an entity.\n These tables are not the same between the client and the server, and different entities may have different fields."},"getPersistent":{"path":"libs_sh/entities.lua#L1693","returns":[{"type":"boolean","value":"boolean True if the entity is persistent","description":"True if the entity is persistent"}],"realm":"shared","class":"function","name":"getPersistent","description":" Checks if entity is marked as persistent"},"getNearestPoint":{"path":"libs_sh/entities.lua#L1906","returns":[{"type":"Vector","value":"Vector The nearest hit point of the entity's bounding box in world coordinates, or Vector(0, 0, 0) for some entities such as worldspawn.","description":"The nearest hit point of the entity's bounding box in world coordinates, or Vector(0, 0, 0) for some entities such as worldspawn."}],"realm":"shared","params":[{"type":"Vector","value":"Vector The vector to start the intersection from.","name":"The","description":"vector to start the intersection from."}],"class":"function","name":"getNearestPoint","description":" Performs a Ray-Orientated Bounding Box intersection from the given position to the origin of the OBBox with the entity and returns the hit position on the OBBox.\n This relies on the entity having a collision mesh (not a physics object) and will be affected by SOLID_NONE"},"isDormant":{"path":"libs_sh/entities.lua#L1897","returns":[{"type":"boolean","value":"boolean Whether entity is dormant or not.","description":"Whether entity is dormant or not."}],"realm":"shared","class":"function","name":"isDormant","description":" Returns whether the entity is dormant or not, i.e. whether or not information about the entity is being sent to your client. Not to be confused with PhysObj:isAsleep\n Clientside, this will usually be true if the object is outside of your PVS (potentially visible set).\n Serverside, this will almost always be false."},"addVelocity":{"path":"libs_sv/entities.lua#L580","realm":"server","params":[{"type":"Vector","value":"Vector vel The world velocity vector to apply","name":"vel","description":"The world velocity vector to apply"}],"class":"function","name":"addVelocity","description":" Applies velocity to an object"},"getInertia":{"path":"libs_sh/entities.lua#L1248","returns":[{"type":"Vector","value":"Vector The principle moments of inertia as a vector","description":"The principle moments of inertia as a vector"}],"realm":"shared","class":"function","name":"getInertia","description":" Returns the principle moments of inertia of the entity"},"hasInstance":{"path":"libs_sh/entities.lua#L960","returns":[{"type":"boolean","value":"boolean if has starfall instance or E2 instance","description":"if has starfall instance or E2 instance"}],"realm":"shared","class":"function","name":"hasInstance","description":" Return if the entity has a starfall instance or E2 instance"},"getInternalVariable":{"path":"libs_sh/entities.lua#L1924","returns":[{"type":"any","value":"any The internal variable associated with the name.","description":"The internal variable associated with the name."}],"realm":"shared","params":[{"type":"string","value":"string variableName Name of the internal save table variable.","name":"variableName","description":"Name of the internal save table variable."}],"class":"function","name":"getInternalVariable","description":" Returns a variable from the entity's save table."},"doorIndex":{"path":"libs_sh/darkrp2.lua#L815","returns":[{"type":"number?","value":"number? The door index, or nil if not a door.","description":"The door index, or nil if not a door."}],"realm":"server","class":"function","name":"doorIndex","description":" Get the DarkRP door index of a door. Use this to store door information in the database."},"isFrozen":{"path":"libs_sv/entities.lua#L826","returns":[{"type":"boolean","value":"boolean True if entity is frozen","description":"True if entity is frozen"}],"realm":"server","class":"function","name":"isFrozen","description":" Checks the entities frozen state"},"getNWVarTable":{"path":"libs_sh/entities.lua#L1883","returns":[{"type":"table","value":"table The table of networked objects","description":"The table of networked objects"}],"realm":"shared","class":"function","name":"getNWVarTable","description":" Gets the table of all networked things on an entity"},"getNWVar":{"path":"libs_sh/entities.lua#L1871","returns":[{"type":"any","value":"any The object associated with that key or nil if it's not set","description":"The object associated with that key or nil if it's not set"}],"realm":"shared","params":[{"type":"string","value":"string key The string key to get","name":"key","description":"The string key to get"}],"class":"function","name":"getNWVar","description":" Gets a networked variable of an entity"},"getDTVector":{"path":"libs_sh/entities.lua#L1861","returns":[{"type":"Vector?","value":"Vector? The vector or nil if it doesn't exist","description":"The vector or nil if it doesn't exist"}],"realm":"shared","params":[{"type":"number","value":"number key The number key. Valid keys are 0 - 31","name":"key","description":"The number key. Valid keys are 0 - 31"}],"class":"function","name":"getDTVector","description":" Gets a datatable vector"},"getElasticity":{"path":"libs_sh/entities.lua#L778","returns":[{"type":"number","value":"number Elasticity","description":"Elasticity"}],"realm":"shared","class":"function","name":"getElasticity","description":" Returns the elasticity of the entity"},"getRenderBounds":{"path":"libs_sh/entities.lua#L247","returns":[{"type":"Vector","value":"Vector The minimum vector of the bounds","description":"The minimum vector of the bounds"},{"type":"Vector","value":"Vector The maximum vector of the bounds","description":"The maximum vector of the bounds"}],"realm":"client","class":"function","name":"getRenderBounds","description":" Returns render bounds of the entity as local vectors\n If the render bounds are not inside players view, the entity will not be drawn!"},"getDTString":{"path":"libs_sh/entities.lua#L1851","returns":[{"type":"string?","value":"string? The string or nil if it doesn't exist","description":"The string or nil if it doesn't exist"}],"realm":"shared","params":[{"type":"number","value":"number key The number key. Valid keys are 0 - 31","name":"key","description":"The number key. Valid keys are 0 - 31"}],"class":"function","name":"getDTString","description":" Gets a datatable string"},"getSequenceCount":{"path":"libs_sh/entities.lua#L1383","returns":[{"type":"number","value":"number Count of entity's animations","description":"Count of entity's animations"}],"realm":"shared","class":"function","name":"getSequenceCount","description":" Gets the number of animations the entity has"},"getDTBool":{"path":"libs_sh/entities.lua#L1811","returns":[{"type":"boolean?","value":"boolean? The boolean or nil if it doesn't exist","description":"The boolean or nil if it doesn't exist"}],"realm":"shared","params":[{"type":"number","value":"number key The number key. Valid keys are 0 - 31","name":"key","description":"The number key. Valid keys are 0 - 31"}],"class":"function","name":"getDTBool","description":" Gets a datatable boolean"},"getUp":{"path":"libs_sh/entities.lua#L1645","returns":[{"type":"Vector","value":"Vector Vector up","description":"Vector up"}],"realm":"shared","class":"function","name":"getUp","description":" Gets the entity's up vector"},"getRenderMode":{"path":"libs_sh/entities.lua#L630","returns":[{"type":"number","value":"number rendermode https://wiki.facepunch.com/gmod/Enums/RENDERMODE","description":"rendermode https://wiki.facepunch.com/gmod/Enums/RENDERMODE"}],"realm":"shared","class":"function","name":"getRenderMode","description":" Gets the render mode of the entity"},"getHitBoxHitGroup":{"path":"libs_sh/entities.lua#L1758","returns":[{"type":"number","value":"number The hitbox group of given hitbox. See https://wiki.facepunch.com/gmod/Enums/HITGROUP","description":"The hitbox group of given hitbox. See https://wiki.facepunch.com/gmod/Enums/HITGROUP"}],"realm":"shared","params":[{"type":"number","value":"number hitbox The number of the hit box.","name":"hitbox","description":"The number of the hit box."},{"type":"number","value":"number hitboxset The number of the hit box set. This should be 0 in most cases.","name":"hitboxset","description":"The number of the hit box set. This should be 0 in most cases."}],"class":"function","name":"getHitBoxHitGroup","description":" Gets the hit group of a given hitbox in a given hitbox set."},"getDTFloat":{"path":"libs_sh/entities.lua#L1831","returns":[{"type":"number?","value":"number? The float or nil if it doesn't exist","description":"The float or nil if it doesn't exist"}],"realm":"shared","params":[{"type":"number","value":"number key The number key. Valid keys are 0 - 31","name":"key","description":"The number key. Valid keys are 0 - 31"}],"class":"function","name":"getDTFloat","description":" Gets a datatable float"},"getHitBoxCount":{"path":"libs_sh/entities.lua#L1723","returns":[{"type":"number","value":"number Number of hitboxes","description":"Number of hitboxes"}],"realm":"shared","params":[{"type":"number","value":"number group The number of the hitbox group.","name":"group","description":"The number of the hitbox group."}],"class":"function","name":"getHitBoxCount","description":" Gets number of hitboxes in a group."},"getDTEntity":{"path":"libs_sh/entities.lua#L1821","returns":[{"type":"Entity?","value":"Entity? The entity or nil if it doesn't exist","description":"The entity or nil if it doesn't exist"}],"realm":"shared","params":[{"type":"number","value":"number key The number key. Valid keys are 0 - 31","name":"key","description":"The number key. Valid keys are 0 - 31"}],"class":"function","name":"getDTEntity","description":" Gets a datatable entity"},"getDTAngle":{"path":"libs_sh/entities.lua#L1801","returns":[{"type":"Angle?","value":"Angle? The angle or nil if it doesn't exist","description":"The angle or nil if it doesn't exist"}],"realm":"shared","params":[{"type":"number","value":"number key The number key. Valid keys are 0 - 31","name":"key","description":"The number key. Valid keys are 0 - 31"}],"class":"function","name":"getDTAngle","description":" Gets a datatable angle"},"getManipulateBonePosition":{"path":"libs_sh/entities.lua#L1146","returns":[{"type":"Vector","value":"Vector Manipulate position of the bone","description":"Manipulate position of the bone"}],"realm":"shared","params":[{"type":"number","value":"number bone Bone index. (def 0)","name":"bone","description":"Bone index. (def 0)"}],"class":"function","name":"getManipulateBonePosition","description":" Returns the vector manipulate position of the bone (relative to its default position)"},"getBrushPlaneCount":{"path":"libs_sh/entities.lua#L1794","returns":[{"type":"number","value":"number The amount of brush planes","description":"The amount of brush planes"}],"realm":"shared","class":"function","name":"getBrushPlaneCount","description":" Returns the amount of planes of the brush entity"},"getOwner":{"path":"libs_sh/entities.lua#L97","returns":[{"type":"Entity","value":"Entity Owner","description":"Owner"}],"realm":"shared","class":"function","name":"getOwner","description":" Gets the owner of the entity"},"setNocollideAll":{"path":"libs_sv/entities.lua#L673","realm":"server","params":[{"type":"boolean","value":"boolean nocollide Whether to collide with nothing except world or not.","name":"nocollide","description":"Whether to collide with nothing except world or not."}],"class":"function","name":"setNocollideAll","description":" Set's the entity to collide with nothing but the world. Alias to entity:setCollisionGroup(COLLISION_GROUP_WORLD)"},"getBrushPlane":{"path":"libs_sh/entities.lua#L1782","returns":[{"type":"Vector","value":"Vector The origin of the plane","description":"The origin of the plane"},{"type":"Vector","value":"Vector The normal of the plane","description":"The normal of the plane"},{"type":"number","value":"number The distance to the plane","description":"The distance to the plane"}],"realm":"shared","params":[{"type":"number","value":"number id Plane index. Starts from 0","name":"id","description":"Plane index. Starts from 0"}],"class":"function","name":"getBrushPlane","description":" Returns info about the given brush plane"},"getBrushSurfaces":{"path":"libs_sh/entities.lua#L1769","returns":[{"type":"table","value":"table Table of SurfaceInfos if the entity has a brush model, or no value otherwise.","description":"Table of SurfaceInfos if the entity has a brush model, or no value otherwise."}],"realm":"shared","class":"function","name":"getBrushSurfaces","description":" Returns a table of brushes surfaces for brush model entities."},"getSequenceInfo":{"path":"libs_sh/entities.lua#L1364","returns":[{"type":"table","value":"table Animation info","description":"Animation info"}],"realm":"shared","params":[{"type":"number","value":"number id The ID of the animation","name":"id","description":"The ID of the animation"}],"class":"function","name":"getSequenceInfo","description":" Gets various information about the specified animation"},"getAttachmentParent":{"path":"libs_sh/entities.lua#L678","returns":[{"type":"number","value":"number Index of the attachment the entity is parented to or 0","description":"Index of the attachment the entity is parented to or 0"}],"realm":"shared","class":"function","name":"getAttachmentParent","description":" Gets the attachment index the entity is parented to"},"getDTInt":{"path":"libs_sh/entities.lua#L1841","returns":[{"type":"number?","value":"number? The int or nil if it doesn't exist","description":"The int or nil if it doesn't exist"}],"realm":"shared","params":[{"type":"number","value":"number key The number key. Valid keys are 0 - 31","name":"key","description":"The number key. Valid keys are 0 - 31"}],"class":"function","name":"getDTInt","description":" Gets a datatable int"},"isOnGround":{"path":"libs_sh/entities.lua#L884","returns":[{"type":"boolean","value":"boolean If it's flag is set or not","description":"If it's flag is set or not"}],"realm":"shared","class":"function","name":"isOnGround","description":" Checks if the entity ONGROUND flag is set"},"getHitBoxSetCount":{"path":"libs_sh/entities.lua#L1751","returns":[{"type":"number","value":"number Number of hitbox sets.","description":"Number of hitbox sets."}],"realm":"shared","class":"function","name":"getHitBoxSetCount","description":" Returns entity's number of hitbox sets."},"getCreationID":{"path":"libs_sv/entities.lua#L1036","returns":[{"type":"number","value":"number The creation ID","description":"The creation ID"}],"realm":"server","class":"function","name":"getCreationID","description":" Returns entity's creation ID (similar to entIndex, but increments monotonically)"},"getFlexScale":{"path":"libs_sh/entities.lua#L1525","returns":[{"type":"number","value":"number The scale of the flexes","description":"The scale of the flexes"}],"realm":"shared","class":"function","name":"getFlexScale","description":" Gets the scale of the entity flexes"},"getPhysicsObjectNum":{"path":"libs_sh/entities.lua#L770","returns":[{"type":"PhysObj","value":"PhysObj The physics object of the entity","description":"The physics object of the entity"}],"realm":"shared","params":[{"type":"number","value":"number id The physics object id (starts at 0)","name":"id","description":"The physics object id (starts at 0)"}],"class":"function","name":"getPhysicsObjectNum","description":" Gets a physics objects of an entity"},"lookupBodygroup":{"path":"libs_sh/entities.lua#L553","returns":[{"type":"number","value":"number The bodygroup index","description":"The bodygroup index"}],"realm":"shared","params":[{"type":"string","value":"string name The bodygroup's string name","name":"name","description":"The bodygroup's string name"}],"class":"function","name":"lookupBodygroup","description":" Returns the bodygroup index of the entity with given name"},"isVehicle":{"path":"libs_sh/entities.lua#L870","returns":[{"type":"boolean","value":"boolean True if vehicle, false if not","description":"True if vehicle, false if not"}],"realm":"shared","class":"function","name":"isVehicle","description":" Checks if an entity is a vehicle."},"toHologram":{"path":"libs_sh/hologram.lua#L89","returns":[{"type":"Hologram","value":"Hologram Hologram instance","description":"Hologram instance"}],"realm":"shared","class":"function","name":"toHologram","description":" Casts a hologram entity into the hologram type"},"setContents":{"path":"libs_sv/entities.lua#L791","realm":"server","params":[{"type":"number","value":"number contents The CONTENTS enum","name":"contents","description":"The CONTENTS enum"}],"class":"function","name":"setContents","description":" Sets the contents flag of the physobject"},"getHitBoxSet":{"path":"libs_sh/entities.lua#L1743","returns":[{"type":"number?","value":"number? Hitbox set number, nil if entity has no hitboxes.","description":"Hitbox set number, nil if entity has no hitboxes."},{"type":"string?","value":"string? Hitbox set name, nil if entity has no hitboxes.","description":"Hitbox set name, nil if entity has no hitboxes."}],"realm":"shared","class":"function","name":"getHitBoxSet","description":" Returns entity's current hit box set."},"getHitBoxBone":{"path":"libs_sh/entities.lua#L1732","returns":[{"type":"number","value":"number Bone ID","description":"Bone ID"}],"realm":"shared","params":[{"type":"number","value":"number hitbox The number of the hitbox.","name":"hitbox","description":"The number of the hitbox."},{"type":"number","value":"number group The number of the hitbox group, 0 in most cases.","name":"group","description":"The number of the hitbox group, 0 in most cases."}],"class":"function","name":"getHitBoxBone","description":" Gets the bone the given hitbox is attached to."},"getRight":{"path":"libs_sh/entities.lua#L1652","returns":[{"type":"Vector","value":"Vector Vector right","description":"Vector right"}],"realm":"shared","class":"function","name":"getRight","description":" Gets the entity's right vector"},"getErroredPlayers":{"path":"libs_sh/entities.lua#L976","returns":[{"type":"table","value":"table A table containing the errored players.","description":"A table containing the errored players."}],"realm":"server","class":"function","name":"getErroredPlayers","description":" Gets all players the specified starfall errored for.\n This excludes the owner of the starfall chip."},"entOwner":{"path":"libs_sh/entities.lua#L1700","returns":[{"type":"Entity","value":"Entity Owner","description":"Owner"}],"realm":"shared","class":"function","name":"entOwner","description":" Returns the game assigned owner of an entity. This doesn't take CPPI into account and will return nil for most standard entities.\n Used on entities with custom physics like held SWEPs and fired bullets in which case player entity should be returned."},"setPersistent":{"path":"libs_sh/entities.lua#L1683","realm":"shared","params":[{"type":"boolean","value":"boolean persist True to make persistent","name":"persist","description":"True to make persistent"}],"class":"function","name":"setPersistent","description":" Marks entity as persistent, disallowing players from physgunning it. Persistent entities save on server shutdown when sbox_persist is set"},"setFlexScale":{"path":"libs_sh/entities.lua#L1531","realm":"shared","params":[{"type":"number","value":"number scale The scale of the flexes to set","name":"scale","description":"The scale of the flexes to set"}],"class":"function","name":"setFlexScale","description":" Sets the scale of the entity flexes"},"translateBoneToPhysBone":{"path":"libs_sh/entities.lua#L742","returns":[{"type":"number","value":"number The physobj id","description":"The physobj id"}],"realm":"shared","params":[{"type":"number","value":"number boneid The ragdoll boneid","name":"boneid","description":"The ragdoll boneid"}],"class":"function","name":"translateBoneToPhysBone","description":" Converts a ragdoll bone id to the corresponding physobject id"},"getMassCenterW":{"path":"libs_sh/entities.lua#L1220","returns":[{"type":"Vector","value":"Vector The position vector of the mass center","description":"The position vector of the mass center"}],"realm":"shared","class":"function","name":"getMassCenterW","description":" Returns the world position of the entity's mass center"},"isEffectActive":{"path":"libs_sh/entities.lua#L1673","returns":[{"type":"boolean","value":"boolean True or false","description":"True or false"}],"realm":"shared","params":[{"type":"number","value":"number effect The effect to check. EF table values","name":"effect","description":"The effect to check. EF table values"}],"class":"function","name":"isEffectActive","description":" Checks if an engine effect is applied to the entity"},"getSolid":{"path":"libs_sh/entities.lua#L718","returns":[{"type":"number","value":"number The solid enum of the entity. https://wiki.facepunch.com/gmod/Enums/SOLID","description":"The solid enum of the entity. https://wiki.facepunch.com/gmod/Enums/SOLID"}],"realm":"shared","class":"function","name":"getSolid","description":" Gets the solid enum of the entity"},"isConstraint":{"path":"libs_sv/entities.lua#L757","returns":[{"type":"boolean","value":"boolean If the entity is a constraint","description":"If the entity is a constraint"}],"realm":"server","class":"function","name":"isConstraint","description":" Returns if the entity is a constraint."},"setBodygroup":{"path":"libs_sh/entities.lua#L517","realm":"shared","params":[{"type":"number","value":"number bodygroup The ID of the bodygroup you're setting.","name":"bodygroup","description":"The ID of the bodygroup you're setting."},{"type":"number","value":"number value The value you're setting the bodygroup to.","name":"value","description":"The value you're setting the bodygroup to."}],"class":"function","name":"setBodygroup","description":" Sets the bodygroup of the entity"},"setSolid":{"path":"libs_sv/entities.lua#L651","realm":"server","params":[{"type":"boolean","value":"boolean solid Should the entity be solid?","name":"solid","description":"Should the entity be solid?"}],"class":"function","name":"setSolid","description":" Sets the entity to be Solid or not."},"getModelScale":{"path":"libs_sh/entities.lua#L1577","returns":[{"type":"number","value":"number Scale of the model","description":"Scale of the model"}],"realm":"shared","class":"function","name":"getModelScale","description":" Returns the model's scale"},"isLocked":{"path":"libs_sh/darkrp2.lua#L822","returns":[{"type":"boolean","value":"boolean Whether it's locked.","description":"Whether it's locked."}],"realm":"server","class":"function","name":"isLocked","description":" Get whether this door/vehicle is locked. DarkRP only."},"getBoneParent":{"path":"libs_sh/entities.lua#L1107","returns":[{"type":"number","value":"number Parent index of the bone. Returns -1 on error","description":"Parent index of the bone. Returns -1 on error"}],"realm":"shared","params":[{"type":"number?","value":"number? bone Bone index. (def 0)","name":"bone","description":"Bone index. (def 0)"}],"class":"function","name":"getBoneParent","description":" Returns the parent index of an entity's bone"},"getEyePos":{"path":"libs_sh/entities.lua#L1605","returns":[{"type":"Vector","value":"Vector Eye position of the entity","description":"Eye position of the entity"},{"type":"Vector?","value":"Vector? In case of a ragdoll, the position of the second eye","description":"In case of a ragdoll, the position of the second eye"}],"realm":"shared","class":"function","name":"getEyePos","description":" Gets the entity's eye position"},"getPhysicsObjectCount":{"path":"libs_sh/entities.lua#L756","returns":[{"type":"number","value":"number The number of physics objects on the entity","description":"The number of physics objects on the entity"}],"realm":"shared","class":"function","name":"getPhysicsObjectCount","description":" Gets the number of physicsobjects of an entity"},"getColor":{"path":"libs_sh/entities.lua#L784","returns":[{"type":"Color","value":"Color Color","description":"Color"}],"realm":"shared","class":"function","name":"getColor","description":" Gets the color of an entity"},"ignite":{"path":"libs_sv/entities.lua#L614","realm":"server","params":[{"type":"number","value":"number length How long the fire lasts","name":"length","description":"How long the fire lasts"},{"type":"number?","value":"number? radius (optional) How large the fire hitbox is (entity obb is the max)","name":"radius","description":"(optional) How large the fire hitbox is (entity obb is the max)"}],"class":"function","name":"ignite","description":" Ignites an entity"},"linkComponent":{"path":"libs_sv/entities.lua#L219","realm":"server","params":[{"type":"Entity?","value":"Entity? e Entity to link the component to, a vehicle or starfall for huds, or a starfall for screens. nil to clear links.","name":"e","description":"Entity to link the component to, a vehicle or starfall for huds, or a starfall for screens. nil to clear links."}],"class":"function","name":"linkComponent","description":" Links starfall components to a starfall processor or vehicle. Screen can only connect to processor. HUD can connect to processor and vehicle."},"isMoneyBag":{"path":"libs_sh/darkrp2.lua#L864","returns":[{"type":"boolean","value":"boolean Whether this entity is a money bag.","description":"Whether this entity is a money bag."}],"realm":"shared","class":"function","name":"isMoneyBag","description":" Get whether this entity is a \"money bag\", i.e. dropped money from a money printer or /dropmoney. DarkRP only."},"getBoneCount":{"path":"libs_sh/entities.lua#L1091","returns":[{"type":"number","value":"number Number of bones","description":"Number of bones"}],"realm":"shared","class":"function","name":"getBoneCount","description":" Returns the number of an entity's bones"},"isSolid":{"path":"libs_sh/entities.lua#L730","returns":[{"type":"boolean","value":"boolean whether an entity is solid or not","description":"whether an entity is solid or not"}],"realm":"shared","class":"function","name":"isSolid","description":" Gets whether an entity is solid or not"},"isOnFire":{"path":"libs_sh/entities.lua#L891","returns":[{"type":"boolean","value":"boolean If the entity is on fire or not","description":"If the entity is on fire or not"}],"realm":"shared","class":"function","name":"isOnFire","description":" Returns if the entity is ignited"},"enableSphere":{"path":"libs_sv/entities.lua#L835","realm":"server","params":[{"type":"boolean","value":"boolean enabled Should the entity be spherical?","name":"enabled","description":"Should the entity be spherical?"},{"type":"number?","value":"number? radius Optional custom radius to use (max 500). Otherwise the prop's obb is used","name":"radius","description":"Optional custom radius to use (max 500). Otherwise the prop's obb is used"}],"class":"function","name":"enableSphere","description":" Sets the physics of an entity to be a sphere"},"getEyeAngles":{"path":"libs_sh/entities.lua#L1598","returns":[{"type":"Angle","value":"Angle Angles of the entity's eyes","description":"Angles of the entity's eyes"}],"realm":"shared","class":"function","name":"getEyeAngles","description":" Gets the entity's eye angles"},"getSequence":{"path":"libs_sh/entities.lua#L1350","returns":[{"type":"number","value":"number The sequence number","description":"The sequence number"}],"realm":"shared","class":"function","name":"getSequence","description":" Gets the current playing sequence"},"getHealth":{"path":"libs_sh/entities.lua#L1591","returns":[{"type":"number","value":"number Health of the entity","description":"Health of the entity"}],"realm":"shared","class":"function","name":"getHealth","description":" Gets the health of an entity"},"getMaxHealth":{"path":"libs_sh/entities.lua#L1584","returns":[{"type":"number","value":"number Max Health of the entity","description":"Max Health of the entity"}],"realm":"shared","class":"function","name":"getMaxHealth","description":" Gets the max health of an entity"},"getSolidFlags":{"path":"libs_sh/entities.lua#L724","returns":[{"type":"number","value":"number The solid flag enum of the entity. https://wiki.facepunch.com/gmod/Enums/FSOLID","description":"The solid flag enum of the entity. https://wiki.facepunch.com/gmod/Enums/FSOLID"}],"realm":"shared","class":"function","name":"getSolidFlags","description":" Gets the solid flag enum of the entity"},"getModelRadius":{"path":"libs_sh/entities.lua#L1570","returns":[{"type":"number","value":"number Radius of the model","description":"Radius of the model"}],"realm":"shared","class":"function","name":"getModelRadius","description":" Returns the model's radius"},"getModelBounds":{"path":"libs_sh/entities.lua#L1553","returns":[{"type":"Vector","value":"Vector Minimum vector of the bounds","description":"Minimum vector of the bounds"},{"type":"Vector","value":"Vector Maximum vector of the bounds","description":"Maximum vector of the bounds"}],"realm":"shared","class":"function","name":"getModelBounds","description":" Returns the entity's model bounds. This is different than the collision bounds/hull.\n This is not scaled with Entity:SetModelScale and will return the model's original, unmodified mins and maxs."},"getModel":{"path":"libs_sh/entities.lua#L1546","returns":[{"type":"string","value":"string Model of the entity","description":"Model of the entity"}],"realm":"shared","class":"function","name":"getModel","description":" Gets the model of an entity"},"setCustomPropShadowForce":{"path":"libs_sv/entities.lua#L323","realm":"server","params":[{"name":"table","description":"|false data Shadow physics data, excluding 'deltatime'. 'teleportdistance' higher than 0 requires 'entities.setPos'. Pass a falsy value to disable custom physics entirely"}],"class":"function","name":"setCustomPropShadowForce","description":" Sets a custom prop's shadow forces, moving the entity to the desired position and angles\n This gets overriden by Entity.setCustomPropForces and cannot be used together\n See available parameters here: https://wiki.facepunch.com/gmod/PhysObj:ComputeShadowControl"},"applyForceCenter":{"path":"libs_sv/entities.lua#L422","realm":"server","params":[{"type":"Vector","value":"Vector vec The force vector","name":"vec","description":"The force vector"}],"class":"function","name":"applyForceCenter","description":" Applies linear force to the entity"},"getFlexWeight":{"path":"libs_sh/entities.lua#L1486","returns":[{"type":"number","value":"number The weight of the flex","description":"The weight of the flex"}],"realm":"shared","params":[{"type":"number","value":"number flexid The id of the flex","name":"flexid","description":"The id of the flex"}],"class":"function","name":"getFlexWeight","description":" Gets the weight (value) of a flex."},"hasFlexManipulations":{"path":"libs_sh/entities.lua#L1479","returns":[{"type":"boolean","value":"boolean True if the entity has flex manipulations, false otherwise.","description":"True if the entity has flex manipulations, false otherwise."}],"realm":"shared","class":"function","name":"hasFlexManipulations","description":" Returns whether or not the the entity has had flex manipulations performed with Entity:setFlexWeight or Entity:setFlexScale."},"__tostring":{"path":"libs_sh/entities.lua#L88","returns":[{"type":"string","value":"string String representation of the entity","description":"String representation of the entity"}],"realm":"shared","class":"function","name":"__tostring","description":" Gets the string representation of the entity"},"getFlexName":{"path":"libs_sh/entities.lua#L1470","returns":[{"type":"string","value":"string The flex name","description":"The flex name"}],"realm":"shared","params":[{"type":"number","value":"number flexid The flex id to look up name of.","name":"flexid","description":"The flex id to look up name of."}],"class":"function","name":"getFlexName","description":" Returns flex name."},"getFlexByName":{"path":"libs_sh/entities.lua#L1461","returns":[{"type":"number","value":"number The ID of the flex based on given name.","description":"The ID of the flex based on given name."}],"realm":"shared","params":[{"type":"string","value":"string flexname The name of the flex to get the ID of. Case sensitive.","name":"flexname","description":"The name of the flex to get the ID of. Case sensitive."}],"class":"function","name":"getFlexByName","description":" Returns the ID of the flex based on given name."},"getRenderFX":{"path":"libs_sh/entities.lua#L656","returns":[{"type":"number","value":"number Renderfx, https://wiki.facepunch.com/gmod/Enums/kRenderFx","description":"Renderfx, https://wiki.facepunch.com/gmod/Enums/kRenderFx"}],"realm":"shared","class":"function","name":"getRenderFX","description":" Gets the renderfx of the entity"},"isWeapon":{"path":"libs_sh/entities.lua#L863","returns":[{"type":"boolean","value":"boolean True if weapon, false if not","description":"True if weapon, false if not"}],"realm":"shared","class":"function","name":"isWeapon","description":" Checks if an entity is a weapon."},"getFlexes":{"path":"libs_sh/entities.lua#L1450","returns":[{"type":"table","value":"table Table of flexes","description":"Table of flexes"}],"realm":"shared","class":"function","name":"getFlexes","description":" Returns a table of flexname -> flexid pairs for use in flex functions."},"lookupAttachment":{"path":"libs_sh/entities.lua#L685","returns":[{"type":"number","value":"number Number of the attachment index, or 0 if it doesn't exist","description":"Number of the attachment index, or 0 if it doesn't exist"}],"realm":"shared","params":[{"type":"string","value":"string name of the attachment to lookup","name":"name","description":"of the attachment to lookup"}],"class":"function","name":"lookupAttachment","description":" Gets the attachment index via the entity and it's attachment name"},"setElasticity":{"path":"libs_sv/entities.lua#L414","realm":"server","params":[{"type":"number","value":"number elasticity","name":"elasticity","description":""}],"class":"function","name":"setElasticity","description":" Sets the elasticity of the entity"},"removeCollisionListener":{"path":"libs_sv/entities.lua#L525","realm":"server","params":[{"type":"string?","value":"string? name The name of the collision listener to remove. (default: \"\")","name":"name","description":"The name of the collision listener to remove. (default: \"\")"}],"class":"function","name":"removeCollisionListener","description":" Removes a collision listener from the entity"},"getManipulateBoneAngles":{"path":"libs_sh/entities.lua#L1128","returns":[{"type":"Angle","value":"Angle Manipulate angle of the bone","description":"Manipulate angle of the bone"}],"realm":"shared","params":[{"type":"number","value":"number bone Bone index. (def 0)","name":"bone","description":"Bone index. (def 0)"}],"class":"function","name":"getManipulateBoneAngles","description":" Returns the manipulate angle of the bone (relative to its default angle)"},"getPoseIndex":{"path":"libs_sh/entities.lua#L1428","returns":[{"type":"number","value":"number Pose index or -1 if not found","description":"Pose index or -1 if not found"}],"realm":"shared","params":[{"type":"string","value":"string pose Pose name","name":"pose","description":"Pose name"}],"class":"function","name":"getPoseIndex","description":" Returns pose index corresponding to the given name"},"getPhysMaterial":{"path":"libs_sv/entities.lua#L731","returns":[{"type":"string","value":"string The physical material","description":"The physical material"}],"realm":"server","class":"function","name":"getPhysMaterial","description":" Get the physical material of the entity"},"getAngles":{"path":"libs_sh/entities.lua#L1230","returns":[{"type":"Angle","value":"Angle The angle","description":"The angle"}],"realm":"shared","class":"function","name":"getAngles","description":" Returns the angle of the entity"},"getBodygroupName":{"path":"libs_sh/entities.lua#L562","returns":[{"type":"string","value":"string The bodygroup name","description":"The bodygroup name"}],"realm":"shared","params":[{"type":"number","value":"number id The bodygroup's number index","name":"id","description":"The bodygroup's number index"}],"class":"function","name":"getBodygroupName","description":" Returns the bodygroup name of the entity with given index"},"setParent":{"path":"libs_sh/entities.lua#L381","realm":"shared","params":[{"type":"Entity?","value":"Entity? parent Entity parent (nil to unparent)","name":"parent","description":"Entity parent (nil to unparent)"},{"type":"number|string|nil","value":"number|string|nil attachment Optional attachment name or ID.","name":"attachment","description":"Optional attachment name or ID."},{"type":"number|string|nil","value":"number|string|nil bone Optional bone name or ID. Can't be used at the same time as attachment","name":"bone","description":"Optional bone name or ID. Can't be used at the same time as attachment"}],"class":"function","name":"setParent","description":" Parents or unparents an entity. Only holograms can be parented to players and clientside holograms can only be parented in the CLIENT realm."},"translatePhysBoneToBone":{"path":"libs_sh/entities.lua#L749","returns":[{"type":"number","value":"number The ragdoll bone id","description":"The ragdoll bone id"}],"realm":"shared","params":[{"type":"number","value":"number boneid The physobject id","name":"boneid","description":"The physobject id"}],"class":"function","name":"translatePhysBoneToBone","description":" Converts a physobject id to the corresponding ragdoll bone id"},"getPoseCount":{"path":"libs_sh/entities.lua#L1422","returns":[{"type":"number","value":"number Amount of poses","description":"Amount of poses"}],"realm":"shared","class":"function","name":"getPoseCount","description":" Returns the amount of pose parameters the entity has"},"getAmount":{"path":"libs_sh/darkrp2.lua#L870","returns":[{"type":"number?","value":"number? Amount of money or number of items","description":"Amount of money or number of items"}],"realm":"shared","class":"function","name":"getAmount","description":" Get the amount of money in a \"money bag\" or cheque, or number of items in a dropped item stack. DarkRP only.\n Equivalent to GLua Entity:Getamount."},"getPose":{"path":"libs_sh/entities.lua#L1415","returns":[{"type":"number","value":"number Value of the pose parameter","description":"Value of the pose parameter"}],"realm":"shared","params":[{"type":"string","value":"string pose Pose parameter name","name":"pose","description":"Pose parameter name"}],"class":"function","name":"getPose","description":" Get the pose value of an animation"},"setPose":{"path":"libs_sh/entities.lua#L1405","realm":"shared","params":[{"type":"string","value":"string pose Name of the pose parameter","name":"pose","description":"Name of the pose parameter"},{"type":"number","value":"number value Value to set it to.","name":"value","description":"Value to set it to."}],"class":"function","name":"setPose","description":" Set the pose value of an animation. Turret/Head angles for example."},"canDraw":{"path":"libs_sh/entities.lua#L271","returns":[{"type":"boolean","value":"boolean Whether the entity can be drawn","description":"Whether the entity can be drawn"}],"realm":"client","class":"function","name":"canDraw","description":" Returns whether or not the entity can be drawn using Entity.draw function\n Checks Entity against a predefined class whitelist\n Entities that have RenderOverride defined or are parented cannot be drawn"},"breakEnt":{"path":"libs_sv/entities.lua#L604","realm":"server","class":"function","name":"breakEnt","description":" Invokes the entity's breaking animation and removes it."},"sequenceDuration":{"path":"libs_sh/entities.lua#L1395","returns":[{"type":"number","value":"number Length of the animation in seconds","description":"Length of the animation in seconds"}],"realm":"shared","params":[{"type":"number?","value":"number? id (Optional) The id of the sequence, or will default to the currently playing sequence","name":"id","description":"(Optional) The id of the sequence, or will default to the currently playing sequence"}],"class":"function","name":"sequenceDuration","description":" Get the length of an animation"},"getSkin":{"path":"libs_sh/entities.lua#L598","returns":[{"type":"number","value":"number Skin number","description":"Skin number"}],"realm":"shared","class":"function","name":"getSkin","description":" Gets the skin number of the entity"},"getSequenceList":{"path":"libs_sh/entities.lua#L1377","returns":[{"type":"table","value":"table List of animations, starts at index 0 where value is the animation's name","description":"List of animations, starts at index 0 where value is the animation's name"}],"realm":"shared","class":"function","name":"getSequenceList","description":" Returns all animations of the entity"},"setSubMaterial":{"path":"libs_sh/entities.lua#L482","realm":"shared","params":[{"type":"number","value":"number index Submaterial index.","name":"index","description":"Submaterial index."},{"type":"string","value":"string material New material name.","name":"material","description":"New material name."}],"class":"function","name":"setSubMaterial","description":" Sets the submaterial of the entity"},"getClipping":{"path":"libs_sh/entities.lua#L791","returns":[{"type":"table","value":"table Table containing the clipdata","description":"Table containing the clipdata"}],"realm":"shared","class":"function","name":"getClipping","description":" Gets the clipping of an entity"},"getSequenceName":{"path":"libs_sh/entities.lua#L1356","returns":[{"type":"string","value":"string The sequence name","description":"The sequence name"}],"realm":"shared","params":[{"type":"number","value":"number id The id of the animation","name":"id","description":"The id of the animation"}],"class":"function","name":"getSequenceName","description":" Gets the name of a sequence"},"lookupSequence":{"path":"libs_sh/entities.lua#L1341","returns":[{"type":"number","value":"number Animation index or -1 if invalid","description":"Animation index or -1 if invalid"}],"realm":"shared","params":[{"type":"string","value":"string animation Name of the animation","name":"animation","description":"Name of the animation"}],"class":"function","name":"lookupSequence","description":" Gets the animation number from the animation name"},"getMoveType":{"path":"libs_sh/entities.lua#L736","returns":[{"type":"number","value":"number The movetype enum of the entity. https://wiki.facepunch.com/gmod/Enums/MOVETYPE","description":"The movetype enum of the entity. https://wiki.facepunch.com/gmod/Enums/MOVETYPE"}],"realm":"shared","class":"function","name":"getMoveType","description":" Gets the movetype enum of the entity"},"obbCenterW":{"path":"libs_sh/entities.lua#L1179","returns":[{"type":"Vector","value":"Vector The position vector of the outer bounding box center","description":"The position vector of the outer bounding box center"}],"realm":"shared","class":"function","name":"obbCenterW","description":" Returns the world position of the entity's outer bounding box"},"worldToLocal":{"path":"libs_sh/entities.lua#L1317","returns":[{"type":"Vector","value":"Vector data as local space vector","description":"data as local space vector"}],"realm":"shared","params":[{"type":"Vector","value":"Vector data World space vector","name":"data","description":"World space vector"}],"class":"function","name":"worldToLocal","description":" Converts a vector in world space to entity local space"},"getBoneMatrix":{"path":"libs_sh/entities.lua#L1060","returns":[{"type":"VMatrix","value":"VMatrix The matrix","description":"The matrix"}],"realm":"shared","params":[{"type":"number?","value":"number? bone Bone index. (def 0)","name":"bone","description":"Bone index. (def 0)"}],"class":"function","name":"getBoneMatrix","description":" Returns the matrix of the entity's bone. Note: this method is slow/doesnt work well if the entity isn't animated."},"worldToLocalVector":{"path":"libs_sh/entities.lua#L1325","returns":[{"type":"Vector","value":"Vector data as local space direction vector","description":"data as local space direction vector"}],"realm":"shared","params":[{"type":"Vector","value":"Vector data World space direction vector","name":"data","description":"World space direction vector"}],"class":"function","name":"worldToLocalVector","description":" Converts a direction vector in world space to entity local space"},"localToWorldAngles":{"path":"libs_sh/entities.lua#L1309","returns":[{"type":"Angle","value":"Angle data as world space angle","description":"data as world space angle"}],"realm":"shared","params":[{"type":"Angle","value":"Angle data Local space angle","name":"data","description":"Local space angle"}],"class":"function","name":"localToWorldAngles","description":" Converts an angle in entity local space to world space"},"setAngleVelocity":{"path":"libs_sv/entities.lua#L370","realm":"server","params":[{"type":"Vector","value":"Vector angvel The local angvel vector to set","name":"angvel","description":"The local angvel vector to set"}],"class":"function","name":"setAngleVelocity","description":" Set the angular velocity of an object"},"setSheetColor":{"path":"libs_sh/entities.lua#L213","realm":"client","params":[{"type":"Color","value":"Color clr RGB color to use, alpha channel not supported","name":"clr","description":"RGB color to use, alpha channel not supported"}],"class":"function","name":"setSheetColor","description":" Sets the sheet color of a player-model\n Can only be used on players, bots, ragdolls, holograms and Starfall NextBots"},"isValid":{"path":"libs_sh/entities.lua#L849","returns":[{"type":"boolean","value":"boolean True if valid, false if not","description":"True if valid, false if not"}],"realm":"shared","class":"function","name":"isValid","description":" Checks if an entity is valid."},"getAngleVelocityAngle":{"path":"libs_sh/entities.lua#L1283","returns":[{"type":"Angle","value":"Angle The angular velocity as an angle","description":"The angular velocity as an angle"}],"realm":"shared","class":"function","name":"getAngleVelocityAngle","description":" Returns the angular velocity of the entity"},"setLOD":{"path":"libs_sh/entities.lua#L258","realm":"client","params":[{"type":"number","value":"number lod The Level Of Detail model ID to use.","name":"lod","description":"The Level Of Detail model ID to use."}],"class":"function","name":"setLOD","description":" Sets the Level Of Detail model to use with this entity. This may not work for all models if the model doesn't include any LOD sub models.\n This function works exactly like the clientside r_lod convar and takes priority over it.\n -1 leaves the engine to automatically set the Level of Detail. The Level Of Detail may range from 0 to 8, with 0 being the highest quality and 8 the lowest."},"getLocalVelocity":{"path":"libs_sh/entities.lua#L1266","returns":[{"type":"Vector","value":"Vector Vector velocity of the physics object local to itself","description":"Vector velocity of the physics object local to itself"}],"realm":"shared","class":"function","name":"getLocalVelocity","description":" Gets the velocity of the entity in its local coordinate system"},"removeTrails":{"path":"libs_sv/entities.lua#L988","realm":"server","class":"function","name":"removeTrails","description":" Removes trails from the entity"},"getMass":{"path":"libs_sh/entities.lua#L1237","returns":[{"type":"number","value":"number The numerical mass","description":"The numerical mass"}],"realm":"shared","class":"function","name":"getMass","description":" Returns the mass of the entity"},"setMaterial":{"path":"libs_sh/entities.lua#L464","realm":"shared","params":[{"type":"string","value":"string material New material name.","name":"material","description":"New material name."}],"class":"function","name":"setMaterial","description":" Sets the material of the entity"},"setBoneMatrix":{"path":"libs_sh/entities.lua#L1070","realm":"shared","params":[{"type":"number","value":"number bone The bone ID","name":"bone","description":"The bone ID"},{"type":"VMatrix","value":"VMatrix matrix The matrix to set","name":"matrix","description":"The matrix to set"}],"class":"function","name":"setBoneMatrix","description":" Sets the bone matrix of given bone to given matrix. See also Entity:getBoneMatrix."},"testPVS":{"path":"libs_sv/entities.lua#L1018","returns":[{"type":"boolean","value":"boolean If the Entity/Vector is within the PVS","description":"If the Entity/Vector is within the PVS"}],"realm":"server","params":[{"type":"Entity|Vector","value":"Entity|Vector other Entity or Vector to test","name":"other","description":"Entity or Vector to test"}],"class":"function","name":"testPVS","description":" Check if the given Entity or Vector is within this entity's PVS (Potentially Visible Set). See: https://developer.valvesoftware.com/wiki/PVS"},"getMassCenter":{"path":"libs_sh/entities.lua#L1210","returns":[{"type":"Vector","value":"Vector The position vector of the mass center","description":"The position vector of the mass center"}],"realm":"shared","class":"function","name":"getMassCenter","description":" Returns the local position of the entity's mass center"},"draw":{"path":"libs_sh/entities.lua#L280","realm":"client","class":"function","name":"draw","description":" Draws the entity, requires 3D rendering context\n Only certain, whitelisted entities can be drawn. They can't be parented or have RenderOverride defined\n Use Entity.canDraw to check if you can draw the entity"},"localToWorldVector":{"path":"libs_sh/entities.lua#L1301","returns":[{"type":"Vector","value":"Vector data as world space vector direction","description":"data as world space vector direction"}],"realm":"shared","params":[{"type":"Vector","value":"Vector data Local space vector direction","name":"data","description":"Local space vector direction"}],"class":"function","name":"localToWorldVector","description":" Converts a direction vector in entity local space to world space"},"getDoorOwner":{"path":"libs_sh/darkrp2.lua#L830","returns":[{"type":"Player?","value":"Player? The owner of the door, or nil if the door is unowned.","description":"The owner of the door, or nil if the door is unowned."}],"realm":"shared","class":"function","name":"getDoorOwner","description":" Get the owner of a door. DarkRP only."},"getBodygroups":{"path":"libs_sh/entities.lua#L546","returns":[{"type":"table","value":"table Bodygroups as a table of BodyGroupDatas. https://wiki.facepunch.com/gmod/Structures/BodyGroupData","description":"Bodygroups as a table of BodyGroupDatas. https://wiki.facepunch.com/gmod/Structures/BodyGroupData"}],"realm":"shared","class":"function","name":"getBodygroups","description":" Returns a list of all bodygroups of the entity"},"setMaxHealth":{"path":"libs_sh/entities.lua#L1004","realm":"server","params":[{"type":"number","value":"number newmaxhealth New max health value.","name":"newmaxhealth","description":"New max health value."}],"class":"function","name":"setMaxHealth","description":" Sets the maximum health for entity. Note, that you can still set entity's health above this amount with Entity:setHealth."},"obbMaxs":{"path":"libs_sh/entities.lua#L1194","returns":[{"type":"Vector","value":"Vector The max bounding box vector","description":"The max bounding box vector"}],"realm":"shared","class":"function","name":"obbMaxs","description":" Returns max local bounding box vector of the entity"},"worldToLocalAngles":{"path":"libs_sh/entities.lua#L1333","returns":[{"type":"Angle","value":"Angle data as local space angle","description":"data as local space angle"}],"realm":"shared","params":[{"type":"Angle","value":"Angle data World space angle","name":"data","description":"World space angle"}],"class":"function","name":"worldToLocalAngles","description":" Converts an angle in world space to entity local space"},"obbCenter":{"path":"libs_sh/entities.lua#L1172","returns":[{"type":"Vector","value":"Vector The position vector of the outer bounding box center","description":"The position vector of the outer bounding box center"}],"realm":"shared","class":"function","name":"obbCenter","description":" Returns the local position of the entity's outer bounding box"},"getShipmentContents":{"path":"libs_sh/darkrp2.lua#L895","returns":[{"type":"table?","value":"table? Contents, or nil if not a shipment","description":"Contents, or nil if not a shipment"}],"realm":"shared","class":"function","name":"getShipmentContents","description":" Get the info for the contents of the shipment. DarkRP only.\n Equivalent to \"darkrp.getCustomShipments()[ent:getShipmentContentsIndex()]\""},"manipulateBoneJiggle":{"path":"libs_sh/entities.lua#L158","realm":"client","params":[{"type":"number","value":"number bone The bone ID","name":"bone","description":"The bone ID"},{"type":"boolean","value":"boolean enabled Whether to make the bone jiggly or not","name":"enabled","description":"Whether to make the bone jiggly or not"}],"class":"function","name":"manipulateBoneJiggle","description":" Allows manipulation of an entity's bones' jiggle status"},"setInertia":{"path":"libs_sv/entities.lua#L699","realm":"server","params":[{"type":"Vector","value":"Vector vec Inertia tensor","name":"vec","description":"Inertia tensor"}],"class":"function","name":"setInertia","description":" Sets the entity's inertia"},"getBodygroupCount":{"path":"libs_sh/entities.lua#L572","returns":[{"type":"number","value":"number Number of values of specified bodygroup, or 0 if there are none.","description":"Number of values of specified bodygroup, or 0 if there are none."}],"realm":"shared","params":[{"type":"number","value":"number id The ID of the bodygroup to get the count for.","name":"id","description":"The ID of the bodygroup to get the count for."}],"class":"function","name":"getBodygroupCount","description":" Returns the number of possible values for this bodygroup.\n Note that bodygroups are 0-indexed, so this will not return the maximum allowed value."},"getManipulateBoneJiggle":{"path":"libs_sh/entities.lua#L1137","returns":[{"type":"number","value":"number Manipulate jiggle of the bone","description":"Manipulate jiggle of the bone"}],"realm":"shared","params":[{"type":"number?","value":"number? bone Bone index. (def 0)","name":"bone","description":"Bone index. (def 0)"}],"class":"function","name":"getManipulateBoneJiggle","description":" Returns the number manipulate jiggle of the bone (0 - 255)"},"setCollisionGroup":{"path":"libs_sv/entities.lua#L661","realm":"server","params":[{"type":"number","value":"number group The COLLISION_GROUP value to set it to","name":"group","description":"The COLLISION_GROUP value to set it to"}],"class":"function","name":"setCollisionGroup","description":" Sets the entity's collision group"},"getPoseName":{"path":"libs_sh/entities.lua#L1435","returns":[{"type":"string","value":"string Pose name or empty string if not found","description":"Pose name or empty string if not found"}],"realm":"shared","params":[{"type":"number","value":"number id Pose index (starting from 0)","name":"id","description":"Pose index (starting from 0)"}],"class":"function","name":"getPoseName","description":" Returns pose name corresponding to the given index"},"getBonePosition":{"path":"libs_sh/entities.lua#L1116","returns":[{"type":"Vector","value":"Vector Position of the bone","description":"Position of the bone"},{"type":"Angle","value":"Angle Angle of the bone","description":"Angle of the bone"}],"realm":"shared","params":[{"type":"number?","value":"number? bone Bone index. (def 0)","name":"bone","description":"Bone index. (def 0)"}],"class":"function","name":"getBonePosition","description":" Returns the bone's position and angle in world coordinates"},"getMaterial":{"path":"libs_sh/entities.lua#L1617","returns":[{"type":"string","value":"string String material","description":"String material"}],"realm":"shared","class":"function","name":"getMaterial","description":" Gets an entities' material"},"getChipAuthor":{"path":"libs_sh/entities.lua#L909","returns":[{"type":"string","value":"string The author of the starfall chip.","description":"The author of the starfall chip."}],"realm":"shared","class":"function","name":"getChipAuthor","description":" Gets the author of the specified starfall."},"getBoneName":{"path":"libs_sh/entities.lua#L1098","returns":[{"type":"string","value":"string Name of the bone","description":"Name of the bone"}],"realm":"shared","params":[{"type":"number?","value":"number? bone Bone index. (def 0)","name":"bone","description":"Bone index. (def 0)"}],"class":"function","name":"getBoneName","description":" Returns the name of an entity's bone"},"getMatrix":{"path":"libs_sh/entities.lua#L1084","returns":[{"type":"VMatrix","value":"VMatrix The matrix","description":"The matrix"}],"realm":"shared","class":"function","name":"getMatrix","description":" Returns the world transform matrix of the entity"},"setRenderFX":{"path":"libs_sh/entities.lua#L638","realm":"shared","params":[{"type":"number","value":"number renderfx Renderfx to use. http://wiki.facepunch.com/gmod/Enums/kRenderFx","name":"renderfx","description":"Renderfx to use. http://wiki.facepunch.com/gmod/Enums/kRenderFx"}],"class":"function","name":"setRenderFX","description":" Sets the renderfx of the entity, most effects require entity's alpha to be less than 255 to take effect"},"getWaterLevel":{"path":"libs_sh/entities.lua#L1044","returns":[{"type":"number","value":"number The water level. 0 none, 1 slightly, 2 at least halfway, 3 all the way","description":"The water level. 0 none, 1 slightly, 2 at least halfway, 3 all the way"}],"realm":"shared","class":"function","name":"getWaterLevel","description":" Returns how submerged the entity is in water"},"setHealth":{"path":"libs_sh/entities.lua#L994","realm":"server","params":[{"type":"number","value":"number newhealth New health value.","name":"newhealth","description":"New health value."}],"class":"function","name":"setHealth","description":" Sets the health of the entity."},"getClass":{"path":"libs_sh/entities.lua#L1030","returns":[{"type":"string","value":"string The string class name","description":"The string class name"}],"realm":"shared","class":"function","name":"getClass","description":" Returns the class of the entity"},"setCustomPropForces":{"path":"libs_sv/entities.lua#L295","realm":"server","params":[{"type":"Vector","value":"Vector ang Angular Force (Torque)","name":"ang","description":"Angular Force (Torque)"},{"type":"Vector","value":"Vector lin Linear Force","name":"lin","description":"Linear Force"},{"type":"number","value":"number mode The physics mode to use. 0 = Off (disables custom physics entirely), 1 = Local acceleration, 2 = Local force, 3 = Global Acceleration, 4 = Global force","name":"mode","description":"The physics mode to use. 0 = Off (disables custom physics entirely), 1 = Local acceleration, 2 = Local force, 3 = Global Acceleration, 4 = Global force"}],"class":"function","name":"setCustomPropForces","description":" Sets a custom prop's physics simulation forces. Thrusters and balloons use this.\n This takes precedence over Entity.setCustomPropShadowForce and cannot be used together"},"setFrozen":{"path":"libs_sv/entities.lua#L820","realm":"server","params":[{"type":"boolean","value":"boolean freeze Should the entity be frozen?","name":"freeze","description":"Should the entity be frozen?"}],"class":"function","name":"setFrozen","description":" Sets the entity frozen state, same as `Entity.enableMotion` but inverted"},"doNotDuplicate":{"path":"libs_sh/entities.lua#L1014","realm":"server","class":"function","name":"doNotDuplicate","description":" Stops the entity from being saved on duplication or map save."},"getQuaternion":{"path":"libs_sh/quaternion.lua#L841","returns":[{"type":"Quaternion","value":"Quaternion Constructed quaternion","description":"Constructed quaternion"}],"realm":"shared","class":"function","name":"getQuaternion","description":" Converts entity angles to a quaternion"},"getPos":{"path":"libs_sh/entities.lua#L1037","returns":[{"type":"Vector","value":"Vector The position vector","description":"The position vector"}],"realm":"shared","class":"function","name":"getPos","description":" Returns the position of the entity"},"getPhysicsObject":{"path":"libs_sh/entities.lua#L762","returns":[{"type":"PhysObj","value":"PhysObj The main physics object of the entity","description":"The main physics object of the entity"}],"realm":"shared","class":"function","name":"getPhysicsObject","description":" Gets the main physics objects of an entity"},"getChipName":{"path":"libs_sh/entities.lua#L898","returns":[{"type":"string","value":"string The name of the chip","description":"The name of the chip"}],"realm":"shared","class":"function","name":"getChipName","description":" Returns the starfall or expression2's name"},"isSequenceFinished":{"path":"libs_sh/entities.lua#L1389","returns":[{"type":"boolean","value":"boolean True if the animation is currently playing, False otherwise","description":"True if the animation is currently playing, False otherwise"}],"realm":"shared","class":"function","name":"isSequenceFinished","description":" Checks whether the animation is playing"},"getRenderGroup":{"path":"libs_sh/entities.lua#L293","returns":[{"type":"number","value":"number Render group","description":"Render group"}],"realm":"client","class":"function","name":"getRenderGroup","description":" Returns the render group of the entity."},"getQuotaUsed":{"path":"libs_sh/entities.lua#L919","returns":[{"type":"number","value":"number Current quota used this Think","description":"Current quota used this Think"}],"realm":"shared","class":"function","name":"getQuotaUsed","description":" Returns the current count for this Think's CPU Time of the specified starfall.\n This value increases as more executions are done, may not be exactly as you want.\n If used on screens, will show 0 if only rendering is done. Operations must be done in the Think loop for them to be counted."},"enableMotion":{"path":"libs_sv/entities.lua#L806","realm":"server","params":[{"type":"boolean","value":"boolean move Should the entity move?","name":"move","description":"Should the entity move?"}],"class":"function","name":"enableMotion","description":" Sets the entity movement state"},"manipulateBoneScale":{"path":"libs_sh/entities.lua#L126","realm":"client","params":[{"type":"number","value":"number bone The bone ID","name":"bone","description":"The bone ID"},{"type":"Vector","value":"Vector vec The scale it should be manipulated to","name":"vec","description":"The scale it should be manipulated to"}],"class":"function","name":"manipulateBoneScale","description":" Allows manipulation of an entity's bones' scale"},"setPos":{"path":"libs_sv/entities.lua#L545","realm":"server","params":[{"type":"Vector","value":"Vector vec New position","name":"vec","description":"New position"}],"class":"function","name":"setPos","description":" Sets the entity's position. No interpolation will occur clientside, use physobj.setPos to have interpolation."},"applyAngForce":{"path":"libs_sv/entities.lua#L456","realm":"server","params":[{"type":"Angle","value":"Angle ang The force angle","name":"ang","description":"The force angle"}],"class":"function","name":"applyAngForce","description":" Applies angular force to the entity (This function is garbage, use applyTorque instead)"},"setMeshMaterial":{"path":"libs_sh/entities.lua#L191","realm":"client","params":[{"type":"Material?","value":"Material? material The material to set it to or nil to set back to default","name":"material","description":"The material to set it to or nil to set back to default"}],"class":"function","name":"setMeshMaterial","description":" Sets a hologram or custom_prop's custom mesh material"},"isNPC":{"path":"libs_sh/entities.lua#L877","returns":[{"type":"boolean","value":"boolean True if npc, false if not","description":"True if npc, false if not"}],"realm":"shared","class":"function","name":"isNPC","description":" Checks if an entity is an npc."},"use":{"path":"libs_sv/entities.lua#L640","realm":"server","params":[{"type":"number?","value":"number? usetype The USE_ enum use type. (Default: USE_ON)","name":"usetype","description":"The USE_ enum use type. (Default: USE_ON)"},{"type":"number?","value":"number? value The use value (Default: 0)","name":"value","description":"The use value (Default: 0)"}],"class":"function","name":"use","description":" Simulate a Use action on the entity by the chip owner"},"isKeysOwnedBy":{"path":"libs_sh/darkrp2.lua#L856","returns":[{"type":"boolean","value":"boolean Whether this door is (co-)owned by the player.","description":"Whether this door is (co-)owned by the player."}],"realm":"shared","params":[{"type":"Player","value":"Player ply The player to query.","name":"ply","description":"The player to query."}],"class":"function","name":"isKeysOwnedBy","description":" Get whether this door is owned or co-owned by this player."},"setFriction":{"path":"libs_sv/entities.lua#L406","realm":"server","params":[{"type":"number","value":"number friction","name":"friction","description":""}],"class":"function","name":"setFriction","description":" Sets the entity's friction multiplier"},"applyTorque":{"path":"libs_sv/entities.lua#L496","realm":"server","params":[{"type":"Vector","value":"Vector torque The torque vector","name":"torque","description":"The torque vector"}],"class":"function","name":"applyTorque","description":" Applies torque"},"getShipmentContentsIndex":{"path":"libs_sh/darkrp2.lua#L886","returns":[{"type":"number?","value":"number? Index of contents, or nil if not a shipment","description":"Index of contents, or nil if not a shipment"}],"realm":"shared","class":"function","name":"getShipmentContentsIndex","description":" Get the index of the contents of the shipment, which should then be looked up in the output of \"darkrp.getCustomShipments\". DarkRP only.\n Equivalent to GLua Entity:Getcontents.\n You may prefer to use Entity:getShipmentContents instead, although that function is slightly slower."},"worldSpaceAABB":{"path":"libs_sh/entities.lua#L1201","returns":[{"type":"Vector","value":"Vector The min bounding box vector","description":"The min bounding box vector"},{"type":"Vector","value":"Vector The max bounding box vector","description":"The max bounding box vector"}],"realm":"shared","class":"function","name":"worldSpaceAABB","description":" Returns Entity axis aligned bounding box in world coordinates"},"stopSound":{"path":"libs_sh/entities.lua#L341","realm":"shared","params":[{"type":"string","value":"string snd string Soundscript path. See http://wiki.facepunch.com/gmod/Entity:StopSound","name":"snd","description":"string Soundscript path. See http://wiki.facepunch.com/gmod/Entity:StopSound"}],"class":"function","name":"stopSound","description":" Stops a sound on the entity"},"getAllConstrained":{"path":"libs_sv/entities.lua#L904","realm":"server","params":[{"type":"table?","value":"table? filter Optional constraint type filter table where keys are the type name and values are 'true'. \"Wire\" and \"Parent\" are used for wires and parents.","name":"filter","description":"Optional constraint type filter table where keys are the type name and values are 'true'. \"Wire\" and \"Parent\" are used for wires and parents."}],"class":"function","name":"getAllConstrained","description":" Gets a table of all constrained entities to each other"},"remove":{"path":"libs_sv/entities.lua#L595","realm":"server","class":"function","name":"remove","description":" Removes an entity"},"obbSize":{"path":"libs_sh/entities.lua#L1164","returns":[{"type":"Vector","value":"Vector The outer bounding box size","description":"The outer bounding box size"}],"realm":"shared","class":"function","name":"obbSize","description":" Returns the x, y, z size of the entity's outer bounding box (local to the entity)"},"setMass":{"path":"libs_sv/entities.lua#L683","realm":"server","params":[{"type":"number","value":"number mass Mass to set to","name":"mass","description":"Mass to set to"}],"class":"function","name":"setMass","description":" Sets the entity's mass"},"getFriction":{"path":"libs_sv/entities.lua#L400","returns":[{"type":"number","value":"number friction","description":"friction"}],"realm":"server","class":"function","name":"getFriction","description":" Returns how much friction the entity has, default is 1 (100%)"},"getParent":{"path":"libs_sh/entities.lua#L664","returns":[{"type":"Entity?","value":"Entity? Entity's parent or nil if not parented","description":"Entity's parent or nil if not parented"}],"realm":"shared","class":"function","name":"getParent","description":" Gets the parent of an entity"},"getManipulateBoneScale":{"path":"libs_sh/entities.lua#L1155","returns":[{"type":"Vector","value":"Vector Manipulate scale of the bone","description":"Manipulate scale of the bone"}],"realm":"shared","params":[{"type":"number","value":"number bone Bone index. (def 0)","name":"bone","description":"Bone index. (def 0)"}],"class":"function","name":"getManipulateBoneScale","description":" Returns the vector manipulate scale of the bone"},"getKeysTitle":{"path":"libs_sh/darkrp2.lua#L837","returns":[{"type":"string?","value":"string? The title of the door or vehicle, or nil if none is set.","description":"The title of the door or vehicle, or nil if none is set."}],"realm":"shared","class":"function","name":"getKeysTitle","description":" Get the title of this door or vehicle. DarkRP only.\n If you don't know what this is referring to, that's because it's not a commonly used feature. Press F2 on a door and click \"Set Door Title\"."},"addAngleVelocity":{"path":"libs_sv/entities.lua#L385","realm":"server","params":[{"type":"Vector","value":"Vector angvel The local angvel vector to apply","name":"angvel","description":"The local angvel vector to apply"}],"class":"function","name":"addAngleVelocity","description":" Applies a angular velocity to an object"},"setColor":{"path":"libs_sh/entities.lua#L429","realm":"shared","params":[{"type":"Color","value":"Color clr New color","name":"clr","description":"New color"}],"class":"function","name":"setColor","description":" Sets the color of the entity"},"getChildren":{"path":"libs_sh/entities.lua#L671","returns":[{"type":"table","value":"table Table of parented children","description":"Table of parented children"}],"realm":"shared","class":"function","name":"getChildren","description":" Gets the children (the parented entities) of an entity"},"applyForceOffset":{"path":"libs_sv/entities.lua#L437","realm":"server","params":[{"type":"Vector","value":"Vector force The force vector in world coordinates","name":"force","description":"The force vector in world coordinates"},{"type":"Vector","value":"Vector position The force position in world coordinates","name":"position","description":"The force position in world coordinates"}],"class":"function","name":"applyForceOffset","description":" Applies linear force to the entity with an offset"},"getWirelink":{"path":"libs_sv/wire.lua#L629","returns":[{"type":"Wirelink","value":"Wirelink Wirelink of the entity","description":"Wirelink of the entity"}],"realm":"server","class":"function","name":"getWirelink","description":" Returns an entities wirelink"},"entIndex":{"path":"libs_sh/entities.lua#L1023","returns":[{"type":"number","value":"number The numerical index of the entity","description":"The numerical index of the entity"}],"realm":"shared","class":"function","name":"entIndex","description":" Returns the EntIndex of the entity"},"setFlexWeight":{"path":"libs_sh/entities.lua#L1502","realm":"shared","params":[{"type":"number","value":"number flexid The id of the flex","name":"flexid","description":"The id of the flex"},{"type":"number","value":"number weight The weight of the flex","name":"weight","description":"The weight of the flex"}],"class":"function","name":"setFlexWeight","description":" Sets the weight (value) of a flex."},"isWeldedTo":{"path":"libs_sv/entities.lua#L887","returns":[{"type":"Entity","value":"Entity The first welded/parent entity","description":"The first welded/parent entity"}],"realm":"server","class":"function","name":"isWeldedTo","description":" Gets what the entity is welded to. If the entity is parented, returns the parent."},"isPlayerHolding":{"path":"libs_sv/entities.lua#L749","returns":[{"type":"boolean","value":"boolean If the entity is being held or not","description":"If the entity is being held or not"}],"realm":"server","class":"function","name":"isPlayerHolding","description":" Returns true if the entity is being held by a player. Either by Physics gun, Gravity gun or Use-key."},"setNoDraw":{"path":"libs_sh/entities.lua#L447","realm":"shared","params":[{"type":"boolean","value":"boolean draw Whether to draw the entity or not.","name":"draw","description":"Whether to draw the entity or not."}],"class":"function","name":"setNoDraw","description":" Sets the whether an entity should be drawn or not. If serverside, will also prevent networking the entity to the client. Don't use serverside on a starfall if you want its client code to work."},"getAttachments":{"path":"libs_sh/entities.lua#L705","returns":[{"type":"table?","value":"table? Table of attachment id and attachment name or nil","description":"Table of attachment id and attachment name or nil"}],"realm":"shared","class":"function","name":"getAttachments","description":" Returns a table of attachments"},"getVar":{"path":"libs_sv/entities.lua#L1085","returns":[{"type":"any","value":"any The variable.","description":"The variable."}],"realm":"server","params":[{"type":"string","value":"string key The variable's key.","name":"key","description":"The variable's key."}],"class":"function","name":"getVar","description":" Returns a variable from the entity's internal glua table."},"manipulateBoneAngles":{"path":"libs_sh/entities.lua#L142","realm":"client","params":[{"type":"number","value":"number bone The bone ID","name":"bone","description":"The bone ID"},{"type":"Angle","value":"Angle ang The angle it should be manipulated to","name":"ang","description":"The angle it should be manipulated to"}],"class":"function","name":"manipulateBoneAngles","description":" Allows manipulation of an entity's bones' angles"},"getNoDraw":{"path":"libs_sh/entities.lua#L457","returns":[{"type":"boolean","value":"boolean True if should draw, False otherwise","description":"True if should draw, False otherwise"}],"realm":"shared","class":"function","name":"getNoDraw","description":" Checks whether the entity should be drawn"},"setRenderBounds":{"path":"libs_sh/entities.lua#L232","realm":"client","params":[{"type":"Vector","value":"Vector mins The lower bounding corner coordinate local to the hologram","name":"mins","description":"The lower bounding corner coordinate local to the hologram"},{"type":"Vector","value":"Vector maxs The upper bounding corner coordinate local to the hologram","name":"maxs","description":"The upper bounding corner coordinate local to the hologram"}],"class":"function","name":"setRenderBounds","description":" Sets a hologram or custom_prop's renderbounds"},"applyDamage":{"path":"libs_sv/entities.lua#L261","realm":"server","params":[{"type":"number","value":"number amt Damage amount","name":"amt","description":"Damage amount"},{"type":"Entity?","value":"Entity? attacker Damage attacker. Defaults to chip owner","name":"attacker","description":"Damage attacker. Defaults to chip owner"},{"type":"Entity?","value":"Entity? inflictor Damage inflictor","name":"inflictor","description":"Damage inflictor"},{"type":"number?","value":"number? dmgtype The damage type number enum","name":"dmgtype","description":"The damage type number enum"},{"type":"Vector?","value":"Vector? pos The position of the damage","name":"pos","description":"The position of the damage"}],"class":"function","name":"applyDamage","description":" Applies damage to an entity"},"getAngleVelocity":{"path":"libs_sh/entities.lua#L1274","returns":[{"type":"Vector","value":"Vector The angular velocity as a vector","description":"The angular velocity as a vector"}],"realm":"shared","class":"function","name":"getAngleVelocity","description":" Returns the angular velocity of the entity"},"getQuotaAverage":{"path":"libs_sh/entities.lua#L931","returns":[{"type":"number","value":"number Average CPU Time of the buffer of the specified starfall or expression2.","description":"Average CPU Time of the buffer of the specified starfall or expression2."}],"realm":"shared","class":"function","name":"getQuotaAverage","description":" Gets the Average CPU Time in the buffer of the specified starfall or expression2."},"setAngles":{"path":"libs_sv/entities.lua#L556","realm":"server","params":[{"type":"Angle","value":"Angle ang New angles","name":"ang","description":"New angles"}],"class":"function","name":"setAngles","description":" Sets the entity's angles"},"isValidPhys":{"path":"libs_sv/entities.lua#L741","returns":[{"type":"boolean","value":"boolean If entity has physics","description":"If entity has physics"}],"realm":"server","class":"function","name":"isValidPhys","description":" Checks whether entity has physics"},"getBodygroup":{"path":"libs_sh/entities.lua#L536","returns":[{"type":"number","value":"number The bodygroup value","description":"The bodygroup value"}],"realm":"shared","params":[{"type":"number","value":"number id The bodygroup's number index","name":"id","description":"The bodygroup's number index"}],"class":"function","name":"getBodygroup","description":" Returns the bodygroup value of the entity with given index"},"isDoor":{"path":"libs_sh/darkrp2.lua#L844","returns":[{"type":"boolean","value":"boolean Whether it's a door.","description":"Whether it's a door."}],"realm":"shared","class":"function","name":"isDoor","description":" Get whether this entity is considered a door by DarkRP."},"setSkin":{"path":"libs_sh/entities.lua#L582","realm":"shared","params":[{"type":"number","value":"number skinIndex Index of the skin to use.","name":"skinIndex","description":"Index of the skin to use."}],"class":"function","name":"setSkin","description":" Sets the skin of the entity"},"getSkinCount":{"path":"libs_sh/entities.lua#L605","returns":[{"type":"number","value":"number The amount of skins","description":"The amount of skins"}],"realm":"shared","class":"function","name":"getSkinCount","description":" Returns the amount of skins of the entity"},"setRenderMode":{"path":"libs_sh/entities.lua#L612","realm":"shared","params":[{"type":"number","value":"number rendermode Rendermode to use. http://wiki.facepunch.com/gmod/Enums/RENDERMODE","name":"rendermode","description":"Rendermode to use. http://wiki.facepunch.com/gmod/Enums/RENDERMODE"}],"class":"function","name":"setRenderMode","description":" Sets the render mode of the entity"},"getQuotaMax":{"path":"libs_sh/entities.lua#L945","returns":[{"type":"number","value":"number Max SysTime allowed to take for execution of the chip in a Think.","description":"Max SysTime allowed to take for execution of the chip in a Think."}],"realm":"shared","class":"function","name":"getQuotaMax","description":" Gets the CPU Time max of the specified starfall of the specified starfall or expression2.\n CPU Time is stored in a buffer of N elements, if the average of this exceeds quotaMax, the chip will error."},"lookupBone":{"path":"libs_sh/entities.lua#L1051","returns":[{"type":"number","value":"number The bone index","description":"The bone index"}],"realm":"shared","params":[{"type":"string","value":"string name The bone's string name","name":"name","description":"The bone's string name"}],"class":"function","name":"lookupBone","description":" Returns the ragdoll bone index given a bone name"},"enableDrag":{"path":"libs_sv/entities.lua#L778","realm":"server","params":[{"type":"boolean","value":"boolean drag Should the entity have air resistance?","name":"drag","description":"Should the entity have air resistance?"}],"class":"function","name":"enableDrag","description":" Sets the entity drag state"},"getAttachment":{"path":"libs_sh/entities.lua#L693","returns":[{"type":"Vector?","value":"Vector? Position, nil if the attachment doesn't exist","description":"Position, nil if the attachment doesn't exist"},{"type":"Angle?","value":"Angle? Orientation, nil if the attachment doesn't exist","description":"Orientation, nil if the attachment doesn't exist"}],"realm":"shared","params":[{"type":"number","value":"number index The index of the attachment","name":"index","description":"The index of the attachment"}],"class":"function","name":"getAttachment","description":" Gets the position and angle of an attachment"},"manipulateBonePosition":{"path":"libs_sh/entities.lua#L110","realm":"client","params":[{"type":"number","value":"number bone The bone ID","name":"bone","description":"The bone ID"},{"type":"Vector","value":"Vector vec The position it should be manipulated to","name":"vec","description":"The position it should be manipulated to"}],"class":"function","name":"manipulateBonePosition","description":" Allows manipulation of an entity's bones' positions"},"isPlayer":{"path":"libs_sh/entities.lua#L856","returns":[{"type":"boolean","value":"boolean True if player, false if not","description":"True if player, false if not"}],"realm":"shared","class":"function","name":"isPlayer","description":" Checks if an entity is a player."},"getSubMaterial":{"path":"libs_sh/entities.lua#L1625","returns":[{"type":"string","value":"string String material","description":"String material"}],"realm":"shared","params":[{"type":"number","value":"number index Number index of the sub material","name":"index","description":"Number index of the sub material"}],"class":"function","name":"getSubMaterial","description":" Gets an entities' submaterial"}},"class":"type","name":"Entity","description":" Entity type"},"Constraint":{"path":"libs_sv/constraint.lua#L27","libtbl":["constr_methods","constr_meta"],"realm":"server","methods":{"remove":{"path":"libs_sv/constraint.lua#L71","realm":"server","class":"function","name":"remove","description":" Removes the constraint"},"__tostring":{"path":"libs_sv/constraint.lua#L56","returns":[{"type":"string","value":"string String representation of the constraint","description":"String representation of the constraint"}],"realm":"server","class":"function","name":"__tostring","description":" Gets the string representation of the constraint"},"isValid":{"path":"libs_sv/constraint.lua#L85","returns":[{"type":"boolean","value":"boolean True if valid, false if not","description":"True if valid, false if not"}],"realm":"server","class":"function","name":"isValid","description":" Returns whether the constraint is valid or not"}},"class":"type","name":"Constraint","description":" A constraint entity returned by constraint functions"},"ParticleEffect":{"path":"libs_cl/particle_effect.lua#L17","libtbl":["particleef_methods"],"realm":"client","methods":{"setSortOrigin":{"path":"libs_cl/particle_effect.lua#L159","realm":"client","params":[{"type":"Vector","value":"Vector origin Sort Origin","name":"origin","description":"Sort Origin"}],"class":"function","name":"setSortOrigin","description":" Sets the sort origin for given particle effect system. This is used as a helper to determine which particles are in front of which."},"restart":{"path":"libs_cl/particle_effect.lua#L136","realm":"client","class":"function","name":"restart","description":" Restarts emission of the particle effect."},"stopEmission":{"path":"libs_cl/particle_effect.lua#L114","realm":"client","class":"function","name":"stopEmission","description":" Stops emission of the particle effect."},"setControlPointEntity":{"path":"libs_cl/particle_effect.lua#L184","realm":"client","params":[{"type":"number","value":"number id Child Control Point ID (0-63)","name":"id","description":"Child Control Point ID (0-63)"},{"type":"Entity","value":"Entity entity Entity parent","name":"entity","description":"Entity parent"}],"class":"function","name":"setControlPointEntity","description":" Essentially makes child control point follow the parent entity."},"isFinished":{"path":"libs_cl/particle_effect.lua#L146","returns":[{"type":"boolean","value":"boolean If the particle effect is finished","description":"If the particle effect is finished"}],"realm":"client","class":"function","name":"isFinished","description":" Returns if the particle effect is finished"},"setControlPointParent":{"path":"libs_cl/particle_effect.lua#L241","realm":"client","params":[{"type":"number","value":"number id Child Control Point ID (0-63)","name":"id","description":"Child Control Point ID (0-63)"},{"type":"number","value":"number parentid Parent control point ID (0-63)","name":"parentid","description":"Parent control point ID (0-63)"}],"class":"function","name":"setControlPointParent","description":" Sets the parent for given control point."},"setControlPoint":{"path":"libs_cl/particle_effect.lua#L170","realm":"client","params":[{"type":"number","value":"number id Control Point ID (0-63)","name":"id","description":"Control Point ID (0-63)"},{"type":"Vector","value":"Vector value Value","name":"value","description":"Value"}],"class":"function","name":"setControlPoint","description":" Sets a value for given control point."},"setUpVector":{"path":"libs_cl/particle_effect.lua#L226","realm":"client","params":[{"type":"number","value":"number id Control Point ID (0-63)","name":"id","description":"Control Point ID (0-63)"},{"type":"Vector","value":"Vector up Up vector","name":"up","description":"Up vector"}],"class":"function","name":"setUpVector","description":" Sets the up direction for given control point."},"destroy":{"path":"libs_cl/particle_effect.lua#L123","realm":"client","class":"function","name":"destroy","description":" Stops emission of the particle effect and destroys the object."},"setForwardVector":{"path":"libs_cl/particle_effect.lua#L199","realm":"client","params":[{"type":"number","value":"number id Control Point ID (0-63)","name":"id","description":"Control Point ID (0-63)"},{"type":"Vector","value":"Vector fwd Forward vector","name":"fwd","description":"Forward vector"}],"class":"function","name":"setForwardVector","description":" Sets the forward direction for given control point."},"startEmission":{"path":"libs_cl/particle_effect.lua#L104","realm":"client","class":"function","name":"startEmission","description":" Starts emission of the particle effect."},"setRightVector":{"path":"libs_cl/particle_effect.lua#L212","realm":"client","params":[{"type":"number","value":"number id Control Point ID (0-63)","name":"id","description":"Control Point ID (0-63)"},{"type":"Vector","value":"Vector right Right vector","name":"right","description":"Right vector"}],"class":"function","name":"setRightVector","description":" Sets the right direction for given control point."},"isValid":{"path":"libs_cl/particle_effect.lua#L96","returns":[{"type":"boolean","value":"boolean Is valid or not","description":"Is valid or not"}],"realm":"client","class":"function","name":"isValid","description":" Gets if the particle effect is valid or not."}},"class":"type","name":"ParticleEffect","description":" ParticleEffect type"},"ParticleEmitter":{"path":"libs_cl/particle.lua#L19","libtbl":["particleem_methods"],"realm":"client","methods":{"setBBox":{"path":"libs_cl/particle.lua#L154","realm":"client","params":[{"type":"Vector","value":"Vector mins Min vector","name":"mins","description":"Min vector"},{"type":"Vector","value":"Vector maxs Max vector","name":"maxs","description":"Max vector"}],"class":"function","name":"setBBox","description":" Sets the bounding box for this emitter. Usually the bounding box is automatically determined by the particles, but this function overrides it."},"is3D":{"path":"libs_cl/particle.lua#L142","returns":[{"type":"boolean","value":"boolean If it's 3D","description":"If it's 3D"}],"realm":"client","class":"function","name":"is3D","description":" Returns whether this emitter is 3D or not. This is set when creating the emitter with ParticleEmitter."},"getPos":{"path":"libs_cl/particle.lua#L136","returns":[{"type":"Vector","value":"Vector Position of the Emitter","description":"Position of the Emitter"}],"realm":"client","class":"function","name":"getPos","description":" Returns the position of this emitter. This is set when creating the emitter with ParticleEmitter."},"setPos":{"path":"libs_cl/particle.lua#L186","realm":"client","params":[{"type":"Vector","value":"Vector position The position","name":"position","description":"The position"}],"class":"function","name":"setPos","description":" Sets the position of the particle emitter."},"getParticlesLeft":{"path":"libs_cl/particle.lua#L130","returns":[{"type":"number","value":"number Number of particles left","description":"Number of particles left"}],"realm":"client","class":"function","name":"getParticlesLeft","description":" Returns number of particles left able to be created from the emitter"},"setParticleCullRadius":{"path":"libs_cl/particle.lua#L177","realm":"client","params":[{"type":"number","value":"number radius Particle radius","name":"radius","description":"Particle radius"}],"class":"function","name":"setParticleCullRadius","description":" The function name has not much in common with its actual function.\n It applies a radius to every particles that affects the building of the bounding box, as it usually is constructed by the particle that has the lowest x, y and z and the highest x, y and z.\n This function just adds/subtracts the radius and inflates the bounding box."},"draw":{"path":"libs_cl/particle.lua#L110","realm":"client","class":"function","name":"draw","description":" Manually renders all particles the emitter has created."},"setNoDraw":{"path":"libs_cl/particle.lua#L170","realm":"client","params":[{"type":"boolean","value":"boolean noDraw Whether not to draw","name":"noDraw","description":"Whether not to draw"}],"class":"function","name":"setNoDraw","description":" Prevents all particles of the emitter from automatically drawing. They can be manually drawn with draw()"},"destroy":{"path":"libs_cl/particle.lua#L116","realm":"client","class":"function","name":"destroy","description":" Removes the emitter, making it no longer usable from Lua. If particles remain, the emitter will be removed when all particles die."},"getNumActiveParticles":{"path":"libs_cl/particle.lua#L124","returns":[{"type":"number","value":"number Number of active particles","description":"Number of active particles"}],"realm":"client","class":"function","name":"getNumActiveParticles","description":" Returns the amount of active particles of this emitter."},"add":{"path":"libs_cl/particle.lua#L70","returns":[{"type":"Particle","value":"Particle A Particle object","description":"A Particle object"}],"realm":"client","params":[{"type":"Material","value":"Material material The material object to set the particle","name":"material","description":"The material object to set the particle"},{"type":"Vector","value":"Vector position The position to create the particle","name":"position","description":"The position to create the particle"},{"type":"number","value":"number startSize Sets the initial size value of the particle.","name":"startSize","description":"Sets the initial size value of the particle."},{"type":"number","value":"number endSize Sets the size of the particle that it will reach when it dies.","name":"endSize","description":"Sets the size of the particle that it will reach when it dies."},{"type":"number","value":"number startLength Sets the initial length value of the particle.","name":"startLength","description":"Sets the initial length value of the particle."},{"type":"number","value":"number endLength Sets the length of the particle that it will reach when it dies.","name":"endLength","description":"Sets the length of the particle that it will reach when it dies."},{"type":"number","value":"number startAlpha Sets the initial alpha value of the particle.","name":"startAlpha","description":"Sets the initial alpha value of the particle."},{"type":"number","value":"number endAlpha Sets the alpha value of the particle that it will reach when it dies.","name":"endAlpha","description":"Sets the alpha value of the particle that it will reach when it dies."},{"type":"number","value":"number dieTime Sets the time where the particle will be removed. (0-60)","name":"dieTime","description":"Sets the time where the particle will be removed. (0-60)"}],"class":"function","name":"add","description":" Creates a new Particle with the given material and position."},"setNearClip":{"path":"libs_cl/particle.lua#L161","realm":"client","params":[{"type":"number","value":"number distanceMin","name":"distanceMin","description":""},{"type":"number","value":"number distanceMax","name":"distanceMax","description":""}],"class":"function","name":"setNearClip","description":" This function sets the the distance between the render camera and the emitter at which the particles should start fading and at which distance fade ends ( alpha becomes 0 )."},"isValid":{"path":"libs_cl/particle.lua#L148","returns":[{"type":"boolean","value":"boolean If it's valid","description":"If it's valid"}],"realm":"client","class":"function","name":"isValid","description":" Returns whether this object is valid or not."}},"class":"type","name":"ParticleEmitter","description":" ParticleEmitter type"},"StringStream":{"path":"libs_sh/bit.lua#L11","libtbl":["ss_methods"],"realm":"shared","methods":{"writeInt32":{"path":"libs_sh/bit.lua#L474","realm":"shared","params":[{"type":"number","value":"number x Int32 to write","name":"x","description":"Int32 to write"}],"class":"function","name":"writeInt32","description":" Writes an int to the buffer and advances the buffer pointer."},"writeEntity":{"path":"libs_sh/bit.lua#L520","realm":"shared","params":[{"type":"Entity","value":"Entity e The entity to be written","name":"e","description":"The entity to be written"}],"class":"function","name":"writeEntity","description":" Writes an entity to the buffer and advances the buffer pointer."},"readUInt32":{"path":"libs_sh/bit.lua#L349","returns":[{"type":"number","value":"number UInt32 at this position","description":"UInt32 at this position"}],"realm":"shared","class":"function","name":"readUInt32","description":" Reads an unsigned 32 bit (four byte) integer from the byte stream and advances the buffer pointer."},"readUInt16":{"path":"libs_sh/bit.lua#L338","returns":[{"type":"number","value":"number UInt16 at this position","description":"UInt16 at this position"}],"realm":"shared","class":"function","name":"readUInt16","description":" Reads an unsigned 16 bit (two byte) integer from the byte stream and advances the buffer pointer."},"read":{"path":"libs_sh/bit.lua#L224","returns":[{"type":"string","value":"string A string containing the bytes","description":"A string containing the bytes"}],"realm":"shared","params":[{"type":"number","value":"number length How many bytes to read","name":"length","description":"How many bytes to read"}],"class":"function","name":"read","description":" Reads the specified number of bytes from the buffer and advances the buffer pointer."},"writeFloat":{"path":"libs_sh/bit.lua#L493","realm":"shared","params":[{"type":"number","value":"number x The float to write","name":"x","description":"The float to write"}],"class":"function","name":"writeFloat","description":" Writes a 4 byte IEEE754 float to the byte stream and advances the buffer pointer."},"seek":{"path":"libs_sh/bit.lua#L254","realm":"shared","params":[{"type":"number","value":"number pos Position to seek to","name":"pos","description":"Position to seek to"}],"class":"function","name":"seek","description":" Sets internal pointer to pos. The position will be clamped to [1, buffersize+1]"},"getString":{"path":"libs_sh/bit.lua#L549","returns":[{"type":"string","value":"string The buffer as a string","description":"The buffer as a string"}],"realm":"shared","class":"function","name":"getString","description":" Returns the buffer as a string"},"readEntity":{"path":"libs_sh/bit.lua#L530","returns":[{"type":"Entity","value":"Entity The entity that was read","description":"The entity that was read"}],"realm":"shared","params":[{"type":"function?","value":"function? callback (Client only) optional callback to be ran whenever the entity becomes valid; returns nothing if this is used. The callback passes the entity if it succeeds or nil if it fails.","name":"callback","description":"(Client only) optional callback to be ran whenever the entity becomes valid; returns nothing if this is used. The callback passes the entity if it succeeds or nil if it fails."}],"class":"function","name":"readEntity","description":" Reads an entity from the byte stream and advances the buffer pointer."},"writeDouble":{"path":"libs_sh/bit.lua#L503","realm":"shared","params":[{"type":"number","value":"number x The double to write","name":"x","description":"The double to write"}],"class":"function","name":"writeDouble","description":" Writes a 8 byte IEEE754 double to the byte stream and advances the buffer pointer."},"tell":{"path":"libs_sh/bit.lua#L309","returns":[{"type":"number","value":"number The buffer position","description":"The buffer position"}],"realm":"shared","class":"function","name":"tell","description":" Returns the internal position of the byte reader."},"writeUInt32":{"path":"libs_sh/bit.lua#L487","realm":"shared","params":[{"type":"number","value":"number x UInt32 to write","name":"x","description":"UInt32 to write"}],"class":"function","name":"writeUInt32","description":" Writes a unsigned long to the buffer and advances the buffer pointer."},"readInt8":{"path":"libs_sh/bit.lua#L360","returns":[{"type":"number","value":"number Int8 at this position","description":"Int8 at this position"}],"realm":"shared","class":"function","name":"readInt8","description":" Reads a signed 8-bit (one byte) integer from the byte stream and advances the buffer pointer."},"readFloat":{"path":"libs_sh/bit.lua#L384","returns":[{"type":"number","value":"number Float32 at this position","description":"Float32 at this position"}],"realm":"shared","class":"function","name":"readFloat","description":" Reads a 4 byte IEEE754 float from the byte stream and advances the buffer pointer."},"readInt16":{"path":"libs_sh/bit.lua#L368","returns":[{"type":"number","value":"number Int16 at this position","description":"Int16 at this position"}],"realm":"shared","class":"function","name":"readInt16","description":" Reads a signed 16-bit (two byte) integer from the byte stream and advances the buffer pointer."},"setEndian":{"path":"libs_sh/bit.lua#L179","realm":"shared","params":[{"type":"string","value":"string endian The endianness of number types. \"big\" or \"little\" (default \"little\")","name":"endian","description":"The endianness of number types. \"big\" or \"little\" (default \"little\")"}],"class":"function","name":"setEndian","description":" Sets the endianness of the string stream"},"writeUInt8":{"path":"libs_sh/bit.lua#L449","realm":"shared","params":[{"type":"number","value":"number x UInt8 to write","name":"x","description":"UInt8 to write"}],"class":"function","name":"writeUInt8","description":" Writes a unsigned byte to the buffer and advances the buffer pointer."},"readUInt8":{"path":"libs_sh/bit.lua#L329","returns":[{"type":"number","value":"number UInt8 at this position","description":"UInt8 at this position"}],"realm":"shared","class":"function","name":"readUInt8","description":" Reads an unsigned 8-bit (one byte) integer from the byte stream and advances the buffer pointer."},"writeInt16":{"path":"libs_sh/bit.lua#L455","realm":"shared","params":[{"type":"number","value":"number x Int16 to write","name":"x","description":"Int16 to write"}],"class":"function","name":"writeInt16","description":" Writes a short to the buffer and advances the buffer pointer."},"writeInt8":{"path":"libs_sh/bit.lua#L441","realm":"shared","params":[{"type":"number","value":"number x Int8 to write","name":"x","description":"Int8 to write"}],"class":"function","name":"writeInt8","description":" Writes a byte to the buffer and advances the buffer pointer."},"readString":{"path":"libs_sh/bit.lua#L434","returns":[{"type":"string","value":"string The string of bytes read","description":"The string of bytes read"}],"realm":"shared","class":"function","name":"readString","description":" Returns a null terminated string, reads until \"\\x00\" and advances the buffer pointer."},"size":{"path":"libs_sh/bit.lua#L319","returns":[{"type":"number","value":"number The buffer size","description":"The buffer size"}],"realm":"shared","class":"function","name":"size","description":" Tells the size of the byte stream."},"readDouble":{"path":"libs_sh/bit.lua#L394","returns":[{"type":"number","value":"number Double at this position","description":"Double at this position"}],"realm":"shared","class":"function","name":"readDouble","description":" Reads a 8 byte IEEE754 double from the byte stream and advances the buffer pointer."},"readInt32":{"path":"libs_sh/bit.lua#L376","returns":[{"type":"number","value":"number Int32 at this position","description":"Int32 at this position"}],"realm":"shared","class":"function","name":"readInt32","description":" Reads a signed 32-bit (four byte) integer from the byte stream and advances the buffer pointer."},"skip":{"path":"libs_sh/bit.lua#L272","realm":"shared","params":[{"type":"number","value":"number length The offset","name":"length","description":"The offset"}],"class":"function","name":"skip","description":" Move the internal pointer by amount i"},"writeString":{"path":"libs_sh/bit.lua#L513","realm":"shared","params":[{"type":"string","value":"string str The string of bytes to write","name":"str","description":"The string of bytes to write"}],"class":"function","name":"writeString","description":" Writes a string to the buffer putting a null at the end and advances the buffer pointer."},"readUntil":{"path":"libs_sh/bit.lua#L404","returns":[{"type":"string","value":"string The string of bytes read","description":"The string of bytes read"}],"realm":"shared","params":[{"type":"number","value":"number byte The byte to read until (in number form)","name":"byte","description":"The byte to read until (in number form)"}],"class":"function","name":"readUntil","description":" Reads until the given byte and advances the buffer pointer."},"write":{"path":"libs_sh/bit.lua#L191","realm":"shared","params":[{"type":"string","value":"string data A string of data to write","name":"data","description":"A string of data to write"}],"class":"function","name":"write","description":" Writes the given string and advances the buffer pointer."},"writeUInt16":{"path":"libs_sh/bit.lua#L468","realm":"shared","params":[{"type":"number","value":"number x UInt16 to write","name":"x","description":"UInt16 to write"}],"class":"function","name":"writeUInt16","description":" Writes a unsigned short to the buffer and advances the buffer pointer."}},"class":"type","name":"StringStream","description":" StringStream type"},"Mesh":{"path":"libs_sh/mesh.lua#L679","libtbl":["mesh_methods"],"realm":"client","methods":{"destroy":{"path":"libs_sh/mesh.lua#L1133","realm":"client","class":"function","name":"destroy","description":" Frees the mesh from memory"},"draw":{"path":"libs_sh/mesh.lua#L1122","realm":"client","class":"function","name":"draw","description":" Draws the mesh. Must be in a 3D rendering context."}},"class":"type","name":"Mesh","description":" Mesh type"},"Sound":{"path":"libs_sh/sound.lua#L25","libtbl":["sound_methods"],"realm":"shared","methods":{"stop":{"path":"libs_sh/sound.lua#L134","realm":"shared","params":[{"type":"number?","value":"number? fade Time in seconds to fade out, if nil or 0 the sound stops instantly.","name":"fade","description":"Time in seconds to fade out, if nil or 0 the sound stops instantly."}],"class":"function","name":"stop","description":" Stops the sound from being played."},"setPitch":{"path":"libs_sh/sound.lua#L170","realm":"shared","params":[{"type":"number","value":"number pitch Pitch to set to, between 0 and 255.","name":"pitch","description":"Pitch to set to, between 0 and 255."},{"type":"number?","value":"number? fade Time in seconds to transition to this new pitch. Default 0","name":"fade","description":"Time in seconds to transition to this new pitch. Default 0"}],"class":"function","name":"setPitch","description":" Sets the pitch of the sound. Won't work unless the sound is playing."},"setDSP":{"path":"libs_sh/sound.lua#L206","realm":"shared","params":[{"type":"number","value":"number dsp (0 - 133) DSP values. List can be found here https://developer.valvesoftware.com/wiki/Dsp_presets","name":"dsp","description":"(0 - 133) DSP values. List can be found here https://developer.valvesoftware.com/wiki/Dsp_presets"}],"class":"function","name":"setDSP","description":" Sets the sound dsp value"},"setSoundLevel":{"path":"libs_sh/sound.lua#L193","realm":"shared","params":[{"type":"number","value":"number level dB level, for information on the value to use see https://developer.valvesoftware.com/wiki/Soundscripts#SoundLevel","name":"level","description":"dB level, for information on the value to use see https://developer.valvesoftware.com/wiki/Soundscripts#SoundLevel"}],"class":"function","name":"setSoundLevel","description":" Sets the sound level in dB. Won't work if the sound is already playing."},"isPlaying":{"path":"libs_sh/sound.lua#L187","returns":[{"type":"boolean","value":"boolean Whether the sound is playing or not","description":"Whether the sound is playing or not"}],"realm":"shared","class":"function","name":"isPlaying","description":" Returns whether the sound is being played."},"getSoundLevel":{"path":"libs_sh/sound.lua#L200","returns":[{"type":"number","value":"number Level in dB","description":"Level in dB"}],"realm":"shared","class":"function","name":"getSoundLevel","description":" Returns the current sound level in dB."},"getDSP":{"path":"libs_sh/sound.lua#L213","returns":[{"type":"number","value":"number (0 - 133) DSP value.","description":"(0 - 133) DSP value."}],"realm":"shared","class":"function","name":"getDSP","description":" Gets the sound dsp value"},"play":{"path":"libs_sh/sound.lua#L129","realm":"shared","class":"function","name":"play","description":" Starts to play the sound."},"destroy":{"path":"libs_sh/sound.lua#L145","realm":"shared","class":"function","name":"destroy","description":" Removes the sound from the game so new one can be created if limit is reached"},"setVolume":{"path":"libs_sh/sound.lua#L153","realm":"shared","params":[{"type":"number","value":"number vol Volume to set to, between 0 and 1.","name":"vol","description":"Volume to set to, between 0 and 1."},{"type":"number?","value":"number? fade Time in seconds to transition to this new volume. Default 0","name":"fade","description":"Time in seconds to transition to this new volume. Default 0"}],"class":"function","name":"setVolume","description":" Sets the volume of the sound. Won't work unless the sound is playing."}},"class":"type","name":"Sound","description":" Sound type"},"Npc":{"path":"libs_sh/npc.lua#L13","libtbl":["npc_methods","npc_meta"],"realm":"shared","methods":{"stop":{"path":"libs_sh/npc.lua#L121","realm":"server","class":"function","name":"stop","description":" Stops the npc"},"goRun":{"path":"libs_sh/npc.lua#L155","realm":"server","params":[{"type":"Vector","value":"Vector vec The position of the destination","name":"vec","description":"The position of the destination"}],"class":"function","name":"goRun","description":" Makes the npc run to a destination"},"getEnemy":{"path":"libs_sh/npc.lua#L114","returns":[{"type":"Entity","value":"Entity Entity the npc is fighting","description":"Entity the npc is fighting"}],"realm":"server","class":"function","name":"getEnemy","description":" Gets what the npc is fighting"},"addRelationship":{"path":"libs_sh/npc.lua#L44","realm":"server","params":[{"type":"string","value":"string str The relationship string. http://wiki.facepunch.com/gmod/NPC:AddRelationship","name":"str","description":"The relationship string. http://wiki.facepunch.com/gmod/NPC:AddRelationship"}],"class":"function","name":"addRelationship","description":" Adds a relationship to the npc"},"giveWeapon":{"path":"libs_sh/npc.lua#L87","realm":"server","params":[{"type":"string","value":"string wep The classname of the weapon","name":"wep","description":"The classname of the weapon"}],"class":"function","name":"giveWeapon","description":" Gives the npc a weapon"},"attackMelee":{"path":"libs_sh/npc.lua#L129","realm":"server","class":"function","name":"attackMelee","description":" Makes the npc do a melee attack"},"goWalk":{"path":"libs_sh/npc.lua#L145","realm":"server","params":[{"type":"Vector","value":"Vector vec The position of the destination","name":"vec","description":"The position of the destination"}],"class":"function","name":"goWalk","description":" Makes the npc walk to a destination"},"attackRange":{"path":"libs_sh/npc.lua#L137","realm":"server","class":"function","name":"attackRange","description":" Makes the npc do a ranged attack"},"getRelationship":{"path":"libs_sh/npc.lua#L79","returns":[{"type":"string","value":"string Relationship of the npc with the target","description":"Relationship of the npc with the target"}],"realm":"server","params":[{"type":"Entity","value":"Entity ent Target entity","name":"ent","description":"Target entity"}],"class":"function","name":"getRelationship","description":" Gets the npc's relationship to the target"},"addEntityRelationship":{"path":"libs_sh/npc.lua#L65","realm":"server","params":[{"type":"Entity","value":"Entity ent The target entity","name":"ent","description":"The target entity"},{"type":"string","value":"string disp String of the relationship. (\"hate\", \"fear\", \"like\", \"neutral\")","name":"disp","description":"String of the relationship. (\"hate\", \"fear\", \"like\", \"neutral\")"},{"type":"number","value":"number priority How strong the relationship is. Higher number is stronger","name":"priority","description":"How strong the relationship is. Higher number is stronger"}],"class":"function","name":"addEntityRelationship","description":" Adds a relationship to the npc with an entity"},"setEnemy":{"path":"libs_sh/npc.lua#L105","realm":"server","params":[{"type":"Entity","value":"Entity ent Target entity","name":"ent","description":"Target entity"}],"class":"function","name":"setEnemy","description":" Tell the npc to fight this"}},"class":"type","name":"Npc","description":" Npc type"},"Color":{"path":"libs_sh/color.lua#L36","methods":{"setB":{"path":"libs_sh/color.lua#L261","returns":[{"type":"Color","value":"Color Color after modification","description":"Color after modification"}],"realm":"shared","params":[{"type":"number","value":"number b The blue","name":"b","description":"The blue"}],"class":"function","name":"setB","description":" Set's the color's blue and returns self."},"__mul":{"path":"libs_sh/color.lua#L155","returns":[{"type":"Color","value":"Color Multiplied color.","description":"Multiplied color."}],"realm":"shared","params":[{"type":"number|Color","value":"number|Color a Number or Color multiplicant","name":"a","description":"Number or Color multiplicant"},{"type":"number|Color","value":"number|Color b Number or Color multiplier","name":"b","description":"Number or Color multiplier"}],"class":"function","name":"__mul","description":" Multiplication metamethod"},"round":{"path":"libs_sh/color.lua#L219","realm":"shared","params":[{"type":"number?","value":"number? idp (Default 0) The integer decimal place to round to.","name":"idp","description":"(Default 0) The integer decimal place to round to."}],"class":"function","name":"round","description":" Round the color values.\n Self-Modifies. Does not return anything"},"__concat":{"path":"libs_sh/color.lua#L125","returns":[{"type":"string","value":"string Adds two colors into one string-representation","description":"Adds two colors into one string-representation"}],"realm":"shared","class":"function","name":"__concat","description":" Concatenation metamethod"},"__sub":{"path":"libs_sh/color.lua#L147","returns":[{"type":"Color","value":"Color Resultant color.","description":"Resultant color."}],"realm":"shared","params":[{"type":"Color","value":"Color c1 Initial color.","name":"c1","description":"Initial color."},{"type":"Color","value":"Color c2 Color to subtract.","name":"c2","description":"Color to subtract."}],"class":"function","name":"__sub","description":" Subtraction metamethod"},"__div":{"path":"libs_sh/color.lua#L173","returns":[{"type":"Color","value":"Color Scaled color.","description":"Scaled color."}],"realm":"shared","params":[{"type":"number|Color","value":"number|Color a Number or Color dividend","name":"a","description":"Number or Color dividend"},{"type":"number|Color","value":"number|Color b Number or Color divisor","name":"b","description":"Number or Color divisor"}],"class":"function","name":"__div","description":" Division metamethod"},"__index":{"path":"libs_sh/color.lua#L107","returns":[{"type":"number","value":"number Value at the index","description":"Value at the index"}],"realm":"shared","params":[{"type":"number|string","value":"number|string k Key. Number or string","name":"k","description":"Key. Number or string"}],"class":"function","name":"__index","description":" Gets a value at a key in the color"},"set":{"path":"libs_sh/color.lua#L235","realm":"shared","params":[{"type":"Color","value":"Color b The color to copy from.","name":"b","description":"The color to copy from."}],"class":"function","name":"set","description":" Copies r,g,b,a from color to another.\n Self-Modifies. Does not return anything"},"rgbToHSV":{"path":"libs_sh/color.lua#L191","returns":[{"type":"Color","value":"Color A triplet of numbers representing HSV.","description":"A triplet of numbers representing HSV."}],"realm":"shared","class":"function","name":"rgbToHSV","description":" Converts the color from RGB to HSV."},"setA":{"path":"libs_sh/color.lua#L269","returns":[{"type":"Color","value":"Color Color after modification","description":"Color after modification"}],"realm":"shared","params":[{"type":"number","value":"number a The alpha","name":"a","description":"The alpha"}],"class":"function","name":"setA","description":" Set's the color's alpha and returns it."},"setG":{"path":"libs_sh/color.lua#L253","returns":[{"type":"Color","value":"Color Color after modification","description":"Color after modification"}],"realm":"shared","params":[{"type":"number","value":"number g The green","name":"g","description":"The green"}],"class":"function","name":"setG","description":" Set's the color's green and returns self."},"__newindex":{"path":"libs_sh/color.lua#L96","realm":"shared","params":[{"type":"number|string","value":"number|string k Key. Number or string","name":"k","description":"Key. Number or string"},{"type":"number","value":"number v Value.","name":"v","description":"Value."}],"class":"function","name":"__newindex","description":" Sets a value at a key in the color"},"hsvToRGB":{"path":"libs_sh/color.lua#L199","returns":[{"type":"Color","value":"Color A triplet of numbers representing HSV.","description":"A triplet of numbers representing HSV."}],"realm":"shared","class":"function","name":"hsvToRGB","description":" Converts the color from HSV to RGB."},"__add":{"path":"libs_sh/color.lua#L139","returns":[{"type":"Color","value":"Color Resultant color.","description":"Resultant color."}],"realm":"shared","params":[{"type":"Color","value":"Color c1 Initial color.","name":"c1","description":"Initial color."},{"type":"Color","value":"Color c2 Color to add to the first.","name":"c2","description":"Color to add to the first."}],"class":"function","name":"__add","description":" Addition metamethod"},"__eq":{"path":"libs_sh/color.lua#L131","returns":[{"type":"boolean","value":"boolean Whether their fields are equal","description":"Whether their fields are equal"}],"realm":"shared","params":[{"type":"Color","value":"Color c1 Initial color.","name":"c1","description":"Initial color."},{"type":"Color","value":"Color c2 Color to check against.","name":"c2","description":"Color to check against."}],"class":"function","name":"__eq","description":" Equivalence metamethod"},"__tostring":{"path":"libs_sh/color.lua#L119","returns":[{"type":"string","value":"string String representation of the color","description":"String representation of the color"}],"realm":"shared","class":"function","name":"__tostring","description":" Turns the color into a string"},"toHex":{"path":"libs_sh/color.lua#L207","returns":[{"type":"string","value":"string String hexadecimal color","description":"String hexadecimal color"}],"realm":"shared","params":[{"type":"boolean?","value":"boolean? alpha Optional boolean whether to include the alpha channel, False by default","name":"alpha","description":"Optional boolean whether to include the alpha channel, False by default"}],"class":"function","name":"toHex","description":" Returns a hexadecimal string representation of the color"},"setR":{"path":"libs_sh/color.lua#L245","returns":[{"type":"Color","value":"Color Color after modification","description":"Color after modification"}],"realm":"shared","params":[{"type":"number","value":"number r The red","name":"r","description":"The red"}],"class":"function","name":"setR","description":" Set's the color's red channel and returns self."},"clone":{"path":"libs_sh/color.lua#L229","returns":[{"type":"Color","value":"Color The copy of the color","description":"The copy of the color"}],"realm":"shared","class":"function","name":"clone","description":" Copies r,g,b,a from color and returns a new color"}},"fields":[{"name":"r","description":"The 0-255 red value of the color. Can also be indexed with [1]"},{"name":"g","description":"The 0-255 green value of the color. Can also be indexed with [2]"},{"name":"b","description":"The 0-255 blue value of the color. Can also be indexed with [3]"},{"name":"a","description":"The 0-255 alpha value of the color. Can also be indexed with [4]"}],"realm":"shared","libtbl":["color_methods","color_meta"],"class":"type","name":"Color","description":" Color type"},"SurfaceInfo":{"path":"libs_sh/surfaceinfo.lua#L3","libtbl":["surfaceinfo_methods","surfaceinfo_meta"],"realm":"shared","methods":{"getMaterial":{"path":"libs_sh/surfaceinfo.lua#L25","returns":[{"type":"string|Material","value":"string|Material In SERVER, the material name, and in CLIENT, the Material object.","description":"In SERVER, the material name, and in CLIENT, the Material object."}],"realm":"shared","class":"function","name":"getMaterial","description":" Returns the brush surface's material."},"isWater":{"path":"libs_sh/surfaceinfo.lua#L68","returns":[{"type":"boolean","value":"boolean If the surface is water.","description":"If the surface is water."}],"realm":"shared","class":"function","name":"isWater","description":" Checks if the brush surface is water.\n This internally checks the SURFDRAW_WATER flag."},"getVertices":{"path":"libs_sh/surfaceinfo.lua#L39","returns":[{"type":"table","value":"table List of Vector points. This will usually be 4 corners of a quadrilateral in counter-clockwise order.","description":"List of Vector points. This will usually be 4 corners of a quadrilateral in counter-clockwise order."}],"realm":"shared","class":"function","name":"getVertices","description":" Returns a list of vertices the brush surface is built from."},"isNoDraw":{"path":"libs_sh/surfaceinfo.lua#L52","returns":[{"type":"boolean","value":"boolean If this surface won't be drawn.","description":"If this surface won't be drawn."}],"realm":"shared","class":"function","name":"isNoDraw","description":" Checks if the brush surface is a nodraw surface, meaning it will not be drawn by the engine.\n This internally checks the SURFDRAW_NODRAW flag."},"isSky":{"path":"libs_sh/surfaceinfo.lua#L60","returns":[{"type":"boolean","value":"boolean If the surface is the sky.","description":"If the surface is the sky."}],"realm":"shared","class":"function","name":"isSky","description":" Checks if the brush surface is displaying the skybox.\n This internally checks the SURFDRAW_SKY flag."}},"class":"type","name":"SurfaceInfo","description":" SurfaceInfo type"},"Wirelink":{"path":"libs_sv/wire.lua#L23","libtbl":["wirelink_methods","wirelink_meta"],"realm":"server","methods":{"inputValue":{"path":"libs_sv/wire.lua#L678","returns":[{"type":"any","value":"any Input value","description":"Input value"}],"realm":"server","params":[{"type":"string","value":"string name Input name","name":"name","description":"Input name"}],"class":"function","name":"inputValue","description":" Returns current state of the specified input"},"entity":{"path":"libs_sv/wire.lua#L706","returns":[{"type":"Entity","value":"Entity Entity the wirelink represents","description":"Entity the wirelink represents"}],"realm":"server","class":"function","name":"entity","description":" Returns the entity that the wirelink represents"},"getWiredToName":{"path":"libs_sv/wire.lua#L775","returns":[{"type":"string","value":"string String name of the output that the input is wired to.","description":"String name of the output that the input is wired to."}],"realm":"server","params":[{"type":"string","value":"string name Name of the input of the wirelink.","name":"name","description":"Name of the input of the wirelink."}],"class":"function","name":"getWiredToName","description":" Returns the name of the output an input of the wirelink is wired to."},"inputs":{"path":"libs_sv/wire.lua#L712","returns":[{"type":"table","value":"table All of the wirelink's inputs","description":"All of the wirelink's inputs"}],"realm":"server","class":"function","name":"inputs","description":" Returns a table of all of the wirelink's inputs"},"__newindex":{"path":"libs_sv/wire.lua#L655","realm":"server","params":[{"type":"any","value":"any key Key to set the value at","name":"key","description":"Key to set the value at"},{"type":"any","value":"any val Value to set at the index","name":"val","description":"Value to set at the index"}],"class":"function","name":"__newindex","description":" Writes to an input."},"inputType":{"path":"libs_sv/wire.lua#L688","returns":[{"type":"string","value":"string Type of input","description":"Type of input"}],"realm":"server","params":[{"type":"string","value":"string name Input name to search for","name":"name","description":"Input name to search for"}],"class":"function","name":"inputType","description":" Returns the type of input name, or nil if it doesn't exist"},"getWiredTo":{"path":"libs_sv/wire.lua#L763","returns":[{"type":"Entity","value":"Entity The entity the wirelink is wired to","description":"The entity the wirelink is wired to"}],"realm":"server","params":[{"type":"string","value":"string name Name of the input","name":"name","description":"Name of the input"}],"class":"function","name":"getWiredTo","description":" Returns what an input of the wirelink is wired to."},"outputType":{"path":"libs_sv/wire.lua#L697","returns":[{"type":"string","value":"string Type of output","description":"Type of output"}],"realm":"server","params":[{"type":"string","value":"string name Output name to search for","name":"name","description":"Output name to search for"}],"class":"function","name":"outputType","description":" Returns the type of output name, or nil if it doesn't exist"},"isWired":{"path":"libs_sv/wire.lua#L752","returns":[{"type":"boolean","value":"boolean Whether it is wired","description":"Whether it is wired"}],"realm":"server","params":[{"type":"string","value":"string name Name of the input to check","name":"name","description":"Name of the input to check"}],"class":"function","name":"isWired","description":" Checks if an input is wired."},"outputs":{"path":"libs_sv/wire.lua#L732","returns":[{"type":"table","value":"table All of the wirelink's outputs","description":"All of the wirelink's outputs"}],"realm":"server","class":"function","name":"outputs","description":" Returns a table of all of the wirelink's outputs"},"isValid":{"path":"libs_sv/wire.lua#L672","returns":[{"type":"boolean","value":"boolean Whether the wirelink is valid","description":"Whether the wirelink is valid"}],"realm":"server","class":"function","name":"isValid","description":" Checks if a wirelink is valid. (ie. doesn't point to an invalid entity)"},"__index":{"path":"libs_sv/wire.lua#L636","returns":[{"type":"any","value":"any Value at the index","description":"Value at the index"}],"realm":"server","params":[{"type":"any","value":"any Key to get the value at","name":"Key","description":"to get the value at"}],"class":"function","name":"__index","description":" Retrieves an output. Returns nil if the output doesn't exist."}},"class":"type","name":"Wirelink","description":" Wirelink type"},"Angle":{"path":"libs_sh/angles.lua#L5","methods":{"setZero":{"path":"libs_sh/angles.lua#L221","realm":"shared","class":"function","name":"setZero","description":" Sets p,y,r to 0. This is faster than doing it manually.\n Self-Modifies. Does not return anything"},"getQuaternion":{"path":"libs_sh/quaternion.lua#L835","returns":[{"type":"Quaternion","value":"Quaternion Constructed quaternion","description":"Constructed quaternion"}],"realm":"shared","class":"function","name":"getQuaternion","description":" Converts angle to a quaternion"},"__mul":{"path":"libs_sh/angles.lua#L85","returns":[{"type":"Angle","value":"Angle Resultant angle.","description":"Resultant angle."}],"realm":"shared","params":[{"type":"number|Angle","value":"number|Angle a1 Number or Angle multiplicand.","name":"a1","description":"Number or Angle multiplicand."},{"type":"number|Angle","value":"number|Angle a2 Number or Angle multiplier.","name":"a2","description":"Number or Angle multiplier."}],"class":"function","name":"__mul","description":" Multiplication metamethod"},"round":{"path":"libs_sh/angles.lua#L197","realm":"shared","params":[{"type":"number?","value":"number? idp (Default 0) The integer decimal place to round to.","name":"idp","description":"(Default 0) The integer decimal place to round to."}],"class":"function","name":"round","description":" Round the angle values.\n Self-Modifies. Does not return anything"},"rotateAroundAxis":{"path":"libs_sh/angles.lua#L175","returns":[{"type":"Angle","value":"Angle The modified angle","description":"The modified angle"}],"realm":"shared","params":[{"type":"Vector","value":"Vector v Vector axis","name":"v","description":"Vector axis"},{"type":"number?","value":"number? deg Number of degrees or nil if radians.","name":"deg","description":"Number of degrees or nil if radians."},{"type":"number?","value":"number? rad Number of radians or nil if degrees.","name":"rad","description":"Number of radians or nil if degrees."}],"class":"function","name":"rotateAroundAxis","description":" Return Rotated angle around the specified axis."},"__div":{"path":"libs_sh/angles.lua#L103","returns":[{"type":"Angle","value":"Angle Resultant angle.","description":"Resultant angle."}],"realm":"shared","params":[{"type":"number|Angle","value":"number|Angle a1 Number or Angle dividend.","name":"a1","description":"Number or Angle dividend."},{"type":"number|Angle","value":"number|Angle a2 Number or Angle divisor.","name":"a2","description":"Number or Angle divisor."}],"class":"function","name":"__div","description":" Division metamethod"},"__index":{"path":"libs_sh/angles.lua#L64","returns":[{"type":"number","value":"number Value","description":"Value"}],"realm":"shared","params":[{"type":"number|string","value":"number|string Key","name":"Key","description":""}],"class":"function","name":"__index","description":" Gets a value at a key in the angle\n Can be indexed with: 1, 2, 3, p, y, r, pitch, yaw, roll. 1,2,3 is most efficient."},"__tostring":{"path":"libs_sh/angles.lua#L79","returns":[{"type":"string","value":"string String representing the angle.","description":"String representing the angle."}],"realm":"shared","class":"function","name":"__tostring","description":" Turns an angle into a string."},"__unm":{"path":"libs_sh/angles.lua#L121","returns":[{"type":"Angle","value":"Angle Negative angle.","description":"Negative angle."}],"realm":"shared","class":"function","name":"__unm","description":" Unary Minus metamethod (Negative)"},"clone":{"path":"libs_sh/angles.lua#L206","returns":[{"type":"Angle","value":"Angle The copy of the angle","description":"The copy of the angle"}],"realm":"shared","class":"function","name":"clone","description":" Copies p,y,r from angle and returns a new angle"},"setY":{"path":"libs_sh/angles.lua#L237","returns":[{"type":"Angle","value":"Angle Angle after modification","description":"Angle after modification"}],"realm":"shared","params":[{"type":"number","value":"number y The yaw","name":"y","description":"The yaw"}],"class":"function","name":"setY","description":" Set's the angle's yaw and returns self."},"getRight":{"path":"libs_sh/angles.lua#L163","returns":[{"type":"Vector","value":"Vector Right direction.","description":"Right direction."}],"realm":"shared","class":"function","name":"getRight","description":" Return the Right Vector relative to the angle dir."},"setP":{"path":"libs_sh/angles.lua#L229","returns":[{"type":"Angle","value":"Angle Angle after modification","description":"Angle after modification"}],"realm":"shared","params":[{"type":"number","value":"number p The pitch","name":"p","description":"The pitch"}],"class":"function","name":"setP","description":" Set's the angle's pitch and returns self."},"set":{"path":"libs_sh/angles.lua#L212","realm":"shared","params":[{"type":"Angle","value":"Angle b The angle to copy from.","name":"b","description":"The angle to copy from."}],"class":"function","name":"set","description":" Copies p,y,r from angle to another.\n Self-Modifies. Does not return anything"},"__newindex":{"path":"libs_sh/angles.lua#L52","realm":"shared","params":[{"type":"Angle","value":"Angle Ang","name":"Ang","description":""},{"type":"number|string","value":"number|string Key","name":"Key","description":""},{"type":"number","value":"number Value","name":"Value","description":""}],"class":"function","name":"__newindex","description":" Sets a value at a key in the angle"},"__add":{"path":"libs_sh/angles.lua#L135","returns":[{"type":"Angle","value":"Angle Resultant angle.","description":"Resultant angle."}],"realm":"shared","params":[{"type":"Angle","value":"Angle a1 Initial angle.","name":"a1","description":"Initial angle."},{"type":"Angle","value":"Angle a2 Angle to add to the first.","name":"a2","description":"Angle to add to the first."}],"class":"function","name":"__add","description":" Addition metamethod"},"getUp":{"path":"libs_sh/angles.lua#L169","returns":[{"type":"Vector","value":"Vector Up direction.","description":"Up direction."}],"realm":"shared","class":"function","name":"getUp","description":" Return the Up Vector relative to the angle dir."},"isZero":{"path":"libs_sh/angles.lua#L151","returns":[{"type":"boolean","value":"boolean If they are all zero","description":"If they are all zero"}],"realm":"shared","class":"function","name":"isZero","description":" Returns if p,y,r are all 0."},"__sub":{"path":"libs_sh/angles.lua#L143","returns":[{"type":"Angle","value":"Angle Resultant angle.","description":"Resultant angle."}],"realm":"shared","params":[{"type":"Angle","value":"Angle a1 Initial angle.","name":"a1","description":"Initial angle."},{"type":"Angle","value":"Angle a2 Angle to subtract.","name":"a2","description":"Angle to subtract."}],"class":"function","name":"__sub","description":" Subtraction metamethod"},"__eq":{"path":"libs_sh/angles.lua#L127","returns":[{"type":"boolean","value":"boolean Whether their fields are equal","description":"Whether their fields are equal"}],"realm":"shared","params":[{"type":"Angle","value":"Angle a1 Initial angle.","name":"a1","description":"Initial angle."},{"type":"Angle","value":"Angle a2 Angle to check against.","name":"a2","description":"Angle to check against."}],"class":"function","name":"__eq","description":" Equivalence metamethod"},"setR":{"path":"libs_sh/angles.lua#L245","returns":[{"type":"Angle","value":"Angle Angle after modification","description":"Angle after modification"}],"realm":"shared","params":[{"type":"number","value":"number r The roll","name":"r","description":"The roll"}],"class":"function","name":"setR","description":" Set's the angle's roll and returns self."},"getForward":{"path":"libs_sh/angles.lua#L157","returns":[{"type":"Vector","value":"Vector Forward direction.","description":"Forward direction."}],"realm":"shared","class":"function","name":"getForward","description":" Return the Forward Vector ( direction the angle points )."}},"fields":[{"name":"p","description":"The -90 to 90 pitch value of the euler angle. Can also be indexed with [1]"},{"name":"y","description":"The -180 to 180 yaw value of the euler angle. Can also be indexed with [2]"},{"name":"r","description":"The -180 to 180 roll value of the euler angle. Can also be indexed with [3]"}],"realm":"shared","libtbl":["ang_methods","ang_meta"],"class":"type","name":"Angle","description":" Angle Type"}}}
\ No newline at end of file