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

#include <ARSharedWorldGameMode.h>

+ Inheritance diagram for AARSharedWorldGameMode:

Public Member Functions

UE_API void SetPreviewImageData (TArray< uint8 > ImageData)
 
UE_API void SetARSharedWorldData (TArray< uint8 > ARWorldData)
 
UE_API void SetARWorldSharingIsReady ()
 
UE_API AARSharedWorldGameState * GetARSharedWorldGameState ()
 
- Public Member Functions inherited from AGameMode
virtual ENGINE_API FString GetNetworkNumber ()
 
ENGINE_API void PlayerSwitchedToSpectatorOnly (APlayerController *PC)
 
ENGINE_API void RemovePlayerControllerFromPlayerCount (APlayerController *PC)
 
virtual ENGINE_API bool GetTravelType ()
 
virtual ENGINE_API void Say (const FString &Msg)
 
virtual ENGINE_API void Broadcast (AActor *Sender, const FString &Msg, FName Type=NAME_None)
 
virtual ENGINE_API void BroadcastLocalized (AActor *Sender, TSubclassOf< ULocalMessage > Message, int32 Switch=0, APlayerState *RelatedPlayerState_1=NULL, APlayerState *RelatedPlayerState_2=NULL, UObject *OptionalObject=NULL)
 
virtual ENGINE_API void AddInactivePlayer (APlayerState *PlayerState, APlayerController *PC)
 
virtual ENGINE_API bool FindInactivePlayer (APlayerController *PC)
 
virtual ENGINE_API void OverridePlayerState (APlayerController *PC, APlayerState *OldPlayerState)
 
virtual ENGINE_API void SetSeamlessTravelViewTarget (APlayerController *PC)
 
virtual ENGINE_API void PreCommitMapChange (const FString &PreviousMapName, const FString &NextMapName)
 
virtual ENGINE_API void PostCommitMapChange ()
 
virtual ENGINE_API void NotifyPendingConnectionLost (const FUniqueNetIdRepl &ConnectionUniqueId)
 
virtual ENGINE_API void HandleDisconnect (UWorld *InWorld, UNetDriver *NetDriver)
 
virtual ENGINE_API void InitGame (const FString &MapName, const FString &Options, FString &ErrorMessage) override
 
virtual ENGINE_API void StartPlay () override
 
virtual ENGINE_API bool HasMatchStarted () const override
 
virtual ENGINE_API bool HasMatchEnded () const override
 
virtual ENGINE_API void PostLogin (APlayerController *NewPlayer) override
 
virtual ENGINE_API int32 GetNumPlayers () override
 
virtual ENGINE_API int32 GetNumSpectators () override
 
virtual ENGINE_API bool IsHandlingReplays () override
 
virtual ENGINE_API void HandleStartingNewPlayer_Implementation (APlayerController *NewPlayer) override
 
virtual ENGINE_API bool PlayerCanRestart_Implementation (APlayerController *Player) override
 
virtual ENGINE_API void PostSeamlessTravel () override
 
virtual ENGINE_API void HandleSeamlessTravelPlayer (AController *&C) override
 
virtual ENGINE_API void InitSeamlessTravelPlayer (AController *NewController) override
 
virtual ENGINE_API bool CanServerTravel (const FString &URL, bool bAbsolute) override
 
virtual ENGINE_API void StartToLeaveMap () override
 
virtual ENGINE_API bool SpawnPlayerFromSimulate (const FVector &NewLocation, const FRotator &NewRotation) override
 

Public Attributes

int32 BufferSizePerChunk
 
- Public Attributes inherited from AGameMode
uint32 bDelayedStart: 1
 
int32 NumSpectators
 
int32 NumPlayers
 
int32 NumBots
 
float MinRespawnDelay
 
int32 NumTravellingPlayers
 
TSubclassOf< class ULocalMessage > EngineMessageClass
 
TArray< TObjectPtr< class APlayerState > > InactivePlayerArray
 

Additional Inherited Members

- Protected Member Functions inherited from AGameMode
virtual ENGINE_API void SetMatchState (FName NewState)
 
virtual ENGINE_API void OnMatchStateSet ()
 
ENGINE_API void K2_OnSetMatchState (FName NewState)
 
virtual ENGINE_API void HandleMatchIsWaitingToStart ()
 
ENGINE_API bool ReadyToStartMatch ()
 
virtual ENGINE_API void HandleMatchHasStarted ()
 
ENGINE_API bool ReadyToEndMatch ()
 
virtual ENGINE_API void HandleMatchHasEnded ()
 
virtual ENGINE_API void HandleLeavingMap ()
 
virtual ENGINE_API void HandleMatchAborted ()
 
- Protected Attributes inherited from AGameMode
FName MatchState
 
float InactivePlayerStateLifeSpan
 
int32 MaxInactivePlayers
 
bool bHandleDedicatedServerReplays
 

Member Function Documentation

◆ GetARSharedWorldGameState()

AARSharedWorldGameState * AARSharedWorldGameMode::GetARSharedWorldGameState ( )
Returns
the game state for this game mode

◆ SetARSharedWorldData()

void AARSharedWorldGameMode::SetARSharedWorldData ( TArray< uint8 >  ARWorldData)

Sets the image data for the shared world game session

Parameters
ARWorldDatathe blob to use as the AR world data

◆ SetARWorldSharingIsReady()

void AARSharedWorldGameMode::SetARWorldSharingIsReady ( )

Tells the game mode that the AR data is ready and should be replicated to all connected clients

◆ SetPreviewImageData()

void AARSharedWorldGameMode::SetPreviewImageData ( TArray< uint8 >  ImageData)

Sets the image data for the shared world game session

Parameters
ImageDatathe blob to use as the image data

Member Data Documentation

◆ BufferSizePerChunk

int32 AARSharedWorldGameMode::BufferSizePerChunk

The size of the buffer to use per send request. Must be between 1 and 65535, though should not be max to avoid saturation

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