Skip to content

Added missing sections: GuiState, Interactable #875

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 21, 2024
Merged

Added missing sections: GuiState, Interactable #875

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
34dde2f
Added missing sections: GuiState, Interactable
vifgaming1 Oct 20, 2024
e953718
Descriptions
vifgaming1 Oct 20, 2024
919cd20
Update content/en-us/reference/engine/classes/GuiObject.yaml
IgnisRBX Oct 21, 2024
f987343
Update content/en-us/reference/engine/classes/GuiObject.yaml
IgnisRBX Oct 21, 2024
be71372
Update content/en-us/reference/engine/classes/GuiObject.yaml
IgnisRBX Oct 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 30 additions & 4 deletions content/en-us/reference/engine/classes/GuiObject.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,8 +369,16 @@ properties:
- UI
writeCapabilities: []
- name: GuiObject.GuiState
summary: ''
description: ''
summary: |
Determines whether the player's mouse is being actively pressed on the
`Class.GuiObject` or not.
description: |
When the player's finger is being tapped and held on the `Class.GuiObject`, the
`Class.GuiObject.GuiState|GuiState` of the `Class.GuiObject` will be set to `Enum.GuiState.Press|Press`. Similarly,
When the player's finger is being released from the `Class.GuiObject`, the
`Class.GuiObject.GuiState|GuiState` of the `Class.GuiObject` will be set to `Enum.GuiState.Idle|Idle`,
and when `Class.GuiObject.Interactable|Interactable` is turned off on the `Class.GuiObject`, the `Class.GuiState`
of the `Class.GuiObject` will be set to `Enum.GuiState.NonInteractable|NonInteractable`.
code_samples: []
type: GuiState
tags:
Expand All @@ -389,8 +397,26 @@ properties:
- UI
writeCapabilities: []
- name: GuiObject.Interactable
summary: ''
description: ''
summary: |
Determines whether the `Class.GuiButton` can be interacted with or not, or if
the `Enum.GuiState|GuiState` of the `Class.GuiObject` is changing or not.
description: |
Determines whether the `Class.GuiButton` can be interacted with or not, or if
the `Enum.GuiState|GuiState` of the `Class.GuiObject` is changing or not.

On a `Class.GuiButton`:
- When the `Class.GuiObject.Interactable|Interactable` setting on the `Class.GuiButton` is
set to `false`, the `Class.GuiButton` will no longer be able to be pressed or clicked, and the
`Class.GuiObject.GuiState|GuiState` will be constantly set to `Enum.GuiState.NonInteractable|NonInteractable`.
- When the `Class.GuiObject.Interactable|Interactable` setting on the `Class.GuiButton` is
set to `true`, the `Class.GuiButton` will behave normally again and the `Class.GuiObject.GuiState|GuiState` will
behave normally.

On a `Class.GuiObject`:
- When the `Class.GuiObject.Interactable|Interactable` setting on the `Class.GuiButton` is
set to `false`, the `Class.GuiObject.GuiState|GuiState` will be constantly set to `Enum.GuiState.NonInteractable|NonInteractable`.
- When the `Class.GuiObject.Interactable|Interactable` setting on the `Class.GuiButton` is
set to `true`, the `Class.GuiObject.GuiState|GuiState` will behave normally again.
code_samples: []
type: bool
tags: []
Expand Down
Loading