Gui

Build on-screen interfaces for spectator cameras.

Icon

Namespace

Fields

Property	Type	Description
`Ad`	`string`
`AddressBook`	`string`
`AddressCard`	`string`
`Adjust`	`string`
`AirFreshener`	`string`
`AlignCenter`	`string`
`AlignJustify`	`string`
`AlignLeft`	`string`
`AlignRight`	`string`
`Allergies`	`string`
`Ambulance`	`string`
`AmericanSignLanguageInterpreting`	`string`
`Anchor`	`string`
`AngleDoubleDown`	`string`
`AngleDoubleLeft`	`string`
`AngleDoubleRight`	`string`
`AngleDoubleUp`	`string`
`AngleDown`	`string`
`AngleLeft`	`string`
`AngleRight`	`string`
`AngleUp`	`string`
`Angry`	`string`
`Ankh`	`string`
`AppleAlt`	`string`
`Archive`	`string`
`Archway`	`string`
`ArrowAltCircleDown`	`string`
`ArrowAltCircleLeft`	`string`
`ArrowAltCircleRight`	`string`
`ArrowAltCircleUp`	`string`
`ArrowCircleDown`	`string`
`ArrowCircleLeft`	`string`
`ArrowCircleRight`	`string`
`ArrowCircleUp`	`string`
`ArrowDown`	`string`
`ArrowLeft`	`string`
`ArrowRight`	`string`
`ArrowUp`	`string`
`ArrowsAlt`	`string`
`ArrowsAltH`	`string`
`ArrowsAltV`	`string`
`AssistiveListeningSystems`	`string`
`Asterisk`	`string`
`At`	`string`
`Atlas`	`string`
`Atom`	`string`
`AudioDescription`	`string`
`Award`	`string`
`Baby`	`string`
`BabyCarriage`	`string`
`Backspace`	`string`
`Backward`	`string`
`Bacon`	`string`
`Bacteria`	`string`
`Bacterium`	`string`
`Bahai`	`string`
`BalanceScale`	`string`
`BalanceScaleLeft`	`string`
`BalanceScaleRight`	`string`
`Ban`	`string`
`BandAid`	`string`
`Barcode`	`string`
`Bars`	`string`
`BaseballBall`	`string`
`BasketballBall`	`string`
`Bath`	`string`
`BatteryEmpty`	`string`
`BatteryFull`	`string`
`BatteryHalf`	`string`
`BatteryQuarter`	`string`
`BatteryThreeQuarters`	`string`
`Bed`	`string`
`Beer`	`string`
`Bell`	`string`
`BellSlash`	`string`
`BezierCurve`	`string`
`Bible`	`string`
`Bicycle`	`string`
`Biking`	`string`
`Binoculars`	`string`
`Biohazard`	`string`
`BirthdayCake`	`string`
`Blender`	`string`
`BlenderPhone`	`string`
`Blind`	`string`
`Blog`	`string`
`Bold`	`string`
`Bolt`	`string`
`Bomb`	`string`
`Bone`	`string`
`Bong`	`string`
`Book`	`string`
`BookDead`	`string`
`BookMedical`	`string`
`BookOpen`	`string`
`BookReader`	`string`
`Bookmark`	`string`
`BorderAll`	`string`
`BorderNone`	`string`
`BorderStyle`	`string`
`BowlingBall`	`string`
`Box`	`string`
`BoxOpen`	`string`
`BoxTissue`	`string`
`Boxes`	`string`
`Braille`	`string`
`Brain`	`string`
`BreadSlice`	`string`
`Briefcase`	`string`
`BriefcaseMedical`	`string`
`BroadcastTower`	`string`
`Broom`	`string`
`Brush`	`string`
`Bug`	`string`
`Building`	`string`
`Bullhorn`	`string`
`Bullseye`	`string`
`Burn`	`string`
`Bus`	`string`
`BusAlt`	`string`
`BusinessTime`	`string`
`Calculator`	`string`
`Calendar`	`string`
`CalendarAlt`	`string`
`CalendarCheck`	`string`
`CalendarDay`	`string`
`CalendarMinus`	`string`
`CalendarPlus`	`string`
`CalendarTimes`	`string`
`CalendarWeek`	`string`
`Camera`	`string`
`CameraRetro`	`string`
`Campground`	`string`
`CandyCane`	`string`
`Capsules`	`string`
`Car`	`string`
`CarAlt`	`string`
`CarBattery`	`string`
`CarCrash`	`string`
`CarSide`	`string`
`Caravan`	`string`
`CaretDown`	`string`
`CaretLeft`	`string`
`CaretRight`	`string`
`CaretSquareDown`	`string`
`CaretSquareLeft`	`string`
`CaretSquareRight`	`string`
`CaretSquareUp`	`string`
`CaretUp`	`string`
`Carrot`	`string`
`CartArrowDown`	`string`
`CartPlus`	`string`
`CashRegister`	`string`
`Cat`	`string`
`Certificate`	`string`
`Chair`	`string`
`Chalkboard`	`string`
`ChalkboardTeacher`	`string`
`ChargingStation`	`string`
`ChartArea`	`string`
`ChartBar`	`string`
`ChartLine`	`string`
`ChartPie`	`string`
`Check`	`string`
`CheckCircle`	`string`
`CheckDouble`	`string`
`CheckSquare`	`string`
`Cheese`	`string`
`Chess`	`string`
`ChessBishop`	`string`
`ChessBoard`	`string`
`ChessKing`	`string`
`ChessKnight`	`string`
`ChessPawn`	`string`
`ChessQueen`	`string`
`ChessRook`	`string`
`ChevronCircleDown`	`string`
`ChevronCircleLeft`	`string`
`ChevronCircleRight`	`string`
`ChevronCircleUp`	`string`
`ChevronDown`	`string`
`ChevronLeft`	`string`
`ChevronRight`	`string`
`ChevronUp`	`string`
`Child`	`string`
`Church`	`string`
`Circle`	`string`
`CircleNotch`	`string`
`City`	`string`
`ClinicMedical`	`string`
`Clipboard`	`string`
`ClipboardCheck`	`string`
`ClipboardList`	`string`
`Clock`	`string`
`Clone`	`string`
`ClosedCaptioning`	`string`
`Cloud`	`string`
`CloudDownloadAlt`	`string`
`CloudMeatball`	`string`
`CloudMoon`	`string`
`CloudMoonRain`	`string`
`CloudRain`	`string`
`CloudShowersHeavy`	`string`
`CloudSun`	`string`
`CloudSunRain`	`string`
`CloudUploadAlt`	`string`
`Cocktail`	`string`
`Code`	`string`
`CodeBranch`	`string`
`Coffee`	`string`
`Cog`	`string`
`Cogs`	`string`
`Coins`	`string`
`Columns`	`string`
`Comment`	`string`
`CommentAlt`	`string`
`CommentDollar`	`string`
`CommentDots`	`string`
`CommentMedical`	`string`
`CommentSlash`	`string`
`Comments`	`string`
`CommentsDollar`	`string`
`CompactDisc`	`string`
`Compass`	`string`
`Compress`	`string`
`CompressAlt`	`string`
`CompressArrowsAlt`	`string`
`ConciergeBell`	`string`
`Cookie`	`string`
`CookieBite`	`string`
`Copy`	`string`
`Copyright`	`string`
`Couch`	`string`
`CreditCard`	`string`
`Crop`	`string`
`CropAlt`	`string`
`Cross`	`string`
`Crosshairs`	`string`
`Crow`	`string`
`Crown`	`string`
`Crutch`	`string`
`Cube`	`string`
`Cubes`	`string`
`Cut`	`string`
`Database`	`string`
`Deaf`	`string`
`Desktop`	`string`
`Dharmachakra`	`string`
`Diagnoses`	`string`
`Dice`	`string`
`DiceD20`	`string`
`DiceD6`	`string`
`DiceFive`	`string`
`DiceFour`	`string`
`DiceOne`	`string`
`DiceSix`	`string`
`DiceThree`	`string`
`DiceTwo`	`string`
`DigitalTachograph`	`string`
`Directions`	`string`
`Disease`	`string`
`Divide`	`string`
`Dizzy`	`string`
`Dna`	`string`
`Dog`	`string`
`DollarSign`	`string`
`Dolly`	`string`
`DollyFlatbed`	`string`
`Donate`	`string`
`DoorClosed`	`string`
`DoorOpen`	`string`
`DotCircle`	`string`
`Dove`	`string`
`Download`	`string`
`DraftingCompass`	`string`
`Dragon`	`string`
`DrawPolygon`	`string`
`Drum`	`string`
`DrumSteelpan`	`string`
`DrumstickBite`	`string`
`Dumbbell`	`string`
`Dumpster`	`string`
`DumpsterFire`	`string`
`Dungeon`	`string`
`Edit`	`string`
`Egg`	`string`
`Eject`	`string`
`EllipsisH`	`string`
`EllipsisV`	`string`
`Envelope`	`string`
`EnvelopeOpen`	`string`
`EnvelopeOpenText`	`string`
`EnvelopeSquare`	`string`
`Equals`	`string`
`Eraser`	`string`
`Ethernet`	`string`
`EuroSign`	`string`
`ExchangeAlt`	`string`
`Exclamation`	`string`
`ExclamationCircle`	`string`
`ExclamationTriangle`	`string`
`Expand`	`string`
`ExpandAlt`	`string`
`ExpandArrowsAlt`	`string`
`ExternalLinkAlt`	`string`
`ExternalLinkSquareAlt`	`string`
`Eye`	`string`
`EyeDropper`	`string`
`EyeSlash`	`string`
`Fan`	`string`
`FastBackward`	`string`
`FastForward`	`string`
`Faucet`	`string`
`Fax`	`string`
`Feather`	`string`
`FeatherAlt`	`string`
`Female`	`string`
`FighterJet`	`string`
`File`	`string`
`FileAlt`	`string`
`FileArchive`	`string`
`FileAudio`	`string`
`FileCode`	`string`
`FileContract`	`string`
`FileCsv`	`string`
`FileDownload`	`string`
`FileExcel`	`string`
`FileExport`	`string`
`FileImage`	`string`
`FileImport`	`string`
`FileInvoice`	`string`
`FileInvoiceDollar`	`string`
`FileMedical`	`string`
`FileMedicalAlt`	`string`
`FilePdf`	`string`
`FilePowerpoint`	`string`
`FilePrescription`	`string`
`FileSignature`	`string`
`FileUpload`	`string`
`FileVideo`	`string`
`FileWord`	`string`
`Fill`	`string`
`FillDrip`	`string`
`Film`	`string`
`Filter`	`string`
`Fingerprint`	`string`
`Fire`	`string`
`FireAlt`	`string`
`FireExtinguisher`	`string`
`FirstAid`	`string`
`Fish`	`string`
`FistRaised`	`string`
`Flag`	`string`
`FlagCheckered`	`string`
`FlagUsa`	`string`
`Flask`	`string`
`Flushed`	`string`
`Folder`	`string`
`FolderMinus`	`string`
`FolderOpen`	`string`
`FolderPlus`	`string`
`Font`	`string`
`FootballBall`	`string`
`Forward`	`string`
`Frog`	`string`
`Frown`	`string`
`FrownOpen`	`string`
`FunnelDollar`	`string`
`Futbol`	`string`
`Gamepad`	`string`
`GasPump`	`string`
`Gavel`	`string`
`Gem`	`string`
`Genderless`	`string`
`Ghost`	`string`
`Gift`	`string`
`Gifts`	`string`
`GlassCheers`	`string`
`GlassMartini`	`string`
`GlassMartiniAlt`	`string`
`GlassWhiskey`	`string`
`Glasses`	`string`
`Globe`	`string`
`GlobeAfrica`	`string`
`GlobeAmericas`	`string`
`GlobeAsia`	`string`
`GlobeEurope`	`string`
`GolfBall`	`string`
`Gopuram`	`string`
`GraduationCap`	`string`
`GreaterThan`	`string`
`GreaterThanEqual`	`string`
`Grimace`	`string`
`Grin`	`string`
`GrinAlt`	`string`
`GrinBeam`	`string`
`GrinBeamSweat`	`string`
`GrinHearts`	`string`
`GrinSquint`	`string`
`GrinSquintTears`	`string`
`GrinStars`	`string`
`GrinTears`	`string`
`GrinTongue`	`string`
`GrinTongueSquint`	`string`
`GrinTongueWink`	`string`
`GrinWink`	`string`
`GripHorizontal`	`string`
`GripLines`	`string`
`GripLinesVertical`	`string`
`GripVertical`	`string`
`Guitar`	`string`
`HSquare`	`string`
`Hamburger`	`string`
`Hammer`	`string`
`Hamsa`	`string`
`HandHolding`	`string`
`HandHoldingHeart`	`string`
`HandHoldingMedical`	`string`
`HandHoldingUsd`	`string`
`HandHoldingWater`	`string`
`HandLizard`	`string`
`HandMiddleFinger`	`string`
`HandPaper`	`string`
`HandPeace`	`string`
`HandPointDown`	`string`
`HandPointLeft`	`string`
`HandPointRight`	`string`
`HandPointUp`	`string`
`HandPointer`	`string`
`HandRock`	`string`
`HandScissors`	`string`
`HandSparkles`	`string`
`HandSpock`	`string`
`Hands`	`string`
`HandsHelping`	`string`
`HandsWash`	`string`
`Handshake`	`string`
`HandshakeAltSlash`	`string`
`HandshakeSlash`	`string`
`Hanukiah`	`string`
`HardHat`	`string`
`Hashtag`	`string`
`HatCowboy`	`string`
`HatCowboySide`	`string`
`HatWizard`	`string`
`Hdd`	`string`
`HeadSideCough`	`string`
`HeadSideCoughSlash`	`string`
`HeadSideMask`	`string`
`HeadSideVirus`	`string`
`Heading`	`string`
`Headphones`	`string`
`HeadphonesAlt`	`string`
`Headset`	`string`
`Heart`	`string`
`HeartBroken`	`string`
`Heartbeat`	`string`
`Helicopter`	`string`
`Highlighter`	`string`
`Hiking`	`string`
`Hippo`	`string`
`History`	`string`
`HockeyPuck`	`string`
`HollyBerry`	`string`
`Home`	`string`
`Horse`	`string`
`HorseHead`	`string`
`Hospital`	`string`
`HospitalAlt`	`string`
`HospitalSymbol`	`string`
`HospitalUser`	`string`
`HotTub`	`string`
`Hotdog`	`string`
`Hotel`	`string`
`Hourglass`	`string`
`HourglassEnd`	`string`
`HourglassHalf`	`string`
`HourglassStart`	`string`
`HouseDamage`	`string`
`HouseUser`	`string`
`Hryvnia`	`string`
`ICursor`	`string`
`IceCream`	`string`
`Icicles`	`string`
`Icons`	`string`
`IdBadge`	`string`
`IdCard`	`string`
`IdCardAlt`	`string`
`Igloo`	`string`
`Image`	`string`
`Images`	`string`
`Inbox`	`string`
`Indent`	`string`
`Industry`	`string`
`Infinity`	`string`
`Info`	`string`
`InfoCircle`	`string`
`Italic`	`string`
`Jedi`	`string`
`Joint`	`string`
`JournalWhills`	`string`
`Kaaba`	`string`
`Key`	`string`
`Keyboard`	`string`
`Khanda`	`string`
`Kiss`	`string`
`KissBeam`	`string`
`KissWinkHeart`	`string`
`KiwiBird`	`string`
`Landmark`	`string`
`Language`	`string`
`Laptop`	`string`
`LaptopCode`	`string`
`LaptopHouse`	`string`
`LaptopMedical`	`string`
`Laugh`	`string`
`LaughBeam`	`string`
`LaughSquint`	`string`
`LaughWink`	`string`
`LayerGroup`	`string`
`Leaf`	`string`
`Lemon`	`string`
`LessThan`	`string`
`LessThanEqual`	`string`
`LevelDownAlt`	`string`
`LevelUpAlt`	`string`
`LifeRing`	`string`
`Lightbulb`	`string`
`Link`	`string`
`LiraSign`	`string`
`List`	`string`
`ListAlt`	`string`
`ListOl`	`string`
`ListUl`	`string`
`LocationArrow`	`string`
`Lock`	`string`
`LockOpen`	`string`
`LongArrowAltDown`	`string`
`LongArrowAltLeft`	`string`
`LongArrowAltRight`	`string`
`LongArrowAltUp`	`string`
`LowVision`	`string`
`LuggageCart`	`string`
`Lungs`	`string`
`LungsVirus`	`string`
`Magic`	`string`
`Magnet`	`string`
`MailBulk`	`string`
`Male`	`string`
`Map`	`string`
`MapMarked`	`string`
`MapMarkedAlt`	`string`
`MapMarker`	`string`
`MapMarkerAlt`	`string`
`MapPin`	`string`
`MapSigns`	`string`
`Marker`	`string`
`Mars`	`string`
`MarsDouble`	`string`
`MarsStroke`	`string`
`MarsStrokeH`	`string`
`MarsStrokeV`	`string`
`Mask`	`string`
`Medal`	`string`
`Medkit`	`string`
`Meh`	`string`
`MehBlank`	`string`
`MehRollingEyes`	`string`
`Memory`	`string`
`Menorah`	`string`
`Mercury`	`string`
`Meteor`	`string`
`Microchip`	`string`
`Microphone`	`string`
`MicrophoneAlt`	`string`
`MicrophoneAltSlash`	`string`
`MicrophoneSlash`	`string`
`Microscope`	`string`
`Minus`	`string`
`MinusCircle`	`string`
`MinusSquare`	`string`
`Mitten`	`string`
`Mobile`	`string`
`MobileAlt`	`string`
`MoneyBill`	`string`
`MoneyBillAlt`	`string`
`MoneyBillWave`	`string`
`MoneyBillWaveAlt`	`string`
`MoneyCheck`	`string`
`MoneyCheckAlt`	`string`
`Monument`	`string`
`Moon`	`string`
`MortarPestle`	`string`
`Mosque`	`string`
`Motorcycle`	`string`
`Mountain`	`string`
`Mouse`	`string`
`MousePointer`	`string`
`MugHot`	`string`
`Music`	`string`
`NetworkWired`	`string`
`Neuter`	`string`
`Newspaper`	`string`
`NotEqual`	`string`
`NotesMedical`	`string`
`ObjectGroup`	`string`
`ObjectUngroup`	`string`
`OilCan`	`string`
`Om`	`string`
`Otter`	`string`
`Outdent`	`string`
`Pager`	`string`
`PaintBrush`	`string`
`PaintRoller`	`string`
`Palette`	`string`
`Pallet`	`string`
`PaperPlane`	`string`
`Paperclip`	`string`
`ParachuteBox`	`string`
`Paragraph`	`string`
`Parking`	`string`
`Passport`	`string`
`Pastafarianism`	`string`
`Paste`	`string`
`Pause`	`string`
`PauseCircle`	`string`
`Paw`	`string`
`Peace`	`string`
`Pen`	`string`
`PenAlt`	`string`
`PenFancy`	`string`
`PenNib`	`string`
`PenSquare`	`string`
`PencilAlt`	`string`
`PencilRuler`	`string`
`PeopleArrows`	`string`
`PeopleCarry`	`string`
`PepperHot`	`string`
`Percent`	`string`
`Percentage`	`string`
`PersonBooth`	`string`
`Phone`	`string`
`PhoneAlt`	`string`
`PhoneSlash`	`string`
`PhoneSquare`	`string`
`PhoneSquareAlt`	`string`
`PhoneVolume`	`string`
`PhotoVideo`	`string`
`PiggyBank`	`string`
`Pills`	`string`
`PizzaSlice`	`string`
`PlaceOfWorship`	`string`
`Plane`	`string`
`PlaneArrival`	`string`
`PlaneDeparture`	`string`
`PlaneSlash`	`string`
`Play`	`string`
`PlayCircle`	`string`
`Plug`	`string`
`Plus`	`string`
`PlusCircle`	`string`
`PlusSquare`	`string`
`Podcast`	`string`
`Poll`	`string`
`PollH`	`string`
`Poo`	`string`
`PooStorm`	`string`
`Poop`	`string`
`Portrait`	`string`
`PoundSign`	`string`
`PowerOff`	`string`
`Pray`	`string`
`PrayingHands`	`string`
`Prescription`	`string`
`PrescriptionBottle`	`string`
`PrescriptionBottleAlt`	`string`
`Print`	`string`
`Procedures`	`string`
`ProjectDiagram`	`string`
`PumpMedical`	`string`
`PumpSoap`	`string`
`PuzzlePiece`	`string`
`Qrcode`	`string`
`Question`	`string`
`QuestionCircle`	`string`
`Quidditch`	`string`
`QuoteLeft`	`string`
`QuoteRight`	`string`
`Quran`	`string`
`Radiation`	`string`
`RadiationAlt`	`string`
`Rainbow`	`string`
`Random`	`string`
`Receipt`	`string`
`RecordVinyl`	`string`
`Recycle`	`string`
`Redo`	`string`
`RedoAlt`	`string`
`Registered`	`string`
`RemoveFormat`	`string`
`Reply`	`string`
`ReplyAll`	`string`
`Restroom`	`string`
`Retweet`	`string`
`Ribbon`	`string`
`Ring`	`string`
`Road`	`string`
`Robot`	`string`
`Rocket`	`string`
`Route`	`string`
`Rss`	`string`
`RssSquare`	`string`
`RubleSign`	`string`
`Ruler`	`string`
`RulerCombined`	`string`
`RulerHorizontal`	`string`
`RulerVertical`	`string`
`Running`	`string`
`RupeeSign`	`string`
`SadCry`	`string`
`SadTear`	`string`
`Satellite`	`string`
`SatelliteDish`	`string`
`Save`	`string`
`School`	`string`
`Screwdriver`	`string`
`Scroll`	`string`
`SdCard`	`string`
`Search`	`string`
`SearchDollar`	`string`
`SearchLocation`	`string`
`SearchMinus`	`string`
`SearchPlus`	`string`
`Seedling`	`string`
`Server`	`string`
`Shapes`	`string`
`Share`	`string`
`ShareAlt`	`string`
`ShareAltSquare`	`string`
`ShareSquare`	`string`
`ShekelSign`	`string`
`ShieldAlt`	`string`
`ShieldVirus`	`string`
`Ship`	`string`
`ShippingFast`	`string`
`ShoePrints`	`string`
`ShoppingBag`	`string`
`ShoppingBasket`	`string`
`ShoppingCart`	`string`
`Shower`	`string`
`ShuttleVan`	`string`
`Sign`	`string`
`SignInAlt`	`string`
`SignLanguage`	`string`
`SignOutAlt`	`string`
`Signal`	`string`
`Signature`	`string`
`SimCard`	`string`
`Sink`	`string`
`Sitemap`	`string`
`Skating`	`string`
`Skiing`	`string`
`SkiingNordic`	`string`
`Skull`	`string`
`SkullCrossbones`	`string`
`Slash`	`string`
`Sleigh`	`string`
`SlidersH`	`string`
`Smile`	`string`
`SmileBeam`	`string`
`SmileWink`	`string`
`Smog`	`string`
`Smoking`	`string`
`SmokingBan`	`string`
`Sms`	`string`
`Snowboarding`	`string`
`Snowflake`	`string`
`Snowman`	`string`
`Snowplow`	`string`
`Soap`	`string`
`Socks`	`string`
`SolarPanel`	`string`
`Sort`	`string`
`SortAlphaDown`	`string`
`SortAlphaDownAlt`	`string`
`SortAlphaUp`	`string`
`SortAlphaUpAlt`	`string`
`SortAmountDown`	`string`
`SortAmountDownAlt`	`string`
`SortAmountUp`	`string`
`SortAmountUpAlt`	`string`
`SortDown`	`string`
`SortNumericDown`	`string`
`SortNumericDownAlt`	`string`
`SortNumericUp`	`string`
`SortNumericUpAlt`	`string`
`SortUp`	`string`
`Spa`	`string`
`SpaceShuttle`	`string`
`SpellCheck`	`string`
`Spider`	`string`
`Spinner`	`string`
`Splotch`	`string`
`SprayCan`	`string`
`Square`	`string`
`SquareFull`	`string`
`SquareRootAlt`	`string`
`Stamp`	`string`
`Star`	`string`
`StarAndCrescent`	`string`
`StarHalf`	`string`
`StarHalfAlt`	`string`
`StarOfDavid`	`string`
`StarOfLife`	`string`
`StepBackward`	`string`
`StepForward`	`string`
`Stethoscope`	`string`
`StickyNote`	`string`
`Stop`	`string`
`StopCircle`	`string`
`Stopwatch`	`string`
`Stopwatch20`	`string`
`Store`	`string`
`StoreAlt`	`string`
`StoreAltSlash`	`string`
`StoreSlash`	`string`
`Stream`	`string`
`StreetView`	`string`
`Strikethrough`	`string`
`Stroopwafel`	`string`
`Subscript`	`string`
`Subway`	`string`
`Suitcase`	`string`
`SuitcaseRolling`	`string`
`Sun`	`string`
`Superscript`	`string`
`Surprise`	`string`
`Swatchbook`	`string`
`Swimmer`	`string`
`SwimmingPool`	`string`
`Synagogue`	`string`
`Sync`	`string`
`SyncAlt`	`string`
`Syringe`	`string`
`Table`	`string`
`TableTennis`	`string`
`Tablet`	`string`
`TabletAlt`	`string`
`Tablets`	`string`
`TachometerAlt`	`string`
`Tag`	`string`
`Tags`	`string`
`Tape`	`string`
`Tasks`	`string`
`Taxi`	`string`
`Teeth`	`string`
`TeethOpen`	`string`
`TemperatureHigh`	`string`
`TemperatureLow`	`string`
`Tenge`	`string`
`Terminal`	`string`
`TextHeight`	`string`
`TextWidth`	`string`
`Th`	`string`
`ThLarge`	`string`
`ThList`	`string`
`TheaterMasks`	`string`
`Thermometer`	`string`
`ThermometerEmpty`	`string`
`ThermometerFull`	`string`
`ThermometerHalf`	`string`
`ThermometerQuarter`	`string`
`ThermometerThreeQuarters`	`string`
`ThumbsDown`	`string`
`ThumbsUp`	`string`
`Thumbtack`	`string`
`TicketAlt`	`string`
`Times`	`string`
`TimesCircle`	`string`
`Tint`	`string`
`TintSlash`	`string`
`Tired`	`string`
`ToggleOff`	`string`
`ToggleOn`	`string`
`Toilet`	`string`
`ToiletPaper`	`string`
`ToiletPaperSlash`	`string`
`Toolbox`	`string`
`Tools`	`string`
`Tooth`	`string`
`Torah`	`string`
`ToriiGate`	`string`
`Tractor`	`string`
`Trademark`	`string`
`TrafficLight`	`string`
`Trailer`	`string`
`Train`	`string`
`Tram`	`string`
`Transgender`	`string`
`TransgenderAlt`	`string`
`Trash`	`string`
`TrashAlt`	`string`
`TrashRestore`	`string`
`TrashRestoreAlt`	`string`
`Tree`	`string`
`Trophy`	`string`
`Truck`	`string`
`TruckLoading`	`string`
`TruckMonster`	`string`
`TruckMoving`	`string`
`TruckPickup`	`string`
`Tshirt`	`string`
`Tty`	`string`
`Tv`	`string`
`Umbrella`	`string`
`UmbrellaBeach`	`string`
`Underline`	`string`
`Undo`	`string`
`UndoAlt`	`string`
`UniversalAccess`	`string`
`University`	`string`
`Unlink`	`string`
`Unlock`	`string`
`UnlockAlt`	`string`
`Upload`	`string`
`User`	`string`
`UserAlt`	`string`
`UserAltSlash`	`string`
`UserAstronaut`	`string`
`UserCheck`	`string`
`UserCircle`	`string`
`UserClock`	`string`
`UserCog`	`string`
`UserEdit`	`string`
`UserFriends`	`string`
`UserGraduate`	`string`
`UserInjured`	`string`
`UserLock`	`string`
`UserMd`	`string`
`UserMinus`	`string`
`UserNinja`	`string`
`UserNurse`	`string`
`UserPlus`	`string`
`UserSecret`	`string`
`UserShield`	`string`
`UserSlash`	`string`
`UserTag`	`string`
`UserTie`	`string`
`UserTimes`	`string`
`Users`	`string`
`UsersCog`	`string`
`UsersSlash`	`string`
`UtensilSpoon`	`string`
`Utensils`	`string`
`VectorSquare`	`string`
`Venus`	`string`
`VenusDouble`	`string`
`VenusMars`	`string`
`Vest`	`string`
`VestPatches`	`string`
`Vial`	`string`
`Vials`	`string`
`Video`	`string`
`VideoSlash`	`string`
`Vihara`	`string`
`Virus`	`string`
`VirusSlash`	`string`
`Viruses`	`string`
`Voicemail`	`string`
`VolleyballBall`	`string`
`VolumeDown`	`string`
`VolumeMute`	`string`
`VolumeOff`	`string`
`VolumeUp`	`string`
`VoteYea`	`string`
`VrCardboard`	`string`
`Walking`	`string`
`Wallet`	`string`
`Warehouse`	`string`
`Water`	`string`
`WaveSquare`	`string`
`Weight`	`string`
`WeightHanging`	`string`
`Wheelchair`	`string`
`Wifi`	`string`
`Wind`	`string`
`WindowClose`	`string`
`WindowMaximize`	`string`
`WindowMinimize`	`string`
`WindowRestore`	`string`
`WineBottle`	`string`
`WineGlass`	`string`
`WineGlassAlt`	`string`
`Wrench`	`string`
`XRay`	`string`
`YinYang`	`string`

