scriptWeaponInfo.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2023 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
#pragma once

#include <vrfLua/vrfLuaDefines.h>

#include <vrfutil/asciiSerializable.h>
#include <vlutil/vlString.h>
#include <list>
#include <luabind/object.hpp>

class DtSimulationServices;
class DtLocalObject;
class DtWeaponInfoInterface;
class DtLocation3D;

class DT_DLL_vrfLua DtScriptWeaponInfo
   : public DtAsciiSerializable
{
private:
   DtScriptWeaponInfo();
public:
   DtScriptWeaponInfo(const DtLocalObject* vrfObject);

   DtScriptWeaponInfo(const DtScriptWeaponInfo& orig);

   DtScriptWeaponInfo& operator=(const DtScriptWeaponInfo& orig);

   virtual ~DtScriptWeaponInfo() override;

   bool operator==(const DtScriptWeaponInfo& orig);


   bool isValid() const;

   void setWeaponInfo(const DtString& weaponId, const DtWeaponInfoInterface* weaponInfo);
   std::string weaponId() const;

   std::string getDisplayName() const;
   bool isReady() const;
   int getStatus() const;
   std::string getStatusString() const;
   int getTurret() const;
   bool getControlExternalTurret() const;
   std::list<std::string> getFireTasks() const;
   std::list<std::string> getResourceNames() const;
   bool canTargetLocation(const DtLocation3D& location) const;
   double maximumRange() const;
   double minimumRange() const;
   int targetApplicability(const std::string& targetType) const;
   bool targetAmmunition(const std::string& targetType) const;
   luabind::object createFireTask(lua_State* L, luabind::object const& luaLocationRef) const;
   bool isAutonomousFire() const;
   bool isAutonomousFireType(const std::string& targetType) const;
   luabind::object weaponProperty(lua_State* L, const std::string& propertyName) const;
   bool isBlockedByOtherWeapon(std::string& blockingWeaponId) const;
   bool conflictsWithOtherWeapon(const std::string& otherWeaponId) const;


   virtual DtString serialize() override;

   virtual void init(const DtSimulationServices*, DtLocalObject* owner);

   virtual bool deserialize(const DtString& data) override;

   virtual DtString objectType() const override;

   //default values
   static DtAsciiSerializable* creator();


protected:
   void throwIfNotValid() const;

protected:
   const DtSimulationServices* mySimServices;
   const DtLocalObject* myObject;
   const DtWeaponInfoInterface* myWeaponInfo;
   std::string myWeaponId;
};

DT_DEFINE_OBJECT_DEBUGGER_NAME(DtScriptWeaponInfo);

DT_DLL_vrfLua std::ostream& operator<<(std::ostream&, const DtScriptWeaponInfo&);