From 038d5684a551e827eaa658be0ab9e986cbdbad62 Mon Sep 17 00:00:00 2001 From: kayomn Date: Thu, 12 Jan 2023 01:28:00 +0000 Subject: [PATCH] Fix wording of PlayerController.screen_to_plane doc comment --- player_controller.gd | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/player_controller.gd b/player_controller.gd index cb556ca..20a044b 100644 --- a/player_controller.gd +++ b/player_controller.gd @@ -192,8 +192,11 @@ func get_select_mode() -> int: return self._select_mode ## -## Converts and returns the screen coordinates in [code]screen_point[/code] into 2D worldspace -## coordinates relative to an infinite ground plane at a y offset of [code]0.0[/code]. +## Attempts to convert the screen coordinates in [code]screen_point[/code] into 2D worldspace +## coordinate relative to an infinite ground plane at y offset [code]0.0[/code]. +## +## Successful point intersection will return the plane coordinates in a [class Vector2], otherwise +## [code]null[/code] is returned. ## func screen_to_plane(screen_point: Vector2): if self._camera != null: