EntityEmbarkationInformation.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----------------------
Contains embarkation information for an entity. Request using EntityEmbarkationInformationRequestMessage.
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreMessages/export.h>
#include <vlpi/entityIdentifier.h>
#include <vlpi/entityType.h>
#include <vector>
 
 
namespace makVre
{
 
 
constexpr const char* EntityEmbarkationInformationMessageType = "entity.query.embarkInfo";
 
class VREMESSAGES_DLL EntityEmbarkationInformationMessage : public makVre::DtVreMessage
{
public:
 
   struct VREMESSAGES_DLL ActionPoint
   {
      ActionPoint();
 
      int size() const;
      void serialize(DtStreamWriter& writer) const;
      void deserialize(DtStreamReader& reader);
      bool operator==(const ActionPoint& rhs) const;
      
      DtVector myPosition;
      int mySlot;
      std::string myName;
      std::string myType;
      std::string myDoor;
 
   };
 
 
   // Struct for defining data
   struct VREMESSAGES_DLL EntityEmbarkationInformationData 
   {
      EntityEmbarkationInformationData();
 
      DtEntityIdentifier myEntityId;
      DtEntityType myEmbarkerType;
      bool myIsEmbarked;
      bool mySlotsExist;
      std::vector<ActionPoint> myActionPoints;
 
      bool operator==(const EntityEmbarkationInformationData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static EntityEmbarkationInformationMessage* create();
   static EntityEmbarkationInformationMessage* createFrom(EntityEmbarkationInformationMessage*);
   static EntityEmbarkationInformationMessage* createFromData(const EntityEmbarkationInformationData);
   
   //! \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 ~EntityEmbarkationInformationMessage() override;
 
   virtual const DtEntityIdentifier& getEntityId() const;
   virtual void setEntityId(const DtEntityIdentifier& val);
 
   virtual const DtEntityType& getEmbarkerType() const;
   virtual void setEmbarkerType(const DtEntityType& val);
 
   virtual bool getIsEmbarked() const;
   virtual void setIsEmbarked(bool val);
 
   virtual bool getSlotsExist() const;
   virtual void setSlotsExist(bool val);
 
   virtual const std::vector<ActionPoint>& getActionPoints() const;
   virtual void setActionPoints(const std::vector<ActionPoint>& val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   EntityEmbarkationInformationData getData();
   EntityEmbarkationInformationData getData() const;
 
   // Operators
   bool operator==(const EntityEmbarkationInformationMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   EntityEmbarkationInformationMessage();
 
   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
   EntityEmbarkationInformationData myData;
};
 
} // ::makVre