Represents an effect engine structure. More...

Inheritance diagram for Anvil.API.Effect:

Collaboration diagram for Anvil.API.Effect:

Public Member Functions
Effect	Clone ()
	Creates a new copy of this effect.

Public Member Functions inherited from Anvil.API.EngineStructure
void	Dispose ()

Static Public Member Functions
static Effect	AbilityDecrease (Ability ability, int amount)
	Creates an effect that decreases a certain ability score.

static Effect	AbilityIncrease (Ability ability, int amount)
	Creates an effect that increases a certain ability score.

static Effect	ACDecrease (int amount, ACBonus acType=ACBonus.Dodge)
	Creates an effect that decreases the AC of an object.

static Effect	ACIncrease (int amount, ACBonus acType=ACBonus.Dodge)
	Creates an effect that increases the AC of an object.

static Effect	Appear ()
	Creates a special effect to make an object "fly in".

static Effect	AreaOfEffect (PersistentVfxTableEntry vfxType, ScriptCallbackHandle? onEnterHandle=null, ScriptCallbackHandle? heartbeatHandle=null, ScriptCallbackHandle? onExitHandle=null)
	Creates an area of effect (AOE) effect.

static Effect	AttackDecrease (int amount, AttackBonus penaltyType=AttackBonus.Misc)
	Creates an effect that applies a penalty to an attack roll.

static Effect	AttackIncrease (int amount, AttackBonus bonusType=AttackBonus.Misc)
	Creates an effect that applies a bonus to an attack roll.

static Effect	Beam (VfxType fxType, NwGameObject emitter, BodyNode origin, bool missTarget=false)
	Creates a visual beam effect.

static Effect	Blindness ()
	Creates an effect that blinds a creature.

static Effect	BonusFeat (NwFeat feat)
	Creates an effect that grants a bonus feat, similar to ItemProperty.BonusFeat.

static Effect	Charmed ()
	Creates an effect that increases the personal reputation to the target by 50 points.

static Effect	Concealment (int percentage, MissChanceType missChanceType=MissChanceType.Normal)
	Creates an effect that conceals an object.

static Effect	Confused ()
	Creates a confuse effect.

static Effect	Curse (int strMod=1, int dexMod=1, int conMod=1, int intMod=1, int wisMod=1, int chaMod=1)
	Creates a curse effect.

static Effect	CutsceneDominated ()
	Creates an effect that is guaranteed to dominate a creature, bypassing immunities and cannot be resisted.

static Effect	CutsceneGhost ()
	Creates an effect that allows creatures to pathfind through other creatures without bumping.

static Effect	CutsceneImmobilize ()
	Creates an effect that will prevent the target from moving, but can otherwise act unpenalized. The cutscene version bypasses immunities and cannot be resisted.

static Effect	CutsceneParalyze ()
	Creates an effect that is guaranteed to paralyze a creature, but can not be resisted.

static Effect	Damage (int amount, DamageType damageType=DamageType.Magical)
	Creates an effect that immediately applies damage to a target.

static Effect	DamageDecrease (int penalty, DamageType damageType=DamageType.Magical)
	Creates an effect that applies a penalty to a specified damage type.

static Effect	DamageImmunityDecrease (DamageType damageType, int pctImmunity)
	Creates an effect that decreases immunity to a certain damage type. If a creature does not have an immunity to the specified type, the creature will instead become more vulnerable to the damage, to a max of 100% (double damage).

static Effect	DamageImmunityIncrease (DamageType damageType, int pctImmunity)
	Creates an effect that increases immunity to a certain damage type, to a max of 100% (complete immunity).

static Effect	DamageIncrease (DamageBonus bonus, DamageType damageType=DamageType.Magical)
	Creates an effect that applies a bonus to a specified damage type.

static Effect	DamageIncrease (int bonus, DamageType damageType=DamageType.Magical)
	Creates an effect that applies a bonus to a specified damage type.

static Effect	DamageReduction (int amount, DamagePower damagePower, int totalAbsorb=0, bool rangedOnly=false)
	Creates an effect that resists a constant amount of damage from a physical attack with a certain magical power.

static Effect	DamageResistance (DamageType damageType, int amount, int totalAbsorb=0, bool rangedOnly=false)
	Creates an effect that resists a constant amount of damage from a specific damage type.

static Effect	DamageShield (int damageAmount, DamageBonus randomAmount, DamageType damageType)
	Creates an effect that reflects damage to melee attackers from successful hits.

static Effect	Darkness ()
	Creates an effect that shrouds an area in darkness, applying a miss chance to all those standing within. Creatures with an Ultravision effect will bypass this miss chance.

static Effect	Dazed ()
	Creates an effect that dazes a creature, preventing all actions but walking movement.

static Effect	Deaf ()
	Creates an effect that deafens a creature, applying a 20% spell failure chance for spells with (V)erbal components.

static Effect	Death (bool spectacularDeath=false, bool feedback=true)
	Creates an effect that kills, or destroys an object.

static Effect	Disappear ()
	Creates an effect that causes the object to "fly away", before destroying itself. This effect should not be applied to PCs.

static Effect	DisappearAppear (Location location, int animationType=1)
	Creates an effect that causes the object to "fly away", before appearing in another location.

static Effect	Disease (DiseaseType diseaseType)
	Creates an effect that applies a disease to a creature.

static Effect	DispelMagicAll (int casterLevel)
	Creates an effect that attempts to strip all (Sp)ell effects on a target, up to a specified caster level. (Su)pernatural and (Ex)traordinary effects can never be dispelled.

static Effect	DispelMagicBest (int casterLevel)
	Creates an effect that will attempt to strip the highest level spell effect on a target, up to a specified caster level.

static Effect	Dominated ()
	Creates a dominate effect. A dominated creature is added to the effect creators party. This means they will become instantly friendly and not attack each other, and they are treated as a normal friend as a henchman would be.

