Class NwCreature

Namespace: Anvil.API

Assembly: NWN.Anvil.dll

A monster, NPC, player character or DM avatar

public sealed class NwCreature : NwGameObject, IEquatable<NwObject>

Inheritance: object

NwObject

NwGameObject

NwCreature

Implements: IEquatable<NwObject>

Inherited Members: NwGameObject.OnAcquireItem

NwGameObject.OnUnacquireItem

NwGameObject.OnChatMessageSend

NwGameObject.OnDisarmWeapon

NwGameObject.OnEffectApply

NwGameObject.OnEffectRemove

NwGameObject.OnHeal

NwGameObject.OnDispelMagicApply

NwGameObject.OnSpellBroadcast

NwGameObject.OnSpellCast

NwGameObject.OnSpellInterrupt

NwGameObject.ActiveEffects

NwGameObject.AnimationState

NwGameObject.Area

NwGameObject.CasterLevel

NwGameObject.HighlightColor

NwGameObject.HP

NwGameObject.IsDestroyable

NwGameObject.IsRaiseable

NwGameObject.IsSelectableWhenDead

NwGameObject.IsInConversation

NwGameObject.Location

NwGameObject.IsListening

NwGameObject.MaxHP

NwGameObject.MouseCursor

NwGameObject.PlotFlag

NwGameObject.PortraitId

NwGameObject.PortraitResRef

NwGameObject.Rotation

NwGameObject.TransitionTarget

NwGameObject.Useable

NwGameObject.VisibilityOverride

NwGameObject.VisibleDistance

NwGameObject.VisualTransform

NwGameObject.UiDiscoveryFlags

NwGameObject.ActionCastSpellAt(NwSpell, NwGameObject, MetaMagic, bool, int, ProjectilePathType, bool, NwClass, bool)

NwGameObject.ActionCastSpellAt(NwSpell, Location, MetaMagic, bool, ProjectilePathType, bool, NwClass, bool, int)

NwGameObject.ActionJumpToLocation(Location)

NwGameObject.ActionWait(TimeSpan)

NwGameObject.ApplyEffect(EffectDuration, Effect, TimeSpan)

NwGameObject.Destroy()

NwGameObject.Distance(NwGameObject)

NwGameObject.DistanceSquared(NwGameObject)

NwGameObject.EndConversation()

NwGameObject.FaceToObject(NwGameObject)

NwGameObject.FaceToPoint(Vector3)

NwGameObject.GetColor(ColorChannel)

NwGameObject.GetLocalizedName(PlayerLanguage, Gender)

NwGameObject.GetNearestCreatures()

NwGameObject.GetNearestCreatures(CreatureTypeFilter)

NwGameObject.GetNearestCreatures(CreatureTypeFilter, CreatureTypeFilter)

NwGameObject.GetNearestCreatures(CreatureTypeFilter, CreatureTypeFilter, CreatureTypeFilter)

NwGameObject.GetNearestObjectsByType<T>()

NwGameObject.GetVisualTransform(ObjectVisualTransformDataScope)

NwGameObject.HasLineOfSight(NwGameObject)

NwGameObject.PeekUUID()

NwGameObject.PlayAnimation(Animation, float, bool, TimeSpan)

NwGameObject.PlaySound(string)

NwGameObject.PlaySoundByStrRef(StrRef, bool)

NwGameObject.RemoveEffect(Effect)

NwGameObject.ReplaceObjectAnimation(string, string)

NwGameObject.ClearObjectAnimationOverride(string)

NwGameObject.ReplaceObjectTexture(string, string)

NwGameObject.ResetMaterialShaderUniforms()

NwGameObject.ResetMaterialShaderUniforms(string)

NwGameObject.ResetMaterialShaderUniforms(string, string)

NwGameObject.RollSavingThrow(SavingThrow, int, SavingThrowType, NwGameObject)

NwGameObject.SetColor(ColorChannel, int)

NwGameObject.SetFacing(float)

NwGameObject.SetIsDestroyable(bool, bool, bool)

NwGameObject.SetListenPattern(string, int)