TextJustify

Class · inherits from EnumItem

Gui

Class

Luau Gui

Static functions

Method	Description
`vSliderInt`	Creates a vertical integer slider.
`vSliderFloat`	Creates a vertical floating-point slider.
`unindent`	Unindents the drawing cursor, moving subsequent elements to the left.
`treePop`	Pops the current tree node, ending the indented section. Must be called after TreeNode if it returned true.
`treeNode`	Creates a tree node, often used for hierarchical data.
`timeline`	A float slider with time labels and custom stand and end times
`textWrapped`	Displays text that wraps to the next line at the edge of the window/region.
`textDisabled`	Displays text using the greyed-out "disabled" color.
`textColored`	Displays text in the given color.
`text`	Displays static text
`tableSetupColumn`	Sets up the properties for the next column in a table.
`tableNextRow`	Advances to the next row in a table.
`tableNextColumn`	Advances to the next column in the current table row.
`tableHeadersRow`	Renders the header row for a table.
`spacing`	Adds a small vertical space.
`smallButton`	Button with (FramePadding.y == 0) to easily embed within text
`sliderInt`	Creates an integer slider.
`sliderFloat4`	Creates a slider for a 4-component vector (e.g., Quaternion).
`sliderFloat3`	Creates a slider for a 3D vector.
`sliderFloat2`	Creates a slider for a 2D vector.
`sliderFloat`	Creates a floating-point slider.
`setNextItemWidth`	Sets the width of the next widget, in pixels. Negative values align the widget's right edge that many pixels from the right of the window (-1 spans the available width).
`setItemTooltip`	Sets a simple tooltip for the last rendered item.
`setItemDefaultFocus`	Sets the last rendered item to be the default focus when its window is first opened.
`separatorText`	Displays a text label centered within a horizontal separator line.
`separator`	Draws a horizontal line to visually separate GUI elements.
`selectable`	Creates a selectable item, often used within combo boxes or lists.
`sameLine`	Call between widgets or groups to layout them horizontally.
`rangeSlider`	Creates a slider that allows selecting a range (min and max) within a given overall range.
`pushId`	Pushes a unique ID onto the ID stack. Essential for widgets with same labels in loops.
`popId`	Pops an ID from the ID stack. Must be called after PushId.
`newLine`	Inserts a vertical space.
`keyframeRowSelectedKeyframes`	Returns the indices of the currently selected keyframes in a keyframe row.
`keyframeRowIsDragging`	Returns true if a keyframe row is currently being dragged.
`keyframeRow`	A horizontal row with points that hold a position and value
`isItemHovered`	Returns true if the last rendered item is hovered by the mouse.
`isItemDeactivated`	Returns true on the frame an item is deactivated (e.g., mouse button released).
`isItemActive`	Returns true if the last rendered item is currently active (e.g., being dragged).
`isItemActivated`	Returns true on the frame an item is activated (e.g., mouse button pressed down).
`inputText`	Creates a text input field.
`indent`	Indents the drawing cursor, pushing subsequent elements to the right.
`graphEditor`	A bezier spline editor
`endVertical`	Ends a vertical layout group. (Likely a custom ImGui extension).
`endTooltip`	Ends a tooltip window. Must be called if BeginTooltip was called.
`endTable`	Ends a table. Must be called if BeginTable returned true.
`endTabItem`	Ends a tab item. Must be called only if BeginTabItem returned true.
`endTabBar`	Ends a tab bar. Must be called only if BeginTabBar returned true.
`endListBox`	Ends a list box. Must be called if BeginListBox returned true.
`endHorizontal`	Ends a horizontal layout group. (Likely a custom ImGui extension).
`endGroup`	Ends a layout group.
`endDisabled`	Ends a disabled block.
`endCombo`	Ends a combo box. Must be called if BeginCombo returned true.
`endChild`	Ends a child region. Must always be called after BeginChild, even if it returned false.
`dragInt`	Creates a draggable integer input field.
`dragFloat4`	Creates a draggable input for a 4-component vector (e.g., Quaternion).
`dragFloat3`	Creates a draggable input for a 3D vector.
`dragFloat2`	Creates a draggable input for a 2D vector.
`dragFloat`	Creates a draggable floating-point input field.
`colorPicker`	Creates a full, always-expanded color picker.
`colorEdit`	Creates a compact color swatch with RGBA fields. Clicking the swatch opens a color picker popup.
`collapsingHeader`	If returning 'true' the header is open. Doesn't indent nor push on ID stack. User doesn't have to call TreePop().
`checkbox`	Creates a checkbox.
`buttonColored`	Creates a button drawn in the given color.
`button`	Creates a button.
`bulletText`	Displays text prefixed with a bullet point.
`beginVertical`	Starts a vertical layout group. (Likely a custom ImGui extension).
`beginTooltip`	Begins a tooltip window. Must be called after the item you want to attach the tooltip to.
`beginTable`	Begins a table.
`beginTabItem`	Begins a tab item within a tab bar.
`beginTabBar`	Begins a tab bar. Tab items created between this and EndTabBar appear as tabs.
`beginListBox`	Begins a scrollable list box.
`beginHorizontal`	Starts a horizontal layout group. (Likely a custom ImGui extension).
`beginGroup`	Begins a layout group. Widgets between this and EndGroup are treated as a single item for layout (e.g. SameLine) and bounding-box purposes.
`beginDisabled`	Starts a disabled block. All subsequent widgets will be grayed out and non-interactive.
`beginCombo`	Starts a combo box.
`beginChild`	Begins a scrollable/clipped child region inside the current window. This is NOT a separate window. A size component of 0 fills the available space on that axis.

