Contacts a destination server before game travel. More...

#include <TransitionBeaconClient.h>

Inheritance diagram for ATransitionBeaconClient:

Public Member Functions
GAMEPLAYRUNTIME_API bool	BeginTargetApproval (const Nelaric::FNetworkEndpoint &Endpoint, uint64 RequestId)
	Connects to a target's beacon and requests admission.
GAMEPLAYRUNTIME_API FTargetDecision &	OnTargetDecision ()
	Observes the destination server's decision or failure.
virtual GAMEPLAYRUNTIME_API void	OnConnected () override
	Sends the approval request after beacon connection.
virtual GAMEPLAYRUNTIME_API void	OnFailure () override
	Reports a failed beacon connection.

Detailed Description

Contacts a destination server before game travel.

The requesting client owns this beacon until it receives a decision or failure. The destination server decides whether to admit the request; a valid response is bound to the supplied request ID.

Member Function Documentation

◆ BeginTargetApproval()

GAMEPLAYRUNTIME_API bool ATransitionBeaconClient::BeginTargetApproval	(	const Nelaric::FNetworkEndpoint &	Endpoint,
		uint64	RequestId )

Connects to a target's beacon and requests admission.

Call on the game thread with the target beacon endpoint.

Parameters

Endpoint	Destination approval beacon address and port.
RequestId	Nonzero identity of the pending transition.

Returns: True if a beacon connection attempt was started.

◆ OnConnected()

virtual GAMEPLAYRUNTIME_API void ATransitionBeaconClient::OnConnected ( )

overridevirtual

Sends the approval request after beacon connection.

Unreal calls this on the game thread.

◆ OnFailure()

virtual GAMEPLAYRUNTIME_API void ATransitionBeaconClient::OnFailure ( )

overridevirtual

Reports a failed beacon connection.

Unreal calls this on the game thread.

◆ OnTargetDecision()

GAMEPLAYRUNTIME_API FTargetDecision & ATransitionBeaconClient::OnTargetDecision ( )

Observes the destination server's decision or failure.

Bind before BeginTargetApproval. The final bool is false when the beacon failed before the target authority replied. The owner must also enforce a timeout.

Returns: Delegate carrying identity, approval, and reply presence.

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

NelaricGameplay/Plugins/NelaricGameplay/Source/GameplayRuntime/Public/Session/TransitionBeaconClient.h