NwGameObject.SetLocalizedName(string, PlayerLanguage, Gender)

NwGameObject.SetMaterialShaderUniform(string, string, int)

NwGameObject.SetMaterialShaderUniform(string, string, Vector4)

NwGameObject.SetMaterialShaderUniform(string, string, float)

NwGameObject.SetTextBubbleOverride(ObjectUiTextBubbleOverride, string)

NwObject.FindObjectsOfType<T>()

NwObject.FindObjectsWithTag(params string[])

NwObject.FindObjectsWithTag<T>(params string[])

NwObject.ObjectId

NwObject.Description

NwObject.HasUUID

NwObject.LocalVariables

NwObject.Name

NwObject.OriginalDescription

NwObject.ResRef

NwObject.Tag

NwObject.UUID

NwObject.AddActionToQueue(Action)

NwObject.ClearActionQueue(bool)

NwObject.ClearEventSubscriptions()

NwObject.Equals(NwObject)

NwObject.Equals(object)

NwObject.ForceRefreshUUID()

NwObject.GetEventScript(EventScriptType)

NwObject.GetHashCode()

NwObject.GetObjectVariable<T>(string)

NwObject.IsEventLocked(EventScriptType)

NwObject.SetEventScript(EventScriptType, string)

NwObject.SpeakString(string, TalkVolume, bool)

NwObject.ToString()

NwObject.TryGetUUID(out Guid)

NwObject.SerializeToJson(bool)

NwObject.WaitForObjectContext()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods: CollectionExtensions.SafeYield<T>(T?)

CollectionExtensions.Yield<T>(T)

ObjectExtensions.IsLoginPlayerCharacter(NwObject?, out NwPlayer?)

ObjectExtensions.IsPlayerControlled(NwObject?, out NwPlayer?)

Properties

AC: Gets this creature's armour class.

Age: Gets or sets this creature's age, in years.

AiLevel: Gets or sets the current AI level that this creature is running at.
Default is recommended for most creatures. Too many creatures at Normal or higher can cause performance degradation.

AlwaysWalk: Gets or sets whether this creature is forced to walk.
Is not persistent, and must be applied again at login.

AnimalCompanionName: Gets or sets this creature's animal companion name.

AnimalCompanionType: Gets or sets this creature's animal companion creature type.

Appearance: Gets or sets the appearance of this creature.

ArcaneSpellFailure: Gets the arcane spell failure factor for this creature.

ArmorCheckPenalty

AssociateType: Gets the associate type of this creature, otherwise returns None if this creature is not an associate of anyone.

Associates: Gets all creatures associated with this creature.

AttackTarget: Gets this creature's current attack target.

AttemptedAttackTarget: Gets the last target this creature tried to attack.

AttemptedSpellTarget: Gets the target this creature attempted to cast a spell at.

BaseAC: Gets or sets the base AC for this creature.

BaseArmorArcaneSpellFailure: Gets or sets the current base armor arcane spell failure factor for this creature (global ASF is automatically recalculated).

BaseAttackBonus: Gets or sets the Base Attack Bonus for this creature.

BaseAttackCount: Sets the number of base attacks for this creature.
The range of values accepted are from 1 to 6.

BaseShieldArcaneSpellFailure: Gets or sets the current base shield arcane spell failure factor for this creature (global ASF is automatically recalculated).

BodyBag: Gets the body bag assigned to this creature as a result of its death.

BodyBagTemplate: Gets or sets the body bag template to use when this creature dies.

ChallengeRating: Gets or sets the calculated challenge rating for this creature.

Classes: Gets this creature's classes, and associated class info.

CombatMode: Gets the creature's current Combat Mode.
Can be used in the OnCombatModeToggle event to determine which combat mode is being toggled off.

Commandable: Gets or sets a value indicating whether this creature's action queue can be modified.

ControllingPlayer: Gets or sets the player currently controlling this creature.
If this creature is a possessed familiar or is DM possessed, this will return the player or DM controlling this creature.
If this creature is a player creature (the creature a played logged in with), but the player is possessing another creature, this returns null.
If no player is controlling this creature, this returns null.
The setter makes this this creature controllable by the specified player, if player party control is enabled.