vSliderInt

Gui.vSliderInt(Label: string, Height: number, InputInt: number, Min: number, Max: number) -> number

Creates a vertical integer slider.

Parameters

Name	Type	Description
`Label`	`string`	The label for the slider.
`Height`	`number`	The desired height of the slider.
`InputInt`	`number`	The current value of the slider.
`Min`	`number`	The minimum value of the slider.
`Max`	`number`	The maximum value of the slider.

Returns: number

vSliderFloat

Gui.vSliderFloat(Label: string, Height: number, InputFloat: number, Min: number, Max: number) -> number

Creates a vertical floating-point slider.

Parameters

Name	Type	Description
`Label`	`string`	The label for the slider.
`Height`	`number`	The desired height of the slider.
`InputFloat`	`number`	The current value of the slider.
`Min`	`number`	The minimum value of the slider.
`Max`	`number`	The maximum value of the slider.

Returns: number

unindent

Gui.unindent() -> nil

Unindents the drawing cursor, moving subsequent elements to the left.

Returns: nil

treePop

Gui.treePop() -> nil

Pops the current tree node, ending the indented section. Must be called after TreeNode if it returned true.

Returns: nil

treeNode

Gui.treeNode(Label: string) -> boolean

Creates a tree node, often used for hierarchical data.

