Added MOSprite property IconFile which can be used to display a separate sprite in GUI elements.

Author: fourZK

Entities/MOSprite.cpp

@@ -30,6 +30,8 @@ void MOSprite::Clear()
 {
     m_SpriteFile.Reset();
     m_aSprite.clear();
+	m_IconFile.Reset();
+	m_GraphicalIcon = nullptr;
     m_FrameCount = 1;
     m_SpriteOffset.Reset();
     m_Frame = 0;
@@ -128,6 +130,8 @@ int MOSprite::Create(const MOSprite &reference)
         return -1;
 
     m_SpriteFile = reference.m_SpriteFile;
+	m_IconFile = reference.m_IconFile;
+	m_GraphicalIcon = m_IconFile.GetAsBitmap();
 
     m_FrameCount = reference.m_FrameCount;
     m_Frame = reference.m_Frame;
@@ -159,11 +163,13 @@ int MOSprite::Create(const MOSprite &reference)
 //                  is called. If the property isn't recognized by any of the base classes,
 //                  false is returned, and the reader's position is untouched.
 
-int MOSprite::ReadProperty(const std::string_view &propName, Reader &reader)
-{
-    if (propName == "SpriteFile")
-        reader >> m_SpriteFile;
-	else if (propName == "FrameCount") {
+int MOSprite::ReadProperty(const std::string_view &propName, Reader &reader) {
+	if (propName == "SpriteFile") {
+		reader >> m_SpriteFile;
+	} else if (propName == "IconFile") {
+		reader >> m_IconFile;
+		m_GraphicalIcon = m_IconFile.GetAsBitmap();
+	} else if (propName == "FrameCount") {
 		reader >> m_FrameCount;
 		m_aSprite.reserve(m_FrameCount);
 	} else if (propName == "SpriteOffset")

Entities/MOSprite.h

@@ -387,16 +387,12 @@ class MOSprite : public MovableObject {
 	void SetAngularVel(float newRotVel) override { m_AngularVel = newRotVel; }
 
 
-//////////////////////////////////////////////////////////////////////////////////////////
-// Method:          GetGraphicalIcon
-//////////////////////////////////////////////////////////////////////////////////////////
-// Description:     Gets a bitmap showing a good identifyable icon of this, for use in
-//                  GUI lists etc.
-// Arguments:       None.
-// Return value:    A good identifyable graphical representation of this in a BITMAP, if
-//                  available. If not, 0 is returned. Ownership is NOT TRANSFERRED!
+	/// <summary>
+	/// Gets the GUI representation of this MOSprite, either based on the first frame of its sprite or separately defined icon file.
+	/// </summary>
+	/// <returns>The graphical representation of this MOSprite as a BITMAP.</returns>
+	BITMAP *GetGraphicalIcon() const override { return m_GraphicalIcon != nullptr ? m_GraphicalIcon : m_aSprite[0]; }
 
-    BITMAP * GetGraphicalIcon() const override { return m_aSprite[0]; }
 
 
 //////////////////////////////////////////////////////////////////////////////////////////
@@ -572,6 +568,8 @@ class MOSprite : public MovableObject {
     ContentFile m_SpriteFile;
     // Vector of pointers to BITMAPs representing the multiple frames of this sprite.
     std::vector<BITMAP *> m_aSprite;
+	ContentFile m_IconFile;	//!< The file containing the GUI icon.
+	BITMAP *m_GraphicalIcon;	//!< The GUI representation of this MOSprite as a BITMAP.
     // Number of frames, or elements in the m_aSprite array.
     unsigned int m_FrameCount;
     Vector m_SpriteOffset;