Readme

Functions exposing additional creature properties.

Files
file	nwnx_creature.nss

Classes
struct	NWNX_Creature_SpecialAbility
	A creature special ability. More...

Functions
void	NWNX_Creature_AddFeat (object creature, int feat)
	Gives the creature a feat. More...

void	NWNX_Creature_AddFeatByLevel (object creature, int feat, int level)
	Gives the creature a feat assigned at a level. More...

void	NWNX_Creature_RemoveFeat (object creature, int feat)
	Removes a feat from a creature. More...

void	NWNX_Creature_RemoveFeatByLevel (object creature, int feat, int level)
	Removes the creature a feat assigned at a level. More...

int	NWNX_Creature_GetKnowsFeat (object creature, int feat)
	Determines if the creature knows a feat. More...

int	NWNX_Creature_GetFeatCountByLevel (object creature, int level)
	Returns the count of feats learned at the provided level. More...

int	NWNX_Creature_GetFeatByLevel (object creature, int level, int index)
	Returns the feat learned at the level and index. More...

int	NWNX_Creature_GetFeatGrantLevel (object creature, int feat)
	Returns the creature level where the specified feat was learned. More...

int	NWNX_Creature_GetFeatCount (object creature)
	Get the total number of feats known by creature. More...

int	NWNX_Creature_GetFeatByIndex (object creature, int index)
	Returns the creature's feat at a given index. More...

int	NWNX_Creature_GetMeetsFeatRequirements (object creature, int feat)
	Gets if creature meets feat requirements. More...

int	NWNX_Creature_GetSpecialAbilityCount (object creature)
	Gets the count of special abilities of the creature. More...

struct NWNX_Creature_SpecialAbility	NWNX_Creature_GetSpecialAbility (object creature, int index)
	Returns the creature's special ability at a given index. More...

void	NWNX_Creature_AddSpecialAbility (object creature, struct NWNX_Creature_SpecialAbility ability)
	Adds a special ability to a creature. More...

void	NWNX_Creature_RemoveSpecialAbility (object creature, int index)
	Removes a special ability from a creature. More...

void	NWNX_Creature_SetSpecialAbility (object creature, int index, struct NWNX_Creature_SpecialAbility ability)
	Sets a special ability at the index for the creature. More...

int	NWNX_Creature_GetClassByLevel (object creature, int level)
	Get the class taken by the creature at the provided level. More...

void	NWNX_Creature_SetBaseAC (object creature, int ac)
	Sets the base AC for the creature. More...

int	NWNX_Creature_GetBaseAC (object creature)
	Get the base AC for the creature. More...

void	NWNX_Creature_SetRawAbilityScore (object creature, int ability, int value)
	Sets the ability score of the creature to the provided value. More...

int	NWNX_Creature_GetRawAbilityScore (object creature, int ability)
	Gets the ability score of the creature. More...

void	NWNX_Creature_ModifyRawAbilityScore (object creature, int ability, int modifier)
	Adjusts the ability score of a creature. More...

int	NWNX_Creature_GetPrePolymorphAbilityScore (object creature, int ability)
	Gets the raw ability score a polymorphed creature had prior to polymorphing. More...

int	NWNX_Creature_GetRemainingSpellSlots (object creature, int class, int level)
	Gets the remaining spell slots (innate casting) at a class level's index. More...

void	NWNX_Creature_SetRemainingSpellSlots (object creature, int class, int level, int slots)
	Sets the remaining spell slots (innate casting) at a class level. More...

int	NWNX_Creature_GetMaxSpellSlots (object creature, int class, int level)
	Gets the maximum spell slots (innate casting) at a class level. More...

void	NWNX_Creature_AddKnownSpell (object creature, int class, int level, int spellId)
	Add a spell to a creature's spellbook for class. More...

void	NWNX_Creature_RemoveKnownSpell (object creature, int class, int level, int spellId)
	Remove a spell from creature's spellbook for class. More...

int	NWNX_Creature_GetMaxHitPointsByLevel (object creature, int level)
	Gets the maximum hit points for creature for level. More...

void	NWNX_Creature_SetMaxHitPointsByLevel (object creature, int level, int value)
	Sets the maximum hit points for creature. More...

void	NWNX_Creature_SetMovementRate (object creature, int rate)
	Set creature's movement rate. More...

float	NWNX_Creature_GetMovementRateFactor (object creature)
	Returns the creature's current movement rate factor. More...

void	NWNX_Creature_SetMovementRateFactor (object creature, float rate)
	Sets the creature's current movement rate factor. More...

float	NWNX_Creature_GetMovementRateFactorCap (object creature)
	Returns the creature's maximum movement rate cap. More...

void	NWNX_Creature_SetMovementRateFactorCap (object creature, float cap)
	Sets the creature's maximum movement rate cap. More...

int	NWNX_Creature_GetMovementType (object creature)
	Returns the creature's current movement type. More...

void	NWNX_Creature_SetWalkRateCap (object creature, float fWalkRate=2000.0f)
	Sets the maximum movement rate a creature can have while walking (not running) More...

void	NWNX_Creature_SetAlignmentGoodEvil (object creature, int value)
	Set creature's raw good/evil alignment value. More...

void	NWNX_Creature_SetAlignmentLawChaos (object creature, int value)
	Set creature's raw law/chaos alignment value. More...

void	NWNX_Creature_SetSkillRank (object creature, int skill, int rank)
	Set the base ranks in a skill for creature. More...

int	NWNX_Creature_GetSkillRankByLevel (object creature, int skill, int level)
	Get the ranks in a skill for creature assigned at a level. More...

void	NWNX_Creature_SetSkillRankByLevel (object creature, int skill, int rank, int level)
	Set the ranks in a skill for creature assigned at a level. More...

void	NWNX_Creature_SetClassByPosition (object creature, int position, int classID, int bUpdateLevels=TRUE)
	Set the class ID in a particular position for a creature. More...

void	NWNX_Creature_SetLevelByPosition (object creature, int position, int level)
	Set the level at the given position for a creature. More...

void	NWNX_Creature_SetBaseAttackBonus (object creature, int bab)
	Set creature's base attack bonus (BAB). More...

int	NWNX_Creature_GetAttacksPerRound (object creature, int bBaseAPR=FALSE)
	Gets the creatures current attacks per round (using equipped weapon). More...

void	NWNX_Creature_RestoreFeats (object creature)
	Restore all creature feat uses. More...

void	NWNX_Creature_RestoreSpecialAbilities (object creature)
	Restore all creature special ability uses. More...

void	NWNX_Creature_RestoreItems (object creature)
	Restore uses for all items carried by the creature. More...

void	NWNX_Creature_SetSize (object creature, int size)
	Sets the creature size. More...

int	NWNX_Creature_GetSkillPointsRemaining (object creature)
	Gets the creature's remaining unspent skill points. More...

void	NWNX_Creature_SetSkillPointsRemaining (object creature, int skillpoints)
	Sets the creature's remaining unspent skill points. More...

int	NWNX_Creature_GetSkillPointsRemainingByLevel (object creature, int level)
	Gets the creature's remaining unspent skill points for level. More...

void	NWNX_Creature_SetSkillPointsRemainingByLevel (object creature, int level, int value)
	Sets the creature's remaining unspent skill points for level. More...

void	NWNX_Creature_SetRacialType (object creature, int racialtype)
	Sets the creature's racial type. More...

void	NWNX_Creature_SetGold (object creature, int gold)
	Sets the creature's gold without sending a feedback message. More...

void	NWNX_Creature_SetCorpseDecayTime (object creature, int nDecayTime)
	Sets corpse decay time in milliseconds. More...

int	NWNX_Creature_GetBaseSavingThrow (object creature, int which)
	Gets the creature's base save. More...

void	NWNX_Creature_SetBaseSavingThrow (object creature, int which, int value)
	Sets the creature's base save. More...

void	NWNX_Creature_LevelUp (object creature, int class, int count=1, int package=PACKAGE_INVALID)
	Add levels of class to the creature, bypassing all validation. More...

void	NWNX_Creature_LevelDown (object creature, int count=1)
	Remove last levels from a creature. More...

void	NWNX_Creature_SetChallengeRating (object creature, float fCR)
	Sets the creature's challenge rating. More...

int	NWNX_Creature_GetAttackBonus (object creature, int isMelee=-1, int isTouchAttack=FALSE, int isOffhand=FALSE, int includeBaseAttackBonus=TRUE)
	Returns the creature's highest attack bonus based on its own stats. More...

int	NWNX_Creature_GetHighestLevelOfFeat (object creature, int feat)
	Get highest level version of feat possessed by creature. More...

int	NWNX_Creature_GetFeatRemainingUses (object creature, int feat)
	Get feat remaining uses. More...

int	NWNX_Creature_GetFeatTotalUses (object creature, int feat)
	Get feat total uses. More...

void	NWNX_Creature_SetFeatRemainingUses (object creature, int feat, int uses)
	Set feat remaining uses. More...

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)
	Get total effect bonus. More...

void	NWNX_Creature_SetOriginalName (object creature, string name, int isLastName)
	Set the original first or last name of creature. More...

string	NWNX_Creature_GetOriginalName (object creature, int isLastName)
	Get the original first or last name of creature. More...

void	NWNX_Creature_SetSpellResistance (object creature, int sr)
	Set creature's spell resistance. More...

void	NWNX_Creature_SetAnimalCompanionCreatureType (object creature, int type)
	Set creature's animal companion creature type. More...

void	NWNX_Creature_SetFamiliarCreatureType (object creature, int type)
	Set creature's familiar creature type. More...

void	NWNX_Creature_SetAnimalCompanionName (object creature, string name)
	Set creature's animal companion's name. More...

void	NWNX_Creature_SetFamiliarName (object creature, string name)
	Set creature's familiar's name. More...

int	NWNX_Creature_GetDisarmable (object creature)
	Get whether the creature can be disarmed. More...

void	NWNX_Creature_SetDisarmable (object creature, int disarmable)
	Set whether a creature can be disarmed. More...

void	NWNX_Creature_SetDomain (object creature, int class, int index, int domain)
	Sets one of creature's domains. More...

void	NWNX_Creature_SetSpecialization (object creature, int class, int school)
	Sets creature's specialist school. More...

void	NWNX_Creature_SetFaction (object oCreature, int nFactionId)
	Sets oCreatures faction to be the faction with id nFactionId. More...

int	NWNX_Creature_GetFaction (object oCreature)
	Gets the faction id from oCreature. More...

int	NWNX_Creature_GetFlatFooted (object oCreature)
	Get whether a creature is flat-footed. More...

string	NWNX_Creature_SerializeQuickbar (object oCreature)
	Serialize oCreature's quickbar to a base64 string. More...

int	NWNX_Creature_DeserializeQuickbar (object oCreature, string sSerializedQuickbar)
	Deserialize sSerializedQuickbar for oCreature. More...

void	NWNX_Creature_SetCasterLevelModifier (object oCreature, int nClass, int nModifier, int bPersist=FALSE)
	Sets a caster level modifier for oCreature. More...

int	NWNX_Creature_GetCasterLevelModifier (object oCreature, int nClass)
	Gets the current caster level modifier for oCreature. More...

void	NWNX_Creature_SetCasterLevelOverride (object oCreature, int nClass, int nCasterLevel, int bPersist=FALSE)
	Sets a caster level override for oCreature. More...

int	NWNX_Creature_GetCasterLevelOverride (object oCreature, int nClass)
	Gets the current caster level override for oCreature. More...

void	NWNX_Creature_JumpToLimbo (object oCreature)
	Move a creature to limbo. More...

void	NWNX_Creature_SetCriticalMultiplierModifier (object oCreature, int nModifier, int nHand=0, int bPersist=FALSE, int nBaseItem=-1)
	Sets the critical hit multiplier modifier for the Creature. More...

int	NWNX_Creature_GetCriticalMultiplierModifier (object oCreature, int nHand=0, int nBaseItem=-1)
	Gets the critical hit multiplier modifier for the Creature. More...

void	NWNX_Creature_SetCriticalMultiplierOverride (object oCreature, int nOverride, int nHand=0, int bPersist=FALSE, int nBaseItem=-1)
	Sets the critical hit multiplier override for the Creature. More...

