UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Verse::IVersePersistence Class Referenceabstract

#include <VVMPersistence.h>

Public Types

using TPersistablePredicateSave = TFunction< bool(const TSharedPtr< FJsonValue > &)>
 
using TPersistablePredicateVM = TFunction< bool(VValue)>
 

Public Member Functions

virtual const TPersistablePredicateVM GetPersistablePredicate () const =0
 
virtual void SetPersistablePredicate (TPersistablePredicateSave)=0
 
virtual void AddPersistentMap (const FString &Path, VPersistentMap &Map)=0
 
virtual void UpdatePersistentPairs (const FUpdatedPersistentPairVM *, const FUpdatedPersistentPairVM *)=0
 
 DECLARE_EVENT_OneParam (IVersePersistence, FOnPersistentMapConstructed, const FString &Path)
 
virtual FOnPersistentMapConstructedOnPersistentMapConstructed ()=0
 
 DECLARE_EVENT_OneParam (IVersePersistence, FOnPersistentPairsUpdated, const TArray< FUpdatedPersistentPairSave > &)
 
virtual FOnPersistentPairsUpdatedOnPersistentPairsUpdated ()=0
 
 DECLARE_EVENT (IVersePersistence, FOnPersistentMapsReleased)
 
virtual FOnPersistentMapsReleasedOnPersistentMapsReleased ()=0
 
 DECLARE_EVENT_OneParam (IVersePersistence, FOnPersistentMapKeyAdded, void *)
 
virtual FOnPersistentMapKeyAddedOnPersistentMapKeyAdded ()=0
 
 DECLARE_EVENT_OneParam (IVersePersistence, FOnPersistentMapKeyRemoved, void *)
 
virtual FOnPersistentMapKeyRemovedOnPersistentMapKeyRemoved ()=0
 
virtual void AddPersistentPair (const FString &Path, const void *Key, const TSharedRef< const FJsonValue > &Value)=0
 
virtual void AddPersistentPair (const FString &Path, const void *Key, VValue Value)=0
 
virtual void RemovePersistentPairs (const void *Key)=0
 
virtual void ResetWeakMaps ()=0
 

Protected Member Functions

virtual ~IVersePersistence ()=default
 

Member Typedef Documentation

◆ TPersistablePredicateSave

◆ TPersistablePredicateVM

Constructor & Destructor Documentation

◆ ~IVersePersistence()

virtual Verse::IVersePersistence::~IVersePersistence ( )
protectedvirtualdefault

Member Function Documentation

◆ AddPersistentMap()

virtual void Verse::IVersePersistence::AddPersistentMap ( const FString &  Path,
VPersistentMap Map 
)
pure virtual

Notify of the construction of a persistent var weak_map

◆ AddPersistentPair() [1/2]

virtual void Verse::IVersePersistence::AddPersistentPair ( const FString &  Path,
const void Key,
const TSharedRef< const FJsonValue > &  Value 
)
pure virtual

Add key and value to a persistent var weak_map with Verse path Path

◆ AddPersistentPair() [2/2]

virtual void Verse::IVersePersistence::AddPersistentPair ( const FString &  Path,
const void Key,
VValue  Value 
)
pure virtual

Add key and value to a persistent var weak_map with Verse path Path

◆ DECLARE_EVENT()

Verse::IVersePersistence::DECLARE_EVENT ( IVersePersistence  ,
FOnPersistentMapsReleased   
)

◆ DECLARE_EVENT_OneParam() [1/4]

Verse::IVersePersistence::DECLARE_EVENT_OneParam ( IVersePersistence  ,
FOnPersistentMapConstructed  ,
const FString &  Path 
)

Event indicating when a persistent var is constructed (correlating directly with a call to AddPersistentMap)

◆ DECLARE_EVENT_OneParam() [2/4]

Verse::IVersePersistence::DECLARE_EVENT_OneParam ( IVersePersistence  ,
FOnPersistentMapKeyAdded  ,
void  
)

Persistent map key added event, triggered when a persistent map key is added to Verse

Parameters
Keythe new key that was added

◆ DECLARE_EVENT_OneParam() [3/4]

Verse::IVersePersistence::DECLARE_EVENT_OneParam ( IVersePersistence  ,
FOnPersistentMapKeyRemoved  ,
void  
)

Persistent map key removed event, triggered when a persistent map key is removed from Verse

Parameters
Keythe key that was removed

◆ DECLARE_EVENT_OneParam() [4/4]

Verse::IVersePersistence::DECLARE_EVENT_OneParam ( IVersePersistence  ,
FOnPersistentPairsUpdated  ,
const TArray< FUpdatedPersistentPairSave > &   
)

◆ GetPersistablePredicate()

virtual const TPersistablePredicateVM Verse::IVersePersistence::GetPersistablePredicate ( ) const
pure virtual

Get the predicate used for FitsInPlayerMap intrinsic

◆ OnPersistentMapConstructed()

virtual FOnPersistentMapConstructed & Verse::IVersePersistence::OnPersistentMapConstructed ( )
pure virtual

◆ OnPersistentMapKeyAdded()

virtual FOnPersistentMapKeyAdded & Verse::IVersePersistence::OnPersistentMapKeyAdded ( )
pure virtual

◆ OnPersistentMapKeyRemoved()

virtual FOnPersistentMapKeyRemoved & Verse::IVersePersistence::OnPersistentMapKeyRemoved ( )
pure virtual

◆ OnPersistentMapsReleased()

virtual FOnPersistentMapsReleased & Verse::IVersePersistence::OnPersistentMapsReleased ( )
pure virtual

◆ OnPersistentPairsUpdated()

virtual FOnPersistentPairsUpdated & Verse::IVersePersistence::OnPersistentPairsUpdated ( )
pure virtual

◆ RemovePersistentPairs()

virtual void Verse::IVersePersistence::RemovePersistentPairs ( const void Key)
pure virtual

Remove key from all persistent var weak_maps

◆ ResetWeakMaps()

virtual void Verse::IVersePersistence::ResetWeakMaps ( )
pure virtual

Reset persistence by reinitialization all vars to a default-constructed value

Note
this assumes the var started out with a default-constructed value

◆ SetPersistablePredicate()

virtual void Verse::IVersePersistence::SetPersistablePredicate ( TPersistablePredicateSave  )
pure virtual

Set the predicate used for FitsInPlayerMap intrinsic

◆ UpdatePersistentPairs()

virtual void Verse::IVersePersistence::UpdatePersistentPairs ( const FUpdatedPersistentPairVM ,
const FUpdatedPersistentPairVM  
)
pure virtual

Update a set of key-value pairs in a persistent var weak_map


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