Anvil.API.HitEffect Struct Reference

Represents an "On Hit" item property effect, for use with ItemProperty.OnHitEffect. More...

Static Public Member Functions
static HitEffect	AbilityDrain (IPAbility ability)
	Creates a HitEffect property that drains the specified ability score on a successful hit.
static HitEffect	Blindness (IPOnHitDuration duration)
	Creates a HitEffect property that applies a blind effect on a successful hit.
static HitEffect	Confusion (IPOnHitDuration duration)
	Creates a HitEffect property that applies a confusion effect on a successful hit.
static HitEffect	Daze (IPOnHitDuration duration)
	Creates a HitEffect property that applies a daze effect on a successful hit.
static HitEffect	Deafness (IPOnHitDuration duration)
	Creates a HitEffect property that applies a deafness effect on a successful hit.
static HitEffect	Disease (DiseaseType diseaseType)
	Creates a HitEffect property that applies a disease effect on a successful hit.
static HitEffect	DispelMagic ()
	Creates a HitEffect property that dispels magical effects on a successful hit.
static HitEffect	Doom (IPOnHitDuration duration)
	Creates a HitEffect property that applies a doom effect on a successful hit.
static HitEffect	Fear (IPOnHitDuration duration)
	Creates a HitEffect property that applies a fear effect on a successful hit.
static HitEffect	GreaterDispel ()
	Creates a HitEffect property that dispels magical effects on a successful hit.
static HitEffect	Hold (IPOnHitDuration duration)
	Creates a HitEffect property that applies a hold effect on a successful hit.
static HitEffect	ItemPoison (IPPoisonDamage poisonType)
	Creates a HitEffect property that applies a poison effect on a successful hit.
static HitEffect	Knock ()
	Creates a HitEffect property that applies a knock effect on a successful hit.
static HitEffect	LesserDispel ()
	Creates a HitEffect property that dispels magical effects on a successful hit.
static HitEffect	LevelDrain (int levelDrain=1)
	Creates a HitEffect property that applies a level drain effect on a successful hit.
static HitEffect	MordsDisjunction ()
	Creates a HitEffect property that dispels magical effects on a successful hit.
static HitEffect	Silence (IPOnHitDuration duration)
	Creates a HitEffect property that applies a silence effect on a successful hit.
static HitEffect	SlayAlignment (IPAlignment alignment)
	Creates a HitEffect property that instantly kills a creature of the specified alignment on a successful hit.
static HitEffect	SlayAlignmentGroup (IPAlignmentGroup alignmentGroup)
	Creates a HitEffect property that instantly kills a creature of the specified alignment group on a successful hit.
static HitEffect	SlayRace (IPRacialType racialType)
static HitEffect	SlayRace (NwRace race)
	Creates a HitEffect property that instantly kills a creature of the specified race on a successful hit.
static HitEffect	Sleep (IPOnHitDuration duration)
	Creates a HitEffect property that applies a sleep effect on a successful hit.
static HitEffect	Slow (IPOnHitDuration duration)
	Creates a HitEffect property that applies a slow effect on a successful hit.
static HitEffect	Stun (IPOnHitDuration duration)
	Creates a HitEffect property that applies a stun effect on a successful hit.
static HitEffect	Vorpal ()
	Creates a HitEffect property that instantly kills a creature on a critical hit.
static HitEffect	Wounding (int bleedDamage)
	Creates a HitEffect property that applies a bleeding damage over time effect until the creature is healed.

Detailed Description

Represents an "On Hit" item property effect, for use with ItemProperty.OnHitEffect.

Member Function Documentation

AbilityDrain()

static HitEffect Anvil.API.HitEffect.AbilityDrain ( IPAbility ability )

inlinestatic

Creates a HitEffect property that drains the specified ability score on a successful hit.

Parameters

ability

The ability score to drain.

Returns

The created HitEffect.

Blindness()

static HitEffect Anvil.API.HitEffect.Blindness ( IPOnHitDuration duration )

inlinestatic

Creates a HitEffect property that applies a blind effect on a successful hit.

Parameters

duration

The duration of the effect.

Returns

The created HitEffect.

Confusion()

static HitEffect Anvil.API.HitEffect.Confusion ( IPOnHitDuration duration )

inlinestatic

Creates a HitEffect property that applies a confusion effect on a successful hit.

Parameters

duration

The duration of the effect.

Returns

The created HitEffect.

Daze()

static HitEffect Anvil.API.HitEffect.Daze ( IPOnHitDuration duration )

inlinestatic

Creates a HitEffect property that applies a daze effect on a successful hit.

Parameters

duration

The duration of the effect.

Returns

The created HitEffect.

Deafness()

static HitEffect Anvil.API.HitEffect.Deafness ( IPOnHitDuration duration )

inlinestatic

Creates a HitEffect property that applies a deafness effect on a successful hit.

Parameters

duration

The duration of the effect.

Returns

The created HitEffect.

Disease()

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

inlinestatic

Creates a HitEffect property that applies a disease effect on a successful hit.

Parameters

diseaseType

The disease type to apply.

Returns

