API:Class/RbxGui

< API:Class(Redirected from RbxGui)
Deprecated: This item is deprecated. Do not use it for new work.
Library: This is documentation for a library. It is a built-in Lua-based library that can be retrieved using LoadLibrary.

ExplorerImageIndex27.pngRbxGui

RbxGui is an official ROBLOX-created library, specifically made for aiding with the creation of GUI elements.
Its use is not mandatory, but is recommended for those who would like to make good looking GUI features quickly.

Properties

Properties [toggle]

Inherited from Object Icon.pngRbxLibrary:
stringName [readonly]

The name of the library.

|RMD member="API:Class/RbxLibrary/Name"|The name of the library.|/RMD|
Name [readonly]
The name of the library.

Functions

FunctionsmemberhiddenFunctions [toggle]

Variant<TextLabel, TextBox>, function<void>(string)AutoTruncateTextObject ( Variant<TextLabel, TextBox> textLabelToAutoTruncate )

Adds automated truncation to a text-based GuiObject. Returns the object that was inputted, and a function that allows you to change the text of the object.

|RMD member="API:Class/RbxGui/AutoTruncateTextObject"|Adds automated truncation to a text-based GuiObject. Returns the object that was inputted, and a function that allows you to change the text of the object.|/RMD|
Frame, function<void>()CreateDropDownMenu ( array<string> items, function(string) onItemSelected, bool forRoblox = false, bool whiteSkin = false, int baseZIndex = 0 )

Creates a dropdown menu, where each entry is a string from the items array.
When an entry is selected, onItemSelected is called with the entry string.

|RMD member="API:Class/RbxGui/CreateDropDownMenu"|Creates a dropdown menu, where each entry is a string from the items array.
When an entry is selected, onItemSelected is called with the entry string.|/RMD|
Frame, function<void>(double, bool, double), BindableEventCreateLoadingFrame ( string name, UDim2 size, UDim2 position )

Creates a gui that can be manipulated to show progress for a particular action.

|RMD member="API:Class/RbxGui/CreateLoadingFrame"|Creates a gui that can be manipulated to show progress for a particular action.|/RMD|
FrameCreateMessageDialog ( string title, string message, array<dictionary<string, function>> buttons )

Returns a Frame icon.pngFrame of a message box with 'title' and 'message' as passed in.

|RMD member="API:Class/RbxGui/CreateMessageDialog"|Returns a Frame icon.pngFrame of a message box with 'title' and 'message' as passed in.|/RMD|
Frame, Frame, Frame, BindableEventCreatePluginFrame ( string name, UDim2 size = nil, UDim2 position = nil, bool scrollable = false, Instance parent = nil )

Creates a widget-like window, primarily designed for ExplorerImageIndex81.pngPlugins.

|RMD member="API:Class/RbxGui/CreatePluginFrame"|Creates a widget-like window, primarily designed for ExplorerImageIndex81.pngPlugins.|/RMD|
FrameCreatePropertyDropDownMenu ( Instance object, string propertyName, Enum enumType )

Creates a dropdown menu for an Instance's property. The property must be an Enum.

|RMD member="API:Class/RbxGui/CreatePropertyDropDownMenu"|Creates a dropdown menu for an Instance's property. The property must be an Enum.|/RMD|
Frame, IntValueCreateSlider ( int steps, int width, UDim2 position )

Creates a slider bar.

|RMD member="API:Class/RbxGui/CreateSlider"|Creates a slider bar.|/RMD|
Frame, IntValueCreateSliderNew ( int steps, int width, UDim2 position )

Like CreateSlider, but with a modern style!.

|RMD member="API:Class/RbxGui/CreateSliderNew"|Like CreateSlider, but with a modern style!.|/RMD|
FrameCreateStyledMessageDialog ( string title, string message, string style, array<dictionary<string, function>> buttons )

Returns a Frame icon.pngFrame of a message box with 'title' and 'message' as passed in.

