|
Open 3D Engine ScriptCanvas Gem API Reference
24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
|
|
Open 3D Engine ScriptCanvas Gem API Reference
24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
|
Configuration provides user-facing facilities for selecting a ScriptCanvas source file, monitoring its status, and exposing its properties for configuration if possible. More...
#include <Configuration.h>
Inherits AzFramework::AssetCatalogEventBus::Handler, and ScriptCanvasBuilder::DataSystemSourceNotificationsBus::Handler.
Public Member Functions | |
| AZ_TYPE_INFO (Configuration, "{0F4D78A9-EF29-4D6A-AC5B-8F4E19B1A6EE}") | |
| Configuration (const SourceHandle &sourceHandle) | |
| const ScriptCanvasBuilder::BuildVariableOverrides * | CompileLatest () |
| AZ::EventHandler< const Configuration & > | ConnectToPropertiesChanged (AZStd::function< void(const Configuration &)> &&function) const |
| Will signal when the properties have been modified by the user, or when the source file has been changed. | |
| AZ::EventHandler< const Configuration & > | ConnectToSourceCompiled (AZStd::function< void(const Configuration &)> &&function) const |
| Will signal when the selected source file has been successfully compiled. | |
| AZ::EventHandler< const Configuration & > | ConnectToSourceFailed (AZStd::function< void(const Configuration &)> &&function) const |
| Will signal when the selected source file has failed to compile for any reason. | |
| const ScriptCanvasBuilder::BuildVariableOverrides & | GetOverrides () const |
| Returns the user editable properties of the selected source. The properties could be empty. | |
| const SourceHandle & | GetSource () const |
| bool | HasSource () const |
| void | Refresh () |
| Provides a manual call to Refresh() with currently selected source file. | |
| void | Refresh (const SourceHandle &sourceHandle) |
| Sets the selected file to the input sourceHandle, compiles latest, and sends all signals. | |
| bool | AcceptsComponentScript () const |
| void | SetAcceptsComponentScript (bool value) |
| AZ::EventHandler< const Configuration & > | ConnectToIncompatilbleScript (AZStd::function< void(const Configuration &)> &&function) const |
Static Public Member Functions | |
| static void | Reflect (AZ::ReflectContext *context) |
Friends | |
| class | AZ::EditorScriptCanvasComponentSerializer |
| class | Deprecated::EditorScriptCanvasComponentVersionConverter |
Configuration provides user-facing facilities for selecting a ScriptCanvas source file, monitoring its status, and exposing its properties for configuration if possible.
| void ScriptCanvasEditor::Configuration::SetAcceptsComponentScript | ( | bool | value | ) |
Some Scripts refer the 'self Entity Id', part of the Entity / Component extension of current ScriptCanvas scripting system. This allows programmers to enable or disable using such a script with this Configuration.
1.9.1