/// @addtogroup creature Creature /// @brief Functions exposing additional creature properties. /// @{ /// @file nwnx_creature.nss #include "nwnx" const string NWNX_Creature = "NWNX_Creature"; ///< @private /// @name Creature Movement Rates /// @anchor creature_movement_rates /// /// The various types of movement rates. /// @{ const int NWNX_CREATURE_MOVEMENT_RATE_PC = 0; const int NWNX_CREATURE_MOVEMENT_RATE_IMMOBILE = 1; const int NWNX_CREATURE_MOVEMENT_RATE_VERY_SLOW = 2; const int NWNX_CREATURE_MOVEMENT_RATE_SLOW = 3; const int NWNX_CREATURE_MOVEMENT_RATE_NORMAL = 4; const int NWNX_CREATURE_MOVEMENT_RATE_FAST = 5; const int NWNX_CREATURE_MOVEMENT_RATE_VERY_FAST = 6; const int NWNX_CREATURE_MOVEMENT_RATE_DEFAULT = 7; const int NWNX_CREATURE_MOVEMENT_RATE_DM_FAST = 8; /// @} /// @name Creature Movement Types /// @anchor creature_movement_types /// /// The various types of movement types. /// @{ const int NWNX_CREATURE_MOVEMENT_TYPE_STATIONARY = 0; const int NWNX_CREATURE_MOVEMENT_TYPE_WALK = 1; const int NWNX_CREATURE_MOVEMENT_TYPE_RUN = 2; const int NWNX_CREATURE_MOVEMENT_TYPE_SIDESTEP = 3; const int NWNX_CREATURE_MOVEMENT_TYPE_WALK_BACKWARDS = 4; /// @} /// @name Cleric Domains /// @anchor cleric_domains /// /// The clerical domains. /// @{ const int NWNX_CREATURE_CLERIC_DOMAIN_AIR = 0; const int NWNX_CREATURE_CLERIC_DOMAIN_ANIMAL = 1; const int NWNX_CREATURE_CLERIC_DOMAIN_DEATH = 3; const int NWNX_CREATURE_CLERIC_DOMAIN_DESTRUCTION = 4; const int NWNX_CREATURE_CLERIC_DOMAIN_EARTH = 5; const int NWNX_CREATURE_CLERIC_DOMAIN_EVIL = 6; const int NWNX_CREATURE_CLERIC_DOMAIN_FIRE = 7; const int NWNX_CREATURE_CLERIC_DOMAIN_GOOD = 8; const int NWNX_CREATURE_CLERIC_DOMAIN_HEALING = 9; const int NWNX_CREATURE_CLERIC_DOMAIN_KNOWLEDGE = 10; const int NWNX_CREATURE_CLERIC_DOMAIN_MAGIC = 13; const int NWNX_CREATURE_CLERIC_DOMAIN_PLANT = 14; const int NWNX_CREATURE_CLERIC_DOMAIN_PROTECTION = 15; const int NWNX_CREATURE_CLERIC_DOMAIN_STRENGTH = 16; const int NWNX_CREATURE_CLERIC_DOMAIN_SUN = 17; const int NWNX_CREATURE_CLERIC_DOMAIN_TRAVEL = 18; const int NWNX_CREATURE_CLERIC_DOMAIN_TRICKERY = 19; const int NWNX_CREATURE_CLERIC_DOMAIN_WAR = 20; const int NWNX_CREATURE_CLERIC_DOMAIN_WATER = 21; /// @} /// @name Bonus Types /// @anchor bonus_types /// /// Used with NWNX_Creature_GetTotalEffectBonus() these are the types of temporary bonuses from effects. /// @{ const int NWNX_CREATURE_BONUS_TYPE_ATTACK = 1; const int NWNX_CREATURE_BONUS_TYPE_DAMAGE = 2; const int NWNX_CREATURE_BONUS_TYPE_SAVING_THROW = 3; const int NWNX_CREATURE_BONUS_TYPE_ABILITY = 4; const int NWNX_CREATURE_BONUS_TYPE_SKILL = 5; const int NWNX_CREATURE_BONUS_TYPE_TOUCH_ATTACK = 6; /// @} /// @struct NWNX_Creature_SpecialAbility /// @brief A creature special ability. struct NWNX_Creature_SpecialAbility { int id; ///< The spell id int ready; ///< Whether it can be used int level; ///< The level of the ability }; /// @struct NWNX_Creature_MemorisedSpell /// @brief A memorised spell structure. struct NWNX_Creature_MemorisedSpell { int id; ///< Spell ID int ready; ///< Whether the spell can be cast int meta; ///< Metamagic type, if any int domain; ///< Clerical domain, if any }; /// @brief Gives the creature a feat. /// @param creature The creature object. /// @param feat The feat id. /// @remark Consider also using NWNX_Creature_AddFeatByLevel() to properly allocate the feat to a level void NWNX_Creature_AddFeat(object creature, int feat); /// @brief Gives the creature a feat assigned at a level /// @param creature The creature object. /// @param feat The feat id. /// @param level The level they gained the feat. /// @remark Adds the feat to the stat list at the provided level. void NWNX_Creature_AddFeatByLevel(object creature, int feat, int level); /// @brief Removes a feat from a creature. /// @param creature The creature object. /// @param feat The feat id. void NWNX_Creature_RemoveFeat(object creature, int feat); /// @brief Determines if the creature knows a feat. /// @note This differs from native @nwn{GetHasFeat} which returns FALSE if the feat has no more uses per day. /// @param creature The creature object. /// @param feat The feat id. /// @return TRUE if the creature has the feat, regardless if they have any usages left or not. int NWNX_Creature_GetKnowsFeat(object creature, int feat); /// @brief Returns the count of feats learned at the provided level. /// @param creature The creature object. /// @param level The level. /// @return The count of feats. int NWNX_Creature_GetFeatCountByLevel(object creature, int level); /// @brief Returns the feat learned at the level and index. /// @param creature The creature object. /// @param level The level. /// @param index The index. Index bounds: 0 <= index < NWNX_Creature_GetFeatCountByLevel(). /// @return The feat id at the index. int NWNX_Creature_GetFeatByLevel(object creature, int level, int index); /// @brief Returns the creature level where the specified feat was learned. /// @param creature The creature object. /// @param feat The feat id. /// @return The character level that the specified feat was granted, otherwise 0 if the creature does not have this feat. int NWNX_Creature_GetFeatGrantLevel(object creature, int feat); /// @brief Get the total number of feats known by creature. /// @param creature The creature object. /// @return The total feat count for the creature. int NWNX_Creature_GetFeatCount(object creature); /// @brief Returns the creature's feat at a given index /// @param creature The creature object. /// @param index The index. Index bounds: 0 <= index < NWNX_Creature_GetFeatCount(); /// @return The feat id at the index. int NWNX_Creature_GetFeatByIndex(object creature, int index); /// @brief Gets if creature meets feat requirements. /// @param creature The creature object. /// @param feat The feat id. /// @return TRUE if creature meets all requirements to take given feat int NWNX_Creature_GetMeetsFeatRequirements(object creature, int feat); /// @brief Gets the count of special abilities of the creature. /// @param creature The creature object. /// @return The total special ability count. int NWNX_Creature_GetSpecialAbilityCount(object creature); /// @brief Returns the creature's special ability at a given index. /// @param creature The creature object. /// @param index The index. Index bounds: 0 <= index < NWNX_Creature_GetSpecialAbilityCount(). /// @return An NWNX_Creature_SpecialAbility struct. struct NWNX_Creature_SpecialAbility NWNX_Creature_GetSpecialAbility(object creature, int index); /// @brief Adds a special ability to a creature. /// @param creature The creature object. /// @param ability An NWNX_Creature_SpecialAbility struct. void NWNX_Creature_AddSpecialAbility(object creature, struct NWNX_Creature_SpecialAbility ability); /// @brief Removes a special ability from a creature. /// @param creature The creature object. /// @param index The index. Index bounds: 0 <= index < NWNX_Creature_GetSpecialAbilityCount(). void NWNX_Creature_RemoveSpecialAbility(object creature, int index); /// @brief Sets a special ability at the index for the creature. /// @param creature The creature object. /// @param index The index. Index bounds: 0 <= index < NWNX_Creature_GetSpecialAbilityCount(). /// @param ability An NWNX_Creature_SpecialAbility struct. void NWNX_Creature_SetSpecialAbility(object creature, int index, struct NWNX_Creature_SpecialAbility ability); /// @brief Get the class taken by the creature at the provided level. /// @param creature The creature object. /// @param level The level. /// @return The class id. int NWNX_Creature_GetClassByLevel(object creature, int level); /// @brief Sets the base AC for the creature. /// @param creature The creature object. /// @param ac The base AC to set for the creature. void NWNX_Creature_SetBaseAC(object creature, int ac); /// @brief Get the base AC for the creature. /// @param creature The creature object. /// @return The base AC. int NWNX_Creature_GetBaseAC(object creature); /// @brief Sets the ability score of the creature to the value. /// @param creature The creature object. /// @param ability The ability constant. /// @param value The value to set. /// @deprecated Use NWNX_Creature_SetRawAbilityScore(). This will be removed in future NWNX releases. void NWNX_Creature_SetAbilityScore(object creature, int ability, int value); /// @brief Sets the ability score of the creature to the provided value. /// @note Does not apply racial bonuses/penalties. /// @param creature The creature object. /// @param ability The ability constant. /// @param value The value to set. void NWNX_Creature_SetRawAbilityScore(object creature, int ability, int value); /// @brief Gets the ability score of the creature. /// @note Does not apply racial bonuses/penalties. /// @param creature The creature object. /// @param ability The ability constant. /// @return The ability score. int NWNX_Creature_GetRawAbilityScore(object creature, int ability); /// @brief Adjusts the ability score of a creature. /// @note Does not apply racial bonuses/penalties. /// @param creature The creature object. /// @param ability The ability constant. /// @param modifier The modifier value. void NWNX_Creature_ModifyRawAbilityScore(object creature, int ability, int modifier); /// @brief Gets the raw ability score a polymorphed creature had prior to polymorphing. /// @note For Strength, Dexterity and Constitution only. /// @param creature The creature object. /// @param ability The ability constant. /// @return The raw ability score. int NWNX_Creature_GetPrePolymorphAbilityScore(object creature, int ability); /// @brief Gets the count of memorised spells for a creature's class at a level. /// @param creature The creature object. /// @param class The class id from classes.2da. (Not class index 0-2) /// @param level The spell level. /// @return The memorised spell count. int NWNX_Creature_GetMemorisedSpellCountByLevel(object creature, int class, int level); /// @brief Gets the memorised spell at a class level's index. /// @param creature The creature object. /// @param class The class id from classes.2da. (Not class index 0-2) /// @param level The spell level. /// @param index The index. Index bounds: 0 <= index < NWNX_Creature_GetMemorisedSpellCountByLevel(). /// @return An NWNX_Creature_MemorisedSpell() struct. struct NWNX_Creature_MemorisedSpell NWNX_Creature_GetMemorisedSpell(object creature, int class, int level, int index); /// @brief Sets the memorised spell at a class level's index. /// @param creature The creature object. /// @param class The class id from classes.2da. (Not class index 0-2) /// @param level The spell level. /// @param index The index. Index bounds: 0 <= index < NWNX_Creature_GetMemorisedSpellCountByLevel(). /// @param spell An NWNX_Creature_MemorisedSpell() struct. void NWNX_Creature_SetMemorisedSpell(object creature, int class, int level, int index, struct NWNX_Creature_MemorisedSpell spell); /// @brief Gets the remaining spell slots (innate casting) at a class level's index. /// @param creature The creature object. /// @param class The class id from classes.2da. (Not class index 0-2) /// @param level The spell level. /// @return The remaining spell slot count. int NWNX_Creature_GetRemainingSpellSlots(object creature, int class, int level); /// @brief Sets the remaining spell slots (innate casting) at a class level. /// @param creature The creature object. /// @param class The class id from classes.2da. (Not class index 0-2) /// @param level The spell level. /// @param slots The remaining spell slots to set. void NWNX_Creature_SetRemainingSpellSlots(object creature, int class, int level, int slots); /// @brief Gets the maximum spell slots (innate casting) at a class level. /// @param creature The creature object. /// @param class The class id from classes.2da. (Not class index 0-2) /// @param level The spell level. /// @return The maximum spell slot count. int NWNX_Creature_GetMaxSpellSlots(object creature, int class, int level); /// @brief Gets the known spell count (innate casting) at a class level. /// @param creature The creature object. /// @param class The class id from classes.2da. (Not class index 0-2) /// @param level The spell level. /// @return The known spell count. int NWNX_Creature_GetKnownSpellCount(object creature, int class, int level); /// @brief Gets the known spell at a class level's index. /// @param creature The creature object. /// @param class The class id from classes.2da. (Not class index 0-2) /// @param level The spell level. /// @param index The index. Index bounds: 0 <= index < NWNX_Creature_GetKnownSpellCount(). /// @return The spell id. int NWNX_Creature_GetKnownSpell(object creature, int class, int level, int index); /// @brief Add a spell to a creature's spellbook for class. /// @param creature The creature object. /// @param class The class id from classes.2da. (Not class index 0-2) /// @param level The spell level. /// @param spellId The spell to remove. void NWNX_Creature_AddKnownSpell(object creature, int class, int level, int spellId); /// @brief Remove a spell from creature's spellbook for class. /// @param creature The creature object. /// @param class The class id from classes.2da. (Not class index 0-2) /// @param level The spell level. /// @param spellId The spell to remove. void NWNX_Creature_RemoveKnownSpell(object creature, int class, int level, int spellId); /// @brief Clear a specific spell from the creature's spellbook for class /// @param creature The creature object. /// @param class The class id from classes.2da. (Not class index 0-2) /// @param spellId The spell to clear. void NWNX_Creature_ClearMemorisedKnownSpells(object creature, int class, int spellId); /// @brief Clear the memorised spell of the creature for the class, level and index. /// @param creature The creature object. /// @param class The class id from classes.2da. (Not class index 0-2) /// @param level The spell level. /// @param index The index. Index bounds: 0 <= index < NWNX_Creature_GetMemorisedSpellCountByLevel(). void NWNX_Creature_ClearMemorisedSpell(object creature, int class, int level, int index); /// @brief Gets whether or not creature has a specialist school of wizardry. /// @param creature The creature object. /// @return TRUE if the wizard specializes. /// @deprecated Use GetSpecialization(). This will be removed in future NWNX releases. int NWNX_Creature_GetWizardSpecialization(object creature); /// @brief Sets creature's wizard specialist school. /// @param creature The creature object. /// @param school The wizard school constant. /// @deprecated Use NWNX_Creature_SetSpecialization(). This will be removed in future NWNX releases. void NWNX_Creature_SetWizardSpecialization(object creature, int school); /// @brief Gets the maximum hit points for creature for level. /// @param creature The creature object. /// @param level The level. /// @return The maximum hit points a creature can have for the class at the provided level. int NWNX_Creature_GetMaxHitPointsByLevel(object creature, int level); /// @brief Sets the maximum hit points for creature. /// @param creature The creature object. /// @param level The level. /// @param value The amount to set the max hit points. void NWNX_Creature_SetMaxHitPointsByLevel(object creature, int level, int value); /// @brief Set creature's movement rate. /// @param creature The creature object. /// @param rate The movement rate. void NWNX_Creature_SetMovementRate(object creature, int rate); /// @brief Returns the creature's current movement rate factor. /// @remark Base movement rate factor is 1.0. /// @param creature The creature object. /// @return The current movement rate factor. float NWNX_Creature_GetMovementRateFactor(object creature); /// @brief Sets the creature's current movement rate factor. /// @note Base movement rate factor is 1.0. /// @param creature The creature object. /// @param rate The rate to set. void NWNX_Creature_SetMovementRateFactor(object creature, float rate); /// @brief Returns the creature's current movement type /// @param creature The creature object. /// @return An NWNX_CREATURE_MOVEMENT_TYPE_* constant. int NWNX_Creature_GetMovementType(object creature); /// @brief Sets the maximum movement rate a creature can have while walking (not running) /// @remark This allows a creature with movement speed enhancements to walk at a normal rate. /// @param creature The creature object. /// @param fWalkRate The walk rate to apply. Setting the value to -1.0 will remove the cap. /// Default value is 2000.0, which is the base human walk speed. void NWNX_Creature_SetWalkRateCap(object creature, float fWalkRate = 2000.0f); /// @brief Set creature's raw good/evil alignment value. /// @param creature The creature object. /// @param value The value to set. void NWNX_Creature_SetAlignmentGoodEvil(object creature, int value); /// @brief Set creature's raw law/chaos alignment value. /// @param creature The creature object. /// @param value The value to set. void NWNX_Creature_SetAlignmentLawChaos(object creature, int value); /// @brief Gets one of creature's cleric domains. /// @param creature The creature object. /// @param index The first or second domain. /// @deprecated Use GetDomain(). This will be removed in future NWNX releases. int NWNX_Creature_GetClericDomain(object creature, int index); /// @brief Sets one of creature's cleric domains. /// @param creature The creature object. /// @param index The first or second domain. /// @param domain The domain constant to set. /// @deprecated Use NWNX_Creature_SetDomain(). This will be removed in future NWNX releases. void NWNX_Creature_SetClericDomain(object creature, int index, int domain); /// @brief Get the soundset index for creature. /// @param creature The creature object. /// @return The soundset used by the creature. int NWNX_Creature_GetSoundset(object creature); /// @brief Set the soundset index for creature. /// @param creature The creature object. /// @param soundset The soundset index. void NWNX_Creature_SetSoundset(object creature, int soundset); /// @brief Set the base ranks in a skill for creature /// @param creature The creature object. /// @param skill The skill id. /// @param rank The value to set as the skill rank. void NWNX_Creature_SetSkillRank(object creature, int skill, int rank); /// @brief Set the class ID in a particular position for a creature. /// @param creature The creature object. /// @param position Should be 0, 1, or 2 depending on how many classes the creature /// has and which is to be modified. /// @param classID A valid ID number in classes.2da and between 0 and 255. void NWNX_Creature_SetClassByPosition(object creature, int position, int classID); /// @brief Set the level at the given position for a creature. /// @note A creature should already have a class in that position. /// @param creature The creature object. /// @param position Should be 0, 1, or 2 depending on how many classes the creature /// has and which is to be modified. /// @param level The level to set. void NWNX_Creature_SetLevelByPosition(object creature, int position, int level); /// @brief Set creature's base attack bonus (BAB). /// @note Modifying the BAB will also affect the creature's attacks per round and its /// eligibility for feats, prestige classes, etc. /// @param creature The creature object. /// @param bab The BAB value. Should be between 0 and 254. Setting BAB to 0 will cause the /// creature to revert to its original BAB based on its classes and levels. A creature can /// never have an actual BAB of zero. /// @remark The base game has a function @nwn{SetBaseAttackBonus}, which actually sets /// the bonus attacks per round for a creature, not the BAB. void NWNX_Creature_SetBaseAttackBonus(object creature, int bab); /// @brief Gets the creatures current attacks per round (using equipped weapon). /// @param creature The creature object. /// @param bBaseAPR If TRUE, will return the base attacks per round, based on BAB and /// equipped weapons, regardless of overrides set by calls to @nwn{SetBaseAttackBonus} builtin function. /// @return The attacks per round. int NWNX_Creature_GetAttacksPerRound(object creature, int bBaseAPR = FALSE); /// @brief Sets the creature gender. /// @param creature The creature object. /// @param gender The GENDER_ constant. void NWNX_Creature_SetGender(object creature, int gender); /// @brief Restore all creature feat uses. /// @param creature The creature object. void NWNX_Creature_RestoreFeats(object creature); /// @brief Restore all creature special ability uses. /// @param creature The creature object. void NWNX_Creature_RestoreSpecialAbilities(object creature); /// @brief Restore all creature spells per day for given level. /// @param creature The creature object. /// @param level The level to restore. If -1, all spells are restored. void NWNX_Creature_RestoreSpells(object creature, int level = -1); /// @brief Restore uses for all items carried by the creature. /// @param creature The creature object. void NWNX_Creature_RestoreItems(object creature); /// @brief Sets the creature size. /// @param creature The creature object. /// @param size Use CREATURE_SIZE_* constants. void NWNX_Creature_SetSize(object creature, int size); /// @brief Gets the creature's remaining unspent skill points. /// @param creature The creature object. /// @return The remaining unspent skill points. int NWNX_Creature_GetSkillPointsRemaining(object creature); /// @brief Sets the creature's remaining unspent skill points. /// @param creature The creature object. /// @param skillpoints The value to set. void NWNX_Creature_SetSkillPointsRemaining(object creature, int skillpoints); /// @brief Sets the creature's racial type /// @param creature The creature object. /// @param racialtype The racial type to set. void NWNX_Creature_SetRacialType(object creature, int racialtype); /// @brief Sets the creature's gold without sending a feedback message /// @param creature The creature object. /// @param gold The amount of gold to set for their creature. void NWNX_Creature_SetGold(object creature, int gold); /// @brief Sets corpse decay time in milliseconds /// @param creature The creature object. /// @param nDecayTime The corpse decay time. void NWNX_Creature_SetCorpseDecayTime(object creature, int nDecayTime); /// @brief Gets the creature's base save. /// @param creature The creature object. /// @param which One of SAVING_THROW_FORT, SAVING_THROW_REFLEX or SAVING_THROW_WILL /// @return The base save value. /// @note This will include any modifiers set in the toolset. int NWNX_Creature_GetBaseSavingThrow(object creature, int which); /// @brief Sets the creature's base save. /// @param creature The creature object. /// @param which One of SAVING_THROW_FORT, SAVING_THROW_REFLEX or SAVING_THROW_WILL /// @param value The base save value. void NWNX_Creature_SetBaseSavingThrow(object creature, int which, int value); /// @brief Add levels of class to the creature, bypassing all validation /// @param creature The creature object. /// @param class The class id. /// @param count The amount of levels of class to add. /// @note This will not work on player characters. void NWNX_Creature_LevelUp(object creature, int class, int count=1); /// @brief Remove last levels from a creature. /// @param creature The creature object. /// @param count The amount of levels to decrement. /// @note This will not work on player characters. void NWNX_Creature_LevelDown(object creature, int count=1); /// @brief Sets the creature's challenge rating /// @param creature The creature object. /// @param fCR The challenge rating. void NWNX_Creature_SetChallengeRating(object creature, float fCR); /// @brief Returns the creature's highest attack bonus based on its own stats. /// @note AB vs. Type and +AB on Gauntlets are excluded /// @param creature The creature object. /// @param isMelee /// * TRUE: Get Melee/Unarmed Attack Bonus /// * FALSE: Get Ranged Attack Bonus /// * -1: Get Attack Bonus depending on the weapon creature has equipped in its right hand /// Defaults to Melee Attack Bonus if weapon is invalid or no weapon /// @param isTouchAttack If the attack was a touch attack. /// @param isOffhand If the attack was with the offhand. /// @param includeBaseAttackBonus Should the result include the base attack bonus. /// @return The highest attack bonus. int NWNX_Creature_GetAttackBonus(object creature, int isMelee = -1, int isTouchAttack = FALSE, int isOffhand = FALSE, int includeBaseAttackBonus = TRUE); /// @brief Get highest level version of feat possessed by creature. /// @remark For feats that increment in power, for example, barbarian rage. /// @param creature The creature object. /// @param feat The feat id. /// @return The highest level version of the feat. int NWNX_Creature_GetHighestLevelOfFeat(object creature, int feat); /// @brief Get feat remaining uses. /// @param creature The creature object. /// @param feat The feat id. /// @return The amount of remaining uses. int NWNX_Creature_GetFeatRemainingUses(object creature, int feat); /// @brief Get feat total uses. /// @param creature The creature object. /// @param feat The feat id. /// @return The total uses. int NWNX_Creature_GetFeatTotalUses(object creature, int feat); /// @brief Set feat remaining uses. /// @param creature The creature object. /// @param feat The feat id. /// @param uses The amount of remaining uses. void NWNX_Creature_SetFeatRemainingUses(object creature, int feat, int uses); /// @brief Get total effect bonus /// @remark This exposes the actual bonus value beyond a player's base scores to attack, damage bonus, saves, /// skills, ability scores, and touch attack provided by spells, equipment, potions etc. /// @param creature The creature object. /// @param bonusType A @ref bonus_types "Bonus Type" /// @param target A target object. Used to calculate bonuses versus specific races, alignments, etc. /// @param isElemental If a damage bonus includes elemental damage. /// @param isForceMax If the bonus should return the maximum possible. /// @param savetype A SAVING_THROW_* constant. /// @param saveSpecificType A SAVING_THROW_TYPE_* constant. /// @param skill A skill id. /// @param abilityScore An ABILITY_* constant. /// @param isOffhand Whether the attack is an offhand attack. /// @return The bonus value. int NWNX_Creature_GetTotalEffectBonus(object creature, int bonusType=NWNX_CREATURE_BONUS_TYPE_ATTACK, object target=OBJECT_INVALID, int isElemental=0, int isForceMax=0, int savetype=-1, int saveSpecificType=-1, int skill=-1, int abilityScore=-1, int isOffhand=FALSE); /// @brief Set the original first or last name of creature /// @param creature The creature object. /// @param name The name to give the creature. /// @param isLastName TRUE to change their last name, FALSE for first. /// @note For PCs this will persist to the .bic file if saved. Requires a relog to update. void NWNX_Creature_SetOriginalName(object creature, string name, int isLastName); /// @brief Get the original first or last name of creature /// @param creature The creature object. /// @param isLastName TRUE to get last name, FALSE for first name. /// @return The original first or last name of the creature. string NWNX_Creature_GetOriginalName(object creature, int isLastName); /// @brief Set creature's spell resistance /// @param creature The creature object. /// @param sr The spell resistance. /// @warning This setting will be overwritten by effects and once those effects fade the old setting (typically 0) will be set. void NWNX_Creature_SetSpellResistance(object creature, int sr); /// @brief Set creature's animal companion creature type /// @param creature The master creature object. /// @param type The type from ANIMAL_COMPANION_CREATURE_TYPE_*. void NWNX_Creature_SetAnimalCompanionCreatureType(object creature, int type); /// @brief Set creature's familiar creature type /// @param creature The master creature object. /// @param type The type from FAMILIAR_CREATURE_TYPE_*. void NWNX_Creature_SetFamiliarCreatureType(object creature, int type); /// @brief Set creature's animal companion's name /// @param creature The master creature object. /// @param name The name to give their animal companion. void NWNX_Creature_SetAnimalCompanionName(object creature, string name); /// @brief Set creature's familiar's name /// @param creature The master creature object. /// @param name The name to give their familiar. void NWNX_Creature_SetFamiliarName(object creature, string name); /// @brief Get whether the creature can be disarmed. /// @param creature The creature object. /// @return TRUE if the creature can be disarmed. int NWNX_Creature_GetDisarmable(object creature); /// @brief Set whether a creature can be disarmed. /// @param creature The creature object. /// @param disarmable Set to TRUE if the creature can be disarmed. void NWNX_Creature_SetDisarmable(object creature, int disarmable); /// @brief Gets one of creature's domains. /// @param creature The creature object. /// @param class The class id from classes.2da. (Not class index 0-2) /// @param index The first or second domain. /// @deprecated Use GetDomain(). This will be removed in future NWNX releases. int NWNX_Creature_GetDomain(object creature, int class, int index); /// @brief Sets one of creature's domains. /// @param creature The creature object. /// @param class The class id from classes.2da. (Not class index 0-2) /// @param index The first or second domain. /// @param domain The domain constant to set. void NWNX_Creature_SetDomain(object creature, int class, int index, int domain); /// @brief Gets the creature's specialist school. /// @param creature The creature object. /// @param class The class id from classes.2da. (Not class index 0-2) /// @deprecated Use GetSpecialization(). This will be removed in future NWNX releases. int NWNX_Creature_GetSpecialization(object creature, int class); /// @brief Sets creature's specialist school. /// @param creature The creature object. /// @param class The class id from classes.2da. (Not class index 0-2) /// @param school The school constant. void NWNX_Creature_SetSpecialization(object creature, int class, int school); /// @brief Sets oCreatures faction to be the faction with id nFactionId. /// @param oCreature The creature. /// @param nFactionId The faction id we want the creature to join. void NWNX_Creature_SetFaction(object oCreature, int nFactionId); /// @brief Gets the faction id from oCreature /// @param oCreature the creature we wish to query against /// @return faction id as an integer, -1 when used against invalid creature or invalid object. int NWNX_Creature_GetFaction(object oCreature); /// @brief Get whether a creature is flat-footed. /// @param The creature object. /// @return TRUE if the creature is flat-footed. int NWNX_Creature_GetFlatFooted(object oCreature); /// @brief Serialize oCreature's quickbar to a base64 string /// @param oCreature The creature. /// @return A base64 string representation of oCreature's quickbar. string NWNX_Creature_SerializeQuickbar(object oCreature); /// @brief Deserialize sSerializedQuickbar for oCreature /// @param oCreature The creature. /// @param sSerializedQuickbar A base64 string of a quickbar /// @return TRUE on success int NWNX_Creature_DeserializeQuickbar(object oCreature, string sSerializedQuickbar); /// @brief Sets a caster level modifier for oCreature /// @param oCreature the target creature /// @param nClass the class that this modifier will apply to /// @param nModifier the modifier to apply /// @param bModifier whether the modifier should be persisted to the .bic file if applicable void NWNX_Creature_SetCasterLevelModifier(object oCreature, int nClass, int nModifier, int bPersist = FALSE); /// @brief Sets the current caster level modifier for oCreature /// @param oCreature the target creature /// @param nClass the creature caster class /// @return the current caster level modifier for the creature int NWNX_Creature_GetCasterLevelModifier(object oCreature, int nClass); /// @brief Sets a caster level override for oCreature /// @param oCreature the target creature /// @param nClass the class that this modifier will apply to /// @param nCasterLevel the caster level override to apply /// @param bModifier whether the override should be persisted to the .bic file if applicable void NWNX_Creature_SetCasterLevelOverride(object oCreature, int nClass, int nCasterLevel, int bPersist = FALSE); /// @brief Gets the current caster level override for oCreature /// @param oCreature the target creature /// @param nClass the creature caster class /// @return the current caster level override for the creature or -1 if not set int NWNX_Creature_GetCasterLevelOverride(object oCreature, int nClass); /// @brief Move a creature to limbo. /// @param The creature object. void NWNX_Creature_JumpToLimbo(object oCreature); /// @} void NWNX_Creature_AddFeat(object creature, int feat) { string sFunc = "AddFeat"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, feat); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_AddFeatByLevel(object creature, int feat, int level) { string sFunc = "AddFeatByLevel"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, level); NWNX_PushArgumentInt(NWNX_Creature, sFunc, feat); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_RemoveFeat(object creature, int feat) { string sFunc = "RemoveFeat"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, feat); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetKnowsFeat(object creature, int feat) { string sFunc = "GetKnowsFeat"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, feat); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } int NWNX_Creature_GetFeatCountByLevel(object creature, int level) { string sFunc = "GetFeatCountByLevel"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, level); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } int NWNX_Creature_GetFeatByLevel(object creature, int level, int index) { string sFunc = "GetFeatByLevel"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, index); NWNX_PushArgumentInt(NWNX_Creature, sFunc, level); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } int NWNX_Creature_GetFeatCount(object creature) { string sFunc = "GetFeatCount"; NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } int NWNX_Creature_GetFeatGrantLevel(object creature, int feat) { string sFunc = "GetFeatGrantLevel"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, feat); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } int NWNX_Creature_GetFeatByIndex(object creature, int index) { string sFunc = "GetFeatByIndex"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, index); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } int NWNX_Creature_GetMeetsFeatRequirements(object creature, int feat) { string sFunc = "GetMeetsFeatRequirements"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, feat); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } struct NWNX_Creature_SpecialAbility NWNX_Creature_GetSpecialAbility(object creature, int index) { string sFunc = "GetSpecialAbility"; struct NWNX_Creature_SpecialAbility ability; NWNX_PushArgumentInt(NWNX_Creature, sFunc, index); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); ability.level = NWNX_GetReturnValueInt(NWNX_Creature, sFunc); ability.ready = NWNX_GetReturnValueInt(NWNX_Creature, sFunc); ability.id = NWNX_GetReturnValueInt(NWNX_Creature, sFunc); return ability; } int NWNX_Creature_GetSpecialAbilityCount(object creature) { string sFunc = "GetSpecialAbilityCount"; NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } void NWNX_Creature_AddSpecialAbility(object creature, struct NWNX_Creature_SpecialAbility ability) { string sFunc = "AddSpecialAbility"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, ability.id); NWNX_PushArgumentInt(NWNX_Creature, sFunc, ability.ready); NWNX_PushArgumentInt(NWNX_Creature, sFunc, ability.level); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_RemoveSpecialAbility(object creature, int index) { string sFunc = "RemoveSpecialAbility"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, index); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_SetSpecialAbility(object creature, int index, struct NWNX_Creature_SpecialAbility ability) { string sFunc = "SetSpecialAbility"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, ability.id); NWNX_PushArgumentInt(NWNX_Creature, sFunc, ability.ready); NWNX_PushArgumentInt(NWNX_Creature, sFunc, ability.level); NWNX_PushArgumentInt(NWNX_Creature, sFunc, index); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetClassByLevel(object creature, int level) { string sFunc = "GetClassByLevel"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, level); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } void NWNX_Creature_SetBaseAC(object creature, int ac) { string sFunc = "SetBaseAC"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, ac); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetBaseAC(object creature) { string sFunc = "GetBaseAC"; NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } void NWNX_Creature_SetAbilityScore(object creature, int ability, int value) { WriteTimestampedLogEntry("NWNX_Creature: SetAbilityScore() is deprecated. Use native NWNX_Creature_SetRawAbilityScore() instead"); NWNX_Creature_SetRawAbilityScore(creature, ability, value); } void NWNX_Creature_SetRawAbilityScore(object creature, int ability, int value) { string sFunc = "SetRawAbilityScore"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, value); NWNX_PushArgumentInt(NWNX_Creature, sFunc, ability); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetRawAbilityScore(object creature, int ability) { string sFunc = "GetRawAbilityScore"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, ability); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } void NWNX_Creature_ModifyRawAbilityScore(object creature, int ability, int modifier) { string sFunc = "ModifyRawAbilityScore"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, modifier); NWNX_PushArgumentInt(NWNX_Creature, sFunc, ability); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetPrePolymorphAbilityScore(object creature, int ability) { string sFunc = "GetPrePolymorphAbilityScore"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, ability); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } struct NWNX_Creature_MemorisedSpell NWNX_Creature_GetMemorisedSpell(object creature, int class, int level, int index) { string sFunc = "GetMemorisedSpell"; struct NWNX_Creature_MemorisedSpell spell; NWNX_PushArgumentInt(NWNX_Creature, sFunc, index); NWNX_PushArgumentInt(NWNX_Creature, sFunc, level); NWNX_PushArgumentInt(NWNX_Creature, sFunc, class); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); spell.domain = NWNX_GetReturnValueInt(NWNX_Creature, sFunc); spell.meta = NWNX_GetReturnValueInt(NWNX_Creature, sFunc); spell.ready = NWNX_GetReturnValueInt(NWNX_Creature, sFunc); spell.id = NWNX_GetReturnValueInt(NWNX_Creature, sFunc); return spell; } int NWNX_Creature_GetMemorisedSpellCountByLevel(object creature, int class, int level) { string sFunc = "GetMemorisedSpellCountByLevel"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, level); NWNX_PushArgumentInt(NWNX_Creature, sFunc, class); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } void NWNX_Creature_SetMemorisedSpell(object creature, int class, int level, int index, struct NWNX_Creature_MemorisedSpell spell) { string sFunc = "SetMemorisedSpell"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, spell.id); NWNX_PushArgumentInt(NWNX_Creature, sFunc, spell.ready); NWNX_PushArgumentInt(NWNX_Creature, sFunc, spell.meta); NWNX_PushArgumentInt(NWNX_Creature, sFunc, spell.domain); NWNX_PushArgumentInt(NWNX_Creature, sFunc, index); NWNX_PushArgumentInt(NWNX_Creature, sFunc, level); NWNX_PushArgumentInt(NWNX_Creature, sFunc, class); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetRemainingSpellSlots(object creature, int class, int level) { string sFunc = "GetRemainingSpellSlots"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, level); NWNX_PushArgumentInt(NWNX_Creature, sFunc, class); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } void NWNX_Creature_SetRemainingSpellSlots(object creature, int class, int level, int slots) { string sFunc = "SetRemainingSpellSlots"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, slots); NWNX_PushArgumentInt(NWNX_Creature, sFunc, level); NWNX_PushArgumentInt(NWNX_Creature, sFunc, class); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetKnownSpell(object creature, int class, int level, int index) { string sFunc = "GetKnownSpell"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, index); NWNX_PushArgumentInt(NWNX_Creature, sFunc, level); NWNX_PushArgumentInt(NWNX_Creature, sFunc, class); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } int NWNX_Creature_GetKnownSpellCount(object creature, int class, int level) { string sFunc = "GetKnownSpellCount"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, level); NWNX_PushArgumentInt(NWNX_Creature, sFunc, class); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } void NWNX_Creature_RemoveKnownSpell(object creature, int class, int level, int spellId) { string sFunc = "RemoveKnownSpell"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, spellId); NWNX_PushArgumentInt(NWNX_Creature, sFunc, level); NWNX_PushArgumentInt(NWNX_Creature, sFunc, class); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_AddKnownSpell(object creature, int class, int level, int spellId) { string sFunc = "AddKnownSpell"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, spellId); NWNX_PushArgumentInt(NWNX_Creature, sFunc, level); NWNX_PushArgumentInt(NWNX_Creature, sFunc, class); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_ClearMemorisedKnownSpells(object creature, int class, int spellId) { string sFunc = "ClearMemorisedKnownSpells"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, spellId); NWNX_PushArgumentInt(NWNX_Creature, sFunc, class); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_ClearMemorisedSpell(object creature, int class, int level, int index) { string sFunc = "ClearMemorisedSpell"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, index); NWNX_PushArgumentInt(NWNX_Creature, sFunc, level); NWNX_PushArgumentInt(NWNX_Creature, sFunc, class); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetMaxSpellSlots(object creature, int class, int level) { string sFunc = "GetMaxSpellSlots"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, level); NWNX_PushArgumentInt(NWNX_Creature, sFunc, class); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } int NWNX_Creature_GetMaxHitPointsByLevel(object creature, int level) { string sFunc = "GetMaxHitPointsByLevel"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, level); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } void NWNX_Creature_SetMaxHitPointsByLevel(object creature, int level, int value) { string sFunc = "SetMaxHitPointsByLevel"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, value); NWNX_PushArgumentInt(NWNX_Creature, sFunc, level); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_SetMovementRate(object creature, int rate) { string sFunc = "SetMovementRate"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, rate); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } float NWNX_Creature_GetMovementRateFactor(object creature) { string sFunc = "GetMovementRateFactor"; NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueFloat(NWNX_Creature, sFunc); } void NWNX_Creature_SetMovementRateFactor(object creature, float factor) { string sFunc = "SetMovementRateFactor"; NWNX_PushArgumentFloat(NWNX_Creature, sFunc, factor); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_SetAlignmentGoodEvil(object creature, int value) { string sFunc = "SetAlignmentGoodEvil"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, value); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_SetAlignmentLawChaos(object creature, int value) { string sFunc = "SetAlignmentLawChaos"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, value); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetClericDomain(object creature, int index) { WriteTimestampedLogEntry("NWNX_Creature: GetClericDomain() is deprecated. Please use the basegame's GetDomain() instead"); return GetDomain(creature, index, CLASS_TYPE_CLERIC); } void NWNX_Creature_SetClericDomain(object creature, int index, int domain) { WriteTimestampedLogEntry("NWNX_Creature: SetClericDomain() is deprecated. Please use NWNX_Creature_SetDomain() instead"); NWNX_Creature_SetDomain(creature, CLASS_TYPE_CLERIC, index, domain); } int NWNX_Creature_GetWizardSpecialization(object creature) { WriteTimestampedLogEntry("NWNX_Creature: GetWizardSpecialization() is deprecated. Please use the basegame's GetSpecialization() instead"); return GetSpecialization(creature, CLASS_TYPE_WIZARD); } void NWNX_Creature_SetWizardSpecialization(object creature, int school) { WriteTimestampedLogEntry("NWNX_Creature: SetWizardSpecialization() is deprecated. Please use NWNX_Creature_SetSpecialization() instead"); NWNX_Creature_SetSpecialization(creature, CLASS_TYPE_WIZARD, school); } int NWNX_Creature_GetSoundset(object creature) { string sFunc = "GetSoundset"; NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } void NWNX_Creature_SetSoundset(object creature, int soundset) { string sFunc = "SetSoundset"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, soundset); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_SetSkillRank(object creature, int skill, int rank) { string sFunc = "SetSkillRank"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, rank); NWNX_PushArgumentInt(NWNX_Creature, sFunc, skill); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_SetClassByPosition(object creature, int position, int classID) { string sFunc = "SetClassByPosition"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, classID); NWNX_PushArgumentInt(NWNX_Creature, sFunc, position); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_SetLevelByPosition(object creature, int position, int level) { string sFunc = "SetLevelByPosition"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, level); NWNX_PushArgumentInt(NWNX_Creature, sFunc, position); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_SetBaseAttackBonus(object creature, int bab) { string sFunc = "SetBaseAttackBonus"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, bab); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetAttacksPerRound(object creature, int bBaseAPR = FALSE) { string sFunc = "GetAttacksPerRound"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, bBaseAPR); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } void NWNX_Creature_SetGender(object creature, int gender) { string sFunc = "SetGender"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, gender); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_RestoreFeats(object creature) { string sFunc = "RestoreFeats"; NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_RestoreSpecialAbilities(object creature) { string sFunc = "RestoreSpecialAbilities"; NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_RestoreSpells(object creature, int level = -1) { string sFunc = "RestoreSpells"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, level); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_RestoreItems(object creature) { string sFunc = "RestoreItems"; NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_SetSize(object creature, int size) { string sFunc = "SetSize"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, size); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetSkillPointsRemaining(object creature) { string sFunc = "GetSkillPointsRemaining"; NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } void NWNX_Creature_SetSkillPointsRemaining(object creature, int skillpoints) { string sFunc = "SetSkillPointsRemaining"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, skillpoints); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_SetRacialType(object creature, int racialtype) { string sFunc = "SetRacialType"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, racialtype); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetMovementType(object creature) { string sFunc = "GetMovementType"; NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } void NWNX_Creature_SetWalkRateCap(object creature, float fWalkRate = 2000.0f) { string sFunc = "SetWalkRateCap"; NWNX_PushArgumentFloat(NWNX_Creature, sFunc, fWalkRate); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_SetGold(object creature, int gold) { string sFunc = "SetGold"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, gold); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_SetCorpseDecayTime(object creature, int nDecayTime) { string sFunc = "SetCorpseDecayTime"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, nDecayTime); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetBaseSavingThrow(object creature, int which) { string sFunc = "GetBaseSavingThrow"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, which); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } void NWNX_Creature_SetBaseSavingThrow(object creature, int which, int value) { string sFunc = "SetBaseSavingThrow"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, value); NWNX_PushArgumentInt(NWNX_Creature, sFunc, which); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_LevelUp(object creature, int class, int count=1) { string sFunc = "LevelUp"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, count); NWNX_PushArgumentInt(NWNX_Creature, sFunc, class); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_LevelDown(object creature, int count=1) { string sFunc = "LevelDown"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, count); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_SetChallengeRating(object creature, float fCR) { string sFunc = "SetChallengeRating"; NWNX_PushArgumentFloat(NWNX_Creature, sFunc, fCR); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetAttackBonus(object creature, int isMelee = -1, int isTouchAttack = FALSE, int isOffhand = FALSE, int includeBaseAttackBonus = TRUE) { string sFunc = "GetAttackBonus"; if (isMelee == -1) { object oWeapon = GetItemInSlot(INVENTORY_SLOT_RIGHTHAND, creature); if (GetIsObjectValid(oWeapon)) { isMelee = !GetWeaponRanged(oWeapon); } else {// Default to melee for unarmed isMelee = TRUE; } } NWNX_PushArgumentInt(NWNX_Creature, sFunc, includeBaseAttackBonus); NWNX_PushArgumentInt(NWNX_Creature, sFunc, isOffhand); NWNX_PushArgumentInt(NWNX_Creature, sFunc, isTouchAttack); NWNX_PushArgumentInt(NWNX_Creature, sFunc, isMelee); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } int NWNX_Creature_GetHighestLevelOfFeat(object creature, int feat) { string sFunc = "GetHighestLevelOfFeat"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, feat); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } int NWNX_Creature_GetFeatRemainingUses(object creature, int feat) { string sFunc = "GetFeatRemainingUses"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, feat); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } int NWNX_Creature_GetFeatTotalUses(object creature, int feat) { string sFunc = "GetFeatTotalUses"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, feat); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } void NWNX_Creature_SetFeatRemainingUses(object creature, int feat, int uses) { string sFunc = "SetFeatRemainingUses"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, uses); NWNX_PushArgumentInt(NWNX_Creature, sFunc, feat); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetTotalEffectBonus(object creature, int bonusType=NWNX_CREATURE_BONUS_TYPE_ATTACK, object target=OBJECT_INVALID, int isElemental=0, int isForceMax=0, int savetype=-1, int saveSpecificType=-1, int skill=-1, int abilityScore=-1, int isOffhand=FALSE) { string sFunc = "GetTotalEffectBonus"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, isOffhand); NWNX_PushArgumentInt(NWNX_Creature, sFunc, abilityScore); NWNX_PushArgumentInt(NWNX_Creature, sFunc, skill); NWNX_PushArgumentInt(NWNX_Creature, sFunc, saveSpecificType); NWNX_PushArgumentInt(NWNX_Creature, sFunc, savetype); NWNX_PushArgumentInt(NWNX_Creature, sFunc, isForceMax); NWNX_PushArgumentInt(NWNX_Creature, sFunc, isElemental); NWNX_PushArgumentObject(NWNX_Creature, sFunc, target); NWNX_PushArgumentInt(NWNX_Creature, sFunc, bonusType); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } void NWNX_Creature_SetOriginalName(object creature, string name, int isLastName) { string sFunc = "SetOriginalName"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, isLastName); NWNX_PushArgumentString(NWNX_Creature, sFunc, name); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } string NWNX_Creature_GetOriginalName(object creature, int isLastName) { string sFunc = "GetOriginalName"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, isLastName); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueString(NWNX_Creature, sFunc); } void NWNX_Creature_SetSpellResistance(object creature, int sr) { string sFunc = "SetSpellResistance"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, sr); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_SetAnimalCompanionCreatureType(object creature, int type) { string sFunc = "SetAnimalCompanionCreatureType"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, type); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_SetFamiliarCreatureType(object creature, int type) { string sFunc = "SetFamiliarCreatureType"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, type); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_SetAnimalCompanionName(object creature, string name) { string sFunc = "SetAnimalCompanionName"; NWNX_PushArgumentString(NWNX_Creature, sFunc, name); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_SetFamiliarName(object creature, string name) { string sFunc = "SetFamiliarName"; NWNX_PushArgumentString(NWNX_Creature, sFunc, name); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetDisarmable(object creature) { string sFunc = "GetDisarmable"; NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } void NWNX_Creature_SetDisarmable(object creature, int disarmable) { string sFunc = "SetDisarmable"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, disarmable); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetDomain(object creature, int class, int index) { WriteTimestampedLogEntry("NWNX_Creature: GetDomain() is deprecated. Please use the basegame's GetDomain() instead"); return GetDomain(creature, index, class); } void NWNX_Creature_SetDomain(object creature, int class, int index, int domain) { string sFunc = "SetDomain"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, domain); NWNX_PushArgumentInt(NWNX_Creature, sFunc, index); NWNX_PushArgumentInt(NWNX_Creature, sFunc, class); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetSpecialization(object creature, int class) { WriteTimestampedLogEntry("NWNX_Creature: GetSpecialization() is deprecated. Please use the basegame's GetSpecialization() instead"); return GetSpecialization(creature, class); } void NWNX_Creature_SetSpecialization(object creature, int class, int school) { string sFunc = "SetSpecialization"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, school); NWNX_PushArgumentInt(NWNX_Creature, sFunc, class); NWNX_PushArgumentObject(NWNX_Creature, sFunc, creature); NWNX_CallFunction(NWNX_Creature, sFunc); } void NWNX_Creature_SetFaction(object oCreature, int nFactionId) { string sFunc = "SetFaction"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, nFactionId); NWNX_PushArgumentObject(NWNX_Creature, sFunc, oCreature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetFaction(object oCreature) { string sFunc = "GetFaction"; NWNX_PushArgumentObject(NWNX_Creature, sFunc, oCreature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } int NWNX_Creature_GetFlatFooted(object oCreature) { string sFunc = "GetFlatFooted"; NWNX_PushArgumentObject(NWNX_Creature, sFunc, oCreature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } string NWNX_Creature_SerializeQuickbar(object oCreature) { string sFunc = "SerializeQuickbar"; NWNX_PushArgumentObject(NWNX_Creature, sFunc, oCreature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueString(NWNX_Creature, sFunc); } int NWNX_Creature_DeserializeQuickbar(object oCreature, string sSerializedQuickbar) { string sFunc = "DeserializeQuickbar"; NWNX_PushArgumentString(NWNX_Creature, sFunc, sSerializedQuickbar); NWNX_PushArgumentObject(NWNX_Creature, sFunc, oCreature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } void NWNX_Creature_SetCasterLevelModifier(object oCreature, int nClass, int nModifier, int bPersist = FALSE) { string sFunc = "SetCasterLevelModifier"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, bPersist); NWNX_PushArgumentInt(NWNX_Creature, sFunc, nModifier); NWNX_PushArgumentInt(NWNX_Creature, sFunc, nClass); NWNX_PushArgumentObject(NWNX_Creature, sFunc, oCreature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetCasterLevelModifier(object oCreature, int nClass) { string sFunc = "GetCasterLevelModifier"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, nClass); NWNX_PushArgumentObject(NWNX_Creature, sFunc, oCreature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } void NWNX_Creature_SetCasterLevelOverride(object oCreature, int nClass, int nCasterLevel, int bPersist = FALSE) { string sFunc = "SetCasterLevelOverride"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, bPersist); NWNX_PushArgumentInt(NWNX_Creature, sFunc, nCasterLevel); NWNX_PushArgumentInt(NWNX_Creature, sFunc, nClass); NWNX_PushArgumentObject(NWNX_Creature, sFunc, oCreature); NWNX_CallFunction(NWNX_Creature, sFunc); } int NWNX_Creature_GetCasterLevelOverride(object oCreature, int nClass) { string sFunc = "GetCasterLevelOverride"; NWNX_PushArgumentInt(NWNX_Creature, sFunc, nClass); NWNX_PushArgumentObject(NWNX_Creature, sFunc, oCreature); NWNX_CallFunction(NWNX_Creature, sFunc); return NWNX_GetReturnValueInt(NWNX_Creature, sFunc); } void NWNX_Creature_JumpToLimbo(object oCreature) { string sFunc = "JumpToLimbo"; NWNX_PushArgumentObject(NWNX_Creature, sFunc, oCreature); NWNX_CallFunction(NWNX_Creature, sFunc); }