Method VisualEffect

Namespace

Anvil.API

Assembly

NWN.Anvil.dll

VisualEffect(VfxType, bool, float, Vector3, Vector3)

Creates an effect that plays a visual effect when applied.

public static Effect VisualEffect(VfxType visualEffectId, bool missEffect = false, float fScale = 1, Vector3 vTranslate = default, Vector3 vRotate = default)

Parameters

visualEffectId VfxType

The visual effect to apply.

missEffect bool

If true, a random vector near or past the target will be generated, as the location for the effect.

fScale float

A scaling factor to apply to the visual effect.

vTranslate Vector3

A translation vector transform to apply to the visual effect.

vRotate Vector3

A rotation vector transform to apply to the visual effect.

Returns

Effect

VisualEffect(VisualEffectTableEntry, bool, float, Vector3, Vector3)

Creates an effect that plays a visual effect when applied.

public static Effect VisualEffect(VisualEffectTableEntry visualEffect, bool missEffect = false, float fScale = 1, Vector3 vTranslate = default, Vector3 vRotate = default)

Parameters

visualEffect VisualEffectTableEntry

The visual effect to apply.

missEffect bool

If true, a random vector near or past the target will be generated, as the location for the effect.

fScale float

A scaling factor to apply to the visual effect.

vTranslate Vector3

A translation vector transform to apply to the visual effect.

vRotate Vector3

A rotation vector transform to apply to the visual effect.

Returns

Effect