CorpseDecayTime: Gets or sets the corpse decay time for this creature.

CurrentAction: Gets the current action that this creature is executing.

DamageLevel: Gets the creature's current damage level (Uninjured, Injured, Near Death, etc).
If an override is set with SetDamageLevelOverride(DamageLevelEntry), this property will return the override value.

DefensiveCastingModeActive: Gets a value indicating whether this creature is currently in Defensive Casting Mode.

Deity: Gets or sets the name of this creature's deity.

DetectModeActive: Gets a value indicating whether this creature is currently in Detect Mode.

DialogResRef: Gets or sets the dialog ResRef for this creature.

Disarmable: Gets a value indicating whether this creature can be disarmed (checks disarm flag on creature, and if the creature actually has a weapon equipped in their right hand that is droppable).

Encounter: Gets the encounter that spawned this creature.

ExploresMinimap: Gets or sets a value indicating whether this creature will auto-explore the minimap as it walks around.

Faction: Gets or sets the faction of this object.

FamiliarName: Gets or sets this creature's familiar name.

FamiliarType: Gets or sets the type of familiar that this creature can summon.

FeatCount: Gets the number of feats known by this creature.

Feats: Gets the feats known by this character.

FlatFooted: Gets a value indicating whether this creature is flat footed.

FootstepType: Gets or sets the sounds to use when this creature makes a step. By default, this is based on the creature's appearance.

Gender: Gets or sets the gender of this creature.

Gold: Gets or sets the amount of gold carried by this creature.
This property does not display feedback to the creature. See GiveGold(int, bool) and TakeGold(int, bool) for options that provide feedback.

GoodEvilAlignment: Gets this creature's Good/Evil Alignment.

GoodEvilValue: Gets or sets this creature's Evil (0) - Good (100) alignment value.

Henchmen: Gets all henchmen associated with this creature.

Immortal: Gets or sets a value indicating whether this creature is immortal.
An immortal creature still takes damage, but cannot be killed.

InitiativeRoll: Gets or sets this creature's initiative roll.

Inventory: Gets the inventory of this creature.

IsBartering: Gets a value indicating whether this creature is currently bartering.

IsDMAvatar: Gets a value indicating whether this creature is a DM avatar character.
This returns false for NPC creatures possessed by DMs.

IsDMPossessed: Gets a value indicating whether this creature is currently possessed by a DM avatar.

IsDead: Gets a value indicating whether this creature is a dead NPC, dead PC, or dying PC.

IsEncounterCreature: Gets a value indicating whether this creature was spawned from an encounter.

IsInCombat: Gets a value indicating whether this creature is in combat.

IsLoginPlayerCharacter: Gets if this creature is a player character/DM avatar.
If this creature is a NPC or familiar, regardless of possession, this will return false.

IsPlayableRace: Gets a value indicating whether this creature is a playable racial type.

IsPlayerControlled: Gets if this creature is currently being controlled by a player/DM.
If this creature is a possessed familiar or is DM possessed, this will return true.
If this creature is a player creature (the creature a played logged in with), but the player is possessing another creature, this returns false.
If no player is controlling this creature, this returns false.

IsPossessedFamiliar: Gets a value indicating whether this creature is a familiar currently possessed by a master.

IsRangedWeaponEquipped: Gets if this creature is currently holding a ranged weapon.

IsResting: Gets a value indicating whether this creature is currently resting.

IsValid: Gets a value indicating whether this is a valid object.

LastAttackMode: Gets the attack mode used during this creature's last attack.

LastCommandFromMaster: Gets the last command issued to this creature.

LastSpecialAttackType: Gets the special attack type used in the last physical attack against this creature.

LastTrapDetected: Gets the last trap detected by this creature.

LawChaosAlignment: Gets this creature's Law/Chaos Alignment.

LawChaosValue: Gets or sets this creature's Chaos (0) - Lawful (100) alignment value.

Level: Gets the Hit Dice/Level of this creature.

LevelInfo: Gets an enumerable containing information about this creature's levels (feats, skills, class taken, etc).

