Anvil.API.MonsterHitEffect Struct Reference

Represents a monster "On Hit" item property effect, for use with ItemProperty.OnMonsterHitProperties. More...

Static Public Member Functions
static MonsterHitEffect	AbilityDrain (IPAbility ability)
	Creates a MonsterHitEffect property that drains the specified ability score on a successful hit. More...
static MonsterHitEffect	Confusion (IPOnHitDuration duration)
	Creates a MonsterHitEffect property that applies a confusion effect on a successful hit. More...
static MonsterHitEffect	Disease (DiseaseType diseaseType)
	Creates a MonsterHitEffect property that applies a disease effect on a successful hit. More...
static MonsterHitEffect	Doom (IPOnHitDuration duration)
	Creates a MonsterHitEffect property that applies a doom effect on a successful hit. More...
static MonsterHitEffect	Fear (IPOnHitDuration duration)
	Creates a MonsterHitEffect property that applies a fear effect on a successful hit. More...
static MonsterHitEffect	LevelDrain (int levelDrain=1)
	Creates a MonsterHitEffect property that applies a level drain effect on a successful hit. More...
static MonsterHitEffect	Poison (PoisonType poisonType)
	Creates a MonsterHitEffect property that applies a poison effect on a successful hit. More...
static MonsterHitEffect	Slow (IPOnHitDuration duration)
	Creates a MonsterHitEffect property that applies a slow effect on a successful hit. More...
static MonsterHitEffect	Stun (IPOnHitDuration duration)
	Creates a MonsterHitEffect property that applies a stun effect on a successful hit. More...
static MonsterHitEffect	Wounding (int bleedDamage)
	Creates a MonsterHitEffect property that applies a bleeding damage over time effect until the creature is healed. More...

Detailed Description

Represents a monster "On Hit" item property effect, for use with ItemProperty.OnMonsterHitProperties.

Member Function Documentation

AbilityDrain()

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

inlinestatic

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

Parameters

ability

The ability score to drain.

Returns

The created HitEffect.

Confusion()

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

inlinestatic

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

Parameters

duration

The duration of the effect.

Returns

The created HitEffect.

Disease()

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

inlinestatic

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

Parameters

diseaseType

The disease type to apply.

Returns

The created HitEffect.

Doom()

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

inlinestatic

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

Parameters

duration

The duration of the effect.

Returns

The created HitEffect.

Fear()

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

inlinestatic

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

Parameters

duration

The duration of the effect.

Returns

The created HitEffect.

LevelDrain()

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

inlinestatic

Creates a MonsterHitEffect 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.

Poison()

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

inlinestatic

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

Parameters

poisonType

The poison type to apply.

Returns

The created HitEffect.

Slow()

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

inlinestatic

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

Parameters

duration

The duration of the effect.

Returns

The created HitEffect.

Stun()

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

inlinestatic

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

Parameters

duration

The duration of the effect.

Returns

The created HitEffect.

Wounding()

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

inlinestatic

Creates a MonsterHitEffect 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/MonsterHitEffect.cs