Anvil
Anvil.API.Events.OnDebugPlayVisualEffect Class Reference

Called when a client attempts to spawn a visual effect. More...

+ Inheritance diagram for Anvil.API.Events.OnDebugPlayVisualEffect:
+ Collaboration diagram for Anvil.API.Events.OnDebugPlayVisualEffect:

Properties

TimeSpan Duration [get]
 Gets the duration of the visual effect. More...
 
VisualEffectTableEntryEffect [get]
 Gets the effect that is attempting to be played. More...
 
NwPlayerPlayer [get]
 Gets the player attempting to spawn the visual effect. More...
 
bool Skip [get, set]
 Gets or sets if execution of the script should be skipped. More...
 
NwObjectTargetObject [get]
 Gets the object/area target of the visual effect. More...
 
Vector3 TargetPosition [get]
 Gets the position target of the visual effect. More...
 
- Properties inherited from Anvil.API.Events.IEvent
NwObjectContext [get]
 

Detailed Description

Called when a client attempts to spawn a visual effect.

Property Documentation

◆ Duration

TimeSpan Anvil.API.Events.OnDebugPlayVisualEffect.Duration
get

Gets the duration of the visual effect.

◆ Effect

VisualEffectTableEntry? Anvil.API.Events.OnDebugPlayVisualEffect.Effect
get

Gets the effect that is attempting to be played.

◆ Player

NwPlayer? Anvil.API.Events.OnDebugPlayVisualEffect.Player
get

Gets the player attempting to spawn the visual effect.

◆ Skip

bool Anvil.API.Events.OnDebugPlayVisualEffect.Skip
getset

Gets or sets if execution of the script should be skipped.

◆ TargetObject

NwObject? Anvil.API.Events.OnDebugPlayVisualEffect.TargetObject
get

Gets the object/area target of the visual effect.

◆ TargetPosition

Vector3 Anvil.API.Events.OnDebugPlayVisualEffect.TargetPosition
get

Gets the position target of the visual effect.


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