Skip to main content

​
Draw

Returns an instance of the specified class ‘Type’ with the given properties. Internally, the render is appended to the Menu.Renders table and the global ZIndex is increased by 1. \ FontFace is handled differently, it must be a table containing at index 1, the Font and at index 2, the textsize. Menu.Fonts contains the default Fonts used by the Menu. TextSize can be overwritten by passing in the TextSize property into the properties table. 
Menu.Draw(string: Type, table?: Properties)
​
Type
string
required
The instance class to create.
​
Properties
table
The table containing the properties to apply to the render.

​
Remove

Destroys a render and removes itself and it’s desscendants from the Menu.Renders table. Use this instead of manually destroying renders created by Menu.Draw. 
Menu.Remove(instance: Render)

-- Removes a render and it's descendants from the Menu.Renders table, then destroys the instance.
-- This is the proper way to destroy renders created by Menu.Draw.
​
Render
instance
required
The Render to destroy.

​
ShadeColor

Returns a Color3, the result of the base Color’s R/G/B values multiplied by the provided R/G/B values. 
Menu.ShadeColor(Color3: Color, number: Red, number: Green, number: Blue)
​
Color
Color3
required
The base color.
​
Red
number
required
​
Green
number
required
​
Blue
number
required

​
GetDescendants

Returns a table of the Render’s descendants inclusive of itself at index 1. 
Menu.GetDescendants(instance: Render)
​
Render
instance
required
The base render.

​
ToRichText

Returns a formatted string for rich text. 
Menu.ToRichText(string: Text, Color3: Color)
Usage example: 
Menu.ToRichText('Hello <font color="rgb(#s)">this is red</font>', Color3.fromRGB(255, 0, 0))
​
Text
string
required
The raw text.
​
Color
Color3
required
Enter a description

​
Tween

Tweens a render, instantly plays it with the given data and returns the tween object. 
Menu.Tween(instance: Render, TweenInfo: TweenInfo, table: Properties)
Usage Example: 
Menu.Tween(Frame, TweenInfo.new(1, Enum.EasingStyle.Linear), { Position = UDim2.new(1, 0, 1, 0) })
​
Render
instance
required
The render to tween.
​
TweenInfo
TweenInfo
required
​
Properties
table
required
The properties to tween.

​
ImportImage

Returns an assetid of the image from the base64 encoded data. 
Menu.ImportImage(string: Name, string: Data)
​
Name
string
required
The name of the image.
​
Data
string
required
The base64 encoding of the Image.

​
ImportFont

Returns a Font object from the given base64 encoded data. 
Menu.ImportFont(string: Name, string: Data, number?: WeightNumber, enum?: WeightEnum, enum?: StyleEnum)
​
Name
string
required
The name of the Font.
​
Data
string
required
The base64 encoding of the font.
​
number
WeightNumber
​
enum
WeightEnum
​
StyleEnum
enum

​
GetTextBounds

Returns thte text bounds (Vector2) of the text from the given font. Refer to Draw for info on FontFace. 
Menu.GetTextBounds(string: Text, table: FontFace, number?: TextSize)
​
Text
string
required
​
FontFace
table
required
​
TextSize
number