Overlay

Example

local overlay = vape:CreateCustom({
	Name = 'Text GUI',
	Icon = getcustomasset('newvape/assets/textguiicon.png'),
	Size = UDim2.fromOffset(16, 12),
	Position = UDim2.fromOffset(12, 14)
})

Parameters

Name	Type	Required	Description
Name	string	Yes	The name used for the overlay
Icon	string	Yes	A rbxasset path used for the icon of the overlay
Size	UDim2	Yes	The size of the icon used in the overlay
Position	UDim2	No	The position of the icon used in the overlay

Methods

Name	Returns	Description	Example
Expand	None	Toggles the collapsed state of the overlay	overlay:Expand()
Pin	None	Toggles the pinned state of the overlay	overlay:Pin()
Clean	None	A garbage clone of maid used to clean up connections & Instances when the overlay toggle state is set to false, use this inside of the callback	overlay:Clean(Instance.new('Part')); overlay:Clean(game.Loaded:Connect(function() end))

Properties

Name	Type	Description
Expanded	boolean	The current expanded state overlay.Expanded
Button	Toggle	The current overlay toggle overlay.Button.Enabled
Pinned	boolean	The current pinned state overlay.Pinned
Object	Instance	Returns the overlay tab that displays onscreen component.Object