Struct Multiplay Server Config

Reference documentation for the Multiplay Server Config struct.

Read time 2 minutes

Last updated 3 hours ago

Warning

We are winding down our direct support for the Unity Multiplay Game Server Hosting Service. Unity will support the Multiplay Game Server Hosting Service through March 31, 2026. To ensure continuity for live titles, we are licensing our Multiplay Game Server Hosting software to Rocket Science Group. Learn more about them here.

The server configuration for the current session.

Include


#include "MultiplayServerConfig.h"

Syntax


USTRUCT(BlueprintType)struct MULTIPLAYGAMESERVERSDK_API FMultiplayServerConfig

Fields

EventId

The server ID.

Declaration


UPROPERTY(BlueprintReadOnly, Category="Multiplay | ServerConfig")int64 ServerId = 0

Blueprint

Name	Type	Default value
Server Id	Integer	`0`

C++

Name	Type
`ServerId`	int64

AllocationId

The allocation ID.

Declaration


UPROPERTY(BlueprintReadOnly, Category="Multiplay | ServerConfig")FString AllocationId

Blueprint

Name	Type
Allocation Id	String

C++

Name	Type
`AllocationId`	FString

QueryPort

The Server Query Protocol Port.

Declaration


UPROPERTY(BlueprintReadOnly, Category="Multiplay | ServerConfig")int32 QueryPort = 0

Blueprint

Name	Type	Default value
Query Port	Integer	`0`

C++

Name	Type	Default value
`QueryPort`	int32	`0``

Ip

The ip address for the session.

Declaration


UPROPERTY(BlueprintReadOnly, Category = "Multiplay | ServerConfig")FString Ip

Blueprint

Name	Type
Ip	String

C++

Name	Type
`Ip`	FString

Port

The connection port for the session.

Declaration


UPROPERTY(BlueprintReadOnly, Category="Multiplay | ServerConfig")int32 Port = 0

Blueprint

Name	Type	Default value
Port	Integer	`0`

C++

Name	Type	Default value
`Port`	int32	`0``

ServerLogDirectory

The directory logs will be written to.

Declaration


UPROPERTY(BlueprintReadOnly, Category="Multiplay | ServerConfig")FString ServerLogDirectory

Blueprint

Name	Type
Server Log Directory	String

C++

Name	Type
`ServerLogDirectory`	FString

Struct Multiplay Server Config

Include

Syntax

Fields

EventId

Declaration

Blueprint

Name

Type

Default value

C++

Name

Type

AllocationId

Declaration

Blueprint

Name

Type

C++

Name

Type

QueryPort

Declaration

Blueprint

Name

Type

Default value

C++

Name

Type

Default value

Ip

Declaration

Blueprint

Name

Type

C++

Name

Type

Port

Declaration

Blueprint

Name

Type

Default value

C++

Name

Type

Default value

ServerLogDirectory

Declaration

Blueprint

Name

Type

C++

Name

Type