Parameters

Name	Type	Description
`Label`	`string`	The label for the tree node.

Returns: boolean

timeline

Gui.timeline(Label: string, PlaybackTime: number, StartTime: number, EndTime: number, SnapTimeInterval: number) -> number

A float slider with time labels and custom stand and end times

Parameters

Name	Type	Description
`Label`	`string`	The label for the timeline.
`PlaybackTime`	`number`	The current playback time.
`StartTime`	`number`	The start time of the timeline.
`EndTime`	`number`	The end time of the timeline.
`SnapTimeInterval`	`number`	The interval for snapping playback time.

Returns: number

textWrapped

Gui.textWrapped(Text: string) -> nil

Displays text that wraps to the next line at the edge of the window/region.

Parameters

Name	Type	Description
`Text`	`string`	The string to display.

Returns: nil

textDisabled

Gui.textDisabled(Text: string) -> nil

Displays text using the greyed-out "disabled" color.

Parameters

Name	Type	Description
`Text`	`string`	The string to display.

Returns: nil

textColored

Gui.textColored(Color: LinearColor, Text: string) -> nil

Displays text in the given color.

Parameters

Name	Type	Description
`Color`	`LinearColor`	The text color.
`Text`	`string`	The string to display.

Returns: nil

text

Gui.text(Text: string) -> nil

