Reference API Roblox

Engine API

Website

Related

Reference API Roblox

StudioTheme

A collection of colors that make up a Roblox Studio theme, letting a plugin query the color of a Studio UI element for the theme the user currently has active.

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory categoryInstances
Tags: [NotCreatable, NotReplicated]

Member index 1

HistoryMember
462GetColor(styleguideitem: StudioStyleGuideColor, modifier: StudioStyleGuideModifier = Default): Color3
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
723IsInSandbox: bool
553Name: string
553Parent: Instance
702PredictionMode: PredictionMode
670Sandboxed: bool
680UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 1

HistoryMember
474GetPath(assetid: string, modifier: StudioStyleGuideModifier = Default): string

Description

A StudioTheme represents one of Roblox Studio's UI color themes, such as the built-in Light and Dark themes, as a palette of colors loaded from the theme's definition. Each color is identified by a StudioStyleGuideColor element (the UI element) together with a StudioStyleGuideModifier (the element's state, which defaults to Default), so a plugin can match its appearance to whichever theme the user currently has active.

Access the currently active theme through Studio.Theme, then call StudioTheme:GetColor() to look up an individual color:

1
2

local theme = settings().Studio.Theme
local color = theme:GetColor(Enum.StudioStyleGuideColor.MainBackground)

Because a user can switch the active theme at any time, listen for Studio.ThemeChanged to refresh your plugin's colors when the theme changes.

History 9

Members 1

GetColor

Parameters (2)Default
styleguideitemStudioStyleGuideColor
modifierStudioStyleGuideModifierDefault
Returns (1)
Color3

The GetColor() function returns the Color3 corresponding to the arguments provided. For instance, if you would like to get the Color3 of the Studio "MainButton" when it's disabled, you can use the following code:

1

settings().Studio.Theme:GetColor(Enum.StudioStyleGuideColor.MainButton, Enum.StudioStyleGuideModifier.Disabled)

See the StudioStyleGuideColor reference for a list of Studio elements and StudioStyleGuideModifier for a list of modifiers.

SecurityPluginSecurity
Thread safetyUnsafe

History 2

Removed members 1

GetPath

Parameters (2)Default
assetidstring
modifierStudioStyleGuideModifierDefault
Returns (1)
string
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
SecurityPluginSecurity
Thread safetyUnsafe

History 6

Tags: [Deprecated]

Settings