Buttons

Buttons are parts that toggle a set of parts between a Pressed and Unpressed state. They are linked to their corresponding button activated objects by their Color property.

Use Cases

Buttons may be used to create toggleable parts and objects. This can be used for progression, timed sections, or to activate platforms that make recovery faster.

Configuration

Name	Default Value	Description
HideGUI	false	When true, the timer label displayed on the button and the game's UI will not be shown.
PadDistance	10	When PadMode is true, the maximum distance above the button the object that activated the button can be before it deactivates.
PadMode	false	When true, the button will only be activated while an object is actively touching the ButtonPart. If not touching, it will automatically deactivate.
PressedMaterial	Neon	The material of the Button when pressed.
PressOffset	CFrame.new(0, -0.75, 0)	The offset of the ButtonPart when pressed. Uses the provided TweenConfiguration.
Timer	0	The time the button will be activated for before automatically deactivating. If set to 0, the button will not have a timer.
TimerDecimalPlaces	0	The number of decimal places displayed on the timer label.
TimerText	{T}	The text that appears on the timer display. See this page for more info.

The TimerLabel is found inside the ButtonConfiguration and can be configured seperately. The UseSpecialColor tag can be used on the TimerLabel to disable its automatic coloring.

Button Activated Objects

Any Part with the ButtonActivated tag will be considered a button activated object. By default, button activated objects behave as follows:

Button State	CanCollide	Transparency	Client Object State
Unpressed	false	0.6	Disabled
Pressed	true	0	Enabled

These will be inverted if the object has the Invert tag.

Please note that if 64 or more parts are toggled at once, there will be a 1 frame delay every 64 parts to improve performance.

Supported Visual Instances

If the following objects are found inside of a button activated object, they will match the object's transparency when toggled:

Object	Property Affected
Decal	Transparency
Texture	Transparency
SelectionBox	Transparency
SelectionSphere	Transparency
Frame	BackgroundTransparency
CanvasGroup	GroupTransparency
TextLabel	TextTransparency
ImageLabel	ImageTransparency

If the following objects are found inside of a button activated object, they will have their Enabled property toggled to match the button's state:

Object
Beam
ParticleEmitter
Fire
Sparkles
Smoke
Trail
UIStroke
Any Light
Highlight

The following objects will also have their Enabled property toggled, but only if they have the ToggleEnabled tag:

Object
Any Constraint

Button Activated Object Configurations

Button activated objects have special configurations that can be modified using Attributes and Tags:

Name	Type	Description
ColorOverride	Color3 Attribute	The object will behave as if it is linked to that Color rather than the object's actual color. If a ButtonPart has this attribute, its functionality may be toggled by other Buttons.
FullHide	Tag	Sets the Unpressed Transparency to 1.
SetTransparency	number Attribute	Changes the Transparency of the object in the Pressed state.
SetInactiveTransparency	number Attribute	Changes the Transparency of the object in the Unpressed state.
IgnoreTransparency	Tag	The Transparency of the object will not be changed and remains in its default state from Studio.
IgnoreCanCollide	Tag	The CanCollide of the object will not be changed and remains in its default state from Studio.
IgnoreEnabled	Tag	The Enabled property of the object will not be changed and remains in its default state from Studio.
ToggleEnabled	Tag	As listed in this section, some objects must have this tag in order for their Enabled property to toggle.
Invisible	Tag	The Transparency of the object will always be 1 no matter the button state.
Invert	Tag	Swaps the properties of the Pressed and Unpressed states.
IgnoreInitialActivate	Tag	The object will not be affected by the first update that happens when the Button initially loads. It will still be affected by further updates.
IgnoreAll	Tag	The object will act as if the IgnoreTransparency, IgnoreCanCollide and IgnoreEnabled tags are all present.
TweenTime	number Attribute	Controls how long button-activated objects take to fade. Defaults to 0.3 if not set.

Unsupported Client Objects

Below is a list of all the client objects that either cannot currently be toggled by a Button, or have known issues regarding them when button activated.

Unsupported Client Object	Notes
Vanishers	Inconsistent behaviour when toggled while vanishing