API v1

* promote v0 to v1
* swap to references instead of pointers
* update `GameState` hooks
* update documentation
* fix incorrect naming of
  `IGameState::OnUpdate` to `OnTick`
* rename `GameStates::Add` to `AddHook`
* split `GameState` hooks to before/after
  hooks for more granular control and
  better verbosity
* add `EMainReason::Run` for notifying plugins
  about entry to `CRunningState`
* add NOMINMAX preprocessor define

Author: WSSDude

CMakeLists.txt

@@ -111,6 +111,7 @@ else()
         RED4EXT_STATIC_LIB
       PRIVATE
         WIN32_LEAN_AND_MEAN
+        NOMINMAX
   )
 
   if(RED4EXT_USE_PCH)

examples/CMakeLists.txt

@@ -13,6 +13,6 @@ foreach(EXAMPLE_PATH ${EXAMPLE_PATHS})
     set_target_properties(${EXAMPLE_NAME} PROPERTIES FOLDER "Examples")
     target_link_libraries(${EXAMPLE_NAME} PRIVATE RED4ext::SDK)
 
-    target_compile_definitions(${EXAMPLE_NAME} PRIVATE WIN32_LEAN_AND_MEAN)
+    target_compile_definitions(${EXAMPLE_NAME} PRIVATE WIN32_LEAN_AND_MEAN NOMINMAX)
   endif()
 endforeach()

include/RED4ext/Api/EMainReason.hpp

@@ -10,6 +10,7 @@ namespace RED4ext
 enum class EMainReason : uint8_t
 {
     Load = 0,
-    Unload
+    Unload,
+    Run
 };
 } // namespace RED4ext

include/RED4ext/Api/FileVer.hpp

@@ -1,8 +1,8 @@
 #pragma once
 
-#include <RED4ext/Api/v0/FileVer.hpp>
+#include <RED4ext/Api/v1/FileVer.hpp>
 
 /**
  * @brief Creates a file version using the latest version info type.
  */
-#define RED4EXT_FILEVER(major, minor, build, revision) RED4EXT_V0_FILEVER(major, minor, build, revision)
+#define RED4EXT_FILEVER(major, minor, build, revision) RED4EXT_V1_FILEVER(major, minor, build, revision)

include/RED4ext/Api/PluginHandle.hpp

@@ -1,11 +1,9 @@
 #pragma once
 
-#include <Windows.h>
-
 namespace RED4ext
 {
 /**
  * @brief The identifier of the plugin.
  */
-using PluginHandle = HMODULE;
+using PluginHandle = void*;
 } // namespace RED4ext

include/RED4ext/Api/Runtime.hpp

@@ -1,37 +1,37 @@
 #pragma once
 
-#include <RED4ext/Api/v0/Runtime.hpp>
+#include <RED4ext/Api/v1/Runtime.hpp>
 