The created HitEffect.

DispelMagic()

static HitEffect Anvil.API.HitEffect.DispelMagic ( )

inlinestatic

Creates a HitEffect property that dispels magical effects on a successful hit.

Returns

The created HitEffect.

Doom()

static HitEffect Anvil.API.HitEffect.Doom ( IPOnHitDuration duration )

inlinestatic

Creates a HitEffect property that applies a doom effect on a successful hit.

Parameters

duration

The duration of the effect.

Returns

The created HitEffect.

Fear()

static HitEffect Anvil.API.HitEffect.Fear ( IPOnHitDuration duration )

inlinestatic

Creates a HitEffect property that applies a fear effect on a successful hit.

Parameters

duration

The duration of the effect.

Returns

The created HitEffect.

GreaterDispel()

static HitEffect Anvil.API.HitEffect.GreaterDispel ( )

inlinestatic

Creates a HitEffect property that dispels magical effects on a successful hit.

Returns

The created HitEffect.

Hold()

static HitEffect Anvil.API.HitEffect.Hold ( IPOnHitDuration duration )

inlinestatic

Creates a HitEffect property that applies a hold effect on a successful hit.

Parameters

duration

The duration of the effect.

Returns

The created HitEffect.

ItemPoison()

static HitEffect Anvil.API.HitEffect.ItemPoison ( IPPoisonDamage poisonType )

inlinestatic

Creates a HitEffect property that applies a poison effect on a successful hit.

Parameters

poisonType

The poison type to apply.

Returns

The created HitEffect.

Knock()

static HitEffect Anvil.API.HitEffect.Knock ( )

inlinestatic

Creates a HitEffect property that applies a knock effect on a successful hit.

Returns

The created HitEffect.

LesserDispel()

static HitEffect Anvil.API.HitEffect.LesserDispel ( )

inlinestatic

Creates a HitEffect property that dispels magical effects on a successful hit.

Returns

The created HitEffect.

LevelDrain()

static HitEffect Anvil.API.HitEffect.LevelDrain ( int levelDrain = 1 )

inlinestatic

Creates a HitEffect property that applies a level drain effect on a successful hit.

Parameters

levelDrain

The amount of levels to drain per hit.

Returns

The created HitEffect.

MordsDisjunction()

static HitEffect Anvil.API.HitEffect.MordsDisjunction ( )

inlinestatic

Creates a HitEffect property that dispels magical effects on a successful hit.

Returns

The created HitEffect.

Silence()

static HitEffect Anvil.API.HitEffect.Silence ( IPOnHitDuration duration )

inlinestatic

Creates a HitEffect property that applies a silence effect on a successful hit.

Parameters

duration

The duration of the effect.

Returns

The created HitEffect.

SlayAlignment()

static HitEffect Anvil.API.HitEffect.SlayAlignment ( IPAlignment alignment )

inlinestatic

Creates a HitEffect property that instantly kills a creature of the specified alignment on a successful hit.

Parameters

alignment

The alignment that will be slain.

Returns

The created HitEffect.

SlayAlignmentGroup()

static HitEffect Anvil.API.HitEffect.SlayAlignmentGroup ( IPAlignmentGroup alignmentGroup )

inlinestatic

Creates a HitEffect property that instantly kills a creature of the specified alignment group on a successful hit.

Parameters

alignmentGroup

The alignment group that will be slain.

Returns

The created HitEffect.

SlayRace()

static HitEffect Anvil.API.HitEffect.SlayRace ( NwRace race )

inlinestatic

Creates a HitEffect property that instantly kills a creature of the specified race on a successful hit.

Parameters

race	The racial type that will be slain.

Returns

The created HitEffect.

Sleep()

static HitEffect Anvil.API.HitEffect.Sleep ( IPOnHitDuration duration )

inlinestatic

Creates a HitEffect property that applies a sleep effect on a successful hit.

Parameters

duration

The duration of the effect.

Returns

The created HitEffect.

Slow()

static HitEffect Anvil.API.HitEffect.Slow ( IPOnHitDuration duration )

inlinestatic

Creates a HitEffect property that applies a slow effect on a successful hit.

Parameters

duration

The duration of the effect.

Returns

The created HitEffect.

Stun()

static HitEffect Anvil.API.HitEffect.Stun ( IPOnHitDuration duration )

inlinestatic

Creates a HitEffect property that applies a stun effect on a successful hit.

Parameters

duration

The duration of the effect.

Returns

The created HitEffect.

Vorpal()

static HitEffect Anvil.API.HitEffect.Vorpal ( )

inlinestatic

Creates a HitEffect property that instantly kills a creature on a critical hit.

Returns

The created HitEffect.

Wounding()

static HitEffect Anvil.API.HitEffect.Wounding ( int bleedDamage )

inlinestatic

Creates a HitEffect property that applies a bleeding damage over time effect until the creature is healed.

Parameters

bleedDamage

The damage to apply per round.

Returns

The created HitEffect.

---

The documentation for this struct was generated from the following file:

• NWN.Anvil/src/main/API/EngineStructures/HitEffect.cs