URejoinCheck

Class responsible for maintaining the status/availability of a session already in progress for a client to join

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Rejoin

Header

/Engine/Plugins/Online/OnlineFramework/Source/Rejoin/Public/RejoinCheck.h

Include

#include "RejoinCheck.h"

Syntax

UCLASS(Abstract)
class URejoinCheck : public UObject

Remarks

Class responsible for maintaining the status/availability of a session already in progress for a client to join

Variables

Name Description

Protected variable UProperty

ERejoinStatus

 

LastKnownStatus

Rejoin status

Constructors

Name Description

Public function

URejoinCheck()

Functions

Name Description

Public function Virtual

void

 

CheckRejoinStatus

(
    const FOnRejoinCheckComplete& Comp...
)

Check the backend for the existence of game session that the local player is registered with It will continue to return a valid value until that session is complete

Protected function

void

 

ClearTimers()

Clear all timers associated with rejoin

Protected function Const

T *

 

GetGameInstance()

Protected function Const

const FOnlin...

 

GetSearchResult()

Helpers

Public function Const

ERejoinStatu...

 

GetStatus()

Get the current state in the rejoin check flow. Dev mode may return CVarDebugRejoin if it was set

Protected function Const

UWorld *

 

GetWorld()

Public function Const

bool

 

HasCompletedCheck()

Protected function Const

bool

 

IsAttemptingRejoin()

Public function Const

bool

 

IsRejoinAvailable()

Public function Virtual Const

bool

 

IsRejoinCheckEnabled()

Public function

FOnRejoinChe...

 

OnRejoinCheckStatusChanged()

Access to the multicast delegate fired when a rejoin check status update is given

Protected function Virtual

void

 

OnRejoinFailure

(
    ERejoinAttemptResult Result
)

Called any time there is a failure to complete the attempted rejoin

Public function

void

 

RejoinLastSession

(
    const FOnRejoinLastSessionComplete ...
)

Rejoin the last session if one is found.

Public function Virtual

void

 

Reset()

Reset the rejoin state.

Public function

void

 

SetStatus

(
    ERejoinStatus NewStatus
)

Manually set the status of rejoins.

Protected function

void

 

TravelToSession()

Use the search result to travel to the given server session Called after a session has been joined by the online platform