Initial Commit

Initial Commit [v1.32PRC8]

_module/nss/nwnx_appearance.nss

@@ -0,0 +1,65 @@
+/// @addtogroup appearance Appearance
+/// @brief Allows the appearance and some other things of creatures to be overridden per player.
+/// @{
+/// @file nwnx_appearance.nss
+
+const string NWNX_Appearance = "NWNX_Appearance"; ///< @private
+
+/// @name Appearance Types
+/// @anchor appearance_types
+///
+/// The various types of changes that can be made to how a PC is perceived.
+/// @{
+const int NWNX_APPEARANCE_TYPE_APPEARANCE       = 0; ///< APPEARANCE_TYPE_* or -1 to remove
+const int NWNX_APPEARANCE_TYPE_GENDER           = 1; ///< GENDER_* or -1 to remove
+
+/// @brief 0-GetMaxHitPoints(oCreature) or -1 to remove
+/// @note This is visual only. Does not change the Examine Window health status.
+const int NWNX_APPEARANCE_TYPE_HITPOINTS        = 2;
+const int NWNX_APPEARANCE_TYPE_HAIR_COLOR       = 3; ///< 0-175 or -1 to remove
+const int NWNX_APPEARANCE_TYPE_SKIN_COLOR       = 4; ///< 0-175 or -1 to remove
+const int NWNX_APPEARANCE_TYPE_PHENOTYPE        = 5; ///< PHENOTYPE_* or -1 to remove
+const int NWNX_APPEARANCE_TYPE_HEAD_TYPE        = 6; ///< 0-? or -1 to remove
+const int NWNX_APPEARANCE_TYPE_SOUNDSET         = 7; ///< See soundset.2da or -1 to remove
+const int NWNX_APPEARANCE_TYPE_TAIL_TYPE        = 8; ///< CREATURE_TAIL_TYPE_* or see tailmodel.2da, -1 to remove
+const int NWNX_APPEARANCE_TYPE_WING_TYPE        = 9; ///< CREATURE_WING_TYPE_* or see wingmodel.2da, -1 to remove
+const int NWNX_APPEARANCE_TYPE_FOOTSTEP_SOUND   = 10; ///< 0-17 or see footstepsounds.2da, -1 to remove
+
+/// @brief See portraits.2da, -1 to remove
+/// @note Does not change the Examine Window portrait.
+const int NWNX_APPEARANCE_TYPE_PORTRAIT         = 11;
+///@}
+
+/// @brief Override a creature's appearance type for a player.
+/// @param oPlayer The player who will see/hear things differently.
+/// @param oCreature The target creature whose appearance type to alter for oPlayer. Can be a PC.
+/// @param nType The @ref appearance_types "Appearance Type" to set or -1 to fully remove override.
+/// @param nValue The new value for the appearance type.
+void NWNX_Appearance_SetOverride(object oPlayer, object oCreature, int nType, int nValue);
+
+/// @brief Get a creature's appearance type for a player.
+/// @param oPlayer The player who see/hear things differently.
+/// @param oCreature The target creature whose appearance type is altered for oPlayer. Can be a PC.
+/// @param nType The @ref appearance_types "Appearance Type" to get.
+/// @return The value for the appearance type or -1 when not set.
+int NWNX_Appearance_GetOverride(object oPlayer, object oCreature, int nType);
+
+/// @}
+
+void NWNX_Appearance_SetOverride(object oPlayer, object oCreature, int nType, int nValue)
+{
+    NWNXPushInt(nValue);
+    NWNXPushInt(nType);
+    NWNXPushObject(oCreature);
+    NWNXPushObject(oPlayer);
+    NWNXCall(NWNX_Appearance, "SetOverride");
+}
+
+int NWNX_Appearance_GetOverride(object oPlayer, object oCreature, int nType)
+{
+    NWNXPushInt(nType);
+    NWNXPushObject(oCreature);
+    NWNXPushObject(oPlayer);
+    NWNXCall(NWNX_Appearance, "GetOverride");
+    return NWNXPopInt();
+}