LoginPlayer: Gets the player that logged in with this creature.
If this creature is a NPC or familiar, regardless of possession, this will return null.

Lootable: Gets or sets a value indicating whether this creature will leave a lootable corpse on death.
This flag must be set while the creature is alive. Players are not supported.

Master: Gets the possessor of this creature. This can be the master of a familiar, or the DM for a DM controlled creature.

MovementRate: Gets or sets the movement rate of this creature.

MovementRateFactor: Gets or sets the creature's current movement rate factor.
Base movement rate factor is 1.0.

MovementType: Gets the creature's current movement type.

OriginalFirstName: Gets or sets the original first name of this creature.

OriginalLastName: Gets or sets the original last name of this creature.

OriginalName: Gets the original name of this creature.

Phenotype: Gets or sets this creature's currently set Phenotype (body type).

Position: Gets or sets the creature's position.
NOTE: For player creatures, you likely want to immobilize the player first before moving them.
An issue exists where drive mode (W/A/S/D) can cause a client/server desync, making the creature appear at their old position.

Race: Gets this creature's race.

RemainingSkillPoints: Gets or sets the remaining skill points this creature has to spend.

ShieldCheckPenalty

SittingObject: Gets the placeable object (if any) that this creature is currently sitting in.

Size: Gets or sets the size of this creature.

SoundSet: Gets or sets the sound set index for this creature.

SpecialAbilities: Gets the special abilities available to this creature.

SpellAbilities: Gets a list of spell abilities usable by this creature.

SpellResistance: Gets or sets the spell resistance of this creature.
Returns 0 if this creature has no spell resistance.

StartingPackage: Gets this creature's default level up package.

StealthModeActive: Gets a value indicating whether this creature is currently in stealth mode.

SubRace: Gets or sets the name of this creature's sub-race.

TailType: Gets or sets the tail type of this creature.

TotalWeight: Gets the total weight of this creature, in pounds.

TurnResistanceHitDice: Gets the number of hit dice worth of Turn Resistance this creature has.

WalkRateCap: Gets or sets the walk rate cap for this creature (persistent).
Set to null to clear existing walk rate caps. Returns null if no walk rate cap is set.

WingType: Gets or sets the wing type of this creature.

Xp: Gets or sets the total experience points for this creature, taking/granting levels based on progression.

Methods

AcquireItem(NwItem, bool)

ActionAttackTarget(NwGameObject, bool): Instructs this creature to start attacking the target using whichever weapon they currently have equipped.

ActionCastFakeSpellAt(NwSpell, Location, ProjectilePathType): Begins the casting animation and spell fx for the specified spell, without any spell effects.

ActionCastFakeSpellAt(NwSpell, NwGameObject, ProjectilePathType): Begins the casting animation and spell fx for the specified spell, without any spell effects.

ActionCloseDoor(NwDoor, bool): Instructs this creature to move and close the specified door.

ActionCounterspell(NwGameObject): Intructs this creature to enter counterspell combat mode against the specified creature.

ActionEquipItem(NwItem, InventorySlot)

Instructs this creature to equip the specified item into the given inventory slot.
Note: If the creature already has an item equipped in the slot specified, it will be unequipped automatically by the call to EquipItem, and dropped if the creature lacks inventory space.
In order for EquipItem to succeed the creature must be able to equip the item normally. This means that:

The item is in the creature's inventory.
The item must already be identified (if magical).
The creature has the level required to equip the item (if magical and ILR is on).
The creature possesses the required feats to equip the item (such as weapon proficiencies).

ActionEquipMostDamagingMelee(NwGameObject?, bool)

Instructs this creature to equip its most damaging melee weapon. If no valid melee weapon is found, it will equip the most damaging ranged weapon.

ActionEquipMostDamagingRanged(NwGameObject?)

Instructs this creature to equip its most damaging ranged weapon. If no valid ranged weapon is found, it will equip the most damaging melee weapon.

