From 96663d564602c7291182ea03b97c0729965a3d9c Mon Sep 17 00:00:00 2001
From: davidmarr <116632612+davidmarr@users.noreply.github.com>
Date: Thu, 28 Nov 2024 13:35:50 +0100
Subject: [PATCH] add SpriteConstants

---
 .../TEN/DisplaySprite/ScriptDisplaySprite.cpp |  8 ++---
 .../Internal/TEN/Objects/ObjectIDs.h          | 33 +++++++++++++++++++
 2 files changed, 37 insertions(+), 4 deletions(-)

diff --git a/TombEngine/Scripting/Internal/TEN/DisplaySprite/ScriptDisplaySprite.cpp b/TombEngine/Scripting/Internal/TEN/DisplaySprite/ScriptDisplaySprite.cpp
index 285a3a9ad..0135785fe 100644
--- a/TombEngine/Scripting/Internal/TEN/DisplaySprite/ScriptDisplaySprite.cpp
+++ b/TombEngine/Scripting/Internal/TEN/DisplaySprite/ScriptDisplaySprite.cpp
@@ -49,7 +49,7 @@ namespace TEN::Scripting::DisplaySprite
 
 	/// Create a DisplaySprite object.
 	// @function DisplaySprite()
-	// @tparam Objects.ObjID ID of the sprite sequence object.
+	// @tparam Objects.ObjID.SpriteConstants ID of the sprite sequence object.
 	// @tparam int int spriteID ID of the sprite in the sequence.
 	// @tparam Vec2 pos Display position in percent.
 	// @tparam float rot Rotation in degrees.
@@ -75,7 +75,7 @@ namespace TEN::Scripting::DisplaySprite
 
 	/// Get the object ID of the sprite sequence object used by the display sprite.
 	// @function DisplaySprite:GetObjectID()
-	// @treturn Objects.ObjID Sprite sequence object ID.
+	// @treturn Objects.ObjID.SpriteConstants Sprite sequence object ID.
 	GAME_OBJECT_ID ScriptDisplaySprite::GetObjectID() const
 	{
 		return _objectID;
@@ -122,8 +122,8 @@ namespace TEN::Scripting::DisplaySprite
 	}
 
 	/// Set the sprite sequence object ID used by the display sprite.
-	// @function DisplaySprite:SetObjectID(Objects.ObjID)
-	// @tparam Objects.ObjID New sprite sequence object ID.
+	// @function DisplaySprite:SetObjectID(Objects.ObjID.SpriteConstants)
+	// @tparam Objects.ObjID.SpriteConstants New sprite sequence object ID.
 	void ScriptDisplaySprite::SetObjectID(GAME_OBJECT_ID objectID)
 	{
 		_objectID = objectID;
diff --git a/TombEngine/Scripting/Internal/TEN/Objects/ObjectIDs.h b/TombEngine/Scripting/Internal/TEN/Objects/ObjectIDs.h
index 2f1e2e899..83f6e51a3 100644
--- a/TombEngine/Scripting/Internal/TEN/Objects/ObjectIDs.h
+++ b/TombEngine/Scripting/Internal/TEN/Objects/ObjectIDs.h
@@ -1197,6 +1197,39 @@ Table of constants.
 @table PickupConstants
 */
 
+/*** Objects.ObjID sprite constants.
+
+The following ObjID members refer to sprites.
+
+Table of constants:
+
+	SKY_GRAPHICS
+	DEFAULT_SPRITES
+	MISC_SPRITES
+	CUSTOM_SPRITES
+	FIRE_SPRITES
+	SMOKE_SPRITES
+	SPARK_SPRITE
+	DRIP_SPRITE
+	EXPLOSION_SPRITES
+	MOTORBOAT_FOAM_SPRITES
+	RUBBER_BOAT_WAVE_SPRITES
+	SKIDOO_SNOW_TRAIL_SPRITES
+	KAYAK_PADDLE_TRAIL_SPRITE
+	KAYAK_WAKE_SPRTIES
+	BINOCULAR_GRAPHIC
+	LASER_SIGHT_GRAPHIC
+	CAUSTICS_TEXTURES
+	BAR_BORDER_GRAPHIC
+	HEALTH_BAR_TEXTURE
+	AIR_BAR_TEXTURE
+	DASH_BAR_TEXTURE
+	SFX_BAR_TEXTURE
+	SPEEDOMETER
+	CUSTOM_BAR_GRAPHIC
+	CUSTOM_AMMO_GRAPHIC
+@table SpriteConstants
+*/
 static const std::unordered_map<std::string, GAME_OBJECT_ID> kObjIDs {
 	{ "LARA", ID_LARA },
 	{ "LARA_EXTRA_ANIMS", ID_LARA_EXTRA_ANIMS },