Method AreaOfEffect

Namespace

Anvil.API

Assembly

NWN.Anvil.dll

AreaOfEffect(PersistentVfxTableEntry, ScriptCallbackHandle?, ScriptCallbackHandle?, ScriptCallbackHandle?)

Creates an area of effect (AOE) effect.

public static Effect AreaOfEffect(PersistentVfxTableEntry vfxType, ScriptCallbackHandle? onEnterHandle = null, ScriptCallbackHandle? heartbeatHandle = null, ScriptCallbackHandle? onExitHandle = null)

Parameters

vfxType PersistentVfxTableEntry

The persistent area visual effect to use for this effect.

onEnterHandle ScriptCallbackHandle

The callback to invoke when something enters this area of effect.

heartbeatHandle ScriptCallbackHandle

The callback to invoke when something is inside the area of effect during a heartbeat (~6 seconds)

onExitHandle ScriptCallbackHandle

The callback to invoke when something leaves this area of effect.

Returns

Effect