Cleanup of particle & particlespawner structures and code (#9893)

1 files changed, 73 insertions, 0 deletions

diff --git a/src/particles.h b/src/particles.h
new file mode 100644
index 000000000..659c1249f
--- /dev/null
+++ b/src/particles.h
@@ -0,0 +1,73 @@
+/*
+Minetest
+Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+*/
+
+#pragma once
+
+#include <string>
+#include "irrlichttypes_bloated.h"
+#include "tileanimation.h"
+
+// This file defines the particle-related structures that both the server and
+// client need. The ParticleManager and rendering is in client/particles.h
+
+struct CommonParticleParams {
+	bool collisiondetection = false;
+	bool collision_removal = false;
+	bool object_collision = false;
+	bool vertical = false;
+	std::string texture;
+	struct TileAnimationParams animation;
+	u8 glow = 0;
+
+	CommonParticleParams() {
+		animation.type = TAT_NONE;
+	}
+
+	/* This helper is useful for copying params from
+	 * ParticleSpawnerParameters to ParticleParameters */
+	inline void copyCommon(CommonParticleParams &to) const {
+		to.collisiondetection = collisiondetection;
+		to.collision_removal = collision_removal;
+		to.object_collision = object_collision;
+		to.vertical = vertical;
+		to.texture = texture;
+		to.animation = animation;
+		to.glow = glow;
+	}
+};
+
+struct ParticleParameters : CommonParticleParams {
+	v3f pos;
+	v3f vel;
+	v3f acc;
+	f32 expirationtime = 1;
+	f32 size = 1;
+
+	void serialize(std::ostream &os, u16 protocol_ver) const;
+	void deSerialize(std::istream &is, u16 protocol_ver);
+};
+
+struct ParticleSpawnerParameters : CommonParticleParams {
+	u16 amount = 1;
+	v3f minpos, maxpos, minvel, maxvel, minacc, maxacc;
+	f32 time = 1;
+	f32 minexptime = 1, maxexptime = 1, minsize = 1, maxsize = 1;
+
+	// For historical reasons no (de-)serialization methods here
+};