Open 3D Engine Multiplayer Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Multiplayer::MultiplayerEditorServerNotifications Class Reference

Inherits AZ::EBusTraits.

Public Member Functions

virtual void OnServerLaunched ()
 Notification when the Editor has successfully opened the editor server.
 
virtual void OnServerLaunchFail ()
 
virtual void OnEditorConnectionAttempt (uint16_t connectionAttempts, uint16_t maxAttempts)
 
virtual void OnEditorConnectionAttemptsFailed (uint16_t failedAttempts)
 
virtual void OnEditorSendingLevelData (uint32_t bytesSent, uint32_t bytesTotal)
 Notification when the Editor starts sending the current level data (spawnable) to the server.
 
virtual void OnEditorSendingLevelDataFailed ()
 Notification when the Editor has failed to send the current level data to the server.
 
virtual void OnEditorSendingLevelDataSuccess ()
 Notification when the Editor has successfully finished sending the current level data to the server.
 
virtual void OnConnectToSimulationSuccess ()
 Notification when the Editor has sent all the level data successful and is now fully connected to the multiplayer simulation.
 
virtual void OnConnectToSimulationFail (uint16_t serverPort)
 
virtual void OnPlayModeEnd ()
 Notification when the Editor multiplayer play mode is over; therefore ending the multiplayer simulation.
 
virtual void OnEditorServerProcessStoppedUnexpectedly ()
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Multiple
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 

Member Function Documentation

◆ OnConnectToSimulationFail()

virtual void Multiplayer::MultiplayerEditorServerNotifications::OnConnectToSimulationFail ( uint16_t  serverPort)
inlinevirtual

Notification when the Editor has sent all the level data successful but for some reason it fails to connect to normal multiplayer simulation.

Parameters
serverPortThe server port. This is useful information since user might be trying to connect to the wrong port.

◆ OnEditorConnectionAttempt()

virtual void Multiplayer::MultiplayerEditorServerNotifications::OnEditorConnectionAttempt ( uint16_t  connectionAttempts,
uint16_t  maxAttempts 
)
inlinevirtual

Notification when the Editor attempts a TCP connection to the server. Note: It's possible multiple connection attempts are needed if the user starts and stops editor play mode repeatedly because the server port takes a few seconds to free.

Parameters
connectionAttemptsThe number of attempts made to connect to the editor-server

◆ OnEditorConnectionAttemptsFailed()

virtual void Multiplayer::MultiplayerEditorServerNotifications::OnEditorConnectionAttemptsFailed ( uint16_t  failedAttempts)
inlinevirtual

Notification when the Editor failed all attempts to establish its TCP connection with the server. Maximum attempts are set using the cvar: editorsv_max_connection_attempts

◆ OnEditorServerProcessStoppedUnexpectedly()

virtual void Multiplayer::MultiplayerEditorServerNotifications::OnEditorServerProcessStoppedUnexpectedly ( )
inlinevirtual

Notification when the server process launched by the editor has unexpectedly stopped running. This likely means the server crashed, or the user stopped the process by hand.

◆ OnServerLaunchFail()

virtual void Multiplayer::MultiplayerEditorServerNotifications::OnServerLaunchFail ( )
inlinevirtual

Notification when the Editor has failed to open the editor server. Might have failed for various reasons, this is a catch-all.


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