int	NWNX_Creature_GetCriticalMultiplierOverride (object oCreature, int nHand=0, int nBaseItem=-1)
	Gets the critical hit multiplier override for the Creature. More...

void	NWNX_Creature_SetCriticalRangeModifier (object oCreature, int nModifier, int nHand=0, int bPersist=FALSE, int nBaseItem=-1)
	Sets the critical hit range modifier for the creature. More...

int	NWNX_Creature_GetCriticalRangeModifier (object oCreature, int nHand=0, int nBaseItem=-1)
	Gets the critical hit range modifier for the creature. More...

void	NWNX_Creature_SetCriticalRangeOverride (object oCreature, int nOverride, int nHand=0, int bPersist=FALSE, int nBaseItem=-1)
	Sets the critical hit range Override for the creature. More...

int	NWNX_Creature_GetCriticalRangeOverride (object oCreature, int nHand=0, int nBaseItem=-1)
	Sets the critical hit range Override for the creature. More...

void	NWNX_Creature_AddAssociate (object oCreature, object oAssociate, int nAssociateType)
	Add oAssociate as nAssociateType to oCreature. More...

void	NWNX_Creature_OverrideDamageLevel (object oCreature, int nDamageLevel)
	Override the damage level of oCreature. More...

void	NWNX_Creature_SetEncounter (object oCreature, object oEncounter)
	Set the encounter source of oCreature. More...

object	NWNX_Creature_GetEncounter (object oCreature)
	Get the encounter source of oCreature. More...

int	NWNX_Creature_GetIsBartering (object oCreature)
	Get if oCreature is currently bartering. More...

void	NWNX_Creature_SetLastItemCasterLevel (object oCreature, int nCasterLvl)
	Sets caster level for the last item used. Use in a spellhook or spell event before to set caster level for any spells cast from the item. More...

int	NWNX_Creature_GetLastItemCasterLevel (object oCreature)
	Gets the caster level of the last item used. More...

int	NWNX_Creature_GetArmorClassVersus (object oAttacked, object oVersus, int nTouch=FALSE)
	Gets the Armor classed of attacked against versus. More...

int	NWNX_Creature_GetWalkAnimation (object oCreature)
	Gets the current walk animation of oCreature. More...

void	NWNX_Creature_SetWalkAnimation (object oCreature, int nAnimation)
	Sets the current walk animation of oCreature. More...

void	NWNX_Creature_SetAttackRollOverride (object oCreature, int nRoll, int nModifier)
	Changes the attack modifier depending on the dice roll. Used to skip autofail on 1 and autosucceed on 20 as well. More...

void	NWNX_Creature_SetParryAllAttacks (object oCreature, int bParry)
	Works like the tweak but can be turned on and off for all creatures or single ones. More...

int	NWNX_Creature_GetNoPermanentDeath (object oCreature)
	Gets the NoPermanentDeath flag of oCreature. More...

void	NWNX_Creature_SetNoPermanentDeath (object oCreature, int bNoPermanentDeath)
	Sets the NoPermanentDeath flag of oCreature. More...

vector	NWNX_Creature_ComputeSafeLocation (object oCreature, vector vPosition, float fRadius=20.0f, int bWalkStraightLineRequired=TRUE)
	Compute a safe location for oCreature. More...

void	NWNX_Creature_DoPerceptionUpdateOnCreature (object oCreature, object oTargetCreature)
	Update oCreature's perception of oTargetCreature. More...

float	NWNX_Creature_GetPersonalSpace (object oCreature)
	Get a creatures personal space (meters from center to non-creature objects). More...

void	NWNX_Creature_SetPersonalSpace (object oCreature, float fPerspace)
	Set a creatures personal space (meters from center to non-creature objects). More...

float	NWNX_Creature_GetCreaturePersonalSpace (object oCreature)
	Get a creatures creature personal space (meters from center to other creatures). More...

void	NWNX_Creature_SetCreaturePersonalSpace (object oCreature, float fCrePerspace)
	Set a creatures creature personal space (meters from center to other creatures). More...

float	NWNX_Creature_GetHeight (object oCreature)
	Get a creatures height. More...

void	NWNX_Creature_SetHeight (object oCreature, float fHeight)
	Set a creatures height. More...

float	NWNX_Creature_GetHitDistance (object oCreature)
	Get a creatures hit distance. More...

void	NWNX_Creature_SetHitDistance (object oCreature, float fHitDist)
	Set a creatures hit distance. More...

float	NWNX_Creature_GetPreferredAttackDistance (object oCreature)
	Get a creatures preferred attack distance. More...

void	NWNX_Creature_SetPreferredAttackDistance (object oCreature, float fPrefAtckDist)
	Set a creatures preferred attack distance. More...

int	NWNX_Creature_GetArmorCheckPenalty (object oCreature)
	Get the skill penalty from wearing armor. More...

int	NWNX_Creature_GetShieldCheckPenalty (object oCreature)
	Get the skill penalty from wearing a shield. More...

void	NWNX_Creature_SetBypassEffectImmunity (object oCreature, int nImmunityType, int nChance=100, int bPersist=FALSE)
	Sets a chance for normal Effect Immunities to be bypassed. More...

int	NWNX_Creature_GetBypassEffectImmunity (object oCreature, int nImmunityType)
	Gets a chance for normal Effect Immunities to be bypassed. More...

void	NWNX_Creature_SetLastKiller (object oCreature, object oKiller)
	Sets the killer of oCreature to oKiller. More...

void	NWNX_Creature_DoItemCastSpell (object oCreature, object oTarget, location locTarget, int nSpellID, int nCasterLevel, float fProjectileTime, int nProjectilePathType=PROJECTILE_PATH_TYPE_DEFAULT, int nProjectileSpellID=-1, object oItem=OBJECT_INVALID, string sImpactScript="")
	Instantly cast a spell at a target or location. More...

int	NWNX_Creature_RunEquip (object oCreature, object oItem, int nInventorySlot)
	Have oCreature instantly equip oItem to nInventorySlot. More...

int	NWNX_Creature_RunUnequip (object oCreature, object oItem)
	Have oCreature instantly unequip oItem. More...

void	NWNX_Creature_OverrideRangedProjectileVFX (object oCreature, int nProjectileVFX, int bPersist=FALSE)
	Override the elemental projectile visual effect of ranged/throwing weapons. More...

void	NWNX_Creature_SetInitiativeModifier (object oCreature, int nMod, int bPersist=FALSE)
	Sets a custom Initiative modifier. More...

int	NWNX_Creature_GetInitiativeModifier (object oCreature)
	Gets the custom Initiative modifier. More...

object	NWNX_Creature_GetBodyBag (object oCreature)
	Gets the Body Bag of a creature. More...

int	NWNX_Creature_AddCastSpellActions (object oCreature, object oTarget, vector vTargetLocation, int nSpellID, int nMultiClass, int nMetaMagic=METAMAGIC_NONE, int nDomainLevel=0, int nProjectilePathType=PROJECTILE_PATH_TYPE_DEFAULT, int bInstant=FALSE, int bClearActions=FALSE, int bAddToFront=FALSE)
	Add a cast spell action to oCreature's action queue. More...

int	NWNX_Creature_GetIsFlanking (object oCreature, object oTargetCreature)
	Get whether oCreature is flanking oTargetCreature. More...

void	NWNX_Creature_DecrementRemainingSpellSlots (object oCreature, int nClass, int nSpellLevel)
	Decrements the remaining spell slots (innate casting) at a class level. More...

void	NWNX_Creature_IncrementRemainingSpellSlots (object oCreature, int nClass, int nSpellLevel)
	Increments the remaining spell slots (innate casting) at a class level. More...

int	NWNX_Creature_GetMaximumBonusAttacks (object oCreature)
	Gets the maximum number of bonus attacks a creature can have from EffectModifyAttacks(). More...

void	NWNX_Creature_SetMaximumBonusAttacks (object oCreature, int nMaxBonusAttacks, int bPersist=FALSE)
	Sets the maximum number of bonus attacks a creature can have from EffectModifyAttacks(). More...

void	NWNX_Creature_DoCleaveAttack (object oCreature)
	Inserts a cleave or great cleave attack into oCreature's current attack round against the nearest enemy within melee reach. More...

object	NWNX_Creature_GetLockOrientationToObject (object oCreature)
	Gets the current object oCreature's orientation is locked to. More...

void	NWNX_Creature_SetLockOrientationToObject (object oCreature, object oTarget)
	Locks oCreature's orientation to always face oTarget. More...

void	NWNX_Creature_BroadcastAttackOfOpportunity (object oCreature, object oSingleCreature=OBJECT_INVALID, int bMovement=FALSE)
	Causes oCreature to broadcast an Attack of Opportunity against themself. More...

int	NWNX_Creature_GetMaxSellToStorePriceOverride (object oCreature, object oStore)
	Returns the maximum price oStore will buy items from oCreature for. More...

void	NWNX_Creature_SetMaxSellToStorePriceOverride (object oCreature, object oStore, int nMaxSellToPrice)
	Overrides the maximum price oStore will buy items from oCreature for. More...

int	NWNX_Creature_GetAbilityIncreaseByLevel (object oCreature, int nLevel)
	Returns the creature's ability increase for nLevel. More...

void	NWNX_Creature_SetAbilityIncreaseByLevel (object oCreature, int nLevel, int nAbility)
	Sets the creature's ability increase for nLevel. More...

float	NWNX_Creature_GetMaxAttackRange (object oCreature, object oTarget)
	Returns the creature's maximum attack range to a target. More...

int	NWNX_Creature_GetMulticlassLimit (object oCreature)
	Returns the creature's multiclass limit. More...

void	NWNX_Creature_SetMulticlassLimit (object oCreature, int nLimit, int bPersist=FALSE)
	Sets the creature's multiclass limit. More...

Variables
const int	NWNX_CREATURE_ABILITY_NONE = 6

Function Documentation

◆ NWNX_Creature_AddFeat()

void NWNX_Creature_AddFeat	(	object	creature,
		int	feat
	)

Gives the creature a feat.

Parameters

creature	The creature object.
feat	The feat id.

Remarks: Consider also using NWNX_Creature_AddFeatByLevel() to properly allocate the feat to a level

Definition at line 1029 of file nwnx_creature.nss.

◆ NWNX_Creature_AddFeatByLevel()

void NWNX_Creature_AddFeatByLevel	(	object	creature,
		int	feat,
		int	level
	)

Gives the creature a feat assigned at a level.

Parameters

creature	The creature object.
feat	The feat id.
level	The level they gained the feat.

Remarks: Adds the feat to the stat list at the provided level.

Definition at line 1038 of file nwnx_creature.nss.

◆ NWNX_Creature_RemoveFeat()

void NWNX_Creature_RemoveFeat	(	object	creature,
		int	feat
	)

Removes a feat from a creature.

Parameters

creature	The creature object.
feat	The feat id.

Definition at line 1049 of file nwnx_creature.nss.

◆ NWNX_Creature_RemoveFeatByLevel()

void NWNX_Creature_RemoveFeatByLevel	(	object	creature,
		int	feat,
		int	level
	)

Removes the creature a feat assigned at a level.

Parameters

creature	The creature object.
feat	The feat id.
level	The level they gained the feat.

Remarks: Removes the feat from the stat list at the provided level. Does not remove the feat from the creature, use NWNX_Creature_RemoveFeat for this.

Definition at line 1058 of file nwnx_creature.nss.

◆ NWNX_Creature_GetKnowsFeat()

int NWNX_Creature_GetKnowsFeat	(	object	creature,
		int	feat
	)

Determines if the creature knows a feat.

Note: This differs from native GetHasFeat which returns FALSE if the feat has no more uses per day.

Parameters

creature	The creature object.
feat	The feat id.

Returns: TRUE if the creature has the feat, regardless if they have any usages left or not.

Definition at line 1069 of file nwnx_creature.nss.

◆ NWNX_Creature_GetFeatCountByLevel()

int NWNX_Creature_GetFeatCountByLevel	(	object	creature,
		int	level
	)

Returns the count of feats learned at the provided level.

Parameters

creature	The creature object.
level	The level.

Returns: The count of feats.

Definition at line 1080 of file nwnx_creature.nss.

◆ NWNX_Creature_GetFeatByLevel()

int NWNX_Creature_GetFeatByLevel	(	object	creature,
		int	level,
		int	index
	)

Returns the feat learned at the level and index.