static Effect	EnemyAttackBonus (int bonus)
	Creates an effect that gives a creature with melee/ranged/touched attacks a bonus to hit.

static Effect	Entangle ()
	Creates an effect that prevents all movement, and applies a -2 to all attacks and a -4 to AC.

static Effect	Ethereal ()
	Creates an effect that causes the creature to become invisible and un-perceivable, and taking on an ethereal appearance. The effect is cancelled when the creature performs a hostile action.

static Effect	ForceWalk ()
	Creates an effect that forces creatures to always walk.

static Effect	Frightened ()
	Creates a frightened effect for use in making creatures shaken or flee.

static Effect	Haste ()
	Creates a haste effect. Haste effects add +4 dodge AC, +1 action/round and 50% movement speed increase.

static Effect	Heal (int damageToHeal)
	Creates a heal effect that will heal the object it is applied to by the specified damage amount.

static Effect	HitPointChangeWhenDying (float hpChangePerRound)
	Creates a special effect for healing/damaging dying players.

static Effect	Icon (EffectIconTableEntry icon)
	Creates an icon effect. Icons appear in the top right and in the character sheet and examine panels.

static Effect	Immunity (ImmunityType immunityType)
	Creates an immunity effect. This provides immunity to a specific effect type.

static Effect	Invisibility (InvisibilityType invisibilityType)
	Creates an invisiblity effect. Behaviour is defined from the specified invisibility type.

static Effect	Knockdown ()
	Creates a knockdown effect. This effect knocks creatures off their feet, they will sit until the effect is removed.

static Effect	LinkEffects (Effect baseEffect, IEnumerable< Effect > effects)

static Effect	LinkEffects (Effect baseEffect, params Effect[] effects)
	Creates a new linked effect from the specified effects. If you remove/dispel one of the effects from a target which is linked to others, the other linked effects will be removed/dispelled too.

static Effect	MissChance (int missPct, MissChanceType missChanceType=MissChanceType.Normal)
	Creates a new effect used to hinder the attacks of the creature it is applied to.

static Effect	ModifyAttacks (int numAttacks)
	Creates an effect that modifies the amount of attacks a creature can perform.

static Effect	MovementSpeedDecrease (int pctChange)
	Creates an effect that reduces the movement speed of a creature.

static Effect	MovementSpeedIncrease (int pctChange)
	Creates an effect that increases the movement speed of a creature.

static Effect	NegativeLevel (int numLevels)
	Creates an effect that will "decrease" the level of the target.

static implicit	operator Effect? (IntPtr intPtr)

static Effect	Pacified ()
	Creates an effect that pacifies a creature, making them unable to do attacks.

static Effect	Paralyze ()
	Creates a paralyze effect.

static Effect	Petrify ()
	Creates an effect that will petrify a creature. It is similar to Paralyze, but also applies the VfxType.DurPetrify visual effect.

static Effect	Poison (PoisonType poisonType)
	Creates a poison effect that sets the poisoned status effect, with varying penalties based on the type chosen.

static Effect	Polymorph (PolymorphTableEntry polymorphType, bool locked=false, VfxType? unPolymorphVfx=VfxType.ImpPolymorph, int spellAbilityModifier=-1, int spellAbilityCasterLevel=0)
	Creates a polymorph effect that changes the target into a different kind of creature.

static Effect	Regenerate (int amountPerInterval, TimeSpan interval)
	Creates a regeneration effect that will cause the target to heal the specified amount at each interval.

static Effect	Resurrection ()
	Creates an effect that raises a creature who is dead to 1 hit point.

static Effect	RunAction (ScriptCallbackHandle? onAppliedHandle=null, ScriptCallbackHandle? onRemovedHandle=null, ScriptCallbackHandle? onIntervalHandle=null, TimeSpan interval=default, string data="")
	Creates a custom scripted effect.

static Effect	Sanctuary (int difficultyClass)
	Creates a sanctuary effect. Sanctuary effects work similar to invisibility effects, but also cause creatures to be unable to hear the target creature, if they fail the DC.

static Effect	SavingThrowDecrease (SavingThrow savingThrow, int amount, SavingThrowType savingThrowType=SavingThrowType.All)
	Creates an effect to decrease one saving throw type.

static Effect	SavingThrowIncrease (SavingThrow savingThrow, int amount, SavingThrowType savingThrowType=SavingThrowType.All)
	Creates an effect to increase one saving throw type.

static Effect	SeeInvisible ()
	Creates an effect that allows a creature to see through magical invisibility.

static Effect	Silence ()
	Creates an effect that silences a creature. Silent creatures may not cast spell with verbal components.

static Effect	SkillDecrease (NwSkill skill, int amount)
	Creates an effect that decreases a specific skill score.

static Effect	SkillDecreaseAll (int amount)
	Creates an effect that decreases all skill scores.

static Effect	SkillIncrease (NwSkill skill, int amount)
	Creates an effect that increases a specific skill score.

static Effect	SkillIncreaseAll (int amount)
	Creates an effect that increases all skill scores.

static Effect	Sleep ()
	Creates a sleep effect. Sleeping creatures may not act, and are subject to coup de grace (4 or less HD)

static Effect	Slow ()
	Creates a slow effect. Slowed creatures have no benefits from any haste applied to them, or if they have no haste, have 1 attack per round, -2 AC, -2 attack, -2 Reflex Saving Throw, and -50% movement speed.

static Effect	SpellFailure (int failPct, SpellSchool spellSchool=SpellSchool.General, SpellFailureType failureType=SpellFailureType.All)
	Creates an effect that inhibits spells.

static Effect	SpellImmunity (Spell spell=API.Spell.AllSpells)
	Creates an effect that provides immunity to a specific spell.

static Effect	SpellLevelAbsorption (int maxSpellLevel, int totalSpellsAbsorbed=0, SpellSchool spellSchool=SpellSchool.General)
	Creates an effect that absorbs a certain amount of spells.

