WeaponConfigResponse.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************************/
 
/*!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!This is an auto-generated file.  Any changes will be destroyed!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
Generated from: /data/exports/DEV-CAM-BML-043/nightly/3085/libsrc/framework/vreMessages/entity.lua
*/
/*-----------------COMMENT----------------------
Reponse to WeaponConfigRequest, contains properties of the entity's
           
weapons and the order in which they should be displayed.
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreMessages/export.h>
#include <vlpi/entityIdentifier.h>
#include <vector>
 
 
namespace makVre
{
 
 
constexpr const char* WeaponConfigResponseMessageType = "entityState.weapons.weaponConfig";
 
class VREMESSAGES_DLL WeaponConfigResponseMessage : public makVre::DtVreMessage
{
public:
 
   struct VREMESSAGES_DLL WeaponConfig
   {
      WeaponConfig();
 
      int size() const;
      void serialize(DtStreamWriter& writer) const;
      void deserialize(DtStreamReader& reader);
      bool operator==(const WeaponConfig& rhs) const;
      
      std::string myWeaponName;
      std::string myInterfaceName;
      std::string myCategory;
      int myMinRange;
      int myMaxRange;
      int myOptimalRange;
      int myInitialAmmoCount;
      std::string myTargetingMethod;
      std::string myFiringMethod;
      DtEntityType myMunitionType;
 
   };
 
 
   // Struct for defining data
   struct VREMESSAGES_DLL WeaponConfigResponseData 
   {
      WeaponConfigResponseData();
 
      DtEntityIdentifier myEntityId;
      std::vector<std::string> myDisplayOrder;
      std::vector<WeaponConfig> myWeaponConfig;
 
      bool operator==(const WeaponConfigResponseData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static WeaponConfigResponseMessage* create();
   static WeaponConfigResponseMessage* createFrom(WeaponConfigResponseMessage*);
   static WeaponConfigResponseMessage* createFromData(const WeaponConfigResponseData);
   
   //! \brief static message identity functions
   static const std::string& theType();
   static const makVre::DtVreMessageId& theId();
   static UInt64 theVersionNumber();
 
   //! \brief Get the name of the message type
   virtual const std::string& type() const override;
   virtual const makVre::DtVreMessageId& messageId() const override;
 
   // default destructor
   virtual ~WeaponConfigResponseMessage() override;
 
   virtual const DtEntityIdentifier& getEntityId() const;
   virtual void setEntityId(const DtEntityIdentifier& val);
 
   virtual const std::vector<std::string>& getDisplayOrder() const;
   virtual void setDisplayOrder(const std::vector<std::string>& val);
 
   virtual const std::vector<WeaponConfig>& getWeaponConfig() const;
   virtual void setWeaponConfig(const std::vector<WeaponConfig>& val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   WeaponConfigResponseData getData();
   WeaponConfigResponseData getData() const;
 
   // Operators
   bool operator==(const WeaponConfigResponseMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   WeaponConfigResponseMessage();
 
   virtual void serialize(DtStreamWriter& writer) const override;
   virtual void deserialize(DtStreamReader& reader) override;
 
protected:
   static makVre::DtVreMessageId theMessageId;
   static UInt64 theVersion;
 
   // Store the data for future use
   WeaponConfigResponseData myData;
};
 
} // ::makVre