ActionEquipMostEffectiveArmor(): Instructs this creature to equip the best armor in its inventory. This function will do nothing if this creature is in combat (IsInCombat).
It will also not equip clothing items with a base AC of 0, even if the item has AC bonuses applied to it.

ActionForceFollowObject(NwGameObject, float): Forces this creature to follow the specified target until ClearActionQueue(bool) is called.

ActionForceMoveTo(Location, bool, TimeSpan?): Instructs this creature to walk/run to the specified target location.

ActionForceMoveTo(NwObject, bool, float, TimeSpan?): Instructs this creature to walk/run to the specified target object.

ActionInteractObject(NwPlaceable): Instructs this creature to use the specified placeable.

ActionLockObject(NwDoor): Instructs this creature to approach and lock the specified door.

ActionLockObject(NwPlaceable): Instructs this creature to approach and lock the specified placeable.

ActionMoveAwayFrom(Location, bool, float): Instructs this creature to move to a certain distance away from the specified location.

ActionMoveAwayFrom(NwObject, bool, float): Instructs this creature to move a certain distance away from the specified target.

ActionMoveTo(Location, bool): Instructs this creature to walk/run to the specified target location.

ActionMoveTo(NwObject, bool, float): Instructs this creature to walk/run to the specified target object.

ActionOpenDoor(NwDoor, bool): Instructs this creature to move and open the specified door.

ActionPickUpItem(NwItem): Instructs this creature to walk over and pick up the specified item on the ground.

ActionPutDownItem(NwItem): Instructs this creature to begin placing down an item at its feet.

ActionRandomWalk(): The creature will generate a random location near its current location and pathfind to it. This repeats and never ends, which means it is necessary to call ClearActionQueue(bool) in order to allow a creature to perform any other action once BeginRandomWalking has been called.

ActionRest(bool): Instructs this creature to rest.

ActionSit(NwPlaceable, bool): Instructs the creature to sit in the specified placeable.

ActionUnequipItem(NwItem): Instructs this creature to unequip the specified item from whatever slot it is currently in.

ActionUnlockObject(NwDoor): Instructs this creature to approach and unlock the specified door.

ActionUnlockObject(NwPlaceable): Instructs this creature to approach and unlock the specified placeable.

ActionUseFeat(NwFeat, Location, Subfeat): Instructs this creature to use the specified feat at the target location.

ActionUseFeat(NwFeat, NwGameObject, Subfeat): Instructs this creature to use the specified feat on the target object.

ActionUseItem(NwItem, ItemProperty, Location, bool, int): Instructs this creature to use the specified item property of an item in their inventory.

ActionUseItem(NwItem, ItemProperty, NwGameObject, bool, int): Instructs this creature to use the specified item property of an item in their inventory.

ActionUseSkill(NwSkill, NwGameObject, SubSkill, NwItem?): Instructs this creature to attempt to use a skill on another object.

ActionUseTalent(Talent, Location): Uses the specified talent.

ActionUseTalent(Talent, NwGameObject): Uses the specified talent.

AddFeat(NwFeat): Gives this creature the specified feat.
Consider using the AddFeat(NwFeat, int) overload to properly allocate the feat to a level.

AddFeat(NwFeat, int): Gives this creature the specified feat at a level.
Consider using the AddFeat(NwFeat, int) overload to properly allocate the feat to a level.

AddSpecialAbility(SpecialAbility): Adds the specified ability to this creature.

AdjustPartyAlignment(Alignment, int): Adjusts the alignment of this creature and associated party members by the specified value.
Use the LawChaosValue and GoodEvilValue setters to only affect this creature.

BroadcastSkillRoll(int, NwSkill, int, int, bool, SkillResult): Causes this creature to broadcast feedback for an arbitrary skill roll (pre-calculated)
This causes a message to be posted in the combat log, and floaty skill text to appear above the character.

CalculateAbilityModifierFromScore(byte): Gets the ability modifier from the given ability score.

CheckResistSpell(NwGameObject): Performs a spell resistance check between this creature (caster) and the specified target.

ClearDamageLevelOverride(): Clears any override that is set for the creature's damage level.

ClearInitiativeModifier(): Clears the modifier that is set for the creature's initiative.