Displays static text

Parameters

Name	Type	Description
`Text`	`string`	The string to display.

Returns: nil

tableSetupColumn

Gui.tableSetupColumn(Id: string) -> nil

Sets up the properties for the next column in a table.

Parameters

Name	Type	Description
`Id`	`string`	The ID/name of the column.

Returns: nil

tableNextRow

Gui.tableNextRow() -> nil

Advances to the next row in a table.

Returns: nil

tableNextColumn

Gui.tableNextColumn() -> boolean

Advances to the next column in the current table row.

Returns: boolean

tableHeadersRow

Gui.tableHeadersRow() -> nil

Renders the header row for a table.

Returns: nil

spacing

Gui.spacing() -> nil

Adds a small vertical space.

Returns: nil

smallButton

Gui.smallButton(Label: string) -> boolean

Button with (FramePadding.y == 0) to easily embed within text

Parameters

Name	Type	Description
`Label`	`string`	The text label for the button.

Returns: boolean

sliderInt

Gui.sliderInt(Label: string, InputInt: number, Min: number, Max: number) -> number

Creates an integer slider.

Parameters

Name	Type	Description
`Label`	`string`	The label for the slider.
`InputInt`	`number`	The current value of the slider.
`Min`	`number`	The minimum value of the slider.
`Max`	`number`	The maximum value of the slider.

