diff --git a/content/en-us/reference/engine/classes/GuiObject.yaml b/content/en-us/reference/engine/classes/GuiObject.yaml index 283cc0e33..7e3100719 100644 --- a/content/en-us/reference/engine/classes/GuiObject.yaml +++ b/content/en-us/reference/engine/classes/GuiObject.yaml @@ -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: @@ -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: []