# Table of Contents - [Installation | v-severe](#installation-v-severe) - [Glossary | v-severe](#glossary-v-severe) - [Miscellaneous | v-severe](#miscellaneous-v-severe) - [Core | v-severe](#core-v-severe) - [Classes | v-severe](#classes-v-severe) - [Input | v-severe](#input-v-severe) - [File System | v-severe](#file-system-v-severe) - [Vector3 | v-severe](#vector3-v-severe) - [Color3 | v-severe](#color3-v-severe) - [Signal | v-severe](#signal-v-severe) - [Libraries | v-severe](#libraries-v-severe) - [Vector2 | v-severe](#vector2-v-severe) - [luau | v-severe](#luau-v-severe) - [memory | v-severe](#memory-v-severe) - [Drawing | v-severe](#drawing-v-severe) - [WebsocketClient | v-severe](#websocketclient-v-severe) - [CFrame | v-severe](#cframe-v-severe) - [task | v-severe](#task-v-severe) - [Static | v-severe](#static-v-severe) - [Dynamic | v-severe](#dynamic-v-severe) - [Classes | v-severe](#classes-v-severe) - [Square | v-severe](#square-v-severe) - [Polyline | v-severe](#polyline-v-severe) - [Image | v-severe](#image-v-severe) - [Immediate | v-severe](#immediate-v-severe) - [Text | v-severe](#text-v-severe) - [Triangle | v-severe](#triangle-v-severe) - [World | v-severe](#world-v-severe) - [DataModel | v-severe](#datamodel-v-severe) - [Unknown](#unknown) - [Model | v-severe](#model-v-severe) - [Enumerations | v-severe](#enumerations-v-severe) - [Unknown](#unknown) - [Circle | v-severe](#circle-v-severe) - [Camera | v-severe](#camera-v-severe) - [Instance | v-severe](#instance-v-severe) - [UserInputService | v-severe](#userinputservice-v-severe) - [Humanoid | v-severe](#humanoid-v-severe) - [BillboardGui | v-severe](#billboardgui-v-severe) - [crypt | v-severe](#crypt-v-severe) - [BasePart | v-severe](#basepart-v-severe) - [RunService | v-severe](#runservice-v-severe) - [Workspace | v-severe](#workspace-v-severe) - [Players | v-severe](#players-v-severe) - [ValueBase | v-severe](#valuebase-v-severe) - [Player | v-severe](#player-v-severe) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Core | v-severe](#core-v-severe) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) --- # Installation | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/introduction/installation.md) . [](https://v-severe.gitbook.io/landing/introduction/installation#overview) Overview ---------------------------------------------------------------------------------------- > In this article, we will cover installing Severe, and the most common issues users face in the process. [](https://v-severe.gitbook.io/landing/introduction/installation#requirements) Requirements ------------------------------------------------------------------------------------------------ * **Windows 10/11:** Note that for some newer versions of **Windows 11** might not work, you should verify in the purchase channel on the Discord server. We also don't promise tweaked re-distributions of Windows to work out of the box, few that have been tested are: **Atlas**, and **XOS**. * **Internet Connection** * **Turned off anti-virus:** both Windows Defender, and user-installed anti-viruses can interfere with **Severe**. We recommend using [**Winaero Tweaker**](https://winaerotweaker.com/) or \[**Defender Control**\]\[https://github.com/pgkt04/defender-control\] ### [](https://v-severe.gitbook.io/landing/introduction/installation#redistributes) Redistributes This is needed to be installed **before** Severe for smoother experience, and also to fix some of the problems (for example: the overlay not showing up). * [DirectX End-User Runtime](https://www.microsoft.com/en-us/download/details.aspx?id=8109) * [.NET SDK](https://dotnet.microsoft.com/en-us/download) * [Visual C++ Runtime](https://www.techpowerup.com/download/visual-c-redistributable-runtime-package-all-in-one/) [](https://v-severe.gitbook.io/landing/introduction/installation#downloading) Downloading ---------------------------------------------------------------------------------------------- Install **severe.rar** from the `#downloads` channel on the official Discord server, afterwards continue by **extracting**, and **running the upgrade.exe** file. After, you should see a new file in the same folder as **upgrade.exe** called **software.exe**, this is your primary executable that **you should be running to launch Severe.** Run **software.exe**, and ideally, after a bit of waiting, you should see an overlay on **Roblox** asking you to either **log-in** or **register**. If you're a first time user, please continue with registering, a few key details however: * **Note down your username and password:** this is critical to ensure that your account won't get lost. * **Avoid special characters:** spaces, symbols should be avoided at all cost, please use an alphanumeric password consisting of letters **A-Z**, and **0-9** numbers. [](https://v-severe.gitbook.io/landing/introduction/installation#issues) Issues ------------------------------------------------------------------------------------ ### [](https://v-severe.gitbook.io/landing/introduction/installation#hwid-mismatch) HWID Mismatch We utilize **HWID** to provide a secure connection from your machine to our servers, changing a part in your PC can sometimes cause this to change. In this case, please navigate to our [Keyauth Page](https://keyauth.cc/panel/SHELUV_PERKS/v-severe) and press **"Reset HWID"**. ### [](https://v-severe.gitbook.io/landing/introduction/installation#executable-not-opening) Executable not opening This is a frequent issue with custom file explorers, please use the native file explorer or utilize the command prompt to open the file. ### [](https://v-severe.gitbook.io/landing/introduction/installation#loading-loop-bad-post-code) Loading Loop / Bad Post Code Incase **Severe** is stuck whilst loading, the most frequent resolution is disabling your anti-virus software, such as **Malwarebytes**, or **Avast**. ### [](https://v-severe.gitbook.io/landing/introduction/installation#glfw-error) GLFW Error Reopen **Severe** with **Roblox window focused**. ### [](https://v-severe.gitbook.io/landing/introduction/installation#d3dcompiler_43.dll) D3DCompiler\_43.dll Download this [file](https://www.dll-files.com/download/0c20f567e2e586f6bcf3f0ce3ae64aab/d3dcompiler_43.dll.html?c=Yko1VjlUSWd4WFJaZ2w5OG1hQjFVQT09) and move it into `C:/Windows/System32`. ### [](https://v-severe.gitbook.io/landing/introduction/installation#https-verification-failed) HTTPs Verification Failed Use [**Cloudflare's 1.1.1.1**](https://one.one.one.one/) or a VPN. ### [](https://v-severe.gitbook.io/landing/introduction/installation#this-app-cant-run-on-your-pc) This app can't run on your PC Disable all anti-viruses, redownload **Severe** and run **upgrade.exe**. ### [](https://v-severe.gitbook.io/landing/introduction/installation#hosts) Hosts First, download [this file](https://pixeldrain.com/u/jWJfBB3Q) , afterwards, move it to `C:/Windows/System32/Drivers/etc`. ### [](https://v-severe.gitbook.io/landing/introduction/installation#dont-see-your-issue) Don't see your issue? Contact support via the official **Discord server**, and please, remain patient. In edge cases, where a new-user can't get their **Severe** working, and hasn't registered an account before, a refund can be negotiated. [PreviousLanding](https://v-severe.gitbook.io/landing) [NextGlossary](https://v-severe.gitbook.io/landing/introduction/glossary) Last updated 4 months ago --- # Glossary | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/introduction/glossary.md) . [](https://v-severe.gitbook.io/landing/introduction/glossary#luau) [Luau](https://luau.org/) -------------------------------------------------------------------------------------------------- (pronounced "LOO-ow") is a scripting language, derived from **Lua 5.1**, key features of it are **performance**, **type checking**, **syntax additions**, and **safety**. It's used in **Roblox** as the primary scripting language for games, as well as in **Warframe**, and **Alan Wake 2**. [](https://v-severe.gitbook.io/landing/introduction/glossary#hwid) [HWID](https://en.wikipedia.org/wiki/Device_fingerprint) --------------------------------------------------------------------------------------------------------------------------------- Often used for authentication, it's a unique identifier assigned to hardware components of a computer. [](https://v-severe.gitbook.io/landing/introduction/glossary#ram) [RAM](https://en.wikipedia.org/wiki/Random-access_memory) --------------------------------------------------------------------------------------------------------------------------------- Digital, "short-term memory" in which games store live data, such as player health, position, etc. [PreviousInstallation](https://v-severe.gitbook.io/landing/introduction/installation) [NextCore](https://v-severe.gitbook.io/landing/reference/core) Last updated 4 months ago --- # Miscellaneous | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/core/miscellaneous.md) . [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#isrbxactive) isrbxactive ------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#definition) Definition Copy function isrbxactive(): boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#returns) Returns Copy boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#description) Description Will return `true` if the currently focused window is **Roblox**, otherwise returns `false`. * * * [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#send_notification) send\_notification -------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#definition-1) Definition Copy function send_notification(content: string): () ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#parameters) Parameters Name Type Description content string Message, that you want to be visualized on the overlay. ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#description-1) Description This will visualize `content` on the screen thru an notification on the overlay. ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#code-samples) Code Samples Copy send_notification 'Hello, world!' * * * [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#setclipboard) setclipboard --------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#definition-2) Definition Copy function setclipboard(content: string): () ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#parameters-1) Parameters Name Type Description content string Whatever you want to be copied into the clipboard. ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#description-2) Description This will essentially copy the string to your system's clipboard. ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#code-samples-1) Code Samples Copy setclipboard 'Clipboard!' * * * [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#block_roblox_window) block\_roblox\_window ------------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#definition-3) Definition Copy function block_roblox_window(state: boolean): () ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#parameters-2) Parameters Name Type Description state boolean Whether or not you're trying to block or unblock the window. ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#description-3) Description Will effectively disable input pass-through on the overlay, forcing you to interact with **it** rather than the game. This is useful when creating custom a user-interface. * * * [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#pointer_to_userdata) pointer\_to\_userdata ------------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#definition-4) Definition Copy function pointer_to_userdata(address: number): userdata ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#parameters-3) Parameters Name Type Description address number The address that you want to turn into a userdata. ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#returns-1) Returns Copy userdata ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#description-4) Description This is a useful function that you'll find yourself utilizing when interacting with the memory functions. This will effectively turn valid addresses back into **wolurld objects**, allowing you to index/namecall them. ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#code-samples-2) Code Samples Copy -- Find the DataModel by reading Workspace's parent offset, and then recasting it back to userdata. local Parent = memory.readu64(workspace, 0x50) local DataModel = pointer_to_userdata(Parent) print(DataModel == game) -- Ideally, would be true, however due to version changes, 0x50 might be an invalid offset. * * * [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#get_overlay_fps) get\_overlay\_fps ----------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#definition-5) Definition Copy function get_overlay_fps(): number ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#returns-2) Returns Copy number ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#description-5) Description Returns the number amount of **FPS** (frames per second) that the overlay is currently running at. * * * [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#is_forcefield_check_active) is\_forcefield\_check\_active ---------------------------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#definition-6) Definition Copy function is_forcefield_check_active(): boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#returns-3) Returns Copy boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#description-6) Description Returns a boolean (true/false) based if the player has **Forcefield Check** on in their settings. * * * [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#is_local_health_check_active) is\_local\_health\_check\_active --------------------------------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#definition-7) Definition Copy function is_local_health_check_active(): boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#returns-4) Returns Copy boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#description-7) Description Returns a boolean (true/false) based if the player has **Health Check** on in their settings. * * * [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#is_team_check_active) is\_team\_check\_active ---------------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#definition-8) Definition Copy function is_team_check_active(): boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#returns-5) Returns Copy boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#description-8) Description Returns a boolean (true/false) based if the player has **Team Check** on in their settings. * * * [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#add_model_data) add\_model\_data --------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#definition-9) Definition Copy function add_model_data(data: table, key: string): boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#parameters-4) Parameters Name Type Description data table Character data structure with fields like `Username` (string), `Displayname` (string), `Userid` (number), `Character` (Instance), `PrimaryPart` (Instance), `Head` (Instance), `LeftLeg` (Instance), `LeftArm` (Instance), `RightLeg` (Instance), `RightArm` (Instance), `Torso` (Instance), `ToolName` (string), `TeamName` (string), `BodyHeightScale` (number), `RigType` (number), `Whitelisted` (boolean), `Archenemies` (boolean), `Aimbot_Part` (Instance), `Aimbot_TP_Part` (Instance), `Triggerbot_Part` (Instance), `Health` (number), `MaxHealth` (number), `body_parts_data` (table), `full_body_data` (table). key string Unique identifier for storing the model data. ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#returns-6) Returns Copy boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#description-9) Description Declares a new character model data under the given key for use in targeting and ESP. Processed in a dedicated model thread, and will return `true` on success. ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#code-samples-3) Code Samples Copy local data = { Username = "Player1", Displayname = "CoolPlayer", Userid = 123456, Character = workspace.Player1.Character, PrimaryPart = workspace.Player1.Character.HumanoidRootPart, -- ... other fields } add_model_data(data, "player1_key") * * * [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#edit_model_data) edit\_model\_data ----------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#definition-10) Definition Copy function edit_model_data(data: table, key: string): boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#parameters-5) Parameters Name Type Description data table Partial updates with fields like `RigType` (number), `Whitelisted` (boolean), `Archenemies` (boolean), `Aimbot_Part` (Instance), `Aimbot_TP_Part` (Instance), `Triggerbot_Part` (Instance), `Health` (number), `MaxHealth` (number), `BodyHeightScale` (number). key string Key of existing model data to update. ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#returns-7) Returns Copy boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#description-10) Description Updates specific fields in existing model data stored under the key. Efficient for runtime changes like health or target parts. Returns `true` on success. ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#code-samples-4) Code Samples Copy local edit = { Health = 50, Aimbot_Part = workspace.Player1.Character.Head } edit_model_data(edit, "player1_key") * * * [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#remove_model_data) remove\_model\_data --------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#definition-11) Definition Copy function remove_model_data(key: string): boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#parameters-6) Parameters Name Type Description key string Key of the model data to remove. ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#returns-8) Returns Copy boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#description-11) Description Deletes specific model data by key. Returns `true` on success. * * * [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#clear_model_data) clear\_model\_data ------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#definition-12) Definition Copy function clear_model_data(): boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#returns-9) Returns Copy boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#description-12) Description Removes all stored model data. Returns `true` on success. * * * [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#override_local_data) override\_local\_data ------------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#definition-13) Definition Copy function override_local_data(data: table): boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#parameters-7) Parameters Name Type Description data table Local player data with fields like `LocalPlayer` (userdata), `Displayname` (string), `Username` (string), `Userid` (number), `Character` (userdata), `Team` (userdata), `RootPart` (userdata), `LeftFoot` (userdata), `Head` (userdata), `LowerTorso` (userdata), `Tool` (userdata), `Humanoid` (userdata), `Health` (number), `MaxHealth` (number), `RigType` (number). ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#returns-10) Returns Copy boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#description-13) Description Sets or overrides local player data for UI rendering and local thread processing. Returns `true` on success. ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#code-samples-5) Code Samples Copy local data = { LocalPlayer = game.Players.LocalPlayer, Character = game.Players.LocalPlayer.Character, -- ... other fields } override_local_data(data) * * * [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#clear_local_data) clear\_local\_data ------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#definition-14) Definition Copy function clear_local_data(): boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#returns-11) Returns Copy boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#description-14) Description Clears all local player data. Returns `true` on success. [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#ismenuopened) ismenuopened --------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#definition-15) Definition Copy function ismenuopened(): boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#returns-12) Returns Copy boolean ### [](https://v-severe.gitbook.io/landing/reference/core/miscellaneous#description-15) Description Whether the menu is opened returns `true`, otherwise `false`. [PreviousFile System](https://v-severe.gitbook.io/landing/reference/core/file-system) [NextInput](https://v-severe.gitbook.io/landing/reference/core/input) Last updated 4 months ago --- # Core | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/core.md) . [File System](https://v-severe.gitbook.io/landing/reference/core/file-system) [Miscellaneous](https://v-severe.gitbook.io/landing/reference/core/miscellaneous) [Input](https://v-severe.gitbook.io/landing/reference/core/input) [PreviousGlossary](https://v-severe.gitbook.io/landing/introduction/glossary) [NextFile System](https://v-severe.gitbook.io/landing/reference/core/file-system) Last updated 4 months ago --- # Classes | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/classes.md) . [Vector3](https://v-severe.gitbook.io/landing/reference/classes/vector3) [Color3](https://v-severe.gitbook.io/landing/reference/classes/color3) [WebsocketClient](https://v-severe.gitbook.io/landing/reference/classes/websocketclient) [Signal](https://v-severe.gitbook.io/landing/reference/classes/signal) [CFrame](https://v-severe.gitbook.io/landing/reference/classes/cframe) [Vector2](https://v-severe.gitbook.io/landing/reference/classes/vector2) [PreviousInput](https://v-severe.gitbook.io/landing/reference/core/input) [NextVector3](https://v-severe.gitbook.io/landing/reference/classes/vector3) --- # Input | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/core/input.md) . [](https://v-severe.gitbook.io/landing/reference/core/input#keypress) keypress ----------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/input#definition) Definition Copy function keypress(keycode: number): () ### [](https://v-severe.gitbook.io/landing/reference/core/input#parameters) Parameters Name Type Description keycode number Virtual keycode to press ### [](https://v-severe.gitbook.io/landing/reference/core/input#description) Description Simulates a key press for the given virtual keycode. > **Note:** Virtual key codes: [Microsoft Docs](https://docs.microsoft.com/en-us/windows/desktop/inputdev/virtual-key-codes) * * * [](https://v-severe.gitbook.io/landing/reference/core/input#keyrelease) keyrelease --------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/input#definition-1) Definition Copy function keyrelease(keycode: number): () ### [](https://v-severe.gitbook.io/landing/reference/core/input#parameters-1) Parameters Name Type Description keycode number Virtual keycode to release ### [](https://v-severe.gitbook.io/landing/reference/core/input#description-1) Description Simulates a key release for the given virtual keycode. * * * [](https://v-severe.gitbook.io/landing/reference/core/input#getpressedkey) getpressedkey --------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/input#definition-2) Definition Copy function getpressedkey(): string ### [](https://v-severe.gitbook.io/landing/reference/core/input#returns) Returns Copy ### string ### [](https://v-severe.gitbook.io/landing/reference/core/input#description-2) Description Returns the name of the last pressed key. * * * [](https://v-severe.gitbook.io/landing/reference/core/input#getpressedkeys) getpressedkeys ----------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/input#definition-3) Definition Copy function getpressedkeys(): { string } ### [](https://v-severe.gitbook.io/landing/reference/core/input#returns-1) Returns Copy ### { string } ### [](https://v-severe.gitbook.io/landing/reference/core/input#description-3) Description Returns an array of currently pressed key names. * * * [](https://v-severe.gitbook.io/landing/reference/core/input#isleftclicked) isleftclicked --------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/input#definition-4) Definition Copy function isleftclicked(): boolean ### [](https://v-severe.gitbook.io/landing/reference/core/input#returns-2) Returns Copy ### boolean ### [](https://v-severe.gitbook.io/landing/reference/core/input#description-4) Description Returns `true` if left mouse button was clicked. * * * [](https://v-severe.gitbook.io/landing/reference/core/input#isrightclicked) isrightclicked ----------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/input#definition-5) Definition Copy function isrightclicked(): boolean ### [](https://v-severe.gitbook.io/landing/reference/core/input#returns-3) Returns Copy ### boolean ### [](https://v-severe.gitbook.io/landing/reference/core/input#description-5) Description Returns `true` if right mouse button was clicked. * * * [](https://v-severe.gitbook.io/landing/reference/core/input#isleftpressed) isleftpressed --------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/input#definition-6) Definition Copy function isleftpressed(): boolean ### [](https://v-severe.gitbook.io/landing/reference/core/input#returns-4) Returns Copy ### boolean ### [](https://v-severe.gitbook.io/landing/reference/core/input#description-6) Description Returns `true` if left mouse button is held down. * * * [](https://v-severe.gitbook.io/landing/reference/core/input#isrightpressed) isrightpressed ----------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/input#definition-7) Definition Copy function isrightpressed(): boolean ### [](https://v-severe.gitbook.io/landing/reference/core/input#returns-5) Returns Copy ### boolean ### [](https://v-severe.gitbook.io/landing/reference/core/input#description-7) Description Returns `true` if right mouse button is held down. * * * [](https://v-severe.gitbook.io/landing/reference/core/input#mousemoverel) mousemoverel ------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/input#definition-8) Definition Copy function mousemoverel(x: number, y: number): () ### [](https://v-severe.gitbook.io/landing/reference/core/input#parameters-2) Parameters Name Type Description x number Relative X offset y number Relative Y offset ### [](https://v-severe.gitbook.io/landing/reference/core/input#description-8) Description Moves mouse by relative X/Y coordinates. * * * [](https://v-severe.gitbook.io/landing/reference/core/input#mousemoveabs) mousemoveabs ------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/input#definition-9) Definition Copy function mousemoveabs(x: number, y: number): () ### [](https://v-severe.gitbook.io/landing/reference/core/input#parameters-3) Parameters Name Type Description x number Absolute X position y number Absolute Y position ### [](https://v-severe.gitbook.io/landing/reference/core/input#description-9) Description Moves mouse to absolute X/Y screen coordinates. * * * [](https://v-severe.gitbook.io/landing/reference/core/input#mousescroll) mousescroll ----------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/input#definition-10) Definition Copy function mousescroll(pixels: number): () ### [](https://v-severe.gitbook.io/landing/reference/core/input#parameters-4) Parameters Name Type Description pixels number Scroll distance (pixels) ### [](https://v-severe.gitbook.io/landing/reference/core/input#description-10) Description Scrolls mouse wheel by specified pixels. * * * [](https://v-severe.gitbook.io/landing/reference/core/input#mouse1click) mouse1click ----------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/input#definition-11) Definition Copy function mouse1click(): () ### [](https://v-severe.gitbook.io/landing/reference/core/input#description-11) Description Simulates a left mouse button click. * * * [](https://v-severe.gitbook.io/landing/reference/core/input#mouse1press) mouse1press ----------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/input#definition-12) Definition Copy function mouse1press(): () ### [](https://v-severe.gitbook.io/landing/reference/core/input#description-12) Description Simulates a left mouse button press (hold). * * * [](https://v-severe.gitbook.io/landing/reference/core/input#mouse1release) mouse1release --------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/input#definition-13) Definition Copy function mouse1release(): () ### [](https://v-severe.gitbook.io/landing/reference/core/input#description-13) Description Simulates a left mouse button release. * * * [](https://v-severe.gitbook.io/landing/reference/core/input#mouse2click) mouse2click ----------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/input#definition-14) Definition Copy function mouse2click(): () ### [](https://v-severe.gitbook.io/landing/reference/core/input#description-14) Description Simulates a right mouse button click. * * * [](https://v-severe.gitbook.io/landing/reference/core/input#mouse2press) mouse2press ----------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/input#definition-15) Definition Copy function mouse2press(): () ### [](https://v-severe.gitbook.io/landing/reference/core/input#description-15) Description Simulates a right mouse button press (hold). * * * [](https://v-severe.gitbook.io/landing/reference/core/input#mouse2release) mouse2release --------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/input#definition-16) Definition Copy function mouse2release(): () ### [](https://v-severe.gitbook.io/landing/reference/core/input#description-16) Description Simulates a right mouse button release. [PreviousMiscellaneous](https://v-severe.gitbook.io/landing/reference/core/miscellaneous) [NextClasses](https://v-severe.gitbook.io/landing/reference/classes) Last updated 4 months ago --- # File System | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/core/file-system.md) . [](https://v-severe.gitbook.io/landing/reference/core/file-system#dofile) dofile ------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#definition) Definition Copy function dofile(path: string): (... any) ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#returns) Returns Copy (... any) ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#description) Description Effectively `loadstring(readfile(path))()`. Loads and executes a luau file, returning any values the file returns. * * * [](https://v-severe.gitbook.io/landing/reference/core/file-system#loadfile) loadfile ----------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#definition-1) Definition Copy function loadfile(path: string): (... any) ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#returns-1) Returns Copy (... any) ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#description-1) Description Loads a luau file and returns it as a function. Call the returned function to execute the file's code. * * * [](https://v-severe.gitbook.io/landing/reference/core/file-system#writefile) writefile ------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#definition-2) Definition Copy function writefile(path: string, content: string): () ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#description-2) Description Overrides/creates a file at `path` with specified content. * * * [](https://v-severe.gitbook.io/landing/reference/core/file-system#isfile) isfile ------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#definition-3) Definition Copy function isfile(path: string): boolean ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#returns-2) Returns Copy boolean ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#description-3) Description Validates the existence of a file at `path`, returns a boolean. * * * [](https://v-severe.gitbook.io/landing/reference/core/file-system#isfolder) isfolder ----------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#definition-4) Definition Copy function isfolder(path: string): boolean ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#returns-3) Returns Copy boolean ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#description-4) Description Validates the existence of a folder at `path`, returns a boolean. * * * [](https://v-severe.gitbook.io/landing/reference/core/file-system#readfile) readfile ----------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#definition-5) Definition Copy function readfile(path: string): string ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#returns-4) Returns Copy string ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#description-5) Description Returns the contents of a file at `path` as a string. * * * [](https://v-severe.gitbook.io/landing/reference/core/file-system#listfiles) listfiles ------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#definition-6) Definition Copy function listfiles(path: string): { string } ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#returns-5) Returns Copy { string } ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#description-6) Description Returns an array of all files and folders at `path`. * * * [](https://v-severe.gitbook.io/landing/reference/core/file-system#makefolder) makefolder --------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#definition-7) Definition Copy function makefolder(path: string): () ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#description-7) Description Creates a new folder at `path`. * * * [](https://v-severe.gitbook.io/landing/reference/core/file-system#delfolder) delfolder ------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#definition-8) Definition Copy function delfolder(path: string): () ### [](https://v-severe.gitbook.io/landing/reference/core/file-system#description-8) Description Removes the folder located at `path`. * * * > **Note:** All file operations are sandboxed to `C:\v2\workspace`. Attempting to read/write/load outside this directory is impossible. [PreviousCore](https://v-severe.gitbook.io/landing/reference/core) [NextMiscellaneous](https://v-severe.gitbook.io/landing/reference/core/miscellaneous) Last updated 4 months ago --- # Vector3 | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/classes/vector3.md) . A 3D vector with X, Y, and Z components. [](https://v-severe.gitbook.io/landing/reference/classes/vector3#constructors) Constructors ------------------------------------------------------------------------------------------------ ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#vector3.new) Vector3.new ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#definition) Definition Copy function Vector3.new(x: number, y: number, z: number): Vector3 function Vector3.new(): Vector3 ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#parameters) Parameters Name Type Description x number The X component y number The Y component z number The Z component ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#returns) Returns Type Vector3 ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#description) Description Creates a new Vector3. If no parameters are provided, creates a zero vector (0, 0, 0). ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#code-samples) Code Samples Copy -- Create a vector local vec = Vector3.new(10, 20, 30) -- Zero vector local zero = Vector3.new() print(zero) -- Vector3(0, 0, 0) -- Unit vectors local right = Vector3.new(1, 0, 0) local up = Vector3.new(0, 1, 0) local forward = Vector3.new(0, 0, 1) * * * [](https://v-severe.gitbook.io/landing/reference/classes/vector3#properties) Properties -------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#x) X Copy Vector3.X: number The X component of the vector. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#y) Y Copy Vector3.Y: number The Y component of the vector. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#z) Z Copy Vector3.Z: number The Z component of the vector. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#magnitude) Magnitude Copy Vector3.Magnitude: number The length of the vector. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#unit) Unit Copy Vector3.Unit: Vector3 A normalized version of the vector (length of 1). * * * [](https://v-severe.gitbook.io/landing/reference/classes/vector3#methods) Methods -------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#dot) Dot ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#definition-1) Definition Copy function Vector3:Dot(other: Vector3): number ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#parameters-1) Parameters Name Type Description other Vector3 The other vector ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#returns-1) Returns Type number ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#description-1) Description Returns the dot product of this vector and another vector. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#cross) Cross ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#definition-2) Definition Copy function Vector3:Cross(other: Vector3): Vector3 ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#parameters-2) Parameters Name Type Description other Vector3 The other vector ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#returns-2) Returns Type Vector3 ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#description-2) Description Returns the cross product of this vector and another vector. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#lerp) Lerp ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#definition-3) Definition Copy function Vector3:Lerp(goal: Vector3, alpha: number): Vector3 ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#parameters-3) Parameters Name Type Description goal Vector3 The target vector to interpolate towards alpha number The interpolation factor (0 to 1) ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#returns-3) Returns Type Vector3 ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#description-3) Description Returns a Vector3 interpolated between this vector and the goal vector by the alpha amount. * * * [](https://v-severe.gitbook.io/landing/reference/classes/vector3#metatables) Metatables -------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#add) \_\_add Adds two vectors. Copy local v1 = Vector3.new(1, 2, 3) local v2 = Vector3.new(4, 5, 6) local result = v1 + v2 -- Vector3(5, 7, 9) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#sub) \_\_sub Subtracts one vector from another. Copy local v1 = Vector3.new(5, 7, 9) local v2 = Vector3.new(1, 2, 3) local result = v1 - v2 -- Vector3(4, 5, 6) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#mul) \_\_mul Multiplies a vector by a scalar or another vector. Copy local vec = Vector3.new(1, 2, 3) local scaled = vec * 2 -- Vector3(2, 4, 6) -- Component-wise multiplication local v1 = Vector3.new(2, 3, 4) local v2 = Vector3.new(1, 2, 3) local result = v1 * v2 -- Vector3(2, 6, 12) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#div) \_\_div Divides a vector by a scalar or another vector. Copy local vec = Vector3.new(10, 20, 30) local scaled = vec / 2 -- Vector3(5, 10, 15) -- Component-wise division local v1 = Vector3.new(10, 20, 30) local v2 = Vector3.new(2, 4, 5) local result = v1 / v2 -- Vector3(5, 5, 6) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#unm) \_\_unm Negates a vector. Copy local vec = Vector3.new(1, 2, 3) local negated = -vec -- Vector3(-1, -2, -3) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#eq) \_\_eq Compares two vectors for equality. Copy local v1 = Vector3.new(1, 2, 3) local v2 = Vector3.new(1, 2, 3) local v3 = Vector3.new(4, 5, 6) print(v1 == v2) -- true print(v1 == v3) -- false * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector3#tostring) \_\_tostring Returns a string representation of the vector. Copy local vec = Vector3.new(10, 20, 30) print(vec) -- "Vector3(10, 20, 30)" [PreviousClasses](https://v-severe.gitbook.io/landing/reference/classes) [NextColor3](https://v-severe.gitbook.io/landing/reference/classes/color3) Last updated 4 months ago --- # Color3 | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/classes/color3.md) . A data type representing a color with red, green, and blue components. [](https://v-severe.gitbook.io/landing/reference/classes/color3#constructors) Constructors ----------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#color3.new) Color3.new ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#definition) Definition Copy function Color3.new(r: number, g: number, b: number): Color3 ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#parameters) Parameters Name Type Description r number Red component (0 to 1) g number Green component (0 to 1) b number Blue component (0 to 1) ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#returns) Returns Type Color3 ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#description) Description Creates a new Color3 from RGB values in the range 0 to 1. ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#code-samples) Code Samples Copy -- Pure red local red = Color3.new(1, 0, 0) -- Pure green local green = Color3.new(0, 1, 0) -- Pure blue local blue = Color3.new(0, 0, 1) -- White local white = Color3.new(1, 1, 1) -- Gray (50%) local gray = Color3.new(0.5, 0.5, 0.5) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#color3.fromrgb) Color3.fromRGB ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#definition-1) Definition Copy function Color3.fromRGB(r: number, g: number, b: number): Color3 ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#parameters-1) Parameters Name Type Description r number Red component (0 to 255) g number Green component (0 to 255) b number Blue component (0 to 255) ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#returns-1) Returns Type Color3 ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#description-1) Description Creates a new Color3 from RGB values in the range 0 to 255. ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#code-samples-1) Code Samples Copy -- Pure red local red = Color3.fromRGB(255, 0, 0) -- Orange local orange = Color3.fromRGB(255, 165, 0) -- Sky blue local skyBlue = Color3.fromRGB(135, 206, 235) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#color3.fromhsv) Color3.fromHSV ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#definition-2) Definition Copy function Color3.fromHSV(h: number, s: number, v: number): Color3 ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#parameters-2) Parameters Name Type Description h number Hue component (0 to 1) s number Saturation component (0 to 1) v number Value/brightness component (0 to 1) ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#returns-2) Returns Type Color3 ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#description-2) Description Creates a new Color3 from HSV (Hue, Saturation, Value) color space values. ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#code-samples-2) Code Samples Copy -- Pure red (hue = 0) local red = Color3.fromHSV(0, 1, 1) -- Pure green (hue = 1/3) local green = Color3.fromHSV(1/3, 1, 1) -- Pure blue (hue = 2/3) local blue = Color3.fromHSV(2/3, 1, 1) -- Desaturated red (pink) local pink = Color3.fromHSV(0, 0.5, 1) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#color3.fromhex) Color3.fromHex ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#definition-3) Definition Copy function Color3.fromHex(hex: string): Color3 ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#parameters-3) Parameters Name Type Description hex string Hexadecimal color string (e.g., "#FF5733") ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#returns-3) Returns Type Color3 ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#description-3) Description Creates a new Color3 from a hexadecimal color string. The string can optionally start with "#". ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#code-samples-3) Code Samples Copy -- With hash local orange = Color3.fromHex("#FF5733") -- Without hash local blue = Color3.fromHex("0000FF") -- Cyan local cyan = Color3.fromHex("#00FFFF") * * * [](https://v-severe.gitbook.io/landing/reference/classes/color3#methods) Methods ------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#tohsv) ToHSV ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#definition-4) Definition Copy function Color3:ToHSV(): (number, number, number) ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#returns-4) Returns Type (number, number, number) ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#description-4) Description Converts the Color3 to HSV (Hue, Saturation, Value) format and returns the three components. ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#code-samples-4) Code Samples Copy local color = Color3.fromRGB(255, 128, 0) local h, s, v = color:ToHSV() print(h, s, v) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#lerp) Lerp ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#definition-5) Definition Copy function Color3:Lerp(goal: Color3, alpha: number): Color3 ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#parameters-4) Parameters Name Type Description goal Color3 The target color to interpolate towards alpha number The interpolation factor (0 to 1) ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#returns-5) Returns Type Color3 ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#description-5) Description Returns a Color3 interpolated between this color and the goal color by the alpha amount. ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#code-samples-5) Code Samples Copy local red = Color3.fromRGB(255, 0, 0) local blue = Color3.fromRGB(0, 0, 255) local purple = red:Lerp(blue, 0.5) * * * [](https://v-severe.gitbook.io/landing/reference/classes/color3#metatables) Metatables ------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#index) \_\_index Allows property access on Color3 values. Copy local color = Color3.fromRGB(255, 128, 64) local r = color.R -- 1 local g = color.G -- 0.502 local b = color.B -- 0.251 * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#tostring) \_\_tostring Returns a string representation of the Color3. Copy local color = Color3.fromRGB(255, 128, 0) print(color) -- "Color3(1, 0.502, 0)" * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#eq) \_\_eq Compares two Color3 values for equality. Copy local color1 = Color3.fromRGB(255, 0, 0) local color2 = Color3.fromRGB(255, 0, 0) local color3 = Color3.fromRGB(0, 255, 0) print(color1 == color2) -- true print(color1 == color3) -- false * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#type) \_\_type Returns the type name "Color3". Copy local color = Color3.new(1, 0, 0) print(typeof(color)) -- "Color3" * * * [](https://v-severe.gitbook.io/landing/reference/classes/color3#properties) Properties ------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#r) R Copy Color3.R: number The red component of the color (0 to 1). * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#g) G Copy Color3.G: number The green component of the color (0 to 1). * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/color3#b) B Copy Color3.B: number The blue component of the color (0 to 1). [PreviousVector3](https://v-severe.gitbook.io/landing/reference/classes/vector3) [NextWebsocketClient](https://v-severe.gitbook.io/landing/reference/classes/websocketclient) Last updated 4 months ago --- # Signal | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/classes/signal.md) . [PreviousWebsocketClient](https://v-severe.gitbook.io/landing/reference/classes/websocketclient) [NextCFrame](https://v-severe.gitbook.io/landing/reference/classes/cframe) Last updated 4 months ago --- # Libraries | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/libraries.md) . [crypt](https://v-severe.gitbook.io/landing/reference/libraries/crypt) [luau](https://v-severe.gitbook.io/landing/reference/libraries/luau) [memory](https://v-severe.gitbook.io/landing/reference/libraries/memory) [task](https://v-severe.gitbook.io/landing/reference/libraries/task) [PreviousVector2](https://v-severe.gitbook.io/landing/reference/classes/vector2) [Nextcrypt](https://v-severe.gitbook.io/landing/reference/libraries/crypt) Last updated 4 months ago --- # Vector2 | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/classes/vector2.md) . A 2D vector with X and Y components. [](https://v-severe.gitbook.io/landing/reference/classes/vector2#constructors) Constructors ------------------------------------------------------------------------------------------------ ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#vector2.new) Vector2.new ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#definition) Definition Copy function Vector2.new(x: number, y: number): Vector2 function Vector2.new(): Vector2 ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#parameters) Parameters Name Type Description x number The X component y number The Y component ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#returns) Returns Type Vector2 ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#description) Description Creates a new Vector2. If no parameters are provided, creates a zero vector (0, 0). ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#code-samples) Code Samples Copy -- Create a vector local vec = Vector2.new(100, 200) -- Zero vector local zero = Vector2.new() print(zero) -- Vector2(0, 0) -- Unit vectors local right = Vector2.new(1, 0) local up = Vector2.new(0, 1) * * * [](https://v-severe.gitbook.io/landing/reference/classes/vector2#properties) Properties -------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#x) X Copy Vector2.X: number The X component of the vector. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#y) Y Copy Vector2.Y: number The Y component of the vector. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#magnitude) Magnitude Copy Vector2.Magnitude: number The length of the vector. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#unit) Unit Copy Vector2.Unit: Vector2 A normalized version of the vector (length of 1). * * * [](https://v-severe.gitbook.io/landing/reference/classes/vector2#methods) Methods -------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#dot) Dot ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#definition-1) Definition Copy function Vector2:Dot(other: Vector2): number ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#parameters-1) Parameters Name Type Description other Vector2 The other vector ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#returns-1) Returns Type number ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#description-1) Description Returns the dot product of this vector and another vector. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#cross) Cross ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#definition-2) Definition Copy function Vector2:Cross(other: Vector2): number ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#parameters-2) Parameters Name Type Description other Vector2 The other vector ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#returns-2) Returns Type number ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#description-2) Description Returns the 2D cross product (scalar) of this vector and another vector. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#lerp) Lerp ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#definition-3) Definition Copy function Vector2:Lerp(goal: Vector2, alpha: number): Vector2 ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#parameters-3) Parameters Name Type Description goal Vector2 The target vector to interpolate towards alpha number The interpolation factor (0 to 1) ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#returns-3) Returns Type Vector2 ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#description-3) Description Returns a Vector2 interpolated between this vector and the goal vector by the alpha amount. * * * [](https://v-severe.gitbook.io/landing/reference/classes/vector2#metatables) Metatables -------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#add) \_\_add Adds two vectors. Copy local v1 = Vector2.new(10, 20) local v2 = Vector2.new(5, 15) local result = v1 + v2 -- Vector2(15, 35) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#sub) \_\_sub Subtracts one vector from another. Copy local v1 = Vector2.new(10, 20) local v2 = Vector2.new(5, 15) local result = v1 - v2 -- Vector2(5, 5) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#mul) \_\_mul Multiplies a vector by a scalar or another vector. Copy local vec = Vector2.new(10, 20) local scaled = vec * 2 -- Vector2(20, 40) -- Component-wise multiplication local v1 = Vector2.new(2, 3) local v2 = Vector2.new(4, 5) local result = v1 * v2 -- Vector2(8, 15) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#div) \_\_div Divides a vector by a scalar or another vector. Copy local vec = Vector2.new(100, 200) local scaled = vec / 2 -- Vector2(50, 100) -- Component-wise division local v1 = Vector2.new(100, 200) local v2 = Vector2.new(10, 20) local result = v1 / v2 -- Vector2(10, 10) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#unm) \_\_unm Negates a vector. Copy local vec = Vector2.new(10, 20) local negated = -vec -- Vector2(-10, -20) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#eq) \_\_eq Compares two vectors for equality. Copy local v1 = Vector2.new(10, 20) local v2 = Vector2.new(10, 20) local v3 = Vector2.new(5, 15) print(v1 == v2) -- true print(v1 == v3) -- false * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/vector2#tostring) \_\_tostring Returns a string representation of the vector. Copy local vec = Vector2.new(100, 200) print(vec) -- "Vector2(100, 200)" [PreviousCFrame](https://v-severe.gitbook.io/landing/reference/classes/cframe) [NextLibraries](https://v-severe.gitbook.io/landing/reference/libraries) Last updated 4 months ago --- # luau | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/libraries/luau.md) . [](https://v-severe.gitbook.io/landing/reference/libraries/luau#compile) compile ------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/luau#definition) Definition Copy function luau.compile(source: string, options: { optimizationLevel: 0 | 1 | 2?, coverageLevel: 0 | 1 | 2?, debugLevel: 0 | 1 | 2? }): string ### [](https://v-severe.gitbook.io/landing/reference/libraries/luau#parameters) Parameters Name Type Description source string The Luau source code to compile. options table Compilation settings (optimization, coverage, debug). ### [](https://v-severe.gitbook.io/landing/reference/libraries/luau#description) Description Compiles the given source code into Luau bytecode. An error will be thrown if the source code contains syntax errors or other issues that prevent successful compilation. ### [](https://v-severe.gitbook.io/landing/reference/libraries/luau#code-samples) Code Samples Copy local bytecode = luau.compile("print('Hello, World!')", { optimizationLevel = 2, coverageLevel = 0, debugLevel = 1, }) local func = load(bytecode) func() -- Outputs: Hello, World! * * * [](https://v-severe.gitbook.io/landing/reference/libraries/luau#load) load ------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/luau#definition-1) Definition Copy function luau.load(bytecode: string, options: { debugName: string?, environment: { [string]: any }?, injectGlobals: boolean?, codegenEnabled: boolean? }): (... any?) -> (... any?) ### [](https://v-severe.gitbook.io/landing/reference/libraries/luau#parameters-1) Parameters Name Type Description bytecode string Compiled Luau bytecode. options table Loading options (debug name, environment, codegen). ### [](https://v-severe.gitbook.io/landing/reference/libraries/luau#description-1) Description Loads a function from the given Luau bytecode string. An error will be thrown if the bytecode is invalid or cannot be loaded. Note that if `environment` is enabled, native code generation and optimizations are forcefully disabled. ### [](https://v-severe.gitbook.io/landing/reference/libraries/luau#code-samples-1) Code Samples Copy local bytecode = luau.compile("return 42", { optimizationLevel = 2, coverageLevel = 0, debugLevel = 1, }) local func = luau.load(bytecode, "MyChunk") print(func()) -- Outputs: 42 [Previouscrypt](https://v-severe.gitbook.io/landing/reference/libraries/crypt) [Nextmemory](https://v-severe.gitbook.io/landing/reference/libraries/memory) Last updated 4 months ago --- # memory | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/libraries/memory.md) . [](https://v-severe.gitbook.io/landing/reference/libraries/memory#types) Types ----------------------------------------------------------------------------------- Type Description Range / Format **i8** Signed 8-bit \[-128, 127\] **u8** Unsigned 8-bit \[0, 255\] **i16** Signed 16-bit \[-32,768, 32,767\] **u16** Unsigned 16-bit \[0, 65,535\] **i32** Signed 32-bit \[-2.1B, 2.1B\] **u32** Unsigned 32-bit \[0, 4.2B\] **i64** Signed 64-bit Approximate (Casted to Double) **u64** Unsigned 64-bit Approximate (Casted to Double) **f32** 32-bit Float IEEE 754 Single **f64** 64-bit Float IEEE 754 Double > **Note:** Luau does not natively support 64-bit integers. As a result, **i64** and **u64** operations are **approximations**; these values are cast to a double-precision float, which may lead to precision loss or rounding for extremely large integers. [](https://v-severe.gitbook.io/landing/reference/libraries/memory#functions) Functions ------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#read-type) read\[type\] #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#definition) Definition Copy function memory.read[type](address: number): number function memory.read[type](source: userdata, offset: number): number #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#description) Description Reads data of a specific type from a raw memory address or an offset from a `userdata`. Note that \[type\] has to be replaced with a valid type that can be found above. Valid example is: `memory.readu32(workspace, 0x50)`. * * * ### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#memory.write-type) memory.write\[type\] #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#definition-1) Definition Copy function memory.write[type](address: number, value: number): () function memory.write[type](destination: userdata, offset: number, value: number): () #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#description-1) Description Writes a value of a specific type to a memory address or `userdata` offset. Note that \[type\] has to be replaced with a valid type that can be found above. Valid example is: `memory.writeu32(workspace, 0x50)`. * * * ### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#memory.readbits) memory.readbits #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#definition-2) Definition Copy function memory.readbits(address: number, bitOffset: number, bitSize: number): number function memory.readbits(source: userdata, offset: number, bitOffset: number, bitSize: number): number #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#description-2) Description Reads a range of bits (up to 32) from the target, starting at `bitOffset`. * * * ### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#memory.writebits) memory.writebits #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#definition-3) Definition Copy function memory.writebits(address: number, bitOffset: number, bitSize: number, value: number): () function memory.writebits(destination: userdata, offset: number, bitOffset: number, bitSize: number, value: number): () #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#description-3) Description Writes a range of bits (up to 32) from `value` to the destination at `bitOffset`. * * * ### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#memory.readstring) memory.readstring #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#definition-4) Definition Copy function memory.readstring(address: number): string function memory.readstring(source: userdata, offset: number): string #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#description-4) Description Reads a raw null-terminated string or byte sequence from the target location. * * * ### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#memory.writestring) memory.writestring #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#definition-5) Definition Copy function memory.writestring(address: number, value: string): () function memory.writestring(destination: userdata, offset: number, value: string): () #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#description-5) Description Writes the raw bytes of a string to the specified memory location. * * * ### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#memory.readvector) memory.readvector #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#definition-6) Definition Copy function memory.readvector(address: number): vector function memory.readvector(source: userdata, offset: number): vector #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#description-6) Description Reads a 3-dimensional vector from memory. * * * ### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#memory.writevector) memory.writevector #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#definition-7) Definition Copy function memory.writevector(address: number, value: vector): () function memory.writevector(destination: userdata, offset: number, value: vector): () #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#description-7) Description Writes a 3-dimensional vector to the target memory location. * * * ### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#memory.readbuffer) memory.readbuffer #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#definition-8) Definition Copy function memory.readbuffer(address: number, size: number): buffer function memory.readbuffer(source: userdata, offset: number, size: number): buffer #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#description-8) Description Reads `size` bytes into a new Luau `buffer`. Highly efficient for bulk data extraction. * * * ### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#memory.writebuffer) memory.writebuffer #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#definition-9) Definition Copy function memory.writebuffer(address: number, value: buffer): () function memory.writebuffer(destination: userdata, offset: number, value: buffer): () #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#description-9) Description Writes the contents of a Luau `buffer` directly to the specified memory location. * * * ### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#memory.rtti) memory.rtti #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#definition-10) Definition Copy function memory.rtti(address: number): string? function memory.rtti(source: userdata, offset: number): string? #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#description-10) Description Retrieves the **Run-Time Type Information** name from the target address. Returns `nil` if no type info is available. * * * ### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#memory.changed) memory.changed #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#definition-11) Definition Copy function memory.changed(address: number, type: string, callback: (self: userdata, new: any, old: any) -> (), iterations: number?): userdata function memory.changed(source: userdata, offset: number, type: string, callback: (self: userdata, new: any, old: any) -> (), iterations: number?): userdata #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#description-11) Description Establishes a listener on a memory location that triggers the `callback` whenever the value changes. Available types: `i8`, `u8`, `i16`, `u16`, `i32`, `u32`, `i64`, `u64`, `f32`, `f64`, `string`. [](https://v-severe.gitbook.io/landing/reference/libraries/memory#properties) Properties --------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#memory.base) memory.base #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#definition-12) Definition Copy memory.base: number #### [](https://v-severe.gitbook.io/landing/reference/libraries/memory#description-12) Description This is the base address for Roblox. [Previousluau](https://v-severe.gitbook.io/landing/reference/libraries/luau) [Nexttask](https://v-severe.gitbook.io/landing/reference/libraries/task) Last updated 4 months ago --- # Drawing | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/drawing.md) . [](https://v-severe.gitbook.io/landing/reference/drawing#overview) Overview -------------------------------------------------------------------------------- Drawing itself, within **Severe** refers to a library which has functions for static ([retained](https://en.wikipedia.org/wiki/Retained_mode) ) rendering of objects. We offer 3 different ways of rendering: * **Dynamic:** Offering best performance, and fast usage. * **Immediate:** Ideal for a small amount of objects, or if the objects move. * **Static:** [Retained](https://en.wikipedia.org/wiki/Retained_mode) drawing, being best if you can manage it properly, or for user interfaces. [Previoustask](https://v-severe.gitbook.io/landing/reference/libraries/task) [NextClasses](https://v-severe.gitbook.io/landing/reference/drawing/classes) Last updated 4 months ago --- # WebsocketClient | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/classes/websocketclient.md) . A websocket client for establishing and managing WebSocket connections. [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#constructors) Constructors -------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#websocketclient.new) WebsocketClient.new ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#definition) Definition Copy function WebsocketClient.new(url: string): WebsocketClient ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#parameters) Parameters Name Type Description url string The WebSocket connection URL ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#returns) Returns Type WebsocketClient ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#description) Description Creates a new WebsocketClient and connects to the specified URL. ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#code-samples) Code Samples Copy -- Create a WebSocket connection local ws = WebsocketClient.new("ws://example.com:8080") -- Handle incoming messages ws.DataReceived:Connect(function(payload, isBinary) if isBinary then print("Received binary data:", #payload, "bytes") else print("Received text:", payload) end end) -- Send a message ws:Send("Hello, server!") -- Disconnect when done ws:Disconnect() * * * [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#properties) Properties ---------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#url) Url Copy WebsocketClient.Url: string [readonly] The WebSocket connection URL that this client is connected to. This property is read-only. * * * [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#methods) Methods ---------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#disconnect) Disconnect ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#definition-1) Definition Copy function WebsocketClient:Disconnect(): () ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#description-1) Description Disconnects the WebSocket. Yields until the client is fully disconnected. After calling this method, the WebSocket connection is closed and no further messages can be sent or received. ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#code-samples-1) Code Samples Copy local ws = WebsocketClient.new("ws://example.com:8080") -- Do some work... ws:Send("Goodbye") -- Disconnect (yields until fully disconnected) ws:Disconnect() print("WebSocket disconnected") * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#send) Send ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#definition-2) Definition Copy function WebsocketClient:Send(message: string, isBinary: boolean?): () ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#parameters-1) Parameters Name Type Description message string The message payload to send isBinary boolean? Whether to send as binary data (defaults to false) ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#description-2) Description Sends a message through the WebSocket connection. The message can be sent as either text or binary data based on the `isBinary` parameter. ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#code-samples-2) Code Samples Copy local ws = WebsocketClient.new("ws://example.com:8080") -- Send text message (default) ws:Send("Hello, world!") -- Explicitly send text ws:Send("Text message", false) -- Send binary data local binaryData = "\x01\x02\x03\x04" ws:Send(binaryData, true) * * * [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#events) Events -------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#datareceived) DataReceived ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#definition-3) Definition Copy WebsocketClient.DataReceived: Signal<(payload: string, isBinary: boolean) -> ()> ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#parameters-2) Parameters Name Type Description payload string The received message data isBinary boolean Whether the received data is binary ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#description-3) Description Fires when data is received from the WebSocket connection. The event provides the payload as a string and a boolean indicating whether it's binary data. ### [](https://v-severe.gitbook.io/landing/reference/classes/websocketclient#code-samples-3) Code Samples Copy local ws = WebsocketClient.new("ws://example.com:8080") -- Connect to the DataReceived event ws.DataReceived:Connect(function(payload, isBinary) if isBinary then print("Received binary payload of length:", #payload) -- Process binary data... else print("Received text message:", payload) -- Process text data... end end) -- Example with JSON parsing ws.DataReceived:Connect(function(payload, isBinary) if not isBinary then local success, data = pcall(function() return game:GetService("HttpService"):JSONDecode(payload) end) if success then print("Received JSON data:", data) else print("Received non-JSON text:", payload) end end end) [PreviousColor3](https://v-severe.gitbook.io/landing/reference/classes/color3) [NextSignal](https://v-severe.gitbook.io/landing/reference/classes/signal) Last updated 4 months ago --- # CFrame | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/classes/cframe.md) . A coordinate frame representing position and rotation in 3D space. [](https://v-severe.gitbook.io/landing/reference/classes/cframe#constructors) Constructors ----------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#cframe.new) CFrame.new ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition) Definition Copy function CFrame.new(): CFrame function CFrame.new(x: number, y: number, z: number): CFrame function CFrame.new(position: Vector3): CFrame function CFrame.new(position: Vector3, lookAt: Vector3): CFrame function CFrame.new(x: number, y: number, z: number, qx: number, qy: number, qz: number, qw: number): CFrame function CFrame.new(x: number, y: number, z: number, R00: number, R01: number, R02: number, R10: number, R11: number, R12: number, R20: number, R21: number, R22: number): CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description) Description Creates a new CFrame. Can be constructed in several ways: * Empty constructor creates an identity CFrame at (0, 0, 0) * Position-only creates a CFrame at the specified position with no rotation * Position and lookAt creates a CFrame positioned at the first argument, looking at the second * Position with quaternion values for rotation * Position with full rotation matrix components ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#code-samples) Code Samples Copy -- Identity CFrame local cf1 = CFrame.new() -- Position only local cf2 = CFrame.new(10, 20, 30) -- Position from Vector3 local cf3 = CFrame.new(Vector3.new(5, 10, 15)) -- Position looking at another position local cf4 = CFrame.new(Vector3.new(0, 5, 0), Vector3.new(10, 5, 10)) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#cframe.fromeuleranglesxyz) CFrame.fromEulerAnglesXYZ ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-1) Definition Copy function CFrame.fromEulerAnglesXYZ(rx: number, ry: number, rz: number): CFrame function CFrame.fromEulerAnglesXYZ(rotation: Vector3): CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#parameters) Parameters Name Type Description rx number Rotation around X-axis in radians ry number Rotation around Y-axis in radians rz number Rotation around Z-axis in radians rotation Vector3 Vector containing rotation angles ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns) Returns Type CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-1) Description Creates a rotated CFrame using Euler angles in X, Y, Z order (roll, pitch, yaw). ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#code-samples-1) Code Samples Copy -- Rotate 90 degrees (π/2 radians) around Y-axis local cf = CFrame.fromEulerAnglesXYZ(0, math.pi/2, 0) -- Using Vector3 local rotation = Vector3.new(0, math.pi/2, 0) local cf2 = CFrame.fromEulerAnglesXYZ(rotation) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#cframe.fromeuleranglesyxz) CFrame.fromEulerAnglesYXZ ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-2) Definition Copy function CFrame.fromEulerAnglesYXZ(rx: number, ry: number, rz: number): CFrame function CFrame.fromEulerAnglesYXZ(rotation: Vector3): CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#parameters-1) Parameters Name Type Description rx number Rotation around X-axis in radians ry number Rotation around Y-axis in radians rz number Rotation around Z-axis in radians rotation Vector3 Vector containing rotation angles ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns-1) Returns Type CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-2) Description Creates a rotated CFrame using Euler angles in Y, X, Z order. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#cframe.fromorientation) CFrame.fromOrientation ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-3) Definition Copy function CFrame.fromOrientation(rx: number, ry: number, rz: number): CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#parameters-2) Parameters Name Type Description rx number Rotation around X-axis in radians ry number Rotation around Y-axis in radians rz number Rotation around Z-axis in radians ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns-2) Returns Type CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-3) Description Creates a rotated CFrame from orientation angles (equivalent to fromEulerAnglesYXZ). * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#cframe.fromaxisangle) CFrame.fromAxisAngle ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-4) Definition Copy function CFrame.fromAxisAngle(axis: Vector3, rotation: number): CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#parameters-3) Parameters Name Type Description axis Vector3 The axis of rotation (unit vector) rotation number The angle of rotation in radians ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns-3) Returns Type CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-4) Description Creates a CFrame rotated around the specified axis by the given angle. ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#code-samples-2) Code Samples Copy -- Rotate 45 degrees around the Y-axis local axis = Vector3.new(0, 1, 0) local cf = CFrame.fromAxisAngle(axis, math.pi/4) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#cframe.frommatrix) CFrame.fromMatrix ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-5) Definition Copy function CFrame.fromMatrix(position: Vector3, vX: Vector3, vY: Vector3, vZ: Vector3): CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#parameters-4) Parameters Name Type Description position Vector3 The position of the CFrame vX Vector3 The right vector vY Vector3 The up vector vZ Vector3 The negative look vector ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns-4) Returns Type CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-5) Description Creates a CFrame from a position and three directional vectors representing the rotation matrix. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#cframe.lookat) CFrame.lookAt ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-6) Definition Copy function CFrame.lookAt(from: Vector3, to: Vector3, up: Vector3?): CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#parameters-5) Parameters Name Type Description from Vector3 The position to look from to Vector3 The position to look at up Vector3? Optional up vector (defaults to world up) ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns-5) Returns Type CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-6) Description Creates a CFrame positioned at 'from' and oriented to look at 'to'. ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#code-samples-3) Code Samples Copy -- Create a CFrame looking from origin to a point local cf = CFrame.lookAt(Vector3.new(0, 5, 0), Vector3.new(10, 5, 10)) -- With custom up vector local cf2 = CFrame.lookAt(Vector3.new(0, 0, 0), Vector3.new(5, 5, 5), Vector3.new(0, 1, 0)) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#cframe.angles) CFrame.Angles ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-7) Definition Copy function CFrame.Angles(rx: number, ry: number, rz: number): CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#parameters-6) Parameters Name Type Description rx number Rotation around X-axis in radians ry number Rotation around Y-axis in radians rz number Rotation around Z-axis in radians ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns-6) Returns Type CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-7) Description Creates a rotated CFrame from Euler angles (equivalent to fromOrientation). * * * [](https://v-severe.gitbook.io/landing/reference/classes/cframe#methods) Methods ------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#inverse) Inverse ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-8) Definition Copy function CFrame:Inverse(): CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns-7) Returns Type CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-8) Description Returns the inverse of this CFrame. When multiplied with the original, produces an identity CFrame. ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#code-samples-4) Code Samples Copy local cf = CFrame.new(10, 20, 30) local inverse = cf:Inverse() local identity = cf * inverse -- Results in CFrame at origin * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#lerp) Lerp ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-9) Definition Copy function CFrame:Lerp(goal: CFrame, alpha: number): CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#parameters-7) Parameters Name Type Description goal CFrame The target CFrame to interpolate towards alpha number The interpolation factor (0 to 1) ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns-8) Returns Type CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-9) Description Returns a CFrame interpolated between this CFrame and the goal CFrame by the alpha amount. ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#code-samples-5) Code Samples Copy local start = CFrame.new(0, 0, 0) local goal = CFrame.new(10, 10, 10) local halfway = start:Lerp(goal, 0.5) -- CFrame at (5, 5, 5) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#toworldspace) ToWorldSpace ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-10) Definition Copy function CFrame:ToWorldSpace(cf: CFrame): CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#parameters-8) Parameters Name Type Description cf CFrame The CFrame in object space ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns-9) Returns Type CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-10) Description Transforms a CFrame from object space to world space. Equivalent to `self * cf`. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#toobjectspace) ToObjectSpace ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-11) Definition Copy function CFrame:ToObjectSpace(cf: CFrame): CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#parameters-9) Parameters Name Type Description cf CFrame The CFrame in world space ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns-10) Returns Type CFrame ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-11) Description Transforms a CFrame from world space to object space. Equivalent to `self:Inverse() * cf`. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#pointtoworldspace) PointToWorldSpace ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-12) Definition Copy function CFrame:PointToWorldSpace(point: Vector3): Vector3 ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#parameters-10) Parameters Name Type Description point Vector3 The point in object space ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns-11) Returns Type Vector3 ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-12) Description Transforms a point from object space to world space. ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#code-samples-6) Code Samples Copy local cf = CFrame.new(10, 0, 0) local localPoint = Vector3.new(5, 0, 0) local worldPoint = cf:PointToWorldSpace(localPoint) -- Vector3(15, 0, 0) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#pointtoobjectspace) PointToObjectSpace ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-13) Definition Copy function CFrame:PointToObjectSpace(point: Vector3): Vector3 ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#parameters-11) Parameters Name Type Description point Vector3 The point in world space ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns-12) Returns Type Vector3 ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-13) Description Transforms a point from world space to object space. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#vectortoworldspace) VectorToWorldSpace ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-14) Definition Copy function CFrame:VectorToWorldSpace(vector: Vector3): Vector3 ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#parameters-12) Parameters Name Type Description vector Vector3 The vector in object space ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns-13) Returns Type Vector3 ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-14) Description Transforms a vector from object space to world space (rotation only, no translation). * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#vectortoobjectspace) VectorToObjectSpace ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-15) Definition Copy function CFrame:VectorToObjectSpace(vector: Vector3): Vector3 ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#parameters-13) Parameters Name Type Description vector Vector3 The vector in world space ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns-14) Returns Type Vector3 ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-15) Description Transforms a vector from world space to object space (rotation only, no translation). * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#getcomponents) GetComponents ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-16) Definition Copy function CFrame:GetComponents(): (number, number, number, number, number, number, number, number, number, number, number, number) ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns-15) Returns Type (number, number, number, number, number, number, number, number, number, number, number, number) ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-16) Description Returns the 12 components of the CFrame: position (x, y, z) and rotation matrix (R00, R01, R02, R10, R11, R12, R20, R21, R22). ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#code-samples-7) Code Samples Copy local cf = CFrame.new(10, 20, 30) local x, y, z, R00, R01, R02, R10, R11, R12, R20, R21, R22 = cf:GetComponents() print(x, y, z) -- 10, 20, 30 * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#toorientation) ToOrientation ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-17) Definition Copy function CFrame:ToOrientation(): (number, number, number) ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns-16) Returns Type (number, number, number) ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-17) Description Returns the orientation of the CFrame as three Euler angles in radians (rx, ry, rz) in Y, X, Z order. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#toeuleranglesxyz) ToEulerAnglesXYZ ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-18) Definition Copy function CFrame:ToEulerAnglesXYZ(): (number, number, number) ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns-17) Returns Type (number, number, number) ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-18) Description Returns the orientation of the CFrame as three Euler angles in radians (rx, ry, rz) in X, Y, Z order. ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#code-samples-8) Code Samples Copy local cf = CFrame.Angles(0, math.pi/2, 0) local rx, ry, rz = cf:ToEulerAnglesXYZ() print(rx, ry, rz) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#toeuleranglesyxz) ToEulerAnglesYXZ ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-19) Definition Copy function CFrame:ToEulerAnglesYXZ(): (number, number, number) ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns-18) Returns Type (number, number, number) ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-19) Description Returns the orientation of the CFrame as three Euler angles in radians (rx, ry, rz) in Y, X, Z order. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#toaxisangle) ToAxisAngle ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#definition-20) Definition Copy function CFrame:ToAxisAngle(): (Vector3, number) ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#returns-19) Returns Type (Vector3, number) ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#description-20) Description Returns the axis-angle representation of the CFrame's rotation as a unit vector and rotation angle in radians. ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#code-samples-9) Code Samples Copy local cf = CFrame.fromAxisAngle(Vector3.new(0, 1, 0), math.pi/4) local axis, angle = cf:ToAxisAngle() print(axis, angle) * * * [](https://v-severe.gitbook.io/landing/reference/classes/cframe#metatables) Metatables ------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#index) \_\_index Allows property access on CFrame values. Copy local cf = CFrame.new(10, 20, 30) local pos = cf.Position -- Vector3(10, 20, 30) local rightVector = cf.RightVector local upVector = cf.UpVector local lookVector = cf.LookVector * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#mul) \_\_mul Multiplies two CFrames or transforms a Vector3. Copy -- CFrame multiplication local cf1 = CFrame.new(10, 0, 0) local cf2 = CFrame.new(5, 0, 0) local result = cf1 * cf2 -- CFrame at (15, 0, 0) -- Transform a Vector3 local cf = CFrame.new(10, 20, 30) local point = Vector3.new(1, 1, 1) local transformed = cf * point * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#add) \_\_add Translates a CFrame by a Vector3. Copy local cf = CFrame.new(10, 20, 30) local offset = Vector3.new(5, 5, 5) local result = cf + offset -- CFrame at (15, 25, 35) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#sub) \_\_sub Translates a CFrame by the negative of a Vector3. Copy local cf = CFrame.new(10, 20, 30) local offset = Vector3.new(5, 5, 5) local result = cf - offset -- CFrame at (5, 15, 25) * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#tostring) \_\_tostring Returns a string representation of the CFrame. Copy local cf = CFrame.new(10, 20, 30) print(cf) -- "CFrame(10, 20, 30, 1, 0, 0, 0, 1, 0, 0, 0, 1)" * * * [](https://v-severe.gitbook.io/landing/reference/classes/cframe#properties) Properties ------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#position) Position Copy CFrame.Position: Vector3 The position component of the CFrame. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#rightvector) RightVector Copy CFrame.RightVector: Vector3 The right direction vector of the CFrame (X-axis). * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#upvector) UpVector Copy CFrame.UpVector: Vector3 The up direction vector of the CFrame (Y-axis). * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#lookvector) LookVector Copy CFrame.LookVector: Vector3 The look direction vector of the CFrame (negative Z-axis). * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#x) X Copy CFrame.X: number The X position component. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#y) Y Copy CFrame.Y: number The Y position component. * * * ### [](https://v-severe.gitbook.io/landing/reference/classes/cframe#z) Z Copy CFrame.Z: number The Z position component. [PreviousSignal](https://v-severe.gitbook.io/landing/reference/classes/signal) [NextVector2](https://v-severe.gitbook.io/landing/reference/classes/vector2) Last updated 4 months ago --- # task | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/libraries/task.md) . Task scheduler library providing thread management functions for asynchronous execution. [](https://v-severe.gitbook.io/landing/reference/libraries/task#functions) Functions ----------------------------------------------------------------------------------------- [](https://v-severe.gitbook.io/landing/reference/libraries/task#task.spawn) task.spawn ------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#definition) Definition Copy function task.spawn(functionOrThread: (() -> ()) | thread, ...: any): thread ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#parameters) Parameters Name Type Description functionOrThread (() -> ()) | thread The function or thread to execute immediately ... any Optional arguments to pass to the function ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#returns) Returns Type thread ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#description) Description Immediately executes the provided function or resumes the provided thread in a separate thread without yielding the current thread. The new thread runs in parallel with the calling thread. Returns the thread that was spawned. ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#code-samples) Code Samples Copy -- Spawn a function task.spawn(function() print("This runs immediately in a new thread") task.wait(1) print("After 1 second") end) -- Spawn with arguments task.spawn(function(message, delay) task.wait(delay) print(message) end, "Hello!", 2) -- Spawn a thread local thread = coroutine.create(function() print("Thread spawned") end) task.spawn(thread) * * * [](https://v-severe.gitbook.io/landing/reference/libraries/task#task.defer) task.defer ------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#definition-1) Definition Copy function task.defer(functionOrThread: (() -> ()) | thread, ...: any): thread ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#parameters-1) Parameters Name Type Description functionOrThread (() -> ()) | thread The function or thread to execute after deferral ... any Optional arguments to pass to the function ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#returns-1) Returns Type thread ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#description-1) Description Defers the execution of the provided function or thread until the next resumption cycle. Unlike `task.spawn`, deferred functions do not run immediately but wait until the current thread yields. This is useful for scheduling work that should happen after the current frame or operation completes. ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#code-samples-1) Code Samples Copy -- Defer a function task.defer(function() print("This runs after the current thread yields") end) -- Defer with arguments task.defer(function(text) print("Deferred: " .. text) end, "Hello, world!") print("This prints first") -- Output: -- This prints first -- This runs after the current thread yields -- Deferred: Hello, world! * * * [](https://v-severe.gitbook.io/landing/reference/libraries/task#task.cancel) task.cancel --------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#definition-2) Definition Copy function task.cancel(thread: thread): () ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#parameters-2) Parameters Name Type Description thread thread The thread to cancel ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#description-2) Description Cancels a thread that was created with `task.spawn`, `task.defer`, or `task.delay`. Once cancelled, the thread will not resume execution. If the thread is already completed or cancelled, this function has no effect. ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#code-samples-2) Code Samples Copy -- Cancel a spawned thread local thread = task.spawn(function() task.wait(5) print("This will never print") end) task.wait(1) task.cancel(thread) print("Thread cancelled") -- Cancel a deferred thread local deferredThread = task.defer(function() print("This will not execute") end) task.cancel(deferredThread) * * * [](https://v-severe.gitbook.io/landing/reference/libraries/task#task.delay) task.delay ------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#definition-3) Definition Copy function task.delay(duration: number, functionOrThread: (() -> ()) | thread, ...: any): thread ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#parameters-3) Parameters Name Type Description duration number The time in seconds to wait before execution functionOrThread (() -> ()) | thread The function or thread to execute after delay ... any Optional arguments to pass to the function ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#returns-2) Returns Type thread ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#description-3) Description Schedules a function or thread to execute after the specified duration in seconds. The function runs in a separate thread after the delay. Returns the thread that will be executed. This is useful for scheduling delayed operations without blocking the current thread. ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#code-samples-3) Code Samples Copy -- Delay execution by 3 seconds task.delay(3, function() print("This prints after 3 seconds") end) -- Delay with arguments task.delay(5, function(message, count) for i = 1, count do print(message) end end, "Delayed message", 3) -- Delay a thread local thread = coroutine.create(function() print("Thread executed after delay") end) task.delay(2, thread) -- Cancel a delayed task local delayedThread = task.delay(10, function() print("This will be cancelled") end) task.wait(1) task.cancel(delayedThread) print("Delayed task cancelled") * * * [](https://v-severe.gitbook.io/landing/reference/libraries/task#task.wait) task.wait ----------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#definition-4) Definition Copy function task.wait(duration: number?): number ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#parameters-4) Parameters Name Type Description duration number? The time in seconds to wait. Defaults to 0 if not provided. ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#returns-3) Returns Type number ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#description-4) Description Yields the current thread for at least the specified duration in seconds. Returns the actual time elapsed. This is the preferred way to yield execution in modern Luau code, replacing the legacy `wait()` function. ### [](https://v-severe.gitbook.io/landing/reference/libraries/task#code-samples-4) Code Samples Copy -- Wait for 2 seconds local elapsed = task.wait(2) print("Waited for " .. elapsed .. " seconds") -- Wait with default duration task.wait() -- Waits for the next frame/cycle -- Use in a loop for i = 1, 5 do print("Iteration " .. i) task.wait(1) end -- Countdown timer for i = 10, 1, -1 do print(i) task.wait(1) end print("Blast off!") [Previousmemory](https://v-severe.gitbook.io/landing/reference/libraries/memory) [NextDrawing](https://v-severe.gitbook.io/landing/reference/drawing) Last updated 4 months ago --- # Static | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/drawing/static.md) . [](https://v-severe.gitbook.io/landing/reference/drawing/static#functions) Functions ----------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/drawing/static#drawing.new) Drawing.new **Definition** Copy function Drawing.new(class: string): userdata **Parameters** Name Type Description class string Valid classes can be found under the "Classes" sub-folder. **Description** Will create a new static drawing on the screen, it's retained, meaning you will have to manually describe it (set it's color, position, size), and manually clean-up. * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/static#drawing.clear) Drawing.clear **Definition** Copy function Drawing.clear(): () **Description** Will clear all the static objects created, this will also include static objects that were created by other scripts. * * * > **Note:** Not removing static drawings can result in degraded performance and memory leaks. Creating a lot of static drawings may result in render thread error, this is a known issue. [PreviousImmediate](https://v-severe.gitbook.io/landing/reference/drawing/immediate) [NextWorld](https://v-severe.gitbook.io/landing/reference/world) Last updated 4 months ago --- # Dynamic | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/drawing/dynamic.md) . [](https://v-severe.gitbook.io/landing/reference/drawing/dynamic#overview) Overview ---------------------------------------------------------------------------------------- Dynamic drawing allows you to automatically attach drawing objects to 3D world positions or instances. Drawing objects automatically update their screen position based on the camera's view of the linked points. [](https://v-severe.gitbook.io/landing/reference/drawing/dynamic#functions) Functions ------------------------------------------------------------------------------------------ ### [](https://v-severe.gitbook.io/landing/reference/drawing/dynamic#drawing.attach) Drawing.attach **Definition** Copy function Drawing.attach(config: { [Drawing]: AttachmentConfig }): Cluster **Parameters** Name Type Description config { \[Drawing\]: AttachmentConfig } A table mapping drawing objects to their attachment configurations **Returns** Type Description Cluster A cluster object that can be destroyed, paused, or resumed **Description** Attaches drawing objects to 3D points in the world. The drawing objects will automatically update their screen positions based on the camera's view of the linked points. Each drawing object can be configured with different attachment properties depending on its type. **Attachment Configurations** For `Square`, `Circle`, `Text`, `Image`: Property Type Description Link Point The point to attach the drawing to Size UDim2 Size of the drawing (Scale/Offset) AnchorPoint Vector2 Anchor point for positioning (0-1 range) For `Line`: Property Type Description From Point Starting point of the line To Point Ending point of the line **Code Samples** Copy local Head = PointInstance.new(game.Players.LocalPlayer.Character.Head :: BasePart) local Mesh = PointInstance.new(workspace.SpawnLocation :: BasePart) local Square = Drawing.new 'Square' Square.Visible = true Square.Filled = true Square.Color = Color3.fromRGB(255, 255, 125) local Line = Drawing.new 'Line' Line.Visible = true Line.Color = Color3.fromRGB(255, 0, 0) Line.Thickness = 2 local Cluster = Drawing.attach { [Square] = { Link = Head, Size = UDim2.fromScale(1, 1), AnchorPoint = Vector2.new(0.5, 0.5) }, [Line] = { From = Head, To = Mesh, } } task.wait(10) -- Later, when done: Cluster:Destroy() * * * [](https://v-severe.gitbook.io/landing/reference/drawing/dynamic#classes) Classes -------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/drawing/dynamic#pointinstance) PointInstance **Definition** Copy PointInstance.new(instance: BasePart): PointInstance **Description** Creates a point tracker for an instance with a CFrame property. The point automatically tracks the instance's position in the world. Only instances that have a CFrame property (e.g., BasePart) can be used. **Properties** Property Type Description CFrame CFrame The current CFrame of the tracked instance Size Vector3 The current Size of the tracked instance Active boolean Whether the point is actively tracking the instance **Methods** Method Description Destroy Stops tracking and cleans up resources **Code Samples** Copy local Head = PointInstance.new(game.Players.LocalPlayer.Character.Head :: BasePart) -- Access properties print(Head.CFrame) print(Head.Size) print(Head.Active) task.wait(10) -- Clean up: Head:Destroy() * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/dynamic#point3d) Point3D **Definition** Copy Point3D.new(position: Vector3): Point3D **Description** Creates a point at a fixed world-space position. The point represents a static location in 3D space. **Properties** Property Type Description Position Vector3 The world-space position of the point Active boolean Whether the point is active **Methods** Method Description Destroy Cleans up the point and its resources **Code Samples** Copy local StaticPoint = Point3D.new(Vector3.new(0, 10, 0)) -- Access properties print(StaticPoint.Position) print(StaticPoint.Active) -- Clean up when done StaticPoint:Destroy() * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/dynamic#cluster) Cluster **Description** A cluster is returned by `Drawing.attach` and manages a group of attached drawing objects. It provides methods to control the lifecycle of all attached drawings. **Methods** Method Description Destroy Destroys the cluster and all attached drawing objects Pause Pauses automatic updates for all drawings in the cluster Resume Resumes automatic updates for all drawings in the cluster **Code Samples** Copy local Head = PointInstance.new(game.Players.LocalPlayer.Character.Head :: BasePart) local Square = Drawing.new 'Square' Square.Visible = true local Cluster = Drawing.attach { [Square] = { Link = Head, Size = UDim2.fromScale(1, 1), AnchorPoint = Vector2.new(0.5, 0.5) } } -- Pause updates Cluster:Pause() -- Resume updates Cluster:Resume() -- Clean up everything Cluster:Destroy() [PreviousTriangle](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle) [NextImmediate](https://v-severe.gitbook.io/landing/reference/drawing/immediate) Last updated 4 months ago --- # Classes | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/drawing/classes.md) . [Circle](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle) [Image](https://v-severe.gitbook.io/landing/reference/drawing/classes/image) [Polyline](https://v-severe.gitbook.io/landing/reference/drawing/classes/polyline) [Square](https://v-severe.gitbook.io/landing/reference/drawing/classes/square) [Text](https://v-severe.gitbook.io/landing/reference/drawing/classes/text) [Triangle](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle) [PreviousDrawing](https://v-severe.gitbook.io/landing/reference/drawing) [NextCircle](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle) Last updated 4 months ago --- # Square | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/drawing/classes/square.md) . [](https://v-severe.gitbook.io/landing/reference/drawing/classes/square#definition) Definition --------------------------------------------------------------------------------------------------- Copy local Square = Square.new() -- Or, Drawing.new("Square") [](https://v-severe.gitbook.io/landing/reference/drawing/classes/square#properties) Properties --------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/square#visible) Visible Copy Square.Visible: boolean * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/square#color) Color Copy Square.Color: Color3 * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/square#zindex) ZIndex Copy Square.ZIndex: number Range `[-2147483647, 2147483647]`. * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/square#opacity) Opacity Copy Square.Opacity: number * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/square#thickness) Thickness Copy Square.Thickness: number * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/square#size) Size Copy Square.Size: Vector2 * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/square#position) Position Copy Square.Position: Vector2 * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/square#filled) Filled Copy Square.Filled: boolean * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/square#rounding) Rounding Copy Square.Rounding: number * * * [](https://v-severe.gitbook.io/landing/reference/drawing/classes/square#methods) Methods --------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/square#remove) Remove Copy Square:Remove(): () Permanently removes the drawing object. [PreviousPolyline](https://v-severe.gitbook.io/landing/reference/drawing/classes/polyline) [NextText](https://v-severe.gitbook.io/landing/reference/drawing/classes/text) Last updated 4 months ago --- # Polyline | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/drawing/classes/polyline.md) . [](https://v-severe.gitbook.io/landing/reference/drawing/classes/polyline#definition) Definition ----------------------------------------------------------------------------------------------------- Copy local Polyline = Polyline.new() -- Or, Drawing.new("Polyline") [](https://v-severe.gitbook.io/landing/reference/drawing/classes/polyline#properties) Properties ----------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/polyline#visible) Visible Copy Polyline.Visible: boolean * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/polyline#color) Color Copy Polyline.Color: Color3 * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/polyline#zindex) ZIndex Copy Polyline.ZIndex: number Range `[-2147483647, 2147483647]`. * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/polyline#opacity) Opacity Copy Polyline.Opacity: number * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/polyline#points) Points Copy Polyline.Points: { Vector2 } An array of Vector2 points that make up the polyline. * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/polyline#thickness) Thickness Copy Polyline.Thickness: number * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/polyline#filled) Filled Copy Polyline.Filled: boolean * * * [](https://v-severe.gitbook.io/landing/reference/drawing/classes/polyline#methods) Methods ----------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/polyline#remove) Remove Copy Polyline:Remove(): () Permanently removes the drawing object. [PreviousImage](https://v-severe.gitbook.io/landing/reference/drawing/classes/image) [NextSquare](https://v-severe.gitbook.io/landing/reference/drawing/classes/square) Last updated 4 months ago --- # Image | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/drawing/classes/image.md) . [](https://v-severe.gitbook.io/landing/reference/drawing/classes/image#definition) Definition -------------------------------------------------------------------------------------------------- Copy local Image = Image.new() -- Or, Drawing.new("Image") [](https://v-severe.gitbook.io/landing/reference/drawing/classes/image#properties) Properties -------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/image#visible) Visible Copy Image.Visible: boolean * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/image#color) Color Copy Image.Color: Color3 * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/image#zindex) ZIndex Copy Image.ZIndex: number Range `[-2147483647, 2147483647]`. * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/image#opacity) Opacity Copy Image.Opacity: number * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/image#url) Url Copy Image.Url: string * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/image#data) Data Copy Image.Data: string * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/image#gif) Gif Copy Image.Gif: boolean * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/image#delay) Delay Copy Image.Delay: number * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/image#position) Position Copy Image.Position: Vector2 * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/image#size) Size Copy Image.Size: Vector2 * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/image#rounding) Rounding Copy Image.Rounding: number * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/image#imagesize) ImageSize Copy Image.ImageSize: Vector2 * * * !\[\[\]\] [](https://v-severe.gitbook.io/landing/reference/drawing/classes/image#methods) Methods -------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/image#remove) Remove Copy Image:Remove(): () Permanently removes the drawing object. [PreviousCircle](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle) [NextPolyline](https://v-severe.gitbook.io/landing/reference/drawing/classes/polyline) Last updated 4 months ago --- # Immediate | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/drawing/immediate.md) . [](https://v-severe.gitbook.io/landing/reference/drawing/immediate#overview) Overview ------------------------------------------------------------------------------------------ Traditional drawing uses **retained mode**—objects persist until removed. **DrawingImmediate** is **immediate mode**; objects exist only during `RunService.Render` calls. [](https://v-severe.gitbook.io/landing/reference/drawing/immediate#examples) Examples ------------------------------------------------------------------------------------------ Copy local Players = game:GetService("Players") local CurrentCamera = workspace.CurrentCamera local RunService = game:GetService("RunService") RunService.Render:Connect(function() for Index, Player in Players:GetChildren() do local Character = Player.Character if not Character then continue end local Head = Character:FindFirstChild("Head") if not Head then continue end local Screen, Visible = CurrentCamera:WorldToScreenPoint(Head.Position) if Visible then DrawingImmediate.OutlinedText(Screen, 14, Color3.fromRGB(125, 165, 255), 1, Player.Name, true, "Tamzen") end end end) [](https://v-severe.gitbook.io/landing/reference/drawing/immediate#functions) Functions -------------------------------------------------------------------------------------------- Call inside `RunService.Render` to avoid flickering. No return values. ### [](https://v-severe.gitbook.io/landing/reference/drawing/immediate#line) Line Copy function DrawingImmediate.Line(a: Vector2, b: Vector2, color: Color3, opacity: number, segments: number, thickness: number): () Name Type Description a Vector2 Start position b Vector2 End position color Color3 Line color opacity number Opacity (0-1) segments number Line segments thickness number Line thickness * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/immediate#circle) Circle Copy function DrawingImmediate.Circle(position: Vector2, radius: number, color: Color3, opacity: number, thickness: number): () Name Type Description position Vector2 Center position radius number Circle radius color Color3 Outline color opacity number Opacity (0-1) thickness number Outline thickness * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/immediate#filledcircle) FilledCircle Copy function DrawingImmediate.FilledCircle(position: Vector2, radius: number, color: Color3, opacity: number): () Name Type Description position Vector2 Center position radius number Circle radius color Color3 Fill color opacity number Opacity (0-1) * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/immediate#triangle) Triangle Copy function DrawingImmediate.Triangle(a: Vector2, b: Vector2, c: Vector2, color: Color3, opacity: number, thickness: number): () Name Type Description a Vector2 Vertex A b Vector2 Vertex B c Vector2 Vertex C color Color3 Outline color opacity number Opacity (0-1) thickness number Outline thickness * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/immediate#filledtriangle) FilledTriangle Copy function DrawingImmediate.FilledTriangle(a: Vector2, b: Vector2, c: Vector2, color: Color3, opacity: number): () Name Type Description a Vector2 Vertex A b Vector2 Vertex B c Vector2 Vertex C color Color3 Fill color opacity number Opacity (0-1) * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/immediate#rectangle) Rectangle Copy function DrawingImmediate.Rectangle(position: Vector2, size: Vector2, color: Color3, opacity: number, thickness: number): () Name Type Description position Vector2 Top-left position size Vector2 Width/height color Color3 Outline color opacity number Opacity (0-1) thickness number Outline thickness * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/immediate#filledrectangle) FilledRectangle Copy function DrawingImmediate.FilledRectangle(position: Vector2, size: Vector2, color: Color3, opacity: number): () Name Type Description position Vector2 Top-left position size Vector2 Width/height color Color3 Fill color opacity number Opacity (0-1) * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/immediate#quad) Quad Copy function DrawingImmediate.Quad(a: Vector2, b: Vector2, c: Vector2, d: Vector2, color: Color3, opacity: number, thickness: number): () Name Type Description a Vector2 Vertex A b Vector2 Vertex B c Vector2 Vertex C d Vector2 Vertex D color Color3 Outline color opacity number Opacity (0-1) thickness number Outline thickness * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/immediate#filledquad) FilledQuad Copy function DrawingImmediate.FilledQuad(a: Vector2, b: Vector2, c: Vector2, d: Vector2, color: Color3, opacity: number): () Name Type Description a Vector2 Vertex A b Vector2 Vertex B c Vector2 Vertex C d Vector2 Vertex D color Color3 Fill color opacity number Opacity (0-1) * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/immediate#polyline) Polyline Copy function DrawingImmediate.Polyline(points: { Vector2 }, color: Color3, opacity: number, thickness: number): () Name Type Description points { Vector2} Array of points color Color3 Line color opacity number Opacity (0-1) thickness number Line thickness * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/immediate#text) Text Copy function DrawingImmediate.Text(position: Vector2, size: number, color: Color3, opacity: number, text: string, center: boolean, font: string?): () Name Type Description position Vector2 Text position size number Text size color Color3 Text color opacity number Opacity (0-1) text string Text content center boolean Center align font string? Font name (optional) * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/immediate#outlinedtext) OutlinedText Copy function DrawingImmediate.OutlinedText(position: Vector2, size: number, color: Color3, opacity: number, text: string, center: boolean, font: string?): () Name Type Description position Vector2 Text position size number Text size color Color3 Text color opacity number Opacity (0-1) text string Text content center boolean Center align font string? Font name (optional) * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/immediate#image) Image Copy function DrawingImmediate.Image(source: string, position: Vector2, size: Vector2, color: Color3, opacity: number, is_gif: boolean, rounding: number): () Name Type Description source string Image URL/source position Vector2 Image position size Vector2 Image size color Color3 Tint color opacity number Opacity (0-1) is\_gif boolean GIF animation rounding number Corner rounding * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/immediate#gettextbounds) GetTextBounds Copy function DrawingImmediate.GetTextBounds(font: string, size: number, text: string): Vector2 Name Type Description font string Font name size number Text size text string Text content Copy Vector2 Calculates text boundaries. Returns `(width, height)`. [PreviousDynamic](https://v-severe.gitbook.io/landing/reference/drawing/dynamic) [NextStatic](https://v-severe.gitbook.io/landing/reference/drawing/static) Last updated 4 months ago --- # Text | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/drawing/classes/text.md) . [](https://v-severe.gitbook.io/landing/reference/drawing/classes/text#definition) Definition ------------------------------------------------------------------------------------------------- Copy local Text = Text.new() -- Or, Drawing.new("Text") [](https://v-severe.gitbook.io/landing/reference/drawing/classes/text#properties) Properties ------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/text#visible) Visible Copy Text.Visible: boolean * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/text#color) Color Copy Text.Color: Color3 * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/text#zindex) ZIndex Copy Text.ZIndex: number Range `[-2147483647, 2147483647]`. * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/text#opacity) Opacity Copy Text.Opacity: number * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/text#text) Text Copy Text.Text: string * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/text#size) Size Copy Text.Size: number * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/text#center) Center Copy Text.Center: boolean * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/text#outline) Outline Copy Text.Outline: boolean * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/text#outlinecolor) OutlineColor Copy Text.OutlineColor: Vector3 * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/text#position) Position Copy Text.Position: Vector2 * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/text#textbounds) TextBounds Copy Text.TextBounds: Vector2 * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/text#font) Font Copy Text.Font: number Range `[0, 31]`. * * * [](https://v-severe.gitbook.io/landing/reference/drawing/classes/text#methods) Methods ------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/text#remove) Remove Copy Text:Remove(): () Permanently removes the drawing object. [PreviousSquare](https://v-severe.gitbook.io/landing/reference/drawing/classes/square) [NextTriangle](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle) Last updated 4 months ago --- # Triangle | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle.md) . [](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle#definition) Definition ----------------------------------------------------------------------------------------------------- Copy local Triangle = Triangle.new() -- Or, Drawing.new("Triangle") [](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle#properties) Properties ----------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle#visible) Visible Copy Triangle.Visible: boolean * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle#color) Color Copy Triangle.Color: Color3 * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle#zindex) ZIndex Copy Triangle.ZIndex: number Range `[-2147483647, 2147483647]`. * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle#opacity) Opacity Copy Triangle.Opacity: number * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle#transparency) Transparency Copy Triangle.Transparency: number * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle#thickness) Thickness Copy Triangle.Thickness: number * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle#pointa) PointA Copy Triangle.PointA: Vector2 * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle#pointb) PointB Copy Triangle.PointB: Vector2 * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle#pointc) PointC Copy Triangle.PointC: Vector2 * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle#filled) Filled Copy Triangle.Filled: boolean * * * [](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle#methods) Methods ----------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle#remove) Remove Copy Triangle:Remove(): () Permanently removes the drawing object. [PreviousText](https://v-severe.gitbook.io/landing/reference/drawing/classes/text) [NextDynamic](https://v-severe.gitbook.io/landing/reference/drawing/dynamic) Last updated 4 months ago --- # World | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/world.md) . [BasePart](https://v-severe.gitbook.io/landing/reference/world/basepart) [BillboardGui](https://v-severe.gitbook.io/landing/reference/world/billboardgui) [Camera](https://v-severe.gitbook.io/landing/reference/world/camera) [DataModel](https://v-severe.gitbook.io/landing/reference/world/datamodel) [Humanoid](https://v-severe.gitbook.io/landing/reference/world/humanoid) [Instance](https://v-severe.gitbook.io/landing/reference/world/instance) [Model](https://v-severe.gitbook.io/landing/reference/world/model) [Player](https://v-severe.gitbook.io/landing/reference/world/player) [Players](https://v-severe.gitbook.io/landing/reference/world/players) [RunService](https://v-severe.gitbook.io/landing/reference/world/runservice) [UserInputService](https://v-severe.gitbook.io/landing/reference/world/userinputservice) [ValueBase](https://v-severe.gitbook.io/landing/reference/world/valuebase) [Workspace](https://v-severe.gitbook.io/landing/reference/world/workspace) [PreviousStatic](https://v-severe.gitbook.io/landing/reference/drawing/static) [NextBasePart](https://v-severe.gitbook.io/landing/reference/world/basepart) Last updated 4 months ago --- # DataModel | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/world/datamodel.md) . The DataModel (accessed via the `game` global) is the root object of the game hierarchy. [](https://v-severe.gitbook.io/landing/reference/world/datamodel#httpget) HttpGet -------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#definition) Definition Copy function game:HttpGet(url: string): string ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#parameters) Parameters Name Type Description url string The URL to send a GET request to ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#returns) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#description) Description Sends an HTTP GET request to the specified URL and returns the response as a string. * * * [](https://v-severe.gitbook.io/landing/reference/world/datamodel#httppost) HttpPost ---------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#definition-1) Definition Copy function game:HttpPost(url: string, data: string): string ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#parameters-1) Parameters Name Type Description url string The URL to send a POST request to data string The data to send in the POST request ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#returns-1) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#description-1) Description Sends an HTTP POST request to the specified URL with the provided data and returns the response as a string. * * * [](https://v-severe.gitbook.io/landing/reference/world/datamodel#getservice) GetService -------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#definition-2) Definition Copy function game:GetService(name: string): Instance ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#parameters-2) Parameters Name Type Description name string The name of the service ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#returns-2) Returns Type Instance ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#description-2) Description Returns the service with the specified name. Creates the service if it doesn't exist. * * * [](https://v-severe.gitbook.io/landing/reference/world/datamodel#gethwid) GetHwid -------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#definition-3) Definition Copy function game:GetHwid(): string ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#returns-3) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#description-3) Description Returns the hardware ID of the current machine. * * * [](https://v-severe.gitbook.io/landing/reference/world/datamodel#getping) GetPing -------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#definition-4) Definition Copy function game:GetPing(): number ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#returns-4) Returns Type number ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#description-4) Description Returns the current network ping in milliseconds. * * * [](https://v-severe.gitbook.io/landing/reference/world/datamodel#placeid) PlaceId -------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#definition-5) Definition Copy game.PlaceId: number ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#description-5) Description The unique identifier for the current place (read-only). * * * [](https://v-severe.gitbook.io/landing/reference/world/datamodel#gameid) GameId ------------------------------------------------------------------------------------ ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#definition-6) Definition Copy game.GameId: number ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#description-6) Description The unique identifier for the current game (read-only). * * * [](https://v-severe.gitbook.io/landing/reference/world/datamodel#jobid) JobId ---------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#definition-7) Definition Copy game.JobId: string ### [](https://v-severe.gitbook.io/landing/reference/world/datamodel#description-7) Description The unique identifier for the current server job (read-only). [PreviousCamera](https://v-severe.gitbook.io/landing/reference/world/camera) [NextHumanoid](https://v-severe.gitbook.io/landing/reference/world/humanoid) Last updated 4 months ago --- # Unknown \# v-severe ## main - \[Landing\](https://v-severe.gitbook.io/landing/introduction/readme.md) - \[Installation\](https://v-severe.gitbook.io/landing/introduction/installation.md) - \[Glossary\](https://v-severe.gitbook.io/landing/introduction/glossary.md) - \[Core\](https://v-severe.gitbook.io/landing/reference/core.md) - \[File System\](https://v-severe.gitbook.io/landing/reference/core/file-system.md) - \[Miscellaneous\](https://v-severe.gitbook.io/landing/reference/core/miscellaneous.md) - \[Input\](https://v-severe.gitbook.io/landing/reference/core/input.md) - \[Classes\](https://v-severe.gitbook.io/landing/reference/classes.md) - \[Vector3\](https://v-severe.gitbook.io/landing/reference/classes/vector3.md) - \[Color3\](https://v-severe.gitbook.io/landing/reference/classes/color3.md) - \[WebsocketClient\](https://v-severe.gitbook.io/landing/reference/classes/websocketclient.md) - \[Signal\](https://v-severe.gitbook.io/landing/reference/classes/signal.md) - \[CFrame\](https://v-severe.gitbook.io/landing/reference/classes/cframe.md) - \[Vector2\](https://v-severe.gitbook.io/landing/reference/classes/vector2.md) - \[Libraries\](https://v-severe.gitbook.io/landing/reference/libraries.md) - \[crypt\](https://v-severe.gitbook.io/landing/reference/libraries/crypt.md) - \[luau\](https://v-severe.gitbook.io/landing/reference/libraries/luau.md) - \[memory\](https://v-severe.gitbook.io/landing/reference/libraries/memory.md) - \[task\](https://v-severe.gitbook.io/landing/reference/libraries/task.md) - \[Drawing\](https://v-severe.gitbook.io/landing/reference/drawing.md) - \[Classes\](https://v-severe.gitbook.io/landing/reference/drawing/classes.md) - \[Circle\](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle.md) - \[Image\](https://v-severe.gitbook.io/landing/reference/drawing/classes/image.md) - \[Polyline\](https://v-severe.gitbook.io/landing/reference/drawing/classes/polyline.md) - \[Square\](https://v-severe.gitbook.io/landing/reference/drawing/classes/square.md) - \[Text\](https://v-severe.gitbook.io/landing/reference/drawing/classes/text.md) - \[Triangle\](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle.md) - \[Dynamic\](https://v-severe.gitbook.io/landing/reference/drawing/dynamic.md) - \[Immediate\](https://v-severe.gitbook.io/landing/reference/drawing/immediate.md) - \[Static\](https://v-severe.gitbook.io/landing/reference/drawing/static.md) - \[World\](https://v-severe.gitbook.io/landing/reference/world.md) - \[BasePart\](https://v-severe.gitbook.io/landing/reference/world/basepart.md) - \[BillboardGui\](https://v-severe.gitbook.io/landing/reference/world/billboardgui.md) - \[Camera\](https://v-severe.gitbook.io/landing/reference/world/camera.md) - \[DataModel\](https://v-severe.gitbook.io/landing/reference/world/datamodel.md) - \[Humanoid\](https://v-severe.gitbook.io/landing/reference/world/humanoid.md) - \[Instance\](https://v-severe.gitbook.io/landing/reference/world/instance.md) - \[Model\](https://v-severe.gitbook.io/landing/reference/world/model.md) - \[Player\](https://v-severe.gitbook.io/landing/reference/world/player.md) - \[Players\](https://v-severe.gitbook.io/landing/reference/world/players.md) - \[RunService\](https://v-severe.gitbook.io/landing/reference/world/runservice.md) - \[UserInputService\](https://v-severe.gitbook.io/landing/reference/world/userinputservice.md) - \[ValueBase\](https://v-severe.gitbook.io/landing/reference/world/valuebase.md) - \[Workspace\](https://v-severe.gitbook.io/landing/reference/world/workspace.md) - \[Enumerations\](https://v-severe.gitbook.io/landing/reference/enumerations.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the \`ask\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/introduction/readme.md?ask= \`\`\` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Model | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/world/model.md) . A container object that groups together parts and other instances. [](https://v-severe.gitbook.io/landing/reference/world/model#primarypart) PrimaryPart ------------------------------------------------------------------------------------------ ### [](https://v-severe.gitbook.io/landing/reference/world/model#definition) Definition Copy Model.PrimaryPart: BasePart? ### [](https://v-severe.gitbook.io/landing/reference/world/model#description) Description The primary part of the model, which serves as the reference point for model operations, or `nil` if no primary part is set (read-only). [PreviousInstance](https://v-severe.gitbook.io/landing/reference/world/instance) [NextPlayer](https://v-severe.gitbook.io/landing/reference/world/player) Last updated 4 months ago --- # Enumerations | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/enumerations.md) . [PreviousWorkspace](https://v-severe.gitbook.io/landing/reference/world/workspace) Last updated 4 months ago --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/introduction/readme.md). # Landing Welcome to \*\*Severe's user guide\*\*, within the articles, we cover user installation, usage, and reference to our implementation of the \*\*Luau\*\*. ## Product Description \*\*Severe\*\* is an external, being one of the first on the market \*\*post-Hyperion\*\*, it is a very powerful and undetected tool on \*\*Roblox\*\*. It has a staggering, modern visuals, a flexible aimbot, and other useful tools, as well as most importantly, a \*\*Luau\*\* environment, allowing those familiar with the language to further tailor their experience. ## Tooling Before proceeding further, if you're here for \*\*Luau\*\* development, please ensure proper tooling. We recommend: \* \*\*Zed:\*\* as a code editor, it is open-source and is blazingly fast, offering alot of extensions and settings to tailor the UI, \*\*Visual Studio Code\*\* can also be used. \* \*\*Figma:\*\* for any graphical work, for example making a UI, we recommend using this, as it is a straight-forward tool allowing you to sketch and convert UI for \*\*Severe\*\*. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/introduction/readme.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Circle | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle.md) . [](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#definition) Definition --------------------------------------------------------------------------------------------------- Copy local Circle = Circle.new() -- Or, Drawing.new("Circle") [](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#properties) Properties --------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#visible) Visible Copy Circle.Visible: boolean * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#color) Color Copy Circle.Color: Color3 * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#zindex) ZIndex Copy Circle.ZIndex: number Range `[-2147483647, 2147483647]`. * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#opacity) Opacity * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#thickness) Thickness * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#numsides) NumSides * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#radius) Radius * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#filled) Filled * * * ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#position) Position * * * [](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#methods) Methods --------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#remove) Remove Permanently removes the drawing object. [PreviousClasses](https://v-severe.gitbook.io/landing/reference/drawing/classes) [NextImage](https://v-severe.gitbook.io/landing/reference/drawing/classes/image) Last updated 4 months ago * [Definition](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#definition) * [Properties](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#properties) * [Visible](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#visible) * [Color](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#color) * [ZIndex](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#zindex) * [Opacity](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#opacity) * [Thickness](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#thickness) * [NumSides](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#numsides) * [Radius](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#radius) * [Filled](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#filled) * [Position](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#position) * [Methods](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#methods) * [Remove](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle#remove) Copy Circle.Opacity: number Copy Circle.Thickness: number Copy Circle.NumSides: number Copy Circle.Radius: number Copy Circle.Filled: boolean Copy Circle.Position: Vector2 Copy Circle:Remove(): () --- # Camera | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/world/camera.md) . The Camera object controls the player's view in the game. [](https://v-severe.gitbook.io/landing/reference/world/camera#viewportsize) ViewportSize --------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/camera#definition) Definition Copy Camera.ViewportSize: Vector2 ### [](https://v-severe.gitbook.io/landing/reference/world/camera#description) Description The size of the camera's viewport in pixels (read-only). * * * [](https://v-severe.gitbook.io/landing/reference/world/camera#fieldofview) FieldOfView ------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/camera#definition-1) Definition Copy Camera.FieldOfView: number ### [](https://v-severe.gitbook.io/landing/reference/world/camera#description-1) Description The field of view of the camera in degrees (read-only). * * * [](https://v-severe.gitbook.io/landing/reference/world/camera#position) Position ------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/camera#definition-2) Definition Copy Camera.Position: Vector3 ### [](https://v-severe.gitbook.io/landing/reference/world/camera#description-2) Description The position of the camera in world space. Can be read and written. * * * [](https://v-severe.gitbook.io/landing/reference/world/camera#cframe) CFrame --------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/camera#definition-3) Definition Copy Camera.CFrame: CFrame ### [](https://v-severe.gitbook.io/landing/reference/world/camera#description-3) Description The position and orientation of the camera in world space. Can be read and written. * * * [](https://v-severe.gitbook.io/landing/reference/world/camera#velocity) Velocity ------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/camera#definition-4) Definition Copy Camera.Velocity: Vector3 ### [](https://v-severe.gitbook.io/landing/reference/world/camera#description-4) Description The current velocity of the camera. Can be read and written. * * * [](https://v-severe.gitbook.io/landing/reference/world/camera#rightvector) RightVector ------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/camera#definition-5) Definition Copy Camera.RightVector: Vector3 ### [](https://v-severe.gitbook.io/landing/reference/world/camera#description-5) Description The right vector of the camera's orientation. Can be read and written. * * * [](https://v-severe.gitbook.io/landing/reference/world/camera#upvector) UpVector ------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/camera#definition-6) Definition Copy Camera.UpVector: Vector3 ### [](https://v-severe.gitbook.io/landing/reference/world/camera#description-6) Description The up vector of the camera's orientation. Can be read and written. * * * [](https://v-severe.gitbook.io/landing/reference/world/camera#lookvector) LookVector ----------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/camera#definition-7) Definition Copy Camera.LookVector: Vector3 ### [](https://v-severe.gitbook.io/landing/reference/world/camera#description-7) Description The forward/look vector of the camera's orientation. Can be read and written. * * * [](https://v-severe.gitbook.io/landing/reference/world/camera#camerasubject) CameraSubject ----------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/camera#definition-8) Definition Copy Camera.CameraSubject: Instance? ### [](https://v-severe.gitbook.io/landing/reference/world/camera#description-8) Description The instance that the camera is focused on. Can be set to change the camera's subject. * * * [](https://v-severe.gitbook.io/landing/reference/world/camera#worldtoscreenpoint) WorldToScreenPoint --------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/camera#definition-9) Definition Copy function Camera:WorldToScreenPoint(worldPosition: Vector3): (Vector3, boolean) ### [](https://v-severe.gitbook.io/landing/reference/world/camera#parameters) Parameters Name Type Description worldPosition Vector3 The position in world space ### [](https://v-severe.gitbook.io/landing/reference/world/camera#returns) Returns Type (Vector3, boolean) ### [](https://v-severe.gitbook.io/landing/reference/world/camera#description-9) Description Converts a world position to screen coordinates. Returns a Vector3 with X and Y as screen coordinates (Z is depth), and a boolean indicating if the point is visible on screen. [PreviousBillboardGui](https://v-severe.gitbook.io/landing/reference/world/billboardgui) [NextDataModel](https://v-severe.gitbook.io/landing/reference/world/datamodel) Last updated 4 months ago --- # Instance | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/world/instance.md) . The base class for all objects in the game world. [](https://v-severe.gitbook.io/landing/reference/world/instance#gettags) GetTags ------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition) Definition Copy function Instance:GetTags(): { string } ### [](https://v-severe.gitbook.io/landing/reference/world/instance#returns) Returns Type { string } ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description) Description Returns an array of all tags assigned to this instance. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#hastag) HasTag ----------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-1) Definition Copy function Instance:HasTag(tag: string): boolean ### [](https://v-severe.gitbook.io/landing/reference/world/instance#parameters) Parameters Name Type Description tag string The tag to check for ### [](https://v-severe.gitbook.io/landing/reference/world/instance#returns-1) Returns Type boolean ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-1) Description Returns `true` if the instance has the specified tag, otherwise `false`. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#addtag) AddTag ----------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-2) Definition Copy function Instance:AddTag(tag: string): () ### [](https://v-severe.gitbook.io/landing/reference/world/instance#parameters-1) Parameters Name Type Description tag string The tag to add ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-2) Description Adds a tag to this instance. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#removetag) RemoveTag ----------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-3) Definition Copy function Instance:RemoveTag(tag: string): () ### [](https://v-severe.gitbook.io/landing/reference/world/instance#parameters-2) Parameters Name Type Description tag string The tag to remove ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-3) Description Removes a tag from this instance. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#cleartags) ClearTags ----------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-4) Definition Copy function Instance:ClearTags(): () ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-4) Description Removes all tags from this instance. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#getattributes) GetAttributes ------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-5) Definition Copy function Instance:GetAttributes(): { [string]: any } ### [](https://v-severe.gitbook.io/landing/reference/world/instance#returns-2) Returns Type { \[string\]: any } ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-5) Description Returns a dictionary of all attributes assigned to this instance. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#getattribute) GetAttribute ----------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-6) Definition Copy function Instance:GetAttribute(name: string): any ### [](https://v-severe.gitbook.io/landing/reference/world/instance#parameters-3) Parameters Name Type Description name string The attribute name ### [](https://v-severe.gitbook.io/landing/reference/world/instance#returns-3) Returns Type any ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-6) Description Returns the value of the specified attribute, or `nil` if it doesn't exist. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#setattribute) SetAttribute ----------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-7) Definition Copy function Instance:SetAttribute(name: string, value: any): () ### [](https://v-severe.gitbook.io/landing/reference/world/instance#parameters-4) Parameters Name Type Description name string The attribute name value any The attribute value ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-7) Description Sets the value of an attribute on this instance. Setting to `nil` removes the attribute. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#findfirstchild) FindFirstChild --------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-8) Definition Copy function Instance:FindFirstChild(name: string): Instance? ### [](https://v-severe.gitbook.io/landing/reference/world/instance#parameters-5) Parameters Name Type Description name string The name of the child ### [](https://v-severe.gitbook.io/landing/reference/world/instance#returns-4) Returns Type Instance? ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-8) Description Returns the first child with the specified name, or `nil` if not found. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#findfirstchildofclass) FindFirstChildOfClass ----------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-9) Definition Copy function Instance:FindFirstChildOfClass(className: string): Instance? ### [](https://v-severe.gitbook.io/landing/reference/world/instance#parameters-6) Parameters Name Type Description className string The class name ### [](https://v-severe.gitbook.io/landing/reference/world/instance#returns-5) Returns Type Instance? ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-9) Description Returns the first child of the specified class, or `nil` if not found. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#findfirstdescendant) FindFirstDescendant ------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-10) Definition Copy function Instance:FindFirstDescendant(name: string): Instance? ### [](https://v-severe.gitbook.io/landing/reference/world/instance#parameters-7) Parameters Name Type Description name string The name of the descendant ### [](https://v-severe.gitbook.io/landing/reference/world/instance#returns-6) Returns Type Instance? ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-10) Description Returns the first descendant with the specified name, or `nil` if not found. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#findfirstancestor) FindFirstAncestor --------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-11) Definition Copy function Instance:FindFirstAncestor(name: string): Instance? ### [](https://v-severe.gitbook.io/landing/reference/world/instance#parameters-8) Parameters Name Type Description name string The name of the ancestor ### [](https://v-severe.gitbook.io/landing/reference/world/instance#returns-7) Returns Type Instance? ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-11) Description Returns the first ancestor with the specified name, or `nil` if not found. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#findfirstancestorofclass) FindFirstAncestorOfClass ----------------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-12) Definition Copy function Instance:FindFirstAncestorOfClass(className: string): Instance? ### [](https://v-severe.gitbook.io/landing/reference/world/instance#parameters-9) Parameters Name Type Description className string The class name ### [](https://v-severe.gitbook.io/landing/reference/world/instance#returns-8) Returns Type Instance? ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-12) Description Returns the first ancestor of the specified class, or `nil` if not found. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#getchildren) GetChildren --------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-13) Definition Copy function Instance:GetChildren(): { Instance } ### [](https://v-severe.gitbook.io/landing/reference/world/instance#returns-9) Returns Type { Instance } ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-13) Description Returns an array of all direct children of this instance. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#getdescendants) GetDescendants --------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-14) Definition Copy function Instance:GetDescendants(): { Instance } ### [](https://v-severe.gitbook.io/landing/reference/world/instance#returns-10) Returns Type { Instance } ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-14) Description Returns an array of all descendants of this instance. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#waitforchild) WaitForChild ----------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-15) Definition Copy function Instance:WaitForChild(name: string, timeout: number?): Instance? ### [](https://v-severe.gitbook.io/landing/reference/world/instance#parameters-10) Parameters Name Type Description name string The name of the child to wait for timeout number? Optional timeout in seconds ### [](https://v-severe.gitbook.io/landing/reference/world/instance#returns-11) Returns Type Instance? ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-15) Description Waits for a child with the specified name to be added. Returns the child when found, or `nil` if timeout is reached. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#isancestorof) IsAncestorOf ----------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-16) Definition Copy function Instance:IsAncestorOf(instance: Instance): boolean ### [](https://v-severe.gitbook.io/landing/reference/world/instance#parameters-11) Parameters Name Type Description instance Instance The instance to check ### [](https://v-severe.gitbook.io/landing/reference/world/instance#returns-12) Returns Type boolean ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-16) Description Returns `true` if this instance is an ancestor of the specified instance. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#isdescendantof) IsDescendantOf --------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-17) Definition Copy function Instance:IsDescendantOf(instance: Instance): boolean ### [](https://v-severe.gitbook.io/landing/reference/world/instance#parameters-12) Parameters Name Type Description instance Instance The instance to check ### [](https://v-severe.gitbook.io/landing/reference/world/instance#returns-13) Returns Type boolean ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-17) Description Returns `true` if this instance is a descendant of the specified instance. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#destroy) Destroy ------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-18) Definition Copy function Instance:Destroy(): () ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-18) Description Destroys the instance and removes it from the game. All descendants are also destroyed. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#name) Name ------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-19) Definition Copy Instance.Name: string ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-19) Description The name of the instance. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#classname) ClassName ----------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-20) Definition Copy Instance.ClassName: string ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-20) Description The class name of the instance (read-only). * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#parent) Parent ----------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-21) Definition Copy Instance.Parent: Instance? ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-21) Description The parent instance. Can be set to `nil` or another instance. * * * [](https://v-severe.gitbook.io/landing/reference/world/instance#data) Data ------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/instance#definition-22) Definition Copy Instance.Data: any ### [](https://v-severe.gitbook.io/landing/reference/world/instance#description-22) Description Custom data storage for the instance. [PreviousHumanoid](https://v-severe.gitbook.io/landing/reference/world/humanoid) [NextModel](https://v-severe.gitbook.io/landing/reference/world/model) Last updated 4 months ago --- # UserInputService | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/world/userinputservice.md) . Service for handling user input such as mouse and keyboard. [](https://v-severe.gitbook.io/landing/reference/world/userinputservice#getmouselocation) GetMouseLocation --------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/userinputservice#definition) Definition Copy function UserInputService:GetMouseLocation(): Vector2 ### [](https://v-severe.gitbook.io/landing/reference/world/userinputservice#returns) Returns Type Vector2 ### [](https://v-severe.gitbook.io/landing/reference/world/userinputservice#description) Description Returns the current mouse position as a Vector2. * * * [](https://v-severe.gitbook.io/landing/reference/world/userinputservice#setmouselocation) SetMouseLocation --------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/userinputservice#definition-1) Definition Copy function UserInputService:SetMouseLocation(x: number, y: number): () ### [](https://v-severe.gitbook.io/landing/reference/world/userinputservice#parameters) Parameters Name Type Description x number The X coordinate y number The Y coordinate ### [](https://v-severe.gitbook.io/landing/reference/world/userinputservice#description-1) Description Sets the mouse position to the specified X and Y coordinates. * * * [](https://v-severe.gitbook.io/landing/reference/world/userinputservice#mousebehavior) MouseBehavior --------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/userinputservice#definition-2) Definition Copy UserInputService.MouseBehavior: Enum.MouseBehavior ### [](https://v-severe.gitbook.io/landing/reference/world/userinputservice#description-2) Description Controls how the mouse behaves (e.g., locked, default). Can be read and written. * * * [](https://v-severe.gitbook.io/landing/reference/world/userinputservice#mousedeltasensitivity) MouseDeltaSensitivity ------------------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/userinputservice#definition-3) Definition Copy UserInputService.MouseDeltaSensitivity: number ### [](https://v-severe.gitbook.io/landing/reference/world/userinputservice#description-3) Description The sensitivity of mouse movement delta. Can be read and written. * * * [](https://v-severe.gitbook.io/landing/reference/world/userinputservice#mouseiconenabled) MouseIconEnabled --------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/userinputservice#definition-4) Definition Copy UserInputService.MouseIconEnabled: boolean ### [](https://v-severe.gitbook.io/landing/reference/world/userinputservice#description-4) Description Determines whether the mouse icon is visible. Can be read and written. [PreviousRunService](https://v-severe.gitbook.io/landing/reference/world/runservice) [NextValueBase](https://v-severe.gitbook.io/landing/reference/world/valuebase) Last updated 4 months ago --- # Humanoid | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/world/humanoid.md) . Controls the behavior of character models, including health and movement. [](https://v-severe.gitbook.io/landing/reference/world/humanoid#health) Health ----------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/humanoid#definition) Definition Copy Humanoid.Health: number ### [](https://v-severe.gitbook.io/landing/reference/world/humanoid#description) Description The current health of the humanoid. Can be read and written. * * * [](https://v-severe.gitbook.io/landing/reference/world/humanoid#maxhealth) MaxHealth ----------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/humanoid#definition-1) Definition Copy Humanoid.MaxHealth: number ### [](https://v-severe.gitbook.io/landing/reference/world/humanoid#description-1) Description The maximum health of the humanoid. Can be read and written. [PreviousDataModel](https://v-severe.gitbook.io/landing/reference/world/datamodel) [NextInstance](https://v-severe.gitbook.io/landing/reference/world/instance) Last updated 4 months ago * [Health](https://v-severe.gitbook.io/landing/reference/world/humanoid#health) * [Definition](https://v-severe.gitbook.io/landing/reference/world/humanoid#definition) * [Description](https://v-severe.gitbook.io/landing/reference/world/humanoid#description) * [MaxHealth](https://v-severe.gitbook.io/landing/reference/world/humanoid#maxhealth) * [Definition](https://v-severe.gitbook.io/landing/reference/world/humanoid#definition-1) * [Description](https://v-severe.gitbook.io/landing/reference/world/humanoid#description-1) --- # BillboardGui | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/world/billboardgui.md) . A GUI object that is rendered in 3D space and faces the camera. [](https://v-severe.gitbook.io/landing/reference/world/billboardgui#adornee) Adornee ----------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/billboardgui#definition) Definition Copy BillboardGui.Adornee: Instance? ### [](https://v-severe.gitbook.io/landing/reference/world/billboardgui#description) Description The instance that this BillboardGui is attached to, or `nil` if not attached (read-only). [PreviousBasePart](https://v-severe.gitbook.io/landing/reference/world/basepart) [NextCamera](https://v-severe.gitbook.io/landing/reference/world/camera) Last updated 4 months ago * [Adornee](https://v-severe.gitbook.io/landing/reference/world/billboardgui#adornee) * [Definition](https://v-severe.gitbook.io/landing/reference/world/billboardgui#definition) * [Description](https://v-severe.gitbook.io/landing/reference/world/billboardgui#description) --- # crypt | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/libraries/crypt.md) . Cryptography library providing various cryptographic functions for encryption, hashing, signing, and encoding. > **Note:** All arguments for crypt functions should be assumed as strings unless otherwise specified. [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#random) Random ------------------------------------------------------------------------------------ [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.random) crypt.random ------------------------------------------------------------------------------------------------ ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition) Definition Copy function crypt.random(size: string): string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters) Parameters Name Type Description size string The size of random data to generate ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description) Description Generates cryptographically secure random bytes of the specified size. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.random_deterministic) crypt.random\_deterministic ----------------------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-1) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-1) Parameters Name Type Description size string The size of random data to generate seed string The seed for deterministic generation ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-1) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-1) Description Generates deterministic random bytes of the specified size using the provided seed. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#hash) Hash -------------------------------------------------------------------------------- [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.hash.sha256) crypt.hash.sha256 ---------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-2) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-2) Parameters Name Type Description data string The data to hash ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-2) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-2) Description Computes the SHA-256 hash of the input data. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.hash.sha512) crypt.hash.sha512 ---------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-3) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-3) Parameters Name Type Description data string The data to hash ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-3) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-3) Description Computes the SHA-512 hash of the input data. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.hash.blake2b) crypt.hash.blake2b ------------------------------------------------------------------------------------------------------------ ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-4) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-4) Parameters Name Type Description data string The data to hash ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-4) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-4) Description Computes the BLAKE2b hash of the input data. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#password-hashing) Password Hashing -------------------------------------------------------------------------------------------------------- [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.pwhash) crypt.pwhash ------------------------------------------------------------------------------------------------ ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-5) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-5) Parameters Name Type Description password string The password to hash salt string? Optional salt for hashing ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-5) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-5) Description Hashes a password using a secure password hashing algorithm. If salt is not provided, one is generated automatically. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.pwhash_str) crypt.pwhash\_str --------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-6) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-6) Parameters Name Type Description password string The password to hash ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-6) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-6) Description Hashes a password and returns a string that includes the salt and hash parameters for later verification. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.pwhash_str_verify) crypt.pwhash\_str\_verify ------------------------------------------------------------------------------------------------------------------------ ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-7) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-7) Parameters Name Type Description hash string The hash string from pwhash\_str password string The password to verify ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-7) Returns Type boolean ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-7) Description Verifies a password against a hash string created by `pwhash_str`. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#secretbox) Secretbox ------------------------------------------------------------------------------------------ [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.secretbox.seal) crypt.secretbox.seal ---------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-8) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-8) Parameters Name Type Description message string The message to encrypt nonce string The nonce (number used once) key string The secret key ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-8) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-8) Description Encrypts a message using secret-key authenticated encryption. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.secretbox.open) crypt.secretbox.open ---------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-9) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-9) Parameters Name Type Description cipher string The encrypted message nonce string The nonce (number used once) key string The secret key ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-9) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-9) Description Decrypts a message encrypted with `secretbox.seal`. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#aead) AEAD -------------------------------------------------------------------------------- [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.aead.encrypt) crypt.aead.encrypt ------------------------------------------------------------------------------------------------------------ ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-10) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-10) Parameters Name Type Description message string The message to encrypt aad string Additional authenticated data nonce string The nonce (number used once) key string The secret key ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-10) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-10) Description Encrypts a message using authenticated encryption with associated data (AEAD). * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.aead.decrypt) crypt.aead.decrypt ------------------------------------------------------------------------------------------------------------ ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-11) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-11) Parameters Name Type Description cipher string The encrypted message aad string Additional authenticated data nonce string The nonce (number used once) key string The secret key ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-11) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-11) Description Decrypts a message encrypted with `aead.encrypt`. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#public-key-box) Public-Key Box ---------------------------------------------------------------------------------------------------- [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.box.keypair) crypt.box.keypair ---------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-12) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-12) Returns Type (string, string) ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-12) Description Generates a new public-key pair for box encryption. Returns `(publicKey, secretKey)`. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.box.encrypt) crypt.box.encrypt ---------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-13) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-12) Parameters Name Type Description message string The message to encrypt nonce string The nonce (number used once) publicKey string The recipient's public key secretKey string The sender's secret key ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-13) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-13) Description Encrypts a message using public-key authenticated encryption. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.box.decrypt) crypt.box.decrypt ---------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-14) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-13) Parameters Name Type Description cipher string The encrypted message nonce string The nonce (number used once) publicKey string The sender's public key secretKey string The recipient's secret key ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-14) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-14) Description Decrypts a message encrypted with `box.encrypt`. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.box.seal) crypt.box.seal ---------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-15) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-14) Parameters Name Type Description message string The message to encrypt publicKey string The recipient's public key ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-15) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-15) Description Encrypts a message using sealed box encryption (anonymous sender). * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.box.open) crypt.box.open ---------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-16) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-15) Parameters Name Type Description cipher string The encrypted message publicKey string The recipient's public key secretKey string The recipient's secret key ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-16) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-16) Description Decrypts a message encrypted with `box.seal`. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.box.beforenm) crypt.box.beforenm ------------------------------------------------------------------------------------------------------------ ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-17) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-16) Parameters Name Type Description publicKey string The other party's public key secretKey string Your secret key ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-17) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-17) Description Computes a shared secret for faster encryption/decryption between the same parties. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#signing) Signing -------------------------------------------------------------------------------------- [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.sign.keypair) crypt.sign.keypair ------------------------------------------------------------------------------------------------------------ ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-18) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-18) Returns Type (string, string) ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-18) Description Generates a new key pair for digital signatures. Returns `(publicKey, secretKey)`. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.sign.sign) crypt.sign.sign ------------------------------------------------------------------------------------------------------ ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-19) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-17) Parameters Name Type Description message string The message to sign secretKey string The secret signing key ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-19) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-19) Description Signs a message and returns the signature concatenated with the message. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.sign.open) crypt.sign.open ------------------------------------------------------------------------------------------------------ ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-20) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-18) Parameters Name Type Description signedMessage string The signed message from sign() publicKey string The public verification key ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-20) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-20) Description Verifies and extracts the original message from a signed message. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.sign.detached) crypt.sign.detached -------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-21) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-19) Parameters Name Type Description message string The message to sign secretKey string The secret signing key ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-21) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-21) Description Signs a message and returns only the signature (detached from the message). * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.sign.verify_detached) crypt.sign.verify\_detached ----------------------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-22) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-20) Parameters Name Type Description signature string The detached signature message string The original message publicKey string The public verification key ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-22) Returns Type boolean ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-22) Description Verifies a detached signature for a message. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#base64) Base64 ------------------------------------------------------------------------------------ [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.base64.encode) crypt.base64.encode -------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-23) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-21) Parameters Name Type Description data string The data to encode ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-23) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-23) Description Encodes data to Base64 format. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.base64.decode) crypt.base64.decode -------------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-24) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-22) Parameters Name Type Description data string The Base64 data to decode ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-24) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-24) Description Decodes Base64 encoded data. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#hmac) HMAC -------------------------------------------------------------------------------- [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.hmac.sha256) crypt.hmac.sha256 ---------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-25) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-23) Parameters Name Type Description data string The data to hash key string The secret key ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-25) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-25) Description Computes an HMAC using SHA-256. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.hmac.sha512) crypt.hmac.sha512 ---------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-26) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-24) Parameters Name Type Description data string The data to hash key string The secret key ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-26) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-26) Description Computes an HMAC using SHA-512. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#hkdf) HKDF -------------------------------------------------------------------------------- [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.hkdf.sha256) crypt.hkdf.sha256 ---------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-27) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-25) Parameters Name Type Description key string The input keying material salt string The salt value info string The context and application info ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-27) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-27) Description Derives a key using HKDF (HMAC-based Key Derivation Function) with SHA-256. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#json) JSON -------------------------------------------------------------------------------- [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.json.encode) crypt.json.encode ---------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-28) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-26) Parameters Name Type Description data table The table to encode ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-28) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-28) Description Encodes a Luau table to a JSON string. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.json.decode) crypt.json.decode ---------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-29) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-27) Parameters Name Type Description json string The JSON string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-29) Returns Type table ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-29) Description Decodes a JSON string to a Luau table. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#hexadecimal) Hexadecimal ---------------------------------------------------------------------------------------------- [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.hexadecimal.encode) crypt.hexadecimal.encode ------------------------------------------------------------------------------------------------------------------------ ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-30) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-28) Parameters Name Type Description bytes string The bytes to encode ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-30) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-30) Description Encodes bytes to hexadecimal string representation. * * * [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.hexadecimal.decode) crypt.hexadecimal.decode ------------------------------------------------------------------------------------------------------------------------ ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-31) Definition ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-29) Parameters Name Type Description hex string The hexadecimal string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-31) Returns Type string ### [](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-31) Description Decodes a hexadecimal string to bytes. [PreviousLibraries](https://v-severe.gitbook.io/landing/reference/libraries) [Nextluau](https://v-severe.gitbook.io/landing/reference/libraries/luau) Last updated 4 months ago * [Random](https://v-severe.gitbook.io/landing/reference/libraries/crypt#random) * [crypt.random](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.random) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description) * [crypt.random\_deterministic](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.random_deterministic) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-1) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-1) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-1) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-1) * [Hash](https://v-severe.gitbook.io/landing/reference/libraries/crypt#hash) * [crypt.hash.sha256](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.hash.sha256) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-2) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-2) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-2) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-2) * [crypt.hash.sha512](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.hash.sha512) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-3) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-3) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-3) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-3) * [crypt.hash.blake2b](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.hash.blake2b) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-4) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-4) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-4) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-4) * [Password Hashing](https://v-severe.gitbook.io/landing/reference/libraries/crypt#password-hashing) * [crypt.pwhash](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.pwhash) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-5) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-5) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-5) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-5) * [crypt.pwhash\_str](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.pwhash_str) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-6) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-6) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-6) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-6) * [crypt.pwhash\_str\_verify](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.pwhash_str_verify) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-7) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-7) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-7) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-7) * [Secretbox](https://v-severe.gitbook.io/landing/reference/libraries/crypt#secretbox) * [crypt.secretbox.seal](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.secretbox.seal) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-8) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-8) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-8) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-8) * [crypt.secretbox.open](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.secretbox.open) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-9) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-9) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-9) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-9) * [AEAD](https://v-severe.gitbook.io/landing/reference/libraries/crypt#aead) * [crypt.aead.encrypt](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.aead.encrypt) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-10) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-10) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-10) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-10) * [crypt.aead.decrypt](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.aead.decrypt) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-11) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-11) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-11) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-11) * [Public-Key Box](https://v-severe.gitbook.io/landing/reference/libraries/crypt#public-key-box) * [crypt.box.keypair](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.box.keypair) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-12) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-12) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-12) * [crypt.box.encrypt](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.box.encrypt) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-13) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-12) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-13) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-13) * [crypt.box.decrypt](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.box.decrypt) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-14) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-13) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-14) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-14) * [crypt.box.seal](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.box.seal) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-15) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-14) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-15) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-15) * [crypt.box.open](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.box.open) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-16) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-15) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-16) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-16) * [crypt.box.beforenm](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.box.beforenm) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-17) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-16) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-17) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-17) * [Signing](https://v-severe.gitbook.io/landing/reference/libraries/crypt#signing) * [crypt.sign.keypair](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.sign.keypair) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-18) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-18) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-18) * [crypt.sign.sign](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.sign.sign) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-19) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-17) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-19) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-19) * [crypt.sign.open](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.sign.open) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-20) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-18) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-20) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-20) * [crypt.sign.detached](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.sign.detached) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-21) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-19) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-21) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-21) * [crypt.sign.verify\_detached](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.sign.verify_detached) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-22) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-20) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-22) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-22) * [Base64](https://v-severe.gitbook.io/landing/reference/libraries/crypt#base64) * [crypt.base64.encode](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.base64.encode) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-23) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-21) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-23) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-23) * [crypt.base64.decode](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.base64.decode) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-24) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-22) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-24) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-24) * [HMAC](https://v-severe.gitbook.io/landing/reference/libraries/crypt#hmac) * [crypt.hmac.sha256](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.hmac.sha256) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-25) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-23) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-25) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-25) * [crypt.hmac.sha512](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.hmac.sha512) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-26) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-24) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-26) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-26) * [HKDF](https://v-severe.gitbook.io/landing/reference/libraries/crypt#hkdf) * [crypt.hkdf.sha256](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.hkdf.sha256) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-27) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-25) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-27) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-27) * [JSON](https://v-severe.gitbook.io/landing/reference/libraries/crypt#json) * [crypt.json.encode](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.json.encode) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-28) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-26) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-28) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-28) * [crypt.json.decode](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.json.decode) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-29) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-27) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-29) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-29) * [Hexadecimal](https://v-severe.gitbook.io/landing/reference/libraries/crypt#hexadecimal) * [crypt.hexadecimal.encode](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.hexadecimal.encode) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-30) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-28) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-30) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-30) * [crypt.hexadecimal.decode](https://v-severe.gitbook.io/landing/reference/libraries/crypt#crypt.hexadecimal.decode) * [Definition](https://v-severe.gitbook.io/landing/reference/libraries/crypt#definition-31) * [Parameters](https://v-severe.gitbook.io/landing/reference/libraries/crypt#parameters-29) * [Returns](https://v-severe.gitbook.io/landing/reference/libraries/crypt#returns-31) * [Description](https://v-severe.gitbook.io/landing/reference/libraries/crypt#description-31) Copy function crypt.random_deterministic(size: string, seed: string): string Copy function crypt.hash.sha256(data: string): string Copy function crypt.hash.sha512(data: string): string Copy function crypt.hash.blake2b(data: string): string Copy function crypt.pwhash(password: string, salt: string?): string Copy function crypt.pwhash_str(password: string): string Copy function crypt.pwhash_str_verify(hash: string, password: string): boolean Copy function crypt.secretbox.seal(message: string, nonce: string, key: string): string Copy function crypt.secretbox.open(cipher: string, nonce: string, key: string): string Copy function crypt.aead.encrypt(message: string, aad: string, nonce: string, key: string): string Copy function crypt.aead.decrypt(cipher: string, aad: string, nonce: string, key: string): string Copy function crypt.box.keypair(): (string, string) Copy function crypt.box.encrypt(message: string, nonce: string, publicKey: string, secretKey: string): string Copy function crypt.box.decrypt(cipher: string, nonce: string, publicKey: string, secretKey: string): string Copy function crypt.box.seal(message: string, publicKey: string): string Copy function crypt.box.open(cipher: string, publicKey: string, secretKey: string): string Copy function crypt.box.beforenm(publicKey: string, secretKey: string): string Copy function crypt.sign.keypair(): (string, string) Copy function crypt.sign.sign(message: string, secretKey: string): string Copy function crypt.sign.open(signedMessage: string, publicKey: string): string Copy function crypt.sign.detached(message: string, secretKey: string): string Copy function crypt.sign.verify_detached(signature: string, message: string, publicKey: string): boolean Copy function crypt.base64.encode(data: string): string Copy function crypt.base64.decode(data: string): string Copy function crypt.hmac.sha256(data: string, key: string): string Copy function crypt.hmac.sha512(data: string, key: string): string Copy function crypt.hkdf.sha256(key: string, salt: string, info: string): string Copy function crypt.json.encode(data: table): string Copy function crypt.json.decode(json: string): table Copy function crypt.hexadecimal.encode(bytes: string): string Copy function crypt.hexadecimal.decode(hex: string): string --- # BasePart | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/world/basepart.md) . BasePart is the base class for all physical part objects in the game world. [](https://v-severe.gitbook.io/landing/reference/world/basepart#applies-to) Applies To ------------------------------------------------------------------------------------------- * Part * MeshPart * UnionOperation * SpawnLocation * CornerWedgePart * TrussPart * WedgePart [](https://v-severe.gitbook.io/landing/reference/world/basepart#cancollide) CanCollide ------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#definition) Definition Copy BasePart.CanCollide: boolean ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#description) Description Determines whether the part can collide with other parts. Can be read and written. * * * [](https://v-severe.gitbook.io/landing/reference/world/basepart#transparency) Transparency ----------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-1) Definition ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#description-1) Description The transparency of the part, ranging from 0 (opaque) to 1 (fully transparent). Can be read and written. * * * [](https://v-severe.gitbook.io/landing/reference/world/basepart#size) Size ------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-2) Definition ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#description-2) Description The size of the part in studs. Can be read and written. * * * [](https://v-severe.gitbook.io/landing/reference/world/basepart#position) Position --------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-3) Definition ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#description-3) Description The position of the part in world space. Can be read and written. * * * [](https://v-severe.gitbook.io/landing/reference/world/basepart#cframe) CFrame ----------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-4) Definition ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#description-4) Description The position and orientation of the part in world space. Can be read and written. * * * [](https://v-severe.gitbook.io/landing/reference/world/basepart#velocity) Velocity --------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-5) Definition ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#description-5) Description The current velocity of the part. Can be read and written. * * * [](https://v-severe.gitbook.io/landing/reference/world/basepart#rightvector) RightVector --------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-6) Definition ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#description-6) Description The right vector of the part's orientation (read-only). * * * [](https://v-severe.gitbook.io/landing/reference/world/basepart#upvector) UpVector --------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-7) Definition ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#description-7) Description The up vector of the part's orientation (read-only). * * * [](https://v-severe.gitbook.io/landing/reference/world/basepart#lookvector) LookVector ------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-8) Definition ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#description-8) Description The forward/look vector of the part's orientation (read-only). * * * [](https://v-severe.gitbook.io/landing/reference/world/basepart#isnetworksleeping) IsNetworkSleeping --------------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-9) Definition ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#description-9) Description Indicates whether the part is currently network sleeping (read-only). * * * [](https://v-severe.gitbook.io/landing/reference/world/basepart#description-10) Description ------------------------------------------------------------------------------------------------ ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-10) Definition ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#description-11) Description A user-defined description for the part. Can be read and written. * * * [](https://v-severe.gitbook.io/landing/reference/world/basepart#textureid) TextureId ----------------------------------------------------------------------------------------- **Applies to: MeshPart, SpecialMesh** ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-11) Definition ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#description-12) Description The asset ID of the texture applied to the mesh. Can be read and written. * * * [](https://v-severe.gitbook.io/landing/reference/world/basepart#meshid) MeshId ----------------------------------------------------------------------------------- **Applies to: MeshPart, SpecialMesh** ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-12) Definition ### [](https://v-severe.gitbook.io/landing/reference/world/basepart#description-13) Description The asset ID of the mesh geometry. Can be read and written. [PreviousWorld](https://v-severe.gitbook.io/landing/reference/world) [NextBillboardGui](https://v-severe.gitbook.io/landing/reference/world/billboardgui) Last updated 4 months ago * [Applies To](https://v-severe.gitbook.io/landing/reference/world/basepart#applies-to) * [CanCollide](https://v-severe.gitbook.io/landing/reference/world/basepart#cancollide) * [Definition](https://v-severe.gitbook.io/landing/reference/world/basepart#definition) * [Description](https://v-severe.gitbook.io/landing/reference/world/basepart#description) * [Transparency](https://v-severe.gitbook.io/landing/reference/world/basepart#transparency) * [Definition](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-1) * [Description](https://v-severe.gitbook.io/landing/reference/world/basepart#description-1) * [Size](https://v-severe.gitbook.io/landing/reference/world/basepart#size) * [Definition](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-2) * [Description](https://v-severe.gitbook.io/landing/reference/world/basepart#description-2) * [Position](https://v-severe.gitbook.io/landing/reference/world/basepart#position) * [Definition](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-3) * [Description](https://v-severe.gitbook.io/landing/reference/world/basepart#description-3) * [CFrame](https://v-severe.gitbook.io/landing/reference/world/basepart#cframe) * [Definition](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-4) * [Description](https://v-severe.gitbook.io/landing/reference/world/basepart#description-4) * [Velocity](https://v-severe.gitbook.io/landing/reference/world/basepart#velocity) * [Definition](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-5) * [Description](https://v-severe.gitbook.io/landing/reference/world/basepart#description-5) * [RightVector](https://v-severe.gitbook.io/landing/reference/world/basepart#rightvector) * [Definition](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-6) * [Description](https://v-severe.gitbook.io/landing/reference/world/basepart#description-6) * [UpVector](https://v-severe.gitbook.io/landing/reference/world/basepart#upvector) * [Definition](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-7) * [Description](https://v-severe.gitbook.io/landing/reference/world/basepart#description-7) * [LookVector](https://v-severe.gitbook.io/landing/reference/world/basepart#lookvector) * [Definition](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-8) * [Description](https://v-severe.gitbook.io/landing/reference/world/basepart#description-8) * [IsNetworkSleeping](https://v-severe.gitbook.io/landing/reference/world/basepart#isnetworksleeping) * [Definition](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-9) * [Description](https://v-severe.gitbook.io/landing/reference/world/basepart#description-9) * [Description](https://v-severe.gitbook.io/landing/reference/world/basepart#description-10) * [Definition](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-10) * [Description](https://v-severe.gitbook.io/landing/reference/world/basepart#description-11) * [TextureId](https://v-severe.gitbook.io/landing/reference/world/basepart#textureid) * [Definition](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-11) * [Description](https://v-severe.gitbook.io/landing/reference/world/basepart#description-12) * [MeshId](https://v-severe.gitbook.io/landing/reference/world/basepart#meshid) * [Definition](https://v-severe.gitbook.io/landing/reference/world/basepart#definition-12) * [Description](https://v-severe.gitbook.io/landing/reference/world/basepart#description-13) Copy BasePart.Transparency: number Copy BasePart.Size: Vector3 Copy BasePart.Position: Vector3 Copy BasePart.CFrame: CFrame Copy BasePart.Velocity: Vector3 Copy BasePart.RightVector: Vector3 Copy BasePart.UpVector: Vector3 Copy BasePart.LookVector: Vector3 Copy BasePart.IsNetworkSleeping: boolean Copy BasePart.Description: string Copy MeshPart.TextureId: string SpecialMesh.TextureId: string Copy MeshPart.MeshId: string SpecialMesh.MeshId: string --- # RunService | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/world/runservice.md) . [PreviousPlayers](https://v-severe.gitbook.io/landing/reference/world/players) [NextUserInputService](https://v-severe.gitbook.io/landing/reference/world/userinputservice) Last updated 4 months ago --- # Workspace | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/world/workspace.md) . The Workspace service contains all of the physical objects in the game world. [](https://v-severe.gitbook.io/landing/reference/world/workspace#currentcamera) CurrentCamera -------------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/workspace#definition) Definition Copy workspace.CurrentCamera: Camera? ### [](https://v-severe.gitbook.io/landing/reference/world/workspace#description) Description The current camera being used for rendering, or `nil` if no camera is set (read-only). [PreviousValueBase](https://v-severe.gitbook.io/landing/reference/world/valuebase) [NextEnumerations](https://v-severe.gitbook.io/landing/reference/enumerations) Last updated 4 months ago * [CurrentCamera](https://v-severe.gitbook.io/landing/reference/world/workspace#currentcamera) * [Definition](https://v-severe.gitbook.io/landing/reference/world/workspace#definition) * [Description](https://v-severe.gitbook.io/landing/reference/world/workspace#description) --- # Players | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/world/players.md) . The Players service manages all players in the game. [](https://v-severe.gitbook.io/landing/reference/world/players#localplayer) LocalPlayer -------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/players#definition) Definition Copy Players.LocalPlayer: Player? ### [](https://v-severe.gitbook.io/landing/reference/world/players#description) Description Returns the local player (the player running the script), or `nil` if accessed from the server (read-only). [PreviousPlayer](https://v-severe.gitbook.io/landing/reference/world/player) [NextRunService](https://v-severe.gitbook.io/landing/reference/world/runservice) Last updated 4 months ago * [LocalPlayer](https://v-severe.gitbook.io/landing/reference/world/players#localplayer) * [Definition](https://v-severe.gitbook.io/landing/reference/world/players#definition) * [Description](https://v-severe.gitbook.io/landing/reference/world/players#description) --- # ValueBase | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/world/valuebase.md) . Value objects are instances that store a single value of a specific type. [](https://v-severe.gitbook.io/landing/reference/world/valuebase#applies-to) Applies To -------------------------------------------------------------------------------------------- * BoolValue * IntValue * NumberValue * Vector3Value * ObjectValue * StringValue * CFrameValue [](https://v-severe.gitbook.io/landing/reference/world/valuebase#value) Value ---------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/valuebase#definition) Definition Depends on the ValueBase type: Copy BoolValue.Value: boolean IntValue.Value: number NumberValue.Value: number Vector3Value.Value: Vector3 ObjectValue.Value: Instance? StringValue.Value: string CFrameValue.Value: CFrame ### [](https://v-severe.gitbook.io/landing/reference/world/valuebase#description) Description The value stored by this value object. Can be read and written. [PreviousUserInputService](https://v-severe.gitbook.io/landing/reference/world/userinputservice) [NextWorkspace](https://v-severe.gitbook.io/landing/reference/world/workspace) Last updated 4 months ago * [Applies To](https://v-severe.gitbook.io/landing/reference/world/valuebase#applies-to) * [Value](https://v-severe.gitbook.io/landing/reference/world/valuebase#value) * [Definition](https://v-severe.gitbook.io/landing/reference/world/valuebase#definition) * [Description](https://v-severe.gitbook.io/landing/reference/world/valuebase#description) --- # Player | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/world/player.md) . Represents a player in the game. [](https://v-severe.gitbook.io/landing/reference/world/player#displayname) DisplayName ------------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/player#definition) Definition Copy Player.DisplayName: string ### [](https://v-severe.gitbook.io/landing/reference/world/player#description) Description The display name of the player (read-only). * * * [](https://v-severe.gitbook.io/landing/reference/world/player#userid) UserId --------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/player#definition-1) Definition Copy Player.UserId: number ### [](https://v-severe.gitbook.io/landing/reference/world/player#description-1) Description The unique user ID of the player (read-only). * * * [](https://v-severe.gitbook.io/landing/reference/world/player#character) Character --------------------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/player#definition-2) Definition ### [](https://v-severe.gitbook.io/landing/reference/world/player#description-2) Description The player's character model in the game, or `nil` if the player doesn't have a character (read-only). * * * [](https://v-severe.gitbook.io/landing/reference/world/player#team) Team ----------------------------------------------------------------------------- ### [](https://v-severe.gitbook.io/landing/reference/world/player#definition-3) Definition ### [](https://v-severe.gitbook.io/landing/reference/world/player#description-3) Description The team the player is currently on, or `nil` if not on a team (read-only). [PreviousModel](https://v-severe.gitbook.io/landing/reference/world/model) [NextPlayers](https://v-severe.gitbook.io/landing/reference/world/players) Last updated 4 months ago * [DisplayName](https://v-severe.gitbook.io/landing/reference/world/player#displayname) * [Definition](https://v-severe.gitbook.io/landing/reference/world/player#definition) * [Description](https://v-severe.gitbook.io/landing/reference/world/player#description) * [UserId](https://v-severe.gitbook.io/landing/reference/world/player#userid) * [Definition](https://v-severe.gitbook.io/landing/reference/world/player#definition-1) * [Description](https://v-severe.gitbook.io/landing/reference/world/player#description-1) * [Character](https://v-severe.gitbook.io/landing/reference/world/player#character) * [Definition](https://v-severe.gitbook.io/landing/reference/world/player#definition-2) * [Description](https://v-severe.gitbook.io/landing/reference/world/player#description-2) * [Team](https://v-severe.gitbook.io/landing/reference/world/player#team) * [Definition](https://v-severe.gitbook.io/landing/reference/world/player#definition-3) * [Description](https://v-severe.gitbook.io/landing/reference/world/player#description-3) Copy Player.Character: Model? Copy Player.Team: Team? --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/introduction/installation.md). # Installation ## Overview > In this article, we will cover installing Severe, and the most common issues users face in the process. ## Requirements \* \*\*Windows 10/11:\*\* Note that for some newer versions of \*\*Windows 11\*\* might not work, you should verify in the purchase channel on the Discord server. We also don't promise tweaked re-distributions of Windows to work out of the box, few that have been tested are: \*\*Atlas\*\*, and \*\*XOS\*\*. \* \*\*Internet Connection\*\* \* \*\*Turned off anti-virus:\*\* both Windows Defender, and user-installed anti-viruses can interfere with \*\*Severe\*\*. We recommend using \[\*\*Winaero Tweaker\*\*\](https://winaerotweaker.com/) or \\\[\*\*Defender Control\*\*\]\\\[\] ### Redistributes This is needed to be installed \*\*before\*\* Severe for smoother experience, and also to fix some of the problems (for example: the overlay not showing up). \* \[DirectX End-User Runtime\](https://www.microsoft.com/en-us/download/details.aspx?id=8109) \* \[.NET SDK\](https://dotnet.microsoft.com/en-us/download) \* \[Visual C++ Runtime\](https://www.techpowerup.com/download/visual-c-redistributable-runtime-package-all-in-one/) ## Downloading Install \*\*severe.rar\*\* from the \`#downloads\` channel on the official Discord server, afterwards continue by \*\*extracting\*\*, and \*\*running the upgrade.exe\*\* file. After, you should see a new file in the same folder as \*\*upgrade.exe\*\* called \*\*software.exe\*\*, this is your primary executable that \*\*you should be running to launch Severe.\*\* Run \*\*software.exe\*\*, and ideally, after a bit of waiting, you should see an overlay on \*\*Roblox\*\* asking you to either \*\*log-in\*\* or \*\*register\*\*. If you're a first time user, please continue with registering, a few key details however: \* \*\*Note down your username and password:\*\* this is critical to ensure that your account won't get lost. \* \*\*Avoid special characters:\*\* spaces, symbols should be avoided at all cost, please use an alphanumeric password consisting of letters \*\*A-Z\*\*, and \*\*0-9\*\* numbers. ## Issues ### HWID Mismatch We utilize \*\*HWID\*\* to provide a secure connection from your machine to our servers, changing a part in your PC can sometimes cause this to change. In this case, please navigate to our \[Keyauth Page\](https://keyauth.cc/panel/SHELUV\_PERKS/v-severe) and press \*\*"Reset HWID"\*\*. ### Executable not opening This is a frequent issue with custom file explorers, please use the native file explorer or utilize the command prompt to open the file. ### Loading Loop / Bad Post Code Incase \*\*Severe\*\* is stuck whilst loading, the most frequent resolution is disabling your anti-virus software, such as \*\*Malwarebytes\*\*, or \*\*Avast\*\*. ### GLFW Error Reopen \*\*Severe\*\* with \*\*Roblox window focused\*\*. ### D3DCompiler\\\_43.dll Download this \[file\](https://www.dll-files.com/download/0c20f567e2e586f6bcf3f0ce3ae64aab/d3dcompiler\_43.dll.html?c=Yko1VjlUSWd4WFJaZ2w5OG1hQjFVQT09) and move it into \`C:/Windows/System32\`. ### HTTPs Verification Failed Use \[\*\*Cloudflare's 1.1.1.1\*\*\](https://one.one.one.one/) or a VPN. ### This app can't run on your PC Disable all anti-viruses, redownload \*\*Severe\*\* and run \*\*upgrade.exe\*\*. ### Hosts First, download \[this file\](https://pixeldrain.com/u/jWJfBB3Q), afterwards, move it to \`C:/Windows/System32/Drivers/etc\`. ### Don't see your issue? Contact support via the official \*\*Discord server\*\*, and please, remain patient. In edge cases, where a new-user can't get their \*\*Severe\*\* working, and hasn't registered an account before, a refund can be negotiated. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/introduction/installation.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/introduction/glossary.md). # Glossary ## \[Luau\](https://luau.org/) (pronounced "LOO-ow") is a scripting language, derived from \*\*Lua 5.1\*\*, key features of it are \*\*performance\*\*, \*\*type checking\*\*, \*\*syntax additions\*\*, and \*\*safety\*\*. It's used in \*\*Roblox\*\* as the primary scripting language for games, as well as in \*\*Warframe\*\*, and \*\*Alan Wake 2\*\*. ## \[HWID\](https://en.wikipedia.org/wiki/Device\_fingerprint) Often used for authentication, it's a unique identifier assigned to hardware components of a computer. ## \[RAM\](https://en.wikipedia.org/wiki/Random-access\_memory) Digital, "short-term memory" in which games store live data, such as player health, position, etc. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/introduction/glossary.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/core/miscellaneous.md). # Miscellaneous ## isrbxactive ### Definition \`\`\`luau function isrbxactive(): boolean \`\`\` ### Returns
Type
boolean
### Description Will return \`true\` if the currently focused window is \*\*Roblox\*\*, otherwise returns \`false\`. \*\*\* ## send\\\_notification ### Definition \`\`\`luau function send\_notification(content: string): () \`\`\` ### Parameters | Name | Type | Description | | :-----: | :----: | :-----------------------------------------------------: | | content | string | Message, that you want to be visualized on the overlay. | ### Description This will visualize \`content\` on the screen thru an notification on the overlay. ### Code Samples \`\`\`luau send\_notification 'Hello, world!' \`\`\` \*\*\* ## setclipboard ### Definition \`\`\`luau function setclipboard(content: string): () \`\`\` ### Parameters | Name | Type | Description | | ------- | ------ | -------------------------------------------------- | | content | string | Whatever you want to be copied into the clipboard. | ### Description This will essentially copy the string to your system's clipboard. ### Code Samples \`\`\`luau setclipboard 'Clipboard!' \`\`\` \*\*\* ## block\\\_roblox\\\_window ### Definition \`\`\`luau function block\_roblox\_window(state: boolean): () \`\`\` ### Parameters | Name | Type | Description | | ----- | ------- | ------------------------------------------------------------ | | state | boolean | Whether or not you're trying to block or unblock the window. | ### Description Will effectively disable input pass-through on the overlay, forcing you to interact with \*\*it\*\* rather than the game. This is useful when creating custom a user-interface. \*\*\* ## pointer\\\_to\\\_userdata ### Definition \`\`\`luau function pointer\_to\_userdata(address: number): userdata \`\`\` ### Parameters | Name | Type | Description | | ------- | ------ | -------------------------------------------------- | | address | number | The address that you want to turn into a userdata. | ### Returns
Type
userdata
### Description This is a useful function that you'll find yourself utilizing when interacting with the memory functions. This will effectively turn valid addresses back into \*\*wolurld objects\*\*, allowing you to index/namecall them. ### Code Samples \`\`\`luau -- Find the DataModel by reading Workspace's parent offset, and then recasting it back to userdata. local Parent = memory.readu64(workspace, 0x50) local DataModel = pointer\_to\_userdata(Parent) print(DataModel == game) -- Ideally, would be true, however due to version changes, 0x50 might be an invalid offset. \`\`\` \*\*\* ## get\\\_overlay\\\_fps ### Definition \`\`\`luau function get\_overlay\_fps(): number \`\`\` ### Returns
Type
number
### Description Returns the number amount of \*\*FPS\*\* (frames per second) that the overlay is currently running at. \*\*\* ## is\\\_forcefield\\\_check\\\_active ### Definition \`\`\`luau function is\_forcefield\_check\_active(): boolean \`\`\` ### Returns
Type
boolean
### Description Returns a boolean (true/false) based if the player has \*\*Forcefield Check\*\* on in their settings. \*\*\* ## is\\\_local\\\_health\\\_check\\\_active ### Definition \`\`\`luau function is\_local\_health\_check\_active(): boolean \`\`\` ### Returns
Type
boolean
### Description Returns a boolean (true/false) based if the player has \*\*Health Check\*\* on in their settings. \*\*\* ## is\\\_team\\\_check\\\_active ### Definition \`\`\`luau function is\_team\_check\_active(): boolean \`\`\` ### Returns
Type
boolean
### Description Returns a boolean (true/false) based if the player has \*\*Team Check\*\* on in their settings. \*\*\* ## add\\\_model\\\_data ### Definition \`\`\`luau function add\_model\_data(data: table, key: string): boolean \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | data | table | Character data structure with fields like \`Username\` (string), \`Displayname\` (string), \`Userid\` (number), \`Character\` (Instance), \`PrimaryPart\` (Instance), \`Head\` (Instance), \`LeftLeg\` (Instance), \`LeftArm\` (Instance), \`RightLeg\` (Instance), \`RightArm\` (Instance), \`Torso\` (Instance), \`ToolName\` (string), \`TeamName\` (string), \`BodyHeightScale\` (number), \`RigType\` (number), \`Whitelisted\` (boolean), \`Archenemies\` (boolean), \`Aimbot\_Part\` (Instance), \`Aimbot\_TP\_Part\` (Instance), \`Triggerbot\_Part\` (Instance), \`Health\` (number), \`MaxHealth\` (number), \`body\_parts\_data\` (table), \`full\_body\_data\` (table). | | key | string | Unique identifier for storing the model data. | ### Returns
Type
boolean
### Description Declares a new character model data under the given key for use in targeting and ESP. Processed in a dedicated model thread, and will return \`true\` on success. ### Code Samples \`\`\`luau local data = { Username = "Player1", Displayname = "CoolPlayer", Userid = 123456, Character = workspace.Player1.Character, PrimaryPart = workspace.Player1.Character.HumanoidRootPart, -- ... other fields } add\_model\_data(data, "player1\_key") \`\`\` \*\*\* ## edit\\\_model\\\_data ### Definition \`\`\`luau function edit\_model\_data(data: table, key: string): boolean \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | data | table | Partial updates with fields like \`RigType\` (number), \`Whitelisted\` (boolean), \`Archenemies\` (boolean), \`Aimbot\_Part\` (Instance), \`Aimbot\_TP\_Part\` (Instance), \`Triggerbot\_Part\` (Instance), \`Health\` (number), \`MaxHealth\` (number), \`BodyHeightScale\` (number). | | key | string | Key of existing model data to update. | ### Returns
Type
boolean
### Description Updates specific fields in existing model data stored under the key. Efficient for runtime changes like health or target parts. Returns \`true\` on success. ### Code Samples \`\`\`luau local edit = { Health = 50, Aimbot\_Part = workspace.Player1.Character.Head } edit\_model\_data(edit, "player1\_key") \`\`\` \*\*\* ## remove\\\_model\\\_data ### Definition \`\`\`luau function remove\_model\_data(key: string): boolean \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | -------------------------------- | | key | string | Key of the model data to remove. | ### Returns
Type
boolean
### Description Deletes specific model data by key. Returns \`true\` on success. \*\*\* ## clear\\\_model\\\_data ### Definition \`\`\`luau function clear\_model\_data(): boolean \`\`\` ### Returns
Type
boolean
### Description Removes all stored model data. Returns \`true\` on success. \*\*\* ## override\\\_local\\\_data ### Definition \`\`\`luau function override\_local\_data(data: table): boolean \`\`\` ### Parameters | Name | Type | Description | | ---- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | data | table | Local player data with fields like \`LocalPlayer\` (userdata), \`Displayname\` (string), \`Username\` (string), \`Userid\` (number), \`Character\` (userdata), \`Team\` (userdata), \`RootPart\` (userdata), \`LeftFoot\` (userdata), \`Head\` (userdata), \`LowerTorso\` (userdata), \`Tool\` (userdata), \`Humanoid\` (userdata), \`Health\` (number), \`MaxHealth\` (number), \`RigType\` (number). | ### Returns
Type
boolean
### Description Sets or overrides local player data for UI rendering and local thread processing. Returns \`true\` on success. ### Code Samples \`\`\`luau local data = { LocalPlayer = game.Players.LocalPlayer, Character = game.Players.LocalPlayer.Character, -- ... other fields } override\_local\_data(data) \`\`\` \*\*\* ## clear\\\_local\\\_data ### Definition \`\`\`luau function clear\_local\_data(): boolean \`\`\` ### Returns
Type
boolean
### Description Clears all local player data. Returns \`true\` on success. ## ismenuopened ### Definition \`\`\`luau function ismenuopened(): boolean \`\`\` ### Returns
Type
boolean
### Description Whether the menu is opened returns \`true\`, otherwise \`false\`. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/core/miscellaneous.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/core.md). # Core - \[File System\](https://v-severe.gitbook.io/landing/reference/core/file-system.md) - \[Miscellaneous\](https://v-severe.gitbook.io/landing/reference/core/miscellaneous.md) - \[Input\](https://v-severe.gitbook.io/landing/reference/core/input.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/core.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/classes.md). # Classes - \[Vector3\](https://v-severe.gitbook.io/landing/reference/classes/vector3.md) - \[Color3\](https://v-severe.gitbook.io/landing/reference/classes/color3.md) - \[WebsocketClient\](https://v-severe.gitbook.io/landing/reference/classes/websocketclient.md) - \[Signal\](https://v-severe.gitbook.io/landing/reference/classes/signal.md) - \[CFrame\](https://v-severe.gitbook.io/landing/reference/classes/cframe.md) - \[Vector2\](https://v-severe.gitbook.io/landing/reference/classes/vector2.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/classes.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/core/input.md). # Input ## keypress ### Definition \`\`\`luau function keypress(keycode: number): () \`\`\` ### Parameters | Name | Type | Description | | ------- | ------ | ------------------------ | | keycode | number | Virtual keycode to press | ### Description Simulates a key press for the given virtual keycode. > \*\*Note:\*\* Virtual key codes: \[Microsoft Docs\](https://docs.microsoft.com/en-us/windows/desktop/inputdev/virtual-key-codes) \*\*\* ## keyrelease ### Definition \`\`\`luau function keyrelease(keycode: number): () \`\`\` ### Parameters | Name | Type | Description | | ------- | ------ | -------------------------- | | keycode | number | Virtual keycode to release | ### Description Simulates a key release for the given virtual keycode. \*\*\* ## getpressedkey ### Definition \`\`\`luau function getpressedkey(): string \`\`\` ### Returns \`\`\`horizontal ### string \`\`\` ### Description Returns the name of the last pressed key. \*\*\* ## getpressedkeys ### Definition \`\`\`luau function getpressedkeys(): { string } \`\`\` ### Returns \`\`\`horizontal ### { string } \`\`\` ### Description Returns an array of currently pressed key names. \*\*\* ## isleftclicked ### Definition \`\`\`luau function isleftclicked(): boolean \`\`\` ### Returns \`\`\`horizontal ### boolean \`\`\` ### Description Returns \`true\` if left mouse button was clicked. \*\*\* ## isrightclicked ### Definition \`\`\`luau function isrightclicked(): boolean \`\`\` ### Returns \`\`\`horizontal ### boolean \`\`\` ### Description Returns \`true\` if right mouse button was clicked. \*\*\* ## isleftpressed ### Definition \`\`\`luau function isleftpressed(): boolean \`\`\` ### Returns \`\`\`horizontal ### boolean \`\`\` ### Description Returns \`true\` if left mouse button is held down. \*\*\* ## isrightpressed ### Definition \`\`\`luau function isrightpressed(): boolean \`\`\` ### Returns \`\`\`horizontal ### boolean \`\`\` ### Description Returns \`true\` if right mouse button is held down. \*\*\* ## mousemoverel ### Definition \`\`\`luau function mousemoverel(x: number, y: number): () \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ----------------- | | x | number | Relative X offset | | y | number | Relative Y offset | ### Description Moves mouse by relative X/Y coordinates. \*\*\* ## mousemoveabs ### Definition \`\`\`luau function mousemoveabs(x: number, y: number): () \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ------------------- | | x | number | Absolute X position | | y | number | Absolute Y position | ### Description Moves mouse to absolute X/Y screen coordinates. \*\*\* ## mousescroll ### Definition \`\`\`luau function mousescroll(pixels: number): () \`\`\` ### Parameters | Name | Type | Description | | ------ | ------ | ------------------------ | | pixels | number | Scroll distance (pixels) | ### Description Scrolls mouse wheel by specified pixels. \*\*\* ## mouse1click ### Definition \`\`\`luau function mouse1click(): () \`\`\` ### Description Simulates a left mouse button click. \*\*\* ## mouse1press ### Definition \`\`\`luau function mouse1press(): () \`\`\` ### Description Simulates a left mouse button press (hold). \*\*\* ## mouse1release ### Definition \`\`\`luau function mouse1release(): () \`\`\` ### Description Simulates a left mouse button release. \*\*\* ## mouse2click ### Definition \`\`\`luau function mouse2click(): () \`\`\` ### Description Simulates a right mouse button click. \*\*\* ## mouse2press ### Definition \`\`\`luau function mouse2press(): () \`\`\` ### Description Simulates a right mouse button press (hold). \*\*\* ## mouse2release ### Definition \`\`\`luau function mouse2release(): () \`\`\` ### Description Simulates a right mouse button release. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/core/input.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/libraries.md). # Libraries - \[crypt\](https://v-severe.gitbook.io/landing/reference/libraries/crypt.md) - \[luau\](https://v-severe.gitbook.io/landing/reference/libraries/luau.md) - \[memory\](https://v-severe.gitbook.io/landing/reference/libraries/memory.md) - \[task\](https://v-severe.gitbook.io/landing/reference/libraries/task.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/libraries.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/core/file-system.md). # File System ## dofile ### Definition \`\`\`luau function dofile(path: string): (... any) \`\`\` ### Returns
Type
(... any)
### Description Effectively \`loadstring(readfile(path))()\`. Loads and executes a luau file, returning any values the file returns. \*\*\* ## loadfile ### Definition \`\`\`luau function loadfile(path: string): (... any) \`\`\` ### Returns
Type
(... any)
### Description Loads a luau file and returns it as a function. Call the returned function to execute the file's code. \*\*\* ## writefile ### Definition \`\`\`luau function writefile(path: string, content: string): () \`\`\` ### Description Overrides/creates a file at \`path\` with specified content. \*\*\* ## isfile ### Definition \`\`\`luau function isfile(path: string): boolean \`\`\` ### Returns
Type
boolean
### Description Validates the existence of a file at \`path\`, returns a boolean. \*\*\* ## isfolder ### Definition \`\`\`luau function isfolder(path: string): boolean \`\`\` ### Returns
Type
boolean
### Description Validates the existence of a folder at \`path\`, returns a boolean. \*\*\* ## readfile ### Definition \`\`\`luau function readfile(path: string): string \`\`\` ### Returns
Type
string
### Description Returns the contents of a file at \`path\` as a string. \*\*\* ## listfiles ### Definition \`\`\`luau function listfiles(path: string): { string } \`\`\` ### Returns
Type
{ string }
### Description Returns an array of all files and folders at \`path\`. \*\*\* ## makefolder ### Definition \`\`\`luau function makefolder(path: string): () \`\`\` ### Description Creates a new folder at \`path\`. \*\*\* ## delfolder ### Definition \`\`\`luau function delfolder(path: string): () \`\`\` ### Description Removes the folder located at \`path\`. \*\*\* > \*\*Note:\*\* All file operations are sandboxed to \`C:\\v2\\workspace\`. Attempting to read/write/load outside this directory is impossible. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/core/file-system.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/classes/signal.md). # Signal --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/classes/signal.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/libraries/luau.md). # luau ## compile ### Definition \`\`\`luau function luau.compile(source: string, options: { optimizationLevel: 0 | 1 | 2?, coverageLevel: 0 | 1 | 2?, debugLevel: 0 | 1 | 2? }): string \`\`\` ### Parameters | Name | Type | Description | | ------- | ------ | ----------------------------------------------------- | | source | string | The Luau source code to compile. | | options | table | Compilation settings (optimization, coverage, debug). | ### Description Compiles the given source code into Luau bytecode. An error will be thrown if the source code contains syntax errors or other issues that prevent successful compilation. ### Code Samples \`\`\`luau local bytecode = luau.compile("print('Hello, World!')", { optimizationLevel = 2, coverageLevel = 0, debugLevel = 1, }) local func = load(bytecode) func() -- Outputs: Hello, World! \`\`\` \*\*\* ## load ### Definition \`\`\`luau function luau.load(bytecode: string, options: { debugName: string?, environment: { \[string\]: any }?, injectGlobals: boolean?, codegenEnabled: boolean? }): (... any?) -> (... any?) \`\`\` ### Parameters | Name | Type | Description | | -------- | ------ | --------------------------------------------------- | | bytecode | string | Compiled Luau bytecode. | | options | table | Loading options (debug name, environment, codegen). | ### Description Loads a function from the given Luau bytecode string. An error will be thrown if the bytecode is invalid or cannot be loaded. Note that if \`environment\` is enabled, native code generation and optimizations are forcefully disabled. ### Code Samples \`\`\`luau local bytecode = luau.compile("return 42", { optimizationLevel = 2, coverageLevel = 0, debugLevel = 1, }) local func = luau.load(bytecode, "MyChunk") print(func()) -- Outputs: 42 \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/libraries/luau.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/classes/vector2.md). # Vector2 A 2D vector with X and Y components. ## Constructors ### Vector2.new ### Definition \`\`\`luau function Vector2.new(x: number, y: number): Vector2 function Vector2.new(): Vector2 \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | --------------- | | x | number | The X component | | y | number | The Y component | ### Returns | Type | | ------- | | Vector2 | ### Description Creates a new Vector2. If no parameters are provided, creates a zero vector (0, 0). ### Code Samples \`\`\`luau -- Create a vector local vec = Vector2.new(100, 200) -- Zero vector local zero = Vector2.new() print(zero) -- Vector2(0, 0) -- Unit vectors local right = Vector2.new(1, 0) local up = Vector2.new(0, 1) \`\`\` \*\*\* ## Properties ### X \`\`\`luau Vector2.X: number \`\`\` The X component of the vector. \*\*\* ### Y \`\`\`luau Vector2.Y: number \`\`\` The Y component of the vector. \*\*\* ### Magnitude \`\`\`luau Vector2.Magnitude: number \`\`\` The length of the vector. \*\*\* ### Unit \`\`\`luau Vector2.Unit: Vector2 \`\`\` A normalized version of the vector (length of 1). \*\*\* ## Methods ### Dot ### Definition \`\`\`luau function Vector2:Dot(other: Vector2): number \`\`\` ### Parameters | Name | Type | Description | | ----- | ------- | ---------------- | | other | Vector2 | The other vector | ### Returns | Type | | ------ | | number | ### Description Returns the dot product of this vector and another vector. \*\*\* ### Cross ### Definition \`\`\`luau function Vector2:Cross(other: Vector2): number \`\`\` ### Parameters | Name | Type | Description | | ----- | ------- | ---------------- | | other | Vector2 | The other vector | ### Returns | Type | | ------ | | number | ### Description Returns the 2D cross product (scalar) of this vector and another vector. \*\*\* ### Lerp ### Definition \`\`\`luau function Vector2:Lerp(goal: Vector2, alpha: number): Vector2 \`\`\` ### Parameters | Name | Type | Description | | ----- | ------- | ---------------------------------------- | | goal | Vector2 | The target vector to interpolate towards | | alpha | number | The interpolation factor (0 to 1) | ### Returns | Type | | ------- | | Vector2 | ### Description Returns a Vector2 interpolated between this vector and the goal vector by the alpha amount. \*\*\* ## Metatables ### \\\_\\\_add Adds two vectors. \`\`\`luau local v1 = Vector2.new(10, 20) local v2 = Vector2.new(5, 15) local result = v1 + v2 -- Vector2(15, 35) \`\`\` \*\*\* ### \\\_\\\_sub Subtracts one vector from another. \`\`\`luau local v1 = Vector2.new(10, 20) local v2 = Vector2.new(5, 15) local result = v1 - v2 -- Vector2(5, 5) \`\`\` \*\*\* ### \\\_\\\_mul Multiplies a vector by a scalar or another vector. \`\`\`luau local vec = Vector2.new(10, 20) local scaled = vec \* 2 -- Vector2(20, 40) -- Component-wise multiplication local v1 = Vector2.new(2, 3) local v2 = Vector2.new(4, 5) local result = v1 \* v2 -- Vector2(8, 15) \`\`\` \*\*\* ### \\\_\\\_div Divides a vector by a scalar or another vector. \`\`\`luau local vec = Vector2.new(100, 200) local scaled = vec / 2 -- Vector2(50, 100) -- Component-wise division local v1 = Vector2.new(100, 200) local v2 = Vector2.new(10, 20) local result = v1 / v2 -- Vector2(10, 10) \`\`\` \*\*\* ### \\\_\\\_unm Negates a vector. \`\`\`luau local vec = Vector2.new(10, 20) local negated = -vec -- Vector2(-10, -20) \`\`\` \*\*\* ### \\\_\\\_eq Compares two vectors for equality. \`\`\`luau local v1 = Vector2.new(10, 20) local v2 = Vector2.new(10, 20) local v3 = Vector2.new(5, 15) print(v1 == v2) -- true print(v1 == v3) -- false \`\`\` \*\*\* ### \\\_\\\_tostring Returns a string representation of the vector. \`\`\`luau local vec = Vector2.new(100, 200) print(vec) -- "Vector2(100, 200)" \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/classes/vector2.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/libraries/memory.md). # memory ## Types | Type | Description | Range / Format | | ------- | --------------- | ------------------------------ | | \*\*i8\*\* | Signed 8-bit | \\\[-128, 127\] | | \*\*u8\*\* | Unsigned 8-bit | \\\[0, 255\] | | \*\*i16\*\* | Signed 16-bit | \\\[-32,768, 32,767\] | | \*\*u16\*\* | Unsigned 16-bit | \\\[0, 65,535\] | | \*\*i32\*\* | Signed 32-bit | \\\[-2.1B, 2.1B\] | | \*\*u32\*\* | Unsigned 32-bit | \\\[0, 4.2B\] | | \*\*i64\*\* | Signed 64-bit | Approximate (Casted to Double) | | \*\*u64\*\* | Unsigned 64-bit | Approximate (Casted to Double) | | \*\*f32\*\* | 32-bit Float | IEEE 754 Single | | \*\*f64\*\* | 64-bit Float | IEEE 754 Double | > \*\*Note:\*\* Luau does not natively support 64-bit integers. As a result, \*\*i64\*\* and \*\*u64\*\* operations are \*\*approximations\*\*; these values are cast to a double-precision float, which may lead to precision loss or rounding for extremely large integers. ## Functions ### read\\\[type\] #### Definition \`\`\`luau function memory.read\[type\](address: number): number function memory.read\[type\](source: userdata, offset: number): number \`\`\` #### Description Reads data of a specific type from a raw memory address or an offset from a \`userdata\`. Note that \\\[type\] has to be replaced with a valid type that can be found above. Valid example is: \`memory.readu32(workspace, 0x50)\`. \*\*\* ### memory.write\\\[type\] #### Definition \`\`\`luau function memory.write\[type\](address: number, value: number): () function memory.write\[type\](destination: userdata, offset: number, value: number): () \`\`\` #### Description Writes a value of a specific type to a memory address or \`userdata\` offset. Note that \\\[type\] has to be replaced with a valid type that can be found above. Valid example is: \`memory.writeu32(workspace, 0x50)\`. \*\*\* ### memory.readbits #### Definition \`\`\`luau function memory.readbits(address: number, bitOffset: number, bitSize: number): number function memory.readbits(source: userdata, offset: number, bitOffset: number, bitSize: number): number \`\`\` #### Description Reads a range of bits (up to 32) from the target, starting at \`bitOffset\`. \*\*\* ### memory.writebits #### Definition \`\`\`luau function memory.writebits(address: number, bitOffset: number, bitSize: number, value: number): () function memory.writebits(destination: userdata, offset: number, bitOffset: number, bitSize: number, value: number): () \`\`\` #### Description Writes a range of bits (up to 32) from \`value\` to the destination at \`bitOffset\`. \*\*\* ### memory.readstring #### Definition \`\`\`luau function memory.readstring(address: number): string function memory.readstring(source: userdata, offset: number): string \`\`\` #### Description Reads a raw null-terminated string or byte sequence from the target location. \*\*\* ### memory.writestring #### Definition \`\`\`luau function memory.writestring(address: number, value: string): () function memory.writestring(destination: userdata, offset: number, value: string): () \`\`\` #### Description Writes the raw bytes of a string to the specified memory location. \*\*\* ### memory.readvector #### Definition \`\`\`luau function memory.readvector(address: number): vector function memory.readvector(source: userdata, offset: number): vector \`\`\` #### Description Reads a 3-dimensional vector from memory. \*\*\* ### memory.writevector #### Definition \`\`\`luau function memory.writevector(address: number, value: vector): () function memory.writevector(destination: userdata, offset: number, value: vector): () \`\`\` #### Description Writes a 3-dimensional vector to the target memory location. \*\*\* ### memory.readbuffer #### Definition \`\`\`luau function memory.readbuffer(address: number, size: number): buffer function memory.readbuffer(source: userdata, offset: number, size: number): buffer \`\`\` #### Description Reads \`size\` bytes into a new Luau \`buffer\`. Highly efficient for bulk data extraction. \*\*\* ### memory.writebuffer #### Definition \`\`\`luau function memory.writebuffer(address: number, value: buffer): () function memory.writebuffer(destination: userdata, offset: number, value: buffer): () \`\`\` #### Description Writes the contents of a Luau \`buffer\` directly to the specified memory location. \*\*\* ### memory.rtti #### Definition \`\`\`luau function memory.rtti(address: number): string? function memory.rtti(source: userdata, offset: number): string? \`\`\` #### Description Retrieves the \*\*Run-Time Type Information\*\* name from the target address. Returns \`nil\` if no type info is available. \*\*\* ### memory.changed #### Definition \`\`\`luau function memory.changed(address: number, type: string, callback: (self: userdata, new: any, old: any) -> (), iterations: number?): userdata function memory.changed(source: userdata, offset: number, type: string, callback: (self: userdata, new: any, old: any) -> (), iterations: number?): userdata \`\`\` #### Description Establishes a listener on a memory location that triggers the \`callback\` whenever the value changes. Available types: \`i8\`, \`u8\`, \`i16\`, \`u16\`, \`i32\`, \`u32\`, \`i64\`, \`u64\`, \`f32\`, \`f64\`, \`string\`. ## Properties ### memory.base #### Definition \`\`\`luau memory.base: number \`\`\` #### Description This is the base address for Roblox. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/libraries/memory.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/classes/color3.md). # Color3 A data type representing a color with red, green, and blue components. ## Constructors ### Color3.new ### Definition \`\`\`luau function Color3.new(r: number, g: number, b: number): Color3 \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ------------------------ | | r | number | Red component (0 to 1) | | g | number | Green component (0 to 1) | | b | number | Blue component (0 to 1) | ### Returns | Type | | ------ | | Color3 | ### Description Creates a new Color3 from RGB values in the range 0 to 1. ### Code Samples \`\`\`luau -- Pure red local red = Color3.new(1, 0, 0) -- Pure green local green = Color3.new(0, 1, 0) -- Pure blue local blue = Color3.new(0, 0, 1) -- White local white = Color3.new(1, 1, 1) -- Gray (50%) local gray = Color3.new(0.5, 0.5, 0.5) \`\`\` \*\*\* ### Color3.fromRGB ### Definition \`\`\`luau function Color3.fromRGB(r: number, g: number, b: number): Color3 \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | -------------------------- | | r | number | Red component (0 to 255) | | g | number | Green component (0 to 255) | | b | number | Blue component (0 to 255) | ### Returns | Type | | ------ | | Color3 | ### Description Creates a new Color3 from RGB values in the range 0 to 255. ### Code Samples \`\`\`luau -- Pure red local red = Color3.fromRGB(255, 0, 0) -- Orange local orange = Color3.fromRGB(255, 165, 0) -- Sky blue local skyBlue = Color3.fromRGB(135, 206, 235) \`\`\` \*\*\* ### Color3.fromHSV ### Definition \`\`\`luau function Color3.fromHSV(h: number, s: number, v: number): Color3 \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ----------------------------------- | | h | number | Hue component (0 to 1) | | s | number | Saturation component (0 to 1) | | v | number | Value/brightness component (0 to 1) | ### Returns | Type | | ------ | | Color3 | ### Description Creates a new Color3 from HSV (Hue, Saturation, Value) color space values. ### Code Samples \`\`\`luau -- Pure red (hue = 0) local red = Color3.fromHSV(0, 1, 1) -- Pure green (hue = 1/3) local green = Color3.fromHSV(1/3, 1, 1) -- Pure blue (hue = 2/3) local blue = Color3.fromHSV(2/3, 1, 1) -- Desaturated red (pink) local pink = Color3.fromHSV(0, 0.5, 1) \`\`\` \*\*\* ### Color3.fromHex ### Definition \`\`\`luau function Color3.fromHex(hex: string): Color3 \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ------------------------------------------ | | hex | string | Hexadecimal color string (e.g., "#FF5733") | ### Returns | Type | | ------ | | Color3 | ### Description Creates a new Color3 from a hexadecimal color string. The string can optionally start with "#". ### Code Samples \`\`\`luau -- With hash local orange = Color3.fromHex("#FF5733") -- Without hash local blue = Color3.fromHex("0000FF") -- Cyan local cyan = Color3.fromHex("#00FFFF") \`\`\` \*\*\* ## Methods ### ToHSV ### Definition \`\`\`luau function Color3:ToHSV(): (number, number, number) \`\`\` ### Returns | Type | | ------------------------ | | (number, number, number) | ### Description Converts the Color3 to HSV (Hue, Saturation, Value) format and returns the three components. ### Code Samples \`\`\`luau local color = Color3.fromRGB(255, 128, 0) local h, s, v = color:ToHSV() print(h, s, v) \`\`\` \*\*\* ### Lerp ### Definition \`\`\`luau function Color3:Lerp(goal: Color3, alpha: number): Color3 \`\`\` ### Parameters | Name | Type | Description | | ----- | ------ | --------------------------------------- | | goal | Color3 | The target color to interpolate towards | | alpha | number | The interpolation factor (0 to 1) | ### Returns | Type | | ------ | | Color3 | ### Description Returns a Color3 interpolated between this color and the goal color by the alpha amount. ### Code Samples \`\`\`luau local red = Color3.fromRGB(255, 0, 0) local blue = Color3.fromRGB(0, 0, 255) local purple = red:Lerp(blue, 0.5) \`\`\` \*\*\* ## Metatables ### \\\_\\\_index Allows property access on Color3 values. \`\`\`luau local color = Color3.fromRGB(255, 128, 64) local r = color.R -- 1 local g = color.G -- 0.502 local b = color.B -- 0.251 \`\`\` \*\*\* ### \\\_\\\_tostring Returns a string representation of the Color3. \`\`\`luau local color = Color3.fromRGB(255, 128, 0) print(color) -- "Color3(1, 0.502, 0)" \`\`\` \*\*\* ### \\\_\\\_eq Compares two Color3 values for equality. \`\`\`luau local color1 = Color3.fromRGB(255, 0, 0) local color2 = Color3.fromRGB(255, 0, 0) local color3 = Color3.fromRGB(0, 255, 0) print(color1 == color2) -- true print(color1 == color3) -- false \`\`\` \*\*\* ### \\\_\\\_type Returns the type name "Color3". \`\`\`luau local color = Color3.new(1, 0, 0) print(typeof(color)) -- "Color3" \`\`\` \*\*\* ## Properties ### R \`\`\`luau Color3.R: number \`\`\` The red component of the color (0 to 1). \*\*\* ### G \`\`\`luau Color3.G: number \`\`\` The green component of the color (0 to 1). \*\*\* ### B \`\`\`luau Color3.B: number \`\`\` The blue component of the color (0 to 1). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/classes/color3.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/classes/vector3.md). # Vector3 A 3D vector with X, Y, and Z components. ## Constructors ### Vector3.new ### Definition \`\`\`luau function Vector3.new(x: number, y: number, z: number): Vector3 function Vector3.new(): Vector3 \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | --------------- | | x | number | The X component | | y | number | The Y component | | z | number | The Z component | ### Returns | Type | | ------- | | Vector3 | ### Description Creates a new Vector3. If no parameters are provided, creates a zero vector (0, 0, 0). ### Code Samples \`\`\`luau -- Create a vector local vec = Vector3.new(10, 20, 30) -- Zero vector local zero = Vector3.new() print(zero) -- Vector3(0, 0, 0) -- Unit vectors local right = Vector3.new(1, 0, 0) local up = Vector3.new(0, 1, 0) local forward = Vector3.new(0, 0, 1) \`\`\` \*\*\* ## Properties ### X \`\`\`luau Vector3.X: number \`\`\` The X component of the vector. \*\*\* ### Y \`\`\`luau Vector3.Y: number \`\`\` The Y component of the vector. \*\*\* ### Z \`\`\`luau Vector3.Z: number \`\`\` The Z component of the vector. \*\*\* ### Magnitude \`\`\`luau Vector3.Magnitude: number \`\`\` The length of the vector. \*\*\* ### Unit \`\`\`luau Vector3.Unit: Vector3 \`\`\` A normalized version of the vector (length of 1). \*\*\* ## Methods ### Dot ### Definition \`\`\`luau function Vector3:Dot(other: Vector3): number \`\`\` ### Parameters | Name | Type | Description | | ----- | ------- | ---------------- | | other | Vector3 | The other vector | ### Returns | Type | | ------ | | number | ### Description Returns the dot product of this vector and another vector. \*\*\* ### Cross ### Definition \`\`\`luau function Vector3:Cross(other: Vector3): Vector3 \`\`\` ### Parameters | Name | Type | Description | | ----- | ------- | ---------------- | | other | Vector3 | The other vector | ### Returns | Type | | ------- | | Vector3 | ### Description Returns the cross product of this vector and another vector. \*\*\* ### Lerp ### Definition \`\`\`luau function Vector3:Lerp(goal: Vector3, alpha: number): Vector3 \`\`\` ### Parameters | Name | Type | Description | | ----- | ------- | ---------------------------------------- | | goal | Vector3 | The target vector to interpolate towards | | alpha | number | The interpolation factor (0 to 1) | ### Returns | Type | | ------- | | Vector3 | ### Description Returns a Vector3 interpolated between this vector and the goal vector by the alpha amount. \*\*\* ## Metatables ### \\\_\\\_add Adds two vectors. \`\`\`luau local v1 = Vector3.new(1, 2, 3) local v2 = Vector3.new(4, 5, 6) local result = v1 + v2 -- Vector3(5, 7, 9) \`\`\` \*\*\* ### \\\_\\\_sub Subtracts one vector from another. \`\`\`luau local v1 = Vector3.new(5, 7, 9) local v2 = Vector3.new(1, 2, 3) local result = v1 - v2 -- Vector3(4, 5, 6) \`\`\` \*\*\* ### \\\_\\\_mul Multiplies a vector by a scalar or another vector. \`\`\`luau local vec = Vector3.new(1, 2, 3) local scaled = vec \* 2 -- Vector3(2, 4, 6) -- Component-wise multiplication local v1 = Vector3.new(2, 3, 4) local v2 = Vector3.new(1, 2, 3) local result = v1 \* v2 -- Vector3(2, 6, 12) \`\`\` \*\*\* ### \\\_\\\_div Divides a vector by a scalar or another vector. \`\`\`luau local vec = Vector3.new(10, 20, 30) local scaled = vec / 2 -- Vector3(5, 10, 15) -- Component-wise division local v1 = Vector3.new(10, 20, 30) local v2 = Vector3.new(2, 4, 5) local result = v1 / v2 -- Vector3(5, 5, 6) \`\`\` \*\*\* ### \\\_\\\_unm Negates a vector. \`\`\`luau local vec = Vector3.new(1, 2, 3) local negated = -vec -- Vector3(-1, -2, -3) \`\`\` \*\*\* ### \\\_\\\_eq Compares two vectors for equality. \`\`\`luau local v1 = Vector3.new(1, 2, 3) local v2 = Vector3.new(1, 2, 3) local v3 = Vector3.new(4, 5, 6) print(v1 == v2) -- true print(v1 == v3) -- false \`\`\` \*\*\* ### \\\_\\\_tostring Returns a string representation of the vector. \`\`\`luau local vec = Vector3.new(10, 20, 30) print(vec) -- "Vector3(10, 20, 30)" \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/classes/vector3.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/drawing.md). # Drawing ## Overview Drawing itself, within \*\*Severe\*\* refers to a library which has functions for static (\[retained\](https://en.wikipedia.org/wiki/Retained\_mode)) rendering of objects. We offer 3 different ways of rendering: \* \*\*Dynamic:\*\* Offering best performance, and fast usage. \* \*\*Immediate:\*\* Ideal for a small amount of objects, or if the objects move. \* \*\*Static:\*\* \[Retained\](https://en.wikipedia.org/wiki/Retained\_mode) drawing, being best if you can manage it properly, or for user interfaces. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/drawing.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/classes/websocketclient.md). # WebsocketClient A websocket client for establishing and managing WebSocket connections. ## Constructors ### WebsocketClient.new ### Definition \`\`\`luau function WebsocketClient.new(url: string): WebsocketClient \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ---------------------------- | | url | string | The WebSocket connection URL | ### Returns | Type | | --------------- | | WebsocketClient | ### Description Creates a new WebsocketClient and connects to the specified URL. ### Code Samples \`\`\`luau -- Create a WebSocket connection local ws = WebsocketClient.new("ws://example.com:8080") -- Handle incoming messages ws.DataReceived:Connect(function(payload, isBinary) if isBinary then print("Received binary data:", #payload, "bytes") else print("Received text:", payload) end end) -- Send a message ws:Send("Hello, server!") -- Disconnect when done ws:Disconnect() \`\`\` \*\*\* ## Properties ### Url \`\`\`luau WebsocketClient.Url: string \[readonly\] \`\`\` The WebSocket connection URL that this client is connected to. This property is read-only. \*\*\* ## Methods ### Disconnect ### Definition \`\`\`luau function WebsocketClient:Disconnect(): () \`\`\` ### Description Disconnects the WebSocket. Yields until the client is fully disconnected. After calling this method, the WebSocket connection is closed and no further messages can be sent or received. ### Code Samples \`\`\`luau local ws = WebsocketClient.new("ws://example.com:8080") -- Do some work... ws:Send("Goodbye") -- Disconnect (yields until fully disconnected) ws:Disconnect() print("WebSocket disconnected") \`\`\` \*\*\* ### Send ### Definition \`\`\`luau function WebsocketClient:Send(message: string, isBinary: boolean?): () \`\`\` ### Parameters | Name | Type | Description | | -------- | -------- | -------------------------------------------------- | | message | string | The message payload to send | | isBinary | boolean? | Whether to send as binary data (defaults to false) | ### Description Sends a message through the WebSocket connection. The message can be sent as either text or binary data based on the \`isBinary\` parameter. ### Code Samples \`\`\`luau local ws = WebsocketClient.new("ws://example.com:8080") -- Send text message (default) ws:Send("Hello, world!") -- Explicitly send text ws:Send("Text message", false) -- Send binary data local binaryData = "\\x01\\x02\\x03\\x04" ws:Send(binaryData, true) \`\`\` \*\*\* ## Events ### DataReceived ### Definition \`\`\`luau WebsocketClient.DataReceived: Signal<(payload: string, isBinary: boolean) -> ()> \`\`\` ### Parameters | Name | Type | Description | | -------- | ------- | ----------------------------------- | | payload | string | The received message data | | isBinary | boolean | Whether the received data is binary | ### Description Fires when data is received from the WebSocket connection. The event provides the payload as a string and a boolean indicating whether it's binary data. ### Code Samples \`\`\`luau local ws = WebsocketClient.new("ws://example.com:8080") -- Connect to the DataReceived event ws.DataReceived:Connect(function(payload, isBinary) if isBinary then print("Received binary payload of length:", #payload) -- Process binary data... else print("Received text message:", payload) -- Process text data... end end) -- Example with JSON parsing ws.DataReceived:Connect(function(payload, isBinary) if not isBinary then local success, data = pcall(function() return game:GetService("HttpService"):JSONDecode(payload) end) if success then print("Received JSON data:", data) else print("Received non-JSON text:", payload) end end end) \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/classes/websocketclient.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Core | v-severe For the complete documentation index, see [llms.txt](https://v-severe.gitbook.io/landing/llms.txt) . This page is also available as [Markdown](https://v-severe.gitbook.io/landing/reference/core.md) . [File System](https://v-severe.gitbook.io/landing/reference/core/file-system) [Miscellaneous](https://v-severe.gitbook.io/landing/reference/core/miscellaneous) [Input](https://v-severe.gitbook.io/landing/reference/core/input) [PreviousGlossary](https://v-severe.gitbook.io/landing/introduction/glossary) [NextFile System](https://v-severe.gitbook.io/landing/reference/core/file-system) Last updated 4 months ago --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/classes/cframe.md). # CFrame A coordinate frame representing position and rotation in 3D space. ## Constructors ### CFrame.new ### Definition \`\`\`luau function CFrame.new(): CFrame function CFrame.new(x: number, y: number, z: number): CFrame function CFrame.new(position: Vector3): CFrame function CFrame.new(position: Vector3, lookAt: Vector3): CFrame function CFrame.new(x: number, y: number, z: number, qx: number, qy: number, qz: number, qw: number): CFrame function CFrame.new(x: number, y: number, z: number, R00: number, R01: number, R02: number, R10: number, R11: number, R12: number, R20: number, R21: number, R22: number): CFrame \`\`\` ### Description Creates a new CFrame. Can be constructed in several ways: \* Empty constructor creates an identity CFrame at (0, 0, 0) \* Position-only creates a CFrame at the specified position with no rotation \* Position and lookAt creates a CFrame positioned at the first argument, looking at the second \* Position with quaternion values for rotation \* Position with full rotation matrix components ### Code Samples \`\`\`luau -- Identity CFrame local cf1 = CFrame.new() -- Position only local cf2 = CFrame.new(10, 20, 30) -- Position from Vector3 local cf3 = CFrame.new(Vector3.new(5, 10, 15)) -- Position looking at another position local cf4 = CFrame.new(Vector3.new(0, 5, 0), Vector3.new(10, 5, 10)) \`\`\` \*\*\* ### CFrame.fromEulerAnglesXYZ ### Definition \`\`\`luau function CFrame.fromEulerAnglesXYZ(rx: number, ry: number, rz: number): CFrame function CFrame.fromEulerAnglesXYZ(rotation: Vector3): CFrame \`\`\` ### Parameters | Name | Type | Description | | -------- | ------- | --------------------------------- | | rx | number | Rotation around X-axis in radians | | ry | number | Rotation around Y-axis in radians | | rz | number | Rotation around Z-axis in radians | | rotation | Vector3 | Vector containing rotation angles | ### Returns | Type | | ------ | | CFrame | ### Description Creates a rotated CFrame using Euler angles in X, Y, Z order (roll, pitch, yaw). ### Code Samples \`\`\`luau -- Rotate 90 degrees (π/2 radians) around Y-axis local cf = CFrame.fromEulerAnglesXYZ(0, math.pi/2, 0) -- Using Vector3 local rotation = Vector3.new(0, math.pi/2, 0) local cf2 = CFrame.fromEulerAnglesXYZ(rotation) \`\`\` \*\*\* ### CFrame.fromEulerAnglesYXZ ### Definition \`\`\`luau function CFrame.fromEulerAnglesYXZ(rx: number, ry: number, rz: number): CFrame function CFrame.fromEulerAnglesYXZ(rotation: Vector3): CFrame \`\`\` ### Parameters | Name | Type | Description | | -------- | ------- | --------------------------------- | | rx | number | Rotation around X-axis in radians | | ry | number | Rotation around Y-axis in radians | | rz | number | Rotation around Z-axis in radians | | rotation | Vector3 | Vector containing rotation angles | ### Returns | Type | | ------ | | CFrame | ### Description Creates a rotated CFrame using Euler angles in Y, X, Z order. \*\*\* ### CFrame.fromOrientation ### Definition \`\`\`luau function CFrame.fromOrientation(rx: number, ry: number, rz: number): CFrame \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | --------------------------------- | | rx | number | Rotation around X-axis in radians | | ry | number | Rotation around Y-axis in radians | | rz | number | Rotation around Z-axis in radians | ### Returns | Type | | ------ | | CFrame | ### Description Creates a rotated CFrame from orientation angles (equivalent to fromEulerAnglesYXZ). \*\*\* ### CFrame.fromAxisAngle ### Definition \`\`\`luau function CFrame.fromAxisAngle(axis: Vector3, rotation: number): CFrame \`\`\` ### Parameters | Name | Type | Description | | -------- | ------- | ---------------------------------- | | axis | Vector3 | The axis of rotation (unit vector) | | rotation | number | The angle of rotation in radians | ### Returns | Type | | ------ | | CFrame | ### Description Creates a CFrame rotated around the specified axis by the given angle. ### Code Samples \`\`\`luau -- Rotate 45 degrees around the Y-axis local axis = Vector3.new(0, 1, 0) local cf = CFrame.fromAxisAngle(axis, math.pi/4) \`\`\` \*\*\* ### CFrame.fromMatrix ### Definition \`\`\`luau function CFrame.fromMatrix(position: Vector3, vX: Vector3, vY: Vector3, vZ: Vector3): CFrame \`\`\` ### Parameters | Name | Type | Description | | -------- | ------- | -------------------------- | | position | Vector3 | The position of the CFrame | | vX | Vector3 | The right vector | | vY | Vector3 | The up vector | | vZ | Vector3 | The negative look vector | ### Returns | Type | | ------ | | CFrame | ### Description Creates a CFrame from a position and three directional vectors representing the rotation matrix. \*\*\* ### CFrame.lookAt ### Definition \`\`\`luau function CFrame.lookAt(from: Vector3, to: Vector3, up: Vector3?): CFrame \`\`\` ### Parameters | Name | Type | Description | | ---- | -------- | ----------------------------------------- | | from | Vector3 | The position to look from | | to | Vector3 | The position to look at | | up | Vector3? | Optional up vector (defaults to world up) | ### Returns | Type | | ------ | | CFrame | ### Description Creates a CFrame positioned at 'from' and oriented to look at 'to'. ### Code Samples \`\`\`luau -- Create a CFrame looking from origin to a point local cf = CFrame.lookAt(Vector3.new(0, 5, 0), Vector3.new(10, 5, 10)) -- With custom up vector local cf2 = CFrame.lookAt(Vector3.new(0, 0, 0), Vector3.new(5, 5, 5), Vector3.new(0, 1, 0)) \`\`\` \*\*\* ### CFrame.Angles ### Definition \`\`\`luau function CFrame.Angles(rx: number, ry: number, rz: number): CFrame \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | --------------------------------- | | rx | number | Rotation around X-axis in radians | | ry | number | Rotation around Y-axis in radians | | rz | number | Rotation around Z-axis in radians | ### Returns | Type | | ------ | | CFrame | ### Description Creates a rotated CFrame from Euler angles (equivalent to fromOrientation). \*\*\* ## Methods ### Inverse ### Definition \`\`\`luau function CFrame:Inverse(): CFrame \`\`\` ### Returns | Type | | ------ | | CFrame | ### Description Returns the inverse of this CFrame. When multiplied with the original, produces an identity CFrame. ### Code Samples \`\`\`luau local cf = CFrame.new(10, 20, 30) local inverse = cf:Inverse() local identity = cf \* inverse -- Results in CFrame at origin \`\`\` \*\*\* ### Lerp ### Definition \`\`\`luau function CFrame:Lerp(goal: CFrame, alpha: number): CFrame \`\`\` ### Parameters | Name | Type | Description | | ----- | ------ | ---------------------------------------- | | goal | CFrame | The target CFrame to interpolate towards | | alpha | number | The interpolation factor (0 to 1) | ### Returns | Type | | ------ | | CFrame | ### Description Returns a CFrame interpolated between this CFrame and the goal CFrame by the alpha amount. ### Code Samples \`\`\`luau local start = CFrame.new(0, 0, 0) local goal = CFrame.new(10, 10, 10) local halfway = start:Lerp(goal, 0.5) -- CFrame at (5, 5, 5) \`\`\` \*\*\* ### ToWorldSpace ### Definition \`\`\`luau function CFrame:ToWorldSpace(cf: CFrame): CFrame \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | -------------------------- | | cf | CFrame | The CFrame in object space | ### Returns | Type | | ------ | | CFrame | ### Description Transforms a CFrame from object space to world space. Equivalent to \`self \* cf\`. \*\*\* ### ToObjectSpace ### Definition \`\`\`luau function CFrame:ToObjectSpace(cf: CFrame): CFrame \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ------------------------- | | cf | CFrame | The CFrame in world space | ### Returns | Type | | ------ | | CFrame | ### Description Transforms a CFrame from world space to object space. Equivalent to \`self:Inverse() \* cf\`. \*\*\* ### PointToWorldSpace ### Definition \`\`\`luau function CFrame:PointToWorldSpace(point: Vector3): Vector3 \`\`\` ### Parameters | Name | Type | Description | | ----- | ------- | ------------------------- | | point | Vector3 | The point in object space | ### Returns | Type | | ------- | | Vector3 | ### Description Transforms a point from object space to world space. ### Code Samples \`\`\`luau local cf = CFrame.new(10, 0, 0) local localPoint = Vector3.new(5, 0, 0) local worldPoint = cf:PointToWorldSpace(localPoint) -- Vector3(15, 0, 0) \`\`\` \*\*\* ### PointToObjectSpace ### Definition \`\`\`luau function CFrame:PointToObjectSpace(point: Vector3): Vector3 \`\`\` ### Parameters | Name | Type | Description | | ----- | ------- | ------------------------ | | point | Vector3 | The point in world space | ### Returns | Type | | ------- | | Vector3 | ### Description Transforms a point from world space to object space. \*\*\* ### VectorToWorldSpace ### Definition \`\`\`luau function CFrame:VectorToWorldSpace(vector: Vector3): Vector3 \`\`\` ### Parameters | Name | Type | Description | | ------ | ------- | -------------------------- | | vector | Vector3 | The vector in object space | ### Returns | Type | | ------- | | Vector3 | ### Description Transforms a vector from object space to world space (rotation only, no translation). \*\*\* ### VectorToObjectSpace ### Definition \`\`\`luau function CFrame:VectorToObjectSpace(vector: Vector3): Vector3 \`\`\` ### Parameters | Name | Type | Description | | ------ | ------- | ------------------------- | | vector | Vector3 | The vector in world space | ### Returns | Type | | ------- | | Vector3 | ### Description Transforms a vector from world space to object space (rotation only, no translation). \*\*\* ### GetComponents ### Definition \`\`\`luau function CFrame:GetComponents(): (number, number, number, number, number, number, number, number, number, number, number, number) \`\`\` ### Returns | Type | | ------------------------------------------------------------------------------------------------ | | (number, number, number, number, number, number, number, number, number, number, number, number) | ### Description Returns the 12 components of the CFrame: position (x, y, z) and rotation matrix (R00, R01, R02, R10, R11, R12, R20, R21, R22). ### Code Samples \`\`\`luau local cf = CFrame.new(10, 20, 30) local x, y, z, R00, R01, R02, R10, R11, R12, R20, R21, R22 = cf:GetComponents() print(x, y, z) -- 10, 20, 30 \`\`\` \*\*\* ### ToOrientation ### Definition \`\`\`luau function CFrame:ToOrientation(): (number, number, number) \`\`\` ### Returns | Type | | ------------------------ | | (number, number, number) | ### Description Returns the orientation of the CFrame as three Euler angles in radians (rx, ry, rz) in Y, X, Z order. \*\*\* ### ToEulerAnglesXYZ ### Definition \`\`\`luau function CFrame:ToEulerAnglesXYZ(): (number, number, number) \`\`\` ### Returns | Type | | ------------------------ | | (number, number, number) | ### Description Returns the orientation of the CFrame as three Euler angles in radians (rx, ry, rz) in X, Y, Z order. ### Code Samples \`\`\`luau local cf = CFrame.Angles(0, math.pi/2, 0) local rx, ry, rz = cf:ToEulerAnglesXYZ() print(rx, ry, rz) \`\`\` \*\*\* ### ToEulerAnglesYXZ ### Definition \`\`\`luau function CFrame:ToEulerAnglesYXZ(): (number, number, number) \`\`\` ### Returns | Type | | ------------------------ | | (number, number, number) | ### Description Returns the orientation of the CFrame as three Euler angles in radians (rx, ry, rz) in Y, X, Z order. \*\*\* ### ToAxisAngle ### Definition \`\`\`luau function CFrame:ToAxisAngle(): (Vector3, number) \`\`\` ### Returns | Type | | ----------------- | | (Vector3, number) | ### Description Returns the axis-angle representation of the CFrame's rotation as a unit vector and rotation angle in radians. ### Code Samples \`\`\`luau local cf = CFrame.fromAxisAngle(Vector3.new(0, 1, 0), math.pi/4) local axis, angle = cf:ToAxisAngle() print(axis, angle) \`\`\` \*\*\* ## Metatables ### \\\_\\\_index Allows property access on CFrame values. \`\`\`luau local cf = CFrame.new(10, 20, 30) local pos = cf.Position -- Vector3(10, 20, 30) local rightVector = cf.RightVector local upVector = cf.UpVector local lookVector = cf.LookVector \`\`\` \*\*\* ### \\\_\\\_mul Multiplies two CFrames or transforms a Vector3. \`\`\`luau -- CFrame multiplication local cf1 = CFrame.new(10, 0, 0) local cf2 = CFrame.new(5, 0, 0) local result = cf1 \* cf2 -- CFrame at (15, 0, 0) -- Transform a Vector3 local cf = CFrame.new(10, 20, 30) local point = Vector3.new(1, 1, 1) local transformed = cf \* point \`\`\` \*\*\* ### \\\_\\\_add Translates a CFrame by a Vector3. \`\`\`luau local cf = CFrame.new(10, 20, 30) local offset = Vector3.new(5, 5, 5) local result = cf + offset -- CFrame at (15, 25, 35) \`\`\` \*\*\* ### \\\_\\\_sub Translates a CFrame by the negative of a Vector3. \`\`\`luau local cf = CFrame.new(10, 20, 30) local offset = Vector3.new(5, 5, 5) local result = cf - offset -- CFrame at (5, 15, 25) \`\`\` \*\*\* ### \\\_\\\_tostring Returns a string representation of the CFrame. \`\`\`luau local cf = CFrame.new(10, 20, 30) print(cf) -- "CFrame(10, 20, 30, 1, 0, 0, 0, 1, 0, 0, 0, 1)" \`\`\` \*\*\* ## Properties ### Position \`\`\`luau CFrame.Position: Vector3 \`\`\` The position component of the CFrame. \*\*\* ### RightVector \`\`\`luau CFrame.RightVector: Vector3 \`\`\` The right direction vector of the CFrame (X-axis). \*\*\* ### UpVector \`\`\`luau CFrame.UpVector: Vector3 \`\`\` The up direction vector of the CFrame (Y-axis). \*\*\* ### LookVector \`\`\`luau CFrame.LookVector: Vector3 \`\`\` The look direction vector of the CFrame (negative Z-axis). \*\*\* ### X \`\`\`luau CFrame.X: number \`\`\` The X position component. \*\*\* ### Y \`\`\`luau CFrame.Y: number \`\`\` The Y position component. \*\*\* ### Z \`\`\`luau CFrame.Z: number \`\`\` The Z position component. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/classes/cframe.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/drawing/classes/square.md). # Square ## Definition \`\`\`luau local Square = Square.new() -- Or, Drawing.new("Square") \`\`\` ## Properties ### Visible \`\`\`luau Square.Visible: boolean \`\`\` \*\*\* ### Color \`\`\`luau Square.Color: Color3 \`\`\` \*\*\* ### ZIndex \`\`\`luau Square.ZIndex: number \`\`\` Range \`\[-2147483647, 2147483647\]\`. \*\*\* ### Opacity \`\`\`luau Square.Opacity: number \`\`\` \*\*\* ### Thickness \`\`\`luau Square.Thickness: number \`\`\` \*\*\* ### Size \`\`\`luau Square.Size: Vector2 \`\`\` \*\*\* ### Position \`\`\`luau Square.Position: Vector2 \`\`\` \*\*\* ### Filled \`\`\`luau Square.Filled: boolean \`\`\` \*\*\* ### Rounding \`\`\`luau Square.Rounding: number \`\`\` \*\*\* ## Methods ### Remove \`\`\`luau Square:Remove(): () \`\`\` Permanently removes the drawing object. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/drawing/classes/square.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/libraries/task.md). # task Task scheduler library providing thread management functions for asynchronous execution. ## Functions ## task.spawn ### Definition \`\`\`luau function task.spawn(functionOrThread: (() -> ()) | thread, ...: any): thread \`\`\` ### Parameters | Name | Type | Description | | ---------------- | -------------------- | --------------------------------------------- | | functionOrThread | (() -> ()) \\| thread | The function or thread to execute immediately | | ... | any | Optional arguments to pass to the function | ### Returns | Type | | ------ | | thread | ### Description Immediately executes the provided function or resumes the provided thread in a separate thread without yielding the current thread. The new thread runs in parallel with the calling thread. Returns the thread that was spawned. ### Code Samples \`\`\`luau -- Spawn a function task.spawn(function() print("This runs immediately in a new thread") task.wait(1) print("After 1 second") end) -- Spawn with arguments task.spawn(function(message, delay) task.wait(delay) print(message) end, "Hello!", 2) -- Spawn a thread local thread = coroutine.create(function() print("Thread spawned") end) task.spawn(thread) \`\`\` \*\*\* ## task.defer ### Definition \`\`\`luau function task.defer(functionOrThread: (() -> ()) | thread, ...: any): thread \`\`\` ### Parameters | Name | Type | Description | | ---------------- | -------------------- | ------------------------------------------------ | | functionOrThread | (() -> ()) \\| thread | The function or thread to execute after deferral | | ... | any | Optional arguments to pass to the function | ### Returns | Type | | ------ | | thread | ### Description Defers the execution of the provided function or thread until the next resumption cycle. Unlike \`task.spawn\`, deferred functions do not run immediately but wait until the current thread yields. This is useful for scheduling work that should happen after the current frame or operation completes. ### Code Samples \`\`\`luau -- Defer a function task.defer(function() print("This runs after the current thread yields") end) -- Defer with arguments task.defer(function(text) print("Deferred: " .. text) end, "Hello, world!") print("This prints first") -- Output: -- This prints first -- This runs after the current thread yields -- Deferred: Hello, world! \`\`\` \*\*\* ## task.cancel ### Definition \`\`\`luau function task.cancel(thread: thread): () \`\`\` ### Parameters | Name | Type | Description | | ------ | ------ | -------------------- | | thread | thread | The thread to cancel | ### Description Cancels a thread that was created with \`task.spawn\`, \`task.defer\`, or \`task.delay\`. Once cancelled, the thread will not resume execution. If the thread is already completed or cancelled, this function has no effect. ### Code Samples \`\`\`luau -- Cancel a spawned thread local thread = task.spawn(function() task.wait(5) print("This will never print") end) task.wait(1) task.cancel(thread) print("Thread cancelled") -- Cancel a deferred thread local deferredThread = task.defer(function() print("This will not execute") end) task.cancel(deferredThread) \`\`\` \*\*\* ## task.delay ### Definition \`\`\`luau function task.delay(duration: number, functionOrThread: (() -> ()) | thread, ...: any): thread \`\`\` ### Parameters | Name | Type | Description | | ---------------- | -------------------- | --------------------------------------------- | | duration | number | The time in seconds to wait before execution | | functionOrThread | (() -> ()) \\| thread | The function or thread to execute after delay | | ... | any | Optional arguments to pass to the function | ### Returns | Type | | ------ | | thread | ### Description Schedules a function or thread to execute after the specified duration in seconds. The function runs in a separate thread after the delay. Returns the thread that will be executed. This is useful for scheduling delayed operations without blocking the current thread. ### Code Samples \`\`\`luau -- Delay execution by 3 seconds task.delay(3, function() print("This prints after 3 seconds") end) -- Delay with arguments task.delay(5, function(message, count) for i = 1, count do print(message) end end, "Delayed message", 3) -- Delay a thread local thread = coroutine.create(function() print("Thread executed after delay") end) task.delay(2, thread) -- Cancel a delayed task local delayedThread = task.delay(10, function() print("This will be cancelled") end) task.wait(1) task.cancel(delayedThread) print("Delayed task cancelled") \`\`\` \*\*\* ## task.wait ### Definition \`\`\`luau function task.wait(duration: number?): number \`\`\` ### Parameters | Name | Type | Description | | -------- | ------- | ----------------------------------------------------------- | | duration | number? | The time in seconds to wait. Defaults to 0 if not provided. | ### Returns | Type | | ------ | | number | ### Description Yields the current thread for at least the specified duration in seconds. Returns the actual time elapsed. This is the preferred way to yield execution in modern Luau code, replacing the legacy \`wait()\` function. ### Code Samples \`\`\`luau -- Wait for 2 seconds local elapsed = task.wait(2) print("Waited for " .. elapsed .. " seconds") -- Wait with default duration task.wait() -- Waits for the next frame/cycle -- Use in a loop for i = 1, 5 do print("Iteration " .. i) task.wait(1) end -- Countdown timer for i = 10, 1, -1 do print(i) task.wait(1) end print("Blast off!") \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/libraries/task.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/drawing/classes/text.md). # Text ## Definition \`\`\`luau local Text = Text.new() -- Or, Drawing.new("Text") \`\`\` ## Properties ### Visible \`\`\`luau Text.Visible: boolean \`\`\` \*\*\* ### Color \`\`\`luau Text.Color: Color3 \`\`\` \*\*\* ### ZIndex \`\`\`luau Text.ZIndex: number \`\`\` Range \`\[-2147483647, 2147483647\]\`. \*\*\* ### Opacity \`\`\`luau Text.Opacity: number \`\`\` \*\*\* ### Text \`\`\`luau Text.Text: string \`\`\` \*\*\* ### Size \`\`\`luau Text.Size: number \`\`\` \*\*\* ### Center \`\`\`luau Text.Center: boolean \`\`\` \*\*\* ### Outline \`\`\`luau Text.Outline: boolean \`\`\` \*\*\* ### OutlineColor \`\`\`luau Text.OutlineColor: Vector3 \`\`\` \*\*\* ### Position \`\`\`luau Text.Position: Vector2 \`\`\` \*\*\* ### TextBounds \`\`\`luau Text.TextBounds: Vector2 \`\`\` \*\*\* ### Font \`\`\`luau Text.Font: number \`\`\` Range \`\[0, 31\]\`. \*\*\* ## Methods ### Remove \`\`\`luau Text:Remove(): () \`\`\` Permanently removes the drawing object. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/drawing/classes/text.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/drawing/classes/image.md). # Image ## Definition \`\`\`luau local Image = Image.new() -- Or, Drawing.new("Image") \`\`\` ## Properties ### Visible \`\`\`luau Image.Visible: boolean \`\`\` \*\*\* ### Color \`\`\`luau Image.Color: Color3 \`\`\` \*\*\* ### ZIndex \`\`\`luau Image.ZIndex: number \`\`\` Range \`\[-2147483647, 2147483647\]\`. \*\*\* ### Opacity \`\`\`luau Image.Opacity: number \`\`\` \*\*\* ### Url \`\`\`luau Image.Url: string \`\`\` \*\*\* ### Data \`\`\`luau Image.Data: string \`\`\` \*\*\* ### Gif \`\`\`luau Image.Gif: boolean \`\`\` \*\*\* ### Delay \`\`\`luau Image.Delay: number \`\`\` \*\*\* ### Position \`\`\`luau Image.Position: Vector2 \`\`\` \*\*\* ### Size \`\`\`luau Image.Size: Vector2 \`\`\` \*\*\* ### Rounding \`\`\`luau Image.Rounding: number \`\`\` \*\*\* ### ImageSize \`\`\`luau Image.ImageSize: Vector2 \`\`\` \*\*\* !\\\[\\\[\]\] ## Methods ### Remove \`\`\`luau Image:Remove(): () \`\`\` Permanently removes the drawing object. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/drawing/classes/image.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/libraries/crypt.md). # crypt Cryptography library providing various cryptographic functions for encryption, hashing, signing, and encoding. > \*\*Note:\*\* All arguments for crypt functions should be assumed as strings unless otherwise specified. ## Random ## crypt.random ### Definition \`\`\`luau function crypt.random(size: string): string \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ----------------------------------- | | size | string | The size of random data to generate | ### Returns | Type | | ------ | | string | ### Description Generates cryptographically secure random bytes of the specified size. \*\*\* ## crypt.random\\\_deterministic ### Definition \`\`\`luau function crypt.random\_deterministic(size: string, seed: string): string \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ------------------------------------- | | size | string | The size of random data to generate | | seed | string | The seed for deterministic generation | ### Returns | Type | | ------ | | string | ### Description Generates deterministic random bytes of the specified size using the provided seed. \*\*\* ## Hash ## crypt.hash.sha256 ### Definition \`\`\`luau function crypt.hash.sha256(data: string): string \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ---------------- | | data | string | The data to hash | ### Returns | Type | | ------ | | string | ### Description Computes the SHA-256 hash of the input data. \*\*\* ## crypt.hash.sha512 ### Definition \`\`\`luau function crypt.hash.sha512(data: string): string \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ---------------- | | data | string | The data to hash | ### Returns | Type | | ------ | | string | ### Description Computes the SHA-512 hash of the input data. \*\*\* ## crypt.hash.blake2b ### Definition \`\`\`luau function crypt.hash.blake2b(data: string): string \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ---------------- | | data | string | The data to hash | ### Returns | Type | | ------ | | string | ### Description Computes the BLAKE2b hash of the input data. \*\*\* ## Password Hashing ## crypt.pwhash ### Definition \`\`\`luau function crypt.pwhash(password: string, salt: string?): string \`\`\` ### Parameters | Name | Type | Description | | -------- | ------- | ------------------------- | | password | string | The password to hash | | salt | string? | Optional salt for hashing | ### Returns | Type | | ------ | | string | ### Description Hashes a password using a secure password hashing algorithm. If salt is not provided, one is generated automatically. \*\*\* ## crypt.pwhash\\\_str ### Definition \`\`\`luau function crypt.pwhash\_str(password: string): string \`\`\` ### Parameters | Name | Type | Description | | -------- | ------ | -------------------- | | password | string | The password to hash | ### Returns | Type | | ------ | | string | ### Description Hashes a password and returns a string that includes the salt and hash parameters for later verification. \*\*\* ## crypt.pwhash\\\_str\\\_verify ### Definition \`\`\`luau function crypt.pwhash\_str\_verify(hash: string, password: string): boolean \`\`\` ### Parameters | Name | Type | Description | | -------- | ------ | -------------------------------- | | hash | string | The hash string from pwhash\\\_str | | password | string | The password to verify | ### Returns | Type | | ------- | | boolean | ### Description Verifies a password against a hash string created by \`pwhash\_str\`. \*\*\* ## Secretbox ## crypt.secretbox.seal ### Definition \`\`\`luau function crypt.secretbox.seal(message: string, nonce: string, key: string): string \`\`\` ### Parameters | Name | Type | Description | | ------- | ------ | ---------------------------- | | message | string | The message to encrypt | | nonce | string | The nonce (number used once) | | key | string | The secret key | ### Returns | Type | | ------ | | string | ### Description Encrypts a message using secret-key authenticated encryption. \*\*\* ## crypt.secretbox.open ### Definition \`\`\`luau function crypt.secretbox.open(cipher: string, nonce: string, key: string): string \`\`\` ### Parameters | Name | Type | Description | | ------ | ------ | ---------------------------- | | cipher | string | The encrypted message | | nonce | string | The nonce (number used once) | | key | string | The secret key | ### Returns | Type | | ------ | | string | ### Description Decrypts a message encrypted with \`secretbox.seal\`. \*\*\* ## AEAD ## crypt.aead.encrypt ### Definition \`\`\`luau function crypt.aead.encrypt(message: string, aad: string, nonce: string, key: string): string \`\`\` ### Parameters | Name | Type | Description | | ------- | ------ | ----------------------------- | | message | string | The message to encrypt | | aad | string | Additional authenticated data | | nonce | string | The nonce (number used once) | | key | string | The secret key | ### Returns | Type | | ------ | | string | ### Description Encrypts a message using authenticated encryption with associated data (AEAD). \*\*\* ## crypt.aead.decrypt ### Definition \`\`\`luau function crypt.aead.decrypt(cipher: string, aad: string, nonce: string, key: string): string \`\`\` ### Parameters | Name | Type | Description | | ------ | ------ | ----------------------------- | | cipher | string | The encrypted message | | aad | string | Additional authenticated data | | nonce | string | The nonce (number used once) | | key | string | The secret key | ### Returns | Type | | ------ | | string | ### Description Decrypts a message encrypted with \`aead.encrypt\`. \*\*\* ## Public-Key Box ## crypt.box.keypair ### Definition \`\`\`luau function crypt.box.keypair(): (string, string) \`\`\` ### Returns | Type | | ---------------- | | (string, string) | ### Description Generates a new public-key pair for box encryption. Returns \`(publicKey, secretKey)\`. \*\*\* ## crypt.box.encrypt ### Definition \`\`\`luau function crypt.box.encrypt(message: string, nonce: string, publicKey: string, secretKey: string): string \`\`\` ### Parameters | Name | Type | Description | | --------- | ------ | ---------------------------- | | message | string | The message to encrypt | | nonce | string | The nonce (number used once) | | publicKey | string | The recipient's public key | | secretKey | string | The sender's secret key | ### Returns | Type | | ------ | | string | ### Description Encrypts a message using public-key authenticated encryption. \*\*\* ## crypt.box.decrypt ### Definition \`\`\`luau function crypt.box.decrypt(cipher: string, nonce: string, publicKey: string, secretKey: string): string \`\`\` ### Parameters | Name | Type | Description | | --------- | ------ | ---------------------------- | | cipher | string | The encrypted message | | nonce | string | The nonce (number used once) | | publicKey | string | The sender's public key | | secretKey | string | The recipient's secret key | ### Returns | Type | | ------ | | string | ### Description Decrypts a message encrypted with \`box.encrypt\`. \*\*\* ## crypt.box.seal ### Definition \`\`\`luau function crypt.box.seal(message: string, publicKey: string): string \`\`\` ### Parameters | Name | Type | Description | | --------- | ------ | -------------------------- | | message | string | The message to encrypt | | publicKey | string | The recipient's public key | ### Returns | Type | | ------ | | string | ### Description Encrypts a message using sealed box encryption (anonymous sender). \*\*\* ## crypt.box.open ### Definition \`\`\`luau function crypt.box.open(cipher: string, publicKey: string, secretKey: string): string \`\`\` ### Parameters | Name | Type | Description | | --------- | ------ | -------------------------- | | cipher | string | The encrypted message | | publicKey | string | The recipient's public key | | secretKey | string | The recipient's secret key | ### Returns | Type | | ------ | | string | ### Description Decrypts a message encrypted with \`box.seal\`. \*\*\* ## crypt.box.beforenm ### Definition \`\`\`luau function crypt.box.beforenm(publicKey: string, secretKey: string): string \`\`\` ### Parameters | Name | Type | Description | | --------- | ------ | ---------------------------- | | publicKey | string | The other party's public key | | secretKey | string | Your secret key | ### Returns | Type | | ------ | | string | ### Description Computes a shared secret for faster encryption/decryption between the same parties. \*\*\* ## Signing ## crypt.sign.keypair ### Definition \`\`\`luau function crypt.sign.keypair(): (string, string) \`\`\` ### Returns | Type | | ---------------- | | (string, string) | ### Description Generates a new key pair for digital signatures. Returns \`(publicKey, secretKey)\`. \*\*\* ## crypt.sign.sign ### Definition \`\`\`luau function crypt.sign.sign(message: string, secretKey: string): string \`\`\` ### Parameters | Name | Type | Description | | --------- | ------ | ---------------------- | | message | string | The message to sign | | secretKey | string | The secret signing key | ### Returns | Type | | ------ | | string | ### Description Signs a message and returns the signature concatenated with the message. \*\*\* ## crypt.sign.open ### Definition \`\`\`luau function crypt.sign.open(signedMessage: string, publicKey: string): string \`\`\` ### Parameters | Name | Type | Description | | ------------- | ------ | ------------------------------ | | signedMessage | string | The signed message from sign() | | publicKey | string | The public verification key | ### Returns | Type | | ------ | | string | ### Description Verifies and extracts the original message from a signed message. \*\*\* ## crypt.sign.detached ### Definition \`\`\`luau function crypt.sign.detached(message: string, secretKey: string): string \`\`\` ### Parameters | Name | Type | Description | | --------- | ------ | ---------------------- | | message | string | The message to sign | | secretKey | string | The secret signing key | ### Returns | Type | | ------ | | string | ### Description Signs a message and returns only the signature (detached from the message). \*\*\* ## crypt.sign.verify\\\_detached ### Definition \`\`\`luau function crypt.sign.verify\_detached(signature: string, message: string, publicKey: string): boolean \`\`\` ### Parameters | Name | Type | Description | | --------- | ------ | --------------------------- | | signature | string | The detached signature | | message | string | The original message | | publicKey | string | The public verification key | ### Returns | Type | | ------- | | boolean | ### Description Verifies a detached signature for a message. \*\*\* ## Base64 ## crypt.base64.encode ### Definition \`\`\`luau function crypt.base64.encode(data: string): string \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ------------------ | | data | string | The data to encode | ### Returns | Type | | ------ | | string | ### Description Encodes data to Base64 format. \*\*\* ## crypt.base64.decode ### Definition \`\`\`luau function crypt.base64.decode(data: string): string \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ------------------------- | | data | string | The Base64 data to decode | ### Returns | Type | | ------ | | string | ### Description Decodes Base64 encoded data. \*\*\* ## HMAC ## crypt.hmac.sha256 ### Definition \`\`\`luau function crypt.hmac.sha256(data: string, key: string): string \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ---------------- | | data | string | The data to hash | | key | string | The secret key | ### Returns | Type | | ------ | | string | ### Description Computes an HMAC using SHA-256. \*\*\* ## crypt.hmac.sha512 ### Definition \`\`\`luau function crypt.hmac.sha512(data: string, key: string): string \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ---------------- | | data | string | The data to hash | | key | string | The secret key | ### Returns | Type | | ------ | | string | ### Description Computes an HMAC using SHA-512. \*\*\* ## HKDF ## crypt.hkdf.sha256 ### Definition \`\`\`luau function crypt.hkdf.sha256(key: string, salt: string, info: string): string \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | -------------------------------- | | key | string | The input keying material | | salt | string | The salt value | | info | string | The context and application info | ### Returns | Type | | ------ | | string | ### Description Derives a key using HKDF (HMAC-based Key Derivation Function) with SHA-256. \*\*\* ## JSON ## crypt.json.encode ### Definition \`\`\`luau function crypt.json.encode(data: table): string \`\`\` ### Parameters | Name | Type | Description | | ---- | ----- | ------------------- | | data | table | The table to encode | ### Returns | Type | | ------ | | string | ### Description Encodes a Luau table to a JSON string. \*\*\* ## crypt.json.decode ### Definition \`\`\`luau function crypt.json.decode(json: string): table \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | --------------- | | json | string | The JSON string | ### Returns | Type | | ----- | | table | ### Description Decodes a JSON string to a Luau table. \*\*\* ## Hexadecimal ## crypt.hexadecimal.encode ### Definition \`\`\`luau function crypt.hexadecimal.encode(bytes: string): string \`\`\` ### Parameters | Name | Type | Description | | ----- | ------ | ------------------- | | bytes | string | The bytes to encode | ### Returns | Type | | ------ | | string | ### Description Encodes bytes to hexadecimal string representation. \*\*\* ## crypt.hexadecimal.decode ### Definition \`\`\`luau function crypt.hexadecimal.decode(hex: string): string \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ---------------------- | | hex | string | The hexadecimal string | ### Returns | Type | | ------ | | string | ### Description Decodes a hexadecimal string to bytes. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/libraries/crypt.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/enumerations.md). # Enumerations --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/enumerations.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/world/runservice.md). # RunService --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/world/runservice.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/world/billboardgui.md). # BillboardGui A GUI object that is rendered in 3D space and faces the camera. ## Adornee ### Definition \`\`\`luau BillboardGui.Adornee: Instance? \`\`\` ### Description The instance that this BillboardGui is attached to, or \`nil\` if not attached (read-only). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/world/billboardgui.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/world/instance.md). # Instance The base class for all objects in the game world. ## GetTags ### Definition \`\`\`luau function Instance:GetTags(): { string } \`\`\` ### Returns | Type | | ---------- | | { string } | ### Description Returns an array of all tags assigned to this instance. \*\*\* ## HasTag ### Definition \`\`\`luau function Instance:HasTag(tag: string): boolean \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | -------------------- | | tag | string | The tag to check for | ### Returns | Type | | ------- | | boolean | ### Description Returns \`true\` if the instance has the specified tag, otherwise \`false\`. \*\*\* ## AddTag ### Definition \`\`\`luau function Instance:AddTag(tag: string): () \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | -------------- | | tag | string | The tag to add | ### Description Adds a tag to this instance. \*\*\* ## RemoveTag ### Definition \`\`\`luau function Instance:RemoveTag(tag: string): () \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ----------------- | | tag | string | The tag to remove | ### Description Removes a tag from this instance. \*\*\* ## ClearTags ### Definition \`\`\`luau function Instance:ClearTags(): () \`\`\` ### Description Removes all tags from this instance. \*\*\* ## GetAttributes ### Definition \`\`\`luau function Instance:GetAttributes(): { \[string\]: any } \`\`\` ### Returns | Type | | ------------------ | | { \\\[string\]: any } | ### Description Returns a dictionary of all attributes assigned to this instance. \*\*\* ## GetAttribute ### Definition \`\`\`luau function Instance:GetAttribute(name: string): any \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ------------------ | | name | string | The attribute name | ### Returns | Type | | ---- | | any | ### Description Returns the value of the specified attribute, or \`nil\` if it doesn't exist. \*\*\* ## SetAttribute ### Definition \`\`\`luau function Instance:SetAttribute(name: string, value: any): () \`\`\` ### Parameters | Name | Type | Description | | ----- | ------ | ------------------- | | name | string | The attribute name | | value | any | The attribute value | ### Description Sets the value of an attribute on this instance. Setting to \`nil\` removes the attribute. \*\*\* ## FindFirstChild ### Definition \`\`\`luau function Instance:FindFirstChild(name: string): Instance? \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | --------------------- | | name | string | The name of the child | ### Returns | Type | | --------- | | Instance? | ### Description Returns the first child with the specified name, or \`nil\` if not found. \*\*\* ## FindFirstChildOfClass ### Definition \`\`\`luau function Instance:FindFirstChildOfClass(className: string): Instance? \`\`\` ### Parameters | Name | Type | Description | | --------- | ------ | -------------- | | className | string | The class name | ### Returns | Type | | --------- | | Instance? | ### Description Returns the first child of the specified class, or \`nil\` if not found. \*\*\* ## FindFirstDescendant ### Definition \`\`\`luau function Instance:FindFirstDescendant(name: string): Instance? \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | -------------------------- | | name | string | The name of the descendant | ### Returns | Type | | --------- | | Instance? | ### Description Returns the first descendant with the specified name, or \`nil\` if not found. \*\*\* ## FindFirstAncestor ### Definition \`\`\`luau function Instance:FindFirstAncestor(name: string): Instance? \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ------------------------ | | name | string | The name of the ancestor | ### Returns | Type | | --------- | | Instance? | ### Description Returns the first ancestor with the specified name, or \`nil\` if not found. \*\*\* ## FindFirstAncestorOfClass ### Definition \`\`\`luau function Instance:FindFirstAncestorOfClass(className: string): Instance? \`\`\` ### Parameters | Name | Type | Description | | --------- | ------ | -------------- | | className | string | The class name | ### Returns | Type | | --------- | | Instance? | ### Description Returns the first ancestor of the specified class, or \`nil\` if not found. \*\*\* ## GetChildren ### Definition \`\`\`luau function Instance:GetChildren(): { Instance } \`\`\` ### Returns | Type | | ------------ | | { Instance } | ### Description Returns an array of all direct children of this instance. \*\*\* ## GetDescendants ### Definition \`\`\`luau function Instance:GetDescendants(): { Instance } \`\`\` ### Returns | Type | | ------------ | | { Instance } | ### Description Returns an array of all descendants of this instance. \*\*\* ## WaitForChild ### Definition \`\`\`luau function Instance:WaitForChild(name: string, timeout: number?): Instance? \`\`\` ### Parameters | Name | Type | Description | | ------- | ------- | --------------------------------- | | name | string | The name of the child to wait for | | timeout | number? | Optional timeout in seconds | ### Returns | Type | | --------- | | Instance? | ### Description Waits for a child with the specified name to be added. Returns the child when found, or \`nil\` if timeout is reached. \*\*\* ## IsAncestorOf ### Definition \`\`\`luau function Instance:IsAncestorOf(instance: Instance): boolean \`\`\` ### Parameters | Name | Type | Description | | -------- | -------- | --------------------- | | instance | Instance | The instance to check | ### Returns | Type | | ------- | | boolean | ### Description Returns \`true\` if this instance is an ancestor of the specified instance. \*\*\* ## IsDescendantOf ### Definition \`\`\`luau function Instance:IsDescendantOf(instance: Instance): boolean \`\`\` ### Parameters | Name | Type | Description | | -------- | -------- | --------------------- | | instance | Instance | The instance to check | ### Returns | Type | | ------- | | boolean | ### Description Returns \`true\` if this instance is a descendant of the specified instance. \*\*\* ## Destroy ### Definition \`\`\`luau function Instance:Destroy(): () \`\`\` ### Description Destroys the instance and removes it from the game. All descendants are also destroyed. \*\*\* ## Name ### Definition \`\`\`luau Instance.Name: string \`\`\` ### Description The name of the instance. \*\*\* ## ClassName ### Definition \`\`\`luau Instance.ClassName: string \`\`\` ### Description The class name of the instance (read-only). \*\*\* ## Parent ### Definition \`\`\`luau Instance.Parent: Instance? \`\`\` ### Description The parent instance. Can be set to \`nil\` or another instance. \*\*\* ## Data ### Definition \`\`\`luau Instance.Data: any \`\`\` ### Description Custom data storage for the instance. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/world/instance.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/drawing/immediate.md). # Immediate ## Overview Traditional drawing uses \*\*retained mode\*\*—objects persist until removed. \*\*DrawingImmediate\*\* is \*\*immediate mode\*\*; objects exist only during \`RunService.Render\` calls. ## Examples \`\`\`luau local Players = game:GetService("Players") local CurrentCamera = workspace.CurrentCamera local RunService = game:GetService("RunService") RunService.Render:Connect(function() for Index, Player in Players:GetChildren() do local Character = Player.Character if not Character then continue end local Head = Character:FindFirstChild("Head") if not Head then continue end local Screen, Visible = CurrentCamera:WorldToScreenPoint(Head.Position) if Visible then DrawingImmediate.OutlinedText(Screen, 14, Color3.fromRGB(125, 165, 255), 1, Player.Name, true, "Tamzen") end end end) \`\`\` ## Functions Call inside \`RunService.Render\` to avoid flickering. No return values. ### Line \`\`\`luau function DrawingImmediate.Line(a: Vector2, b: Vector2, color: Color3, opacity: number, segments: number, thickness: number): () \`\`\` | Name | Type | Description | | --------- | ------- | -------------- | | a | Vector2 | Start position | | b | Vector2 | End position | | color | Color3 | Line color | | opacity | number | Opacity (0-1) | | segments | number | Line segments | | thickness | number | Line thickness | \*\*\* ### Circle \`\`\`luau function DrawingImmediate.Circle(position: Vector2, radius: number, color: Color3, opacity: number, thickness: number): () \`\`\` | Name | Type | Description | | --------- | ------- | ----------------- | | position | Vector2 | Center position | | radius | number | Circle radius | | color | Color3 | Outline color | | opacity | number | Opacity (0-1) | | thickness | number | Outline thickness | \*\*\* ### FilledCircle \`\`\`luau function DrawingImmediate.FilledCircle(position: Vector2, radius: number, color: Color3, opacity: number): () \`\`\` | Name | Type | Description | | -------- | ------- | --------------- | | position | Vector2 | Center position | | radius | number | Circle radius | | color | Color3 | Fill color | | opacity | number | Opacity (0-1) | \*\*\* ### Triangle \`\`\`luau function DrawingImmediate.Triangle(a: Vector2, b: Vector2, c: Vector2, color: Color3, opacity: number, thickness: number): () \`\`\` | Name | Type | Description | | --------- | ------- | ----------------- | | a | Vector2 | Vertex A | | b | Vector2 | Vertex B | | c | Vector2 | Vertex C | | color | Color3 | Outline color | | opacity | number | Opacity (0-1) | | thickness | number | Outline thickness | \*\*\* ### FilledTriangle \`\`\`luau function DrawingImmediate.FilledTriangle(a: Vector2, b: Vector2, c: Vector2, color: Color3, opacity: number): () \`\`\` | Name | Type | Description | | ------- | ------- | ------------- | | a | Vector2 | Vertex A | | b | Vector2 | Vertex B | | c | Vector2 | Vertex C | | color | Color3 | Fill color | | opacity | number | Opacity (0-1) | \*\*\* ### Rectangle \`\`\`luau function DrawingImmediate.Rectangle(position: Vector2, size: Vector2, color: Color3, opacity: number, thickness: number): () \`\`\` | Name | Type | Description | | --------- | ------- | ----------------- | | position | Vector2 | Top-left position | | size | Vector2 | Width/height | | color | Color3 | Outline color | | opacity | number | Opacity (0-1) | | thickness | number | Outline thickness | \*\*\* ### FilledRectangle \`\`\`luau function DrawingImmediate.FilledRectangle(position: Vector2, size: Vector2, color: Color3, opacity: number): () \`\`\` | Name | Type | Description | | -------- | ------- | ----------------- | | position | Vector2 | Top-left position | | size | Vector2 | Width/height | | color | Color3 | Fill color | | opacity | number | Opacity (0-1) | \*\*\* ### Quad \`\`\`luau function DrawingImmediate.Quad(a: Vector2, b: Vector2, c: Vector2, d: Vector2, color: Color3, opacity: number, thickness: number): () \`\`\` | Name | Type | Description | | --------- | ------- | ----------------- | | a | Vector2 | Vertex A | | b | Vector2 | Vertex B | | c | Vector2 | Vertex C | | d | Vector2 | Vertex D | | color | Color3 | Outline color | | opacity | number | Opacity (0-1) | | thickness | number | Outline thickness | \*\*\* ### FilledQuad \`\`\`luau function DrawingImmediate.FilledQuad(a: Vector2, b: Vector2, c: Vector2, d: Vector2, color: Color3, opacity: number): () \`\`\` | Name | Type | Description | | ------- | ------- | ------------- | | a | Vector2 | Vertex A | | b | Vector2 | Vertex B | | c | Vector2 | Vertex C | | d | Vector2 | Vertex D | | color | Color3 | Fill color | | opacity | number | Opacity (0-1) | \*\*\* ### Polyline \`\`\`luau function DrawingImmediate.Polyline(points: { Vector2 }, color: Color3, opacity: number, thickness: number): () \`\`\` | Name | Type | Description | | --------- | ---------- | --------------- | | points | { Vector2} | Array of points | | color | Color3 | Line color | | opacity | number | Opacity (0-1) | | thickness | number | Line thickness | \*\*\* ### Text \`\`\`luau function DrawingImmediate.Text(position: Vector2, size: number, color: Color3, opacity: number, text: string, center: boolean, font: string?): () \`\`\` | Name | Type | Description | | -------- | ------- | -------------------- | | position | Vector2 | Text position | | size | number | Text size | | color | Color3 | Text color | | opacity | number | Opacity (0-1) | | text | string | Text content | | center | boolean | Center align | | font | string? | Font name (optional) | \*\*\* ### OutlinedText \`\`\`luau function DrawingImmediate.OutlinedText(position: Vector2, size: number, color: Color3, opacity: number, text: string, center: boolean, font: string?): () \`\`\` | Name | Type | Description | | -------- | ------- | -------------------- | | position | Vector2 | Text position | | size | number | Text size | | color | Color3 | Text color | | opacity | number | Opacity (0-1) | | text | string | Text content | | center | boolean | Center align | | font | string? | Font name (optional) | \*\*\* ### Image \`\`\`luau function DrawingImmediate.Image(source: string, position: Vector2, size: Vector2, color: Color3, opacity: number, is\_gif: boolean, rounding: number): () \`\`\` | Name | Type | Description | | -------- | ------- | ---------------- | | source | string | Image URL/source | | position | Vector2 | Image position | | size | Vector2 | Image size | | color | Color3 | Tint color | | opacity | number | Opacity (0-1) | | is\\\_gif | boolean | GIF animation | | rounding | number | Corner rounding | \*\*\* ### GetTextBounds \`\`\`luau function DrawingImmediate.GetTextBounds(font: string, size: number, text: string): Vector2 \`\`\` | Name | Type | Description | | ---- | ------ | ------------ | | font | string | Font name | | size | number | Text size | | text | string | Text content |
Type
Vector2
Calculates text boundaries. Returns \`(width, height)\`. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/drawing/immediate.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle.md). # Circle ## Definition \`\`\`luau local Circle = Circle.new() -- Or, Drawing.new("Circle") \`\`\` ## Properties ### Visible \`\`\`luau Circle.Visible: boolean \`\`\` \*\*\* ### Color \`\`\`luau Circle.Color: Color3 \`\`\` \*\*\* ### ZIndex \`\`\`luau Circle.ZIndex: number \`\`\` Range \`\[-2147483647, 2147483647\]\`. \*\*\* ### Opacity \`\`\`luau Circle.Opacity: number \`\`\` \*\*\* ### Thickness \`\`\`luau Circle.Thickness: number \`\`\` \*\*\* ### NumSides \`\`\`luau Circle.NumSides: number \`\`\` \*\*\* ### Radius \`\`\`luau Circle.Radius: number \`\`\` \*\*\* ### Filled \`\`\`luau Circle.Filled: boolean \`\`\` \*\*\* ### Position \`\`\`luau Circle.Position: Vector2 \`\`\` \*\*\* ## Methods ### Remove \`\`\`luau Circle:Remove(): () \`\`\` Permanently removes the drawing object. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/drawing/classes/circle.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/world.md). # World - \[BasePart\](https://v-severe.gitbook.io/landing/reference/world/basepart.md) - \[BillboardGui\](https://v-severe.gitbook.io/landing/reference/world/billboardgui.md) - \[Camera\](https://v-severe.gitbook.io/landing/reference/world/camera.md) - \[DataModel\](https://v-severe.gitbook.io/landing/reference/world/datamodel.md) - \[Humanoid\](https://v-severe.gitbook.io/landing/reference/world/humanoid.md) - \[Instance\](https://v-severe.gitbook.io/landing/reference/world/instance.md) - \[Model\](https://v-severe.gitbook.io/landing/reference/world/model.md) - \[Player\](https://v-severe.gitbook.io/landing/reference/world/player.md) - \[Players\](https://v-severe.gitbook.io/landing/reference/world/players.md) - \[RunService\](https://v-severe.gitbook.io/landing/reference/world/runservice.md) - \[UserInputService\](https://v-severe.gitbook.io/landing/reference/world/userinputservice.md) - \[ValueBase\](https://v-severe.gitbook.io/landing/reference/world/valuebase.md) - \[Workspace\](https://v-severe.gitbook.io/landing/reference/world/workspace.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/world.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/world/player.md). # Player Represents a player in the game. ## DisplayName ### Definition \`\`\`luau Player.DisplayName: string \`\`\` ### Description The display name of the player (read-only). \*\*\* ## UserId ### Definition \`\`\`luau Player.UserId: number \`\`\` ### Description The unique user ID of the player (read-only). \*\*\* ## Character ### Definition \`\`\`luau Player.Character: Model? \`\`\` ### Description The player's character model in the game, or \`nil\` if the player doesn't have a character (read-only). \*\*\* ## Team ### Definition \`\`\`luau Player.Team: Team? \`\`\` ### Description The team the player is currently on, or \`nil\` if not on a team (read-only). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/world/player.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/world/model.md). # Model A container object that groups together parts and other instances. ## PrimaryPart ### Definition \`\`\`luau Model.PrimaryPart: BasePart? \`\`\` ### Description The primary part of the model, which serves as the reference point for model operations, or \`nil\` if no primary part is set (read-only). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/world/model.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/world/humanoid.md). # Humanoid Controls the behavior of character models, including health and movement. ## Health ### Definition \`\`\`luau Humanoid.Health: number \`\`\` ### Description The current health of the humanoid. Can be read and written. \*\*\* ## MaxHealth ### Definition \`\`\`luau Humanoid.MaxHealth: number \`\`\` ### Description The maximum health of the humanoid. Can be read and written. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/world/humanoid.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/world/players.md). # Players The Players service manages all players in the game. ## LocalPlayer ### Definition \`\`\`luau Players.LocalPlayer: Player? \`\`\` ### Description Returns the local player (the player running the script), or \`nil\` if accessed from the server (read-only). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/world/players.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/world/valuebase.md). # ValueBase Value objects are instances that store a single value of a specific type. ## Applies To \* BoolValue \* IntValue \* NumberValue \* Vector3Value \* ObjectValue \* StringValue \* CFrameValue ## Value ### Definition Depends on the ValueBase type: \`\`\`luau BoolValue.Value: boolean IntValue.Value: number NumberValue.Value: number Vector3Value.Value: Vector3 ObjectValue.Value: Instance? StringValue.Value: string CFrameValue.Value: CFrame \`\`\` ### Description The value stored by this value object. Can be read and written. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/world/valuebase.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/drawing/static.md). # Static ## Functions ### Drawing.new \*\*Definition\*\* \`\`\`luau function Drawing.new(class: string): userdata \`\`\` \*\*Parameters\*\* | Name | Type | Description | | ----- | ------ | ---------------------------------------------------------- | | class | string | Valid classes can be found under the "Classes" sub-folder. | \*\*Description\*\* Will create a new static drawing on the screen, it's retained, meaning you will have to manually describe it (set it's color, position, size), and manually clean-up. \*\*\* ### Drawing.clear \*\*Definition\*\* \`\`\`luau function Drawing.clear(): () \`\`\` \*\*Description\*\* Will clear all the static objects created, this will also include static objects that were created by other scripts. \*\*\* > \*\*Note:\*\* Not removing static drawings can result in degraded performance and memory leaks. Creating a lot of static drawings may result in render thread error, this is a known issue. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/drawing/static.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle.md). # Triangle ## Definition \`\`\`luau local Triangle = Triangle.new() -- Or, Drawing.new("Triangle") \`\`\` ## Properties ### Visible \`\`\`luau Triangle.Visible: boolean \`\`\` \*\*\* ### Color \`\`\`luau Triangle.Color: Color3 \`\`\` \*\*\* ### ZIndex \`\`\`luau Triangle.ZIndex: number \`\`\` Range \`\[-2147483647, 2147483647\]\`. \*\*\* ### Opacity \`\`\`luau Triangle.Opacity: number \`\`\` \*\*\* ### Transparency \`\`\`luau Triangle.Transparency: number \`\`\` \*\*\* ### Thickness \`\`\`luau Triangle.Thickness: number \`\`\` \*\*\* ### PointA \`\`\`luau Triangle.PointA: Vector2 \`\`\` \*\*\* ### PointB \`\`\`luau Triangle.PointB: Vector2 \`\`\` \*\*\* ### PointC \`\`\`luau Triangle.PointC: Vector2 \`\`\` \*\*\* ### Filled \`\`\`luau Triangle.Filled: boolean \`\`\` \*\*\* ## Methods ### Remove \`\`\`luau Triangle:Remove(): () \`\`\` Permanently removes the drawing object. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/world/datamodel.md). # DataModel The DataModel (accessed via the \`game\` global) is the root object of the game hierarchy. ## HttpGet ### Definition \`\`\`luau function game:HttpGet(url: string): string \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | -------------------------------- | | url | string | The URL to send a GET request to | ### Returns | Type | | ------ | | string | ### Description Sends an HTTP GET request to the specified URL and returns the response as a string. \*\*\* ## HttpPost ### Definition \`\`\`luau function game:HttpPost(url: string, data: string): string \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ------------------------------------ | | url | string | The URL to send a POST request to | | data | string | The data to send in the POST request | ### Returns | Type | | ------ | | string | ### Description Sends an HTTP POST request to the specified URL with the provided data and returns the response as a string. \*\*\* ## GetService ### Definition \`\`\`luau function game:GetService(name: string): Instance \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ----------------------- | | name | string | The name of the service | ### Returns | Type | | -------- | | Instance | ### Description Returns the service with the specified name. Creates the service if it doesn't exist. \*\*\* ## GetHwid ### Definition \`\`\`luau function game:GetHwid(): string \`\`\` ### Returns | Type | | ------ | | string | ### Description Returns the hardware ID of the current machine. \*\*\* ## GetPing ### Definition \`\`\`luau function game:GetPing(): number \`\`\` ### Returns | Type | | ------ | | number | ### Description Returns the current network ping in milliseconds. \*\*\* ## PlaceId ### Definition \`\`\`luau game.PlaceId: number \`\`\` ### Description The unique identifier for the current place (read-only). \*\*\* ## GameId ### Definition \`\`\`luau game.GameId: number \`\`\` ### Description The unique identifier for the current game (read-only). \*\*\* ## JobId ### Definition \`\`\`luau game.JobId: string \`\`\` ### Description The unique identifier for the current server job (read-only). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/world/datamodel.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/world/userinputservice.md). # UserInputService Service for handling user input such as mouse and keyboard. ## GetMouseLocation ### Definition \`\`\`luau function UserInputService:GetMouseLocation(): Vector2 \`\`\` ### Returns | Type | | ------- | | Vector2 | ### Description Returns the current mouse position as a Vector2. \*\*\* ## SetMouseLocation ### Definition \`\`\`luau function UserInputService:SetMouseLocation(x: number, y: number): () \`\`\` ### Parameters | Name | Type | Description | | ---- | ------ | ---------------- | | x | number | The X coordinate | | y | number | The Y coordinate | ### Description Sets the mouse position to the specified X and Y coordinates. \*\*\* ## MouseBehavior ### Definition \`\`\`luau UserInputService.MouseBehavior: Enum.MouseBehavior \`\`\` ### Description Controls how the mouse behaves (e.g., locked, default). Can be read and written. \*\*\* ## MouseDeltaSensitivity ### Definition \`\`\`luau UserInputService.MouseDeltaSensitivity: number \`\`\` ### Description The sensitivity of mouse movement delta. Can be read and written. \*\*\* ## MouseIconEnabled ### Definition \`\`\`luau UserInputService.MouseIconEnabled: boolean \`\`\` ### Description Determines whether the mouse icon is visible. Can be read and written. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/world/userinputservice.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/world/camera.md). # Camera The Camera object controls the player's view in the game. ## ViewportSize ### Definition \`\`\`luau Camera.ViewportSize: Vector2 \`\`\` ### Description The size of the camera's viewport in pixels (read-only). \*\*\* ## FieldOfView ### Definition \`\`\`luau Camera.FieldOfView: number \`\`\` ### Description The field of view of the camera in degrees (read-only). \*\*\* ## Position ### Definition \`\`\`luau Camera.Position: Vector3 \`\`\` ### Description The position of the camera in world space. Can be read and written. \*\*\* ## CFrame ### Definition \`\`\`luau Camera.CFrame: CFrame \`\`\` ### Description The position and orientation of the camera in world space. Can be read and written. \*\*\* ## Velocity ### Definition \`\`\`luau Camera.Velocity: Vector3 \`\`\` ### Description The current velocity of the camera. Can be read and written. \*\*\* ## RightVector ### Definition \`\`\`luau Camera.RightVector: Vector3 \`\`\` ### Description The right vector of the camera's orientation. Can be read and written. \*\*\* ## UpVector ### Definition \`\`\`luau Camera.UpVector: Vector3 \`\`\` ### Description The up vector of the camera's orientation. Can be read and written. \*\*\* ## LookVector ### Definition \`\`\`luau Camera.LookVector: Vector3 \`\`\` ### Description The forward/look vector of the camera's orientation. Can be read and written. \*\*\* ## CameraSubject ### Definition \`\`\`luau Camera.CameraSubject: Instance? \`\`\` ### Description The instance that the camera is focused on. Can be set to change the camera's subject. \*\*\* ## WorldToScreenPoint ### Definition \`\`\`luau function Camera:WorldToScreenPoint(worldPosition: Vector3): (Vector3, boolean) \`\`\` ### Parameters | Name | Type | Description | | ------------- | ------- | --------------------------- | | worldPosition | Vector3 | The position in world space | ### Returns | Type | | ------------------ | | (Vector3, boolean) | ### Description Converts a world position to screen coordinates. Returns a Vector3 with X and Y as screen coordinates (Z is depth), and a boolean indicating if the point is visible on screen. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/world/camera.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/drawing/dynamic.md). # Dynamic ## Overview Dynamic drawing allows you to automatically attach drawing objects to 3D world positions or instances. Drawing objects automatically update their screen position based on the camera's view of the linked points. ## Functions ### Drawing.attach \*\*Definition\*\* \`\`\`luau function Drawing.attach(config: { \[Drawing\]: AttachmentConfig }): Cluster \`\`\` \*\*Parameters\*\* | Name | Type | Description | | ------ | -------------------------------- | ------------------------------------------------------------------ | | config | { \\\[Drawing\]: AttachmentConfig } | A table mapping drawing objects to their attachment configurations | \*\*Returns\*\* | Type | Description | | ------- | ---------------------------------------------------------- | | Cluster | A cluster object that can be destroyed, paused, or resumed | \*\*Description\*\* Attaches drawing objects to 3D points in the world. The drawing objects will automatically update their screen positions based on the camera's view of the linked points. Each drawing object can be configured with different attachment properties depending on its type. \*\*Attachment Configurations\*\* For \`Square\`, \`Circle\`, \`Text\`, \`Image\`: | Property | Type | Description | | ----------- | ------- | ---------------------------------------- | | Link | Point | The point to attach the drawing to | | Size | UDim2 | Size of the drawing (Scale/Offset) | | AnchorPoint | Vector2 | Anchor point for positioning (0-1 range) | For \`Line\`: | Property | Type | Description | | -------- | ----- | -------------------------- | | From | Point | Starting point of the line | | To | Point | Ending point of the line | \*\*Code Samples\*\* \`\`\`luau local Head = PointInstance.new(game.Players.LocalPlayer.Character.Head :: BasePart) local Mesh = PointInstance.new(workspace.SpawnLocation :: BasePart) local Square = Drawing.new 'Square' Square.Visible = true Square.Filled = true Square.Color = Color3.fromRGB(255, 255, 125) local Line = Drawing.new 'Line' Line.Visible = true Line.Color = Color3.fromRGB(255, 0, 0) Line.Thickness = 2 local Cluster = Drawing.attach { \[Square\] = { Link = Head, Size = UDim2.fromScale(1, 1), AnchorPoint = Vector2.new(0.5, 0.5) }, \[Line\] = { From = Head, To = Mesh, } } task.wait(10) -- Later, when done: Cluster:Destroy() \`\`\` \*\*\* ## Classes ### PointInstance \*\*Definition\*\* \`\`\`luau PointInstance.new(instance: BasePart): PointInstance \`\`\` \*\*Description\*\* Creates a point tracker for an instance with a CFrame property. The point automatically tracks the instance's position in the world. Only instances that have a CFrame property (e.g., BasePart) can be used. \*\*Properties\*\* | Property | Type | Description | | -------- | ------- | --------------------------------------------------- | | CFrame | CFrame | The current CFrame of the tracked instance | | Size | Vector3 | The current Size of the tracked instance | | Active | boolean | Whether the point is actively tracking the instance | \*\*Methods\*\* | Method | Description | | ------- | -------------------------------------- | | Destroy | Stops tracking and cleans up resources | \*\*Code Samples\*\* \`\`\`luau local Head = PointInstance.new(game.Players.LocalPlayer.Character.Head :: BasePart) -- Access properties print(Head.CFrame) print(Head.Size) print(Head.Active) task.wait(10) -- Clean up: Head:Destroy() \`\`\` \*\*\* ### Point3D \*\*Definition\*\* \`\`\`luau Point3D.new(position: Vector3): Point3D \`\`\` \*\*Description\*\* Creates a point at a fixed world-space position. The point represents a static location in 3D space. \*\*Properties\*\* | Property | Type | Description | | -------- | ------- | ------------------------------------- | | Position | Vector3 | The world-space position of the point | | Active | boolean | Whether the point is active | \*\*Methods\*\* | Method | Description | | ------- | ------------------------------------- | | Destroy | Cleans up the point and its resources | \*\*Code Samples\*\* \`\`\`luau local StaticPoint = Point3D.new(Vector3.new(0, 10, 0)) -- Access properties print(StaticPoint.Position) print(StaticPoint.Active) -- Clean up when done StaticPoint:Destroy() \`\`\` \*\*\* ### Cluster \*\*Description\*\* A cluster is returned by \`Drawing.attach\` and manages a group of attached drawing objects. It provides methods to control the lifecycle of all attached drawings. \*\*Methods\*\* | Method | Description | | ------- | --------------------------------------------------------- | | Destroy | Destroys the cluster and all attached drawing objects | | Pause | Pauses automatic updates for all drawings in the cluster | | Resume | Resumes automatic updates for all drawings in the cluster | \*\*Code Samples\*\* \`\`\`luau local Head = PointInstance.new(game.Players.LocalPlayer.Character.Head :: BasePart) local Square = Drawing.new 'Square' Square.Visible = true local Cluster = Drawing.attach { \[Square\] = { Link = Head, Size = UDim2.fromScale(1, 1), AnchorPoint = Vector2.new(0.5, 0.5) } } -- Pause updates Cluster:Pause() -- Resume updates Cluster:Resume() -- Clean up everything Cluster:Destroy() \`\`\` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/drawing/dynamic.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/drawing/classes/polyline.md). # Polyline ## Definition \`\`\`luau local Polyline = Polyline.new() -- Or, Drawing.new("Polyline") \`\`\` ## Properties ### Visible \`\`\`luau Polyline.Visible: boolean \`\`\` \*\*\* ### Color \`\`\`luau Polyline.Color: Color3 \`\`\` \*\*\* ### ZIndex \`\`\`luau Polyline.ZIndex: number \`\`\` Range \`\[-2147483647, 2147483647\]\`. \*\*\* ### Opacity \`\`\`luau Polyline.Opacity: number \`\`\` \*\*\* ### Points \`\`\`luau Polyline.Points: { Vector2 } \`\`\` An array of Vector2 points that make up the polyline. \*\*\* ### Thickness \`\`\`luau Polyline.Thickness: number \`\`\` \*\*\* ### Filled \`\`\`luau Polyline.Filled: boolean \`\`\` \*\*\* ## Methods ### Remove \`\`\`luau Polyline:Remove(): () \`\`\` Permanently removes the drawing object. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/drawing/classes/polyline.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/world/basepart.md). # BasePart BasePart is the base class for all physical part objects in the game world. ## Applies To \* Part \* MeshPart \* UnionOperation \* SpawnLocation \* CornerWedgePart \* TrussPart \* WedgePart ## CanCollide ### Definition \`\`\`luau BasePart.CanCollide: boolean \`\`\` ### Description Determines whether the part can collide with other parts. Can be read and written. \*\*\* ## Transparency ### Definition \`\`\`luau BasePart.Transparency: number \`\`\` ### Description The transparency of the part, ranging from 0 (opaque) to 1 (fully transparent). Can be read and written. \*\*\* ## Size ### Definition \`\`\`luau BasePart.Size: Vector3 \`\`\` ### Description The size of the part in studs. Can be read and written. \*\*\* ## Position ### Definition \`\`\`luau BasePart.Position: Vector3 \`\`\` ### Description The position of the part in world space. Can be read and written. \*\*\* ## CFrame ### Definition \`\`\`luau BasePart.CFrame: CFrame \`\`\` ### Description The position and orientation of the part in world space. Can be read and written. \*\*\* ## Velocity ### Definition \`\`\`luau BasePart.Velocity: Vector3 \`\`\` ### Description The current velocity of the part. Can be read and written. \*\*\* ## RightVector ### Definition \`\`\`luau BasePart.RightVector: Vector3 \`\`\` ### Description The right vector of the part's orientation (read-only). \*\*\* ## UpVector ### Definition \`\`\`luau BasePart.UpVector: Vector3 \`\`\` ### Description The up vector of the part's orientation (read-only). \*\*\* ## LookVector ### Definition \`\`\`luau BasePart.LookVector: Vector3 \`\`\` ### Description The forward/look vector of the part's orientation (read-only). \*\*\* ## IsNetworkSleeping ### Definition \`\`\`luau BasePart.IsNetworkSleeping: boolean \`\`\` ### Description Indicates whether the part is currently network sleeping (read-only). \*\*\* ## Description ### Definition \`\`\`luau BasePart.Description: string \`\`\` ### Description A user-defined description for the part. Can be read and written. \*\*\* ## TextureId \*\*Applies to: MeshPart, SpecialMesh\*\* ### Definition \`\`\`luau MeshPart.TextureId: string SpecialMesh.TextureId: string \`\`\` ### Description The asset ID of the texture applied to the mesh. Can be read and written. \*\*\* ## MeshId \*\*Applies to: MeshPart, SpecialMesh\*\* ### Definition \`\`\`luau MeshPart.MeshId: string SpecialMesh.MeshId: string \`\`\` ### Description The asset ID of the mesh geometry. Can be read and written. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/world/basepart.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/drawing/classes.md). # Classes - \[Circle\](https://v-severe.gitbook.io/landing/reference/drawing/classes/circle.md) - \[Image\](https://v-severe.gitbook.io/landing/reference/drawing/classes/image.md) - \[Polyline\](https://v-severe.gitbook.io/landing/reference/drawing/classes/polyline.md) - \[Square\](https://v-severe.gitbook.io/landing/reference/drawing/classes/square.md) - \[Text\](https://v-severe.gitbook.io/landing/reference/drawing/classes/text.md) - \[Triangle\](https://v-severe.gitbook.io/landing/reference/drawing/classes/triangle.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/drawing/classes.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://v-severe.gitbook.io/landing/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://v-severe.gitbook.io/landing/reference/world/workspace.md). # Workspace The Workspace service contains all of the physical objects in the game world. ## CurrentCamera ### Definition \`\`\`luau workspace.CurrentCamera: Camera? \`\`\` ### Description The current camera being used for rendering, or \`nil\` if no camera is set (read-only). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://v-severe.gitbook.io/landing/reference/world/workspace.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. ---