Method SummonCreature

Namespace

Anvil.API

Assembly

NWN.Anvil.dll

SummonCreature(string, VisualEffectTableEntry, TimeSpan, int, VisualEffectTableEntry?)

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

public static Effect SummonCreature(string creatureResRef, VisualEffectTableEntry summonVfx, TimeSpan delay = default, int appearType = 0, VisualEffectTableEntry? unsummonVfx = null)

Parameters

creatureResRef string

The template/ResRef of the creature to summon.

summonVfx VisualEffectTableEntry

A visual effect to display upon summoning.

delay TimeSpan

A delay between the visual effect, and the creature actually being added to the area.

appearType int

The appear animation to use.

unsummonVfx VisualEffectTableEntry

A visual effect to display when this creature is unsummoned.

Returns

Effect

SummonCreature(NwCreature, VisualEffectTableEntry, VisualEffectTableEntry?)

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

public static Effect SummonCreature(NwCreature summonCreature, VisualEffectTableEntry summonVfx, VisualEffectTableEntry? unsummonVfx = null)

Parameters

summonCreature NwCreature

The creature to be used as the summoned creature. Must not have a current "master" creature.

summonVfx VisualEffectTableEntry

A visual effect to display when claiming the summoned creature.

unsummonVfx VisualEffectTableEntry

A visual effect to play when the summoned creature is unsummoned.

Returns

Effect