|RMD member="API:Class/RbxGui/CreateStyledMessageDialog"|Returns a Frame icon.pngFrame of a message box with 'title' and 'message' as passed in.|/RMD|
TupleCreateScrollingFrame ( array orderList, string style ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/RbxGui/CreateScrollingFrame"|Deprecated. Do not use.|/RMD|
TupleCreateSetPanel ( array userIdsForSets, function objectSelected, function dialogClosed, UDim2 size = nil, UDim2 position = nil, bool showAdminCategories = false, bool useAssetVersionId = false ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/RbxGui/CreateSetPanel"|Deprecated. Do not use.|/RMD|
TupleCreateTerrainMaterialSelector ( UDim2 size, UDim2 position ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/RbxGui/CreateTerrainMaterialSelector"|Deprecated. Do not use.|/RMD|
TupleCreateTrueScrollingFrame ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/RbxGui/CreateTrueScrollingFrame"|Deprecated. Do not use.|/RMD|
doubleGetFontHeight ( Font font, FontSize fontSize ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/RbxGui/GetFontHeight"|Deprecated. Do not use.|/RMD|
AutoTruncateTextObject ( Variant<TextLabel, TextBox> textLabelToAutoTruncate )
Adds automated truncation to a text-based GuiObject. Returns the object that was inputted, and a function that allows you to change the text of the object.
CreateDropDownMenu ( array<string> items, function(string) onItemSelected, bool forRoblox = false, bool whiteSkin = false, int baseZIndex = 0 )
Creates a dropdown menu, where each entry is a string from the items array.
When an entry is selected, onItemSelected is called with the entry string.
CreateLoadingFrame ( string name, UDim2 size, UDim2 position )
Creates a gui that can be manipulated to show progress for a particular action.
Returns a Frame icon.pngFrame of a message box with 'title' and 'message' as passed in.
CreatePluginFrame ( string name, UDim2 size = nil, UDim2 position = nil, bool scrollable = false, Instance parent = nil )
Creates a widget-like window, primarily designed for ExplorerImageIndex81.pngPlugins.
CreatePropertyDropDownMenu ( Instance object, string propertyName, Enum enumType )
Creates a dropdown menu for an Instance's property. The property must be an Enum.
CreateSlider ( int steps, int width, UDim2 position )
Creates a slider bar.
CreateSliderNew ( int steps, int width, UDim2 position )
Like CreateSlider, but with a modern style!.
Returns a Frame icon.pngFrame of a message box with 'title' and 'message' as passed in.
CreateScrollingFrame ( array orderList, string style ) [deprecated]
Deprecated. Do not use.
CreateSetPanel ( array userIdsForSets, function objectSelected, function dialogClosed, UDim2 size = nil, UDim2 position = nil, bool showAdminCategories = false, bool useAssetVersionId = false ) [deprecated]
Deprecated. Do not use.
CreateTerrainMaterialSelector ( UDim2 size, UDim2 position ) [deprecated]
Deprecated. Do not use.
CreateTrueScrollingFrame ( ) [deprecated]
Deprecated. Do not use.
GetFontHeight ( Font font, FontSize fontSize ) [deprecated]
Deprecated. Do not use.
Inherited from Object Icon.pngRbxLibrary:
array<string>GetApi ( )

Returns an array of strings, each string being the name of a function in the library.

|RMD member="API:Class/RbxLibrary/GetApi"|Returns an array of strings, each string being the name of a function in the library.|/RMD|
stringHelp ( Variant<string, function> funcNameOrFunc )

Returns a string, representing the documentation of a function in the library, which can be printed into the output.

|RMD member="API:Class/RbxLibrary/Help"|Returns a string, representing the documentation of a function in the library, which can be printed into the output.|/RMD|
GetApi ( )
Returns an array of strings, each string being the name of a function in the library.
Help ( Variant<string, function> funcNameOrFunc )
Returns a string, representing the documentation of a function in the library, which can be printed into the output.


|RMD member="API:Class/RbxGui"|RbxGui is an official ROBLOX-created library, specifically made for aiding with the creation of GUI elements.
Its use is not mandatory, but is recommended for those who would like to make good looking GUI features quickly.
|/RMD|