Returns: number

sliderFloat4

Gui.sliderFloat4(Label: string, Input: Quat, Min: number, Max: number) -> Quat

Creates a slider for a 4-component vector (e.g., Quaternion).

Parameters

Name	Type	Description
`Label`	`string`	The label for the slider.
`Input`	`Quat`	The current FQuat value.
`Min`	`number`	The minimum value for each component.
`Max`	`number`	The maximum value for each component.

Returns: Quat

sliderFloat3

Gui.sliderFloat3(Label: string, Input: Vec3, Min: number, Max: number) -> Vec3

Creates a slider for a 3D vector.

Parameters

Name	Type	Description
`Label`	`string`	The label for the slider.
`Input`	`Vec3`	The current FVector value.
`Min`	`number`	The minimum value for each component.
`Max`	`number`	The maximum value for each component.

Returns: Vec3

sliderFloat2

Gui.sliderFloat2(Label: string, Input: Vec2, Min: number, Max: number) -> Vec2

Creates a slider for a 2D vector.

Parameters

Name	Type	Description
`Label`	`string`	The label for the slider.
`Input`	`Vec2`	The current FVector2D value.
`Min`	`number`	The minimum value for each component.
`Max`	`number`	The maximum value for each component.

Returns: Vec2

sliderFloat

Gui.sliderFloat(Label: string, InputFloat: number, Min: number, Max: number) -> number

Creates a floating-point slider.

Parameters

