VR-Engage  2.2
Loading...
Searching...
No Matches
reset.h
Go to the documentation of this file.
1/*********************************************************************************
2** Copyright (c) 2025 MAK Technologies, Inc.
3** All rights reserved.
4*********************************************************************************/
5
6/*!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
7!!!!!!!!!This is an auto-generated file. Any changes will be destroyed!!!!!!!!!!!
8!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
9Generated from: /data/exports/DEV-CAM-BML-043/nightly/3085/libsrc/framework/vreMessages/reset.lua
10*/
11/*-----------------COMMENT----------------------
12Sent when the reset action menu option is selected. Causes the DtEntityControlLogic to send a ResetSimPlayerMessage.
13-------------------COMMENT----------------------*/
14#pragma once
15
18#include <vreMessages/export.h>
19
20
21namespace makVre
22{
23
24
25constexpr const char* ResetMessageType = "player.reset";
26
28{
29public:
30
31
32 // Struct for defining data
34 {
36
38
39 bool operator==(const ResetData& rhs) const;
40 };
41
42 // Default static creators to promote the usage of not using new.
46
47 //! \brief static message identity functions
48 static const std::string& theType();
51
52 //! \brief Get the name of the message type
53 virtual const std::string& type() const override;
54 virtual const makVre::DtVreMessageId& messageId() const override;
55
56 // default destructor
57 virtual ~ResetMessage() override;
58
59 virtual bool getInPlace() const;
60 virtual void setInPlace(bool val);
61
62
63 // Accessors
64 virtual int messageSize() const override;
65 static makVre::DtVreMessage* decode(char* buffer, int length);
68
69 // Operators
70 bool operator==(const ResetMessage& rhs) const;
71
72protected:
73 // Inaccessible default constructor to promote the usage of the static creator functions
75
76 virtual void serialize(DtStreamWriter& writer) const override;
77 virtual void deserialize(DtStreamReader& reader) override;
78
79protected:
82
83 // Store the data for future use
85};
86
87} // ::makVre
88
89
90
Reader class for decoding values from a byte array.
Definition byteStream.h:42
Writer class for encoding values into a byte array.
Definition byteStream.h:161
Abstract base class for all VREngage messages.
Definition vreMessage.h:50
Message identifier class for the VREngage messaging system.
Definition vreMessageId.h:35
virtual void deserialize(DtStreamReader &reader) override
Deserializes the message from a stream reader.
virtual void serialize(DtStreamWriter &writer) const override
Serializes the message to a stream writer.
static makVre::DtVreMessageId theMessageId
Definition reset.h:80
virtual const std::string & type() const override
Get the name of the message type.
static const std::string & theType()
static message identity functions
static ResetMessage * createFromData(const ResetData)
static UInt64 theVersionNumber()
virtual const makVre::DtVreMessageId & messageId() const override
Gets the message ID object.
static const makVre::DtVreMessageId & theId()
ResetData getData() const
static ResetMessage * createFrom(ResetMessage *)
static UInt64 theVersion
Definition reset.h:81
virtual ~ResetMessage() override
ResetData myData
Definition reset.h:84
static makVre::DtVreMessage * decode(char *buffer, int length)
virtual bool getInPlace() const
bool operator==(const ResetMessage &rhs) const
virtual int messageSize() const override
Static decode function pattern for derived classes.
virtual void setInPlace(bool val)
static ResetMessage * create()
Defines export macros for the VREngage Messages library.
#define VREMESSAGES_DLL
Export/import macro for non-Windows platforms.
Definition export.h:39
Include export definitions for this library.
Definition glsVreMessageUtil.h:49
unsigned long long UInt64
Unsigned 64-bit integer type.
Definition utilFunctions.h:42
constexpr const char * ResetMessageType
Definition reset.h:25
Definition reset.h:34
bool myInPlace
Definition reset.h:37
bool operator==(const ResetData &rhs) const
Defines the base class for all VREngage messages.
Defines message identifier class for the VREngage messaging system.