DMA for RValues

- Add GetMember, GetRefMember, GetMemberCount for RValue, to prevent pointers being restricted to ToMap()

Author: Archie-osu

ExamplePlugin/include/YYToolkit/YYTK_Shared_Base.hpp

@@ -24,7 +24,7 @@
 #endif // YYTK_MINOR
 
 #ifndef YYTK_PATCH
-#define YYTK_PATCH 0
+#define YYTK_PATCH 1
 #endif
 
 #ifndef YYTK_VERSION_STRING

ExamplePlugin/include/YYToolkit/YYTK_Shared_Interface.hpp

@@ -234,7 +234,7 @@ namespace YYTK
 
 		/**
 		* \brief Retrieves the engine entry for a built-in variable.
-		* \param Index The array index of the built-in variable.
+		* \param Index The array index of the built-in variable. 
 		* \param VariableInformation A read-only struct describing the built-in variable.
 		* \return AURIE_SUCCESS on success. AURIE_INVALID_PARAMETER if the index is out of bounds.
 		*/
@@ -360,7 +360,7 @@ namespace YYTK
 		* \brief Calls a game script in the global context.
 		* \param ScriptName The name of the script to call, prefixed with gml_Script. Case-sensitive.
 		* \param Arguments The arguments to pass into the script.
-		* \return AURIE_SUCCESS on success. AURIE_INVALID_PARAMETER if Object is an invalid type.
+		* \return An RValue representing the return value of the script.
 		*/
 		virtual RValue CallGameScript(
 			IN std::string_view ScriptName,

ExamplePlugin/include/YYToolkit/YYTK_Shared_Types.cpp

@@ -147,6 +147,39 @@ std::vector<RValue> YYTK::RValue::ToVector() const
 	return result;
 }
 
+RValue* YYTK::RValue::GetRefMember(
+	IN const char* MemberName
+)
+{
+	return this->ToInstance()->GetRefMember(MemberName);
+}
+
+RValue* YYTK::RValue::GetRefMember(
+	IN const std::string& MemberName
+)
+{
+	return this->ToInstance()->GetRefMember(MemberName);
+}
+
+RValue YYTK::RValue::GetMember(
+	IN const char* MemberName
+) const
+{
+	return this->ToInstance()->GetMember(MemberName);
+}
+
+RValue YYTK::RValue::GetMember(
+	IN const std::string& MemberName
+) const
+{
+	return this->ToInstance()->GetMember(MemberName);
+}
+
+int32_t YYTK::RValue::GetMemberCount() const
+{
+	return this->ToInstance()->GetMemberCount();
+}
+
 RValue* YYTK::RValue::ToArray()
 {
 	RValue* array_start = nullptr;

ExamplePlugin/include/YYToolkit/YYTK_Shared_Types.hpp

@@ -1681,6 +1681,43 @@ namespace YYTK
 		// Elements of the vector are copies of the array members.
 		std::vector<RValue> ToVector() const;
 
+		// Retrieves a nested member from the RValue.
+		// Only applicable for VALUE_OBJECT RValues.
+		//
+		// The returned value is a pointer to the variable.
+		// If the variable does not exist, the function returns NULL.
+		RValue* GetRefMember(
+			IN const char* MemberName
+		);
+
+		// Retrieves a nested member from the RValue.
+		// Only applicable for VALUE_OBJECT RValues.
+		//
+		// The returned value is a pointer to the variable.
+		RValue* GetRefMember(
+			IN const std::string& MemberName
+		);
+
+		// Retrieves a nested member from the RValue.
+		// Only applicable for VALUE_OBJECT RValues.
+		//
+		// The returned value is a copy of the variable.
+		RValue GetMember(
+			IN const char* MemberName
+		) const;
+
+		// Retrieves a nested member from the RValue.
+		// Only applicable for VALUE_OBJECT RValues.
+		//
+		// The returned value is a copy of the variable.
+		RValue GetMember(
+			IN const std::string& MemberName
+		) const;
+
+		// Retrieves the member variable count from the RValue.
+		// Only applicable for VALUE_OBJECT RValues.
+		int32_t GetMemberCount() const;
+
 		// Converts the RValue into a C-style array of RValues.
 		// Only applicable for VALUE_ARRAY RValues.
 		RValue* ToArray();

YYToolkit/source/YYTK/Shared/YYTK_Shared_Types.cpp

@@ -147,6 +147,39 @@ std::vector<RValue> YYTK::RValue::ToVector() const
 	return result;
 }
 
+RValue* YYTK::RValue::GetRefMember(
+	IN const char* MemberName
+)
+{
+	return this->ToInstance()->GetRefMember(MemberName);
+}
+
+RValue* YYTK::RValue::GetRefMember(
+	IN const std::string& MemberName
+)
+{
+	return this->ToInstance()->GetRefMember(MemberName);
+}
+
+RValue YYTK::RValue::GetMember(
+	IN const char* MemberName
+) const
+{
+	return this->ToInstance()->GetMember(MemberName);
+}
+
+RValue YYTK::RValue::GetMember(
+	IN const std::string& MemberName
+) const
+{
+	return this->ToInstance()->GetMember(MemberName);
+}
+
+int32_t YYTK::RValue::GetMemberCount() const
+{
+	return this->ToInstance()->GetMemberCount();
+}
+
 RValue* YYTK::RValue::ToArray()
 {
 	RValue* array_start = nullptr;

YYToolkit/source/YYTK/Shared/YYTK_Shared_Types.hpp

@@ -1681,6 +1681,43 @@ namespace YYTK
 		// Elements of the vector are copies of the array members.
 		std::vector<RValue> ToVector() const;
 
+		// Retrieves a nested member from the RValue.
+		// Only applicable for VALUE_OBJECT RValues.
+		//
+		// The returned value is a pointer to the variable.
+		// If the variable does not exist, the function returns NULL.
+		RValue* GetRefMember(
+			IN const char* MemberName
+		);
+
+		// Retrieves a nested member from the RValue.
+		// Only applicable for VALUE_OBJECT RValues.
+		//
+		// The returned value is a pointer to the variable.
+		RValue* GetRefMember(
+			IN const std::string& MemberName
+		);
+
+		// Retrieves a nested member from the RValue.
+		// Only applicable for VALUE_OBJECT RValues.
+		//
+		// The returned value is a copy of the variable.
+		RValue GetMember(
+			IN const char* MemberName
+		) const;
+
+		// Retrieves a nested member from the RValue.
+		// Only applicable for VALUE_OBJECT RValues.
+		//
+		// The returned value is a copy of the variable.
+		RValue GetMember(
+			IN const std::string& MemberName
+		) const;
+
+		// Retrieves the member variable count from the RValue.
+		// Only applicable for VALUE_OBJECT RValues.
+		int32_t GetMemberCount() const;
+
 		// Converts the RValue into a C-style array of RValues.
 		// Only applicable for VALUE_ARRAY RValues.
 		RValue* ToArray();