Clone(Location, string?, bool): Creates a copy of this game object.

Create(string, Location, bool, string): Creates a creature at the specified location.

DecrementRemainingFeatUses(NwFeat, int): Decrements the remaining number of uses of a particular feat for this creature by the specified amount.
You must have at least one feat use remaining to be able to decrement it.
Passive feats, and feats that can be used unlimited times per day, cannot be decremented or suppressed.

Deserialize(byte[])

DeserializeQuickbar(byte[])

DoDoorAction(NwDoor, DoorAction): Instructs this creature to perform the specified action on a door.

DoPlaceableAction(NwPlaceable, PlaceableAction): Instructs this creature to perform the specified action on a placeable.

DoSkillCheck(NwSkill, int): Returns true if 1d20 + skill rank is greater than, or equal to difficultyClass.

FindItemWithTag(string): Get the item possessed by this creature with the tag itemTag.

ForceLevelUp(NwClass, byte, Ability?, bool, ushort, NwDomain?, NwDomain?, SpellSchool, bool): Forces a PC to level up without the level up GUI.

ForceRest(): Instantly gives this creature the benefits of a rest (restored hitpoints, spells, feats, etc...).

GetAbilityModifier(Ability): Gets this creature's ability modifier for the specified ability.

GetAbilityScore(Ability, bool): Gets the specified ability score from this creature.

GetActionMode(ActionMode): Gets if this creature is using the specified action mode.

GetArmorClassVersus(NwCreature): Return the Armor Class this creature has against another creature

GetAssociate(AssociateType): Gets the first associate of this creature with the matching associate type.
See Henchmen for getting a list of all henchmen associated with this creature. See Associates for getting a list of all creatures associated with this creature.

GetAttackBonus(bool, bool, bool, bool): Gets the creature's highest attack bonus based on its own stats.
AB vs. Type and +AB on Gauntlets are excluded.

GetBaseSavingThrow(SavingThrow): Gets this creature's base save value for the specified saving throw.

GetClassDomains(NwClass?): Returns this creature's domains in the specified class. Unless custom content is used, only clerics have domains.

GetClassInfo(NwClass?): Gets the CreatureClassInfo associated with the specified class type.

GetCreatureBodyPart(CreaturePart): Gets the model number for the specified body part on the creature.

GetDamageLevelOverride(): Gets the override that is set for the creature's damage level.

GetFeatGainLevel(NwFeat): Gets the level a feat was gained.

GetFeatRemainingUses(NwFeat): Gets the remaining uses available for the specified feat.

GetFeatTotalUses(NwFeat): Gets the max/total amount of times the specified feat can be used.

GetInitiativeModifier(): Gets the modifier that is set for the creature's initiative.

GetItemInSlot(InventorySlot): Gets the item that is equipped in the specified inventory slot.

GetLevelStats(int): Gets the level stat info for the specified level (feat, class, skills, etc.).

GetPrePolymorphAbilityScore(Ability): Gets the raw ability score a polymorphed creature had prior to polymorphing.

GetQuickBarButton(byte)

GetQuickBarButtons()

GetRawAbilityScore(Ability): Gets the base (raw) ability score for the specified ability, without racial modfiers.

GetSavingThrow(SavingThrow): Gets the specified saving throw modifier for this creature.

GetSkillRank(NwSkill, bool): Gets the number of ranks this creature has in the specified skill.

GetSlotFromItem(NwItem): Gets the slot that the specified item is in.

GetSpecialization(NwClass?): Returns this creature's spell school specialization in the specified class.
Unless custom content is used, only Wizards have spell schools.

GetSpellUsesLeft(NwClass, NwSpell, MetaMagic, int): Gets the number of remaining uses for a specific spell for this creature.

GetTileExplored(NwArea, int, int): Gets whether the given area tile is visible on the map for this creature.
Tile exploration also controls object visibility in areas and the fog of war for interior and underground areas.

GiveGold(int, bool): Gives gold to this creature.

GiveItem(NwItem): Moves the specified item/item stack to this creature's inventory.

