rojo/.cursor/rules/roblox/reference/engine/classes/GlobalSettings.yaml
2026-02-02 12:08:47 -06:00

72 lines
1.7 KiB
YAML

# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
name: GlobalSettings
type: class
memory_category: Instances
summary: |
Collection of menu settings for Roblox Studio.
description: |
The base object used for Roblox Studio's settings menu. Can be accessed by
using the `settings()` function.
## Settings classes under the GlobalSettings
- `Class.DebugSettings`
- `Class.GameSettings`
- `Class.LuaSettings`
- `Class.NetworkSettings`
- `Class.PhysicsSettings`
- `Class.RenderSettings`
- `Class.Studio`
code_samples: []
inherits:
- GenericSettings
descendants: []
tags:
- NotCreatable
- NotBrowsable
deprecation_message: ''
properties: []
methods:
- name: GlobalSettings:GetFFlag
summary: |
Returns the value of an FFlag if it exists.
description: |
Returns the value of an FFlag if it exists.
code_samples: []
parameters:
- name: name
type: string
default:
summary: ''
returns:
- type: boolean
summary: ''
tags: []
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
- name: GlobalSettings:GetFVariable
summary: |
Returns the value of an FVariable, if it exists.
description: |
Returns the value of an FVariable, if it exists.
code_samples: []
parameters:
- name: name
type: string
default:
summary: ''
returns:
- type: string
summary: ''
tags: []
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
events: []
callbacks: []