-#define RED4EXT_RUNTIME_1_50 RED4EXT_V0_RUNTIME_1_50
-#define RED4EXT_RUNTIME_1_50_HOTFIX_1 RED4EXT_V0_RUNTIME_1_50_HOTFIX_1
-#define RED4EXT_RUNTIME_1_50_HOTFIX_2 RED4EXT_V0_RUNTIME_1_50_HOTFIX_2
-#define RED4EXT_RUNTIME_1_52 RED4EXT_V0_RUNTIME_1_52
-#define RED4EXT_RUNTIME_1_52_HOTFIX_1 RED4EXT_V0_RUNTIME_1_52_HOTFIX_1
-#define RED4EXT_RUNTIME_1_60 RED4EXT_V0_RUNTIME_1_60
-#define RED4EXT_RUNTIME_1_61 RED4EXT_V0_RUNTIME_1_61
-#define RED4EXT_RUNTIME_1_61_HOTFIX_1 RED4EXT_V0_RUNTIME_1_61_HOTFIX_1
-#define RED4EXT_RUNTIME_1_62 RED4EXT_V0_RUNTIME_1_62
-#define RED4EXT_RUNTIME_1_62_HOTFIX_1 RED4EXT_V0_RUNTIME_1_62_HOTFIX_1
-#define RED4EXT_RUNTIME_1_63 RED4EXT_V0_RUNTIME_1_63
-#define RED4EXT_RUNTIME_1_63_HOTFIX_1 RED4EXT_V0_RUNTIME_1_63_HOTFIX_1
-#define RED4EXT_RUNTIME_2_00 RED4EXT_V0_RUNTIME_2_00
-#define RED4EXT_RUNTIME_2_01 RED4EXT_V0_RUNTIME_2_01
-#define RED4EXT_RUNTIME_2_02 RED4EXT_V0_RUNTIME_2_02
-#define RED4EXT_RUNTIME_2_10 RED4EXT_V0_RUNTIME_2_10
-#define RED4EXT_RUNTIME_2_11 RED4EXT_V0_RUNTIME_2_11
-#define RED4EXT_RUNTIME_2_12 RED4EXT_V0_RUNTIME_2_12
-#define RED4EXT_RUNTIME_2_12_HOTFIX_1 RED4EXT_V0_RUNTIME_2_12_HOTFIX_1
-#define RED4EXT_RUNTIME_2_13 RED4EXT_V0_RUNTIME_2_13
-#define RED4EXT_RUNTIME_2_20 RED4EXT_V0_RUNTIME_2_20
-#define RED4EXT_RUNTIME_2_21 RED4EXT_V0_RUNTIME_2_21
+#define RED4EXT_RUNTIME_1_50 RED4EXT_V1_RUNTIME_1_50
+#define RED4EXT_RUNTIME_1_50_HOTFIX_1 RED4EXT_V1_RUNTIME_1_50_HOTFIX_1
+#define RED4EXT_RUNTIME_1_50_HOTFIX_2 RED4EXT_V1_RUNTIME_1_50_HOTFIX_2
+#define RED4EXT_RUNTIME_1_52 RED4EXT_V1_RUNTIME_1_52
+#define RED4EXT_RUNTIME_1_52_HOTFIX_1 RED4EXT_V1_RUNTIME_1_52_HOTFIX_1
+#define RED4EXT_RUNTIME_1_60 RED4EXT_V1_RUNTIME_1_60
+#define RED4EXT_RUNTIME_1_61 RED4EXT_V1_RUNTIME_1_61
+#define RED4EXT_RUNTIME_1_61_HOTFIX_1 RED4EXT_V1_RUNTIME_1_61_HOTFIX_1
+#define RED4EXT_RUNTIME_1_62 RED4EXT_V1_RUNTIME_1_62
+#define RED4EXT_RUNTIME_1_62_HOTFIX_1 RED4EXT_V1_RUNTIME_1_62_HOTFIX_1
+#define RED4EXT_RUNTIME_1_63 RED4EXT_V1_RUNTIME_1_63
+#define RED4EXT_RUNTIME_1_63_HOTFIX_1 RED4EXT_V1_RUNTIME_1_63_HOTFIX_1
+#define RED4EXT_RUNTIME_2_00 RED4EXT_V1_RUNTIME_2_00
+#define RED4EXT_RUNTIME_2_01 RED4EXT_V1_RUNTIME_2_01
+#define RED4EXT_RUNTIME_2_02 RED4EXT_V1_RUNTIME_2_02
+#define RED4EXT_RUNTIME_2_10 RED4EXT_V1_RUNTIME_2_10
+#define RED4EXT_RUNTIME_2_11 RED4EXT_V1_RUNTIME_2_11
+#define RED4EXT_RUNTIME_2_12 RED4EXT_V1_RUNTIME_2_12
+#define RED4EXT_RUNTIME_2_12_HOTFIX_1 RED4EXT_V1_RUNTIME_2_12_HOTFIX_1
+#define RED4EXT_RUNTIME_2_13 RED4EXT_V1_RUNTIME_2_13
+#define RED4EXT_RUNTIME_2_20 RED4EXT_V1_RUNTIME_2_20
+#define RED4EXT_RUNTIME_2_21 RED4EXT_V1_RUNTIME_2_21
 
 /**
  * @brief Supports all game versions.
  * @note Only use this if you do not use RED4ext.SDK library, but you want to use RED4ext as a loader only.
  */
-#define RED4EXT_RUNTIME_INDEPENDENT RED4EXT_V0_RUNTIME_INDEPENDENT
+#define RED4EXT_RUNTIME_INDEPENDENT RED4EXT_V1_RUNTIME_INDEPENDENT
 
 /*
  * @brief The latest game version.
  */
-#define RED4EXT_RUNTIME_LATEST RED4EXT_V0_RUNTIME_LATEST
+#define RED4EXT_RUNTIME_LATEST RED4EXT_V1_RUNTIME_LATEST

include/RED4ext/Api/Sdk.hpp

@@ -1,54 +1,59 @@
 #pragma once
 
