# Table of Contents - [KeyCode | RbxCli](#keycode-rbxcli) - [RbxCli | RbxCli](#rbxcli-rbxcli) - [KeyCode | RbxCli](#keycode-rbxcli) - [Introduction | RbxCli](#introduction-rbxcli) - [ProcessWriteResult | RbxCli](#processwriteresult-rbxcli) - [ProcessReadResult | RbxCli](#processreadresult-rbxcli) - [global | RbxCli](#global-rbxcli) - [input | RbxCli](#input-rbxcli) - [physics | RbxCli](#physics-rbxcli) - [rendering | RbxCli](#rendering-rbxcli) - [rbxcli | RbxCli](#rbxcli-rbxcli) - [memory | RbxCli](#memory-rbxcli) - [ProductInformation | RbxCli](#productinformation-rbxcli) - [BasePart | RbxCli](#basepart-rbxcli) - [Security | RbxCli](#security-rbxcli) - [RakNet IDs | RbxCli](#raknet-ids-rbxcli) - [DataModel | RbxCli](#datamodel-rbxcli) - [Instance | RbxCli](#instance-rbxcli) - [LuaSourceContainer | RbxCli](#luasourcecontainer-rbxcli) - [Yielding | RbxCli](#yielding-rbxcli) --- # KeyCode | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/api#__docusaurus_skipToContent_fallback) On this page Properties[​](https://rbxcli.github.io/eUNC/api#properties "Direct link to Properties") ---------------------------------------------------------------------------------------- ### `LeftButton`[​](https://rbxcli.github.io/eUNC/api#LeftButton "Direct link to LeftButton") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L200) `KeyCode.LeftButton:` `number` ### `RightButton`[​](https://rbxcli.github.io/eUNC/api#RightButton "Direct link to RightButton") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L205) `KeyCode.RightButton:` `number` ### `MiddleButton`[​](https://rbxcli.github.io/eUNC/api#MiddleButton "Direct link to MiddleButton") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L210) `KeyCode.MiddleButton:` `number` ### `Backspace`[​](https://rbxcli.github.io/eUNC/api#Backspace "Direct link to Backspace") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L215) `KeyCode.Backspace:` `number` ### `Tab`[​](https://rbxcli.github.io/eUNC/api#Tab "Direct link to Tab") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L220) `KeyCode.Tab:` `number` ### `Clear`[​](https://rbxcli.github.io/eUNC/api#Clear "Direct link to Clear") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L225) `KeyCode.Clear:` `number` ### `Return`[​](https://rbxcli.github.io/eUNC/api#Return "Direct link to Return") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L230) `KeyCode.Return:` `number` ### `Shift`[​](https://rbxcli.github.io/eUNC/api#Shift "Direct link to Shift") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L235) `KeyCode.Shift:` `number` ### `Control`[​](https://rbxcli.github.io/eUNC/api#Control "Direct link to Control") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L240) `KeyCode.Control:` `number` ### `Alt`[​](https://rbxcli.github.io/eUNC/api#Alt "Direct link to Alt") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L245) `KeyCode.Alt:` `number` ### `Pause`[​](https://rbxcli.github.io/eUNC/api#Pause "Direct link to Pause") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L250) `KeyCode.Pause:` `number` ### `CapsLock`[​](https://rbxcli.github.io/eUNC/api#CapsLock "Direct link to CapsLock") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L255) `KeyCode.CapsLock:` `number` ### `Escape`[​](https://rbxcli.github.io/eUNC/api#Escape "Direct link to Escape") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L260) `KeyCode.Escape:` `number` ### `Space`[​](https://rbxcli.github.io/eUNC/api#Space "Direct link to Space") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L265) `KeyCode.Space:` `number` ### `PageUp`[​](https://rbxcli.github.io/eUNC/api#PageUp "Direct link to PageUp") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L270) `KeyCode.PageUp:` `number` ### `PageDown`[​](https://rbxcli.github.io/eUNC/api#PageDown "Direct link to PageDown") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L275) `KeyCode.PageDown:` `number` ### `End`[​](https://rbxcli.github.io/eUNC/api#End "Direct link to End") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L280) `KeyCode.End:` `number` ### `Home`[​](https://rbxcli.github.io/eUNC/api#Home "Direct link to Home") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L285) `KeyCode.Home:` `number` ### `Left`[​](https://rbxcli.github.io/eUNC/api#Left "Direct link to Left") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L291) `KeyCode.Left:` `number` ### `Up`[​](https://rbxcli.github.io/eUNC/api#Up "Direct link to Up") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L296) `KeyCode.Up:` `number` ### `Right`[​](https://rbxcli.github.io/eUNC/api#Right "Direct link to Right") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L301) `KeyCode.Right:` `number` ### `Down`[​](https://rbxcli.github.io/eUNC/api#Down "Direct link to Down") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L306) `KeyCode.Down:` `number` ### `Select`[​](https://rbxcli.github.io/eUNC/api#Select "Direct link to Select") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L312) `KeyCode.Select:` `number` ### `Print`[​](https://rbxcli.github.io/eUNC/api#Print "Direct link to Print") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L317) `KeyCode.Print:` `number` ### `Execute`[​](https://rbxcli.github.io/eUNC/api#Execute "Direct link to Execute") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L322) `KeyCode.Execute:` `number` ### `PrintScreen`[​](https://rbxcli.github.io/eUNC/api#PrintScreen "Direct link to PrintScreen") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L327) `KeyCode.PrintScreen:` `number` ### `Insert`[​](https://rbxcli.github.io/eUNC/api#Insert "Direct link to Insert") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L332) `KeyCode.Insert:` `number` ### `Delete`[​](https://rbxcli.github.io/eUNC/api#Delete "Direct link to Delete") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L337) `KeyCode.Delete:` `number` ### `Help`[​](https://rbxcli.github.io/eUNC/api#Help "Direct link to Help") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L342) `KeyCode.Help:` `number` ### `Zero`[​](https://rbxcli.github.io/eUNC/api#Zero "Direct link to Zero") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L348) `KeyCode.Zero:` `number` ### `One`[​](https://rbxcli.github.io/eUNC/api#One "Direct link to One") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L353) `KeyCode.One:` `number` ### `Two`[​](https://rbxcli.github.io/eUNC/api#Two "Direct link to Two") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L358) `KeyCode.Two:` `number` ### `Three`[​](https://rbxcli.github.io/eUNC/api#Three "Direct link to Three") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L363) `KeyCode.Three:` `number` ### `Four`[​](https://rbxcli.github.io/eUNC/api#Four "Direct link to Four") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L368) `KeyCode.Four:` `number` ### `Five`[​](https://rbxcli.github.io/eUNC/api#Five "Direct link to Five") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L373) `KeyCode.Five:` `number` ### `Six`[​](https://rbxcli.github.io/eUNC/api#Six "Direct link to Six") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L378) `KeyCode.Six:` `number` ### `Seven`[​](https://rbxcli.github.io/eUNC/api#Seven "Direct link to Seven") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L383) `KeyCode.Seven:` `number` ### `Eight`[​](https://rbxcli.github.io/eUNC/api#Eight "Direct link to Eight") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L388) `KeyCode.Eight:` `number` ### `Nine`[​](https://rbxcli.github.io/eUNC/api#Nine "Direct link to Nine") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L393) `KeyCode.Nine:` `number` ### `A`[​](https://rbxcli.github.io/eUNC/api#A "Direct link to A") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L399) `KeyCode.A:` `number` ### `B`[​](https://rbxcli.github.io/eUNC/api#B "Direct link to B") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L404) `KeyCode.B:` `number` ### `C`[​](https://rbxcli.github.io/eUNC/api#C "Direct link to C") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L409) `KeyCode.C:` `number` ### `D`[​](https://rbxcli.github.io/eUNC/api#D "Direct link to D") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L414) `KeyCode.D:` `number` ### `E`[​](https://rbxcli.github.io/eUNC/api#E "Direct link to E") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L419) `KeyCode.E:` `number` ### `F`[​](https://rbxcli.github.io/eUNC/api#F "Direct link to F") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L424) `KeyCode.F:` `number` ### `G`[​](https://rbxcli.github.io/eUNC/api#G "Direct link to G") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L429) `KeyCode.G:` `number` ### `H`[​](https://rbxcli.github.io/eUNC/api#H "Direct link to H") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L434) `KeyCode.H:` `number` ### `I`[​](https://rbxcli.github.io/eUNC/api#I "Direct link to I") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L439) `KeyCode.I:` `number` ### `J`[​](https://rbxcli.github.io/eUNC/api#J "Direct link to J") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L444) `KeyCode.J:` `number` ### `K`[​](https://rbxcli.github.io/eUNC/api#K "Direct link to K") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L449) `KeyCode.K:` `number` ### `L`[​](https://rbxcli.github.io/eUNC/api#L "Direct link to L") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L454) `KeyCode.L:` `number` ### `M`[​](https://rbxcli.github.io/eUNC/api#M "Direct link to M") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L459) `KeyCode.M:` `number` ### `N`[​](https://rbxcli.github.io/eUNC/api#N "Direct link to N") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L464) `KeyCode.N:` `number` ### `O`[​](https://rbxcli.github.io/eUNC/api#O "Direct link to O") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L469) `KeyCode.O:` `number` ### `P`[​](https://rbxcli.github.io/eUNC/api#P "Direct link to P") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L474) `KeyCode.P:` `number` ### `Q`[​](https://rbxcli.github.io/eUNC/api#Q "Direct link to Q") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L479) `KeyCode.Q:` `number` ### `R`[​](https://rbxcli.github.io/eUNC/api#R "Direct link to R") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L484) `KeyCode.R:` `number` ### `S`[​](https://rbxcli.github.io/eUNC/api#S "Direct link to S") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L489) `KeyCode.S:` `number` ### `T`[​](https://rbxcli.github.io/eUNC/api#T "Direct link to T") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L494) `KeyCode.T:` `number` ### `U`[​](https://rbxcli.github.io/eUNC/api#U "Direct link to U") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L499) `KeyCode.U:` `number` ### `V`[​](https://rbxcli.github.io/eUNC/api#V "Direct link to V") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L504) `KeyCode.V:` `number` ### `W`[​](https://rbxcli.github.io/eUNC/api#W "Direct link to W") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L509) `KeyCode.W:` `number` ### `X`[​](https://rbxcli.github.io/eUNC/api#X "Direct link to X") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L514) `KeyCode.X:` `number` ### `Y`[​](https://rbxcli.github.io/eUNC/api#Y "Direct link to Y") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L519) `KeyCode.Y:` `number` ### `Z`[​](https://rbxcli.github.io/eUNC/api#Z "Direct link to Z") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L524) `KeyCode.Z:` `number` ### `LWin`[​](https://rbxcli.github.io/eUNC/api#LWin "Direct link to LWin") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L529) `KeyCode.LWin:` `number` ### `RWin`[​](https://rbxcli.github.io/eUNC/api#RWin "Direct link to RWin") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L534) `KeyCode.RWin:` `number` ### `Apps`[​](https://rbxcli.github.io/eUNC/api#Apps "Direct link to Apps") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L539) `KeyCode.Apps:` `number` ### `NumPad0`[​](https://rbxcli.github.io/eUNC/api#NumPad0 "Direct link to NumPad0") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L544) `KeyCode.NumPad0:` `number` ### `NumPad1`[​](https://rbxcli.github.io/eUNC/api#NumPad1 "Direct link to NumPad1") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L549) `KeyCode.NumPad1:` `number` ### `NumPad2`[​](https://rbxcli.github.io/eUNC/api#NumPad2 "Direct link to NumPad2") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L554) `KeyCode.NumPad2:` `number` ### `NumPad3`[​](https://rbxcli.github.io/eUNC/api#NumPad3 "Direct link to NumPad3") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L559) `KeyCode.NumPad3:` `number` ### `NumPad4`[​](https://rbxcli.github.io/eUNC/api#NumPad4 "Direct link to NumPad4") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L564) `KeyCode.NumPad4:` `number` ### `NumPad5`[​](https://rbxcli.github.io/eUNC/api#NumPad5 "Direct link to NumPad5") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L569) `KeyCode.NumPad5:` `number` ### `NumPad6`[​](https://rbxcli.github.io/eUNC/api#NumPad6 "Direct link to NumPad6") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L574) `KeyCode.NumPad6:` `number` ### `NumPad7`[​](https://rbxcli.github.io/eUNC/api#NumPad7 "Direct link to NumPad7") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L579) `KeyCode.NumPad7:` `number` ### `NumPad8`[​](https://rbxcli.github.io/eUNC/api#NumPad8 "Direct link to NumPad8") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L584) `KeyCode.NumPad8:` `number` ### `NumPad9`[​](https://rbxcli.github.io/eUNC/api#NumPad9 "Direct link to NumPad9") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L589) `KeyCode.NumPad9:` `number` ### `Multiply`[​](https://rbxcli.github.io/eUNC/api#Multiply "Direct link to Multiply") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L594) `KeyCode.Multiply:` `number` ### `Add`[​](https://rbxcli.github.io/eUNC/api#Add "Direct link to Add") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L599) `KeyCode.Add:` `number` ### `Separator`[​](https://rbxcli.github.io/eUNC/api#Separator "Direct link to Separator") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L604) `KeyCode.Separator:` `number` ### `Subtract`[​](https://rbxcli.github.io/eUNC/api#Subtract "Direct link to Subtract") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L609) `KeyCode.Subtract:` `number` ### `Decimal`[​](https://rbxcli.github.io/eUNC/api#Decimal "Direct link to Decimal") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L614) `KeyCode.Decimal:` `number` ### `Divide`[​](https://rbxcli.github.io/eUNC/api#Divide "Direct link to Divide") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L619) `KeyCode.Divide:` `number` ### `F1`[​](https://rbxcli.github.io/eUNC/api#F1 "Direct link to F1") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L624) `KeyCode.F1:` `number` ### `F2`[​](https://rbxcli.github.io/eUNC/api#F2 "Direct link to F2") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L629) `KeyCode.F2:` `number` ### `F3`[​](https://rbxcli.github.io/eUNC/api#F3 "Direct link to F3") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L634) `KeyCode.F3:` `number` ### `F4`[​](https://rbxcli.github.io/eUNC/api#F4 "Direct link to F4") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L639) `KeyCode.F4:` `number` ### `F5`[​](https://rbxcli.github.io/eUNC/api#F5 "Direct link to F5") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L644) `KeyCode.F5:` `number` ### `F6`[​](https://rbxcli.github.io/eUNC/api#F6 "Direct link to F6") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L649) `KeyCode.F6:` `number` ### `F7`[​](https://rbxcli.github.io/eUNC/api#F7 "Direct link to F7") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L654) `KeyCode.F7:` `number` ### `F8`[​](https://rbxcli.github.io/eUNC/api#F8 "Direct link to F8") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L659) `KeyCode.F8:` `number` ### `F9`[​](https://rbxcli.github.io/eUNC/api#F9 "Direct link to F9") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L664) `KeyCode.F9:` `number` ### `F10`[​](https://rbxcli.github.io/eUNC/api#F10 "Direct link to F10") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L669) `KeyCode.F10:` `number` ### `F11`[​](https://rbxcli.github.io/eUNC/api#F11 "Direct link to F11") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L674) `KeyCode.F11:` `number` ### `F12`[​](https://rbxcli.github.io/eUNC/api#F12 "Direct link to F12") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L679) `KeyCode.F12:` `number` ### `NumLock`[​](https://rbxcli.github.io/eUNC/api#NumLock "Direct link to NumLock") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L684) `KeyCode.NumLock:` `number` ### `ScrollLock`[​](https://rbxcli.github.io/eUNC/api#ScrollLock "Direct link to ScrollLock") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L689) `KeyCode.ScrollLock:` `number` ### `LeftShift`[​](https://rbxcli.github.io/eUNC/api#LeftShift "Direct link to LeftShift") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L694) `KeyCode.LeftShift:` `number` ### `RightShift`[​](https://rbxcli.github.io/eUNC/api#RightShift "Direct link to RightShift") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L699) `KeyCode.RightShift:` `number` ### `LeftControl`[​](https://rbxcli.github.io/eUNC/api#LeftControl "Direct link to LeftControl") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L704) `KeyCode.LeftControl:` `number` ### `RightControl`[​](https://rbxcli.github.io/eUNC/api#RightControl "Direct link to RightControl") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L709) `KeyCode.RightControl:` `number` ### `LeftAlt`[​](https://rbxcli.github.io/eUNC/api#LeftAlt "Direct link to LeftAlt") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L714) `KeyCode.LeftAlt:` `number` ### `RightAlt`[​](https://rbxcli.github.io/eUNC/api#RightAlt "Direct link to RightAlt") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L719) `KeyCode.RightAlt:` `number` Show raw api { "functions": \[\], "properties": \[\ {\ "name": "LeftButton",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 200,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "RightButton",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 205,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "MiddleButton",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 210,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Backspace",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 215,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Tab",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 220,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Clear",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 225,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Return",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 230,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Shift",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 235,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Control",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 240,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Alt",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 245,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Pause",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 250,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "CapsLock",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 255,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Escape",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 260,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Space",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 265,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "PageUp",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 270,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "PageDown",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 275,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "End",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 280,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Home",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 285,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Left",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 291,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Up",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 296,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Right",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 301,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Down",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 306,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Select",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 312,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Print",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 317,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Execute",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 322,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "PrintScreen",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 327,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Insert",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 332,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Delete",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 337,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Help",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 342,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Zero",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 348,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "One",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 353,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Two",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 358,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Three",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 363,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Four",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 368,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Five",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 373,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Six",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 378,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Seven",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 383,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Eight",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 388,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Nine",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 393,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "A",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 399,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "B",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 404,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "C",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 409,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "D",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 414,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "E",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 419,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 424,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "G",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 429,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "H",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 434,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "I",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 439,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "J",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 444,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "K",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 449,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "L",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 454,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "M",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 459,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "N",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 464,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "O",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 469,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "P",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 474,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Q",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 479,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "R",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 484,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "S",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 489,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "T",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 494,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "U",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 499,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "V",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 504,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "W",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 509,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "X",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 514,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Y",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 519,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Z",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 524,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "LWin",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 529,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "RWin",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 534,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Apps",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 539,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad0",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 544,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad1",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 549,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad2",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 554,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad3",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 559,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad4",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 564,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad5",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 569,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad6",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 574,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad7",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 579,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad8",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 584,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad9",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 589,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Multiply",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 594,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Add",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 599,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Separator",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 604,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Subtract",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 609,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Decimal",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 614,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Divide",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 619,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F1",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 624,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F2",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 629,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F3",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 634,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F4",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 639,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F5",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 644,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F6",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 649,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F7",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 654,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F8",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 659,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F9",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 664,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F10",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 669,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F11",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 674,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F12",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 679,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumLock",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 684,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "ScrollLock",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 689,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "LeftShift",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 694,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "RightShift",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 699,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "LeftControl",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 704,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "RightControl",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 709,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "LeftAlt",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 714,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "RightAlt",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 719,\ "path": "src/libraries/input.luau"\ }\ }\ \], "types": \[\], "name": "KeyCode", "desc": "Defines the available virtual key codes for input operations (Win32 VK Codes).\\r", "tags": \[\ "Library"\ \], "source": { "line": 195, "path": "src/libraries/input.luau" } } * [Properties](https://rbxcli.github.io/eUNC/api#properties) * [A](https://rbxcli.github.io/eUNC/api#A) * [Add](https://rbxcli.github.io/eUNC/api#Add) * [Alt](https://rbxcli.github.io/eUNC/api#Alt) * [Apps](https://rbxcli.github.io/eUNC/api#Apps) * [B](https://rbxcli.github.io/eUNC/api#B) * [Backspace](https://rbxcli.github.io/eUNC/api#Backspace) * [C](https://rbxcli.github.io/eUNC/api#C) * [CapsLock](https://rbxcli.github.io/eUNC/api#CapsLock) * [Clear](https://rbxcli.github.io/eUNC/api#Clear) * [Control](https://rbxcli.github.io/eUNC/api#Control) * [D](https://rbxcli.github.io/eUNC/api#D) * [Decimal](https://rbxcli.github.io/eUNC/api#Decimal) * [Delete](https://rbxcli.github.io/eUNC/api#Delete) * [Divide](https://rbxcli.github.io/eUNC/api#Divide) * [Down](https://rbxcli.github.io/eUNC/api#Down) * [E](https://rbxcli.github.io/eUNC/api#E) * [Eight](https://rbxcli.github.io/eUNC/api#Eight) * [End](https://rbxcli.github.io/eUNC/api#End) * [Escape](https://rbxcli.github.io/eUNC/api#Escape) * [Execute](https://rbxcli.github.io/eUNC/api#Execute) * [F](https://rbxcli.github.io/eUNC/api#F) * [F1](https://rbxcli.github.io/eUNC/api#F1) * [F10](https://rbxcli.github.io/eUNC/api#F10) * [F11](https://rbxcli.github.io/eUNC/api#F11) * [F12](https://rbxcli.github.io/eUNC/api#F12) * [F2](https://rbxcli.github.io/eUNC/api#F2) * [F3](https://rbxcli.github.io/eUNC/api#F3) * [F4](https://rbxcli.github.io/eUNC/api#F4) * [F5](https://rbxcli.github.io/eUNC/api#F5) * [F6](https://rbxcli.github.io/eUNC/api#F6) * [F7](https://rbxcli.github.io/eUNC/api#F7) * [F8](https://rbxcli.github.io/eUNC/api#F8) * [F9](https://rbxcli.github.io/eUNC/api#F9) * [Five](https://rbxcli.github.io/eUNC/api#Five) * [Four](https://rbxcli.github.io/eUNC/api#Four) * [G](https://rbxcli.github.io/eUNC/api#G) * [H](https://rbxcli.github.io/eUNC/api#H) * [Help](https://rbxcli.github.io/eUNC/api#Help) * [Home](https://rbxcli.github.io/eUNC/api#Home) * [I](https://rbxcli.github.io/eUNC/api#I) * [Insert](https://rbxcli.github.io/eUNC/api#Insert) * [J](https://rbxcli.github.io/eUNC/api#J) * [K](https://rbxcli.github.io/eUNC/api#K) * [L](https://rbxcli.github.io/eUNC/api#L) * [Left](https://rbxcli.github.io/eUNC/api#Left) * [LeftAlt](https://rbxcli.github.io/eUNC/api#LeftAlt) * [LeftButton](https://rbxcli.github.io/eUNC/api#LeftButton) * [LeftControl](https://rbxcli.github.io/eUNC/api#LeftControl) * [LeftShift](https://rbxcli.github.io/eUNC/api#LeftShift) * [LWin](https://rbxcli.github.io/eUNC/api#LWin) * [M](https://rbxcli.github.io/eUNC/api#M) * [MiddleButton](https://rbxcli.github.io/eUNC/api#MiddleButton) * [Multiply](https://rbxcli.github.io/eUNC/api#Multiply) * [N](https://rbxcli.github.io/eUNC/api#N) * [Nine](https://rbxcli.github.io/eUNC/api#Nine) * [NumLock](https://rbxcli.github.io/eUNC/api#NumLock) * [NumPad0](https://rbxcli.github.io/eUNC/api#NumPad0) * [NumPad1](https://rbxcli.github.io/eUNC/api#NumPad1) * [NumPad2](https://rbxcli.github.io/eUNC/api#NumPad2) * [NumPad3](https://rbxcli.github.io/eUNC/api#NumPad3) * [NumPad4](https://rbxcli.github.io/eUNC/api#NumPad4) * [NumPad5](https://rbxcli.github.io/eUNC/api#NumPad5) * [NumPad6](https://rbxcli.github.io/eUNC/api#NumPad6) * [NumPad7](https://rbxcli.github.io/eUNC/api#NumPad7) * [NumPad8](https://rbxcli.github.io/eUNC/api#NumPad8) * [NumPad9](https://rbxcli.github.io/eUNC/api#NumPad9) * [O](https://rbxcli.github.io/eUNC/api#O) * [One](https://rbxcli.github.io/eUNC/api#One) * [P](https://rbxcli.github.io/eUNC/api#P) * [PageDown](https://rbxcli.github.io/eUNC/api#PageDown) * [PageUp](https://rbxcli.github.io/eUNC/api#PageUp) * [Pause](https://rbxcli.github.io/eUNC/api#Pause) * [Print](https://rbxcli.github.io/eUNC/api#Print) * [PrintScreen](https://rbxcli.github.io/eUNC/api#PrintScreen) * [Q](https://rbxcli.github.io/eUNC/api#Q) * [R](https://rbxcli.github.io/eUNC/api#R) * [Return](https://rbxcli.github.io/eUNC/api#Return) * [Right](https://rbxcli.github.io/eUNC/api#Right) * [RightAlt](https://rbxcli.github.io/eUNC/api#RightAlt) * [RightButton](https://rbxcli.github.io/eUNC/api#RightButton) * [RightControl](https://rbxcli.github.io/eUNC/api#RightControl) * [RightShift](https://rbxcli.github.io/eUNC/api#RightShift) * [RWin](https://rbxcli.github.io/eUNC/api#RWin) * [S](https://rbxcli.github.io/eUNC/api#S) * [ScrollLock](https://rbxcli.github.io/eUNC/api#ScrollLock) * [Select](https://rbxcli.github.io/eUNC/api#Select) * [Separator](https://rbxcli.github.io/eUNC/api#Separator) * [Seven](https://rbxcli.github.io/eUNC/api#Seven) * [Shift](https://rbxcli.github.io/eUNC/api#Shift) * [Six](https://rbxcli.github.io/eUNC/api#Six) * [Space](https://rbxcli.github.io/eUNC/api#Space) * [Subtract](https://rbxcli.github.io/eUNC/api#Subtract) * [T](https://rbxcli.github.io/eUNC/api#T) * [Tab](https://rbxcli.github.io/eUNC/api#Tab) * [Three](https://rbxcli.github.io/eUNC/api#Three) * [Two](https://rbxcli.github.io/eUNC/api#Two) * [U](https://rbxcli.github.io/eUNC/api#U) * [Up](https://rbxcli.github.io/eUNC/api#Up) * [V](https://rbxcli.github.io/eUNC/api#V) * [W](https://rbxcli.github.io/eUNC/api#W) * [X](https://rbxcli.github.io/eUNC/api#X) * [Y](https://rbxcli.github.io/eUNC/api#Y) * [Z](https://rbxcli.github.io/eUNC/api#Z) * [Zero](https://rbxcli.github.io/eUNC/api#Zero) --- # RbxCli | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/#__docusaurus_skipToContent_fallback) ### Simplicity RbxCli promises simplicity, reassembling the native Roblox API as much as possible ### Performance RbxCli takes performance seriously. We have built the API from the ground up with this detail in mind. ### Correctness RbxCli focuses on maintaining the correctness of every operation done externally. Everything must be properly handled. --- # KeyCode | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/api/KeyCode#__docusaurus_skipToContent_fallback) On this page Properties[​](https://rbxcli.github.io/eUNC/api/KeyCode#properties "Direct link to Properties") ------------------------------------------------------------------------------------------------ ### `LeftButton`[​](https://rbxcli.github.io/eUNC/api/KeyCode#LeftButton "Direct link to LeftButton") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L200) `KeyCode.LeftButton:` `number` ### `RightButton`[​](https://rbxcli.github.io/eUNC/api/KeyCode#RightButton "Direct link to RightButton") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L205) `KeyCode.RightButton:` `number` ### `MiddleButton`[​](https://rbxcli.github.io/eUNC/api/KeyCode#MiddleButton "Direct link to MiddleButton") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L210) `KeyCode.MiddleButton:` `number` ### `Backspace`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Backspace "Direct link to Backspace") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L215) `KeyCode.Backspace:` `number` ### `Tab`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Tab "Direct link to Tab") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L220) `KeyCode.Tab:` `number` ### `Clear`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Clear "Direct link to Clear") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L225) `KeyCode.Clear:` `number` ### `Return`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Return "Direct link to Return") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L230) `KeyCode.Return:` `number` ### `Shift`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Shift "Direct link to Shift") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L235) `KeyCode.Shift:` `number` ### `Control`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Control "Direct link to Control") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L240) `KeyCode.Control:` `number` ### `Alt`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Alt "Direct link to Alt") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L245) `KeyCode.Alt:` `number` ### `Pause`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Pause "Direct link to Pause") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L250) `KeyCode.Pause:` `number` ### `CapsLock`[​](https://rbxcli.github.io/eUNC/api/KeyCode#CapsLock "Direct link to CapsLock") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L255) `KeyCode.CapsLock:` `number` ### `Escape`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Escape "Direct link to Escape") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L260) `KeyCode.Escape:` `number` ### `Space`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Space "Direct link to Space") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L265) `KeyCode.Space:` `number` ### `PageUp`[​](https://rbxcli.github.io/eUNC/api/KeyCode#PageUp "Direct link to PageUp") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L270) `KeyCode.PageUp:` `number` ### `PageDown`[​](https://rbxcli.github.io/eUNC/api/KeyCode#PageDown "Direct link to PageDown") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L275) `KeyCode.PageDown:` `number` ### `End`[​](https://rbxcli.github.io/eUNC/api/KeyCode#End "Direct link to End") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L280) `KeyCode.End:` `number` ### `Home`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Home "Direct link to Home") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L285) `KeyCode.Home:` `number` ### `Left`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Left "Direct link to Left") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L291) `KeyCode.Left:` `number` ### `Up`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Up "Direct link to Up") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L296) `KeyCode.Up:` `number` ### `Right`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Right "Direct link to Right") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L301) `KeyCode.Right:` `number` ### `Down`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Down "Direct link to Down") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L306) `KeyCode.Down:` `number` ### `Select`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Select "Direct link to Select") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L312) `KeyCode.Select:` `number` ### `Print`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Print "Direct link to Print") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L317) `KeyCode.Print:` `number` ### `Execute`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Execute "Direct link to Execute") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L322) `KeyCode.Execute:` `number` ### `PrintScreen`[​](https://rbxcli.github.io/eUNC/api/KeyCode#PrintScreen "Direct link to PrintScreen") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L327) `KeyCode.PrintScreen:` `number` ### `Insert`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Insert "Direct link to Insert") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L332) `KeyCode.Insert:` `number` ### `Delete`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Delete "Direct link to Delete") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L337) `KeyCode.Delete:` `number` ### `Help`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Help "Direct link to Help") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L342) `KeyCode.Help:` `number` ### `Zero`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Zero "Direct link to Zero") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L348) `KeyCode.Zero:` `number` ### `One`[​](https://rbxcli.github.io/eUNC/api/KeyCode#One "Direct link to One") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L353) `KeyCode.One:` `number` ### `Two`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Two "Direct link to Two") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L358) `KeyCode.Two:` `number` ### `Three`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Three "Direct link to Three") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L363) `KeyCode.Three:` `number` ### `Four`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Four "Direct link to Four") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L368) `KeyCode.Four:` `number` ### `Five`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Five "Direct link to Five") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L373) `KeyCode.Five:` `number` ### `Six`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Six "Direct link to Six") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L378) `KeyCode.Six:` `number` ### `Seven`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Seven "Direct link to Seven") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L383) `KeyCode.Seven:` `number` ### `Eight`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Eight "Direct link to Eight") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L388) `KeyCode.Eight:` `number` ### `Nine`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Nine "Direct link to Nine") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L393) `KeyCode.Nine:` `number` ### `A`[​](https://rbxcli.github.io/eUNC/api/KeyCode#A "Direct link to A") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L399) `KeyCode.A:` `number` ### `B`[​](https://rbxcli.github.io/eUNC/api/KeyCode#B "Direct link to B") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L404) `KeyCode.B:` `number` ### `C`[​](https://rbxcli.github.io/eUNC/api/KeyCode#C "Direct link to C") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L409) `KeyCode.C:` `number` ### `D`[​](https://rbxcli.github.io/eUNC/api/KeyCode#D "Direct link to D") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L414) `KeyCode.D:` `number` ### `E`[​](https://rbxcli.github.io/eUNC/api/KeyCode#E "Direct link to E") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L419) `KeyCode.E:` `number` ### `F`[​](https://rbxcli.github.io/eUNC/api/KeyCode#F "Direct link to F") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L424) `KeyCode.F:` `number` ### `G`[​](https://rbxcli.github.io/eUNC/api/KeyCode#G "Direct link to G") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L429) `KeyCode.G:` `number` ### `H`[​](https://rbxcli.github.io/eUNC/api/KeyCode#H "Direct link to H") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L434) `KeyCode.H:` `number` ### `I`[​](https://rbxcli.github.io/eUNC/api/KeyCode#I "Direct link to I") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L439) `KeyCode.I:` `number` ### `J`[​](https://rbxcli.github.io/eUNC/api/KeyCode#J "Direct link to J") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L444) `KeyCode.J:` `number` ### `K`[​](https://rbxcli.github.io/eUNC/api/KeyCode#K "Direct link to K") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L449) `KeyCode.K:` `number` ### `L`[​](https://rbxcli.github.io/eUNC/api/KeyCode#L "Direct link to L") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L454) `KeyCode.L:` `number` ### `M`[​](https://rbxcli.github.io/eUNC/api/KeyCode#M "Direct link to M") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L459) `KeyCode.M:` `number` ### `N`[​](https://rbxcli.github.io/eUNC/api/KeyCode#N "Direct link to N") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L464) `KeyCode.N:` `number` ### `O`[​](https://rbxcli.github.io/eUNC/api/KeyCode#O "Direct link to O") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L469) `KeyCode.O:` `number` ### `P`[​](https://rbxcli.github.io/eUNC/api/KeyCode#P "Direct link to P") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L474) `KeyCode.P:` `number` ### `Q`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Q "Direct link to Q") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L479) `KeyCode.Q:` `number` ### `R`[​](https://rbxcli.github.io/eUNC/api/KeyCode#R "Direct link to R") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L484) `KeyCode.R:` `number` ### `S`[​](https://rbxcli.github.io/eUNC/api/KeyCode#S "Direct link to S") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L489) `KeyCode.S:` `number` ### `T`[​](https://rbxcli.github.io/eUNC/api/KeyCode#T "Direct link to T") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L494) `KeyCode.T:` `number` ### `U`[​](https://rbxcli.github.io/eUNC/api/KeyCode#U "Direct link to U") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L499) `KeyCode.U:` `number` ### `V`[​](https://rbxcli.github.io/eUNC/api/KeyCode#V "Direct link to V") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L504) `KeyCode.V:` `number` ### `W`[​](https://rbxcli.github.io/eUNC/api/KeyCode#W "Direct link to W") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L509) `KeyCode.W:` `number` ### `X`[​](https://rbxcli.github.io/eUNC/api/KeyCode#X "Direct link to X") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L514) `KeyCode.X:` `number` ### `Y`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Y "Direct link to Y") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L519) `KeyCode.Y:` `number` ### `Z`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Z "Direct link to Z") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L524) `KeyCode.Z:` `number` ### `LWin`[​](https://rbxcli.github.io/eUNC/api/KeyCode#LWin "Direct link to LWin") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L529) `KeyCode.LWin:` `number` ### `RWin`[​](https://rbxcli.github.io/eUNC/api/KeyCode#RWin "Direct link to RWin") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L534) `KeyCode.RWin:` `number` ### `Apps`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Apps "Direct link to Apps") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L539) `KeyCode.Apps:` `number` ### `NumPad0`[​](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad0 "Direct link to NumPad0") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L544) `KeyCode.NumPad0:` `number` ### `NumPad1`[​](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad1 "Direct link to NumPad1") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L549) `KeyCode.NumPad1:` `number` ### `NumPad2`[​](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad2 "Direct link to NumPad2") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L554) `KeyCode.NumPad2:` `number` ### `NumPad3`[​](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad3 "Direct link to NumPad3") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L559) `KeyCode.NumPad3:` `number` ### `NumPad4`[​](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad4 "Direct link to NumPad4") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L564) `KeyCode.NumPad4:` `number` ### `NumPad5`[​](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad5 "Direct link to NumPad5") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L569) `KeyCode.NumPad5:` `number` ### `NumPad6`[​](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad6 "Direct link to NumPad6") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L574) `KeyCode.NumPad6:` `number` ### `NumPad7`[​](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad7 "Direct link to NumPad7") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L579) `KeyCode.NumPad7:` `number` ### `NumPad8`[​](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad8 "Direct link to NumPad8") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L584) `KeyCode.NumPad8:` `number` ### `NumPad9`[​](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad9 "Direct link to NumPad9") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L589) `KeyCode.NumPad9:` `number` ### `Multiply`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Multiply "Direct link to Multiply") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L594) `KeyCode.Multiply:` `number` ### `Add`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Add "Direct link to Add") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L599) `KeyCode.Add:` `number` ### `Separator`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Separator "Direct link to Separator") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L604) `KeyCode.Separator:` `number` ### `Subtract`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Subtract "Direct link to Subtract") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L609) `KeyCode.Subtract:` `number` ### `Decimal`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Decimal "Direct link to Decimal") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L614) `KeyCode.Decimal:` `number` ### `Divide`[​](https://rbxcli.github.io/eUNC/api/KeyCode#Divide "Direct link to Divide") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L619) `KeyCode.Divide:` `number` ### `F1`[​](https://rbxcli.github.io/eUNC/api/KeyCode#F1 "Direct link to F1") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L624) `KeyCode.F1:` `number` ### `F2`[​](https://rbxcli.github.io/eUNC/api/KeyCode#F2 "Direct link to F2") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L629) `KeyCode.F2:` `number` ### `F3`[​](https://rbxcli.github.io/eUNC/api/KeyCode#F3 "Direct link to F3") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L634) `KeyCode.F3:` `number` ### `F4`[​](https://rbxcli.github.io/eUNC/api/KeyCode#F4 "Direct link to F4") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L639) `KeyCode.F4:` `number` ### `F5`[​](https://rbxcli.github.io/eUNC/api/KeyCode#F5 "Direct link to F5") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L644) `KeyCode.F5:` `number` ### `F6`[​](https://rbxcli.github.io/eUNC/api/KeyCode#F6 "Direct link to F6") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L649) `KeyCode.F6:` `number` ### `F7`[​](https://rbxcli.github.io/eUNC/api/KeyCode#F7 "Direct link to F7") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L654) `KeyCode.F7:` `number` ### `F8`[​](https://rbxcli.github.io/eUNC/api/KeyCode#F8 "Direct link to F8") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L659) `KeyCode.F8:` `number` ### `F9`[​](https://rbxcli.github.io/eUNC/api/KeyCode#F9 "Direct link to F9") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L664) `KeyCode.F9:` `number` ### `F10`[​](https://rbxcli.github.io/eUNC/api/KeyCode#F10 "Direct link to F10") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L669) `KeyCode.F10:` `number` ### `F11`[​](https://rbxcli.github.io/eUNC/api/KeyCode#F11 "Direct link to F11") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L674) `KeyCode.F11:` `number` ### `F12`[​](https://rbxcli.github.io/eUNC/api/KeyCode#F12 "Direct link to F12") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L679) `KeyCode.F12:` `number` ### `NumLock`[​](https://rbxcli.github.io/eUNC/api/KeyCode#NumLock "Direct link to NumLock") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L684) `KeyCode.NumLock:` `number` ### `ScrollLock`[​](https://rbxcli.github.io/eUNC/api/KeyCode#ScrollLock "Direct link to ScrollLock") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L689) `KeyCode.ScrollLock:` `number` ### `LeftShift`[​](https://rbxcli.github.io/eUNC/api/KeyCode#LeftShift "Direct link to LeftShift") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L694) `KeyCode.LeftShift:` `number` ### `RightShift`[​](https://rbxcli.github.io/eUNC/api/KeyCode#RightShift "Direct link to RightShift") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L699) `KeyCode.RightShift:` `number` ### `LeftControl`[​](https://rbxcli.github.io/eUNC/api/KeyCode#LeftControl "Direct link to LeftControl") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L704) `KeyCode.LeftControl:` `number` ### `RightControl`[​](https://rbxcli.github.io/eUNC/api/KeyCode#RightControl "Direct link to RightControl") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L709) `KeyCode.RightControl:` `number` ### `LeftAlt`[​](https://rbxcli.github.io/eUNC/api/KeyCode#LeftAlt "Direct link to LeftAlt") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L714) `KeyCode.LeftAlt:` `number` ### `RightAlt`[​](https://rbxcli.github.io/eUNC/api/KeyCode#RightAlt "Direct link to RightAlt") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L719) `KeyCode.RightAlt:` `number` Show raw api { "functions": \[\], "properties": \[\ {\ "name": "LeftButton",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 200,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "RightButton",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 205,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "MiddleButton",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 210,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Backspace",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 215,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Tab",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 220,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Clear",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 225,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Return",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 230,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Shift",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 235,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Control",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 240,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Alt",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 245,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Pause",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 250,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "CapsLock",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 255,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Escape",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 260,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Space",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 265,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "PageUp",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 270,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "PageDown",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 275,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "End",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 280,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Home",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 285,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Left",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 291,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Up",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 296,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Right",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 301,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Down",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 306,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Select",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 312,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Print",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 317,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Execute",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 322,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "PrintScreen",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 327,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Insert",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 332,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Delete",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 337,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Help",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 342,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Zero",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 348,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "One",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 353,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Two",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 358,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Three",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 363,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Four",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 368,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Five",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 373,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Six",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 378,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Seven",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 383,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Eight",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 388,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Nine",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 393,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "A",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 399,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "B",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 404,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "C",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 409,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "D",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 414,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "E",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 419,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 424,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "G",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 429,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "H",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 434,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "I",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 439,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "J",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 444,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "K",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 449,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "L",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 454,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "M",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 459,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "N",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 464,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "O",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 469,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "P",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 474,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Q",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 479,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "R",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 484,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "S",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 489,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "T",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 494,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "U",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 499,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "V",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 504,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "W",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 509,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "X",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 514,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Y",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 519,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Z",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 524,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "LWin",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 529,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "RWin",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 534,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Apps",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 539,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad0",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 544,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad1",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 549,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad2",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 554,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad3",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 559,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad4",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 564,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad5",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 569,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad6",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 574,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad7",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 579,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad8",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 584,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumPad9",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 589,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Multiply",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 594,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Add",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 599,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Separator",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 604,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Subtract",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 609,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Decimal",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 614,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "Divide",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 619,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F1",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 624,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F2",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 629,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F3",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 634,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F4",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 639,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F5",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 644,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F6",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 649,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F7",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 654,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F8",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 659,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F9",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 664,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F10",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 669,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F11",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 674,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "F12",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 679,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "NumLock",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 684,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "ScrollLock",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 689,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "LeftShift",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 694,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "RightShift",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 699,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "LeftControl",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 704,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "RightControl",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 709,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "LeftAlt",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 714,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "RightAlt",\ "desc": "",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 719,\ "path": "src/libraries/input.luau"\ }\ }\ \], "types": \[\], "name": "KeyCode", "desc": "Defines the available virtual key codes for input operations (Win32 VK Codes).\\r", "tags": \[\ "Library"\ \], "source": { "line": 195, "path": "src/libraries/input.luau" } } * [Properties](https://rbxcli.github.io/eUNC/api/KeyCode#properties) * [A](https://rbxcli.github.io/eUNC/api/KeyCode#A) * [Add](https://rbxcli.github.io/eUNC/api/KeyCode#Add) * [Alt](https://rbxcli.github.io/eUNC/api/KeyCode#Alt) * [Apps](https://rbxcli.github.io/eUNC/api/KeyCode#Apps) * [B](https://rbxcli.github.io/eUNC/api/KeyCode#B) * [Backspace](https://rbxcli.github.io/eUNC/api/KeyCode#Backspace) * [C](https://rbxcli.github.io/eUNC/api/KeyCode#C) * [CapsLock](https://rbxcli.github.io/eUNC/api/KeyCode#CapsLock) * [Clear](https://rbxcli.github.io/eUNC/api/KeyCode#Clear) * [Control](https://rbxcli.github.io/eUNC/api/KeyCode#Control) * [D](https://rbxcli.github.io/eUNC/api/KeyCode#D) * [Decimal](https://rbxcli.github.io/eUNC/api/KeyCode#Decimal) * [Delete](https://rbxcli.github.io/eUNC/api/KeyCode#Delete) * [Divide](https://rbxcli.github.io/eUNC/api/KeyCode#Divide) * [Down](https://rbxcli.github.io/eUNC/api/KeyCode#Down) * [E](https://rbxcli.github.io/eUNC/api/KeyCode#E) * [Eight](https://rbxcli.github.io/eUNC/api/KeyCode#Eight) * [End](https://rbxcli.github.io/eUNC/api/KeyCode#End) * [Escape](https://rbxcli.github.io/eUNC/api/KeyCode#Escape) * [Execute](https://rbxcli.github.io/eUNC/api/KeyCode#Execute) * [F](https://rbxcli.github.io/eUNC/api/KeyCode#F) * [F1](https://rbxcli.github.io/eUNC/api/KeyCode#F1) * [F10](https://rbxcli.github.io/eUNC/api/KeyCode#F10) * [F11](https://rbxcli.github.io/eUNC/api/KeyCode#F11) * [F12](https://rbxcli.github.io/eUNC/api/KeyCode#F12) * [F2](https://rbxcli.github.io/eUNC/api/KeyCode#F2) * [F3](https://rbxcli.github.io/eUNC/api/KeyCode#F3) * [F4](https://rbxcli.github.io/eUNC/api/KeyCode#F4) * [F5](https://rbxcli.github.io/eUNC/api/KeyCode#F5) * [F6](https://rbxcli.github.io/eUNC/api/KeyCode#F6) * [F7](https://rbxcli.github.io/eUNC/api/KeyCode#F7) * [F8](https://rbxcli.github.io/eUNC/api/KeyCode#F8) * [F9](https://rbxcli.github.io/eUNC/api/KeyCode#F9) * [Five](https://rbxcli.github.io/eUNC/api/KeyCode#Five) * [Four](https://rbxcli.github.io/eUNC/api/KeyCode#Four) * [G](https://rbxcli.github.io/eUNC/api/KeyCode#G) * [H](https://rbxcli.github.io/eUNC/api/KeyCode#H) * [Help](https://rbxcli.github.io/eUNC/api/KeyCode#Help) * [Home](https://rbxcli.github.io/eUNC/api/KeyCode#Home) * [I](https://rbxcli.github.io/eUNC/api/KeyCode#I) * [Insert](https://rbxcli.github.io/eUNC/api/KeyCode#Insert) * [J](https://rbxcli.github.io/eUNC/api/KeyCode#J) * [K](https://rbxcli.github.io/eUNC/api/KeyCode#K) * [L](https://rbxcli.github.io/eUNC/api/KeyCode#L) * [Left](https://rbxcli.github.io/eUNC/api/KeyCode#Left) * [LeftAlt](https://rbxcli.github.io/eUNC/api/KeyCode#LeftAlt) * [LeftButton](https://rbxcli.github.io/eUNC/api/KeyCode#LeftButton) * [LeftControl](https://rbxcli.github.io/eUNC/api/KeyCode#LeftControl) * [LeftShift](https://rbxcli.github.io/eUNC/api/KeyCode#LeftShift) * [LWin](https://rbxcli.github.io/eUNC/api/KeyCode#LWin) * [M](https://rbxcli.github.io/eUNC/api/KeyCode#M) * [MiddleButton](https://rbxcli.github.io/eUNC/api/KeyCode#MiddleButton) * [Multiply](https://rbxcli.github.io/eUNC/api/KeyCode#Multiply) * [N](https://rbxcli.github.io/eUNC/api/KeyCode#N) * [Nine](https://rbxcli.github.io/eUNC/api/KeyCode#Nine) * [NumLock](https://rbxcli.github.io/eUNC/api/KeyCode#NumLock) * [NumPad0](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad0) * [NumPad1](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad1) * [NumPad2](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad2) * [NumPad3](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad3) * [NumPad4](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad4) * [NumPad5](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad5) * [NumPad6](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad6) * [NumPad7](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad7) * [NumPad8](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad8) * [NumPad9](https://rbxcli.github.io/eUNC/api/KeyCode#NumPad9) * [O](https://rbxcli.github.io/eUNC/api/KeyCode#O) * [One](https://rbxcli.github.io/eUNC/api/KeyCode#One) * [P](https://rbxcli.github.io/eUNC/api/KeyCode#P) * [PageDown](https://rbxcli.github.io/eUNC/api/KeyCode#PageDown) * [PageUp](https://rbxcli.github.io/eUNC/api/KeyCode#PageUp) * [Pause](https://rbxcli.github.io/eUNC/api/KeyCode#Pause) * [Print](https://rbxcli.github.io/eUNC/api/KeyCode#Print) * [PrintScreen](https://rbxcli.github.io/eUNC/api/KeyCode#PrintScreen) * [Q](https://rbxcli.github.io/eUNC/api/KeyCode#Q) * [R](https://rbxcli.github.io/eUNC/api/KeyCode#R) * [Return](https://rbxcli.github.io/eUNC/api/KeyCode#Return) * [Right](https://rbxcli.github.io/eUNC/api/KeyCode#Right) * [RightAlt](https://rbxcli.github.io/eUNC/api/KeyCode#RightAlt) * [RightButton](https://rbxcli.github.io/eUNC/api/KeyCode#RightButton) * [RightControl](https://rbxcli.github.io/eUNC/api/KeyCode#RightControl) * [RightShift](https://rbxcli.github.io/eUNC/api/KeyCode#RightShift) * [RWin](https://rbxcli.github.io/eUNC/api/KeyCode#RWin) * [S](https://rbxcli.github.io/eUNC/api/KeyCode#S) * [ScrollLock](https://rbxcli.github.io/eUNC/api/KeyCode#ScrollLock) * [Select](https://rbxcli.github.io/eUNC/api/KeyCode#Select) * [Separator](https://rbxcli.github.io/eUNC/api/KeyCode#Separator) * [Seven](https://rbxcli.github.io/eUNC/api/KeyCode#Seven) * [Shift](https://rbxcli.github.io/eUNC/api/KeyCode#Shift) * [Six](https://rbxcli.github.io/eUNC/api/KeyCode#Six) * [Space](https://rbxcli.github.io/eUNC/api/KeyCode#Space) * [Subtract](https://rbxcli.github.io/eUNC/api/KeyCode#Subtract) * [T](https://rbxcli.github.io/eUNC/api/KeyCode#T) * [Tab](https://rbxcli.github.io/eUNC/api/KeyCode#Tab) * [Three](https://rbxcli.github.io/eUNC/api/KeyCode#Three) * [Two](https://rbxcli.github.io/eUNC/api/KeyCode#Two) * [U](https://rbxcli.github.io/eUNC/api/KeyCode#U) * [Up](https://rbxcli.github.io/eUNC/api/KeyCode#Up) * [V](https://rbxcli.github.io/eUNC/api/KeyCode#V) * [W](https://rbxcli.github.io/eUNC/api/KeyCode#W) * [X](https://rbxcli.github.io/eUNC/api/KeyCode#X) * [Y](https://rbxcli.github.io/eUNC/api/KeyCode#Y) * [Z](https://rbxcli.github.io/eUNC/api/KeyCode#Z) * [Zero](https://rbxcli.github.io/eUNC/api/KeyCode#Zero) --- # Introduction | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/docs/intro#__docusaurus_skipToContent_fallback) RbxCli is an external tool for the ROBLOX engine meant to modify and gain an advantage while in gameplay as well as to perform analysis on several games, their structures and other ways they achieve effects, gameplay or mechanics. RbxCli contains a Luau VM, the VM itself holds a heavy resemblance and familiarity to the Roblox Luau API, however there are numerous differences, in between these are the following. * No Events Framework RbxCli's method of working does not allow for any events to occur unless they are fired explicitly from within RbxCli. There are no Roblox related events, such as `.ChildAdded`, `.DescendantAdded`, .... This is due to the method RbxCLi operates, which would make performing these events slower and non-benefitial. * Modified/Dissimilar behaviour RbxCli's Luau API, while holding resemblance to the original Roblox Luau API, however, the behaviour between both APIs is not guaranteed to be the same. These differences will be laid out on the documentations of the API if they could amount to a hit on performance, usability or other details.. * * * Any other tool can adapt the APIs RbxCli has defined, however we will not make any compromises to support such. RbxCli's API is designed to not change in order to maintain as much compatibility as possible with scripts, every aspect of it has been designed with this in mind, once an API is marked public and published it will **not** be removed, only deprecated. --- # ProcessWriteResult | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/api/ProcessWriteResult#__docusaurus_skipToContent_fallback) On this page Properties[​](https://rbxcli.github.io/eUNC/api/ProcessWriteResult#properties "Direct link to Properties") ----------------------------------------------------------------------------------------------------------- ### `PagedOut`[​](https://rbxcli.github.io/eUNC/api/ProcessWriteResult#PagedOut "Direct link to PagedOut") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L49) `ProcessWriteResult.PagedOut:` `number` The memory region was outside of the process's Working Set. ### `Successful`[​](https://rbxcli.github.io/eUNC/api/ProcessWriteResult#Successful "Direct link to Successful") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L55) `ProcessWriteResult.Successful:` `number` The memory write was successful. ### `Failed`[​](https://rbxcli.github.io/eUNC/api/ProcessWriteResult#Failed "Direct link to Failed") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L61) `ProcessWriteResult.Failed:` `number` The memory write failed at the API level (Kernel/Win32). ### `PartialWrite`[​](https://rbxcli.github.io/eUNC/api/ProcessWriteResult#PartialWrite "Direct link to PartialWrite") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L67) `ProcessWriteResult.PartialWrite:` `number` The memory write was only completed partially, not completely (Kernel/Win32). Show raw api { "functions": \[\], "properties": \[\ {\ "name": "PagedOut",\ "desc": "The memory region was outside of the process's Working Set.\\r",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 49,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "Successful",\ "desc": "The memory write was successful.\\r",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 55,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "Failed",\ "desc": "The memory write failed at the API level (Kernel/Win32).\\r",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 61,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "PartialWrite",\ "desc": "The memory write was only completed partially, not completely (Kernel/Win32).\\r",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 67,\ "path": "src/libraries/memory.luau"\ }\ }\ \], "types": \[\], "name": "ProcessWriteResult", "desc": "Defines the write result statuses for memory writing operations.\\r", "tags": \[\ "Library"\ \], "source": { "line": 43, "path": "src/libraries/memory.luau" } } * [Properties](https://rbxcli.github.io/eUNC/api/ProcessWriteResult#properties) * [Failed](https://rbxcli.github.io/eUNC/api/ProcessWriteResult#Failed) * [PagedOut](https://rbxcli.github.io/eUNC/api/ProcessWriteResult#PagedOut) * [PartialWrite](https://rbxcli.github.io/eUNC/api/ProcessWriteResult#PartialWrite) * [Successful](https://rbxcli.github.io/eUNC/api/ProcessWriteResult#Successful) --- # ProcessReadResult | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/api/ProcessReadResult#__docusaurus_skipToContent_fallback) On this page Properties[​](https://rbxcli.github.io/eUNC/api/ProcessReadResult#properties "Direct link to Properties") ---------------------------------------------------------------------------------------------------------- ### `PagedOut`[​](https://rbxcli.github.io/eUNC/api/ProcessReadResult#PagedOut "Direct link to PagedOut") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L20) `ProcessReadResult.PagedOut:` `number` The memory region was outside of the process's Working Set. ### `Successful`[​](https://rbxcli.github.io/eUNC/api/ProcessReadResult#Successful "Direct link to Successful") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L26) `ProcessReadResult.Successful:` `number` The memory read was successful. ### `Failed`[​](https://rbxcli.github.io/eUNC/api/ProcessReadResult#Failed "Direct link to Failed") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L32) `ProcessReadResult.Failed:` `number` The memory read failed at the API level (Kernel/Win32). ### `PartialRead`[​](https://rbxcli.github.io/eUNC/api/ProcessReadResult#PartialRead "Direct link to PartialRead") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L38) `ProcessReadResult.PartialRead:` `number` The memory read was only completed partially, not completely (Kernel/Win32). Show raw api { "functions": \[\], "properties": \[\ {\ "name": "PagedOut",\ "desc": "The memory region was outside of the process's Working Set.\\r",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 20,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "Successful",\ "desc": "The memory read was successful.\\r",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 26,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "Failed",\ "desc": "The memory read failed at the API level (Kernel/Win32).\\r",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 32,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "PartialRead",\ "desc": "The memory read was only completed partially, not completely (Kernel/Win32).\\r",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 38,\ "path": "src/libraries/memory.luau"\ }\ }\ \], "types": \[\], "name": "ProcessReadResult", "desc": "Defines the read result statuses for memory reading operations.\\r", "tags": \[\ "Library"\ \], "source": { "line": 14, "path": "src/libraries/memory.luau" } } * [Properties](https://rbxcli.github.io/eUNC/api/ProcessReadResult#properties) * [Failed](https://rbxcli.github.io/eUNC/api/ProcessReadResult#Failed) * [PagedOut](https://rbxcli.github.io/eUNC/api/ProcessReadResult#PagedOut) * [PartialRead](https://rbxcli.github.io/eUNC/api/ProcessReadResult#PartialRead) * [Successful](https://rbxcli.github.io/eUNC/api/ProcessReadResult#Successful) --- # global | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/api/global#__docusaurus_skipToContent_fallback) On this page Properties[​](https://rbxcli.github.io/eUNC/api/global#properties "Direct link to Properties") ----------------------------------------------------------------------------------------------- ### `game`[​](https://rbxcli.github.io/eUNC/api/global#game "Direct link to game") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/global.luau#L15) `global.game:` `[DataModel](https://rbxcli.github.io/eUNC/api/DataModel) ` A reference to the active Roblox DataModel. ### `workspace`[​](https://rbxcli.github.io/eUNC/api/global#workspace "Direct link to workspace") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/global.luau#L24) `global.workspace:` `[Workspace](https://developer.roblox.com/en-us/api-reference/class/Workspace) ` A reference to the active Roblox Workspace. Functions[​](https://rbxcli.github.io/eUNC/api/global#functions "Direct link to Functions") -------------------------------------------------------------------------------------------- ### `print`[​](https://rbxcli.github.io/eUNC/api/global#print "Direct link to print") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/global.luau#L33) `global.``print``(` `...:` `any`\-- The values to print. `) →` `(``)` Prints the given arguments to the RbxCli logger with an info level. Each argument is converted to a string and separated by tabs. ### `warn`[​](https://rbxcli.github.io/eUNC/api/global#warn "Direct link to warn") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/global.luau#L42) `global.``warn``(` `...:` `any`\-- The values to warn. `) →` `(``)` Prints the given arguments to the RbxCli logger with a warning level. Each argument is converted to a string and separated by tabs. ### `request`[​](https://rbxcli.github.io/eUNC/api/global#request "Direct link to request") This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yields [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/global.luau#L71) `global.``request``(` `options:` `table`\-- A table containing request details. `) →` `table`\-- The response information. Performs an HTTP request ### Request Options | Field | Type | Description | | --- | --- | --- | | `Url` | string | The target URL for the request. | | `Method` | string? | The HTTP method (GET, POST, PUT, PATCH, DELETE). Defaults to GET. | | `Headers` | table? | A dictionary of string keys and values for HTTP headers. | | `Cookies` | table? | A dictionary of string keys and values for Cookies. | | `Body` | string? | The request body (payload). | ### Response Structure | Field | Type | Description | | --- | --- | --- | | `Success` | boolean | True if the status code is not an error (and not 0). | | `StatusCode` | number | The HTTP status code returned. | | `StatusMessage` | string | The status message (e.g., "200 OK"). | | `Body` | string | The response body. | | `Headers` | table | A dictionary of response headers. | | `Cookies` | table | A dictionary of response cookies (excluding .ROBLOSECURITY). | Show raw api { "functions": \[\ {\ "name": "print",\ "desc": "Prints the given arguments to the RbxCli logger with an info level.\\nEach argument is converted to a string and separated by tabs.",\ "params": \[\ {\ "name": "...",\ "desc": "The values to print.",\ "lua\_type": "any"\ }\ \],\ "returns": \[\],\ "function\_type": "static",\ "source": {\ "line": 33,\ "path": "src/libraries/global.luau"\ }\ },\ {\ "name": "warn",\ "desc": "Prints the given arguments to the RbxCli logger with a warning level.\\nEach argument is converted to a string and separated by tabs.",\ "params": \[\ {\ "name": "...",\ "desc": "The values to warn.",\ "lua\_type": "any"\ }\ \],\ "returns": \[\],\ "function\_type": "static",\ "source": {\ "line": 42,\ "path": "src/libraries/global.luau"\ }\ },\ {\ "name": "request",\ "desc": "Performs an HTTP request\\n\\n### Request Options\\n| Field | Type | Description |\\n| :--- | :--- | :--- |\\n| \`Url\` | string | The target URL for the request. |\\n| \`Method\` | string? | The HTTP method (GET, POST, PUT, PATCH, DELETE). Defaults to GET. |\\n| \`Headers\` | table? | A dictionary of string keys and values for HTTP headers. |\\n| \`Cookies\` | table? | A dictionary of string keys and values for Cookies. |\\n| \`Body\` | string? | The request body (payload). |\\n\\n### Response Structure\\n| Field | Type | Description |\\n| :--- | :--- | :--- |\\n| \`Success\` | boolean | True if the status code is not an error (and not 0). |\\n| \`StatusCode\` | number | The HTTP status code returned. |\\n| \`StatusMessage\` | string | The status message (e.g., \\"200 OK\\"). |\\n| \`Body\` | string | The response body. |\\n| \`Headers\` | table | A dictionary of response headers. |\\n| \`Cookies\` | table | A dictionary of response cookies (excluding .ROBLOSECURITY). |",\ "params": \[\ {\ "name": "options",\ "desc": "A table containing request details.",\ "lua\_type": "table"\ }\ \],\ "returns": \[\ {\ "desc": "The response information.",\ "lua\_type": "table"\ }\ \],\ "function\_type": "static",\ "yields": true,\ "source": {\ "line": 71,\ "path": "src/libraries/global.luau"\ }\ }\ \], "properties": \[\ {\ "name": "game",\ "desc": "A reference to the active Roblox DataModel.",\ "lua\_type": "DataModel",\ "readonly": true,\ "source": {\ "line": 15,\ "path": "src/libraries/global.luau"\ }\ },\ {\ "name": "workspace",\ "desc": "A reference to the active Roblox Workspace.",\ "lua\_type": "Workspace",\ "readonly": true,\ "source": {\ "line": 24,\ "path": "src/libraries/global.luau"\ }\ }\ \], "types": \[\], "name": "global", "desc": "Contains functions that are present in the top level (or global) scope of the Luau VM.", "tags": \[\ "Library"\ \], "source": { "line": 6, "path": "src/libraries/global.luau" } } * [Properties](https://rbxcli.github.io/eUNC/api/global#properties) * [game](https://rbxcli.github.io/eUNC/api/global#game) * [workspace](https://rbxcli.github.io/eUNC/api/global#workspace) * [Functions](https://rbxcli.github.io/eUNC/api/global#functions) * [.print](https://rbxcli.github.io/eUNC/api/global#print) * [.request](https://rbxcli.github.io/eUNC/api/global#request) * [.warn](https://rbxcli.github.io/eUNC/api/global#warn) --- # input | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/api/input#__docusaurus_skipToContent_fallback) On this page Functions[​](https://rbxcli.github.io/eUNC/api/input#functions "Direct link to Functions") ------------------------------------------------------------------------------------------- ### `key_down`[​](https://rbxcli.github.io/eUNC/api/input#key_down "Direct link to key_down") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L18) `input.``key_down``(` `key:` `number`\-- The Virtual Key (VK) code of the key. (see KeyCode Library) `) →` `(``)` Presses and holds a keyboard key until key\_up is called. ### Errors | Type | Description | | --- | --- | | "Roblox is not focused" | Roblox's windows is not the focused window. | | "Key is already pressed" | The key is already 'held down'. | | "Invalid or unsupported key" | The VK code was invalid or is not supported. | ### `key_up`[​](https://rbxcli.github.io/eUNC/api/input#key_up "Direct link to key_up") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L29) `input.``key_up``(` `key:` `number`\-- The Virtual Key (VK) code of the key. (see KeyCode Library) `) →` `(``)` Releases a previously pressed keyboard key. ### Errors | Type | Description | | --- | --- | | "Roblox is not focused" | Roblox's windows is not the focused window. | | "Key is not pressed" | The key is already 'released'. | | "Invalid or unsupported key" | The VK code was invalid or is not supported. | ### `key_click`[​](https://rbxcli.github.io/eUNC/api/input#key_click "Direct link to key_click") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L39) `input.``key_click``(` `key:` `number`\-- The Virtual Key (VK) code of the key. (see KeyCode Library) `) →` `(``)` Presses and releases a keyboard key in a single call. ### Errors | Type | Description | | --- | --- | | "Roblox is not focused" | Roblox's windows is not the focused window. | | "Invalid or unsupported key" | The VK code was invalid or is not supported. | ### `is_key_down`[​](https://rbxcli.github.io/eUNC/api/input#is_key_down "Direct link to is_key_down") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L50) `input.``is_key_down``(` `key:` `number`\-- The Virtual Key (VK) code of the key. (see KeyCode Library) `) →` `boolean`\-- True if the key is currently held down. Returns whether the specified key is currently pressed according to the internal library state. ### Errors | Type | Description | | --- | --- | | "Roblox is not focused" | Roblox's windows is not the focused window. | | "Invalid or unsupported key" | The VK code was invalid or is not supported. | ### `mouse_down`[​](https://rbxcli.github.io/eUNC/api/input#mouse_down "Direct link to mouse_down") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L63) `input.``mouse_down``(` `button:` `number`\-- The button code (e.g., 1 for Left, 2 for Right). `) →` `(``)` Presses and holds a mouse button. ### Errors | Type | Description | | --- | --- | | "Roblox is not focused" | Roblox's windows is not the focused window. | | "Mouse button is already pressed" | The mouse button is already 'held down'. | | "Invalid or unsupported mouse button" | The Mouse VK code was invalid or is not supported. | ### `mouse_up`[​](https://rbxcli.github.io/eUNC/api/input#mouse_up "Direct link to mouse_up") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L74) `input.``mouse_up``(` `button:` `number`\-- The button code (e.g., 1 for Left, 2 for Right). `) →` `(``)` Releases a previously pressed mouse button. ### Errors | Type | Description | | --- | --- | | "Roblox is not focused" | Roblox's windows is not the focused window. | | "Mouse button is not pressed" | The mouse button is already 'released'. | | "Invalid or unsupported mouse button" | The Mouse VK code was invalid or is not supported. | ### `is_mouse_down`[​](https://rbxcli.github.io/eUNC/api/input#is_mouse_down "Direct link to is_mouse_down") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L85) `input.``is_mouse_down``(` `button:` `number`\-- The button code. `) →` `boolean`\-- True if the button is held down. Returns whether the specified mouse button is currently pressed. ### Errors | Type | Description | | --- | --- | | "Roblox is not focused" | Roblox's windows is not the focused window. | | "Invalid or unsupported mouse button" | The Mouse VK code was invalid or is not supported. | ### `mouse_click`[​](https://rbxcli.github.io/eUNC/api/input#mouse_click "Direct link to mouse_click") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L99) `input.``mouse_click``(` `button:` `number``,`\-- The button code. `count:` `number?`\-- How many times to click (defaults to 1). `) →` `(``)` Performs one or more mouse clicks sequentially. ### Errors | Type | Description | | --- | --- | | "Roblox is not focused" | Roblox's windows is not the focused window. | | "Click count must be greater than 0" | The count parameter was less than 1 or equal to 0. | | "Invalid or unsupported mouse button" | The Mouse VK code was invalid or is not supported. | ### `mouse_move_absolute`[​](https://rbxcli.github.io/eUNC/api/input#mouse_move_absolute "Direct link to mouse_move_absolute") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L108) `input.``mouse_move_absolute``(` `position:` `[Vector2](https://developer.roblox.com/en-us/api-reference/datatype/Vector2)` \-- The absolute XY screen coordinates. `) →` `(``)` Moves the mouse cursor instantly to the given absolute screen position. ### Errors | Type | Description | | --- | --- | | "Roblox is not focused" | Roblox's windows is not the focused window. | ### `mouse_move_relative`[​](https://rbxcli.github.io/eUNC/api/input#mouse_move_relative "Direct link to mouse_move_relative") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L117) `input.``mouse_move_relative``(` `offset:` `[Vector2](https://developer.roblox.com/en-us/api-reference/datatype/Vector2)` \-- The XY offset to move by. `) →` `(``)` Moves the mouse cursor instantly by the given offset relative to its current position. ### Errors | Type | Description | | --- | --- | | "Roblox is not focused" | Roblox's windows is not the focused window. | ### `mouse_move_tween`[​](https://rbxcli.github.io/eUNC/api/input#mouse_move_tween "Direct link to mouse_move_tween") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L129) `input.``mouse_move_tween``(` `position:` `[Vector2](https://developer.roblox.com/en-us/api-reference/datatype/Vector2)` `,`\-- The target absolute XY position. `timeInSeconds:` `number`\-- The duration of the movement. `) →` `(``)` Smoothly moves the mouse cursor to the target position over a period of time. This function yields the current thread until the move is complete. ### Errors | Type | Description | | --- | --- | | "Roblox is not focused" | Roblox's windows is not the focused window. | | "Time must be a positive number" | The timeInSeconds parameter was not a positive number. | ### `mouse_move_instance`[​](https://rbxcli.github.io/eUNC/api/input#mouse_move_instance "Direct link to mouse_move_instance") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L140) `input.``mouse_move_instance``(` `instance:` `[Instance](https://rbxcli.github.io/eUNC/api/Instance) `\-- The GuiObject to target. `) →` `(``)` Moves the mouse cursor instantly to the center of the given Roblox UI instance. ### Errors | Type | Description | | --- | --- | | "Roblox is not focused" | Roblox's windows is not the focused window. | | "Instance must be a valid UI Instance" | The object was not an Instance object of type GuiObject. | | "Instance is not visible or has no absolute position" | The GuiObject was not visible or had no absolute position. | ### `mouse_move_instance_tween`[​](https://rbxcli.github.io/eUNC/api/input#mouse_move_instance_tween "Direct link to mouse_move_instance_tween") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L154) `input.``mouse_move_instance_tween``(` `instance:` `[Instance](https://rbxcli.github.io/eUNC/api/Instance) ``,`\-- The GuiObject to target. `timeInSeconds:` `number`\-- The duration of the movement. `) →` `(``)` Smoothly moves the mouse cursor to the center of the given Roblox UI instance. This function yields the current thread until the move is complete. ### Errors | Type | Description | | --- | --- | | "Roblox is not focused" | Roblox's windows is not the focused window. | | "Instance must be a valid UI Instance" | The object was not an Instance object of type GuiObject. | | "Instance is not visible or has no absolute position" | The GuiObject was not visible or had no absolute position. | | "Time must be a positive number" | The timeInSeconds parameter was not a positive number. | ### `mouse_click_instance`[​](https://rbxcli.github.io/eUNC/api/input#mouse_click_instance "Direct link to mouse_click_instance") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L167) `input.``mouse_click_instance``(` `instance:` `[Instance](https://rbxcli.github.io/eUNC/api/Instance) ``,`\-- The GuiObject to target. `button:` `number`\-- The button VK code. `) →` `(``)` Moves the mouse cursor to the center of the given Roblox UI instance and performs a mouse click. ### Errors | Type | Description | | --- | --- | | "Roblox is not focused" | Roblox's windows is not the focused window. | | "Instance must be a valid UI Instance" | The object was not an Instance object of type GuiObject. | | "Invalid or unsupported mouse button" | The Mouse VK code was invalid or is not supported. | | "Instance is not visible or interactable" | The GuiObject was not visible or isn't interactable. | ### `mouse_scroll`[​](https://rbxcli.github.io/eUNC/api/input#mouse_scroll "Direct link to mouse_scroll") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L176) `input.``mouse_scroll``(` `delta:` `number`\-- The amount to scroll (positive for up, negative for down). `) →` `(``)` Scrolls the mouse wheel by the given delta amount. ### Errors | Type | Description | | --- | --- | | "Roblox is not focused" | Roblox's windows is not the focused window. | ### `is_window_focused`[​](https://rbxcli.github.io/eUNC/api/input#is_window_focused "Direct link to is_window_focused") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/input.luau#L188) `input.``is_window_focused``(``) →` `boolean`\-- True if the window is currently focused. Returns whether the Roblox window is currently in focus. ### Remark: It is recommended to call this function before performing any input sequence. The input library requires that Roblox be focused. Show raw api { "functions": \[\ {\ "name": "key\_down",\ "desc": "Presses and holds a keyboard key until key\_up is called.",\ "params": \[\ {\ "name": "key",\ "desc": "The Virtual Key (VK) code of the key. (see KeyCode Library)",\ "lua\_type": "number"\ }\ \],\ "returns": \[\],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"Roblox is not focused\\"",\ "desc": "Roblox's windows is not the focused window."\ },\ {\ "lua\_type": "\\"Key is already pressed\\"",\ "desc": "The key is already 'held down'."\ },\ {\ "lua\_type": "\\"Invalid or unsupported key\\"",\ "desc": "The VK code was invalid or is not supported."\ }\ \],\ "source": {\ "line": 18,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "key\_up",\ "desc": "Releases a previously pressed keyboard key.",\ "params": \[\ {\ "name": "key",\ "desc": "The Virtual Key (VK) code of the key. (see KeyCode Library)",\ "lua\_type": "number"\ }\ \],\ "returns": \[\],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"Roblox is not focused\\"",\ "desc": "Roblox's windows is not the focused window."\ },\ {\ "lua\_type": "\\"Key is not pressed\\"",\ "desc": "The key is already 'released'."\ },\ {\ "lua\_type": "\\"Invalid or unsupported key\\"",\ "desc": "The VK code was invalid or is not supported."\ }\ \],\ "source": {\ "line": 29,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "key\_click",\ "desc": "Presses and releases a keyboard key in a single call.",\ "params": \[\ {\ "name": "key",\ "desc": "The Virtual Key (VK) code of the key. (see KeyCode Library)",\ "lua\_type": "number"\ }\ \],\ "returns": \[\],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"Roblox is not focused\\"",\ "desc": "Roblox's windows is not the focused window."\ },\ {\ "lua\_type": "\\"Invalid or unsupported key\\"",\ "desc": "The VK code was invalid or is not supported."\ }\ \],\ "source": {\ "line": 39,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "is\_key\_down",\ "desc": "Returns whether the specified key is currently pressed according to the internal library state.",\ "params": \[\ {\ "name": "key",\ "desc": "The Virtual Key (VK) code of the key. (see KeyCode Library)",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "True if the key is currently held down.",\ "lua\_type": "boolean"\ }\ \],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"Roblox is not focused\\"",\ "desc": "Roblox's windows is not the focused window."\ },\ {\ "lua\_type": "\\"Invalid or unsupported key\\"",\ "desc": "The VK code was invalid or is not supported."\ }\ \],\ "source": {\ "line": 50,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "mouse\_down",\ "desc": "Presses and holds a mouse button.",\ "params": \[\ {\ "name": "button",\ "desc": "The button code (e.g., 1 for Left, 2 for Right).",\ "lua\_type": "number"\ }\ \],\ "returns": \[\],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"Roblox is not focused\\"",\ "desc": "Roblox's windows is not the focused window."\ },\ {\ "lua\_type": "\\"Mouse button is already pressed\\"",\ "desc": "The mouse button is already 'held down'."\ },\ {\ "lua\_type": "\\"Invalid or unsupported mouse button\\"",\ "desc": "The Mouse VK code was invalid or is not supported."\ }\ \],\ "source": {\ "line": 63,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "mouse\_up",\ "desc": "Releases a previously pressed mouse button.",\ "params": \[\ {\ "name": "button",\ "desc": "The button code (e.g., 1 for Left, 2 for Right).",\ "lua\_type": "number"\ }\ \],\ "returns": \[\],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"Roblox is not focused\\"",\ "desc": "Roblox's windows is not the focused window."\ },\ {\ "lua\_type": "\\"Mouse button is not pressed\\"",\ "desc": "The mouse button is already 'released'."\ },\ {\ "lua\_type": "\\"Invalid or unsupported mouse button\\"",\ "desc": "The Mouse VK code was invalid or is not supported."\ }\ \],\ "source": {\ "line": 74,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "is\_mouse\_down",\ "desc": "Returns whether the specified mouse button is currently pressed.",\ "params": \[\ {\ "name": "button",\ "desc": "The button code.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "True if the button is held down.",\ "lua\_type": "boolean"\ }\ \],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"Roblox is not focused\\"",\ "desc": "Roblox's windows is not the focused window."\ },\ {\ "lua\_type": "\\"Invalid or unsupported mouse button\\"",\ "desc": "The Mouse VK code was invalid or is not supported."\ }\ \],\ "source": {\ "line": 85,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "mouse\_click",\ "desc": "Performs one or more mouse clicks sequentially.",\ "params": \[\ {\ "name": "button",\ "desc": "The button code.",\ "lua\_type": "number"\ },\ {\ "name": "count",\ "desc": "How many times to click (defaults to 1).",\ "lua\_type": "number?"\ }\ \],\ "returns": \[\],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"Roblox is not focused\\"",\ "desc": "Roblox's windows is not the focused window."\ },\ {\ "lua\_type": "\\"Click count must be greater than 0\\"",\ "desc": "The count parameter was less than 1 or equal to 0."\ },\ {\ "lua\_type": "\\"Invalid or unsupported mouse button\\"",\ "desc": "The Mouse VK code was invalid or is not supported."\ }\ \],\ "source": {\ "line": 99,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "mouse\_move\_absolute",\ "desc": "Moves the mouse cursor instantly to the given absolute screen position.",\ "params": \[\ {\ "name": "position",\ "desc": "The absolute XY screen coordinates.",\ "lua\_type": "Vector2"\ }\ \],\ "returns": \[\],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"Roblox is not focused\\"",\ "desc": "Roblox's windows is not the focused window."\ }\ \],\ "source": {\ "line": 108,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "mouse\_move\_relative",\ "desc": "Moves the mouse cursor instantly by the given offset relative to its current position.",\ "params": \[\ {\ "name": "offset",\ "desc": "The XY offset to move by.",\ "lua\_type": "Vector2"\ }\ \],\ "returns": \[\],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"Roblox is not focused\\"",\ "desc": "Roblox's windows is not the focused window."\ }\ \],\ "source": {\ "line": 117,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "mouse\_move\_tween",\ "desc": "Smoothly moves the mouse cursor to the target position over a period of time.\\nThis function yields the current thread until the move is complete.",\ "params": \[\ {\ "name": "position",\ "desc": "The target absolute XY position.",\ "lua\_type": "Vector2"\ },\ {\ "name": "timeInSeconds",\ "desc": "The duration of the movement.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"Roblox is not focused\\"",\ "desc": "Roblox's windows is not the focused window."\ },\ {\ "lua\_type": "\\"Time must be a positive number\\"",\ "desc": "The timeInSeconds parameter was not a positive number."\ }\ \],\ "source": {\ "line": 129,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "mouse\_move\_instance",\ "desc": "Moves the mouse cursor instantly to the center of the given Roblox UI instance.",\ "params": \[\ {\ "name": "instance",\ "desc": "The GuiObject to target.",\ "lua\_type": "Instance"\ }\ \],\ "returns": \[\],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"Roblox is not focused\\"",\ "desc": "Roblox's windows is not the focused window."\ },\ {\ "lua\_type": "\\"Instance must be a valid UI Instance\\"",\ "desc": "The object was not an Instance object of type GuiObject."\ },\ {\ "lua\_type": "\\"Instance is not visible or has no absolute position\\"",\ "desc": "The GuiObject was not visible or had no absolute position."\ }\ \],\ "source": {\ "line": 140,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "mouse\_move\_instance\_tween",\ "desc": "Smoothly moves the mouse cursor to the center of the given Roblox UI instance.\\nThis function yields the current thread until the move is complete.",\ "params": \[\ {\ "name": "instance",\ "desc": "The GuiObject to target.",\ "lua\_type": "Instance"\ },\ {\ "name": "timeInSeconds",\ "desc": "The duration of the movement.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"Roblox is not focused\\"",\ "desc": "Roblox's windows is not the focused window."\ },\ {\ "lua\_type": "\\"Instance must be a valid UI Instance\\"",\ "desc": "The object was not an Instance object of type GuiObject."\ },\ {\ "lua\_type": "\\"Instance is not visible or has no absolute position\\"",\ "desc": "The GuiObject was not visible or had no absolute position."\ },\ {\ "lua\_type": "\\"Time must be a positive number\\"",\ "desc": "The timeInSeconds parameter was not a positive number."\ }\ \],\ "source": {\ "line": 154,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "mouse\_click\_instance",\ "desc": "Moves the mouse cursor to the center of the given Roblox UI instance and performs a mouse click.",\ "params": \[\ {\ "name": "instance",\ "desc": "The GuiObject to target.",\ "lua\_type": "Instance"\ },\ {\ "name": "button",\ "desc": "The button VK code.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"Roblox is not focused\\"",\ "desc": "Roblox's windows is not the focused window."\ },\ {\ "lua\_type": "\\"Instance must be a valid UI Instance\\"",\ "desc": "The object was not an Instance object of type GuiObject."\ },\ {\ "lua\_type": "\\"Invalid or unsupported mouse button\\"",\ "desc": "The Mouse VK code was invalid or is not supported."\ },\ {\ "lua\_type": "\\"Instance is not visible or interactable\\"",\ "desc": "The GuiObject was not visible or isn't interactable."\ }\ \],\ "source": {\ "line": 167,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "mouse\_scroll",\ "desc": "Scrolls the mouse wheel by the given delta amount.",\ "params": \[\ {\ "name": "delta",\ "desc": "The amount to scroll (positive for up, negative for down).",\ "lua\_type": "number"\ }\ \],\ "returns": \[\],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"Roblox is not focused\\"",\ "desc": "Roblox's windows is not the focused window."\ }\ \],\ "source": {\ "line": 176,\ "path": "src/libraries/input.luau"\ }\ },\ {\ "name": "is\_window\_focused",\ "desc": "Returns whether the Roblox window is currently in focus.\\n\\n### Remark:\\nIt is recommended to call this function before performing any input sequence. \\nThe input library requires that Roblox be focused.",\ "params": \[\],\ "returns": \[\ {\ "desc": "True if the window is currently focused.",\ "lua\_type": "boolean"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 188,\ "path": "src/libraries/input.luau"\ }\ }\ \], "properties": \[\], "types": \[\], "name": "input", "desc": "The input library provides low-level simulation of keyboard and mouse events.\\nInputs are synthesized to the Roblox window.", "tags": \[\ "Library"\ \], "source": { "line": 7, "path": "src/libraries/input.luau" } } * [Functions](https://rbxcli.github.io/eUNC/api/input#functions) * [.is\_key\_down](https://rbxcli.github.io/eUNC/api/input#is_key_down) * [.is\_mouse\_down](https://rbxcli.github.io/eUNC/api/input#is_mouse_down) * [.is\_window\_focused](https://rbxcli.github.io/eUNC/api/input#is_window_focused) * [.key\_click](https://rbxcli.github.io/eUNC/api/input#key_click) * [.key\_down](https://rbxcli.github.io/eUNC/api/input#key_down) * [.key\_up](https://rbxcli.github.io/eUNC/api/input#key_up) * [.mouse\_click](https://rbxcli.github.io/eUNC/api/input#mouse_click) * [.mouse\_click\_instance](https://rbxcli.github.io/eUNC/api/input#mouse_click_instance) * [.mouse\_down](https://rbxcli.github.io/eUNC/api/input#mouse_down) * [.mouse\_move\_absolute](https://rbxcli.github.io/eUNC/api/input#mouse_move_absolute) * [.mouse\_move\_instance](https://rbxcli.github.io/eUNC/api/input#mouse_move_instance) * [.mouse\_move\_instance\_tween](https://rbxcli.github.io/eUNC/api/input#mouse_move_instance_tween) * [.mouse\_move\_relative](https://rbxcli.github.io/eUNC/api/input#mouse_move_relative) * [.mouse\_move\_tween](https://rbxcli.github.io/eUNC/api/input#mouse_move_tween) * [.mouse\_scroll](https://rbxcli.github.io/eUNC/api/input#mouse_scroll) * [.mouse\_up](https://rbxcli.github.io/eUNC/api/input#mouse_up) --- # physics | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/api/physics#__docusaurus_skipToContent_fallback) On this page Functions[​](https://rbxcli.github.io/eUNC/api/physics#functions "Direct link to Functions") --------------------------------------------------------------------------------------------- ### `raycast`[​](https://rbxcli.github.io/eUNC/api/physics#raycast "Direct link to raycast") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/physics.luau#L36) `physics.``raycast``(` `origin:` `vector``,`\-- The starting point of the ray. `direction:` `vector``,`\-- The unit direction of the ray. `distance:` `number``,`\-- The maximum distance the ray should travel. `ignoreList:` `{``[Instance](https://rbxcli.github.io/eUNC/api/Instance) ``}`\-- An array containing instances that the ray should ignore. `) →` `[RaycastResult?](https://rbxcli.github.io/eUNC/api/physics#RaycastResult) `\-- A table containing hit information, or nil if no hit occurred. ### Types ### [​](https://rbxcli.github.io/eUNC/api/physics#RaycastResult "Direct link to RaycastResult") `interface` `RaycastResult {` `distance:` `number`\-- The distance from the origin to the hit position. `hit_successful:` `boolean`\-- Whether the raycast successfully hit a surface. `position:` `vector`\-- The world position where the ray hit. `instance:` `[Instance?](https://rbxcli.github.io/eUNC/api/Instance) `\-- The Instance that was hit by the ray. `}` Performs a raycast against the physical world. The ray is constructed using an origin and a direction, which is then scaled by the provided distance. An exclusion list can be provided to ignore specific instances during the raycast calculation. ### Example Usage: local result = physics.raycast(Vector3.new(0, 10, 0), Vector3.new(0, -1, 0), 100, { workspace.BasePlate }) if result then print("Hit " .. result.instance.Name .. " at " .. tostring(result.position)) end ### Errors | Type | Description | | --- | --- | | "table must be an Array" | The ignoreList parameter is not a valid array of Instances. | | "direction vector cannot be a zero vector" | The direction vector provided is a zero vector (Magnitude is 0). | | "distance cannot be less or equal to 0" | The distance provided is negative or zero. | | "direction vector resulted in a zero vector" | The direction vector normalized and scaled by distance resulted in a zero vector. | | "collection contained an object which was not an RbxInstance." | The ignoreList contains an element that is not an Instance. | | "raycast unavailable" | The physics engine is not currently available, likely due to physics updates being disabled. | ### `get_part_pool`[​](https://rbxcli.github.io/eUNC/api/physics#get_part_pool "Direct link to get_part_pool") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/physics.luau#L61) `physics.``get_part_pool``(` `part:` `[Instance](https://rbxcli.github.io/eUNC/api/Instance) `\-- The BasePart to query. `) →` `number`\-- The pool index the part is located in. Retrieves the internal 'pool' index the part is assigned to within the RbxCli physics engine. The pool determines the update rate of the part on the overlay's visuals and affects how 'fresh' the data returned by other physics functions is. ### Errors | Type | Description | | --- | --- | | "object was freed" | The instance passed has been destroyed. | | "variant cast failed" | The instance passed is not a BasePart. | | "object is not tracked" | The part is not currently tracked by RbxCli. | ### `is_part_tracked`[​](https://rbxcli.github.io/eUNC/api/physics#is_part_tracked "Direct link to is_part_tracked") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/physics.luau#L80) `physics.``is_part_tracked``(` `part:` `[Instance](https://rbxcli.github.io/eUNC/api/Instance) `\-- The BasePart to check. `) →` `boolean`\-- True if the part is actively being updated. Checks if the specified BasePart is actively being updated by the RbxCli physics engine. ### Behavior * Parts inside Characters are typically ignored and will return `false`. * Newly created parts (less than ~20 seconds old) may return `false` until they are picked up by the worker. A memory read may occur if physics updating is disabled to ensure the most accurate data is returned. ### Errors | Type | Description | | --- | --- | | "object was freed" | The instance passed has been destroyed. | | "variant cast failed" | The instance passed is not a BasePart. | ### `get_tracked_size`[​](https://rbxcli.github.io/eUNC/api/physics#get_tracked_size "Direct link to get_tracked_size") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/physics.luau#L101) `physics.``get_tracked_size``(` `part:` `[Instance](https://rbxcli.github.io/eUNC/api/Instance) `\-- The BasePart to query. `) →` `[Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3)` \-- The cached size of the part. Retrieves the cached 'Size' of the part from the last RbxCli update. ### Performance Note This function reads from RbxCli's internal cache rather than reading directly from Roblox memory. * **Pros:** It is significantly faster than standard property access. * **Cons:** The data may be slightly out of date depending on the part's update pool. A memory read may occur if physics updating is disabled to ensure the most accurate data is returned. ### Errors | Type | Description | | --- | --- | | "object was freed" | The instance passed has been destroyed. | | "variant cast failed" | The instance passed is not a BasePart. | | "object is not tracked" | The part is not currently in the physics engine. | ### `get_tracked_cframe`[​](https://rbxcli.github.io/eUNC/api/physics#get_tracked_cframe "Direct link to get_tracked_cframe") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/physics.luau#L120) `physics.``get_tracked_cframe``(` `part:` `[Instance](https://rbxcli.github.io/eUNC/api/Instance) `\-- The BasePart to query. `) →` `[CFrame](https://developer.roblox.com/en-us/api-reference/datatype/CFrame)` \-- The cached CFrame of the part. Retrieves the cached 'CFrame' of the part from the last RbxCli update. ### Performance Note This function reads from RbxCli's internal cache rather than reading directly from Roblox memory. * **Pros:** It is significantly faster than standard property access. * **Cons:** The data may be slightly out of date depending on the part's update pool. ### Errors | Type | Description | | --- | --- | | "object was freed" | The instance passed has been destroyed. | | "variant cast failed" | The instance passed is not a BasePart. | | "object is not tracked" | The part is not currently in the physics engine. | ### `can_part_be_tracked`[​](https://rbxcli.github.io/eUNC/api/physics#can_part_be_tracked "Direct link to can_part_be_tracked") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/physics.luau#L135) `physics.``can_part_be_tracked``(` `part:` `[Instance](https://rbxcli.github.io/eUNC/api/Instance) `\-- The BasePart to check. `) →` `boolean`\-- True if the part is allowed to be tracked. Retrieves whether the given part is eligible to be tracked and updated by the physics engine. This indicates if the part has been explicitly enabled or disabled for updates within RbxCli's PhysicsWorld (e.g., via configuration or internal logic). ### Errors | Type | Description | | --- | --- | | "object was freed" | The instance passed has been destroyed. | | "variant cast failed" | The instance passed is not a BasePart. | ### `are_parts_updated`[​](https://rbxcli.github.io/eUNC/api/physics#are_parts_updated "Direct link to are_parts_updated") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/physics.luau#L147) `physics.``are_parts_updated``(``) →` `boolean`\-- True if parts are being updated internally. Checks if part data is being updated. If this function returns false, it indicates that parts are not being updated. In this case, RbxCli will fall back to reading from raw memory instead of from its built-in cache. This may lead to reduced execution speed or for some APIs to completely fail. ### `is_point_in_part`[​](https://rbxcli.github.io/eUNC/api/physics#is_point_in_part "Direct link to is_point_in_part") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/physics.luau#L165) `physics.``is_point_in_part``(` `point:` `[Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3)` `,`\-- The world space point to check. `part:` `[Instance](https://rbxcli.github.io/eUNC/api/Instance) `\-- The BasePart to test against. `) →` `boolean`\-- True if the point is inside the part, false otherwise. Determines if a given point in world space is located within the bounds of a specified BasePart. ### Errors | Type | Description | | --- | --- | | "object was freed" | The instance passed has been destroyed. | | "variant cast failed" | The instance passed is not a BasePart. | | "failed to retrieve instance data." | Memory read failure/ part data unavailable. | ### `is_point_in_box_volume`[​](https://rbxcli.github.io/eUNC/api/physics#is_point_in_box_volume "Direct link to is_point_in_box_volume") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/physics.luau#L180) `physics.``is_point_in_box_volume``(` `point:` `[Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3)` `,`\-- The world space point to check. `boxCFrame:` `[CFrame](https://developer.roblox.com/en-us/api-reference/datatype/CFrame)` `,`\-- The CFrame representing the center and orientation of the box. `boxSize:` `[Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3)` \-- The size of the box along each axis. `) →` `boolean`\-- True if the point is inside the box volume, false otherwise. Determines if a given point in world space is located within the bounds of an box volume defined by a CFrame and size. ### `is_point_in_sphere_volume`[​](https://rbxcli.github.io/eUNC/api/physics#is_point_in_sphere_volume "Direct link to is_point_in_sphere_volume") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/physics.luau#L194) `physics.``is_point_in_sphere_volume``(` `point:` `[Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3)` `,`\-- The world space point to check. `sphereCenter:` `[Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3)` `,`\-- The center of the sphere. `sphereRadius:` `number`\-- The radius of the sphere. `) →` `boolean`\-- True if the point is inside the sphere volume, false otherwise. Determines if a given point in world space is located within the bounds of a sphere volume defined by a center point and radius. Show raw api { "functions": \[\ {\ "name": "raycast",\ "desc": "Performs a raycast against the physical world.\\n\\nThe ray is constructed using an origin and a direction, which is then scaled by the provided distance.\\nAn exclusion list can be provided to ignore specific instances during the raycast calculation.\\n\\n### Example Usage:\\n\`\`\`lua\\nlocal result = physics.raycast(Vector3.new(0, 10, 0), Vector3.new(0, -1, 0), 100, { workspace.BasePlate })\\nif result then\\n print(\\"Hit \\" .. result.instance.Name .. \\" at \\" .. tostring(result.position))\\nend\\n\`\`\`",\ "params": \[\ {\ "name": "origin",\ "desc": "The starting point of the ray.",\ "lua\_type": "vector"\ },\ {\ "name": "direction",\ "desc": "The unit direction of the ray.",\ "lua\_type": "vector"\ },\ {\ "name": "distance",\ "desc": "The maximum distance the ray should travel.",\ "lua\_type": "number"\ },\ {\ "name": "ignoreList",\ "desc": "An array containing instances that the ray should ignore.",\ "lua\_type": "{Instance}"\ }\ \],\ "returns": \[\ {\ "desc": "A table containing hit information, or nil if no hit occurred.",\ "lua\_type": "RaycastResult?"\ }\ \],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"table must be an Array\\"",\ "desc": "The ignoreList parameter is not a valid array of Instances."\ },\ {\ "lua\_type": "\\"direction vector cannot be a zero vector\\"",\ "desc": "The direction vector provided is a zero vector (Magnitude is 0)."\ },\ {\ "lua\_type": "\\"distance cannot be less or equal to 0\\"",\ "desc": "The distance provided is negative or zero."\ },\ {\ "lua\_type": "\\"direction vector resulted in a zero vector\\"",\ "desc": "The direction vector normalized and scaled by distance resulted in a zero vector."\ },\ {\ "lua\_type": "\\"collection contained an object which was not an RbxInstance.\\"",\ "desc": "The ignoreList contains an element that is not an Instance."\ },\ {\ "lua\_type": "\\"raycast unavailable\\"",\ "desc": "The physics engine is not currently available, likely due to physics updates being disabled."\ }\ \],\ "source": {\ "line": 36,\ "path": "src/libraries/physics.luau"\ }\ },\ {\ "name": "get\_part\_pool",\ "desc": "Retrieves the internal 'pool' index the part is assigned to within the RbxCli physics engine.\\n\\nThe pool determines the update rate of the part on the overlay's visuals and affects how 'fresh' the data returned by other physics functions is.",\ "params": \[\ {\ "name": "part",\ "desc": "The BasePart to query.",\ "lua\_type": "Instance"\ }\ \],\ "returns": \[\ {\ "desc": "The pool index the part is located in.",\ "lua\_type": "number"\ }\ \],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"object was freed\\"",\ "desc": "The instance passed has been destroyed."\ },\ {\ "lua\_type": "\\"variant cast failed\\"",\ "desc": "The instance passed is not a BasePart."\ },\ {\ "lua\_type": "\\"object is not tracked\\"",\ "desc": "The part is not currently tracked by RbxCli."\ }\ \],\ "source": {\ "line": 61,\ "path": "src/libraries/physics.luau"\ }\ },\ {\ "name": "is\_part\_tracked",\ "desc": "Checks if the specified BasePart is actively being updated by the RbxCli physics engine.\\n\\n### Behavior\\n\* Parts inside Characters are typically ignored and will return \`false\`.\\n\* Newly created parts (less than ~20 seconds old) may return \`false\` until they are picked up by the worker.\\n\\nA memory read may occur if physics updating is disabled to ensure the most accurate data is returned.",\ "params": \[\ {\ "name": "part",\ "desc": "The BasePart to check.",\ "lua\_type": "Instance"\ }\ \],\ "returns": \[\ {\ "desc": "True if the part is actively being updated.",\ "lua\_type": "boolean"\ }\ \],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"object was freed\\"",\ "desc": "The instance passed has been destroyed."\ },\ {\ "lua\_type": "\\"variant cast failed\\"",\ "desc": "The instance passed is not a BasePart."\ }\ \],\ "source": {\ "line": 80,\ "path": "src/libraries/physics.luau"\ }\ },\ {\ "name": "get\_tracked\_size",\ "desc": "Retrieves the cached 'Size' of the part from the last RbxCli update.\\n\\n### Performance Note\\nThis function reads from RbxCli's internal cache rather than reading directly from Roblox memory. \\n\* \*\*Pros:\*\* It is significantly faster than standard property access.\\n\* \*\*Cons:\*\* The data may be slightly out of date depending on the part's update pool.\\n\\nA memory read may occur if physics updating is disabled to ensure the most accurate data is returned.",\ "params": \[\ {\ "name": "part",\ "desc": "The BasePart to query.",\ "lua\_type": "Instance"\ }\ \],\ "returns": \[\ {\ "desc": "The cached size of the part.",\ "lua\_type": "Vector3"\ }\ \],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"object was freed\\"",\ "desc": "The instance passed has been destroyed."\ },\ {\ "lua\_type": "\\"variant cast failed\\"",\ "desc": "The instance passed is not a BasePart."\ },\ {\ "lua\_type": "\\"object is not tracked\\"",\ "desc": "The part is not currently in the physics engine."\ }\ \],\ "source": {\ "line": 101,\ "path": "src/libraries/physics.luau"\ }\ },\ {\ "name": "get\_tracked\_cframe",\ "desc": "Retrieves the cached 'CFrame' of the part from the last RbxCli update.\\n\\n### Performance Note\\nThis function reads from RbxCli's internal cache rather than reading directly from Roblox memory.\\n\* \*\*Pros:\*\* It is significantly faster than standard property access.\\n\* \*\*Cons:\*\* The data may be slightly out of date depending on the part's update pool.",\ "params": \[\ {\ "name": "part",\ "desc": "The BasePart to query.",\ "lua\_type": "Instance"\ }\ \],\ "returns": \[\ {\ "desc": "The cached CFrame of the part.",\ "lua\_type": "CFrame"\ }\ \],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"object was freed\\"",\ "desc": "The instance passed has been destroyed."\ },\ {\ "lua\_type": "\\"variant cast failed\\"",\ "desc": "The instance passed is not a BasePart."\ },\ {\ "lua\_type": "\\"object is not tracked\\"",\ "desc": "The part is not currently in the physics engine."\ }\ \],\ "source": {\ "line": 120,\ "path": "src/libraries/physics.luau"\ }\ },\ {\ "name": "can\_part\_be\_tracked",\ "desc": "Retrieves whether the given part is eligible to be tracked and updated by the physics engine.\\n\\nThis indicates if the part has been explicitly enabled or disabled for updates within RbxCli's PhysicsWorld (e.g., via configuration or internal logic).",\ "params": \[\ {\ "name": "part",\ "desc": "The BasePart to check.",\ "lua\_type": "Instance"\ }\ \],\ "returns": \[\ {\ "desc": "True if the part is allowed to be tracked.",\ "lua\_type": "boolean"\ }\ \],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"object was freed\\"",\ "desc": "The instance passed has been destroyed."\ },\ {\ "lua\_type": "\\"variant cast failed\\"",\ "desc": "The instance passed is not a BasePart."\ }\ \],\ "source": {\ "line": 135,\ "path": "src/libraries/physics.luau"\ }\ },\ {\ "name": "are\_parts\_updated",\ "desc": "Checks if part data is being updated.\\n\\nIf this function returns false, it indicates that parts are not being updated. In this case, RbxCli will fall back to reading from raw memory instead of from its built-in cache. This may lead to reduced execution speed or for some APIs to completely fail.",\ "params": \[\],\ "returns": \[\ {\ "desc": "True if parts are being updated internally.",\ "lua\_type": "boolean"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 147,\ "path": "src/libraries/physics.luau"\ }\ },\ {\ "name": "is\_point\_in\_part",\ "desc": "Determines if a given point in world space is located within the bounds of a specified BasePart.",\ "params": \[\ {\ "name": "point",\ "desc": "The world space point to check.",\ "lua\_type": "Vector3"\ },\ {\ "name": "part",\ "desc": "The BasePart to test against.",\ "lua\_type": "Instance"\ }\ \],\ "returns": \[\ {\ "desc": "True if the point is inside the part, false otherwise.",\ "lua\_type": "boolean"\ }\ \],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"object was freed\\"",\ "desc": "The instance passed has been destroyed."\ },\ {\ "lua\_type": "\\"variant cast failed\\"",\ "desc": "The instance passed is not a BasePart."\ },\ {\ "lua\_type": "\\"failed to retrieve instance data.\\"",\ "desc": "Memory read failure/ part data unavailable."\ }\ \],\ "source": {\ "line": 165,\ "path": "src/libraries/physics.luau"\ }\ },\ {\ "name": "is\_point\_in\_box\_volume",\ "desc": "Determines if a given point in world space is located within the bounds of an box volume defined by a CFrame and size.",\ "params": \[\ {\ "name": "point",\ "desc": "The world space point to check.",\ "lua\_type": "Vector3"\ },\ {\ "name": "boxCFrame",\ "desc": "The CFrame representing the center and orientation of the box.",\ "lua\_type": "CFrame"\ },\ {\ "name": "boxSize",\ "desc": "The size of the box along each axis.",\ "lua\_type": "Vector3"\ }\ \],\ "returns": \[\ {\ "desc": "True if the point is inside the box volume, false otherwise.",\ "lua\_type": "boolean"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 180,\ "path": "src/libraries/physics.luau"\ }\ },\ {\ "name": "is\_point\_in\_sphere\_volume",\ "desc": "Determines if a given point in world space is located within the bounds of a sphere volume defined by a center point and radius.",\ "params": \[\ {\ "name": "point",\ "desc": "The world space point to check.",\ "lua\_type": "Vector3"\ },\ {\ "name": "sphereCenter",\ "desc": "The center of the sphere.",\ "lua\_type": "Vector3"\ },\ {\ "name": "sphereRadius",\ "desc": "The radius of the sphere.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "True if the point is inside the sphere volume, false otherwise.",\ "lua\_type": "boolean"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 194,\ "path": "src/libraries/physics.luau"\ }\ }\ \], "properties": \[\], "types": \[\ {\ "name": "RaycastResult",\ "desc": "",\ "fields": \[\ {\ "name": "distance",\ "lua\_type": "number",\ "desc": "The distance from the origin to the hit position."\ },\ {\ "name": "hit\_successful",\ "lua\_type": "boolean",\ "desc": "Whether the raycast successfully hit a surface."\ },\ {\ "name": "position",\ "lua\_type": "vector",\ "desc": "The world position where the ray hit."\ },\ {\ "name": "instance",\ "lua\_type": "Instance?",\ "desc": "The Instance that was hit by the ray."\ }\ \],\ "source": {\ "line": 48,\ "path": "src/libraries/physics.luau"\ }\ }\ \], "name": "physics", "desc": "The physics library provides access to the world's physical state, allowing for spatial queries such as raycasting.", "tags": \[\ "Library"\ \], "source": { "line": 6, "path": "src/libraries/physics.luau" } } * [Types](https://rbxcli.github.io/eUNC/api/physics#types) * [RaycastResult](https://rbxcli.github.io/eUNC/api/physics#RaycastResult) * [Functions](https://rbxcli.github.io/eUNC/api/physics#functions) * [.are\_parts\_updated](https://rbxcli.github.io/eUNC/api/physics#are_parts_updated) * [.can\_part\_be\_tracked](https://rbxcli.github.io/eUNC/api/physics#can_part_be_tracked) * [.get\_part\_pool](https://rbxcli.github.io/eUNC/api/physics#get_part_pool) * [.get\_tracked\_cframe](https://rbxcli.github.io/eUNC/api/physics#get_tracked_cframe) * [.get\_tracked\_size](https://rbxcli.github.io/eUNC/api/physics#get_tracked_size) * [.is\_part\_tracked](https://rbxcli.github.io/eUNC/api/physics#is_part_tracked) * [.is\_point\_in\_box\_volume](https://rbxcli.github.io/eUNC/api/physics#is_point_in_box_volume) * [.is\_point\_in\_part](https://rbxcli.github.io/eUNC/api/physics#is_point_in_part) * [.is\_point\_in\_sphere\_volume](https://rbxcli.github.io/eUNC/api/physics#is_point_in_sphere_volume) * [.raycast](https://rbxcli.github.io/eUNC/api/physics#raycast) --- # rendering | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/api/rendering#__docusaurus_skipToContent_fallback) On this page Functions[​](https://rbxcli.github.io/eUNC/api/rendering#functions "Direct link to Functions") ----------------------------------------------------------------------------------------------- ### `world_to_screen`[​](https://rbxcli.github.io/eUNC/api/rendering#world_to_screen "Direct link to world_to_screen") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/rendering.luau#L22) `rendering.``world_to_screen``(` `partOrPosition:` `[BasePart](https://rbxcli.github.io/eUNC/api/BasePart) ` `|` `[Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3)` \-- The part or Position to project. `) →` `(` `[Vector2](https://developer.roblox.com/en-us/api-reference/datatype/Vector2)` `,` `boolean` `)`\-- A tuple containing first a Vector2, representing the position of the object in pixels, with containing second whether the object is visible on screen. Attempts to project the position/ part into the screen space. ##### WARNING This function may support positions that are slightly off-screen on some implementations, these yield matematically correct projections, but the X and Y values may be extremely high. For off-screen coordinates, the boolean present on the tuple should be true. For a more accurate check use rendering.is_on_screen ### `is_on_screen`[​](https://rbxcli.github.io/eUNC/api/rendering#is_on_screen "Direct link to is_on_screen") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/rendering.luau#L36) `rendering.``is_on_screen``(` `partOrPosition:` `[BasePart](https://rbxcli.github.io/eUNC/api/BasePart) ` `|` `[Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3)` \-- The part or Position to project. `) →` `boolean`\-- If true, the position is visible on screen and the coordinates are within the screen viewport. Validates if the position/ part will be visible within the viewport of the game. ##### Implementation for Part objects The underlying implementation may vary for Part objects. Some implementations may cache positions and update them periodically, or they may retrieve the position on call. Show raw api { "functions": \[\ {\ "name": "world\_to\_screen",\ "desc": "Attempts to project the position/ part into the screen space.\\n\\n\\n:::warning\\n This function may support positions that are slightly off-screen on some implementations, these yield matematically correct projections, but the X and Y values may be extremely high.\\n\\n For off-screen coordinates, the boolean present on the tuple should be true. For a more accurate check use rendering.is\_on\_screen\\n:::",\ "params": \[\ {\ "name": "partOrPosition",\ "desc": "The part or Position to project.",\ "lua\_type": "BasePart | Vector3"\ }\ \],\ "returns": \[\ {\ "desc": "A tuple containing first a Vector2, representing the position of the object in pixels, with containing second whether the object is visible on screen.",\ "lua\_type": "(Vector2, boolean)"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 22,\ "path": "src/libraries/rendering.luau"\ }\ },\ {\ "name": "is\_on\_screen",\ "desc": "Validates if the position/ part will be visible within the viewport of the game.\\n\\n\\n:::info Implementation for Part objects\\n The underlying implementation may vary for Part objects. Some implementations may cache positions and update them periodically, or they may retrieve the position on call.\\n:::",\ "params": \[\ {\ "name": "partOrPosition",\ "desc": "The part or Position to project.",\ "lua\_type": "BasePart | Vector3"\ }\ \],\ "returns": \[\ {\ "desc": "If true, the position is visible on screen and the coordinates are within the screen viewport.",\ "lua\_type": "boolean"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 36,\ "path": "src/libraries/rendering.luau"\ }\ }\ \], "properties": \[\], "types": \[\], "name": "rendering", "desc": "Contains functions related to rendering operations.", "tags": \[\ "Library"\ \], "source": { "line": 8, "path": "src/libraries/rendering.luau" } } * [Functions](https://rbxcli.github.io/eUNC/api/rendering#functions) * [.is\_on\_screen](https://rbxcli.github.io/eUNC/api/rendering#is_on_screen) * [.world\_to\_screen](https://rbxcli.github.io/eUNC/api/rendering#world_to_screen) --- # rbxcli | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/api/rbxcli#__docusaurus_skipToContent_fallback) On this page Functions[​](https://rbxcli.github.io/eUNC/api/rbxcli#functions "Direct link to Functions") -------------------------------------------------------------------------------------------- ### `get_product_information`[​](https://rbxcli.github.io/eUNC/api/rbxcli#get_product_information "Direct link to get_product_information") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/rbxcli.luau#L68) `rbxcli.``get_product_information``(``) →` `[ProductInformation](https://rbxcli.github.io/eUNC/api/ProductInformation) `\-- A table containing information about the product running the script. Obtains information about the version of the product that runs the script. ### `display_notification`[​](https://rbxcli.github.io/eUNC/api/rbxcli#display_notification "Direct link to display_notification") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/rbxcli.luau#L84) `rbxcli.``display_notification``(` `content:` `string``,`\-- The content of the notification. `timeInSeconds:` `number`\-- The amount of time in seconds the notification should be displayed for. Defaults to 5 seconds. Must be greater than 0. `) →` `(``)` Displays a notification using the built-in User Interface and it's notification system. ### `teleport_local_player`[​](https://rbxcli.github.io/eUNC/api/rbxcli#teleport_local_player "Direct link to teleport_local_player") This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yields [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/rbxcli.luau#L93) `rbxcli.``teleport_local_player``(` `pos:` `[Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3)` \-- The position to teleport the local player to, in global space. `) →` `(``)` Attempts to teleport the local player to the given position in the world. ### `firetouchinterest`[​](https://rbxcli.github.io/eUNC/api/rbxcli#firetouchinterest "Direct link to firetouchinterest") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/rbxcli.luau#L117) `rbxcli.``firetouchinterest``(` `part0:` `[BasePart](https://rbxcli.github.io/eUNC/api/BasePart) ``,`\-- The first part involved in the touch interaction. `part1:` `[BasePart](https://rbxcli.github.io/eUNC/api/BasePart) ``,`\-- The second part involved in the touch interaction. `touchType:` `number``,`\-- The type of touch interaction. 0 for Touch, 1 for Untouch. `replicate:` `boolean?`\-- Whether or not to replicate the touch event to the server, defaults to true. `) →` `(``)` Attempts to fire the .Touched event between two parts. ### Warning This feature depends on 'Hybrid mode' being enabled, with it disabled, the function will be unavailable. ### Errors | Type | Description | | --- | --- | | "touch must be either 0 (Touch) or 1 (Untouch)" | touchType is not 0 or 1. | | "neither of the parts to be 'touched' are owned. The event would not be fired, firing is unavailable." | Neither part is owned by the local player, firing the event would have no effect. | | "object was freed." | One of the parts has been removed from the game. | | "instance to fire may be type confused, firing is unavailable" | One of the parts may be re-used heap memory, attempting to fire the event is unsafe and has been blocked. | | "instance to fire is not a BasePart, firing is unavailable." | One of the parts does not inherit from the BasePart class. | | "instance to fire is not touchable, firing is unavailable." | One of the parts has CanTouch set to false, .Touched would not be fireable. | | "instance contains no physics object, firing is unavailable." | One of the parts contains an invalid 'Primitive' object. Firing the event is unsafe and has been blocked. | ### `fireproximityprompt`[​](https://rbxcli.github.io/eUNC/api/rbxcli#fireproximityprompt "Direct link to fireproximityprompt") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/rbxcli.luau#L138) `rbxcli.``fireproximityprompt``(` `orompt:` `[ProximityPrompt](https://developer.roblox.com/en-us/api-reference/class/ProximityPrompt)` \-- The prompt to fire. `) →` `(``)` Attempts to fire the .Triggered event of the provided ProximityPrompt. ### Warning This feature depends on 'Hybrid mode' being enabled, with it disabled, the function will be unavailable. ### Information This function provides no way to simulate the hold duration of a ProximityPrompt, it will always trigger the prompt as if it were tapped and if the duration was 0. This can be detected by fancier anticheat systems, as the necessary events that go before and/or after the `.Triggered` event, such as `.PromptButtonHoldBegan`, `.PromptButtonHoldEnded` or `.TriggerEnded` would not be fired appropriately. Due to this, use this function with caution when dealing with fancier anticheats. ### Errors | Type | Description | | --- | --- | | "object was freed." | The object has been removed from the game. | | "instance to fire may be type confused, firing is unavailable" | The object may be re-used heap memory, attempting to fire the event is unsafe and has been blocked. | | "instance to fire is not a ProximityPrompt, firing is unavailable." | The provided instance is not a ProximityPrompt. | Show raw api { "functions": \[\ {\ "name": "get\_product\_information",\ "desc": "Obtains information about the version of the product that runs the script.",\ "params": \[\],\ "returns": \[\ {\ "desc": "A table containing information about the product running the script.",\ "lua\_type": "ProductInformation"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 68,\ "path": "src/libraries/rbxcli.luau"\ }\ },\ {\ "name": "display\_notification",\ "desc": "Displays a notification using the built-in User Interface and it's notification system.",\ "params": \[\ {\ "name": "content",\ "desc": "The content of the notification.",\ "lua\_type": "string"\ },\ {\ "name": "timeInSeconds",\ "desc": "The amount of time in seconds the notification should be displayed for. Defaults to 5 seconds. Must be greater than 0.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\],\ "function\_type": "static",\ "source": {\ "line": 84,\ "path": "src/libraries/rbxcli.luau"\ }\ },\ {\ "name": "teleport\_local\_player",\ "desc": "Attempts to teleport the local player to the given position in the world.",\ "params": \[\ {\ "name": "pos",\ "desc": "The position to teleport the local player to, in global space.",\ "lua\_type": "Vector3"\ }\ \],\ "returns": \[\],\ "function\_type": "static",\ "yields": true,\ "source": {\ "line": 93,\ "path": "src/libraries/rbxcli.luau"\ }\ },\ {\ "name": "firetouchinterest",\ "desc": "Attempts to fire the .Touched event between two parts.\\n\\n\\n\\n### Warning\\n\\nThis feature depends on 'Hybrid mode' being enabled, with it disabled, the function will be unavailable.",\ "params": \[\ {\ "name": "part0",\ "desc": "The first part involved in the touch interaction.",\ "lua\_type": "BasePart"\ },\ {\ "name": "part1",\ "desc": "The second part involved in the touch interaction.",\ "lua\_type": "BasePart"\ },\ {\ "name": "touchType",\ "desc": "The type of touch interaction. 0 for Touch, 1 for Untouch.",\ "lua\_type": "number"\ },\ {\ "name": "replicate",\ "desc": "Whether or not to replicate the touch event to the server, defaults to true.",\ "lua\_type": "boolean?"\ }\ \],\ "returns": \[\],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"touch must be either 0 (Touch) or 1 (Untouch)\\"",\ "desc": "touchType is not 0 or 1."\ },\ {\ "lua\_type": "\\"neither of the parts to be 'touched' are owned. The event would not be fired, firing is unavailable.\\"",\ "desc": "Neither part is owned by the local player, firing the event would have no effect."\ },\ {\ "lua\_type": "\\"object was freed.\\"",\ "desc": "One of the parts has been removed from the game."\ },\ {\ "lua\_type": "\\"instance to fire may be type confused, firing is unavailable\\"",\ "desc": "One of the parts may be re-used heap memory, attempting to fire the event is unsafe and has been blocked."\ },\ {\ "lua\_type": "\\"instance to fire is not a BasePart, firing is unavailable.\\"",\ "desc": "One of the parts does not inherit from the BasePart class."\ },\ {\ "lua\_type": "\\"instance to fire is not touchable, firing is unavailable.\\"",\ "desc": "One of the parts has CanTouch set to false, .Touched would not be fireable."\ },\ {\ "lua\_type": "\\"instance contains no physics object, firing is unavailable.\\"",\ "desc": "One of the parts contains an invalid 'Primitive' object. Firing the event is unsafe and has been blocked."\ }\ \],\ "source": {\ "line": 117,\ "path": "src/libraries/rbxcli.luau"\ }\ },\ {\ "name": "fireproximityprompt",\ "desc": "Attempts to fire the .Triggered event of the provided ProximityPrompt.\\n\\n\\n\\n### Warning\\nThis feature depends on 'Hybrid mode' being enabled, with it disabled, the function will be unavailable.\\n\\n### Information\\nThis function provides no way to simulate the hold duration of a ProximityPrompt, it will always trigger the prompt as if it were tapped and if the duration was 0. This can be detected by fancier anticheat systems, as the necessary events that go before and/or after the \`.Triggered\` event, such as \`.PromptButtonHoldBegan\`, \`.PromptButtonHoldEnded\` or \`.TriggerEnded\` would not be fired appropriately.\\n\\nDue to this, use this function with caution when dealing with fancier anticheats.",\ "params": \[\ {\ "name": "orompt",\ "desc": "The prompt to fire.",\ "lua\_type": "ProximityPrompt"\ }\ \],\ "returns": \[\],\ "function\_type": "static",\ "errors": \[\ {\ "lua\_type": "\\"object was freed.\\"",\ "desc": "The object has been removed from the game."\ },\ {\ "lua\_type": "\\"instance to fire may be type confused, firing is unavailable\\"",\ "desc": "The object may be re-used heap memory, attempting to fire the event is unsafe and has been blocked."\ },\ {\ "lua\_type": "\\"instance to fire is not a ProximityPrompt, firing is unavailable.\\"",\ "desc": "The provided instance is not a ProximityPrompt."\ }\ \],\ "source": {\ "line": 138,\ "path": "src/libraries/rbxcli.luau"\ }\ }\ \], "properties": \[\], "types": \[\], "name": "rbxcli", "desc": "Contains functions related to miscellaneous and/or general interactions with RbxCli.", "tags": \[\ "Library"\ \], "source": { "line": 53, "path": "src/libraries/rbxcli.luau" } } * [Functions](https://rbxcli.github.io/eUNC/api/rbxcli#functions) * [.display\_notification](https://rbxcli.github.io/eUNC/api/rbxcli#display_notification) * [.fireproximityprompt](https://rbxcli.github.io/eUNC/api/rbxcli#fireproximityprompt) * [.firetouchinterest](https://rbxcli.github.io/eUNC/api/rbxcli#firetouchinterest) * [.get\_product\_information](https://rbxcli.github.io/eUNC/api/rbxcli#get_product_information) * [.teleport\_local\_player](https://rbxcli.github.io/eUNC/api/rbxcli#teleport_local_player) --- # memory | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/api/memory#__docusaurus_skipToContent_fallback) On this page Functions[​](https://rbxcli.github.io/eUNC/api/memory#functions "Direct link to Functions") -------------------------------------------------------------------------------------------- ### `is_enabled`[​](https://rbxcli.github.io/eUNC/api/memory#is_enabled "Direct link to is_enabled") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L76) `memory.``is_enabled``(``) →` `boolean`\-- If true, the Memory library is enabled and can be used. Return whether the Memory library access is enabled. ### `read`[​](https://rbxcli.github.io/eUNC/api/memory#read "Direct link to read") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L87) `memory.``read``(` `address:` `number``,`\-- The remote address to read from. `size:` `number`\-- The size of the read. `) →` `(` `number``,` `buffer` `)`\-- A status code (ProcessReadResult) representing if the operation was successful, and a buffer representing the contents read. Performs a memory read on the specified address with the given size. ### `read_string`[​](https://rbxcli.github.io/eUNC/api/memory#read_string "Direct link to read_string") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L100) `memory.``read_string``(` `address:` `number``,`\-- The remote address to read from. `isCxxString:` `boolean``,`\-- Whether the string is a C++ style string, which has a complex structure instead of a simple null-terminated string. `readCount:` `number?``,`\-- An optional maximum number of bytes to read, if not specified, it will read until a null-terminator is found. Only used if the string is a C string. `readExactly:` `boolean`\-- If true, will read exactly readCount bytes, otherwise will stop at the first null-terminator found. Only used if the string is a C string. `) →` `(` `number``,` `string?` `)`\-- A status code (ProcessReadResult) representing if the operation was successful, and the string read, or nil if the read failed. Attempts to read an ASCII string from the specified address. ### `readbool`[​](https://rbxcli.github.io/eUNC/api/memory#readbool "Direct link to readbool") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L115) `memory.``readbool``(` `address:` `number`\-- The remote address to read from. `) →` `(` `number``,` `boolean?` `)`\-- A status code (ProcessReadResult) and the boolean read. Reads a boolean value from the specified address. ### `readu8`[​](https://rbxcli.github.io/eUNC/api/memory#readu8 "Direct link to readu8") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L125) `memory.``readu8``(` `address:` `number`\-- The remote address to read from. `) →` `(` `number``,` `number?` `)`\-- A status code (ProcessReadResult) and the value read. Reads an unsigned 8-bit integer (byte) from the specified address. ### `readu16`[​](https://rbxcli.github.io/eUNC/api/memory#readu16 "Direct link to readu16") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L135) `memory.``readu16``(` `address:` `number`\-- The remote address to read from. `) →` `(` `number``,` `number?` `)`\-- A status code (ProcessReadResult) and the value read. Reads an unsigned 16-bit integer (short) from the specified address. ### `readu32`[​](https://rbxcli.github.io/eUNC/api/memory#readu32 "Direct link to readu32") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L145) `memory.``readu32``(` `address:` `number`\-- The remote address to read from. `) →` `(` `number``,` `number?` `)`\-- A status code (ProcessReadResult) and the value read. Reads an unsigned 32-bit integer (int) from the specified address. ### `readi8`[​](https://rbxcli.github.io/eUNC/api/memory#readi8 "Direct link to readi8") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L155) `memory.``readi8``(` `address:` `number`\-- The remote address to read from. `) →` `(` `number``,` `number?` `)`\-- A status code (ProcessReadResult) and the value read. Reads a signed 8-bit integer from the specified address. ### `readi16`[​](https://rbxcli.github.io/eUNC/api/memory#readi16 "Direct link to readi16") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L165) `memory.``readi16``(` `address:` `number`\-- The remote address to read from. `) →` `(` `number``,` `number?` `)`\-- A status code (ProcessReadResult) and the value read. Reads a signed 16-bit integer from the specified address. ### `readi32`[​](https://rbxcli.github.io/eUNC/api/memory#readi32 "Direct link to readi32") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L175) `memory.``readi32``(` `address:` `number`\-- The remote address to read from. `) →` `(` `number``,` `number?` `)`\-- A status code (ProcessReadResult) and the value read. Reads a signed 32-bit integer from the specified address. ### `readf32`[​](https://rbxcli.github.io/eUNC/api/memory#readf32 "Direct link to readf32") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L185) `memory.``readf32``(` `address:` `number`\-- The remote address to read from. `) →` `(` `number``,` `number?` `)`\-- A status code (ProcessReadResult) and the value read. Reads a 32-bit floating point number from the specified address. ### `readf64`[​](https://rbxcli.github.io/eUNC/api/memory#readf64 "Direct link to readf64") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L195) `memory.``readf64``(` `address:` `number`\-- The remote address to read from. `) →` `(` `number``,` `number?` `)`\-- A status code (ProcessReadResult) and the value read. Reads a 64-bit floating point number (double) from the specified address. ### `read_pointer`[​](https://rbxcli.github.io/eUNC/api/memory#read_pointer "Direct link to read_pointer") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L205) `memory.``read_pointer``(` `address:` `number`\-- The remote address to read from. `) →` `(` `number``,` `number?` `)`\-- A status code (ProcessReadResult) and the pointer address read. Reads a pointer value from the specified address. ### `write`[​](https://rbxcli.github.io/eUNC/api/memory#write "Direct link to write") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L216) `memory.``write``(` `address:` `number``,`\-- The address to write to. `buffer:` `buffer`\-- The buffer containing the data to write. `) →` `number`\-- A status code (ProcessWriteResult) representing if the write operation was successful. Attempts to write to the specified address with the given buffer. ### `writebool`[​](https://rbxcli.github.io/eUNC/api/memory#writebool "Direct link to writebool") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L227) `memory.``writebool``(` `address:` `number``,`\-- The address to write to. `value:` `boolean`\-- The value to write. `) →` `number`\-- A status code (ProcessWriteResult). Writes a boolean value to the specified address. ### `writeu8`[​](https://rbxcli.github.io/eUNC/api/memory#writeu8 "Direct link to writeu8") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L238) `memory.``writeu8``(` `address:` `number``,`\-- The address to write to. `value:` `number`\-- The value to write. `) →` `number`\-- A status code (ProcessWriteResult). Writes an unsigned 8-bit integer to the specified address. ### `writeu16`[​](https://rbxcli.github.io/eUNC/api/memory#writeu16 "Direct link to writeu16") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L249) `memory.``writeu16``(` `address:` `number``,`\-- The address to write to. `value:` `number`\-- The value to write. `) →` `number`\-- A status code (ProcessWriteResult). Writes an unsigned 16-bit integer to the specified address. ### `writeu32`[​](https://rbxcli.github.io/eUNC/api/memory#writeu32 "Direct link to writeu32") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L260) `memory.``writeu32``(` `address:` `number``,`\-- The address to write to. `value:` `number`\-- The value to write. `) →` `number`\-- A status code (ProcessWriteResult). Writes an unsigned 32-bit integer to the specified address. ### `writei8`[​](https://rbxcli.github.io/eUNC/api/memory#writei8 "Direct link to writei8") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L271) `memory.``writei8``(` `address:` `number``,`\-- The address to write to. `value:` `number`\-- The value to write. `) →` `number`\-- A status code (ProcessWriteResult). Writes a signed 8-bit integer to the specified address. ### `writei16`[​](https://rbxcli.github.io/eUNC/api/memory#writei16 "Direct link to writei16") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L282) `memory.``writei16``(` `address:` `number``,`\-- The address to write to. `value:` `number`\-- The value to write. `) →` `number`\-- A status code (ProcessWriteResult). Writes a signed 16-bit integer to the specified address. ### `writei32`[​](https://rbxcli.github.io/eUNC/api/memory#writei32 "Direct link to writei32") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L293) `memory.``writei32``(` `address:` `number``,`\-- The address to write to. `value:` `number`\-- The value to write. `) →` `number`\-- A status code (ProcessWriteResult). Writes a signed 32-bit integer to the specified address. ### `writef32`[​](https://rbxcli.github.io/eUNC/api/memory#writef32 "Direct link to writef32") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L304) `memory.``writef32``(` `address:` `number``,`\-- The address to write to. `value:` `number`\-- The value to write. `) →` `number`\-- A status code (ProcessWriteResult). Writes a 32-bit floating point number to the specified address. ### `writef64`[​](https://rbxcli.github.io/eUNC/api/memory#writef64 "Direct link to writef64") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L315) `memory.``writef64``(` `address:` `number``,`\-- The address to write to. `value:` `number`\-- The value to write. `) →` `number`\-- A status code (ProcessWriteResult). Writes a 64-bit floating point number to the specified address. ### `scan_signature`[​](https://rbxcli.github.io/eUNC/api/memory#scan_signature "Direct link to scan_signature") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L327) `memory.``scan_signature``(` `signature:` `string``,`\-- The AOB signature in libhat format. (e.g: "48 ?? 33 ?? C3") `startAddress:` `number?``,`\-- An optional starting address to begin the scan from. If not provided, the scan will start from the beginning of the process memory. `endAddress:` `number?`\-- An optional ending address to stop the scan at. If not provided, the scan will go until the end of the process memory. This parameter is ignored if startAddress is not provided. `) →` `(` `number``,` `{``number``}``?` `)`\-- A tuple containing first a status code (ProcessReadResult) representing if the operation was successful, and second containing the list of matches found. Attempts to scan the process memory for the given signature. ### `scan_instances`[​](https://rbxcli.github.io/eUNC/api/memory#scan_instances "Direct link to scan_instances") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L337) `memory.``scan_instances``(` `vtableAddress:` `number`\-- The address of the VTable the classes should look for. `) →` `{``number``}`\-- An array of addresses of the instances whose first member is the VTable. Scans for instances in memory given a vtable. ### `scan_vtable`[​](https://rbxcli.github.io/eUNC/api/memory#scan_vtable "Direct link to scan_vtable") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L347) `memory.``scan_vtable``(` `vtableName:` `string`\-- The name of the vtable in MANGLED form. `) →` `number?`\-- The pointer to the VTable address, may be nil if not found. Scans the Roblox PE for a VTable given the mangled name. ### `is_valid_address`[​](https://rbxcli.github.io/eUNC/api/memory#is_valid_address "Direct link to is_valid_address") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L357) `memory.``is_valid_address``(` `address:` `number`\-- The address to check. `) →` `boolean`\-- True if the address is a valid pointer in the target process. Validates if the given address is a valid remote pointer. ### `get_base_address`[​](https://rbxcli.github.io/eUNC/api/memory#get_base_address "Direct link to get_base_address") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/memory.luau#L366) `memory.``get_base_address``(``) →` `number`\-- The base address. Gets the base address of the main module of the target process. Show raw api { "functions": \[\ {\ "name": "is\_enabled",\ "desc": "Return whether the Memory library access is enabled.",\ "params": \[\],\ "returns": \[\ {\ "desc": "If true, the Memory library is enabled and can be used.",\ "lua\_type": "boolean"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 76,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "read",\ "desc": "Performs a memory read on the specified address with the given size.",\ "params": \[\ {\ "name": "address",\ "desc": "The remote address to read from.",\ "lua\_type": "number"\ },\ {\ "name": "size",\ "desc": "The size of the read.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessReadResult) representing if the operation was successful, and a buffer representing the contents read.",\ "lua\_type": "(number, buffer)"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 87,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "read\_string",\ "desc": "Attempts to read an ASCII string from the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The remote address to read from.",\ "lua\_type": "number"\ },\ {\ "name": "isCxxString",\ "desc": "Whether the string is a C++ style string, which has a complex structure instead of a simple null-terminated string.",\ "lua\_type": "boolean"\ },\ {\ "name": "readCount",\ "desc": "An optional maximum number of bytes to read, if not specified, it will read until a null-terminator is found. Only used if the string is a C string.",\ "lua\_type": "number?"\ },\ {\ "name": "readExactly",\ "desc": "If true, will read exactly readCount bytes, otherwise will stop at the first null-terminator found. Only used if the string is a C string.",\ "lua\_type": "boolean"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessReadResult) representing if the operation was successful, and the string read, or nil if the read failed.",\ "lua\_type": "(number, string?)"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 100,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "readbool",\ "desc": "Reads a boolean value from the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The remote address to read from.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessReadResult) and the boolean read.",\ "lua\_type": "(number, boolean?)"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 115,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "readu8",\ "desc": "Reads an unsigned 8-bit integer (byte) from the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The remote address to read from.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessReadResult) and the value read.",\ "lua\_type": "(number, number?)"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 125,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "readu16",\ "desc": "Reads an unsigned 16-bit integer (short) from the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The remote address to read from.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessReadResult) and the value read.",\ "lua\_type": "(number, number?)"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 135,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "readu32",\ "desc": "Reads an unsigned 32-bit integer (int) from the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The remote address to read from.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessReadResult) and the value read.",\ "lua\_type": "(number, number?)"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 145,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "readi8",\ "desc": "Reads a signed 8-bit integer from the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The remote address to read from.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessReadResult) and the value read.",\ "lua\_type": "(number, number?)"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 155,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "readi16",\ "desc": "Reads a signed 16-bit integer from the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The remote address to read from.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessReadResult) and the value read.",\ "lua\_type": "(number, number?)"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 165,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "readi32",\ "desc": "Reads a signed 32-bit integer from the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The remote address to read from.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessReadResult) and the value read.",\ "lua\_type": "(number, number?)"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 175,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "readf32",\ "desc": "Reads a 32-bit floating point number from the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The remote address to read from.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessReadResult) and the value read.",\ "lua\_type": "(number, number?)"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 185,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "readf64",\ "desc": "Reads a 64-bit floating point number (double) from the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The remote address to read from.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessReadResult) and the value read.",\ "lua\_type": "(number, number?)"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 195,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "read\_pointer",\ "desc": "Reads a pointer value from the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The remote address to read from.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessReadResult) and the pointer address read.",\ "lua\_type": "(number, number?)"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 205,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "write",\ "desc": "Attempts to write to the specified address with the given buffer.",\ "params": \[\ {\ "name": "address",\ "desc": "The address to write to.",\ "lua\_type": "number"\ },\ {\ "name": "buffer",\ "desc": "The buffer containing the data to write.",\ "lua\_type": "buffer"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessWriteResult) representing if the write operation was successful.",\ "lua\_type": "number"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 216,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "writebool",\ "desc": "Writes a boolean value to the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The address to write to.",\ "lua\_type": "number"\ },\ {\ "name": "value",\ "desc": "The value to write.",\ "lua\_type": "boolean"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessWriteResult).",\ "lua\_type": "number"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 227,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "writeu8",\ "desc": "Writes an unsigned 8-bit integer to the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The address to write to.",\ "lua\_type": "number"\ },\ {\ "name": "value",\ "desc": "The value to write.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessWriteResult).",\ "lua\_type": "number"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 238,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "writeu16",\ "desc": "Writes an unsigned 16-bit integer to the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The address to write to.",\ "lua\_type": "number"\ },\ {\ "name": "value",\ "desc": "The value to write.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessWriteResult).",\ "lua\_type": "number"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 249,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "writeu32",\ "desc": "Writes an unsigned 32-bit integer to the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The address to write to.",\ "lua\_type": "number"\ },\ {\ "name": "value",\ "desc": "The value to write.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessWriteResult).",\ "lua\_type": "number"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 260,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "writei8",\ "desc": "Writes a signed 8-bit integer to the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The address to write to.",\ "lua\_type": "number"\ },\ {\ "name": "value",\ "desc": "The value to write.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessWriteResult).",\ "lua\_type": "number"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 271,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "writei16",\ "desc": "Writes a signed 16-bit integer to the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The address to write to.",\ "lua\_type": "number"\ },\ {\ "name": "value",\ "desc": "The value to write.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessWriteResult).",\ "lua\_type": "number"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 282,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "writei32",\ "desc": "Writes a signed 32-bit integer to the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The address to write to.",\ "lua\_type": "number"\ },\ {\ "name": "value",\ "desc": "The value to write.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessWriteResult).",\ "lua\_type": "number"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 293,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "writef32",\ "desc": "Writes a 32-bit floating point number to the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The address to write to.",\ "lua\_type": "number"\ },\ {\ "name": "value",\ "desc": "The value to write.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessWriteResult).",\ "lua\_type": "number"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 304,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "writef64",\ "desc": "Writes a 64-bit floating point number to the specified address.",\ "params": \[\ {\ "name": "address",\ "desc": "The address to write to.",\ "lua\_type": "number"\ },\ {\ "name": "value",\ "desc": "The value to write.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "A status code (ProcessWriteResult).",\ "lua\_type": "number"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 315,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "scan\_signature",\ "desc": "Attempts to scan the process memory for the given signature.",\ "params": \[\ {\ "name": "signature",\ "desc": "The AOB signature in libhat format. (e.g: \\"48 ?? 33 ?? C3\\")",\ "lua\_type": "string"\ },\ {\ "name": "startAddress",\ "desc": "An optional starting address to begin the scan from. If not provided, the scan will start from the beginning of the process memory.",\ "lua\_type": "number?"\ },\ {\ "name": "endAddress",\ "desc": "An optional ending address to stop the scan at. If not provided, the scan will go until the end of the process memory. This parameter is ignored if startAddress is not provided.",\ "lua\_type": "number?"\ }\ \],\ "returns": \[\ {\ "desc": "A tuple containing first a status code (ProcessReadResult) representing if the operation was successful, and second containing the list of matches found.",\ "lua\_type": "(number, { number }?)"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 327,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "scan\_instances",\ "desc": "Scans for instances in memory given a vtable.",\ "params": \[\ {\ "name": "vtableAddress",\ "desc": "The address of the VTable the classes should look for.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "An array of addresses of the instances whose first member is the VTable.",\ "lua\_type": "{ number }"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 337,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "scan\_vtable",\ "desc": "Scans the Roblox PE for a VTable given the mangled name.",\ "params": \[\ {\ "name": "vtableName",\ "desc": "The name of the vtable in MANGLED form.",\ "lua\_type": "string"\ }\ \],\ "returns": \[\ {\ "desc": "The pointer to the VTable address, may be nil if not found.",\ "lua\_type": "number?"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 347,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "is\_valid\_address",\ "desc": "Validates if the given address is a valid remote pointer.",\ "params": \[\ {\ "name": "address",\ "desc": "The address to check.",\ "lua\_type": "number"\ }\ \],\ "returns": \[\ {\ "desc": "True if the address is a valid pointer in the target process.",\ "lua\_type": "boolean"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 357,\ "path": "src/libraries/memory.luau"\ }\ },\ {\ "name": "get\_base\_address",\ "desc": "Gets the base address of the main module of the target process.",\ "params": \[\],\ "returns": \[\ {\ "desc": "The base address.",\ "lua\_type": "number"\ }\ \],\ "function\_type": "static",\ "source": {\ "line": 366,\ "path": "src/libraries/memory.luau"\ }\ }\ \], "properties": \[\], "types": \[\], "name": "memory", "desc": "Contains functions related explicitly to modifying Roblox memory.", "tags": \[\ "Library"\ \], "source": { "line": 9, "path": "src/libraries/memory.luau" } } * [Functions](https://rbxcli.github.io/eUNC/api/memory#functions) * [.get\_base\_address](https://rbxcli.github.io/eUNC/api/memory#get_base_address) * [.is\_enabled](https://rbxcli.github.io/eUNC/api/memory#is_enabled) * [.is\_valid\_address](https://rbxcli.github.io/eUNC/api/memory#is_valid_address) * [.read](https://rbxcli.github.io/eUNC/api/memory#read) * [.read\_pointer](https://rbxcli.github.io/eUNC/api/memory#read_pointer) * [.read\_string](https://rbxcli.github.io/eUNC/api/memory#read_string) * [.readbool](https://rbxcli.github.io/eUNC/api/memory#readbool) * [.readf32](https://rbxcli.github.io/eUNC/api/memory#readf32) * [.readf64](https://rbxcli.github.io/eUNC/api/memory#readf64) * [.readi16](https://rbxcli.github.io/eUNC/api/memory#readi16) * [.readi32](https://rbxcli.github.io/eUNC/api/memory#readi32) * [.readi8](https://rbxcli.github.io/eUNC/api/memory#readi8) * [.readu16](https://rbxcli.github.io/eUNC/api/memory#readu16) * [.readu32](https://rbxcli.github.io/eUNC/api/memory#readu32) * [.readu8](https://rbxcli.github.io/eUNC/api/memory#readu8) * [.scan\_instances](https://rbxcli.github.io/eUNC/api/memory#scan_instances) * [.scan\_signature](https://rbxcli.github.io/eUNC/api/memory#scan_signature) * [.scan\_vtable](https://rbxcli.github.io/eUNC/api/memory#scan_vtable) * [.write](https://rbxcli.github.io/eUNC/api/memory#write) * [.writebool](https://rbxcli.github.io/eUNC/api/memory#writebool) * [.writef32](https://rbxcli.github.io/eUNC/api/memory#writef32) * [.writef64](https://rbxcli.github.io/eUNC/api/memory#writef64) * [.writei16](https://rbxcli.github.io/eUNC/api/memory#writei16) * [.writei32](https://rbxcli.github.io/eUNC/api/memory#writei32) * [.writei8](https://rbxcli.github.io/eUNC/api/memory#writei8) * [.writeu16](https://rbxcli.github.io/eUNC/api/memory#writeu16) * [.writeu32](https://rbxcli.github.io/eUNC/api/memory#writeu32) * [.writeu8](https://rbxcli.github.io/eUNC/api/memory#writeu8) --- # ProductInformation | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/api/ProductInformation#__docusaurus_skipToContent_fallback) On this page Properties[​](https://rbxcli.github.io/eUNC/api/ProductInformation#properties "Direct link to Properties") ----------------------------------------------------------------------------------------------------------- ### `name`[​](https://rbxcli.github.io/eUNC/api/ProductInformation#name "Direct link to name") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/rbxcli.luau#L17) `ProductInformation.name:` `string` The name of the tool running the script. ### `build`[​](https://rbxcli.github.io/eUNC/api/ProductInformation#build "Direct link to build") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/rbxcli.luau#L29) `ProductInformation.build:` `string` The build version of the product in the form of `major.minor.patch[letter]-[beta/alpha]` `[letter]` may be present if a hotfix or a minor update has been applied to the build, but was not sufficient to be considered a patch version. `[beta/alpha]` may not be present if the build is considered a stable, released build. ### `build`[​](https://rbxcli.github.io/eUNC/api/ProductInformation#build "Direct link to build") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/rbxcli.luau#L37) `ProductInformation.build:` `string` The date of the build that this product version was built in the form of `DD-MM-YYYY` ### `built_for_roblox_version`[​](https://rbxcli.github.io/eUNC/api/ProductInformation#built_for_roblox_version "Direct link to built_for_roblox_version") [](https://github.com/RbxCli/eUNC/blob/dev/src/libraries/rbxcli.luau#L45) `ProductInformation.built_for_roblox_version:` `string` The Roblox version that this product is built for in the form of `version-{{HASH}}` Show raw api { "functions": \[\], "properties": \[\ {\ "name": "name",\ "desc": "The name of the tool running the script.",\ "lua\_type": "string",\ "source": {\ "line": 17,\ "path": "src/libraries/rbxcli.luau"\ }\ },\ {\ "name": "build",\ "desc": "The build version of the product in the form of \`major.minor.patch\[letter\]-\[beta/alpha\]\`\\n\\n\`\[letter\]\` may be present if a hotfix or a minor update has been applied to the build, but was not sufficient to be considered a patch version.\\n\\n\`\[beta/alpha\]\` may not be present if the build is considered a stable, released build. ",\ "lua\_type": "string",\ "source": {\ "line": 29,\ "path": "src/libraries/rbxcli.luau"\ }\ },\ {\ "name": "build",\ "desc": "The date of the build that this product version was built in the form of \`DD-MM-YYYY\`",\ "lua\_type": "string",\ "source": {\ "line": 37,\ "path": "src/libraries/rbxcli.luau"\ }\ },\ {\ "name": "built\_for\_roblox\_version",\ "desc": "The Roblox version that this product is built for in the form of \`version-{{HASH}}\`",\ "lua\_type": "string",\ "source": {\ "line": 45,\ "path": "src/libraries/rbxcli.luau"\ }\ }\ \], "types": \[\], "name": "ProductInformation", "desc": "Represents a structure containing information about the product.", "tags": \[\ "Class"\ \], "source": { "line": 9, "path": "src/libraries/rbxcli.luau" } } * [Properties](https://rbxcli.github.io/eUNC/api/ProductInformation#properties) * [build](https://rbxcli.github.io/eUNC/api/ProductInformation#build) * [build](https://rbxcli.github.io/eUNC/api/ProductInformation#build) * [built\_for\_roblox\_version](https://rbxcli.github.io/eUNC/api/ProductInformation#built_for_roblox_version) * [name](https://rbxcli.github.io/eUNC/api/ProductInformation#name) --- # BasePart | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/api/BasePart#__docusaurus_skipToContent_fallback) On this page Properties[​](https://rbxcli.github.io/eUNC/api/BasePart#properties "Direct link to Properties") ------------------------------------------------------------------------------------------------- ### `Position`[​](https://rbxcli.github.io/eUNC/api/BasePart#Position "Direct link to Position") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/basepart.luau#L23) `BasePart.Position:` `[Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3) ` The current world position for this part. ##### Remarks Writing to this value may be slower than ideal, due to this, prevent writing to this property if possible. ### `CFrame`[​](https://rbxcli.github.io/eUNC/api/BasePart#CFrame "Direct link to CFrame") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/basepart.luau#L35) `BasePart.CFrame:` `CoordinateFrame` The coordinate frame representing the position and rotation of this part in the world. ##### Remarks Writing to this value may be slower than ideal, due to this, prevent writing to this property if possible. ### `Size`[​](https://rbxcli.github.io/eUNC/api/BasePart#Size "Direct link to Size") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/basepart.luau#L47) `BasePart.Size:` `[Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3) ` The size the part holds in the physics engine. ##### Remarks Modifying this property will not modify the visual size of the part, only its physical collision size. ### `IsNetworkOwner`[​](https://rbxcli.github.io/eUNC/api/BasePart#IsNetworkOwner "Direct link to IsNetworkOwner") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/basepart.luau#L56) `BasePart.IsNetworkOwner:` `boolean` Whether or not the LocalPlayer is the owner of this part for physics replication. ### `IsNetworkOwner`[​](https://rbxcli.github.io/eUNC/api/BasePart#IsNetworkOwner "Direct link to IsNetworkOwner") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/basepart.luau#L64) `BasePart.IsNetworkOwner:` `boolean` Whether or not the Part is reported as sleeping for physics replication. ### `Anchored`[​](https://rbxcli.github.io/eUNC/api/BasePart#Anchored "Direct link to Anchored") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/basepart.luau#L72) `BasePart.Anchored:` `boolean` Whether or not the Part is being simulated by the Physics Engine. ### `CanCollide`[​](https://rbxcli.github.io/eUNC/api/BasePart#CanCollide "Direct link to CanCollide") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/basepart.luau#L80) `BasePart.CanCollide:` `boolean` Whether or not the Part is collidable within the Physics Engine. ### `CanQuery`[​](https://rbxcli.github.io/eUNC/api/BasePart#CanQuery "Direct link to CanQuery") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/basepart.luau#L88) `BasePart.CanQuery:` `boolean` Whether or not the Part can be queried for physics interactions. ### `CanTouch`[​](https://rbxcli.github.io/eUNC/api/BasePart#CanTouch "Direct link to CanTouch") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/basepart.luau#L96) `BasePart.CanTouch:` `boolean` Whether or not the Part will raise Touch events when it interacts with other parts. ### `NetworkOwnerV3`[​](https://rbxcli.github.io/eUNC/api/BasePart#NetworkOwnerV3 "Direct link to NetworkOwnerV3") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/basepart.luau#L105) `BasePart.NetworkOwnerV3:` `[RaknetID](https://rbxcli.github.io/eUNC/docs/Roblox/NetworkIds) ` The RakNet ID for the owner of this part. ### `AssemblyLinearVelocity`[​](https://rbxcli.github.io/eUNC/api/BasePart#AssemblyLinearVelocity "Direct link to AssemblyLinearVelocity") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/basepart.luau#L113) `BasePart.AssemblyLinearVelocity:` `[Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3) ` The linear velocity of the part in the assembly. ### `AssemblyAngularVelocity`[​](https://rbxcli.github.io/eUNC/api/BasePart#AssemblyAngularVelocity "Direct link to AssemblyAngularVelocity") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/basepart.luau#L121) `BasePart.AssemblyAngularVelocity:` `[Vector3](https://developer.roblox.com/en-us/api-reference/datatype/Vector3) ` The angular velocity of the part in the assembly. Show raw api { "functions": \[\], "properties": \[\ {\ "name": "Position",\ "desc": "The current world position for this part.\\n\\n:::info Remarks\\n Writing to this value may be slower than ideal, due to this, prevent writing to this property if possible.\\n:::",\ "lua\_type": "Vector3",\ "source": {\ "line": 23,\ "path": "src/instances/basepart.luau"\ }\ },\ {\ "name": "CFrame",\ "desc": "The coordinate frame representing the position and rotation of this part in the world.\\n\\n:::info Remarks\\n Writing to this value may be slower than ideal, due to this, prevent writing to this property if possible.\\n:::",\ "lua\_type": "CoordinateFrame",\ "source": {\ "line": 35,\ "path": "src/instances/basepart.luau"\ }\ },\ {\ "name": "Size",\ "desc": "The size the part holds in the physics engine.\\n\\n:::info Remarks\\n Modifying this property will not modify the visual size of the part, only its physical collision size.\\n:::",\ "lua\_type": "Vector3",\ "source": {\ "line": 47,\ "path": "src/instances/basepart.luau"\ }\ },\ {\ "name": "IsNetworkOwner",\ "desc": "Whether or not the LocalPlayer is the owner of this part for physics replication.",\ "lua\_type": "boolean",\ "readonly": true,\ "source": {\ "line": 56,\ "path": "src/instances/basepart.luau"\ }\ },\ {\ "name": "IsNetworkOwner",\ "desc": "Whether or not the Part is reported as sleeping for physics replication.",\ "lua\_type": "boolean",\ "source": {\ "line": 64,\ "path": "src/instances/basepart.luau"\ }\ },\ {\ "name": "Anchored",\ "desc": "Whether or not the Part is being simulated by the Physics Engine.",\ "lua\_type": "boolean",\ "source": {\ "line": 72,\ "path": "src/instances/basepart.luau"\ }\ },\ {\ "name": "CanCollide",\ "desc": "Whether or not the Part is collidable within the Physics Engine.",\ "lua\_type": "boolean",\ "source": {\ "line": 80,\ "path": "src/instances/basepart.luau"\ }\ },\ {\ "name": "CanQuery",\ "desc": "Whether or not the Part can be queried for physics interactions.",\ "lua\_type": "boolean",\ "source": {\ "line": 88,\ "path": "src/instances/basepart.luau"\ }\ },\ {\ "name": "CanTouch",\ "desc": "Whether or not the Part will raise Touch events when it interacts with other parts.",\ "lua\_type": "boolean",\ "source": {\ "line": 96,\ "path": "src/instances/basepart.luau"\ }\ },\ {\ "name": "NetworkOwnerV3",\ "desc": "The RakNet ID for the owner of this part.",\ "lua\_type": "RaknetID",\ "external\_types": \[\ {\ "name": "RaknetID",\ "url": "/docs/Roblox/NetworkIds"\ }\ \],\ "source": {\ "line": 105,\ "path": "src/instances/basepart.luau"\ }\ },\ {\ "name": "AssemblyLinearVelocity",\ "desc": "The linear velocity of the part in the assembly.",\ "lua\_type": "Vector3",\ "source": {\ "line": 113,\ "path": "src/instances/basepart.luau"\ }\ },\ {\ "name": "AssemblyAngularVelocity",\ "desc": "The angular velocity of the part in the assembly.",\ "lua\_type": "Vector3",\ "source": {\ "line": 121,\ "path": "src/instances/basepart.luau"\ }\ }\ \], "types": \[\], "name": "BasePart", "desc": "Contains methods and fields that are required by the standard in BasePart objects.\\n\\nThis class inherits from the Instance class.", "tags": \[\ "Instances"\ \], "source": { "line": 11, "path": "src/instances/basepart.luau" } } * [Properties](https://rbxcli.github.io/eUNC/api/BasePart#properties) * [Anchored](https://rbxcli.github.io/eUNC/api/BasePart#Anchored) * [AssemblyAngularVelocity](https://rbxcli.github.io/eUNC/api/BasePart#AssemblyAngularVelocity) * [AssemblyLinearVelocity](https://rbxcli.github.io/eUNC/api/BasePart#AssemblyLinearVelocity) * [CanCollide](https://rbxcli.github.io/eUNC/api/BasePart#CanCollide) * [CanQuery](https://rbxcli.github.io/eUNC/api/BasePart#CanQuery) * [CanTouch](https://rbxcli.github.io/eUNC/api/BasePart#CanTouch) * [CFrame](https://rbxcli.github.io/eUNC/api/BasePart#CFrame) * [IsNetworkOwner](https://rbxcli.github.io/eUNC/api/BasePart#IsNetworkOwner) * [IsNetworkOwner](https://rbxcli.github.io/eUNC/api/BasePart#IsNetworkOwner) * [NetworkOwnerV3](https://rbxcli.github.io/eUNC/api/BasePart#NetworkOwnerV3) * [Position](https://rbxcli.github.io/eUNC/api/BasePart#Position) * [Size](https://rbxcli.github.io/eUNC/api/BasePart#Size) --- # Security | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/docs/security#__docusaurus_skipToContent_fallback) Some APIs present within RbxCli are considered **high risk**, as they provide script programmers the possibility to read and write potential user data. APIs deemed to be of **high risk** require reasonable, sufficient steps to be enabled, such as checkboxes and warnings once enabled. This is made to prevent users from suffering potential consequences from potential malicious actors, this also allows us to include and allow our users to publish their own intellectual property, such as scripts, with their own protections. --- # RakNet IDs | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/docs/Roblox/NetworkIds#__docusaurus_skipToContent_fallback) RbxCli allows you to read the Network ID of objects such as parts. This ID is the 'who' on the "Who simulates this part?". These values are not publicly defined, as they're relating to RakNet. Previously, one could have been able to know the Network IDs of other players, however this has been long removed, and the only communication you have is with the Server directly. RbxCli distinguishes these parts on the explorer by their network id. | Network ID | Owner | Happens When | | --- | --- | --- | | **\-1** | **Not Simulated** (No Owner) | Part is not parented to Workspace or Physics simulation is disabled | | **1** | **Server** (Server) | The server owns this part and its responsable for its physics simulation. | | **2** | **Welded/Anchored** (Server/You) | The part is welded to another, forming an assembly. It is not independantly simulated, and it is tied to the assembly's primary part. | | **3** | **Remotely Simulated** (Server/Player) | The server or another player owns this part and its responsable for its physics simulation. | | **4+** | **Local Player** (You) | You own this part and are responsable for its physics simulation, changes you do (Position, Size, ...) will replicate to other clients and the server. | --- # DataModel | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/api/DataModel#__docusaurus_skipToContent_fallback) On this page Properties[​](https://rbxcli.github.io/eUNC/api/DataModel#properties "Direct link to Properties") -------------------------------------------------------------------------------------------------- ### `UniverseId`[​](https://rbxcli.github.io/eUNC/api/DataModel#UniverseId "Direct link to UniverseId") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/datamodel.luau#L20) `DataModel.UniverseId:` `number` The unique identifier for this game in Roblox. ### `GameId`[​](https://rbxcli.github.io/eUNC/api/DataModel#GameId "Direct link to GameId") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/datamodel.luau#L29) `DataModel.GameId:` `number` The unique identifier for this game in Roblox. ### `PlaceId`[​](https://rbxcli.github.io/eUNC/api/DataModel#PlaceId "Direct link to PlaceId") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/datamodel.luau#L38) `DataModel.PlaceId:` `number` The unique identifier for this specific place within the game. ### `Workspace`[​](https://rbxcli.github.io/eUNC/api/DataModel#Workspace "Direct link to Workspace") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/datamodel.luau#L47) `DataModel.Workspace:` `[Workspace?](https://developer.roblox.com/en-us/api-reference/class/Workspace) ` The Workspace instance of the DataModel, unaffected by renaming. ### `JobId`[​](https://rbxcli.github.io/eUNC/api/DataModel#JobId "Direct link to JobId") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/datamodel.luau#L56) `DataModel.JobId:` `string` The GUID representing the instance the game is running on. Functions[​](https://rbxcli.github.io/eUNC/api/DataModel#functions "Direct link to Functions") ----------------------------------------------------------------------------------------------- ### `GetService`[​](https://rbxcli.github.io/eUNC/api/DataModel#GetService "Direct link to GetService") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/datamodel.luau#L76) `DataModel:``GetService``(` `serviceName:` `string`\-- The name of the service to retrieve. `) →` `[Instance?](https://rbxcli.github.io/eUNC/api/Instance) `\-- The service instance, which may be nil if it does not exist Attempts to retrieve a service based on its ClassName. ##### Locking This function will not create services unlike the Roblox version, it is akin to FindService. ##### Aliases This function has the following aliases: - FindService - service - findService Show raw api { "functions": \[\ {\ "name": "GetService",\ "desc": "Attempts to retrieve a service based on its ClassName.\\n\\n\\n:::info Locking\\n This function will not create services unlike the Roblox version, it is akin to FindService.\\n:::\\n\\n:::info Aliases\\n This function has the following aliases:\\n - FindService\\n - service\\n - findService\\n:::",\ "params": \[\ {\ "name": "serviceName",\ "desc": "The name of the service to retrieve.",\ "lua\_type": "string"\ }\ \],\ "returns": \[\ {\ "desc": "The service instance, which may be nil if it does not exist",\ "lua\_type": "Instance?"\ }\ \],\ "function\_type": "method",\ "source": {\ "line": 76,\ "path": "src/instances/datamodel.luau"\ }\ }\ \], "properties": \[\ {\ "name": "UniverseId",\ "desc": "The unique identifier for this game in Roblox.",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 20,\ "path": "src/instances/datamodel.luau"\ }\ },\ {\ "name": "GameId",\ "desc": "The unique identifier for this game in Roblox.",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 29,\ "path": "src/instances/datamodel.luau"\ }\ },\ {\ "name": "PlaceId",\ "desc": "The unique identifier for this specific place within the game.",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 38,\ "path": "src/instances/datamodel.luau"\ }\ },\ {\ "name": "Workspace",\ "desc": "The Workspace instance of the DataModel, unaffected by renaming.",\ "lua\_type": "Workspace?",\ "readonly": true,\ "source": {\ "line": 47,\ "path": "src/instances/datamodel.luau"\ }\ },\ {\ "name": "JobId",\ "desc": "The GUID representing the instance the game is running on.",\ "lua\_type": "string",\ "readonly": true,\ "source": {\ "line": 56,\ "path": "src/instances/datamodel.luau"\ }\ }\ \], "types": \[\], "name": "DataModel", "desc": "Contains methods and fields that are required by the standard in DataModel objects.\\n\\nThis class inherits from the Instance class.", "tags": \[\ "Instances"\ \], "source": { "line": 11, "path": "src/instances/datamodel.luau" } } * [Properties](https://rbxcli.github.io/eUNC/api/DataModel#properties) * [GameId](https://rbxcli.github.io/eUNC/api/DataModel#GameId) * [JobId](https://rbxcli.github.io/eUNC/api/DataModel#JobId) * [PlaceId](https://rbxcli.github.io/eUNC/api/DataModel#PlaceId) * [UniverseId](https://rbxcli.github.io/eUNC/api/DataModel#UniverseId) * [Workspace](https://rbxcli.github.io/eUNC/api/DataModel#Workspace) * [Functions](https://rbxcli.github.io/eUNC/api/DataModel#functions) * [:GetService](https://rbxcli.github.io/eUNC/api/DataModel#GetService) --- # Instance | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/api/Instance#__docusaurus_skipToContent_fallback) On this page Properties[​](https://rbxcli.github.io/eUNC/api/Instance#properties "Direct link to Properties") ------------------------------------------------------------------------------------------------- ### `Name`[​](https://rbxcli.github.io/eUNC/api/Instance#Name "Direct link to Name") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/instance.luau#L23) `Instance.Name:` `string` Contains the Name of the object. ##### Readonly Validity This property may be safe to read/write on certain conditions. However this behaviour is not guaranteed by spec. ### `ClassName`[​](https://rbxcli.github.io/eUNC/api/Instance#ClassName "Direct link to ClassName") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/instance.luau#L32) `Instance.ClassName:` `string` Contains the ClassName of the object, held in its class descriptor. ### `Parent`[​](https://rbxcli.github.io/eUNC/api/Instance#Parent "Direct link to Parent") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/instance.luau#L41) `Instance.Parent:` `instance?` The parent of the instance, may be nil. ### `Address`[​](https://rbxcli.github.io/eUNC/api/Instance#Address "Direct link to Address") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/instance.luau#L50) `Instance.Address:` `number` The address of the instance in roblox memory. Functions[​](https://rbxcli.github.io/eUNC/api/Instance#functions "Direct link to Functions") ---------------------------------------------------------------------------------------------- ### `IsA`[​](https://rbxcli.github.io/eUNC/api/Instance#IsA "Direct link to IsA") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/instance.luau#L59) `Instance:``IsA``(` `className:` `string`\-- The name of the class that is checked for inheritance. `) →` `boolean`\-- Whether the object's class inherits from className Performs an inheritance check, validating whether the object's class derives from the given `className` ### `GetChildren`[​](https://rbxcli.github.io/eUNC/api/Instance#GetChildren "Direct link to GetChildren") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/instance.luau#L69) `Instance:``GetChildren``(``) →` `{``[Instance](https://rbxcli.github.io/eUNC/api/Instance) ``}`\-- All children of the instance Retrieves the children for the instance. ### `GetDescendants`[​](https://rbxcli.github.io/eUNC/api/Instance#GetDescendants "Direct link to GetDescendants") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/instance.luau#L85) `Instance:``GetDescendants``(``) →` `{``[Instance](https://rbxcli.github.io/eUNC/api/Instance) ``}`\-- All descendants of the instance Retrieves the descendants for the instance. ##### Performance This function may be **very** slow. Avoid using it if possible. ### `GetFullName`[​](https://rbxcli.github.io/eUNC/api/Instance#GetFullName "Direct link to GetFullName") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/instance.luau#L95) `Instance:``GetFullName``(``) →` `string`\-- The fully qualified name for the instance. Retrieves the fully qualified name for the given instance. ### `OfClass`[​](https://rbxcli.github.io/eUNC/api/Instance#OfClass "Direct link to OfClass") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/instance.luau#L106) `Instance:``OfClass``(` `className:` `string`\-- The expected class name `) →` `boolean`\-- Whether the given class name is equal to the one the instance possesses. Checks the immediate Class of the object. ### `FindFirstChild`[​](https://rbxcli.github.io/eUNC/api/Instance#FindFirstChild "Direct link to FindFirstChild") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/instance.luau#L122) `Instance:``FindFirstChild``(` `name:` `string`\-- The instance name `) →` `[Instance?](https://rbxcli.github.io/eUNC/api/Instance) `\-- An instance, which may be null if it was not found. Attempts to find the first child on the instance which matches the given name. ##### Performance This function may silently performs GetChildren for every invocation, if you are going to be repeatedly getting children, and you know they may not suddenly change, it is better you cache the list and retrieve them yourself. ### `FindFirstChildOfClass`[​](https://rbxcli.github.io/eUNC/api/Instance#FindFirstChildOfClass "Direct link to FindFirstChildOfClass") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/instance.luau#L138) `Instance:``FindFirstChildOfClass``(` `className:` `string`\-- The class name of the target instance `) →` `[Instance?](https://rbxcli.github.io/eUNC/api/Instance) `\-- An instance, which may be null if it was not found. Attempts to find the first child on the instance which matches the given class name. ##### Performance This function may silently performs GetChildren for every invocation, if you are going to be repeatedly getting children, and you know they may not suddenly change, it is better you cache the list and retrieve them yourself. ### `FindFirstChildWhichIsA`[​](https://rbxcli.github.io/eUNC/api/Instance#FindFirstChildWhichIsA "Direct link to FindFirstChildWhichIsA") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/instance.luau#L154) `Instance:``FindFirstChildWhichIsA``(` `className:` `string`\-- The class name of the target instance `) →` `[Instance?](https://rbxcli.github.io/eUNC/api/Instance) `\-- An instance, which may be null if it was not found. Attempts to find the first child on the instance whose class matches or inherits from the given class. ##### Performance This function may silently performs GetChildren for every invocation, if you are going to be repeatedly getting children, and you know they may not suddenly change, it is better you cache the list and retrieve them yourself. ### `GetAttribute`[​](https://rbxcli.github.io/eUNC/api/Instance#GetAttribute "Direct link to GetAttribute") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/instance.luau#L165) `Instance:``GetAttribute``(` `attributeName:` `string`\-- The name of the target attribute. `) →` `any?`\-- The value of the attribute, which may be nil. Attempts to retrieve the attribute with the given name. ### `GetAttributes`[​](https://rbxcli.github.io/eUNC/api/Instance#GetAttributes "Direct link to GetAttributes") [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/instance.luau#L175) `Instance:``GetAttributes``(``) →` `{``[``string``]``:` `any?``}`\-- A dictionary containinig all attributes available with their names as the key. Attempts to retrieve all attributes of the instance. Show raw api { "functions": \[\ {\ "name": "IsA",\ "desc": "Performs an inheritance check, validating whether the object's class derives from the given \`className\`",\ "params": \[\ {\ "name": "className",\ "desc": "The name of the class that is checked for inheritance.",\ "lua\_type": "string"\ }\ \],\ "returns": \[\ {\ "desc": "Whether the object's class inherits from className",\ "lua\_type": "boolean"\ }\ \],\ "function\_type": "method",\ "source": {\ "line": 59,\ "path": "src/instances/instance.luau"\ }\ },\ {\ "name": "GetChildren",\ "desc": "Retrieves the children for the instance. ",\ "params": \[\],\ "returns": \[\ {\ "desc": "All children of the instance",\ "lua\_type": "{ Instance }"\ }\ \],\ "function\_type": "method",\ "source": {\ "line": 69,\ "path": "src/instances/instance.luau"\ }\ },\ {\ "name": "GetDescendants",\ "desc": "Retrieves the descendants for the instance. \\n\\n\\n:::warning Performance\\n This function may be \*\*very\*\* slow. \\n\\n Avoid using it if possible.\\n:::",\ "params": \[\],\ "returns": \[\ {\ "desc": "All descendants of the instance",\ "lua\_type": "{ Instance }"\ }\ \],\ "function\_type": "method",\ "source": {\ "line": 85,\ "path": "src/instances/instance.luau"\ }\ },\ {\ "name": "GetFullName",\ "desc": "Retrieves the fully qualified name for the given instance.",\ "params": \[\],\ "returns": \[\ {\ "desc": "The fully qualified name for the instance.",\ "lua\_type": "string"\ }\ \],\ "function\_type": "method",\ "source": {\ "line": 95,\ "path": "src/instances/instance.luau"\ }\ },\ {\ "name": "OfClass",\ "desc": "Checks the immediate Class of the object.",\ "params": \[\ {\ "name": "className",\ "desc": "The expected class name",\ "lua\_type": "string"\ }\ \],\ "returns": \[\ {\ "desc": "Whether the given class name is equal to the one the instance possesses.",\ "lua\_type": "boolean"\ }\ \],\ "function\_type": "method",\ "source": {\ "line": 106,\ "path": "src/instances/instance.luau"\ }\ },\ {\ "name": "FindFirstChild",\ "desc": "Attempts to find the first child on the instance which matches the given name.\\n\\n\\n\\n:::warning Performance\\n This function may silently performs GetChildren for every invocation, if you are going to be repeatedly getting children, and you know they may not suddenly change, it is better you cache the list and retrieve them yourself.\\n:::",\ "params": \[\ {\ "name": "name",\ "desc": "The instance name",\ "lua\_type": "string"\ }\ \],\ "returns": \[\ {\ "desc": "An instance, which may be null if it was not found.",\ "lua\_type": "Instance?"\ }\ \],\ "function\_type": "method",\ "source": {\ "line": 122,\ "path": "src/instances/instance.luau"\ }\ },\ {\ "name": "FindFirstChildOfClass",\ "desc": "Attempts to find the first child on the instance which matches the given class name.\\n\\n\\n\\n:::warning Performance\\n This function may silently performs GetChildren for every invocation, if you are going to be repeatedly getting children, and you know they may not suddenly change, it is better you cache the list and retrieve them yourself.\\n:::",\ "params": \[\ {\ "name": "className",\ "desc": "The class name of the target instance",\ "lua\_type": "string"\ }\ \],\ "returns": \[\ {\ "desc": "An instance, which may be null if it was not found.",\ "lua\_type": "Instance?"\ }\ \],\ "function\_type": "method",\ "source": {\ "line": 138,\ "path": "src/instances/instance.luau"\ }\ },\ {\ "name": "FindFirstChildWhichIsA",\ "desc": "Attempts to find the first child on the instance whose class matches or inherits from the given class.\\n\\n\\n\\n:::warning Performance\\n This function may silently performs GetChildren for every invocation, if you are going to be repeatedly getting children, and you know they may not suddenly change, it is better you cache the list and retrieve them yourself.\\n:::",\ "params": \[\ {\ "name": "className",\ "desc": "The class name of the target instance",\ "lua\_type": "string"\ }\ \],\ "returns": \[\ {\ "desc": "An instance, which may be null if it was not found.",\ "lua\_type": "Instance?"\ }\ \],\ "function\_type": "method",\ "source": {\ "line": 154,\ "path": "src/instances/instance.luau"\ }\ },\ {\ "name": "GetAttribute",\ "desc": "Attempts to retrieve the attribute with the given name.",\ "params": \[\ {\ "name": "attributeName",\ "desc": "The name of the target attribute.",\ "lua\_type": "string"\ }\ \],\ "returns": \[\ {\ "desc": "The value of the attribute, which may be nil.",\ "lua\_type": "any?"\ }\ \],\ "function\_type": "method",\ "source": {\ "line": 165,\ "path": "src/instances/instance.luau"\ }\ },\ {\ "name": "GetAttributes",\ "desc": "Attempts to retrieve all attributes of the instance.",\ "params": \[\],\ "returns": \[\ {\ "desc": "A dictionary containinig all attributes available with their names as the key.",\ "lua\_type": "{ \[string\]: any? }"\ }\ \],\ "function\_type": "method",\ "source": {\ "line": 175,\ "path": "src/instances/instance.luau"\ }\ }\ \], "properties": \[\ {\ "name": "Name",\ "desc": "Contains the Name of the object.\\n\\n:::warning Readonly Validity\\n This property may be safe to read/write on certain conditions. However this behaviour is not guaranteed by spec.\\n:::",\ "lua\_type": "string",\ "readonly": true,\ "source": {\ "line": 23,\ "path": "src/instances/instance.luau"\ }\ },\ {\ "name": "ClassName",\ "desc": "Contains the ClassName of the object, held in its class descriptor.",\ "lua\_type": "string",\ "readonly": true,\ "source": {\ "line": 32,\ "path": "src/instances/instance.luau"\ }\ },\ {\ "name": "Parent",\ "desc": "The parent of the instance, may be nil.",\ "lua\_type": "instance?",\ "readonly": true,\ "source": {\ "line": 41,\ "path": "src/instances/instance.luau"\ }\ },\ {\ "name": "Address",\ "desc": "The address of the instance in roblox memory.",\ "lua\_type": "number",\ "readonly": true,\ "source": {\ "line": 50,\ "path": "src/instances/instance.luau"\ }\ }\ \], "types": \[\], "name": "Instance", "desc": "Contains methods and fields that are required by the standard in Instance objects. ", "tags": \[\ "Instances"\ \], "source": { "line": 8, "path": "src/instances/instance.luau" } } * [Properties](https://rbxcli.github.io/eUNC/api/Instance#properties) * [Address](https://rbxcli.github.io/eUNC/api/Instance#Address) * [ClassName](https://rbxcli.github.io/eUNC/api/Instance#ClassName) * [Name](https://rbxcli.github.io/eUNC/api/Instance#Name) * [Parent](https://rbxcli.github.io/eUNC/api/Instance#Parent) * [Functions](https://rbxcli.github.io/eUNC/api/Instance#functions) * [:FindFirstChild](https://rbxcli.github.io/eUNC/api/Instance#FindFirstChild) * [:FindFirstChildOfClass](https://rbxcli.github.io/eUNC/api/Instance#FindFirstChildOfClass) * [:FindFirstChildWhichIsA](https://rbxcli.github.io/eUNC/api/Instance#FindFirstChildWhichIsA) * [:GetAttribute](https://rbxcli.github.io/eUNC/api/Instance#GetAttribute) * [:GetAttributes](https://rbxcli.github.io/eUNC/api/Instance#GetAttributes) * [:GetChildren](https://rbxcli.github.io/eUNC/api/Instance#GetChildren) * [:GetDescendants](https://rbxcli.github.io/eUNC/api/Instance#GetDescendants) * [:GetFullName](https://rbxcli.github.io/eUNC/api/Instance#GetFullName) * [:IsA](https://rbxcli.github.io/eUNC/api/Instance#IsA) * [:OfClass](https://rbxcli.github.io/eUNC/api/Instance#OfClass) --- # LuaSourceContainer | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/api/LuaSourceContainer#__docusaurus_skipToContent_fallback) On this page Properties[​](https://rbxcli.github.io/eUNC/api/LuaSourceContainer#properties "Direct link to Properties") ----------------------------------------------------------------------------------------------------------- ### `Bytecode`[​](https://rbxcli.github.io/eUNC/api/LuaSourceContainer#Bytecode "Direct link to Bytecode") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/luasourcecontainer.luau#L24) `LuaSourceContainer.Bytecode:` `buffer` Contains the luau bytecode of the script, can be used with a decompiler. ##### Readonly Validity This property may be safe to read/write on certain conditions. ### `RawBytecode`[​](https://rbxcli.github.io/eUNC/api/LuaSourceContainer#RawBytecode "Direct link to RawBytecode") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/luasourcecontainer.luau#L37) `LuaSourceContainer.RawBytecode:` `buffer` Contains the raw, compressed and encrypted bytecode of the script. ##### Readonly Validity This property may be safe to read/write on certain conditions. ### `BytecodeAvailable`[​](https://rbxcli.github.io/eUNC/api/LuaSourceContainer#BytecodeAvailable "Direct link to BytecodeAvailable") This item is read only and cannot be modified. Read Only [](https://github.com/RbxCli/eUNC/blob/dev/src/instances/luasourcecontainer.luau#L46) `LuaSourceContainer.BytecodeAvailable:` `bool` Whether the script contains luau bytecode. Show raw api { "functions": \[\], "properties": \[\ {\ "name": "Bytecode",\ "desc": "Contains the luau bytecode of the script, can be used with a decompiler.\\n\\n:::warning Readonly Validity\\n This property may be safe to read/write on certain conditions.\\n:::",\ "lua\_type": "buffer",\ "readonly": true,\ "source": {\ "line": 24,\ "path": "src/instances/luasourcecontainer.luau"\ }\ },\ {\ "name": "RawBytecode",\ "desc": "Contains the raw, compressed and encrypted bytecode of the script.\\n\\n:::warning Readonly Validity\\n This property may be safe to read/write on certain conditions.\\n:::",\ "lua\_type": "buffer",\ "readonly": true,\ "source": {\ "line": 37,\ "path": "src/instances/luasourcecontainer.luau"\ }\ },\ {\ "name": "BytecodeAvailable",\ "desc": "Whether the script contains luau bytecode.",\ "lua\_type": "bool",\ "readonly": true,\ "source": {\ "line": 46,\ "path": "src/instances/luasourcecontainer.luau"\ }\ }\ \], "types": \[\], "name": "LuaSourceContainer", "desc": "Contains methods and fields that are required by the standard in LuaSourceContainer objects.\\n\\nThis class inherits from the Instance class.", "tags": \[\ "Instances"\ \], "source": { "line": 11, "path": "src/instances/luasourcecontainer.luau" } } * [Properties](https://rbxcli.github.io/eUNC/api/LuaSourceContainer#properties) * [Bytecode](https://rbxcli.github.io/eUNC/api/LuaSourceContainer#Bytecode) * [BytecodeAvailable](https://rbxcli.github.io/eUNC/api/LuaSourceContainer#BytecodeAvailable) * [RawBytecode](https://rbxcli.github.io/eUNC/api/LuaSourceContainer#RawBytecode) --- # Yielding | RbxCli [Skip to main content](https://rbxcli.github.io/eUNC/docs/Luau%20VM/yielding#__docusaurus_skipToContent_fallback) Unlike other tools, RbxCli contains numerous APIs which yield. These APIs will be marked yieldable. This is important, as some Luau functionality isn't compatible with yielding functions (Such as metamethods, as attempting to yield inside of one except for `__namecall` results in an error). These APIs which yield will be marked, and if needed, can be avoided. ---