Class
GlobalSettings
NotCreatableNotBrowsable
Collection of menu settings for Roblox Studio.
The base object used for Roblox Studio's settings menu. Can be accessed by
using the settings() function, which requires the Plugin capability.
Settings classes under the GlobalSettings#
Methods 2#
| GetFFlag | Returns the value of an FFlag if it exists. |
| GetFVariable | Returns the value of an FVariable, if it exists. |
GetFFlag(name: string): boolean#
Looks up the fast flag registered under name and returns its current
value as a boolean: true when the flag's value is true, and false
otherwise. Provide the flag's registered name without its type prefix, for
example MyFeature rather than FFlagMyFeature. If no flag with that
name is defined in the engine, the method raises an error instead of
returning a value, so avoid querying flags that might not exist. Access it
through the settings() global (requires the Plugin capability), as in
settings():GetFFlag("MyFeature").
| Name | Type | Default | Description |
|---|---|---|---|
name | string | The registered name of the fast flag to query, without its type prefix
(for example, MyFeature rather than FFlagMyFeature). |
Returns
boolean—truewhen the named flag's value istrue, andfalseotherwise; raises an error if no flag with that name is defined.
GetFVariable(name: string): string#
Looks up the fast variable registered under name and returns its current
value as a string. Provide the variable's registered name without its type
prefix. As with GlobalSettings:GetFFlag(), if no variable with
that name is defined in the engine, the method raises an error rather than
returning a value. Access it through the settings() global (requires the
Plugin capability), as in settings():GetFVariable("MyValue").
| Name | Type | Default | Description |
|---|---|---|---|
name | string | The registered name of the fast variable to query, without its type
prefix (for example, MyValue rather than FIntMyValue). |
Returns
string— The current value of the named fast variable as a string; raises an error if no variable with that name is defined.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild