Skip to content

Commit a9c6f9f

Browse files
authored
Added missing sections: GuiState, Interactable (#875)
There was just nothing in those 2 sections. ## Changes GuiObject.GuiState and GuiObject.Interactable now have short summaries and long descriptions of how they work. ## Checks By submitting your pull request for review, you agree to the following: - [ ] This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses. - [ ] I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses. - [ ] To the best of my knowledge, all proposed changes are accurate. ---------
1 parent 0b017c7 commit a9c6f9f

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

content/en-us/reference/engine/classes/GuiObject.yaml

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -369,8 +369,16 @@ properties:
369369
- UI
370370
writeCapabilities: []
371371
- name: GuiObject.GuiState
372-
summary: ''
373-
description: ''
372+
summary: |
373+
Determines whether the player's mouse is being actively pressed on the
374+
`Class.GuiObject` or not.
375+
description: |
376+
When the player's finger is being tapped and held on the `Class.GuiObject`, the
377+
`Class.GuiObject.GuiState|GuiState` of the `Class.GuiObject` will be set to `Enum.GuiState.Press|Press`. Similarly,
378+
When the player's finger is being released from the `Class.GuiObject`, the
379+
`Class.GuiObject.GuiState|GuiState` of the `Class.GuiObject` will be set to `Enum.GuiState.Idle|Idle`,
380+
and when `Class.GuiObject.Interactable|Interactable` is turned off on the `Class.GuiObject`, the `Class.GuiState`
381+
of the `Class.GuiObject` will be set to `Enum.GuiState.NonInteractable|NonInteractable`.
374382
code_samples: []
375383
type: GuiState
376384
tags:
@@ -389,8 +397,26 @@ properties:
389397
- UI
390398
writeCapabilities: []
391399
- name: GuiObject.Interactable
392-
summary: ''
393-
description: ''
400+
summary: |
401+
Determines whether the `Class.GuiButton` can be interacted with or not, or if
402+
the `Enum.GuiState|GuiState` of the `Class.GuiObject` is changing or not.
403+
description: |
404+
Determines whether the `Class.GuiButton` can be interacted with or not, or if
405+
the `Enum.GuiState|GuiState` of the `Class.GuiObject` is changing or not.
406+
407+
On a `Class.GuiButton`:
408+
- When the `Class.GuiObject.Interactable|Interactable` setting on the `Class.GuiButton` is
409+
set to `false`, the `Class.GuiButton` will no longer be able to be pressed or clicked, and the
410+
`Class.GuiObject.GuiState|GuiState` will be constantly set to `Enum.GuiState.NonInteractable|NonInteractable`.
411+
- When the `Class.GuiObject.Interactable|Interactable` setting on the `Class.GuiButton` is
412+
set to `true`, the `Class.GuiButton` will behave normally again and the `Class.GuiObject.GuiState|GuiState` will
413+
behave normally.
414+
415+
On a `Class.GuiObject`:
416+
- When the `Class.GuiObject.Interactable|Interactable` setting on the `Class.GuiButton` is
417+
set to `false`, the `Class.GuiObject.GuiState|GuiState` will be constantly set to `Enum.GuiState.NonInteractable|NonInteractable`.
418+
- When the `Class.GuiObject.Interactable|Interactable` setting on the `Class.GuiButton` is
419+
set to `true`, the `Class.GuiObject.GuiState|GuiState` will behave normally again.
394420
code_samples: []
395421
type: bool
396422
tags: []

0 commit comments

Comments
 (0)