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.
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
Multiplayer::MultiplayerConnectionViewportMessageSystemComponent Class Referencefinal

System component that draws viewport messaging as the editor attempts connection to the editor-server while starting up game-mode. More...

#include <MultiplayerConnectionViewportMessageSystemComponent.h>

Inherits AZ::Component, AZ::RPI::ViewportContextNotificationBus::Handler, and MultiplayerEditorServerNotificationBus::Handler.

Public Member Functions

 AZ_COMPONENT (MultiplayerConnectionViewportMessageSystemComponent, "{7600cfcf-e380-4876-aa90-8120e57205e9}")
 
void Activate () override
 
void Deactivate () override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 

Static Public Attributes

static constexpr int MaxMessageLength = 256
 
static constexpr float ScrimAlpha = 0.6f
 
static constexpr AZ::TimeMs CenterViewportDebugToastTimePerWord = AZ::TimeMs{ 300 }
 
static constexpr AZ::TimeMs CenterViewportDebugToastTimePrefix = AZ::TimeMs{ 2000 }
 
static constexpr AZ::TimeMs CenterViewportDebugToastTimeFade = AZ::TimeMs{ 1000 }
 
static constexpr char CenterViewportDebugTitle [] = "Multiplayer Editor"
 
static constexpr char OnServerLaunchedMessage [] = "(1/4) Launching server..."
 
static constexpr char OnServerLaunchFailMessage [] = "(1/4) Could not launch editor server.\nSee console for more info."
 
static constexpr char OnEditorConnectionAttemptMessage [] = "(2/4) Attempting to connect to server in order to send level data.\nAttempt %i of %i"
 
static constexpr char OnEditorConnectionAttemptsFailedMessage [] = "(2/4) Failed to connect to server after %i attempts!\nPlease exit play mode and try again."
 
static constexpr char OnEditorSendingLevelDataMessage [] = "(3/4) Editor is sending the editor-server the level data packet.\nBytes %u / %u sent."
 
static constexpr char OnEditorSendingLevelDataFailedMessage []
 
static constexpr char OnEditorSendingLevelDataSuccessMessage []
 
static constexpr char OnConnectToSimulationFailMessage []
 
static constexpr char OnEditorServerStoppedUnexpectedly [] ="Editor server has unexpectedly stopped running!"
 
static constexpr char ClientStatusTitle [] = "Multiplayer Client Status:"
 
static constexpr char ServerHostingPort [] = "Hosting on port %i"
 
static constexpr char DedicatedServerStatusTitle [] = "Multiplayer Dedicated Server Status:"
 
static constexpr char DedicatedServerNotHosting [] = "Not Hosting"
 
static constexpr char DedicatedServerHostingClientCount [] = "%i client(s)"
 
static constexpr char ClientServerStatusTitle [] = "Multiplayer Client-Server Status:"
 
static constexpr char ClientServerHostingClientCount [] = "%i client(s) (including self)"
 
static constexpr char CenterViewportToastTitle [] = "Multiplayer Alert"
 
static constexpr char OnBlockedLevelLoadMessage [] = "Blocked level load; see log for details."
 
static constexpr char OnNoServerLevelLoadedMessageClientSide [] = "Server accept message did not provide a level.\nEnsure server has level loaded before connecting."
 
static constexpr char OnNoServerLevelLoadedMessageServerSide [] = "A client has connected, but we're not in a level.\nPlease load a valid multiplayer level before accepting clients."
 
static constexpr char OnVersionMismatch [] = "Multiplayer Version Mismatch.\nEnsure server and client are both up to date."
 

Detailed Description

System component that draws viewport messaging as the editor attempts connection to the editor-server while starting up game-mode.

Member Function Documentation

◆ Activate()

void Multiplayer::MultiplayerConnectionViewportMessageSystemComponent::Activate ( )
override

AZ::Component overrides.

Member Data Documentation

◆ OnConnectToSimulationFailMessage

constexpr char Multiplayer::MultiplayerConnectionViewportMessageSystemComponent::OnConnectToSimulationFailMessage[]
staticconstexpr
Initial value:
=
"EditorServerReady packet was received, but connecting to the editor-server's network simulation failed! Is the editor and "
"server using the same sv_port (%i)?"

◆ OnEditorSendingLevelDataFailedMessage

constexpr char Multiplayer::MultiplayerConnectionViewportMessageSystemComponent::OnEditorSendingLevelDataFailedMessage[]
staticconstexpr
Initial value:
=
"(3/4) Editor failed to send the editor-server the level data packet.\nPlease exit play mode and try again."

◆ OnEditorSendingLevelDataSuccessMessage

constexpr char Multiplayer::MultiplayerConnectionViewportMessageSystemComponent::OnEditorSendingLevelDataSuccessMessage[]
staticconstexpr
Initial value:
=
"(4/4) Waiting for editor-server to finish loading the level data."
The documentation for this class was generated from the following file: