Interface IAuraAccessor
Represents an accessor for an aura, encapsulating the ability to interact with and manipulate various properties and collections associated with the aura. Provides access to the aura's identifiers, state, and actions, as well as its hierarchical structure through overlays and triggers.
Inherited Members
Namespace: EyeAuras.Scripting.Api
Assembly: EyeAuras.Scripting.dll
Syntax
public interface IAuraAccessor : IHasId, IHasTypedId<string>, ICanBeLoaded, IHasLoaded, ICanBeArchived, IHasTimestamp, IHasVariables, IDisposable, INotifyPropertyChanged, ICanSetVariables, IHasPath, IHasNameProperties
| Name | Description |
|---|---|
| EnablingConditions | Gets a list of triggers that serve as conditions required for this aura to become active. |
| IsActive | Gets a value indicating whether the aura is currently active. |
| IsEnabled | Gets a value indicating whether this aura is enabled and available for selection or editing. |
| OnEnterActions | Gets a list of actions that are executed when the aura is first activated. |
| OnExitActions | Gets a list of actions that are executed when the aura is deactivated. |
| Overlays | Gets a list of overlays associated with this aura, providing additional contextual or visual enhancements. |
| Triggers | Gets a list of triggers associated with this aura, defining interactions or conditions monitored during the aura's lifecycle. |
| WhileActiveActions | Gets a list of actions that are executed repeatedly while the aura is active. |
Methods
| Name | Description |
|---|---|
| Execute(CancellationToken) | Executes all actions in that aura in the following order: OnEnter -> WhileActive -> OnExit It does not matter whether the aura has changed its state or not - all actions will be executed anyways, if not cancelled |
| ExecuteAsync(CancellationToken) | Executes all actions in that aura in the following order: OnEnter -> WhileActive -> OnExit It does not matter whether the aura has changed it's state or not - all actions will be executed anyways, if not cancelled |