From 34dde2f215f6cbc25697a07f7a72105487d231b1 Mon Sep 17 00:00:00 2001 From: vifgaming1 <153995437+vifgaming1@users.noreply.github.com> Date: Sun, 20 Oct 2024 13:06:09 +0700 Subject: [PATCH 1/5] Added missing sections: GuiState, Interactable There was just nothing in those 2 sections. --- content/en-us/reference/engine/classes/GuiObject.yaml | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/content/en-us/reference/engine/classes/GuiObject.yaml b/content/en-us/reference/engine/classes/GuiObject.yaml index 283cc0e33..ad582f962 100644 --- a/content/en-us/reference/engine/classes/GuiObject.yaml +++ b/content/en-us/reference/engine/classes/GuiObject.yaml @@ -369,7 +369,9 @@ properties: - UI writeCapabilities: [] - name: GuiObject.GuiState - summary: '' + summary: | + Determines whether the player's mouse is being actively pressed on the + `Class.GuiObject` or not. description: '' code_samples: [] type: GuiState @@ -389,8 +391,10 @@ properties: - UI writeCapabilities: [] - name: GuiObject.Interactable - summary: '' - description: '' + summary: | + Determines whether the `Class.GuiButton` can be interacted with or not. + description: | + code_samples: [] type: bool tags: [] From e953718fe98d676f30cd1391625bede326c55103 Mon Sep 17 00:00:00 2001 From: vifgaming1 <153995437+vifgaming1@users.noreply.github.com> Date: Sun, 20 Oct 2024 13:36:50 +0700 Subject: [PATCH 2/5] Descriptions Added long descriptions going into detail how it works --- .../reference/engine/classes/GuiObject.yaml | 24 ++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/content/en-us/reference/engine/classes/GuiObject.yaml b/content/en-us/reference/engine/classes/GuiObject.yaml index ad582f962..c1f3b43b5 100644 --- a/content/en-us/reference/engine/classes/GuiObject.yaml +++ b/content/en-us/reference/engine/classes/GuiObject.yaml @@ -372,7 +372,13 @@ properties: summary: | Determines whether the player's mouse is being actively pressed on the `Class.GuiObject` or not. - description: '' + 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: @@ -392,9 +398,21 @@ properties: writeCapabilities: [] - name: GuiObject.Interactable summary: | - Determines whether the `Class.GuiButton` can be interacted with or not. + Determines whether the `Class.GuiButton` can be interacted with or not, or if + the `Class.GuiObject`'s `Enum.GuiState|GuiState` is changing or not. description: | - + 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: [] From 919cd20019f5a48ddf9390aa141b009d8664a0c7 Mon Sep 17 00:00:00 2001 From: IgnisRBX <43388550+IgnisRBX@users.noreply.github.com> Date: Mon, 21 Oct 2024 08:38:33 -1000 Subject: [PATCH 3/5] Update content/en-us/reference/engine/classes/GuiObject.yaml --- content/en-us/reference/engine/classes/GuiObject.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/en-us/reference/engine/classes/GuiObject.yaml b/content/en-us/reference/engine/classes/GuiObject.yaml index c1f3b43b5..55f4944a5 100644 --- a/content/en-us/reference/engine/classes/GuiObject.yaml +++ b/content/en-us/reference/engine/classes/GuiObject.yaml @@ -373,11 +373,11 @@ properties: 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 + 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 + 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` + 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 From f9873430a6e050cc158458597ddff2bd4f584913 Mon Sep 17 00:00:00 2001 From: IgnisRBX <43388550+IgnisRBX@users.noreply.github.com> Date: Mon, 21 Oct 2024 08:38:40 -1000 Subject: [PATCH 4/5] Update content/en-us/reference/engine/classes/GuiObject.yaml --- content/en-us/reference/engine/classes/GuiObject.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/GuiObject.yaml b/content/en-us/reference/engine/classes/GuiObject.yaml index 55f4944a5..54a8af9cb 100644 --- a/content/en-us/reference/engine/classes/GuiObject.yaml +++ b/content/en-us/reference/engine/classes/GuiObject.yaml @@ -399,7 +399,7 @@ properties: - name: GuiObject.Interactable summary: | Determines whether the `Class.GuiButton` can be interacted with or not, or if - the `Class.GuiObject`'s `Enum.GuiState|GuiState` is changing or not. + the `Enum.GuiState|GuiState` of the `Class.GuiObject` is changing or not. description: | On a `Class.GuiButton`: - When the `Class.GuiObject.Interactable|Interactable` setting on the `Class.GuiButton` is From be71372e0119446254d6d31afee37dacc309dbbc Mon Sep 17 00:00:00 2001 From: IgnisRBX <43388550+IgnisRBX@users.noreply.github.com> Date: Mon, 21 Oct 2024 08:38:46 -1000 Subject: [PATCH 5/5] Update content/en-us/reference/engine/classes/GuiObject.yaml --- .../en-us/reference/engine/classes/GuiObject.yaml | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/content/en-us/reference/engine/classes/GuiObject.yaml b/content/en-us/reference/engine/classes/GuiObject.yaml index 54a8af9cb..7e3100719 100644 --- a/content/en-us/reference/engine/classes/GuiObject.yaml +++ b/content/en-us/reference/engine/classes/GuiObject.yaml @@ -401,18 +401,22 @@ properties: 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 + 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 + 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`. + 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. + set to `true`, the `Class.GuiObject.GuiState|GuiState` will behave normally again. code_samples: [] type: bool tags: []