-#include <RED4ext/Api/v0/PluginInfo.hpp>
-#include <RED4ext/Api/v0/Sdk.hpp>
+#include <RED4ext/Api/v1/PluginInfo.hpp>
+#include <RED4ext/Api/v1/Sdk.hpp>
 
 namespace RED4ext
 {
 /**
  * @brief The latest plugin info type.
  */
-using PluginInfo = v0::PluginInfo;
+using PluginInfo = v1::PluginInfo;
 
 /**
  * @brief The latest version info type.
  */
-using SemVer = v0::SemVer;
+using SemVer = v1::SemVer;
 
 /**
  * @brief The latest version info type.
  */
-using FileVer = v0::FileVer;
+using FileVer = v1::FileVer;
 
 /**
  * @brief The latest RED4ext.
  */
-using Sdk = v0::Sdk;
+using Sdk = v1::Sdk;
 
 /**
- * @brief The latest hooking.
+ * @brief The latest logger.
  */
-using Logger = v0::Logger;
+using Logger = v1::Logger;
 
 /**
  * @brief The latest hooking.
  */
-using Hooking = v0::Hooking;
+using Hooking = v1::Hooking;
+
+/**
+ * @brief The latest game state handler.
+ */
+using GameStates = v1::GameStates;
 
 /**
- * @brief The latest game state type.
+ * @brief The latest game state for hooking.
  */
-using GameStates = v0::GameStates;
+using GameState = v1::GameState;
 
 /**
- * @brief The latest game state type.
+ * @brief The latest scripts compiler interface.
  */
-using GameState = v0::GameState;
+using Scripts = v1::Scripts;
 
 /**
- * @brief The latest game state type.
+ * @brief The latest game state hook result.
  */
-using Scripts = v0::Scripts;
+using EGameStateResult = v1::EGameStateResult;
 } // namespace RED4ext
 
 /*
@@ -60,5 +65,5 @@ using Scripts = v0::Scripts;
  */
 #ifndef RED4EXT_OFFSET_TO_ADDR
 #define RED4EXT_OFFSET_TO_ADDR(offset)                                                                                 \
-    reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(GetModuleHandle(nullptr)) + offset)
+    reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(GetModuleHandleW(nullptr)) + offset)
 #endif

include/RED4ext/Api/SemVer.hpp

@@ -1,14 +1,14 @@
 #pragma once
 
-#include <RED4ext/Api/v0/SemVer.hpp>
+#include <RED4ext/Api/v1/SemVer.hpp>
 
 /**
  * @brief Creates a semantic version using the latest version info type.
  */
 #define RED4EXT_SEMVER_EX(major, minor, patch, prereleaseType, prereleaseNumber)                                       \
-    RED4EXT_V0_SEMVER_EX(major, minor, patch, prereleaseType, prereleaseNumber)
+    RED4EXT_V1_SEMVER_EX(major, minor, patch, prereleaseType, prereleaseNumber)
 
 /**
  * @brief Creates a semantic version using the latest version info type.
  */
-#define RED4EXT_SEMVER(major, minor, patch) RED4EXT_V0_SEMVER(major, minor, patch)
+#define RED4EXT_SEMVER(major, minor, patch) RED4EXT_V1_SEMVER(major, minor, patch)

include/RED4ext/Api/Version.hpp

@@ -1,6 +1,6 @@
 #pragma once
 
-#include <RED4ext/Api/v0/Version.hpp>
+#include <RED4ext/Api/v1/Version.hpp>
 
 /*
  * The SDK is using only one API version, the reason behind that is that multiple versions for every structure is
@@ -15,17 +15,18 @@
  */
 
 #define RED4EXT_API_VERSION_0 0
-#define RED4EXT_API_VERSION_LATEST RED4EXT_API_VERSION_0
+#define RED4EXT_API_VERSION_1 1
+#define RED4EXT_API_VERSION_LATEST RED4EXT_API_VERSION_1
 
 /*
  * The SDK version, it is maninly used to reject loading plugin that are using a broken SDK version, while API version
  * is 0, it is used to load only plugins using the latest SDK version.
  */
 
-#define RED4EXT_SDK_0_1_0 RED4EXT_V0_SDK_0_1_0
-#define RED4EXT_SDK_0_2_0 RED4EXT_V0_SDK_0_2_0
-#define RED4EXT_SDK_0_3_0 RED4EXT_V0_SDK_0_3_0
-#define RED4EXT_SDK_0_4_0 RED4EXT_V0_SDK_0_4_0
-#define RED4EXT_SDK_0_5_0 RED4EXT_V0_SDK_0_5_0
+#define RED4EXT_SDK_0_1_0 RED4EXT_V1_SDK_0_1_0
+#define RED4EXT_SDK_0_2_0 RED4EXT_V1_SDK_0_2_0
+#define RED4EXT_SDK_0_3_0 RED4EXT_V1_SDK_0_3_0
+#define RED4EXT_SDK_0_4_0 RED4EXT_V1_SDK_0_4_0
+#define RED4EXT_SDK_0_5_0 RED4EXT_V1_SDK_0_5_0
 
-#define RED4EXT_SDK_LATEST RED4EXT_V0_SDK_LATEST
+#define RED4EXT_SDK_LATEST RED4EXT_V1_SDK_LATEST