Open 3D Engine AzToolsFramework 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.
Public Types | Public Member Functions | Static Public Attributes | List of all members
AzToolsFramework::AssetBrowser::AssetBrowserFileCreationNotifications Class Reference

Used for sending and/or recieving notifications regarding events related to files created through the Asset Browser. More...

#include <AssetBrowserBus.h>

Inherits AZ::EBusTraits.

Public Types

using BusIdType = AZ::Crc32
 

Public Member Functions

virtual void HandleAssetCreatedInEditor (const AZStd::string_view, const AZ::Crc32 &, const bool)
 
virtual void HandleInitialFilenameChange (const AZStd::string_view)
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 
static constexpr AZ::Crc32 FileCreationNotificationBusId = AZ::Crc32("AssetBrowserFileCreationNotification")
 

Detailed Description

Used for sending and/or recieving notifications regarding events related to files created through the Asset Browser.

Member Function Documentation

◆ HandleAssetCreatedInEditor()

virtual void AzToolsFramework::AssetBrowser::AssetBrowserFileCreationNotifications::HandleAssetCreatedInEditor ( const AZStd::string_view  ,
const AZ::Crc32 &  ,
const bool   
)
inlinevirtual

Notifies the handler that a new asset was created from the editor so they can handle renaming or other behavior as necessary.

Parameters
assetPathThe full path to the asset that was created.
creatorBusIdThe file creator's bus handler address. A default constructed Crc32 implies no one is listening.
initialFilenameChangeNotifies the handler that this file should give users the option to rename upon creation, set to false if you will use custom naming

◆ HandleInitialFilenameChange()

virtual void AzToolsFramework::AssetBrowser::AssetBrowserFileCreationNotifications::HandleInitialFilenameChange ( const AZStd::string_view  )
inlinevirtual

Notifies a given handler that an asset which was recently created has been given a non-default name.

Parameters
assetPathThe full path to the asset that had its initial name change.

Member Data Documentation

◆ FileCreationNotificationBusId

constexpr AZ::Crc32 AzToolsFramework::AssetBrowser::AssetBrowserFileCreationNotifications::FileCreationNotificationBusId = AZ::Crc32("AssetBrowserFileCreationNotification")
staticconstexpr

The ebus address to use when notifying the Asset Browser component that a new file was created through the Asset Browser. Note that addresses for individual asset creators should be specified in their respective code.

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