From cd16268e19ce65e80aba4d8db5edbb90c71c7188 Mon Sep 17 00:00:00 2001
From: hispidence <squidshirehimself@gmail.com>
Date: Thu, 12 Aug 2021 19:58:22 +0100
Subject: [PATCH] Actually add documentation.

---
 TR5Main/Scripting/GameLogicScript.cpp | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/TR5Main/Scripting/GameLogicScript.cpp b/TR5Main/Scripting/GameLogicScript.cpp
index 73b9203b4..832424a18 100644
--- a/TR5Main/Scripting/GameLogicScript.cpp
+++ b/TR5Main/Scripting/GameLogicScript.cpp
@@ -264,7 +264,29 @@ Get a SinkInfo by its name.
 */
 	m_lua->set_function("GetSinkByName", &GameScript::GetSinkByName, this);
 
+/***
+Get a SoundSourceInfo by its name.
+@function GetSoundSourceByName
+@tparam string name the unique name of the sink as set in, or generated by, Tomb Editor
+@treturn SoundSourceInfo a non-owning SoundSourceInfo referencing the sink.
+*/
+	m_lua->set_function("GetSoundSourceByName", &GameScript::GetSoundSourceByName, this);
+
+/***
+Calculate the distance between two positions.
+@function CalculateDistance
+@tparam Position posA first position
+@tparam Position posB second position
+@treturn int the direct distance from one position to the other
+*/
 	m_lua->set_function("CalculateDistance", &CalculateDistance);
+/***
+Calculate the horizontal distance between two positions.
+@function CalculateHorizontalDistance
+@tparam Position posA first position
+@tparam Position posB second position
+@treturn int the direct distance on the XZ plane from one position to the other
+*/
 	m_lua->set_function("CalculateHorizontalDistance", &CalculateHorizontalDistance);
 
 	MakeReadOnlyTable("ObjID", kObjIDs);