Interface IAuraTreeScriptingApi

Provides methods for interacting with the aura tree, including finding and retrieving auras, folders, and behavior trees. It supports operations to both safely find elements (returning null if not found) and directly retrieve elements (throwing exceptions if not found), accommodating scenarios that require precise control over error handling. The interface enables accessing collections of all managed auras, folders, and behavior trees, as well as fetching specific triggers and actions associated with auras by path. This facilitates dynamic and scriptable interactions with the application's hierarchical structure, ideal for scenarios requiring runtime navigation and manipulation of the aura tree.

Inherited Members

IScriptingApi.Name

IDisposable.Dispose()

Namespace: EyeAuras.Scripting.Api

Assembly: EyeAuras.Scripting.dll

Syntax

public interface IAuraTreeScriptingApi : IScriptingApi, IDisposable

Properties

Name	Description
Aura	Contains reference to the Aura (or null) which holds the current script.
Auras	Contains all auras in the Aura Tree.
BehaviorTrees	Contains all behavior trees in the Aura Tree.
Folder	Contains reference to the Folder which holds the current script.
Folders	Contains all folders in the Aura Tree.
Macros	Contains all macros in the Aura Tree.

Methods

Name	Description
FindAuraByPath(string)	Finds an aura by its path. Returns null if not found.
FindBehaviorTreeByPath(string)	Finds a behavior tree by its path. Returns null if not found.
FindFolderByPath(string)	Finds a folder by its path. Returns null if not found.
FindMacroByPath(string)	Finds a macro by its path. Returns null if not found.
GetActionByPath<TAction>(string)
GetAuraByPath(string)	Gets an aura by its path. Throws an exception if not found.
GetBehaviorTreeByPath(string)	Gets a behavior tree by its path. Throws an exception if not found.
GetFolderByPath(string)	Gets a folder by its path. Throws an exception if not found.
GetMacroByPath(string)	Gets a macro by its path. Throws an exception if not found.
GetTriggerByPath<TTrigger>(string)