SpawnComponent.h

#pragma once
 
#include <GameEngine/GameEngineDLL.h>
 
#include <Core/Prefabs/PrefabResource.h>
#include <Core/World/World.h>
#include <Foundation/Types/RangeView.h>
 
struct plMsgComponentInternalTrigger;
 
struct plSpawnComponentFlags
{
  using StorageType = plUInt16;
 
  enum Enum
  {
    None = 0,
    SpawnAtStart = PL_BIT(0),      
    SpawnContinuously = PL_BIT(1), 
    AttachAsChild = PL_BIT(2),     
    SpawnInFlight = PL_BIT(3),     
 
    Default = None
  };
 
  struct Bits
  {
    StorageType SpawnAtStart : 1;
    StorageType SpawnContinuously : 1;
    StorageType AttachAsChild : 1;
    StorageType SpawnInFlight : 1;
  };
};
 
PL_DECLARE_FLAGS_OPERATORS(plSpawnComponentFlags);
 
using plSpawnComponentManager = plComponentManager<class plSpawnComponent, plBlockStorageType::Compact>;
 
class PL_GAMEENGINE_DLL plSpawnComponent : public plComponent
{
  PL_DECLARE_COMPONENT_TYPE(plSpawnComponent, plComponent, plSpawnComponentManager);
 
  // plComponent
 
public:
  virtual void SerializeComponent(plWorldWriter& inout_stream) const override;
  virtual void DeserializeComponent(plWorldReader& inout_stream) override;
 
protected:
  virtual void OnSimulationStarted() override;
  virtual void OnDeactivated() override;
 
 
  // plSpawnComponent
 
public:
  plSpawnComponent();
  ~plSpawnComponent();
 
  bool CanTriggerManualSpawn() const; // [ scriptable ]
 
  bool TriggerManualSpawn(bool bIgnoreSpawnDelay = false, const plVec3& vLocalOffset = plVec3::MakeZero()); // [ scriptable ]
 
  void ScheduleSpawn(); // [ scriptable ]
 
  void SetPrefabFile(const char* szFile); // [ property ]
  const char* GetPrefabFile() const;      // [ property ]
 
  void SetSpawnAtStart(bool b); // [ property ]
  bool GetSpawnAtStart() const; // [ property ]
 
  void SetSpawnContinuously(bool b); // [ property ]
  bool GetSpawnContinuously() const; // [ property ]
 
  void SetAttachAsChild(bool b); // [ property ]
  bool GetAttachAsChild() const; // [ property ]
 
  void SetPrefab(const plPrefabResourceHandle& hPrefab);
  PL_ALWAYS_INLINE const plPrefabResourceHandle& GetPrefab() const { return m_hPrefab; }
 
  plTime m_MinDelay; // [ property ]
 
  plTime m_DelayRange; // [ property ]
 
  plAngle m_MaxDeviation; // [ property ]
 
  const plRangeView<const char*, plUInt32> GetParameters() const;   // [ property ] (exposed parameter)
  void SetParameter(const char* szKey, const plVariant& value);     // [ property ] (exposed parameter)
  void RemoveParameter(const char* szKey);                          // [ property ] (exposed parameter)
  bool GetParameter(const char* szKey, plVariant& out_value) const; // [ property ] (exposed parameter)
 
  plArrayMap<plHashedString, plVariant> m_Parameters;
 
protected:
  plBitflags<plSpawnComponentFlags> m_SpawnFlags;
 
  virtual void DoSpawn(const plTransform& tLocalSpawn);
  bool SpawnOnce(const plVec3& vLocalOffset);
  void OnTriggered(plMsgComponentInternalTrigger& msg);
 
  plTime m_LastManualSpawn;
  plPrefabResourceHandle m_hPrefab;
};