From 0afd4d5ac1fa0c754abb326c6a6ff3c69b98ef87 Mon Sep 17 00:00:00 2001 From: Munsterlander Date: Sun, 13 Aug 2023 16:16:42 -0700 Subject: [PATCH 1/3] Initial Commit --- doc/flame/inputs/drag_events.md | 8 ++++++-- doc/flame/inputs/tap_events.md | 8 ++++++-- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/doc/flame/inputs/drag_events.md b/doc/flame/inputs/drag_events.md index e8675f3215b..9e6df4ecd88 100644 --- a/doc/flame/inputs/drag_events.md +++ b/doc/flame/inputs/drag_events.md @@ -1,8 +1,12 @@ # Drag Events ```{note} -This document describes the new drag events API. The old (legacy) approach, -which is still supported, is described in [](gesture_input.md). +This document describes the new drag events API. It is important to note that when the first +draggable component is added to the game, `FlameGame` must temporarily remove itself and run the +`GestureDetectorBuilder` which will add a gesture detector as the first child to `FlameGame`, and +then re-add the `FlameGame`. As such, `FlameGame`'s `onRemove` event will be triggered. A simple +boolean flag can be used to ignore this event if your game is using the `onRemove` event. The old +(legacy) approach, which is still supported, is described in [](gesture_input.md). ``` **Drag events** occur when the user moves their finger across the screen of the device, or when they diff --git a/doc/flame/inputs/tap_events.md b/doc/flame/inputs/tap_events.md index 7f2c331bfba..c4a6ede8067 100644 --- a/doc/flame/inputs/tap_events.md +++ b/doc/flame/inputs/tap_events.md @@ -1,8 +1,12 @@ # Tap Events ```{note} -This document describes the new tap events API. The old (legacy) approach, -which is still supported, is described in [](gesture_input.md). +This document describes the new tap events API. It is important to note that when the first +tappable component is added to the game, `FlameGame` must temporarily remove itself and run the +`GestureDetectorBuilder` which will add a gesture detector as the first child to `FlameGame`, and +then re-add the `FlameGame`. As such, `FlameGame`'s `onRemove` event will be triggered. A simple +boolean flag can be used to ignore this event if your game is using the `onRemove` event. The old +(legacy) approach, which is still supported, is described in [](gesture_input.md). ``` **Tap events** are one of the most basic methods of interaction with a Flame game. These events From 92d6a3ce345f21daac05e9e8fcc9b5439c5ab3be Mon Sep 17 00:00:00 2001 From: Munsterlander Date: Sun, 13 Aug 2023 16:19:45 -0700 Subject: [PATCH 2/3] Line length --- doc/flame/inputs/drag_events.md | 14 ++++++++------ doc/flame/inputs/tap_events.md | 14 ++++++++------ 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/doc/flame/inputs/drag_events.md b/doc/flame/inputs/drag_events.md index 9e6df4ecd88..70cb895fb10 100644 --- a/doc/flame/inputs/drag_events.md +++ b/doc/flame/inputs/drag_events.md @@ -1,12 +1,14 @@ # Drag Events ```{note} -This document describes the new drag events API. It is important to note that when the first -draggable component is added to the game, `FlameGame` must temporarily remove itself and run the -`GestureDetectorBuilder` which will add a gesture detector as the first child to `FlameGame`, and -then re-add the `FlameGame`. As such, `FlameGame`'s `onRemove` event will be triggered. A simple -boolean flag can be used to ignore this event if your game is using the `onRemove` event. The old -(legacy) approach, which is still supported, is described in [](gesture_input.md). +This document describes the new drag events API. It is important to note that +when the first draggable component is added to the game, `FlameGame` must +temporarily remove itself and run the `GestureDetectorBuilder` which will add a +gesture detector as the first child to `FlameGame`, and then re-add the +`FlameGame`. As such, `FlameGame`'s `onRemove` event will be triggered. A +simple boolean flag can be used to ignore this event if your game is using the +`onRemove` event. The old (legacy) approach, which is still supported, is +described in [](gesture_input.md). ``` **Drag events** occur when the user moves their finger across the screen of the device, or when they diff --git a/doc/flame/inputs/tap_events.md b/doc/flame/inputs/tap_events.md index c4a6ede8067..ffc44fc0f1d 100644 --- a/doc/flame/inputs/tap_events.md +++ b/doc/flame/inputs/tap_events.md @@ -1,12 +1,14 @@ # Tap Events ```{note} -This document describes the new tap events API. It is important to note that when the first -tappable component is added to the game, `FlameGame` must temporarily remove itself and run the -`GestureDetectorBuilder` which will add a gesture detector as the first child to `FlameGame`, and -then re-add the `FlameGame`. As such, `FlameGame`'s `onRemove` event will be triggered. A simple -boolean flag can be used to ignore this event if your game is using the `onRemove` event. The old -(legacy) approach, which is still supported, is described in [](gesture_input.md). +This document describes the new tap events API. It is important to note that +when the first tappable component is added to the game, `FlameGame` must +temporarily remove itself and run the `GestureDetectorBuilder` which will add a +gesture detector as the first child to `FlameGame`, and then re-add the +`FlameGame`. As such, `FlameGame`'s `onRemove` event will be triggered. A +simple boolean flag can be used to ignore this event if your game is using the +`onRemove` event. The old (legacy) approach, which is still supported, is +described in [](gesture_input.md). ``` **Tap events** are one of the most basic methods of interaction with a Flame game. These events From 5ebc83355eb291978f2e5d9ee58bde44795c3ee7 Mon Sep 17 00:00:00 2001 From: Munsterlander Date: Sun, 13 Aug 2023 16:28:44 -0700 Subject: [PATCH 3/3] Clarified the message --- doc/flame/inputs/drag_events.md | 9 ++++----- doc/flame/inputs/tap_events.md | 9 ++++----- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/doc/flame/inputs/drag_events.md b/doc/flame/inputs/drag_events.md index 70cb895fb10..f25c8c7db28 100644 --- a/doc/flame/inputs/drag_events.md +++ b/doc/flame/inputs/drag_events.md @@ -4,11 +4,10 @@ This document describes the new drag events API. It is important to note that when the first draggable component is added to the game, `FlameGame` must temporarily remove itself and run the `GestureDetectorBuilder` which will add a -gesture detector as the first child to `FlameGame`, and then re-add the -`FlameGame`. As such, `FlameGame`'s `onRemove` event will be triggered. A -simple boolean flag can be used to ignore this event if your game is using the -`onRemove` event. The old (legacy) approach, which is still supported, is -described in [](gesture_input.md). +gesture detector as the first child to `FlameGame`, and then re-add itelf. As +such, `FlameGame`'s `onRemove` event will be triggered. A simple boolean flag +can be used to ignore this event if your game is using the `onRemove` event. +The old (legacy) approach, which is still supported, is described in [](gesture_input.md). ``` **Drag events** occur when the user moves their finger across the screen of the device, or when they diff --git a/doc/flame/inputs/tap_events.md b/doc/flame/inputs/tap_events.md index ffc44fc0f1d..28c925c0ef8 100644 --- a/doc/flame/inputs/tap_events.md +++ b/doc/flame/inputs/tap_events.md @@ -4,11 +4,10 @@ This document describes the new tap events API. It is important to note that when the first tappable component is added to the game, `FlameGame` must temporarily remove itself and run the `GestureDetectorBuilder` which will add a -gesture detector as the first child to `FlameGame`, and then re-add the -`FlameGame`. As such, `FlameGame`'s `onRemove` event will be triggered. A -simple boolean flag can be used to ignore this event if your game is using the -`onRemove` event. The old (legacy) approach, which is still supported, is -described in [](gesture_input.md). +gesture detector as the first child to `FlameGame`, and then re-add itself. As +such, `FlameGame`'s `onRemove` event will be triggered. A simple boolean flag +can be used to ignore this event if your game is using the `onRemove` event. +The old (legacy) approach, which is still supported, is described in [](gesture_input.md). ``` **Tap events** are one of the most basic methods of interaction with a Flame game. These events