From e5cd58d20523667d255ec4be1fc94a5b725a9eae Mon Sep 17 00:00:00 2001
From: Mark Wilson <23439518+wlsnmrk@users.noreply.github.com>
Date: Mon, 22 Jan 2024 16:13:53 -0500
Subject: [PATCH] docs: fix action, mouse extensions return values
Fixed documented return values for action and mouse input extensions
to reflect that they are now void instead of returning Tasks.
---
GodotTestDriver/Input/ActionsControlExtensions.cs | 6 +-----
GodotTestDriver/Input/MouseControlExtensions.cs | 5 -----
2 files changed, 1 insertion(+), 10 deletions(-)
diff --git a/GodotTestDriver/Input/ActionsControlExtensions.cs b/GodotTestDriver/Input/ActionsControlExtensions.cs
index 2d69d69..e4e420f 100644
--- a/GodotTestDriver/Input/ActionsControlExtensions.cs
+++ b/GodotTestDriver/Input/ActionsControlExtensions.cs
@@ -36,9 +36,7 @@ string actionName
///
/// Node to supply input to.
/// Name of the action.
- /// Action strength (optional — default is 1.0).
- ///
- /// Task that completes when the input finishes.
+ /// Action strength (optional — default is 1.0).
public static void StartAction(
this Node node, string actionName, float strength = 1f
)
@@ -57,8 +55,6 @@ public static void StartAction(
///
/// Node to supply input to.
/// Name of the action.
-
- /// Task that completes when the input finishes.
public static void EndAction(this Node node, string actionName)
{
Input.ParseInputEvent(new InputEventAction
diff --git a/GodotTestDriver/Input/MouseControlExtensions.cs b/GodotTestDriver/Input/MouseControlExtensions.cs
index bcaa6f4..e8b2964 100644
--- a/GodotTestDriver/Input/MouseControlExtensions.cs
+++ b/GodotTestDriver/Input/MouseControlExtensions.cs
@@ -15,7 +15,6 @@ public static class MouseControlExtensions
/// Viewport.
/// Position, in viewport coordinates.
/// Mouse button.
- /// Task that completes when the input finishes.
public static void ClickMouseAt(this Viewport viewport, Vector2 position, MouseButton button = MouseButton.Left)
{
viewport.PressMouseAt(position, button);
@@ -27,7 +26,6 @@ public static void ClickMouseAt(this Viewport viewport, Vector2 position, MouseB
///
/// Viewport.
/// Position, in viewport coordinates.
- /// Task that completes when the input finishes.
public static void MoveMouseTo(this Viewport viewport, Vector2 position)
{
var oldPosition = viewport.GetMousePosition();
@@ -49,7 +47,6 @@ public static void MoveMouseTo(this Viewport viewport, Vector2 position)
/// Start position, in viewport coordinates.
/// End position, in viewport coordinates.
/// Mouse button.
- /// Task that completes when the input finishes.
public static void DragMouse(this Viewport viewport, Vector2 start, Vector2 end, MouseButton button = MouseButton.Left)
{
viewport.PressMouseAt(start, button);
@@ -61,7 +58,6 @@ public static void DragMouse(this Viewport viewport, Vector2 start, Vector2 end,
///
/// Viewport.
/// Mouse button (left by default).
- /// Task that completes when the input finishes.
public static void PressMouse(this Viewport _, MouseButton button = MouseButton.Left)
{
var action = new InputEventMouseButton
@@ -78,7 +74,6 @@ public static void PressMouse(this Viewport _, MouseButton button = MouseButton.
///
/// Viewport.
/// Mouse button (left by default).
- /// Task that completes when the input finishes.
public static void ReleaseMouse(this Viewport _, MouseButton button = MouseButton.Left)
{
var action = new InputEventMouseButton