Added bool m_SpriteModified to MOSprites to check whether or not their sprites have been modified so the extras can be deleted on Destroy

Added documentation in MOSprite.h
Implemented MOSprite:SetPixelIndex()
Implemented MOSprite:GetAllVisiblePixelPositions()
Fixed GetAllPixelPositions not accounting for sprite offset properly
Exposed to Lua as necessary
Changed GetAllPixelPositions to have an ignoreIndex and invert bool instead of an ignoreTransparency bool

Author: comradeshook

Source/Entities/MOSprite.cpp

@@ -42,6 +42,7 @@ void MOSprite::Clear() {
 	m_SettleMaterialDisabled = false;
 	m_pEntryWound = 0;
 	m_pExitWound = 0;
+	m_SpriteModified = false;
 }
 
 int MOSprite::Create() {
@@ -235,6 +236,12 @@ void MOSprite::Destroy(bool notInherited) {
 	//    delete m_pEntryWound; Not doing this anymore since we're not owning
 	//    delete m_pExitWound;
 
+	if (m_SpriteModified) {
+		for (BITMAP* sprite : m_aSprite) {
+			destroy_bitmap(sprite);
+		}
+	}
+
 	if (!notInherited)
 		MovableObject::Destroy();
 	Clear();
@@ -351,13 +358,36 @@ Vector MOSprite::UnRotateOffset(const Vector& offset) const {
 	return rotOff;
 }
 
-std::vector<Vector>* MOSprite::GetAllPixelPositions(const Vector& origin, float angle, bool hflipped, bool includeTransparency, unsigned int whichFrame) {
+void MOSprite::SetPixelIndex(int x, int y, unsigned int whichFrame, int colorIndex, int ignoreIndex, bool invert) {
+	if (!m_SpriteModified) {
+		std::vector<BITMAP*> spriteList;
+
+		for (BITMAP* sprite: m_aSprite) {
+			BITMAP* spriteCopy = create_bitmap_ex(8, sprite->w, sprite->h);
+			rectfill(spriteCopy, 0, 0, spriteCopy->w - 1, spriteCopy->h - 1, 0);
+			draw_sprite(spriteCopy, sprite, 0, 0);
+			spriteList.push_back(spriteCopy);
+		}
+
+		m_aSprite = spriteList;
+		m_SpriteModified = true;
+	}
+
+	BITMAP* targetSprite = m_aSprite[CLAMP(m_FrameCount - 1, 0, whichFrame)];
+	if (ignoreIndex < 0 || (getpixel(targetSprite, x, y) == ignoreIndex) != invert) {
+		putpixel(targetSprite, x, y, colorIndex);
+	}
+}
+
+std::vector<Vector>* MOSprite::GetAllPixelPositions(const Vector& origin, float angle, bool hflipped, unsigned int whichFrame, int ignoreIndex, bool invert) {
 	std::vector<Vector>* posList = new std::vector<Vector>();
 	CLAMP(m_FrameCount - 1, 0, whichFrame);
 	BITMAP* sprite = m_aSprite[whichFrame];
-	BITMAP* temp = create_bitmap_ex(8, m_SpriteDiameter * m_Scale, m_SpriteDiameter * m_Scale);
+	BITMAP* temp = create_bitmap_ex(8, m_SpriteDiameter, m_SpriteDiameter);
 	rectfill(temp, 0, 0, temp->w - 1, temp->h - 1, 0);
-	Vector offset = Vector(temp->w / 2 + m_SpriteOffset.m_X, temp->h / 2 + m_SpriteOffset.m_Y);
+	Vector tempCentre = Vector(temp->w / 2, temp->h / 2);
+	Vector spriteCentre = Vector(sprite->w / 2, sprite->h / 2);
+	Vector offset = (tempCentre + (m_SpriteOffset + spriteCentre).GetXFlipped(m_HFlipped).RadRotate(m_Rotation.GetRadAngle()) - spriteCentre);
 
 	if (!hflipped) {
 		rotate_scaled_sprite(temp, sprite, offset.m_X, offset.m_Y, ftofix(GetAllegroAngle(-m_Rotation.GetDegAngle())), ftofix(m_Scale));
@@ -368,15 +398,14 @@ std::vector<Vector>* MOSprite::GetAllPixelPositions(const Vector& origin, float
 	for (int y = 0; y < temp->h; y++) {
 		for (int x = 0; x < temp->w; x++) {
 			int pixelIndex = getpixel(temp, x, y);
-			if (includeTransparency || pixelIndex > 0) {
-				Vector pixelPos = (Vector(x - temp->w / 2, y - temp->h / 2)) + origin;
-				posList->push_back(pixelPos.GetRounded());
+			if (pixelIndex >= 0 && (pixelIndex != ignoreIndex) != invert) {
+				Vector pixelPos = (Vector(x, y) - tempCentre) + origin;
+				posList->push_back(pixelPos);
 			}
 		}
 	}
 
 	destroy_bitmap(temp);
-	temp = NULL;
 	return posList;
 }
 

Source/Entities/MOSprite.h

@@ -90,9 +90,35 @@ namespace RTE {
 		/// Ownership is NOT transferred!
 		BITMAP* GetSpriteFrame(unsigned int whichFrame = 0) const { return (whichFrame < m_FrameCount) ? m_aSprite[whichFrame] : 0; }
 
+		/// Gets the color index of the pixel at position (X, Y) in the sprite bitmap
+		/// @param x X coordinate on the bitmap of the pixel to get.
+		/// @param y Y coordinate on the bitmap of the pixel to get.
+		/// @param whichFrame Which frame of the sprite sequence to check.
+		/// @return Color index of the indicated pixel.
 		int GetPixelIndex(int x, int y, unsigned int whichFrame = 0) const { return getpixel(m_aSprite[CLAMP(m_FrameCount - 1, 0, whichFrame)], x, y); }
 
-		std::vector<Vector>* GetAllPixelPositions(const Vector& origin, float angle, bool hflipped, bool includeTransparency, unsigned int whichFrame);
+		/// Sets the color index of the pixel at position (X, Y) in the sprite bitmap
+		/// @param x X coordinate on the bitmap of the pixel to set.
+		/// @param y Y coordinate on the bitmap of the pixel to set.
+		/// @param whichFrame Which frame of the sprite sequence to affect.
+		/// @param colorIndex Desired color index of the indicated pixel.
+		/// @param ignoreIndex Avoid setting pixel colour if it has this color index; set below 0 to disable.
+		/// @param invert Whether or not to invert the ignoreIndex so it ONLY colors that index.
+		void SetPixelIndex(int x, int y, unsigned int whichFrame, int colorIndex, int ignoreIndex, bool invert);
+
+		/// Returns a list of vectors pointing to all matching pixels of the given frame in the sprite, accounting for flipping, rotation and scale.
+		/// @param origin The position around which the vectors are centered.
+		/// @param angle The angle at which the sprite is rotated.
+		/// @param hflipped Whether or not the sprite is flipped horizontally.
+		/// @param whichFrame Which frame of the sprite sequence to check.
+		/// @param ignoreIndex Which color index to ignore when checking; set below 0 to include everything.
+		/// @param invert Whether or not to invert the above check so it ONLY counts that index.
+		/// @return List of vectors pointing to all visible pixels of the given frame in the sprite.
+		std::vector<Vector>* GetAllPixelPositions(const Vector& origin, float angle, bool hflipped, unsigned int whichFrame, int ignoreIndex, bool invert);
+
+		/// Returns a list of vectors pointing to all visible pixels of the given frame in the sprite, accounting for flipping, rotation and scale.
+		/// @return List of vectors pointing to all visible pixels of the given frame in the sprite.
+		std::vector<Vector>* GetAllVisiblePixelPositions() { return GetAllPixelPositions(m_Pos, m_Rotation.GetRadAngle(), m_HFlipped, m_Frame, 0, false); };
 
 		/// Gets the width of the bitmap of this MOSprite
 		/// @return Sprite width if loaded.
@@ -345,6 +371,8 @@ namespace RTE {
 		const AEmitter* m_pEntryWound;
 		// Exit wound template
 		const AEmitter* m_pExitWound;
+		// Whether or not the sprite has been modified
+		bool m_SpriteModified;
 
 		/// Private member variable and method declarations
 	private:

Source/Lua/LuaBindingsEntities.cpp

@@ -837,6 +837,8 @@ LuaBindingRegisterFunctionDefinitionForType(EntityLuaBindings, MOSprite) {
 	    .def("GetEntryWoundPresetName", &MOSprite::GetEntryWoundPresetName)
 	    .def("GetExitWoundPresetName", &MOSprite::GetExitWoundPresetName)
 	    .def("GetPixelIndex", &MOSprite::GetPixelIndex)
+	    .def("SetPixelIndex", &MOSprite::SetPixelIndex)
+	    .def("GetAllVisiblePixelPositions", &MOSprite::GetAllVisiblePixelPositions, luabind::return_stl_iterator)
 	    .def("GetAllPixelPositions", &MOSprite::GetAllPixelPositions, luabind::return_stl_iterator)
 
 	    .enum_("SpriteAnimMode")[luabind::value("NOANIM", SpriteAnimMode::NOANIM),