Open 3D Engine SaveData 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.
Public Types | Public Attributes | List of all members
SaveData::SaveDataRequests::SaveOrLoadObjectParams< SerializableType > Struct Template Reference

#include <SaveDataRequestBus.h>

Public Types

using OnObjectSavedOrLoaded = AZStd::function< void(const SaveOrLoadObjectParams &, SaveDataNotifications::Result)>
 Alias for verbose callback function type.
 

Public Attributes

AZStd::shared_ptr< SerializableType > serializableObject
 A shared ptr to the serializable object to save or load.
 
AZ::SerializeContext * serializeContext = nullptr
 The serialize context to use when serializing the object, use nullptr for global one.
 
AZStd::string dataBufferName
 
AzFramework::LocalUserId localUserId = AzFramework::LocalUserIdNone
 The local user id the data buffer to be saved or loaded is associated with.
 
OnObjectSavedOrLoaded callback = nullptr
 Callback function to invoke on the main thread once the object has saved or loaded.
 

Detailed Description

template<typename SerializableType>
struct SaveData::SaveDataRequests::SaveOrLoadObjectParams< SerializableType >

The parameters used to send a save or load serializable object request.

Template Parameters
SerializableTypeThe type of serializable object to save or load.

Member Data Documentation

◆ dataBufferName

template<typename SerializableType >
AZStd::string SaveData::SaveDataRequests::SaveOrLoadObjectParams< SerializableType >::dataBufferName

The name of the data buffer to be saved or loaded. Is a filename on most platforms, but will always uniquely identify the data buffer for the associated local user.

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