X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=src%2Ftouchscreengui.h;h=da97381cd4fc080616ec4cd0f864ab882c0b772f;hb=01c319d7784c3db614a53745e5af62c43cf45c90;hp=8dfec47d8abbfd904701978b7277e7d7ab275ea0;hpb=921151d97a2fb2238ab514324fb95e2732248b96;p=dragonfireclient.git

diff --git a/src/touchscreengui.h b/src/touchscreengui.h
index 8dfec47d8..da97381cd 100644
--- a/src/touchscreengui.h
+++ b/src/touchscreengui.h
@@ -154,6 +154,14 @@ class TouchScreenGUI
 
 	double getPitch() { return m_camera_pitch; }
 
+	/*!
+	 * Returns a line which describes what the player is pointing at.
+	 * The starting point and looking direction are significant,
+	 * the line should be scaled to match its length to the actual distance
+	 * the player can reach.
+	 * The line starts at the camera and ends on the camera's far plane.
+	 * The coordinates do not contain the camera offset.
+	 */
 	line3d<f32> getShootline() { return m_shootline; }
 
 	void step(float dtime);
@@ -178,6 +186,12 @@ class TouchScreenGUI
 	double m_camera_yaw_change = 0.0;
 	double m_camera_pitch = 0.0;
 
+	/*!
+	 * A line starting at the camera and pointing towards the
+	 * selected object.
+	 * The line ends on the camera's far plane.
+	 * The coordinates do not contain the camera offset.
+	 */
 	line3d<f32> m_shootline;
 
 	int m_move_id = -1;