static Effect	SpellResistanceDecrease (int amount)
	Creates an effect that decreases the spell resistance of a creature.

static Effect	SpellResistanceIncrease (int amount)
	Creates an effect that increases the spell resistance of a creature.

static Effect	Stunned ()
	Creates a stun effect. This is a mind-effecting effect, and so immunity to mind effects prevents this from working. Stunned creatures are flat-footed (no AC dex bonus), and cannot move.

static Effect	SummonCreature (NwCreature summonCreature, VisualEffectTableEntry summonVfx, VisualEffectTableEntry? unsummonVfx=default)
	Creates an effect that uses summon behaviours on an existing creature.

static Effect	SummonCreature (string creatureResRef, VisualEffectTableEntry summonVfx, TimeSpan delay=default, int appearType=0, VisualEffectTableEntry? unsummonVfx=default)
	Creates an effect to summon a creature from a resref. THIS IS OBJECT CONTEXT SENSITIVE! Use NwObject.WaitForObjectContext to correctly assign the right owner of the master.

static Effect	Swarm (bool loop, string creatureTemplate1, string creatureTemplate2="", string creatureTemplate3="", string creatureTemplate4="")
	Creates a swarm effect. This is exactly the same as SummonCreature(string,Anvil.API.VisualEffectTableEntry,System.TimeSpan,int,Anvil.API.VisualEffectTableEntry?), except, after one dies, another takes its place.

static Effect	TemporaryHitpoints (int hitPoints)
	Creates an effect that will give temporary hitpoints to a target.