GiveItem(NwItem, int): Moves a specified amount of items from an item stack to this creature's inventory.

HasFeatEffect(NwFeat): Gets whether this creature is under the effects of the specified feat.

HasFeatPrepared(NwFeat): Returns true if this creature knows the specified NwFeat, and can use it.
Use KnowsFeat(NwFeat) to simply check if a creature knows NwFeat, but may or may not have uses remaining.

HasSkill(NwSkill): Returns true if this creature has the skill specified, and is useable.

HasSpellEffect(NwSpell): Gets whether this creature is under the effects of the specified spell.

HasSpellUse(NwSpell): Gets if this creature has the specified spell available to cast.

HasTalent(Talent): Determines whether this creature has the specified talent.

IncrementRemainingFeatUses(NwFeat, int): Increment the remaining uses per day for this (creature) by the specified amount.
Total number of feats uses per-day cannot exceed the creature's standard maximum.

IsCreatureHeard(NwCreature): Gets whether this creature can hear the specified creature.

IsCreatureSeen(NwCreature): Gets whether this creature can see the specified creature.

IsEnemy(NwCreature): Gets a value indicating whether this creature considers the target as a friend.

IsFlanking(NwCreature): Gets if this creature is flanking the specified target.

IsFriend(NwCreature): Gets a value indicating whether this creature considers the target as a enemy.

IsImmuneTo(ImmunityType, NwGameObject?): Gets whether this creature has a specific immunity.

IsNeutral(NwCreature): Gets a value indicating whether this creature considers the target as neutral.

IsReactionTypeFriendly(NwCreature): Gets whether this creature has a friendly reaction towards another given creature.

IsReactionTypeHostile(NwCreature): Gets whether this creature has a hostile reaction towards another given creature.

IsReactionTypeNeutral(NwCreature): Gets whether this creature has a neutral reaction towards another given creature.

IsWeaponEffective(NwGameObject, bool): Check whether this creature can damage the specified object using their current weapon/s.

JumpToObject(NwGameObject, bool): Teleports this creature to the nearest valid location by the target.
This action produces no visual effect.

KnowsFeat(NwFeat): Gets if this creature knows the specified feat.

LevelUp(NwClass, int): Adds levels of the specified class to a creature, bypassing all validation.

LevelUpHenchman(NwClass, PackageType, bool): Levels up this creature using the default settings.
You can assign a new class to level up
If an invalid class combination is chosen the default class is leveled up.
Package determines which package to level up with.
If package is omitted it will use the starting package assigned to that class or just the class package.

MeetsFeatRequirements(NwFeat): Gets if this creature meets the requirements to take the specified feat.

PlayVoiceChat(VoiceChatType): Instructs this creature to speak/play the specified voice chat.

RemoveFeat(NwFeat, bool): Removes the specified feat from this creature.

RemoveSpecialAbilityAt(int): Removes the specified ability at the given index.

Reputation(NwCreature): Gets how one creature feels toward this creature.

RestoreAllSpells(): Restore all NwCreature spells per day for all levels.

RestoreBaseAttackBonus(): Restores the number of base attacks back to it's original state on this (creature).

RestoreSpells(byte): Restore all NwCreature spells per day for given level.

RunEquip(NwItem, EquipmentSlots): Instruct this creature to instantly equip the specified item.

RunEquip(NwItem, InventorySlot): Instruct this creature to instantly equip the specified item.

RunUnequip(NwItem): Instruct this creature to instantly unequip the specified item.

Serialize()

SerializeQuickbar()

SetActionMode(ActionMode, bool): Instructs this creature to enable/disable the specified action mode (parry, power attack, expertise, etc).

SetAssociateListenPatterns(): Initialises this creature to listen for the standard AssociateCommand messages.
These are the messages sent by the standard party UI.

SetBaseSavingThrow(SavingThrow, sbyte): Sets this creatures's base save value for the specified saving throw.

SetCreatureBodyPart(CreaturePart, int): Sets the model number to use for the specified body part on the creature.

SetDamageLevelOverride(DamageLevelEntry): Sets the override value to use for this creature's damage level.

