Open 3D Engine ScriptCanvas Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
ScriptCanvasBuilder::DataSystem Class Referencefinal

Provides simplified access to status and compiled data for ScriptCanvas source files. More...

#include <ScriptCanvasBuilderDataSystem.h>

Inherits AZ::Data::AssetBus::MultiHandler, AzFramework::AssetCatalogEventBus::Handler, AzFramework::AssetSystemInfoBus::Handler, AzToolsFramework::AssetSystemBus::Handler, DataSystemSourceRequestsBus::Handler, and DataSystemAssetRequestsBus::Handler.

Public Member Functions

 AZ_TYPE_INFO (DataSystem, "{27B74209-319D-4A8C-B37D-F85EFA6D2FFA}")
 
 AZ_CLASS_ALLOCATOR (DataSystem, AZ::SystemAllocator)
 
BuilderSourceResult CompileBuilderData (SourceHandle sourceHandle) override
 Returns the latest built editor properties for the source file.
 
BuilderAssetResult LoadAsset (SourceHandle sourceHandle) override
 Returns the latest built runtime data for the source file.
 

Detailed Description

Provides simplified access to status and compiled data for ScriptCanvas source files.

This class handles both DataSystemAssetRequestsBus and DataSystemSourceRequestsBus. It listens to AP notifications and the tools framework notifications for ScriptCanvas source file changes. It stores the results of processing a source file for both editor-configurable properties and for runtime ready assets for faster retrieval when many are being simultaneously processed. For example, this occurs during prefab compilation time, when multiple ScriptCanvasEditorComponents require builder data for their configuration loaded from latest source file on disk. This system reduces file I/O and compilation work by maintaining and providing access to the very latest results.

Member Function Documentation

◆ CompileBuilderData()

BuilderSourceResult ScriptCanvasBuilder::DataSystem::CompileBuilderData ( SourceHandle  sourceHandle)
override

Returns the latest built editor properties for the source file.

Parameters
sourceHandle
Returns
BuilderSourceResult editor properties status and data

◆ LoadAsset()

BuilderAssetResult ScriptCanvasBuilder::DataSystem::LoadAsset ( SourceHandle  sourceHandle)
override

Returns the latest built runtime data for the source file.

Parameters
sourceHandle
Returns
BuilderAssetResult runtime status and data

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