Name	Type	Description
`Label`	`string`	The label for the slider.
`InputFloat`	`number`	The current value of the slider.
`Min`	`number`	The minimum value of the slider.
`Max`	`number`	The maximum value of the slider.

Returns: number

setNextItemWidth

Gui.setNextItemWidth(Width: number) -> nil

Sets the width of the next widget, in pixels. Negative values align the widget's right edge that many pixels from the right of the window (-1 spans the available width).

Parameters

Name	Type	Description
`Width`	`number`	The width in pixels.

Returns: nil

setItemTooltip

Gui.setItemTooltip(Text: string) -> nil

Sets a simple tooltip for the last rendered item.

Parameters

Name	Type	Description
`Text`	`string`	The text to display in the tooltip.

Returns: nil

setItemDefaultFocus

Gui.setItemDefaultFocus() -> nil

Sets the last rendered item to be the default focus when its window is first opened.

Returns: nil

separatorText

Gui.separatorText(Text: string) -> nil

Displays a text label centered within a horizontal separator line.

Parameters

Name	Type	Description
`Text`	`string`	The string to display as a separator text.

Returns: nil

separator

Gui.separator() -> nil

Draws a horizontal line to visually separate GUI elements.

Returns: nil

selectable

Gui.selectable(Label: string, bIsSelected: boolean) -> boolean

Creates a selectable item, often used within combo boxes or lists.

Parameters

Name	Type	Description
`Label`	`string`	The label for the selectable item.
`bIsSelected`	`boolean`	True if the item is currently selected.

Returns: boolean

sameLine

Gui.sameLine() -> nil

Call between widgets or groups to layout them horizontally.

Returns: nil

rangeSlider

Gui.rangeSlider(Label: string, SelectedRange: Vec2, Min: number, Max: number, Clamp: boolean) -> Vec2

Creates a slider that allows selecting a range (min and max) within a given overall range.

Parameters

Name	Type	Description
`Label`	`string`	The label for the range slider.
`SelectedRange`	`Vec2`	A FVector2D where X is the selected min and Y is the selected max.
`Min`	`number`	The overall minimum value.
`Max`	`number`	The overall maximum value.
`Clamp`	`boolean`	Clamp start and end of range to stay within the slider

Returns: Vec2

pushId

Gui.pushId(Id: string) -> nil

Pushes a unique ID onto the ID stack. Essential for widgets with same labels in loops.

Parameters

Name	Type	Description
`Id`	`string`	The ID to push (can be a string or integer).

Returns: nil

popId

Gui.popId() -> nil

Pops an ID from the ID stack. Must be called after PushId.

Returns: nil

newLine

Gui.newLine() -> nil

Inserts a vertical space.

Returns: nil

keyframeRowSelectedKeyframes

Gui.keyframeRowSelectedKeyframes(Label: string) -> Array<number>

Returns the indices of the currently selected keyframes in a keyframe row.

Parameters

Name	Type	Description
`Label`	`string`	The label of the keyframe row to query.

Returns: Array<number>

keyframeRowIsDragging

Gui.keyframeRowIsDragging(Label: string) -> boolean

Returns true if a keyframe row is currently being dragged.

Parameters

Name	Type	Description
`Label`	`string`	The label of the keyframe row to check.

Returns: boolean

keyframeRow

Gui.keyframeRow(Label: string, Vectors: Array<Vec2>, PlaybackTime: number, StartTime: number, EndTime: number, SnapTimeInterval: number) -> Array<Vec2>

A horizontal row with points that hold a position and value

Parameters

Name	Type	Description
`Label`	`string`	The label for the keyframe row.
`Vectors`	`Array<Vec2>`	An array of FVector2D representing the keyframe points (X=time, Y=value).
`PlaybackTime`	`number`	The current playback time.
`StartTime`	`number`	The start time of the timeline.
`EndTime`	`number`	The end time of the timeline.
`SnapTimeInterval`	`number`	The interval for snapping keyframes.

Returns: Array<Vec2>

isItemHovered

Gui.isItemHovered() -> boolean

Returns true if the last rendered item is hovered by the mouse.

Returns: boolean

isItemDeactivated

Gui.isItemDeactivated() -> boolean

Returns true on the frame an item is deactivated (e.g., mouse button released).

Returns: boolean

isItemActive

Gui.isItemActive() -> boolean

Returns true if the last rendered item is currently active (e.g., being dragged).

Returns: boolean

isItemActivated

Gui.isItemActivated() -> boolean

Returns true on the frame an item is activated (e.g., mouse button pressed down).

Returns: boolean

inputText

Gui.inputText(Label: string, InputText: string) -> string

Creates a text input field.

Parameters

Name	Type	Description
`Label`	`string`	The label for the input field.
`InputText`	`string`	The current text in the input field.

Returns: string

indent

Gui.indent() -> nil

Indents the drawing cursor, pushing subsequent elements to the right.

Returns: nil

graphEditor

Gui.graphEditor(Label: string, Vectors: Array<Vec2>, PlaybackTime: number, StartTime: number, EndTime: number, SnapTimeInterval: number) -> Array<Vec2>

A bezier spline editor

Parameters

Name	Type	Description
`Label`	`string`	The label for the graph editor.
`Vectors`	`Array<Vec2>`	An array of FVector2D representing the graph points.
`PlaybackTime`	`number`	The current playback time.
`StartTime`	`number`	The start time of the graph.
`EndTime`	`number`	The end time of the graph.
`SnapTimeInterval`	`number`	The interval for snapping points.

Returns: Array<Vec2>

endVertical

Gui.endVertical() -> nil

Ends a vertical layout group. (Likely a custom ImGui extension).

Returns: nil

endTooltip

Gui.endTooltip() -> nil

Ends a tooltip window. Must be called if BeginTooltip was called.

Returns: nil

endTable

Gui.endTable() -> nil

Ends a table. Must be called if BeginTable returned true.

Returns: nil

endTabItem

Gui.endTabItem() -> nil

Ends a tab item. Must be called only if BeginTabItem returned true.

Returns: nil

endTabBar

Gui.endTabBar() -> nil

Ends a tab bar. Must be called only if BeginTabBar returned true.

Returns: nil

endListBox

Gui.endListBox() -> nil

Ends a list box. Must be called if BeginListBox returned true.

Returns: nil

endHorizontal

Gui.endHorizontal() -> nil

Ends a horizontal layout group. (Likely a custom ImGui extension).

Returns: nil

endGroup

Gui.endGroup() -> nil

Ends a layout group.

Returns: nil

endDisabled

Gui.endDisabled() -> nil

Ends a disabled block.

Returns: nil

endCombo

Gui.endCombo() -> nil

Ends a combo box. Must be called if BeginCombo returned true.

Returns: nil

endChild

Gui.endChild() -> nil

Ends a child region. Must always be called after BeginChild, even if it returned false.

Returns: nil

dragInt