Parameters

creature	The creature object.
level	The level.
index	The index. Index bounds: 0 <= index < NWNX_Creature_GetFeatCountByLevel().

Returns: The feat id at the index.

Definition at line 1091 of file nwnx_creature.nss.

◆ NWNX_Creature_GetFeatGrantLevel()

int NWNX_Creature_GetFeatGrantLevel	(	object	creature,
		int	feat
	)

Returns the creature level where the specified feat was learned.

Parameters

creature	The creature object.
feat	The feat id.

Returns: The character level that the specified feat was granted, otherwise 0 if the creature does not have this feat.

Definition at line 1113 of file nwnx_creature.nss.

◆ NWNX_Creature_GetFeatCount()

int NWNX_Creature_GetFeatCount ( object creature )

Get the total number of feats known by creature.

Parameters

creature The creature object.

Returns: The total feat count for the creature.

Definition at line 1103 of file nwnx_creature.nss.

◆ NWNX_Creature_GetFeatByIndex()

int NWNX_Creature_GetFeatByIndex	(	object	creature,
		int	index
	)

Returns the creature's feat at a given index.

Parameters

creature	The creature object.
index	The index. Index bounds: 0 <= index < NWNX_Creature_GetFeatCount();

Returns: The feat id at the index.

Definition at line 1123 of file nwnx_creature.nss.

◆ NWNX_Creature_GetMeetsFeatRequirements()

int NWNX_Creature_GetMeetsFeatRequirements	(	object	creature,
		int	feat
	)

Gets if creature meets feat requirements.

Parameters

creature	The creature object.
feat	The feat id.

Returns: TRUE if creature meets all requirements to take given feat

Definition at line 1134 of file nwnx_creature.nss.

◆ NWNX_Creature_GetSpecialAbilityCount()

int NWNX_Creature_GetSpecialAbilityCount ( object creature )

Gets the count of special abilities of the creature.

Parameters

creature The creature object.

Returns: The total special ability count.

Definition at line 1163 of file nwnx_creature.nss.

◆ NWNX_Creature_GetSpecialAbility()

struct NWNX_Creature_SpecialAbility NWNX_Creature_GetSpecialAbility	(	object	creature,
		int	index
	)

Returns the creature's special ability at a given index.

Parameters

creature	The creature object.
index	The index. Index bounds: 0 <= index < NWNX_Creature_GetSpecialAbilityCount().

Returns: An NWNX_Creature_SpecialAbility struct.

Definition at line 1145 of file nwnx_creature.nss.

◆ NWNX_Creature_AddSpecialAbility()

void NWNX_Creature_AddSpecialAbility	(	object	creature,
		struct NWNX_Creature_SpecialAbility	ability
	)

Adds a special ability to a creature.

Parameters

creature	The creature object.
ability	An NWNX_Creature_SpecialAbility struct.

Definition at line 1173 of file nwnx_creature.nss.

◆ NWNX_Creature_RemoveSpecialAbility()

void NWNX_Creature_RemoveSpecialAbility	(	object	creature,
		int	index
	)

Removes a special ability from a creature.

Parameters

creature	The creature object.
index	The index. Index bounds: 0 <= index < NWNX_Creature_GetSpecialAbilityCount().

Definition at line 1185 of file nwnx_creature.nss.

◆ NWNX_Creature_SetSpecialAbility()

void NWNX_Creature_SetSpecialAbility	(	object	creature,
		int	index,
		struct NWNX_Creature_SpecialAbility	ability
	)

Sets a special ability at the index for the creature.

Parameters

creature	The creature object.
index	The index. Index bounds: 0 <= index < NWNX_Creature_GetSpecialAbilityCount().
ability	An NWNX_Creature_SpecialAbility struct.

Definition at line 1195 of file nwnx_creature.nss.

◆ NWNX_Creature_GetClassByLevel()

int NWNX_Creature_GetClassByLevel	(	object	creature,
		int	level
	)

Get the class taken by the creature at the provided level.

Parameters

creature	The creature object.
level	The level.

Returns: The class id.

Definition at line 1208 of file nwnx_creature.nss.

◆ NWNX_Creature_SetBaseAC()

void NWNX_Creature_SetBaseAC	(	object	creature,
		int	ac
	)

Sets the base AC for the creature.

Parameters

creature	The creature object.
ac	The base AC to set for the creature.

Definition at line 1219 of file nwnx_creature.nss.

◆ NWNX_Creature_GetBaseAC()

int NWNX_Creature_GetBaseAC ( object creature )

Get the base AC for the creature.

Parameters

creature The creature object.

Returns: The base AC.

Definition at line 1229 of file nwnx_creature.nss.

◆ NWNX_Creature_SetRawAbilityScore()

void NWNX_Creature_SetRawAbilityScore	(	object	creature,
		int	ability,
		int	value
	)

Sets the ability score of the creature to the provided value.

Note: Does not apply racial bonuses/penalties.

Parameters

creature	The creature object.
ability	The ability constant.
value	The value to set.

Definition at line 1239 of file nwnx_creature.nss.

◆ NWNX_Creature_GetRawAbilityScore()

int NWNX_Creature_GetRawAbilityScore	(	object	creature,
		int	ability
	)

Gets the ability score of the creature.

Note: Does not apply racial bonuses/penalties.

Parameters

creature	The creature object.
ability	The ability constant.

Returns: The ability score.

Definition at line 1250 of file nwnx_creature.nss.

◆ NWNX_Creature_ModifyRawAbilityScore()

void NWNX_Creature_ModifyRawAbilityScore	(	object	creature,
		int	ability,
		int	modifier
	)

Adjusts the ability score of a creature.

Note: Does not apply racial bonuses/penalties.

Parameters

creature	The creature object.
ability	The ability constant.
modifier	The modifier value.

Definition at line 1261 of file nwnx_creature.nss.

◆ NWNX_Creature_GetPrePolymorphAbilityScore()

int NWNX_Creature_GetPrePolymorphAbilityScore	(	object	creature,
		int	ability
	)

Gets the raw ability score a polymorphed creature had prior to polymorphing.

Note: For Strength, Dexterity and Constitution only.

Parameters

creature	The creature object.
ability	The ability constant.

Returns: The raw ability score.

Definition at line 1272 of file nwnx_creature.nss.

◆ NWNX_Creature_GetRemainingSpellSlots()

int NWNX_Creature_GetRemainingSpellSlots	(	object	creature,
		int	class,
		int	level
	)

Gets the remaining spell slots (innate casting) at a class level's index.

Parameters

creature	The creature object.
class	The class id from classes.2da. (Not class index 0-2)
level	The spell level.

Returns: The remaining spell slot count.

Definition at line 1283 of file nwnx_creature.nss.

◆ NWNX_Creature_SetRemainingSpellSlots()

void NWNX_Creature_SetRemainingSpellSlots	(	object	creature,
		int	class,
		int	level,
		int	slots
	)

Sets the remaining spell slots (innate casting) at a class level.

Parameters

creature	The creature object.
class	The class id from classes.2da. (Not class index 0-2)
level	The spell level.
slots	The remaining spell slots to set.

Definition at line 1295 of file nwnx_creature.nss.

◆ NWNX_Creature_GetMaxSpellSlots()

int NWNX_Creature_GetMaxSpellSlots	(	object	creature,
		int	class,
		int	level
	)

Gets the maximum spell slots (innate casting) at a class level.

Parameters

creature	The creature object.
class	The class id from classes.2da. (Not class index 0-2)
level	The spell level.

Returns: The maximum spell slot count.

Definition at line 1331 of file nwnx_creature.nss.

◆ NWNX_Creature_AddKnownSpell()

void NWNX_Creature_AddKnownSpell	(	object	creature,
		int	class,
		int	level,
		int	spellId
	)

Add a spell to a creature's spellbook for class.

Parameters

creature	The creature object.
class	The class id from classes.2da. (Not class index 0-2)
level	The spell level.
spellId	The spell to remove.

Definition at line 1319 of file nwnx_creature.nss.

◆ NWNX_Creature_RemoveKnownSpell()

void NWNX_Creature_RemoveKnownSpell	(	object	creature,
		int	class,
		int	level,
		int	spellId
	)

Remove a spell from creature's spellbook for class.

Parameters

creature	The creature object.
class	The class id from classes.2da. (Not class index 0-2)
level	The spell level.
spellId	The spell to remove.

Definition at line 1307 of file nwnx_creature.nss.

◆ NWNX_Creature_GetMaxHitPointsByLevel()

int NWNX_Creature_GetMaxHitPointsByLevel	(	object	creature,
		int	level
	)

Gets the maximum hit points for creature for level.

Parameters

creature	The creature object.
level	The level.

Returns: The maximum hit points a creature can have for the class at the provided level.

Definition at line 1344 of file nwnx_creature.nss.

◆ NWNX_Creature_SetMaxHitPointsByLevel()

void NWNX_Creature_SetMaxHitPointsByLevel	(	object	creature,
		int	level,
		int	value
	)

Sets the maximum hit points for creature.

Parameters

creature	The creature object.
level	The level.
value	The amount to set the max hit points.

Definition at line 1355 of file nwnx_creature.nss.

◆ NWNX_Creature_SetMovementRate()

void NWNX_Creature_SetMovementRate	(	object	creature,
		int	rate
	)

Set creature's movement rate.

Parameters

creature	The creature object.
rate	The movement rate.

Definition at line 1366 of file nwnx_creature.nss.

◆ NWNX_Creature_GetMovementRateFactor()

float NWNX_Creature_GetMovementRateFactor ( object creature )

Returns the creature's current movement rate factor.

Remarks: Base movement rate factor is 1.0.

Parameters

creature The creature object.

Returns: The current movement rate factor.

Definition at line 1376 of file nwnx_creature.nss.

◆ NWNX_Creature_SetMovementRateFactor()

void NWNX_Creature_SetMovementRateFactor	(	object	creature,
		float	rate
	)

Sets the creature's current movement rate factor.

Note: Base movement rate factor is 1.0.

Parameters

creature	The creature object.
rate	The rate to set.

Definition at line 1385 of file nwnx_creature.nss.

◆ NWNX_Creature_GetMovementRateFactorCap()

float NWNX_Creature_GetMovementRateFactorCap ( object creature )

Returns the creature's maximum movement rate cap.

Remarks: Default movement rate cap is 1.5.

Parameters

creature The creature object.

Returns: The maximum movement rate cap.

Definition at line 1395 of file nwnx_creature.nss.

◆ NWNX_Creature_SetMovementRateFactorCap()

void NWNX_Creature_SetMovementRateFactorCap	(	object	creature,
		float	cap
	)

Sets the creature's maximum movement rate cap.

Note: Default movement rate cap is 1.5.

Parameters

creature	The creature object.
cap	The cap to set.

Definition at line 1404 of file nwnx_creature.nss.

◆ NWNX_Creature_GetMovementType()

int NWNX_Creature_GetMovementType ( object creature )

Returns the creature's current movement type.

Parameters

creature The creature object.

Returns: An NWNX_CREATURE_MOVEMENT_TYPE_* constant.

Definition at line 1591 of file nwnx_creature.nss.

◆ NWNX_Creature_SetWalkRateCap()

void NWNX_Creature_SetWalkRateCap	(	object	creature,
		float	fWalkRate = `2000.0f`
	)

Sets the maximum movement rate a creature can have while walking (not running)

Remarks: This allows a creature with movement speed enhancements to walk at a normal rate.

Parameters

creature	The creature object.
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.

Definition at line 1600 of file nwnx_creature.nss.

◆ NWNX_Creature_SetAlignmentGoodEvil()

void NWNX_Creature_SetAlignmentGoodEvil	(	object	creature,
		int	value
	)

Set creature's raw good/evil alignment value.

Parameters

creature	The creature object.
value	The value to set.

Definition at line 1414 of file nwnx_creature.nss.

◆ NWNX_Creature_SetAlignmentLawChaos()

void NWNX_Creature_SetAlignmentLawChaos	(	object	creature,
		int	value
	)

Set creature's raw law/chaos alignment value.

Parameters

creature	The creature object.
value	The value to set.

Definition at line 1424 of file nwnx_creature.nss.

◆ NWNX_Creature_SetSkillRank()

void NWNX_Creature_SetSkillRank	(	object	creature,
		int	skill,
		int	rank
	)