SetEffectIconFlashing(EffectIconTableEntry, bool): Sets whether the specified effect icon should be flashing in the creature's GUI icon bar.

SetFeatRemainingUses(NwFeat, byte): Sets the remaining uses available for the specified feat.
Cannot exceed the creature's total/max uses of the feat.

SetInitiativeModifier(int): Sets the modifier that is set for the creature's initiative.

SetQuickBarButton(byte, PlayerQuickBarButton)

SetQuickBarButtons(PlayerQuickBarButton[])

SetSkillRank(NwSkill, sbyte): Sets the skill ranks for the specified skill on this creature.

SetSpecialAbilityAt(int, SpecialAbility): Updates the specified ability at the given index.

SetTileExplored(NwArea, int, int, bool): Gets whether the given area tile is visible on the map for this creature.
Tile exploration also controls object visibility in areas and the fog of war for interior and underground areas.

SetsRawAbilityScore(Ability, byte): Sets the base (raw) ability score for the specified ability, without racial modifiers.

SpeakOneLinerConversation(string, NwGameObject?): Instructs this creature to immediately speak the first non-branching conversation line in their dialog.

SpellAbsorptionLimitedCheck(NwGameObject, NwSpell?, SpellSchool?, int?, bool, bool): Performs a spell absorption check for limited spell absorption effects (e.g. Spell Mantle).

SpellAbsorptionUnlimitedCheck(NwGameObject, NwSpell?, SpellSchool?, int?, bool): Performs a spell absorption check for unlimited spell absorption effects (e.g. Globe of invulnerability).

SpellImmunityCheck(NwGameObject, NwSpell?, bool): Performs a spell immunity check.

SpellResistanceCheck(NwGameObject, NwSpell?, int?, int?, bool): Performs a spell resistance check.

SummonAnimalCompanion(): Instructs this creature to summon their animal companion.
Does nothing if this creature has no animal companion available.

SummonAnimalCompanion(string): Forces this creature to summon a familiar event if it does not meet the base game requirements

SummonFamiliar(): Instructs this creature to summon their familiar (wizard/sorcerer).
Does nothing if this creature has no familiar available.

SummonFamiliar(string): Forces this creature to summon a familiar event if it does not meet the base game requirements

TakeGold(int, bool): Takes gold away from this creature.

TalentBest(TalentCategory, int): Gets the best talent from a group of talents.

TalentRandom(TalentCategory): Gets a random talent from a group of talents possessed by this creature.

TouchAttackMelee(NwGameObject, bool): Attempts to perform a melee touch attack on target. This is not a creature action, and assumes that this creature is already within range of the target.

TouchAttackRanged(NwGameObject, bool): Attempts to perform a ranged touch attack on the target. This is not a creature action, and simply does a roll to see if the target was hit.

UnpossessFamiliar(): Instructs this creature to unpossess their familiar.
This function can be run on the player creature, or the possessed familiar.

Unsummon(): Forces this creature to unsummon itself.
Does nothing if this creature is not a summon.

UnsummonAnimalCompanion(): Forces this creature to unsummon their animal companion.
Does nothing if this creature has no animal companion summoned.

UnsummonFamiliar(): Forces this creature to unsummon their familiar.
Does nothing if this creature has no familiar summoned.

Events

OnActivateItem: Triggered when an item that has the item property spell "Unique Power" (targeted) or "Unique Power - Self Only" (self) casts its spell.

OnAssociateAdd

OnAssociateRemove

OnBlocked: Triggered when the NwCreature is blocked by a NwDoor.

OnCheckEffectImmunity: Called when an effect is checking for creature immunities.
Use this event to force an effect to bypass creature immunities.

OnCombatDRBroken

OnCombatModeToggle

OnCombatRoundEnd: Triggered at the end of the NwCreature combat round.

OnCombatRoundStart

OnConversation: Called when this creature starts a conversation, or hears a message they are listening for.

OnCreatureAcquireItem

OnCreatureAttack

OnCreatureCheckProficiencies: Called when an item is tested against a creature's proficiencies to determine if the creature may attempt to equip the item.