Gui.dragInt(Label: string, Input: number, DragSpeed: number, Min: number, Max: number) -> number

Creates a draggable integer input field.

Parameters

Name	Type	Description
`Label`	`string`	The label for the drag widget.
`Input`	`number`	The current integer value.
`DragSpeed`	`number`	The speed multiplier for dragging.
`Min`	`number`	The minimum value.
`Max`	`number`	The maximum value.

Returns: number

dragFloat4

Gui.dragFloat4(Label: string, Input: Quat, DragSpeed: number, Min: number, Max: number) -> Quat

Creates a draggable input for a 4-component vector (e.g., Quaternion).

Parameters

Name	Type	Description
`Label`	`string`	The label for the drag widget.
`Input`	`Quat`	The current FQuat value.
`DragSpeed`	`number`	The speed multiplier for dragging.
`Min`	`number`	The minimum value for each component.
`Max`	`number`	The maximum value for each component.

Returns: Quat

dragFloat3

Gui.dragFloat3(Label: string, Input: Vec3, DragSpeed: number, Min: number, Max: number) -> Vec3

Creates a draggable input for a 3D vector.

Parameters

Name	Type	Description
`Label`	`string`	The label for the drag widget.
`Input`	`Vec3`	The current FVector value.
`DragSpeed`	`number`	The speed multiplier for dragging.
`Min`	`number`	The minimum value for each component.
`Max`	`number`	The maximum value for each component.

Returns: Vec3

dragFloat2

Gui.dragFloat2(Label: string, Input: Vec2, DragSpeed: number, Min: number, Max: number) -> Vec2

Creates a draggable input for a 2D vector.

Parameters

Name	Type	Description
`Label`	`string`	The label for the drag widget.
`Input`	`Vec2`	The current FVector2D value.
`DragSpeed`	`number`	The speed multiplier for dragging.
`Min`	`number`	The minimum value for each component.
`Max`	`number`	The maximum value for each component.

Returns: Vec2

dragFloat

Gui.dragFloat(Label: string, InputFloat: number, DragSpeed: number, Min: number, Max: number) -> number

Creates a draggable floating-point input field.

Parameters

Name	Type	Description
`Label`	`string`	The label for the drag widget.
`InputFloat`	`number`	The current float value.
`DragSpeed`	`number`	The speed multiplier for dragging.
`Min`	`number`	The minimum value.
`Max`	`number`	The maximum value.

Returns: number

colorPicker

Gui.colorPicker(Label: string, Input: LinearColor) -> LinearColor

Creates a full, always-expanded color picker.

Parameters

Name	Type	Description
`Label`	`string`	The label for the widget.
`Input`	`LinearColor`	The current color.

Returns: LinearColor

colorEdit

Gui.colorEdit(Label: string, Input: LinearColor) -> LinearColor

Creates a compact color swatch with RGBA fields. Clicking the swatch opens a color picker popup.

Parameters

Name	Type	Description
`Label`	`string`	The label for the widget.
`Input`	`LinearColor`	The current color.

Returns: LinearColor

collapsingHeader

Gui.collapsingHeader(Label: string) -> boolean

If returning 'true' the header is open. Doesn't indent nor push on ID stack. User doesn't have to call TreePop().

Parameters

Name	Type	Description
`Label`	`string`	The label for the header.

Returns: boolean

checkbox

Gui.checkbox(Label: string, InputBool: boolean) -> boolean

Creates a checkbox.

Parameters

Name	Type	Description
`Label`	`string`	The label for the checkbox.
`InputBool`	`boolean`	The current boolean state of the checkbox.

Returns: boolean

buttonColored

Gui.buttonColored(Color: LinearColor, Label: string) -> boolean

Creates a button drawn in the given color.

Parameters

Name	Type	Description
`Color`	`LinearColor`	The button's background color.
`Label`	`string`	The text label for the button.

Returns: boolean

button

Gui.button(Label: string) -> boolean

Creates a button.

Parameters

Name	Type	Description
`Label`	`string`	The text label for the button.

Returns: boolean

bulletText

Gui.bulletText(Text: string) -> nil

Displays text prefixed with a bullet point.

Parameters

Name	Type	Description
`Text`	`string`	The string to display.

Returns: nil

beginVertical

Gui.beginVertical(Id: string) -> nil

Starts a vertical layout group. (Likely a custom ImGui extension).

Parameters

Name	Type	Description
`Id`	`string`	A unique ID for the vertical group.

Returns: nil

beginTooltip

Gui.beginTooltip() -> nil

Begins a tooltip window. Must be called after the item you want to attach the tooltip to.

Returns: nil

beginTable

Gui.beginTable(Id: string, ColumnsCount: number) -> boolean

Begins a table.

Parameters

Name	Type	Description
`Id`	`string`	A unique ID for the table.
`ColumnsCount`	`number`	The number of columns in the table.

Returns: boolean

beginTabItem

Gui.beginTabItem(Label: string) -> boolean

Begins a tab item within a tab bar.

Parameters

Name	Type	Description
`Label`	`string`	The label shown on the tab.

Returns: boolean

beginTabBar

Gui.beginTabBar(Id: string) -> boolean

Begins a tab bar. Tab items created between this and EndTabBar appear as tabs.

Parameters

Name	Type	Description
`Id`	`string`	A unique ID for the tab bar.

Returns: boolean

beginListBox

Gui.beginListBox(Id: string) -> boolean

Begins a scrollable list box.

Parameters

Name	Type	Description
`Id`	`string`	A unique ID for the list box.

Returns: boolean

beginHorizontal

Gui.beginHorizontal(Id: string) -> nil

Starts a horizontal layout group. (Likely a custom ImGui extension).

Parameters

Name	Type	Description
`Id`	`string`	A unique ID for the horizontal group.

Returns: nil

beginGroup

Gui.beginGroup() -> nil

Begins a layout group. Widgets between this and EndGroup are treated as a single item for layout (e.g. SameLine) and bounding-box purposes.

Returns: nil

beginDisabled

Gui.beginDisabled() -> nil

Starts a disabled block. All subsequent widgets will be grayed out and non-interactive.

Returns: nil

beginCombo

Gui.beginCombo(Label: string, PreviewValue: string) -> boolean

Starts a combo box.

Parameters

Name	Type	Description
`Label`	`string`	The label for the combo box.
`PreviewValue`	`string`	The text displayed when the combo box is closed.

Returns: boolean

beginChild

Gui.beginChild(Id: string, Width: number, Height: number, Border: boolean) -> boolean

Begins a scrollable/clipped child region inside the current window. This is NOT a separate window. A size component of 0 fills the available space on that axis.

Parameters

Name	Type	Description
`Id`	`string`	A unique ID for the child region.
`Width`	`number`	The width of the region (0 = fill available width).
`Height`	`number`	The height of the region (0 = fill available height).
`Border`	`boolean`	Whether to draw a border around the region.

Returns: boolean