Set the base ranks in a skill for creature.

Parameters

creature	The creature object.
skill	The skill id.
rank	The value to set as the skill rank.

Definition at line 1434 of file nwnx_creature.nss.

◆ NWNX_Creature_GetSkillRankByLevel()

int NWNX_Creature_GetSkillRankByLevel	(	object	creature,
		int	skill,
		int	level
	)

Get the ranks in a skill for creature assigned at a level.

Parameters

creature	The creature object.
skill	The skill id.
level	The level they gained skill ranks.

Returns: The rank in a skill assigned at a level (-1 on error).

Definition at line 1444 of file nwnx_creature.nss.

◆ NWNX_Creature_SetSkillRankByLevel()

void NWNX_Creature_SetSkillRankByLevel	(	object	creature,
		int	skill,
		int	rank,
		int	level
	)

Set the ranks in a skill for creature assigned at a level.

Note: It only affect the leveling array, to know what to do on level-down. To effectivly change the skill rank on the current level, NWNX_Creature_SetSkillRank is also needed.

Parameters

creature	The creature object.
skill	The skill id.
level	The level they gained skill ranks.
rank	The value to set as the skill rank.

Definition at line 1456 of file nwnx_creature.nss.

◆ NWNX_Creature_SetClassByPosition()

void NWNX_Creature_SetClassByPosition	(	object	creature,
		int	position,
		int	classID,
		int	bUpdateLevels = `TRUE`
	)

Set the class ID in a particular position for a creature.

Parameters

creature	The creature object.
position	Should be 0, 1, or 2 depending on how many classes the creature has and which is to be modified.
classID	A valid ID number in classes.2da and between 0 and 255.
bUpdateLevels	determines whether the method will replace all occurrences of the old class in CNWLevelStats with the new classID.

Definition at line 1468 of file nwnx_creature.nss.

◆ NWNX_Creature_SetLevelByPosition()

void NWNX_Creature_SetLevelByPosition	(	object	creature,
		int	position,
		int	level
	)

Set the level at the given position for a creature.

Note: A creature should already have a class in that position.

Parameters

creature	The creature object.
position	Should be 0, 1, or 2 depending on how many classes the creature has and which is to be modified.
level	The level to set.

Definition at line 1479 of file nwnx_creature.nss.

◆ NWNX_Creature_SetBaseAttackBonus()

void NWNX_Creature_SetBaseAttackBonus	(	object	creature,
		int	bab
	)

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.

Parameters

creature	The creature object.
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.

Remarks: The base game has a function SetBaseAttackBonus, which actually sets the bonus attacks per round for a creature, not the BAB.

Definition at line 1489 of file nwnx_creature.nss.

◆ NWNX_Creature_GetAttacksPerRound()

int NWNX_Creature_GetAttacksPerRound	(	object	creature,
		int	bBaseAPR = `FALSE`
	)

Gets the creatures current attacks per round (using equipped weapon).

Parameters

creature	The creature object.
bBaseAPR	If TRUE, will return the base attacks per round, based on BAB and equipped weapons, regardless of overrides set by calls to SetBaseAttackBonus builtin function.

Returns: The attacks per round.

Definition at line 1498 of file nwnx_creature.nss.

◆ NWNX_Creature_RestoreFeats()

void NWNX_Creature_RestoreFeats ( object creature )

Restore all creature feat uses.

Parameters

creature The creature object.

Definition at line 1508 of file nwnx_creature.nss.

◆ NWNX_Creature_RestoreSpecialAbilities()

void NWNX_Creature_RestoreSpecialAbilities ( object creature )

Restore all creature special ability uses.

Parameters

creature The creature object.

Definition at line 1516 of file nwnx_creature.nss.

◆ NWNX_Creature_RestoreItems()

void NWNX_Creature_RestoreItems ( object creature )

Restore uses for all items carried by the creature.

Parameters

creature The creature object.

Definition at line 1524 of file nwnx_creature.nss.

◆ NWNX_Creature_SetSize()

void NWNX_Creature_SetSize	(	object	creature,
		int	size
	)

Sets the creature size.

Parameters

creature	The creature object.
size	Use CREATURE_SIZE_* constants.

Definition at line 1532 of file nwnx_creature.nss.

◆ NWNX_Creature_GetSkillPointsRemaining()

int NWNX_Creature_GetSkillPointsRemaining ( object creature )

Gets the creature's remaining unspent skill points.

Parameters

creature The creature object.

Returns: The remaining unspent skill points.

Definition at line 1541 of file nwnx_creature.nss.

◆ NWNX_Creature_SetSkillPointsRemaining()

void NWNX_Creature_SetSkillPointsRemaining	(	object	creature,
		int	skillpoints
	)

Sets the creature's remaining unspent skill points.

Parameters

creature	The creature object.
skillpoints	The value to set.

Definition at line 1551 of file nwnx_creature.nss.

◆ NWNX_Creature_GetSkillPointsRemainingByLevel()

int NWNX_Creature_GetSkillPointsRemainingByLevel	(	object	creature,
		int	level
	)

Gets the creature's remaining unspent skill points for level.

Parameters

creature	The creature object.
level	The level.

Returns: The remaining unspent skill points for level.

Definition at line 1560 of file nwnx_creature.nss.

◆ NWNX_Creature_SetSkillPointsRemainingByLevel()

void NWNX_Creature_SetSkillPointsRemainingByLevel	(	object	creature,
		int	level,
		int	value
	)

Sets the creature's remaining unspent skill points for level.

Parameters

creature	The creature object.
level	The level.
value	The value to set for level.

Definition at line 1571 of file nwnx_creature.nss.

◆ NWNX_Creature_SetRacialType()

void NWNX_Creature_SetRacialType	(	object	creature,
		int	racialtype
	)

Sets the creature's racial type.

Parameters

creature	The creature object.
racialtype	The racial type to set.

Definition at line 1582 of file nwnx_creature.nss.

◆ NWNX_Creature_SetGold()

void NWNX_Creature_SetGold	(	object	creature,
		int	gold
	)

Sets the creature's gold without sending a feedback message.

Parameters

creature	The creature object.
gold	The amount of gold to set for their creature.

Definition at line 1609 of file nwnx_creature.nss.

◆ NWNX_Creature_SetCorpseDecayTime()

void NWNX_Creature_SetCorpseDecayTime	(	object	creature,
		int	nDecayTime
	)

Sets corpse decay time in milliseconds.

Parameters

creature	The creature object.
nDecayTime	The corpse decay time.

Definition at line 1618 of file nwnx_creature.nss.

◆ NWNX_Creature_GetBaseSavingThrow()

int NWNX_Creature_GetBaseSavingThrow	(	object	creature,
		int	which
	)

Gets the creature's base save.

Parameters

creature	The creature object.
which	One of SAVING_THROW_FORT, SAVING_THROW_REFLEX or SAVING_THROW_WILL

Returns: The base save value.

Note: This will include any modifiers set in the toolset.

Definition at line 1628 of file nwnx_creature.nss.

◆ NWNX_Creature_SetBaseSavingThrow()

void NWNX_Creature_SetBaseSavingThrow	(	object	creature,
		int	which,
		int	value
	)

Sets the creature's base save.

Parameters

creature	The creature object.
which	One of SAVING_THROW_FORT, SAVING_THROW_REFLEX or SAVING_THROW_WILL
value	The base save value.

Definition at line 1638 of file nwnx_creature.nss.

◆ NWNX_Creature_LevelUp()

void NWNX_Creature_LevelUp	(	object	creature,
		int	class,
		int	count = `1`,
		int	package = `PACKAGE_INVALID`
	)

Add levels of class to the creature, bypassing all validation.

Parameters

creature	The creature object.
class	The class id.
count	The amount of levels of class to add.
package	The class package to use for leveling up (PACKAGE_INVALID = starting package)

Note: This will not work on player characters.

Definition at line 1648 of file nwnx_creature.nss.

◆ NWNX_Creature_LevelDown()

void NWNX_Creature_LevelDown	(	object	creature,
		int	count = `1`
	)

Remove last levels from a creature.

Parameters

creature	The creature object.
count	The amount of levels to decrement.

Note: This will not work on player characters.

Definition at line 1659 of file nwnx_creature.nss.

◆ NWNX_Creature_SetChallengeRating()

void NWNX_Creature_SetChallengeRating	(	object	creature,
		float	fCR
	)

Sets the creature's challenge rating.

Parameters

creature	The creature object.
fCR	The challenge rating.

Definition at line 1668 of file nwnx_creature.nss.

◆ NWNX_Creature_GetAttackBonus()

int NWNX_Creature_GetAttackBonus	(	object	creature,
		int	isMelee = `-1`,
		int	isTouchAttack = `FALSE`,
		int	isOffhand = `FALSE`,
		int	includeBaseAttackBonus = `TRUE`
	)

Returns the creature's highest attack bonus based on its own stats.

Note: AB vs. Type and +AB on Gauntlets are excluded

Parameters

creature	The creature object.
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
isTouchAttack	If the attack was a touch attack.
isOffhand	If the attack was with the offhand.
includeBaseAttackBonus	Should the result include the base attack bonus.

Returns: The highest attack bonus.

Definition at line 1677 of file nwnx_creature.nss.

◆ NWNX_Creature_GetHighestLevelOfFeat()

int NWNX_Creature_GetHighestLevelOfFeat	(	object	creature,
		int	feat
	)

Get highest level version of feat possessed by creature.

Remarks: For feats that increment in power, for example, barbarian rage.

Parameters

creature	The creature object.
feat	The feat id.

Returns: The highest level version of the feat.

Definition at line 1705 of file nwnx_creature.nss.

◆ NWNX_Creature_GetFeatRemainingUses()

int NWNX_Creature_GetFeatRemainingUses	(	object	creature,
		int	feat
	)

Get feat remaining uses.

Parameters

creature	The creature object.
feat	The feat id.

Returns: The amount of remaining uses.

Definition at line 1716 of file nwnx_creature.nss.

◆ NWNX_Creature_GetFeatTotalUses()

int NWNX_Creature_GetFeatTotalUses	(	object	creature,
		int	feat
	)

Get feat total uses.

Parameters

creature	The creature object.
feat	The feat id.

Returns: The total uses.

Definition at line 1727 of file nwnx_creature.nss.

◆ NWNX_Creature_SetFeatRemainingUses()

void NWNX_Creature_SetFeatRemainingUses	(	object	creature,
		int	feat,
		int	uses
	)

Set feat remaining uses.

Parameters

creature	The creature object.
feat	The feat id.
uses	The amount of remaining uses.

Definition at line 1738 of file nwnx_creature.nss.

