Skip to content

Commit e953718

Browse files
authored
Descriptions
Added long descriptions going into detail how it works
1 parent 34dde2f commit e953718

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

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

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,13 @@ properties:
372372
summary: |
373373
Determines whether the player's mouse is being actively pressed on the
374374
`Class.GuiObject` or not.
375-
description: ''
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`.
376382
code_samples: []
377383
type: GuiState
378384
tags:
@@ -392,9 +398,21 @@ properties:
392398
writeCapabilities: []
393399
- name: GuiObject.Interactable
394400
summary: |
395-
Determines whether the `Class.GuiButton` can be interacted with or not.
401+
Determines whether the `Class.GuiButton` can be interacted with or not, or if
402+
the `Class.GuiObject`'s `Enum.GuiState|GuiState` is changing or not.
396403
description: |
397-
404+
On a `Class.GuiButton`:
405+
- When the `Class.GuiObject.Interactable|Interactable` setting on the `Class.GuiButton` is
406+
set to `false`, The `Class.GuiButton` will no longer be able to be pressed or clicked. and the
407+
`Class.GuiObject.GuiState|GuiState` will be constantly set to `Enum.GuiState.NonInteractable|NonInteractable`.
408+
- When the `Class.GuiObject.Interactable|Interactable` setting on the `Class.GuiButton` is
409+
set to `true`, The `Class.GuiButton` will behave normally again, and the `Class.GuiObject.GuiState|GuiState` will
410+
behave normally.
411+
On a `Class.GuiObject`:
412+
- When the `Class.GuiObject.Interactable|Interactable` setting on the `Class.GuiButton` is
413+
set to `false`, The `Class.GuiObject.GuiState|GuiState` will be constantly set to `Enum.GuiState.NonInteractable|NonInteractable`.
414+
- When the `Class.GuiObject.Interactable|Interactable` setting on the `Class.GuiButton` is
415+
set to `true`, The `Class.GuiObject.GuiState|GuiState` will behave normally again.
398416
code_samples: []
399417
type: bool
400418
tags: []

0 commit comments

Comments
 (0)