NWNX_Vault

Author: Daztek

Core/NWNXCore.cpp

@@ -613,6 +613,7 @@ void NWNXCore::CreateServerHandler(CAppManager* app)
 
     g_core->m_createServerHook.reset();
     app->CreateServer();
+    MessageBus::Broadcast("NWNX_CORE_SIGNAL", { "ON_CREATE_SERVER" });
 }
 
 void NWNXCore::DestroyServerHandler(CAppManager* app)

Plugins/Vault/CMakeLists.txt

@@ -0,0 +1 @@
+add_plugin(Vault "Vault.cpp")

Plugins/Vault/NWScript/nwnx_vault.nss

@@ -0,0 +1,46 @@
+/// @addtogroup vault Vault
+/// @brief Provides various character/servervault related functions.
+/// @{
+/// @file nwnx_vault.nss
+#include "nwnx"
+
+const string NWNX_Vault = "NWNX_Vault"; ///< @private
+
+/// @name Vault Event Types
+/// @anchor vault_event_types
+/// @{
+const int NWNX_VAULT_EVENT_TYPE_CREATED = 1;
+const int NWNX_VAULT_EVENT_TYPE_LOGIN = 2;
+const int NWNX_VAULT_EVENT_TYPE_LOGOUT = 3;
+const int NWNX_VAULT_EVENT_TYPE_MIGRATED = 4;
+/// @}
+
+/// @brief Switch oPlayer's character to another one.
+/// @warning THIS FUNCTION IS EXPERIMENTAL, BACKUP YOUR SERVERVAULT BEFORE EVEN ATTEMPTING TO USE THIS.
+/// @note If something goes catastrophically wrong the player will be disconnected.
+/// @param oPlayer The player.
+/// @param nCharacterId The Id of the character in the server vault database.
+/// @param bSaveCurrentCharacter TRUE to save the current character.
+void NWNX_Vault_SwitchCharacter(object oPlayer, int nCharacterId, int bSaveCurrentCharacter = TRUE);
+
+// @brief Get oPlayer's character as json.
+// @param oPlayer A player character.
+// @return The player character as json or JsonNull().
+json NWNX_Vault_GetCharacterJson(object oPlayer);
+
+/// @}
+
+void NWNX_Vault_SwitchCharacter(object oPlayer, int nCharacterId, int bSaveCurrentCharacter = TRUE)
+{
+    NWNX_PushArgumentInt(bSaveCurrentCharacter);
+    NWNX_PushArgumentInt(nCharacterId);
+    NWNX_PushArgumentObject(oPlayer);
+    NWNX_CallFunction(NWNX_Vault, "SwitchCharacter");
+}
+
+json NWNX_Vault_GetCharacterJson(object oPlayer)
+{
+    NWNX_PushArgumentObject(oPlayer);
+    NWNX_CallFunction(NWNX_Vault, "GetCharacterJson");
+    return NWNX_GetReturnValueJson();
+}

Plugins/Vault/README.md

@@ -0,0 +1,16 @@
+@page vault Readme
+@ingroup vault
+
+Provides various character/servervault functions.
+
+## NWNX_Vault_SwitchCharacter Notes
+
+### Before even attempting to do anything with this function, make sure to (regularly) backup your servervault. You have been warned.
+
+Things of note:
+
+* **Backup your servervault.**
+* Will disconnect the player if something goes catastrophically wrong.
+* OnClientEnter/Leave and OnAreaEnter/Exit will fire for the appropriate creature objects.
+* Players will switch characters on the spot, it's up to you to move them if needed.
+* Probably has weird quirks and/or bugs.