Merge pull request #213 from cortex-command-community/lua-pemitter

Lua PEmitter

Author: garethyr

CHANGELOG.md

@@ -137,6 +137,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - GUI sliders (like for music volume) can now be adjusted with the mouse scroll wheel.
 
+- Exposed PEmitter to lua. Bindings are identical to AEmitter's bindings, except that damage-related bindings don't exist for PEmitter.
+
 ### Changed
 
 - Codebase now uses the C++17 standard.

Entities/PEmitter.h

@@ -25,7 +25,7 @@ namespace RTE
 //////////////////////////////////////////////////////////////////////////////////////////
 // Class:           PEmitter
 //////////////////////////////////////////////////////////////////////////////////////////
-// Description:     
+// Description:     A particle MO that creates and emits particle MOs.
 // Parent(s):       MOSParticle.
 // Class history:   02/29/2004 PEmitter created.
 
@@ -39,6 +39,7 @@ class PEmitter :
 
 public:
 
+	friend class LuaMan;
 
 	// Concrete allocation and cloning definitions
 	EntityAllocation(PEmitter)
@@ -328,6 +329,13 @@ class PEmitter :
 	void SetFlashScale(float flashScale = 1.0f) { m_FlashScale = flashScale; }
 
 
+	/// <summary>
+	/// Gets the display scale factor of the flash effect. This is purely visual.
+	/// </summary>
+	/// <returns>The scale factor of the flash draw.</returns>
+	float GetFlashScale() const { return m_FlashScale; }
+
+
 	//////////////////////////////////////////////////////////////////////////////////////////
 	// Method:          SetEmitAngle
 	//////////////////////////////////////////////////////////////////////////////////////////
@@ -464,6 +472,18 @@ class PEmitter :
 
 	void Draw(BITMAP *pTargetBitmap, const Vector &targetPos = Vector(), DrawMode mode = g_DrawColor, bool onlyPhysical = false) const override;
 
+	/// <summary>
+	/// Gets the number of emissions left before emitter is disabled.
+	/// </summary>
+	/// <returns>The number of emissions left before emitter is disabled.</returns>
+	long GetEmitCountLimit() const { return m_EmitCountLimit; }
+
+	/// <summary>
+	/// Sets the number of emissions left before emitter is disabled.
+	/// </summary>
+	/// <param name="newValue">New number of emissions left.</param>
+	void SetEmitCountLimit(long newValue) { m_EmitCountLimit = newValue; }
+
 	//////////////////////////////////////////////////////////////////////////////////////////
 	// Protected member variable and method declarations
 

Managers/LuaMan.cpp

@@ -31,6 +31,7 @@
 #include "TDExplosive.h"
 #include "ThrownDevice.h"
 #include "Turret.h"
+#include "PEmitter.h"
 
 #include "DataModule.h"
 #include "GAScripted.h"
@@ -206,6 +207,7 @@ LUAENTITYCREATE(HDFirearm)
 LUAENTITYCREATE(ThrownDevice)
 LUAENTITYCREATE(TDExplosive)
 LUAENTITYCREATE(TerrainObject)
+LUAENTITYCREATE(PEmitter)
 
 
 //////////////////////////////////////////////////////////////////////////////////////////
@@ -250,6 +252,7 @@ LUAENTITYCLONE(HDFirearm)
 LUAENTITYCLONE(ThrownDevice)
 LUAENTITYCLONE(TDExplosive)
 LUAENTITYCLONE(TerrainObject)
+LUAENTITYCLONE(PEmitter)
 
 //////////////////////////////////////////////////////////////////////////////////////////
 // Explicit deletion of any Entity instance that Lua owns.. it will probably be handled
@@ -316,6 +319,7 @@ LUAENTITYCAST(HDFirearm)
 LUAENTITYCAST(ThrownDevice)
 LUAENTITYCAST(TDExplosive)
 LUAENTITYCAST(TerrainObject)
+LUAENTITYCAST(PEmitter)
 
 
 //////////////////////////////////////////////////////////////////////////////////////////
@@ -837,6 +841,24 @@ int LuaMan::Create() {
             .def("CanTriggerBurst", &AEmitter::CanTriggerBurst)
 			.def_readwrite("Emissions", &AEmitter::m_EmissionList, return_stl_iterator),
 
+		CONCRETELUABINDING(PEmitter, MOSParticle)
+			.def("IsEmitting", &PEmitter::IsEmitting)
+			.def("EnableEmission", &PEmitter::EnableEmission)
+			.property("BurstScale", &PEmitter::GetBurstScale, &PEmitter::SetBurstScale)
+			.property("EmitAngle", &PEmitter::GetEmitAngle, &PEmitter::SetEmitAngle)
+			.property("GetThrottle", &PEmitter::GetThrottle, &PEmitter::SetThrottle)
+			.property("Throttle", &PEmitter::GetThrottle, &PEmitter::SetThrottle)
+			.property("BurstSpacing", &PEmitter::GetBurstSpacing, &PEmitter::SetBurstSpacing)
+			.property("EmitCountLimit", &PEmitter::GetEmitCountLimit, &PEmitter::SetEmitCountLimit)
+			.property("FlashScale", &PEmitter::GetFlashScale, &PEmitter::SetFlashScale)
+			.def("GetEmitVector", &PEmitter::GetEmitVector)
+			.def("GetRecoilVector", &PEmitter::GetRecoilVector)
+			.def("EstimateImpulse", &PEmitter::EstimateImpulse)
+			.def("TriggerBurst", &PEmitter::TriggerBurst)
+			.def("IsSetToBurst", &PEmitter::IsSetToBurst)
+			.def("CanTriggerBurst", &PEmitter::CanTriggerBurst)
+			.def_readwrite("Emissions", &PEmitter::m_EmissionList, return_stl_iterator),
+
 		CONCRETELUABINDING(Actor, MOSRotating)
 			.enum_("Status")[
 				value("STABLE", Actor::Status::STABLE),