Interface IAuraTreeUnstableScriptingApi
Provides an unstable API for scripting interactions with aura trees. This API is subject to change and operates within a specific aura and folder context that may evolve over the API's lifecycle.
Namespace: EyeAuras.Scripting.Api
Assembly: EyeAuras.Scripting.dll
Syntax
public interface IAuraTreeUnstableScriptingApi : IScriptingApi, IDisposable
Properties
Name | Description |
---|---|
Aura | Gets the current aura context in which the API is operating. This context may change throughout the API lifecycle. |
Auras | Gets a list of all auras managed by the application. |
BehaviorTrees | Gets a list of all behavior trees managed by the application. |
Folder | Gets the folder associated with the current aura context in which the API is operating. This context may change throughout the API lifecycle. |
Folders | Gets a list of all folders managed by the application. |
Methods
Name | Description |
---|---|
FindActionById(string) | Finds an aura action by its globally unique identifier. |
FindAuraById(string) | Finds an aura by its globally unique identifier. |
FindAuraByPath(string) | Finds an aura by its path, which can be specified as either an absolute path (e.g., "MyFolder/Aura1") or a relative path (e.g., "./Aura1" to find Aura1 in the same directory as the script using this API). |
FindBehaviorTreeByPath(string) | Finds a behavior tree by its path, which can be specified as either an absolute path (e.g., "MyProject/BehaviorTrees/Tree1") or a relative path (e.g., "./Tree1" to find Tree1 in the same directory as the script using this API). |
FindFolderByPath(string) | Finds a folder by its path, which can be specified as either an absolute path (e.g., "MyProject/Folders/Folder1") or a relative path (e.g., "./Folder1" to find Folder1 in the same directory as the script using this API). |
FindItemByPath(string) | Finds an item by its path, which can be specified as either an absolute path (e.g., "MyFolder/Aura1") or a relative path (e.g., "./Aura1" to find Aura1 in the same directory as the script using this API). |
FindModelById<TAuraModel>(string) | Finds a model of the specified type by its globally unique identifier. |
FindOverlayById(string) | Finds an aura overlay by its globally unique identifier. |
FindTriggerById(string) | Finds an aura trigger by its globally unique identifier. |