◆ NWNX_Creature_GetTotalEffectBonus()

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`
	)

Get total effect bonus.

Remarks: 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.

Parameters

creature	The creature object.
bonusType	A Bonus Type
target	A target object. Used to calculate bonuses versus specific races, alignments, etc.
isElemental	If a damage bonus includes elemental damage.
isForceMax	If the bonus should return the maximum possible.
savetype	A SAVING_THROW_* constant.
saveSpecificType	A SAVING_THROW_TYPE_* constant.
skill	A skill id.
abilityScore	An ABILITY_* constant.
isOffhand	Whether the attack is an offhand attack.

Returns: The bonus value.

Definition at line 1749 of file nwnx_creature.nss.

◆ NWNX_Creature_SetOriginalName()

void NWNX_Creature_SetOriginalName	(	object	creature,
		string	name,
		int	isLastName
	)

Set the original first or last name of creature.

Parameters

creature	The creature object.
name	The name to give the creature.
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.

Definition at line 1768 of file nwnx_creature.nss.

◆ NWNX_Creature_GetOriginalName()

string NWNX_Creature_GetOriginalName	(	object	creature,
		int	isLastName
	)

Get the original first or last name of creature.

Parameters

creature	The creature object.
isLastName	TRUE to get last name, FALSE for first name.

Returns: The original first or last name of the creature.

Definition at line 1779 of file nwnx_creature.nss.

◆ NWNX_Creature_SetSpellResistance()

void NWNX_Creature_SetSpellResistance	(	object	creature,
		int	sr
	)

Set creature's spell resistance.

Parameters

creature	The creature object.
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.

Definition at line 1790 of file nwnx_creature.nss.

◆ NWNX_Creature_SetAnimalCompanionCreatureType()

void NWNX_Creature_SetAnimalCompanionCreatureType	(	object	creature,
		int	type
	)

Set creature's animal companion creature type.

Parameters

creature	The master creature object.
type	The type from ANIMAL_COMPANION_CREATURE_TYPE_*.

Definition at line 1800 of file nwnx_creature.nss.

◆ NWNX_Creature_SetFamiliarCreatureType()

void NWNX_Creature_SetFamiliarCreatureType	(	object	creature,
		int	type
	)

Set creature's familiar creature type.

Parameters

creature	The master creature object.
type	The type from FAMILIAR_CREATURE_TYPE_*.

Definition at line 1810 of file nwnx_creature.nss.

◆ NWNX_Creature_SetAnimalCompanionName()

void NWNX_Creature_SetAnimalCompanionName	(	object	creature,
		string	name
	)

Set creature's animal companion's name.

Parameters

creature	The master creature object.
name	The name to give their animal companion.

Definition at line 1820 of file nwnx_creature.nss.

◆ NWNX_Creature_SetFamiliarName()

void NWNX_Creature_SetFamiliarName	(	object	creature,
		string	name
	)

Set creature's familiar's name.

Parameters

creature	The master creature object.
name	The name to give their familiar.

Definition at line 1830 of file nwnx_creature.nss.

◆ NWNX_Creature_GetDisarmable()

int NWNX_Creature_GetDisarmable ( object creature )

Get whether the creature can be disarmed.

Parameters

creature The creature object.

Returns: TRUE if the creature can be disarmed.

Definition at line 1840 of file nwnx_creature.nss.

◆ NWNX_Creature_SetDisarmable()

void NWNX_Creature_SetDisarmable	(	object	creature,
		int	disarmable
	)

Set whether a creature can be disarmed.

Parameters

creature	The creature object.
disarmable	Set to TRUE if the creature can be disarmed.

Definition at line 1850 of file nwnx_creature.nss.

◆ NWNX_Creature_SetDomain()

void NWNX_Creature_SetDomain	(	object	creature,
		int	class,
		int	index,
		int	domain
	)

Sets one of creature's domains.

Parameters

creature	The creature object.
class	The class id from classes.2da. (Not class index 0-2)
index	The first or second domain.
domain	The domain constant to set.

Definition at line 1860 of file nwnx_creature.nss.

◆ NWNX_Creature_SetSpecialization()

void NWNX_Creature_SetSpecialization	(	object	creature,
		int	class,
		int	school
	)

Sets creature's specialist school.

Parameters

creature	The creature object.
class	The class id from classes.2da. (Not class index 0-2)
school	The school constant.

Definition at line 1872 of file nwnx_creature.nss.

◆ NWNX_Creature_SetFaction()

void NWNX_Creature_SetFaction	(	object	oCreature,
		int	nFactionId
	)

Sets oCreatures faction to be the faction with id nFactionId.

Parameters

oCreature	The creature.
nFactionId	The faction id we want the creature to join.

Definition at line 1883 of file nwnx_creature.nss.

◆ NWNX_Creature_GetFaction()

int NWNX_Creature_GetFaction ( object oCreature )

Gets the faction id from oCreature.

Parameters

oCreature the creature we wish to query against

Returns: faction id as an integer, -1 when used against invalid creature or invalid object.

Definition at line 1891 of file nwnx_creature.nss.

◆ NWNX_Creature_GetFlatFooted()

int NWNX_Creature_GetFlatFooted ( object oCreature )

Get whether a creature is flat-footed.

Parameters

oCreature The creature object.

Returns: TRUE if the creature is flat-footed.

Definition at line 1899 of file nwnx_creature.nss.

◆ NWNX_Creature_SerializeQuickbar()

string NWNX_Creature_SerializeQuickbar ( object oCreature )

Serialize oCreature's quickbar to a base64 string.

Parameters

oCreature The creature.

Returns: A base64 string representation of oCreature's quickbar.

Definition at line 1907 of file nwnx_creature.nss.

◆ NWNX_Creature_DeserializeQuickbar()

int NWNX_Creature_DeserializeQuickbar	(	object	oCreature,
		string	sSerializedQuickbar
	)

Deserialize sSerializedQuickbar for oCreature.

Parameters

oCreature	The creature.
sSerializedQuickbar	A base64 string of a quickbar

Returns: TRUE on success

Definition at line 1917 of file nwnx_creature.nss.

◆ NWNX_Creature_SetCasterLevelModifier()

void NWNX_Creature_SetCasterLevelModifier	(	object	oCreature,
		int	nClass,
		int	nModifier,
		int	bPersist = `FALSE`
	)

Sets a caster level modifier for oCreature.

Parameters

oCreature	the target creature
nClass	the class that this modifier will apply to
nModifier	the modifier to apply
bPersist	whether the modifier should be persisted to the .bic file if applicable

Definition at line 1928 of file nwnx_creature.nss.

◆ NWNX_Creature_GetCasterLevelModifier()

int NWNX_Creature_GetCasterLevelModifier	(	object	oCreature,
		int	nClass
	)

Gets the current caster level modifier for oCreature.

Parameters

oCreature	the target creature
nClass	the creature caster class

Returns: the current caster level modifier for the creature

Definition at line 1940 of file nwnx_creature.nss.

◆ NWNX_Creature_SetCasterLevelOverride()

void NWNX_Creature_SetCasterLevelOverride	(	object	oCreature,
		int	nClass,
		int	nCasterLevel,
		int	bPersist = `FALSE`
	)

Sets a caster level override for oCreature.

Parameters

oCreature	the target creature
nClass	the class that this modifier will apply to
nCasterLevel	the caster level override to apply
bPersist	whether the override should be persisted to the .bic file if applicable

Definition at line 1951 of file nwnx_creature.nss.

◆ NWNX_Creature_GetCasterLevelOverride()

int NWNX_Creature_GetCasterLevelOverride	(	object	oCreature,
		int	nClass
	)

Gets the current caster level override for oCreature.

Parameters

oCreature	the target creature
nClass	the creature caster class

Returns: the current caster level override for the creature or -1 if not set

Definition at line 1963 of file nwnx_creature.nss.

◆ NWNX_Creature_JumpToLimbo()

void NWNX_Creature_JumpToLimbo ( object oCreature )

Move a creature to limbo.

Parameters

oCreature The creature object.

Definition at line 1974 of file nwnx_creature.nss.

◆ NWNX_Creature_SetCriticalMultiplierModifier()

void NWNX_Creature_SetCriticalMultiplierModifier	(	object	oCreature,
		int	nModifier,
		int	nHand = `0`,
		int	bPersist = `FALSE`,
		int	nBaseItem = `-1`
	)

Sets the critical hit multiplier modifier for the Creature.

Parameters

oCreature	The target creature
nModifier	The modifier to apply
nHand	0 for all attacks, 1 for Mainhand, 2 for Offhand
bPersist	Whether the modifier should persist to .bic file if applicable
nBaseItem	Applies the.modifier only when the attack used this baseitem. BASE_ITEM_GLOVES for Unarmed, '-1' for all

Note: Persistence is activated each server reset by the first use of either 'SetCriticalMultiplier*' functions. Recommended to trigger on a dummy target OnModuleLoad to enable persistence.

Definition at line 1981 of file nwnx_creature.nss.

◆ NWNX_Creature_GetCriticalMultiplierModifier()

int NWNX_Creature_GetCriticalMultiplierModifier	(	object	oCreature,
		int	nHand = `0`,
		int	nBaseItem = `-1`
	)

Gets the critical hit multiplier modifier for the Creature.

Parameters

oCreature	The target creature
nHand	0 for all attacks, 1 for Mainhand, 2 for Offhand
nBaseItem	The baseitem modifer to retrieve. BASE_ITEM_GLOVES for Unarmed, '-1' for all

Returns: the current critical hit multiplier modifier for the creature

Definition at line 1994 of file nwnx_creature.nss.

◆ NWNX_Creature_SetCriticalMultiplierOverride()

void NWNX_Creature_SetCriticalMultiplierOverride	(	object	oCreature,
		int	nOverride,
		int	nHand = `0`,
		int	bPersist = `FALSE`,
		int	nBaseItem = `-1`
	)

Sets the critical hit multiplier override for the Creature.

Parameters

oCreature	The target creature
nOverride	The override value to apply. -1 to clear override.
nHand	0 for all attacks, 1 for Mainhand, 2 for Offhand
bPersist	Whether the modifier should persist to .bic file if applicable
nBaseItem	Applies the.Override only when the attack used this baseitem. BASE_ITEM_GLOVES for Unarmed, '-1' for all

Note: Persistence is activated each server reset by the first use of either 'SetCriticalMultiplier*' functions. Recommended to trigger on a dummy target OnModuleLoad to enable persistence.

Definition at line 2006 of file nwnx_creature.nss.

◆ NWNX_Creature_GetCriticalMultiplierOverride()

int NWNX_Creature_GetCriticalMultiplierOverride	(	object	oCreature,
		int	nHand = `0`,
		int	nBaseItem = `-1`
	)

Gets the critical hit multiplier override for the Creature.

Parameters

oCreature	The target creature
nHand	0 for all attacks, 1 for Mainhand, 2 for Offhand
nBaseItem	The baseitem Override to retrieve. BASE_ITEM_GLOVES for Unarmed, '-1' for all

Returns: the current critical hit multiplier override for the creature. No override == -1

Definition at line 2019 of file nwnx_creature.nss.

◆ NWNX_Creature_SetCriticalRangeModifier()

void NWNX_Creature_SetCriticalRangeModifier	(	object	oCreature,
		int	nModifier,
		int	nHand = `0`,
		int	bPersist = `FALSE`,
		int	nBaseItem = `-1`
	)

Sets the critical hit range modifier for the creature.

Parameters

oCreature	The target creature
nModifier	The modifier to apply. Positive modifiers reduce critical chance. (I.e. From 18-20, a +1 results in crit range of 19-20)
nHand	0 for all attacks, 1 for Mainhand, 2 for Offhand
bPersist	Whether the modifier should persist to .bic file if applicable
nBaseItem	Applies the.modifier only when the attack used this baseitem. BASE_ITEM_GLOVES for Unarmed, '-1' for all

Note: Persistence is activated each server reset by the first use of either 'SetCriticalRange*' functions. Recommended to trigger on a dummy target OnModuleLoad to enable persistence.

Definition at line 2031 of file nwnx_creature.nss.

◆ NWNX_Creature_GetCriticalRangeModifier()

int NWNX_Creature_GetCriticalRangeModifier	(	object	oCreature,
		int	nHand = `0`,
		int	nBaseItem = `-1`
	)

Gets the critical hit range modifier for the creature.

Parameters

oCreature	The target creature
nHand	0 for all attacks, 1 for Mainhand, 2 for Offhand
nBaseItem	The baseitem modifer to retrieve. BASE_ITEM_GLOVES for Unarmed, '-1' for all

Returns: the current critical hit range modifier for the creature

Definition at line 2044 of file nwnx_creature.nss.

◆ NWNX_Creature_SetCriticalRangeOverride()

void NWNX_Creature_SetCriticalRangeOverride	(	object	oCreature,
		int	nOverride,
		int	nHand = `0`,
		int	bPersist = `FALSE`,
		int	nBaseItem = `-1`
	)

Sets the critical hit range Override for the creature.

Parameters

oCreature	The target creature
nOverride	The new minimum roll to crit. i.e nOverride of 15 results in crit range of 15-20. -1 to clear override.
nHand	0 for all attacks, 1 for Mainhand, 2 for Offhand
bPersist	Whether the modifier should persist to .bic file if applicable
nBaseItem	Applies the.Override only when the attack used this baseitem. BASE_ITEM_GLOVES for Unarmed, '-1' for all

Note: Persistence is activated each server reset by the first use of either 'SetCriticalRange*' functions. Recommended to trigger on a dummy target OnModuleLoad to enable persistence.

Definition at line 2056 of file nwnx_creature.nss.

◆ NWNX_Creature_GetCriticalRangeOverride()

int NWNX_Creature_GetCriticalRangeOverride	(	object	oCreature,
		int	nHand = `0`,
		int	nBaseItem = `-1`
	)

Sets the critical hit range Override for the creature.

Parameters

oCreature	The target creature
nHand	0 for all attacks, 1 for Mainhand, 2 for Offhand
nBaseItem	The baseitem Override to retrieve. BASE_ITEM_GLOVES for Unarmed, '-1' for all

Returns: the current critical hit range override for the creature. No override == -1

Definition at line 2069 of file nwnx_creature.nss.

◆ NWNX_Creature_AddAssociate()

void NWNX_Creature_AddAssociate	(	object	oCreature,
		object	oAssociate,
		int	nAssociateType
	)

Add oAssociate as nAssociateType to oCreature.

Warning: Only basic checks are done so care must be taken when using this function

Parameters

oCreature	The creature to add oAssociate to
oAssociate	The associate, must be a NPC
nAssociateType	The associate type, one of ASSOCIATE_TYPE_*, except _NONE

Definition at line 2081 of file nwnx_creature.nss.

◆ NWNX_Creature_OverrideDamageLevel()

void NWNX_Creature_OverrideDamageLevel	(	object	oCreature,
		int	nDamageLevel
	)

Override the damage level of oCreature.

Note: Damage levels are the damage state under a creature's name, for example: 'Near Death'

Parameters

oCreature	The target creature.
nDamageLevel	A damage level, see damagelevels.2da. Allowed values: 0-255 or -1 to remove the override.

Definition at line 2092 of file nwnx_creature.nss.

◆ NWNX_Creature_SetEncounter()

void NWNX_Creature_SetEncounter	(	object	oCreature,
		object	oEncounter
	)

Set the encounter source of oCreature.

Parameters

oCreature	The target creature.
oEncounter	The source encounter

Definition at line 2101 of file nwnx_creature.nss.

◆ NWNX_Creature_GetEncounter()

object NWNX_Creature_GetEncounter ( object oCreature )

Get the encounter source of oCreature.

Parameters

oCreature The target creature.

Returns: The encounter, OBJECT_INVALID if not part of an encounter or on error

Definition at line 2110 of file nwnx_creature.nss.

◆ NWNX_Creature_GetIsBartering()

int NWNX_Creature_GetIsBartering ( object oCreature )

Get if oCreature is currently bartering.

Parameters

oCreature The target creature.

Returns: TRUE if oCreature is bartering, FALSE if not or on error.

Definition at line 2120 of file nwnx_creature.nss.

◆ NWNX_Creature_SetLastItemCasterLevel()

void NWNX_Creature_SetLastItemCasterLevel	(	object	oCreature,
		int	nCasterLvl
	)

Sets caster level for the last item used. Use in a spellhook or spell event before to set caster level for any spells cast from the item.

Parameters

oCreature	the creature who used the item.
nCasterLvl	the desired caster level.

Definition at line 2130 of file nwnx_creature.nss.

◆ NWNX_Creature_GetLastItemCasterLevel()

int NWNX_Creature_GetLastItemCasterLevel ( object oCreature )

Gets the caster level of the last item used.

Parameters

oCreature the creature who used the item.

Returns: returns the creatures last used item's level.

Definition at line 2139 of file nwnx_creature.nss.

◆ NWNX_Creature_GetArmorClassVersus()

int NWNX_Creature_GetArmorClassVersus	(	object	oAttacked,
		object	oVersus,
		int	nTouch = `FALSE`
	)

Gets the Armor classed of attacked against versus.

Parameters

oAttacked	The one being attacked
oVersus	The one doing the attacking
nTouch	TRUE for touch attacks

Returns: -255 on Error, Flat footed AC if oVersus is invalid or the Attacked AC versus oVersus.

Definition at line 2148 of file nwnx_creature.nss.

◆ NWNX_Creature_GetWalkAnimation()

int NWNX_Creature_GetWalkAnimation ( object oCreature )

Gets the current walk animation of oCreature.

Parameters

oCreature The target creature.

Returns: -1 on Error, otherwise the walk animation number

Definition at line 2159 of file nwnx_creature.nss.

◆ NWNX_Creature_SetWalkAnimation()

void NWNX_Creature_SetWalkAnimation	(	object	oCreature,
		int	nAnimation
	)

Sets the current walk animation of oCreature.

Parameters

oCreature	The target creature.
nAnimation	The walk animation number.

Definition at line 2168 of file nwnx_creature.nss.

◆ NWNX_Creature_SetAttackRollOverride()

void NWNX_Creature_SetAttackRollOverride	(	object	oCreature,
		int	nRoll,
		int	nModifier
	)

Changes the attack modifier depending on the dice roll. Used to skip autofail on 1 and autosucceed on 20 as well.

Parameters

oCreature	The attacking creature, use OBJECT_INVALID for all.
nRoll	The dice roll to modify.
nModifier	The modifier to the attack, use 0 to turn off autofail for 1/autosucceed for 20 with no attack modifier value.

Definition at line 2176 of file nwnx_creature.nss.

◆ NWNX_Creature_SetParryAllAttacks()

void NWNX_Creature_SetParryAllAttacks	(	object	oCreature,
		int	bParry
	)

Works like the tweak but can be turned on and off for all creatures or single ones.

Parameters

oCreature	The parrying creature, use OBJECT_INVALID for all.
bParry	TRUE to parry all attacks.

Note: Use this command on_module_load instead of the NWNX_TWEAKS_PARRY_ALL_ATTACKS tweak if using NWNX_Creature_SetAttackRollOverride()

Definition at line 2185 of file nwnx_creature.nss.

◆ NWNX_Creature_GetNoPermanentDeath()

int NWNX_Creature_GetNoPermanentDeath ( object oCreature )

Gets the NoPermanentDeath flag of oCreature.

Parameters

oCreature The target creature.

Returns: TRUE/FALSE or -1 on error.

Definition at line 2193 of file nwnx_creature.nss.

◆ NWNX_Creature_SetNoPermanentDeath()

void NWNX_Creature_SetNoPermanentDeath	(	object	oCreature,
		int	bNoPermanentDeath
	)

Sets the NoPermanentDeath flag of oCreature.

Parameters

oCreature	The target creature.
bNoPermanentDeath	TRUE/FALSE.

Definition at line 2203 of file nwnx_creature.nss.

◆ NWNX_Creature_ComputeSafeLocation()

vector NWNX_Creature_ComputeSafeLocation	(	object	oCreature,
		vector	vPosition,
		float	fRadius = `20.0f`,
		int	bWalkStraightLineRequired = `TRUE`
	)

Compute a safe location for oCreature.

Parameters

oCreature	The target creature.
vPosition	The starting position.
fRadius	The search radius around vPosition.
bWalkStraightLineRequired	Whether the creature must be able to walk in a straight line to the position.

Returns: A safe location as vector, will return vPosition if one wasn't found. Returns {0.0, 0.0, 0.0} on error.

Definition at line 2212 of file nwnx_creature.nss.

◆ NWNX_Creature_DoPerceptionUpdateOnCreature()

void NWNX_Creature_DoPerceptionUpdateOnCreature	(	object	oCreature,
		object	oTargetCreature
	)

Update oCreature's perception of oTargetCreature.

Parameters

oCreature	The creature.
oTargetCreature	The target creature.

Definition at line 2232 of file nwnx_creature.nss.

◆ NWNX_Creature_GetPersonalSpace()

float NWNX_Creature_GetPersonalSpace ( object oCreature )

Get a creatures personal space (meters from center to non-creature objects).

Parameters

oCreature The creature.

Returns: The creatures personal space.

Definition at line 2241 of file nwnx_creature.nss.

◆ NWNX_Creature_SetPersonalSpace()

void NWNX_Creature_SetPersonalSpace	(	object	oCreature,
		float	fPerspace
	)

Set a creatures personal space (meters from center to non-creature objects).

Parameters

oCreature	The creature.
fPerspace	The creatures personal space.

Definition at line 2251 of file nwnx_creature.nss.

◆ NWNX_Creature_GetCreaturePersonalSpace()

float NWNX_Creature_GetCreaturePersonalSpace ( object oCreature )

Get a creatures creature personal space (meters from center to other creatures).

Parameters

oCreature The creature.

Returns: The creatures creature personal space.

Definition at line 2260 of file nwnx_creature.nss.

◆ NWNX_Creature_SetCreaturePersonalSpace()

void NWNX_Creature_SetCreaturePersonalSpace	(	object	oCreature,
		float	fCrePerspace
	)

Set a creatures creature personal space (meters from center to other creatures).

Parameters

oCreature	The creature.
fCrePerspace	The creatures creature personal space.

Definition at line 2270 of file nwnx_creature.nss.

◆ NWNX_Creature_GetHeight()

float NWNX_Creature_GetHeight ( object oCreature )

Get a creatures height.

Parameters

oCreature The creature.

Returns: The creatures height.

Definition at line 2279 of file nwnx_creature.nss.

◆ NWNX_Creature_SetHeight()

void NWNX_Creature_SetHeight	(	object	oCreature,
		float	fHeight
	)

Set a creatures height.

Parameters

oCreature	The creature.
fHeight	The creatures height.

Definition at line 2289 of file nwnx_creature.nss.

◆ NWNX_Creature_GetHitDistance()

float NWNX_Creature_GetHitDistance ( object oCreature )

Get a creatures hit distance.

Parameters

oCreature The creature.

Returns: The creatures hit distance.

Definition at line 2298 of file nwnx_creature.nss.

◆ NWNX_Creature_SetHitDistance()

void NWNX_Creature_SetHitDistance	(	object	oCreature,
		float	fHitDist
	)

Set a creatures hit distance.

Parameters

oCreature	The creature.
fHitDist	The creatures hit distance.

Definition at line 2308 of file nwnx_creature.nss.

◆ NWNX_Creature_GetPreferredAttackDistance()

float NWNX_Creature_GetPreferredAttackDistance ( object oCreature )

Get a creatures preferred attack distance.

Parameters

oCreature The creature.

Returns: The creatures preferred attack distance.

Definition at line 2317 of file nwnx_creature.nss.

◆ NWNX_Creature_SetPreferredAttackDistance()

void NWNX_Creature_SetPreferredAttackDistance	(	object	oCreature,
		float	fPrefAtckDist
	)

Set a creatures preferred attack distance.

Parameters

oCreature	The creature.
fPrefAtckDist	The creatures preferred attack distance.

Definition at line 2327 of file nwnx_creature.nss.

◆ NWNX_Creature_GetArmorCheckPenalty()

int NWNX_Creature_GetArmorCheckPenalty ( object oCreature )

Get the skill penalty from wearing armor.

Parameters

oCreature The creature.

Definition at line 2336 of file nwnx_creature.nss.

◆ NWNX_Creature_GetShieldCheckPenalty()

int NWNX_Creature_GetShieldCheckPenalty ( object oCreature )

Get the skill penalty from wearing a shield.

Parameters

oCreature The creature.

Definition at line 2345 of file nwnx_creature.nss.

◆ NWNX_Creature_SetBypassEffectImmunity()

void NWNX_Creature_SetBypassEffectImmunity	(	object	oCreature,
		int	nImmunityType,
		int	nChance = `100`,
		int	bPersist = `FALSE`
	)

Sets a chance for normal Effect Immunities to be bypassed.

Parameters

oCreature	The affected creature
nImmunityType	'IMMUNITY_TYPE_' to bypass. By default affects outgoing effects (oCreature -> another creature). Use a negative (-IMMUNITY_TYPE_) to affect incoming effects instead (another creature -> oCreature) use 255/-255 to bypass ALL Immunities.
nChance	The chance (of 100%) to bypass the immunity check. A Positive chance results in NOT IMMUNE. A Negative chance results in IMMUNE.
bPersist	Whether the modifier should persist to .bic file (for PCs)

Note: Persistence is enabled after a server reset by the first use of this function. Recommended to trigger on a dummy target OnModuleLoad to enable persistence.; Where an Outgoing and Incoming bypass both attempt opposing outcomes, both are ignored and the immunity status without bypass will apply.

Definition at line 2354 of file nwnx_creature.nss.

◆ NWNX_Creature_GetBypassEffectImmunity()

int NWNX_Creature_GetBypassEffectImmunity	(	object	oCreature,
		int	nImmunityType
	)

Gets a chance for normal Effect Immunities to be bypassed.

Parameters

oCreature	The target creature
nImmunityType	'IMMUNITY_TYPE_' to retrieve the current chance for bypass: Positive gets outgoing effects (oCreature -> another creature). Negative (-IMMUNITY_TYPE_) gets incoming effects (another creature -> oCreature).

Returns: the current critical hit multiplier modifier for the creature

Definition at line 2365 of file nwnx_creature.nss.

◆ NWNX_Creature_SetLastKiller()

void NWNX_Creature_SetLastKiller	(	object	oCreature,
		object	oKiller
	)

Sets the killer of oCreature to oKiller.

Parameters

oCreature	The target creature.
oKiller	The killer.

Definition at line 2375 of file nwnx_creature.nss.

◆ NWNX_Creature_DoItemCastSpell()

void NWNX_Creature_DoItemCastSpell	(	object	oCreature,
		object	oTarget,
		location	locTarget,
		int	nSpellID,
		int	nCasterLevel,
		float	fProjectileTime,
		int	nProjectilePathType = `PROJECTILE_PATH_TYPE_DEFAULT`,
		int	nProjectileSpellID = `-1`,
		object	oItem = `OBJECT_INVALID`,
		string	sImpactScript = `""`
	)

Instantly cast a spell at a target or location.

Note: oCreature must be in the same area as oTarget or locTarget.; Does not care if oCreature can't cast spells or doesn't know the spell. Does not consume spell slots.

Parameters

oCreature	The caster.
oTarget	The target, use OBJECT_INVALID to cast at a location.
locTarget	The location, only used when oTarget is OBJECT_INVALID.
nSpellID	The spell ID.
nCasterLevel	The caster level of the spell.
fProjectileTime	The time in seconds for the projectile to reach the target. 0.0f for no projectile.
nProjectilePathType	A PROJECTILE_PATH_TYPE_* constant.
nProjectileSpellID	An optional spell ID which to use the projectile vfx of. -1 to use nSpellID's projectile vfx.
oItem	The spell cast item retrieved by GetSpellCastItem().
sImpactScript	The spell impact script. Set to "****"" to not run any impact script. If left blank, will execute nSpellID's impact script.

Definition at line 2384 of file nwnx_creature.nss.

◆ NWNX_Creature_RunEquip()

int NWNX_Creature_RunEquip	(	object	oCreature,
		object	oItem,
		int	nInventorySlot
	)

Have oCreature instantly equip oItem to nInventorySlot.

Parameters

oCreature	The creature.
oItem	The item, must be possessed by oCreature.
nInventorySlot	An INVENTORY_SLOT_* constant.

Returns: TRUE on success, FALSE on failure.

Definition at line 2407 of file nwnx_creature.nss.

◆ NWNX_Creature_RunUnequip()

int NWNX_Creature_RunUnequip	(	object	oCreature,
		object	oItem
	)

Have oCreature instantly unequip oItem.

Parameters

oCreature	The creature.
oItem	The item, must be possessed by oCreature.

Returns: TRUE on success, FALSE on failure.

Definition at line 2419 of file nwnx_creature.nss.

◆ NWNX_Creature_OverrideRangedProjectileVFX()

void NWNX_Creature_OverrideRangedProjectileVFX	(	object	oCreature,
		int	nProjectileVFX,
		int	bPersist = `FALSE`
	)

Override the elemental projectile visual effect of ranged/throwing weapons.

Parameters

oCreature	The creature.
nProjectileVFX	A NWNX_CREATURE_PROJECTILE_VFX_* constant or -1 to remove the override.
bPersist	Whether the vfx should persist to the .bic file (for PCs).

Note: Persistence is enabled after a server reset by the first use of this function. Recommended to trigger on a dummy target OnModuleLoad to enable persistence.

Definition at line 2430 of file nwnx_creature.nss.

◆ NWNX_Creature_SetInitiativeModifier()

void NWNX_Creature_SetInitiativeModifier	(	object	oCreature,
		int	nMod,
		int	bPersist = `FALSE`
	)

Sets a custom Initiative modifier.

Parameters

oCreature	The affected creature
nMod	The amount to adjust their initiative (+/-).
bPersist	Whether the modifier should persist to .bic file (for PCs)

Note: Persistence is enabled after a server reset by the first use of this function. Recommended to trigger on a dummy target OnModuleLoad to enable persistence.

Warning: This modifier takes precedence over an NWNX_Race Initiative modifier; they're not additive

Definition at line 2440 of file nwnx_creature.nss.

◆ NWNX_Creature_GetInitiativeModifier()

int NWNX_Creature_GetInitiativeModifier ( object oCreature )

Gets the custom Initiative modifier.

Parameters

oCreature The target creature

Returns: the current custom initiative modifier for the creature

Definition at line 2450 of file nwnx_creature.nss.

◆ NWNX_Creature_GetBodyBag()

object NWNX_Creature_GetBodyBag ( object oCreature )

Gets the Body Bag of a creature.

Parameters

oCreature The target creature

Returns: The creatures assigned Body Bag

Definition at line 2459 of file nwnx_creature.nss.

◆ NWNX_Creature_AddCastSpellActions()

int NWNX_Creature_AddCastSpellActions	(	object	oCreature,
		object	oTarget,
		vector	vTargetLocation,
		int	nSpellID,
		int	nMultiClass,
		int	nMetaMagic = `METAMAGIC_NONE`,
		int	nDomainLevel = `0`,
		int	nProjectilePathType = `PROJECTILE_PATH_TYPE_DEFAULT`,
		int	bInstant = `FALSE`,
		int	bClearActions = `FALSE`,
		int	bAddToFront = `FALSE`
	)

Add a cast spell action to oCreature's action queue.

Parameters

oCreature	The creature casting the spell.
oTarget	The target, to cast at a location use the area as target.
vTargetLocation	The target location.
nSpellID	The spell ID.
nMultiClass	The character class position to cast the spell as. 0 = First Class, 1 = Second Class, 3 = Third Class. To cast a cheat spell use 255 and to cast a special ability use 254.
nMetaMagic	A METAMAGIC_* constant, except METAMAGIC_ANY.
nDomainLevel	The domain level if casting a domain spell.
nProjectilePathType	A PROJECTILE_PATH_TYPE_* constant.
bInstant	TRUE to instantly cast the spell.
bClearActions	TRUE to clear all actions.
bAddToFront	TRUE to add the cast spell action to the front of the action queue.

Returns: TRUE if the action was successfully added to oCreature's action queue.

Definition at line 2468 of file nwnx_creature.nss.

◆ NWNX_Creature_GetIsFlanking()

int NWNX_Creature_GetIsFlanking	(	object	oCreature,
		object	oTargetCreature
	)

Get whether oCreature is flanking oTargetCreature.

Parameters

oCreature	The creature object.
oTargetCreature	The target creature object.

Returns: TRUE if oCreature is flanking oTargetCreature.

Definition at line 2490 of file nwnx_creature.nss.

◆ NWNX_Creature_DecrementRemainingSpellSlots()

void NWNX_Creature_DecrementRemainingSpellSlots	(	object	oCreature,
		int	nClass,
		int	nSpellLevel
	)

Decrements the remaining spell slots (innate casting) at a class level.

Parameters

oCreature	The creature object.
nClass	The class id from classes.2da. (Not class index 0-2)
nSpellLevel	The spell level.

Definition at line 2501 of file nwnx_creature.nss.

◆ NWNX_Creature_IncrementRemainingSpellSlots()

void NWNX_Creature_IncrementRemainingSpellSlots	(	object	oCreature,
		int	nClass,
		int	nSpellLevel
	)

Increments the remaining spell slots (innate casting) at a class level.

Parameters

oCreature	The creature object.
nClass	The class id from classes.2da. (Not class index 0-2)
nSpellLevel	The spell level.

Definition at line 2512 of file nwnx_creature.nss.

◆ NWNX_Creature_GetMaximumBonusAttacks()

int NWNX_Creature_GetMaximumBonusAttacks ( object oCreature )

Gets the maximum number of bonus attacks a creature can have from EffectModifyAttacks().

Parameters

oCreature The creature.

Returns: The maximum number of bonus attacks or 0 on error.

Definition at line 2523 of file nwnx_creature.nss.

◆ NWNX_Creature_SetMaximumBonusAttacks()

void NWNX_Creature_SetMaximumBonusAttacks	(	object	oCreature,
		int	nMaxBonusAttacks,
		int	bPersist = `FALSE`
	)

Sets the maximum number of bonus attacks a creature can have from EffectModifyAttacks().

Note: This function also removes the limit of 5 bonus attacks from EffectModifyAttacks().

Parameters

oCreature	The creature.
nMaxBonusAttacks	The maximum number of bonus attacks. Values < 0 will set the limit back to the default of 5.
bPersist	Whether the modifier should persist to .bic file (for PCs).

Note: Persistence is enabled after a server reset by the first use of this function. Recommended to trigger on a dummy target OnModuleLoad to enable persistence.

Definition at line 2532 of file nwnx_creature.nss.

◆ NWNX_Creature_DoCleaveAttack()

void NWNX_Creature_DoCleaveAttack ( object oCreature )

Inserts a cleave or great cleave attack into oCreature's current attack round against the nearest enemy within melee reach.

Parameters

oCreature The creature object.

Note: oCreature must have the cleave or great cleave feats, must be in combat, and must have available attacks remaining in their combat round to use for cleave attack.

Definition at line 2542 of file nwnx_creature.nss.

◆ NWNX_Creature_GetLockOrientationToObject()

object NWNX_Creature_GetLockOrientationToObject ( object oCreature )

Gets the current object oCreature's orientation is locked to.

Parameters

oCreature The creature object.

Returns: The object oCreature's orientation is locked to, or OBJECT_INVALID if oCreature's orientation is not locked.

Definition at line 2550 of file nwnx_creature.nss.

◆ NWNX_Creature_SetLockOrientationToObject()

void NWNX_Creature_SetLockOrientationToObject	(	object	oCreature,
		object	oTarget
	)

Locks oCreature's orientation to always face oTarget.

Parameters

oCreature	The creature object.
oTarget	The target to lock oCreature's orientation to. Use OBJECT_INVALID to remove the orientation lock.

Definition at line 2560 of file nwnx_creature.nss.

◆ NWNX_Creature_BroadcastAttackOfOpportunity()

void NWNX_Creature_BroadcastAttackOfOpportunity	(	object	oCreature,
		object	oSingleCreature = `OBJECT_INVALID`,
		int	bMovement = `FALSE`
	)

Causes oCreature to broadcast an Attack of Opportunity against themself.

Parameters

oCreature	The creature object.
oSingleCreature	A single creature to broadcast the Attack of Opporunity to. Use OBJECT_INVALID to broadcast to all nearby enemies.
bMovement	Whether the Attack of Opportunity was caused by movement.

Definition at line 2569 of file nwnx_creature.nss.

◆ NWNX_Creature_GetMaxSellToStorePriceOverride()

int NWNX_Creature_GetMaxSellToStorePriceOverride	(	object	oCreature,
		object	oStore
	)

Returns the maximum price oStore will buy items from oCreature for.

Parameters

oCreature	The creature object.
oStore	The store object.

Returns: The max buy price override. -1 = No maximum buy price, -2 = No override set.

Definition at line 2579 of file nwnx_creature.nss.

◆ NWNX_Creature_SetMaxSellToStorePriceOverride()

void NWNX_Creature_SetMaxSellToStorePriceOverride	(	object	oCreature,
		object	oStore,
		int	nMaxSellToPrice
	)

Overrides the maximum price oStore will buy items from oCreature for.

Parameters

oCreature	The creature object.
oStore	The store object.
nMaxSellToPrice	The maximum buy price override. -1 = No maximum buy price, -2 = Remove the override.

Definition at line 2590 of file nwnx_creature.nss.

◆ NWNX_Creature_GetAbilityIncreaseByLevel()

int NWNX_Creature_GetAbilityIncreaseByLevel	(	object	oCreature,
		int	nLevel
	)

Returns the creature's ability increase for nLevel.

Parameters

oCreature	The creature object.
nLevel	The level.

Returns: An ABILITY_* constant, NWNX_CREATURE_ABILITY_NONE or -1 on error

Definition at line 2600 of file nwnx_creature.nss.

◆ NWNX_Creature_SetAbilityIncreaseByLevel()

void NWNX_Creature_SetAbilityIncreaseByLevel	(	object	oCreature,
		int	nLevel,
		int	nAbility
	)

Sets the creature's ability increase for nLevel.

Parameters

oCreature	The creature object.
nLevel	The level.
nAbility	ABILITY_* constant or NWNX_CREATURE_ABILITY_NONE

Definition at line 2611 of file nwnx_creature.nss.

◆ NWNX_Creature_GetMaxAttackRange()

float NWNX_Creature_GetMaxAttackRange	(	object	oCreature,
		object	oTarget
	)

Returns the creature's maximum attack range to a target.

Parameters

oCreature	The creature object.
oTarget	The target to get the maximum attack range to

Returns: The maximum attack range for oCreature to oTarget

Definition at line 2621 of file nwnx_creature.nss.

◆ NWNX_Creature_GetMulticlassLimit()

int NWNX_Creature_GetMulticlassLimit ( object oCreature )

Returns the creature's multiclass limit.

Note: Only works on player characters.

Parameters

oCreature The creature object. Has to be a player character.

Returns: The PCs multiclass limit. Returns 0 if no limit is set.

Definition at line 2632 of file nwnx_creature.nss.

◆ NWNX_Creature_SetMulticlassLimit()

void NWNX_Creature_SetMulticlassLimit	(	object	oCreature,
		int	nLimit,
		int	bPersist = `FALSE`
	)

Sets the creature's multiclass limit.

Note: Only works on player characters and only for future level ups. Classes already taken will continue to be available on level up. The limit must be lower than the server limit set in ruleset.2da MULTICLASS_LIMIT. Setting a value of 0 will remove the limit.

Parameters

oCreature	The creature object. Has to be a player character.
nLimit	The multiclass limit.
bPersist	Whether the limit should persist to the .bic file.

Note: Persistence is enabled after a server reset by the first use of this function.

Definition at line 2643 of file nwnx_creature.nss.

Variable Documentation

◆ NWNX_CREATURE_MOVEMENT_RATE_PC

const int NWNX_CREATURE_MOVEMENT_RATE_PC = 0

Definition at line 14 of file nwnx_creature.nss.

◆ NWNX_CREATURE_MOVEMENT_RATE_IMMOBILE

const int NWNX_CREATURE_MOVEMENT_RATE_IMMOBILE = 1

Definition at line 15 of file nwnx_creature.nss.

◆ NWNX_CREATURE_MOVEMENT_RATE_VERY_SLOW

const int NWNX_CREATURE_MOVEMENT_RATE_VERY_SLOW = 2

Definition at line 16 of file nwnx_creature.nss.

◆ NWNX_CREATURE_MOVEMENT_RATE_SLOW

const int NWNX_CREATURE_MOVEMENT_RATE_SLOW = 3

Definition at line 17 of file nwnx_creature.nss.

◆ NWNX_CREATURE_MOVEMENT_RATE_NORMAL

const int NWNX_CREATURE_MOVEMENT_RATE_NORMAL = 4

Definition at line 18 of file nwnx_creature.nss.

◆ NWNX_CREATURE_MOVEMENT_RATE_FAST

const int NWNX_CREATURE_MOVEMENT_RATE_FAST = 5

Definition at line 19 of file nwnx_creature.nss.

◆ NWNX_CREATURE_MOVEMENT_RATE_VERY_FAST

const int NWNX_CREATURE_MOVEMENT_RATE_VERY_FAST = 6

Definition at line 20 of file nwnx_creature.nss.

◆ NWNX_CREATURE_MOVEMENT_RATE_DEFAULT

const int NWNX_CREATURE_MOVEMENT_RATE_DEFAULT = 7

Definition at line 21 of file nwnx_creature.nss.

◆ NWNX_CREATURE_MOVEMENT_RATE_DM_FAST

const int NWNX_CREATURE_MOVEMENT_RATE_DM_FAST = 8

Definition at line 22 of file nwnx_creature.nss.

◆ NWNX_CREATURE_MOVEMENT_TYPE_STATIONARY

const int NWNX_CREATURE_MOVEMENT_TYPE_STATIONARY = 0

Definition at line 30 of file nwnx_creature.nss.

◆ NWNX_CREATURE_MOVEMENT_TYPE_WALK

const int NWNX_CREATURE_MOVEMENT_TYPE_WALK = 1

Definition at line 31 of file nwnx_creature.nss.

◆ NWNX_CREATURE_MOVEMENT_TYPE_RUN

const int NWNX_CREATURE_MOVEMENT_TYPE_RUN = 2

Definition at line 32 of file nwnx_creature.nss.

◆ NWNX_CREATURE_MOVEMENT_TYPE_SIDESTEP

const int NWNX_CREATURE_MOVEMENT_TYPE_SIDESTEP = 3

Definition at line 33 of file nwnx_creature.nss.

◆ NWNX_CREATURE_MOVEMENT_TYPE_WALK_BACKWARDS

const int NWNX_CREATURE_MOVEMENT_TYPE_WALK_BACKWARDS = 4

Definition at line 34 of file nwnx_creature.nss.

◆ NWNX_CREATURE_BONUS_TYPE_ATTACK

const int NWNX_CREATURE_BONUS_TYPE_ATTACK = 1

Definition at line 42 of file nwnx_creature.nss.

◆ NWNX_CREATURE_BONUS_TYPE_DAMAGE

const int NWNX_CREATURE_BONUS_TYPE_DAMAGE = 2

Definition at line 43 of file nwnx_creature.nss.

◆ NWNX_CREATURE_BONUS_TYPE_SAVING_THROW

const int NWNX_CREATURE_BONUS_TYPE_SAVING_THROW = 3

Definition at line 44 of file nwnx_creature.nss.

◆ NWNX_CREATURE_BONUS_TYPE_ABILITY

const int NWNX_CREATURE_BONUS_TYPE_ABILITY = 4

Definition at line 45 of file nwnx_creature.nss.

◆ NWNX_CREATURE_BONUS_TYPE_SKILL

const int NWNX_CREATURE_BONUS_TYPE_SKILL = 5

Definition at line 46 of file nwnx_creature.nss.

◆ NWNX_CREATURE_BONUS_TYPE_TOUCH_ATTACK

const int NWNX_CREATURE_BONUS_TYPE_TOUCH_ATTACK = 6

Definition at line 47 of file nwnx_creature.nss.

◆ NWNX_CREATURE_PROJECTILE_VFX_NONE

const int NWNX_CREATURE_PROJECTILE_VFX_NONE = 0

No VFX.

Definition at line 55 of file nwnx_creature.nss.

◆ NWNX_CREATURE_PROJECTILE_VFX_ACID

const int NWNX_CREATURE_PROJECTILE_VFX_ACID = 1

Definition at line 56 of file nwnx_creature.nss.

◆ NWNX_CREATURE_PROJECTILE_VFX_COLD

const int NWNX_CREATURE_PROJECTILE_VFX_COLD = 2

Definition at line 57 of file nwnx_creature.nss.

◆ NWNX_CREATURE_PROJECTILE_VFX_ELECTRICAL

const int NWNX_CREATURE_PROJECTILE_VFX_ELECTRICAL = 3

Definition at line 58 of file nwnx_creature.nss.

◆ NWNX_CREATURE_PROJECTILE_VFX_FIRE

const int NWNX_CREATURE_PROJECTILE_VFX_FIRE = 4

Definition at line 59 of file nwnx_creature.nss.

◆ NWNX_CREATURE_PROJECTILE_VFX_SONIC

const int NWNX_CREATURE_PROJECTILE_VFX_SONIC = 5

Definition at line 60 of file nwnx_creature.nss.

◆ NWNX_CREATURE_PROJECTILE_VFX_RANDOM

const int NWNX_CREATURE_PROJECTILE_VFX_RANDOM = 6

Random Elemental VFX.

Definition at line 61 of file nwnx_creature.nss.

◆ NWNX_CREATURE_ABILITY_NONE

const int NWNX_CREATURE_ABILITY_NONE = 6

Definition at line 64 of file nwnx_creature.nss.

Readme

Files

Classes

Functions

Variables

Function Documentation

◆ NWNX_Creature_AddFeat()

◆ NWNX_Creature_AddFeatByLevel()

◆ NWNX_Creature_RemoveFeat()

◆ NWNX_Creature_RemoveFeatByLevel()

◆ NWNX_Creature_GetKnowsFeat()

◆ NWNX_Creature_GetFeatCountByLevel()

◆ NWNX_Creature_GetFeatByLevel()

◆ NWNX_Creature_GetFeatGrantLevel()

◆ NWNX_Creature_GetFeatCount()

◆ NWNX_Creature_GetFeatByIndex()

◆ NWNX_Creature_GetMeetsFeatRequirements()

◆ NWNX_Creature_GetSpecialAbilityCount()

◆ NWNX_Creature_GetSpecialAbility()

◆ NWNX_Creature_AddSpecialAbility()

◆ NWNX_Creature_RemoveSpecialAbility()

◆ NWNX_Creature_SetSpecialAbility()

◆ NWNX_Creature_GetClassByLevel()

◆ NWNX_Creature_SetBaseAC()

◆ NWNX_Creature_GetBaseAC()

◆ NWNX_Creature_SetRawAbilityScore()

◆ NWNX_Creature_GetRawAbilityScore()

◆ NWNX_Creature_ModifyRawAbilityScore()

◆ NWNX_Creature_GetPrePolymorphAbilityScore()

◆ NWNX_Creature_GetRemainingSpellSlots()

◆ NWNX_Creature_SetRemainingSpellSlots()

◆ NWNX_Creature_GetMaxSpellSlots()

◆ NWNX_Creature_AddKnownSpell()

◆ NWNX_Creature_RemoveKnownSpell()

◆ NWNX_Creature_GetMaxHitPointsByLevel()

◆ NWNX_Creature_SetMaxHitPointsByLevel()

◆ NWNX_Creature_SetMovementRate()

◆ NWNX_Creature_GetMovementRateFactor()

◆ NWNX_Creature_SetMovementRateFactor()

◆ NWNX_Creature_GetMovementRateFactorCap()

◆ NWNX_Creature_SetMovementRateFactorCap()

◆ NWNX_Creature_GetMovementType()

◆ NWNX_Creature_SetWalkRateCap()

◆ NWNX_Creature_SetAlignmentGoodEvil()

◆ NWNX_Creature_SetAlignmentLawChaos()

◆ NWNX_Creature_SetSkillRank()

◆ NWNX_Creature_GetSkillRankByLevel()

◆ NWNX_Creature_SetSkillRankByLevel()

◆ NWNX_Creature_SetClassByPosition()

◆ NWNX_Creature_SetLevelByPosition()

◆ NWNX_Creature_SetBaseAttackBonus()

◆ NWNX_Creature_GetAttacksPerRound()

◆ NWNX_Creature_RestoreFeats()

◆ NWNX_Creature_RestoreSpecialAbilities()

◆ NWNX_Creature_RestoreItems()

◆ NWNX_Creature_SetSize()

◆ NWNX_Creature_GetSkillPointsRemaining()

◆ NWNX_Creature_SetSkillPointsRemaining()

◆ NWNX_Creature_GetSkillPointsRemainingByLevel()

◆ NWNX_Creature_SetSkillPointsRemainingByLevel()

◆ NWNX_Creature_SetRacialType()

◆ NWNX_Creature_SetGold()

◆ NWNX_Creature_SetCorpseDecayTime()

◆ NWNX_Creature_GetBaseSavingThrow()

◆ NWNX_Creature_SetBaseSavingThrow()

◆ NWNX_Creature_LevelUp()

◆ NWNX_Creature_LevelDown()

◆ NWNX_Creature_SetChallengeRating()

◆ NWNX_Creature_GetAttackBonus()

◆ NWNX_Creature_GetHighestLevelOfFeat()

◆ NWNX_Creature_GetFeatRemainingUses()

◆ NWNX_Creature_GetFeatTotalUses()

◆ NWNX_Creature_SetFeatRemainingUses()

◆ NWNX_Creature_GetTotalEffectBonus()

◆ NWNX_Creature_SetOriginalName()

◆ NWNX_Creature_GetOriginalName()

◆ NWNX_Creature_SetSpellResistance()

◆ NWNX_Creature_SetAnimalCompanionCreatureType()

◆ NWNX_Creature_SetFamiliarCreatureType()

◆ NWNX_Creature_SetAnimalCompanionName()