UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
AARSharedWorldGameState Class Reference

#include <ARSharedWorldGameState.h>

+ Inheritance diagram for AARSharedWorldGameState:

Public Member Functions

UE_API void InitSharedWorld (int32 PreviewImageSize, int32 ARWorldDataSize)
 
UE_API void UpdatePreviewImageData (int32 Offset, const uint8 *Buffer, int32 Size)
 
UE_API void UpdateARWorldData (int32 Offset, const uint8 *Buffer, int32 Size)
 
UE_API void K2_OnARWorldMapIsReady ()
 
- Public Member Functions inherited from AGameState
virtual ENGINE_API void OnRep_MatchState ()
 
virtual ENGINE_API void OnRep_ElapsedTime ()
 
virtual ENGINE_API void DefaultTimer ()
 
virtual ENGINE_API void PostInitializeComponents () override
 
virtual ENGINE_API void ReceivedGameModeClass () override
 
virtual ENGINE_API bool HasMatchStarted () const override
 
virtual ENGINE_API bool HasMatchEnded () const override
 
virtual ENGINE_API void HandleBeginPlay () override
 
virtual ENGINE_API float GetPlayerStartTime (class AController *Controller) const override
 
virtual ENGINE_API float GetPlayerRespawnDelay (class AController *Controller) const override
 
- Public Member Functions inherited from AGameStateBase
virtual void AsyncPackageLoaded (UObject *Package)
 
ENGINE_API const AGameModeBase * GetDefaultGameMode () const
 
template<class T >
const T * GetDefaultGameMode () const
 
virtual ENGINE_API double GetServerWorldTimeSeconds () const
 
virtual ENGINE_API bool HasBegunPlay () const
 
virtual ENGINE_API void GetLifetimeReplicatedProps (TArray< FLifetimeProperty > &OutLifetimeProps) const
 
ENGINE_API APlayerState * GetPlayerStateFromUniqueNetId (const FUniqueNetIdWrapper &InPlayerId) const
 
virtual ENGINE_API void ReceivedSpectatorClass ()
 
virtual ENGINE_API void SeamlessTravelTransitionCheckpoint (bool bToTransitionMap)
 
virtual ENGINE_API void AddPlayerState (APlayerState *PlayerState)
 
virtual ENGINE_API void RemovePlayerState (APlayerState *PlayerState)
 

Public Attributes

TArray< uint8 > PreviewImageData
 
TArray< uint8 > ARWorldData
 
int32 PreviewImageBytesTotal
 
int32 ARWorldBytesTotal
 
int32 PreviewImageBytesDelivered
 
int32 ARWorldBytesDelivered
 
- Public Attributes inherited from AGameState
int32 ElapsedTime
 
- Public Attributes inherited from AGameStateBase
TSubclassOf< AGameModeBase > GameModeClass
 
TObjectPtr< AGameModeBase > AuthorityGameMode
 
TSubclassOf< ASpectatorPawn > SpectatorClass
 
TArray< TObjectPtr< APlayerState > > PlayerArray
 

Additional Inherited Members

- Protected Member Functions inherited from AGameState
virtual ENGINE_API void HandleMatchIsWaitingToStart ()
 
virtual ENGINE_API void HandleMatchHasStarted ()
 
virtual ENGINE_API void HandleMatchHasEnded ()
 
virtual ENGINE_API void HandleLeavingMap ()
 
- Protected Member Functions inherited from AGameStateBase
virtual ENGINE_API void OnRep_GameModeClass ()
 
virtual ENGINE_API void OnRep_SpectatorClass ()
 
virtual ENGINE_API void OnRep_ReplicatedHasBegunPlay ()
 
virtual ENGINE_API void UpdateServerTimeSeconds ()
 
virtual ENGINE_API void OnRep_ReplicatedWorldTimeSecondsDouble ()
 
- Protected Attributes inherited from AGameState
FName MatchState
 
FName PreviousMatchState
 
FTimerHandle TimerHandle_DefaultTimer
 
- Protected Attributes inherited from AGameStateBase
bool bReplicatedHasBegunPlay
 
double ReplicatedWorldTimeSecondsDouble
 
float ServerWorldTimeSecondsDelta
 
float ServerWorldTimeSecondsUpdateFrequency
 
FTimerHandle TimerHandle_UpdateServerTimeSeconds
 
double SumServerWorldTimeSecondsDelta
 
uint32 NumServerWorldTimeSecondsDeltas
 

Member Function Documentation

◆ InitSharedWorld()

void AARSharedWorldGameState::InitSharedWorld ( int32  PreviewImageSize,
int32  ARWorldDataSize 
)

Used to setup the initial values and size the arrays (client)

Parameters
PreviewImageSizethe total size in bytes of the image data that will be sent
ARWorldDataSizethe total size in bytes of the AR world data that will be sent

◆ K2_OnARWorldMapIsReady()

UE_API void AARSharedWorldGameState::K2_OnARWorldMapIsReady ( )

◆ UpdateARWorldData()

void AARSharedWorldGameState::UpdateARWorldData ( int32  Offset,
const uint8 *  Buffer,
int32  Size 
)

Copies the buffer into the AR world data (client)

Parameters
Offsetwhere in the buffer to start the copying
Bufferthe chunk of data to copy
BufferSizethe amount of data to copy

◆ UpdatePreviewImageData()

void AARSharedWorldGameState::UpdatePreviewImageData ( int32  Offset,
const uint8 *  Buffer,
int32  Size 
)

Copies the buffer into the image data (client)

Parameters
Offsetwhere in the buffer to start the copying
Bufferthe chunk of data to copy
BufferSizethe amount of data to copy

Member Data Documentation

◆ ARWorldBytesDelivered

int32 AARSharedWorldGameState::ARWorldBytesDelivered

The amount of the AR world data that has been replicated to this client so far

◆ ARWorldBytesTotal

int32 AARSharedWorldGameState::ARWorldBytesTotal

The size of the AR world data that will be replicated to each client

◆ ARWorldData

TArray<uint8> AARSharedWorldGameState::ARWorldData

Each client and the host have a copy of the shared world data

◆ PreviewImageBytesDelivered

int32 AARSharedWorldGameState::PreviewImageBytesDelivered

The amount of the preview image data that has been replicated to this client so far

◆ PreviewImageBytesTotal

int32 AARSharedWorldGameState::PreviewImageBytesTotal

The size of the image that will be replicated to each client

◆ PreviewImageData

TArray<uint8> AARSharedWorldGameState::PreviewImageData

Each client and the host have a copy of the shared world data The image taken at the time of world saving for use when aligning the AR world later in the session

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