static Effect	TimeStop ()
	Creates a time stop effect. Time stop applies a special module-wide pause which only the object it is applied to (and DM's) can move and cast spells without penalties or hindrance. This is not recommended for multiplayer games as it will cause everyone in the module to pause. You can query the current timestop state with NwServer.IsTimestopPaused.

static Effect	TimeStopImmunity ()
	Creates a time stop immunity effect. Immunity allows objects to continue taking actions during an active time stop effect.

static Effect	TrueSeeing ()
	Creates a true seeing effect. Creatures with true sight can see through stealth, invisibility, sanctuary and darkness.

static Effect	Turned ()
	Creates a turned effect. Turning bypass all fear immunity effects, but should only be used in the turn undead script.

static Effect	TurnResistanceDecrease (int hitDiceDecrease)
	Creates an effect that decreases a creature's turn resistance, making them more susceptible to turning.

static Effect	TurnResistanceIncrease (int hitDiceIncrease)
	Creates an effect that increases a creature's turn resistance, making them more resistant to turning.

static Effect	Ultravision ()
	Creates an Ultravision effect. Ultravision lets the target see through Darkness and Invisibility effects with InvisibilityType.Darkness.

static Effect	VisualEffect (VfxType visualEffectId, bool missEffect=false, float fScale=1.0f, System.Numerics.Vector3 vTranslate=default, System.Numerics.Vector3 vRotate=default)
	Creates an effect that plays a visual effect when applied.

static Effect	VisualEffect (VisualEffectTableEntry visualEffect, bool missEffect=false, float fScale=1.0f, System.Numerics.Vector3 vTranslate=default, System.Numerics.Vector3 vRotate=default)
	Creates an effect that plays a visual effect when applied.

Static Public Member Functions inherited from Anvil.API.EffectBase
static implicit	operator CGameEffect (EffectBase effect)

Static Public Member Functions inherited from Anvil.API.EngineStructure
static implicit	operator IntPtr (EngineStructure engineStructure)

Properties
float	DurationRemaining `[get]`
	Gets the remaining duration of this effect in seconds. Returns 0 if the duration type is not EffectDuration.Temporary.

EffectDuration	DurationType `[get, set]`
	Gets or sets the duration type (Temporary, Instant, Permanent) of this effect.

EffectType	EffectType `[get]`
	Gets the type of this effect.

bool	IgnoreImmunity `[get, set]`
	Gets or sets if this effect should ignore immunities.

string	LinkId `[get]`
	Gets the link id of this effect, if it is a linked effect. There is no guarantees about this identifier other than it is unique and the same for all effects linked to it.

override int	StructureId `[get]`

EffectSubType	SubType `[get, set]`
	Gets or sets the subtype of this effect.

string?	Tag `[get, set]`
	Gets or sets the tag for this effect.

float	TotalDuration `[get]`
	Gets the total duration of this effect in seconds. Returns 0 if the duration type is not EffectDuration.Temporary.

Properties inherited from Anvil.API.EffectBase
int	CasterLevel `[get, set]`
	Gets or sets the caster level for this effect/item property.

NwObject?	Creator `[get, set]`
	Gets or sets the creator of this effect/item property.

bool	Expose `[get, set]`

EffectParams< float >	FloatParams `[get]`
	Gets the float parameters of this effect/item property.

EffectParams< int >	IntParams `[get]`
	Gets the integer parameters of this effect/item property.

EffectParams< NwObject >	ObjectParams `[get]`
	Gets the object parameters of this effect/item property.

bool	ShowIcon `[get, set]`
	Gets or sets if this effect should show an icon in the top right and in the character sheet and examine panels.

NwSpell?	Spell `[get, set]`
	Gets or sets the associated spell for this effect/item property.

EffectParams< string >	StringParams `[get]`
	Gets the string parameters of this effect/item property.

EffectParams< Vector3 >	VectorParams `[get]`
	Gets the vector parameters of this effect/item property.

Properties inherited from Anvil.API.EngineStructure
bool	IsValid `[get]`
	Gets if this object is valid.

int	StructureId `[get]`

Additional Inherited Members
Protected Member Functions inherited from Anvil.API.EffectBase
unsafe	EffectBase (CGameEffect effect, bool memoryOwn)

Protected Member Functions inherited from Anvil.API.EngineStructure
	EngineStructure (IntPtr handle, bool memoryOwn)

Protected Attributes inherited from Anvil.API.EffectBase
readonly CGameEffect	Effect

Detailed Description

Represents an effect engine structure.

Examples

/*
 * Examples for creating and applying effects to objects and locations.
 */
 
using System;
using System.Linq;
using Anvil.API;
using Anvil.API.Events;
using Anvil.Services;
 
namespace NWN.Anvil.Samples
{
  [ServiceBinding(typeof(EffectExamples))]
  public class EffectExamples
  {
    // Some effects can be declared as fields. This allows you to reuse effects, rather than creating them every time.
    private readonly Effect blindnessEffect = Effect.Blindness();
    private readonly Effect bloodVfx = Effect.VisualEffect(VfxType.ComBloodCrtRed);
 
    public EffectExamples()
    {
      // Make our blindness effect a supernatural effect.
      blindnessEffect.SubType = EffectSubType.Supernatural;
 
      // Register methods to listen for the player/client enter event.
      NwModule.Instance.OnClientEnter += RatSummonExample;
 
      // When entering a specific area, remove all blindness effects:
      NwArea? area = NwObject.FindObjectsWithTag<NwArea>("clear_blind").FirstOrDefault();
      if (area != null)
      {
        area.OnEnter += RemoveBlindnessExample;
      }
 
      // Register methods to listen for the creature damage event.
      NwModule.Instance.OnCreatureDamage += BloodVfxExample;
      NwModule.Instance.OnCreatureDamage += BlindnessExample;
    }
 
    private async void RatSummonExample(ModuleEvents.OnClientEnter eventData)
    {
      // Create the summon effect.
      // Some effects require a "caster" for the effect, and must be made within the caster's context.
      await eventData.Player.ControlledCreature!.WaitForObjectContext();
      Effect summon = Effect.SummonCreature("nw_rat001", VfxType.ImpUnsummon);
 
      // Spawn the summon at the module's starting location
      Location spawnLocation = NwModule.Instance.StartingLocation;
      spawnLocation.ApplyEffect(EffectDuration.Temporary, summon, TimeSpan.FromMinutes(5));
    }
 
    private void BloodVfxExample(OnCreatureDamage eventData)
    {
      // If the target is a creature, and the attack does more than 50 slashing damage...
      if (eventData.Target is NwCreature && eventData.DamageData.GetDamageByType(DamageType.Slashing) > 50)
      {
        // ...Apply our blood effect to the creature
        eventData.Target.ApplyEffect(EffectDuration.Instant, bloodVfx);
      }
    }
 
    private void BlindnessExample(OnCreatureDamage eventData)
    {
      // If the target is a creature, and the attack does more than 100 bludgeoning damage...
      if (eventData.Target is NwCreature && eventData.DamageData.GetDamageByType(DamageType.Bludgeoning) > 100)
      {
        // ...Apply our blindness effect for 5 seconds.
        eventData.Target.ApplyEffect(EffectDuration.Temporary, blindnessEffect, TimeSpan.FromSeconds(5));
      }
    }
 
    private void RemoveBlindnessExample(AreaEvents.OnEnter eventData)
    {
      // If the object entering is not a creature, early return.
      if (eventData.EnteringObject is not NwCreature creature)
      {
        return;
      }
 
      // Loop through all active effects on the creature, and remove any with the blindness type.
      foreach (Effect effect in creature.ActiveEffects)
      {
        if (effect.EffectType == EffectType.Blindness)
        {
          creature.RemoveEffect(effect);
        }
      }
    }
  }
}

Member Function Documentation

◆ AbilityDecrease()

static Effect Anvil.API.Effect.AbilityDecrease	(	Ability	ability,
		int	amount )

inlinestatic

Creates an effect that decreases a certain ability score.

Parameters

ability	The ability to decrease.
amount	The amount to increase the ability by.

◆ AbilityIncrease()

static Effect Anvil.API.Effect.AbilityIncrease	(	Ability	ability,
		int	amount )

inlinestatic

Creates an effect that increases a certain ability score.

Parameters

ability	The ability to increase.
amount	The amount to increase the ability by.

◆ ACDecrease()

static Effect Anvil.API.Effect.ACDecrease	(	int	amount,
		ACBonus	acType = ACBonus::Dodge )

inlinestatic

Creates an effect that decreases the AC of an object.

Parameters

amount	The AC penalty.
acType	The type of AC to decrease (Dodge).

◆ ACIncrease()

static Effect Anvil.API.Effect.ACIncrease	(	int	amount,
		ACBonus	acType = ACBonus::Dodge )

inlinestatic

Creates an effect that increases the AC of an object.

Parameters

amount	The AC bonus.
acType	The AC type of the AC bonus.

◆ AreaOfEffect()

static Effect Anvil.API.Effect.AreaOfEffect	(	PersistentVfxTableEntry	vfxType,
		ScriptCallbackHandle?	onEnterHandle = null,
		ScriptCallbackHandle?	heartbeatHandle = null,
		ScriptCallbackHandle?	onExitHandle = null )

inlinestatic

Creates an area of effect (AOE) effect.

Parameters

vfxType	The persistent area visual effect to use for this effect.
onEnterHandle	The callback to invoke when something enters this area of effect.
heartbeatHandle	The callback to invoke when something is inside the area of effect during a heartbeat (~6 seconds)
onExitHandle	The callback to invoke when something leaves this area of effect.

◆ AttackDecrease()

static Effect Anvil.API.Effect.AttackDecrease	(	int	amount,
		AttackBonus	penaltyType = AttackBonus::Misc )

inlinestatic

Creates an effect that applies a penalty to an attack roll.

Parameters

amount	The penalty to apply.
penaltyType	The weapon slot this penalty should be applied to.

◆ AttackIncrease()

static Effect Anvil.API.Effect.AttackIncrease	(	int	amount,
		AttackBonus	bonusType = AttackBonus::Misc )

inlinestatic

Creates an effect that applies a bonus to an attack roll.

Parameters

amount	The bonus to apply.
bonusType	The weapon slot this bonus should be applied to.

◆ Beam()

static Effect Anvil.API.Effect.Beam	(	VfxType	fxType,
		NwGameObject	emitter,
		BodyNode	origin,
		bool	missTarget = false )

inlinestatic

Creates a visual beam effect.

Parameters

fxType	The beam effect to render.
emitter	The origin object of this beam .
origin	The origin body part of this beam.
missTarget	If true, the beam will hit a random position near or past the applied target to indicate a miss.

◆ BonusFeat()

static Effect Anvil.API.Effect.BonusFeat ( NwFeat feat )

inlinestatic

Creates an effect that grants a bonus feat, similar to ItemProperty.BonusFeat.

Parameters

feat	The feat to grant.

◆ Concealment()

static Effect Anvil.API.Effect.Concealment	(	int	percentage,
		MissChanceType	missChanceType = MissChanceType::Normal )

inlinestatic

Creates an effect that conceals an object.

Parameters

percentage	A positive number representing the percentage chance for other attackers to miss (1-100).
missChanceType	The type of attack to apply this concealment against.

◆ Curse()

static Effect Anvil.API.Effect.Curse	(	int	strMod = 1,
		int	dexMod = 1,
		int	conMod = 1,
		int	intMod = 1,
		int	wisMod = 1,
		int	chaMod = 1 )

inlinestatic

Creates a curse effect.

Parameters

strMod	The penalty to Strength.
dexMod	The penalty to Dexterity.
conMod	The penalty to Constitution.
intMod	The penalty to Intelligence.
wisMod	The penalty to Wisdom.
chaMod	The penalty to Charisma.

◆ Damage()

static Effect Anvil.API.Effect.Damage	(	int	amount,
		DamageType	damageType = DamageType::Magical )

inlinestatic

Creates an effect that immediately applies damage to a target.

Parameters

amount	The amount of damage to apply.
damageType	The damage type to apply.

◆ DamageDecrease()

static Effect Anvil.API.Effect.DamageDecrease	(	int	penalty,
		DamageType	damageType = DamageType::Magical )

inlinestatic

Creates an effect that applies a penalty to a specified damage type.

Parameters

penalty	The damage penalty to apply.
damageType	The damage type to apply the penalty to.

◆ DamageImmunityDecrease()

static Effect Anvil.API.Effect.DamageImmunityDecrease	(	DamageType	damageType,
		int	pctImmunity )

inlinestatic

Creates an effect that decreases immunity to a certain damage type.
If a creature does not have an immunity to the specified type, the creature will instead become more vulnerable to the damage, to a max of 100% (double damage).

Parameters

damageType	The type of damage to decrease immunity against.
pctImmunity	A positive number representing the percentage decrease (1-100).

◆ DamageImmunityIncrease()

static Effect Anvil.API.Effect.DamageImmunityIncrease	(	DamageType	damageType,
		int	pctImmunity )

inlinestatic

Creates an effect that increases immunity to a certain damage type, to a max of 100% (complete immunity).

Parameters

damageType	The type of damage to increase immunity against.
pctImmunity	A positive number representing the percentage increase (1-100).

◆ DamageIncrease() [1/2]

static Effect Anvil.API.Effect.DamageIncrease	(	DamageBonus	bonus,
		DamageType	damageType = DamageType::Magical )

inlinestatic

Creates an effect that applies a bonus to a specified damage type.

Parameters

bonus	The damage bonus to apply.
damageType	The damage type to apply the bonus to.

◆ DamageIncrease() [2/2]

static Effect Anvil.API.Effect.DamageIncrease	(	int	bonus,
		DamageType	damageType = DamageType::Magical )

inlinestatic

Creates an effect that applies a bonus to a specified damage type.

Parameters

bonus	The damage bonus to apply.
damageType	The damage type to apply the bonus to.

◆ DamageReduction()

static Effect Anvil.API.Effect.DamageReduction	(	int	amount,
		DamagePower	damagePower,
		int	totalAbsorb = 0,
		bool	rangedOnly = false )

inlinestatic

Creates an effect that resists a constant amount of damage from a physical attack with a certain magical power.

Parameters

amount	The damage to remove from each attack.
damagePower	The max enchantment/power bonus of the weapon this effect will resist.
totalAbsorb	The total amount of damage to absorb, before the effect is removed (0 = infinite).
rangedOnly	Set to true to have this damage reduction effect only apply to ranged attacks.

◆ DamageResistance()

static Effect Anvil.API.Effect.DamageResistance	(	DamageType	damageType,
		int	amount,
		int	totalAbsorb = 0,
		bool	rangedOnly = false )

inlinestatic

Creates an effect that resists a constant amount of damage from a specific damage type.

Parameters

damageType	The type of damage to resist.
amount	The damage to remove from each attack.
totalAbsorb	The total amount of damage to absorb, before the effect is removed (0 = infinite).
rangedOnly	Set to true to have this damage resistance effect only apply to ranged attacks.

◆ DamageShield()

static Effect Anvil.API.Effect.DamageShield	(	int	damageAmount,
		DamageBonus	randomAmount,
		DamageType	damageType )

inlinestatic

Creates an effect that reflects damage to melee attackers from successful hits.

Parameters

damageAmount	The flat amount of damage to reflect back to the attacker.
randomAmount	A special damage amount to additionally reflect back to the attacker.
damageType	The type of the damage reflected to the attacker.

◆ Death()

static Effect Anvil.API.Effect.Death	(	bool	spectacularDeath = false,
		bool	feedback = true )

inlinestatic

Creates an effect that kills, or destroys an object.

Parameters

spectacularDeath	If true, the object in which this is applied will die in an extraordinary fashion (gibs).
feedback	If false, excludes the "XXX: Dead" feedback message.

◆ DisappearAppear()

static Effect Anvil.API.Effect.DisappearAppear	(	Location	location,
		int	animationType = 1 )

inlinestatic

Creates an effect that causes the object to "fly away", before appearing in another location.

Parameters

location	The new location to re-appear at.
animationType	The appear/disappear animation nto use.

◆ Disease()

static Effect Anvil.API.Effect.Disease ( DiseaseType diseaseType )

inlinestatic

Creates an effect that applies a disease to a creature.

Parameters

diseaseType The type of disease to apply.

◆ DispelMagicAll()

static Effect Anvil.API.Effect.DispelMagicAll ( int casterLevel )

inlinestatic

Creates an effect that attempts to strip all (Sp)ell effects on a target, up to a specified caster level.
(Su)pernatural and (Ex)traordinary effects can never be dispelled.

Parameters

casterLevel The max (inclusive) caster level of spell to dispel.

◆ DispelMagicBest()

static Effect Anvil.API.Effect.DispelMagicBest ( int casterLevel )

inlinestatic

Creates an effect that will attempt to strip the highest level spell effect on a target, up to a specified caster level.

Parameters

casterLevel The max (inclusive) caster level of spell to dispel.

◆ EnemyAttackBonus()

static Effect Anvil.API.Effect.EnemyAttackBonus ( int bonus )

inlinestatic

Creates an effect that gives a creature with melee/ranged/touched attacks a bonus to hit.

Parameters

bonus The additional attack bonus.

◆ Heal()

static Effect Anvil.API.Effect.Heal ( int damageToHeal )

inlinestatic

Creates a heal effect that will heal the object it is applied to by the specified damage amount.

Parameters

damageToHeal The amount of damage to heal.

◆ HitPointChangeWhenDying()

static Effect Anvil.API.Effect.HitPointChangeWhenDying ( float hpChangePerRound )

inlinestatic

Creates a special effect for healing/damaging dying players.

Parameters

hpChangePerRound The HP change each round.

◆ Icon()

static Effect Anvil.API.Effect.Icon ( EffectIconTableEntry icon )

inlinestatic

Creates an icon effect. Icons appear in the top right and in the character sheet and examine panels.

Parameters

icon	The icon to display.

◆ Immunity()

static Effect Anvil.API.Effect.Immunity ( ImmunityType immunityType )

inlinestatic

Creates an immunity effect. This provides immunity to a specific effect type.

Parameters

immunityType The type of immunity.

◆ Invisibility()

static Effect Anvil.API.Effect.Invisibility ( InvisibilityType invisibilityType )

inlinestatic

Creates an invisiblity effect. Behaviour is defined from the specified invisibility type.

Parameters

invisibilityType The type of invisibility to apply.

◆ LinkEffects()

static Effect Anvil.API.Effect.LinkEffects	(	Effect	baseEffect,
		params Effect[]	effects )

inlinestatic

Creates a new linked effect from the specified effects.
If you remove/dispel one of the effects from a target which is linked to others, the other linked effects will be removed/dispelled too.

Parameters

baseEffect	The base effect.
effects	The effects to link.

Returns: The new composite effect linking both effects.

◆ MissChance()

static Effect Anvil.API.Effect.MissChance	(	int	missPct,
		MissChanceType	missChanceType = MissChanceType::Normal )

inlinestatic

Creates a new effect used to hinder the attacks of the creature it is applied to.

Parameters

missPct	A positive number representing the percentage chance to miss.
missChanceType	The type of attack that will have the hindered attack.

◆ ModifyAttacks()

static Effect Anvil.API.Effect.ModifyAttacks ( int numAttacks )

inlinestatic

Creates an effect that modifies the amount of attacks a creature can perform.

Parameters

numAttacks The number of attacks to add to the target (max 5).

◆ MovementSpeedDecrease()

static Effect Anvil.API.Effect.MovementSpeedDecrease ( int pctChange )

inlinestatic

Creates an effect that reduces the movement speed of a creature.

Parameters

pctChange A positive number representing the percentage speed to decrease (0-99)

◆ MovementSpeedIncrease()

static Effect Anvil.API.Effect.MovementSpeedIncrease ( int pctChange )

inlinestatic

Creates an effect that increases the movement speed of a creature.

Parameters

pctChange A positive number representing the percentage speed to increase (0-99)

◆ NegativeLevel()

static Effect Anvil.API.Effect.NegativeLevel ( int numLevels )

inlinestatic

Creates an effect that will "decrease" the level of the target.

Parameters

numLevels The number of negative levels to apply.

◆ Paralyze()

static Effect Anvil.API.Effect.Paralyze ( )

inlinestatic

Creates a paralyze effect.

Paralysis is not a mind effect - it stops all movement (and also in-game pauses the creature in their current action), and so they are prone, have no dexterity or strength (act as if had the lowest, 3) and all sneak attacks work against them.
By default creatures level 4 and below in 10 meters can be "coup de grace" ie instantly killed on a successful hit.

◆ Poison()

static Effect Anvil.API.Effect.Poison ( PoisonType poisonType )

inlinestatic

Creates a poison effect that sets the poisoned status effect, with varying penalties based on the type chosen.

Parameters

poisonType The type of poison to apply.

◆ Polymorph()

static Effect Anvil.API.Effect.Polymorph	(	PolymorphTableEntry	polymorphType,
		bool	locked = false,
		VfxType?	unPolymorphVfx = VfxType::ImpPolymorph,
		int	spellAbilityModifier = -1,
		int	spellAbilityCasterLevel = 0 )

inlinestatic

Creates a polymorph effect that changes the target into a different kind of creature.

Parameters

polymorphType	The polymorph to apply.
locked	If true, players cannot dismiss the polymorph effect.
unPolymorphVfx	The visual effect that will play when this polymorph is removed. Set to null to have no effect play.
spellAbilityModifier	Set a custom spell ability modifier for the 3 polymorph spells. Save DC is 10 + Innate spell level + this ability modifier.
spellAbilityCasterLevel	Set a custom caster level for the 3 polymorph spells.

◆ Regenerate()

static Effect Anvil.API.Effect.Regenerate	(	int	amountPerInterval,
		TimeSpan	interval )

inlinestatic

Creates a regeneration effect that will cause the target to heal the specified amount at each interval.

Parameters

amountPerInterval	The amount to heal.
interval	The interval at which the healing is applied.

◆ RunAction()

static Effect Anvil.API.Effect.RunAction	(	ScriptCallbackHandle?	onAppliedHandle = null,
		ScriptCallbackHandle?	onRemovedHandle = null,
		ScriptCallbackHandle?	onIntervalHandle = null,
		TimeSpan	interval = default,
		string	data = "" )

inlinestatic

Creates a custom scripted effect.

Parameters

onAppliedHandle	The callback to invoke when this effect is applied.
onRemovedHandle	The callback to invoke when this effect is removed (via script, death, resting, or dispelling).
onIntervalHandle	The callback to invoke per interval.
interval	The interval in which to call onIntervalHandle.
data	Optional string of data saved with the effect, retrievable with Effect.StringParams[0].

◆ Sanctuary()

static Effect Anvil.API.Effect.Sanctuary ( int difficultyClass )

inlinestatic

Creates a sanctuary effect. Sanctuary effects work similar to invisibility effects, but also cause creatures to be unable to hear the target creature, if they fail the DC.

Parameters

difficultyClass The difficulty class for other creatures to beat the effect, allowing them to see and hear the creature.

◆ SavingThrowDecrease()

static Effect Anvil.API.Effect.SavingThrowDecrease	(	SavingThrow	savingThrow,
		int	amount,
		SavingThrowType	savingThrowType = SavingThrowType::All )

inlinestatic

Creates an effect to decrease one saving throw type.

Parameters

savingThrow	The saving throw to decrease.
amount	The amount to decrease the saving throw.
savingThrowType	The saving throw sub-type to decrease.

◆ SavingThrowIncrease()

static Effect Anvil.API.Effect.SavingThrowIncrease	(	SavingThrow	savingThrow,
		int	amount,
		SavingThrowType	savingThrowType = SavingThrowType::All )

inlinestatic

Creates an effect to increase one saving throw type.

Parameters

savingThrow	The saving throw to increase.
amount	The amount to increase the saving throw.
savingThrowType	The saving throw sub-type to increase.

◆ SkillDecrease()

static Effect Anvil.API.Effect.SkillDecrease	(	NwSkill	skill,
		int	amount )

inlinestatic

Creates an effect that decreases a specific skill score.

Parameters

skill	The skill to decrease.
amount	The amount to decrease the skill by.

◆ SkillDecreaseAll()

static Effect Anvil.API.Effect.SkillDecreaseAll ( int amount )

inlinestatic

Creates an effect that decreases all skill scores.

Parameters

amount The amount to decrease all skills by.

◆ SkillIncrease()

static Effect Anvil.API.Effect.SkillIncrease	(	NwSkill	skill,
		int	amount )

inlinestatic

Creates an effect that increases a specific skill score.

Parameters

skill	The skill to increase.
amount	The amount to increase the skill by.

◆ SkillIncreaseAll()

static Effect Anvil.API.Effect.SkillIncreaseAll ( int amount )

inlinestatic

Creates an effect that increases all skill scores.

Parameters

amount The amount to increase all skills by.

◆ SpellFailure()

static Effect Anvil.API.Effect.SpellFailure	(	int	failPct,
		SpellSchool	spellSchool = SpellSchool::General,
		SpellFailureType	failureType = SpellFailureType::All )

inlinestatic

Creates an effect that inhibits spells.

Parameters

failPct	A positive number representing the percent chance of spell failing (1-100)
spellSchool	The spell school that is affected.
failureType	Use SpellFailureType constants for different spell failure types.

◆ SpellImmunity()

static Effect Anvil.API.Effect.SpellImmunity ( Spell spell = API::Spell::AllSpells )

inlinestatic

Creates an effect that provides immunity to a specific spell.

Parameters

spell The spell to provide immunity for.

◆ SpellLevelAbsorption()

static Effect Anvil.API.Effect.SpellLevelAbsorption	(	int	maxSpellLevel,
		int	totalSpellsAbsorbed = 0,
		SpellSchool	spellSchool = SpellSchool::General )

inlinestatic

Creates an effect that absorbs a certain amount of spells.

Parameters

maxSpellLevel	The max level spell that can be absorbed.
totalSpellsAbsorbed	The total number of spells that can be absorbed.
spellSchool	The spell school to absorb specifically.

◆ SpellResistanceDecrease()

static Effect Anvil.API.Effect.SpellResistanceDecrease ( int amount )

inlinestatic

Creates an effect that decreases the spell resistance of a creature.

Parameters

amount The amount to decrease.

◆ SpellResistanceIncrease()

static Effect Anvil.API.Effect.SpellResistanceIncrease ( int amount )

inlinestatic

Creates an effect that increases the spell resistance of a creature.

Parameters

amount The amount to increase.

◆ SummonCreature() [1/2]

static Effect Anvil.API.Effect.SummonCreature	(	NwCreature	summonCreature,
		VisualEffectTableEntry	summonVfx,
		VisualEffectTableEntry?	unsummonVfx = default )

inlinestatic

Creates an effect that uses summon behaviours on an existing creature.

Parameters

summonCreature	The creature to be used as the summoned creature. Must not have a current "master" creature.
summonVfx	A visual effect to display when claiming the summoned creature.
unsummonVfx	A visual effect to play when the summoned creature is unsummoned.

◆ SummonCreature() [2/2]

static Effect Anvil.API.Effect.SummonCreature	(	string	creatureResRef,
		VisualEffectTableEntry	summonVfx,
		TimeSpan	delay = default,
		int	appearType = 0,
		VisualEffectTableEntry?	unsummonVfx = default )

inlinestatic

Creates an effect to summon a creature from a resref.
THIS IS OBJECT CONTEXT SENSITIVE! Use NwObject.WaitForObjectContext to correctly assign the right owner of the master.

Parameters

creatureResRef	The template/ResRef of the creature to summon.
summonVfx	A visual effect to display upon summoning.
delay	A delay between the visual effect, and the creature actually being added to the area.
appearType	The appear animation to use.
unsummonVfx	A visual effect to display when this creature is unsummoned.

◆ Swarm()

static Effect Anvil.API.Effect.Swarm	(	bool	loop,
		string	creatureTemplate1,
		string	creatureTemplate2 = "",
		string	creatureTemplate3 = "",
		string	creatureTemplate4 = "" )

inlinestatic

Creates a swarm effect. This is exactly the same as SummonCreature(string,Anvil.API.VisualEffectTableEntry,System.TimeSpan,int,Anvil.API.VisualEffectTableEntry?), except, after one dies, another takes its place.

Parameters

loop	If true, while the effect is active and the last creature dies, it will loop back to the first template.
creatureTemplate1	The blueprint of the first creature to spawn.
creatureTemplate2	The blueprint of the second creature to spawn.
creatureTemplate3	The blueprint of the third creature to spawn.
creatureTemplate4	The blueprint of the fourth creature to spawn.

◆ TemporaryHitpoints()

static Effect Anvil.API.Effect.TemporaryHitpoints ( int hitPoints )

inlinestatic

Creates an effect that will give temporary hitpoints to a target.

Parameters

hitPoints The amount of temporary hit points to add.

◆ TurnResistanceDecrease()

static Effect Anvil.API.Effect.TurnResistanceDecrease ( int hitDiceDecrease )

inlinestatic

Creates an effect that decreases a creature's turn resistance, making them more susceptible to turning.

Parameters

hitDiceDecrease A positive number representing the number of hit dice to decrease.

◆ TurnResistanceIncrease()

static Effect Anvil.API.Effect.TurnResistanceIncrease ( int hitDiceIncrease )

inlinestatic

Creates an effect that increases a creature's turn resistance, making them more resistant to turning.

Parameters

hitDiceIncrease A positive number representing the number of hit dice to increase.

◆ VisualEffect() [1/2]

static Effect Anvil.API.Effect.VisualEffect	(	VfxType	visualEffectId,
		bool	missEffect = false,
		float	fScale = 1::0f,
		System.Numerics.Vector3	vTranslate = default,
		System.Numerics.Vector3	vRotate = default )

inlinestatic

Creates an effect that plays a visual effect when applied.

Parameters

visualEffectId	The visual effect to apply.
missEffect	If true, a random vector near or past the target will be generated, as the location for the effect.
fScale	A scaling factor to apply to the visual effect.
vTranslate	A translation vector transform to apply to the visual effect.
vRotate	A rotation vector transform to apply to the visual effect.

◆ VisualEffect() [2/2]

static Effect Anvil.API.Effect.VisualEffect	(	VisualEffectTableEntry	visualEffect,
		bool	missEffect = false,
		float	fScale = 1::0f,
		System.Numerics.Vector3	vTranslate = default,
		System.Numerics.Vector3	vRotate = default )

inlinestatic

Creates an effect that plays a visual effect when applied.

Parameters

visualEffect	The visual effect to apply.
missEffect	If true, a random vector near or past the target will be generated, as the location for the effect.
fScale	A scaling factor to apply to the visual effect.
vTranslate	A translation vector transform to apply to the visual effect.
vRotate	A rotation vector transform to apply to the visual effect.

The documentation for this class was generated from the following files:

NWN.Anvil/src/main/API/EngineStructures/Effect.Create.cs
NWN.Anvil/src/main/API/EngineStructures/Effect.cs

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Examples

Member Function Documentation

◆ AbilityDecrease()

◆ AbilityIncrease()

◆ ACDecrease()

◆ ACIncrease()

◆ AreaOfEffect()

◆ AttackDecrease()

◆ AttackIncrease()

◆ Beam()

◆ BonusFeat()

◆ Concealment()

◆ Curse()

◆ Damage()

◆ DamageDecrease()

◆ DamageImmunityDecrease()

◆ DamageImmunityIncrease()

◆ DamageIncrease() [1/2]

◆ DamageIncrease() [2/2]

◆ DamageReduction()

◆ DamageResistance()

◆ DamageShield()

◆ Death()

◆ DisappearAppear()

◆ Disease()

◆ DispelMagicAll()

◆ DispelMagicBest()

◆ EnemyAttackBonus()

◆ Heal()

◆ HitPointChangeWhenDying()

◆ Icon()

◆ Immunity()

◆ Invisibility()

◆ LinkEffects()

◆ MissChance()

◆ ModifyAttacks()

◆ MovementSpeedDecrease()

◆ MovementSpeedIncrease()

◆ NegativeLevel()

◆ Paralyze()

◆ Poison()

◆ Polymorph()

◆ Regenerate()

◆ RunAction()

◆ Sanctuary()

◆ SavingThrowDecrease()

◆ SavingThrowIncrease()

◆ SkillDecrease()

◆ SkillDecreaseAll()

◆ SkillIncrease()

◆ SkillIncreaseAll()

◆ SpellFailure()

◆ SpellImmunity()

◆ SpellLevelAbsorption()

◆ SpellResistanceDecrease()

◆ SpellResistanceIncrease()

◆ SummonCreature() [1/2]

◆ SummonCreature() [2/2]

◆ Swarm()

◆ TemporaryHitpoints()

◆ TurnResistanceDecrease()

◆ TurnResistanceIncrease()

◆ VisualEffect() [1/2]

◆ VisualEffect() [2/2]