文档

支持

Multiplay Hosting for the Unreal Engine

Multiplay Hosting overview

Multiplay Hosting for the Unreal Engine

类 Multiplay Server Query Handler Subsystem

Reference documentation for the Multiplay Server Query Handler Subsystem class.
阅读时间5 分钟最后更新于 4 天前
负责处理 Multiplay 服务器查询的子系统。
Include（包括）
#include "MultiplayServerQueryHandlerSubsystem.h"
语法
UCLASS()class MULTIPLAYGAMESERVERSDK_API UMultiplayServerQueryHandlerSubsystem : public UMultiplaySubsystemBase
继承自：MultiplaySubsystemBase。

覆盖

Initialize(FSubsystemCollectionBase&)

初始化 USubsystem 的覆盖。

声明

virtual void Initialize(FSubsystemCollectionBase& Collection) override

Deinitialize()

初始化 USubsystem 的覆盖。

声明

virtual void Deinitialize() override

方法

Connect()

开始监听 Multiplay 服务器查询。

声明

UFUNCTION(BlueprintCallable, Category="Multiplay | ServerQuery")bool Connect()

返回

类型

描述

bool
布尔值，指示查询端口是否被绑定。

Disconnect()

停止监听 Multiplay 服务器查询。

声明

UFUNCTION(BlueprintCallable, Category="Multiplay | ServerQuery")void Disconnect()

IsConnected()

指示服务器是否正在主动监听服务器查询请求。

声明

UFUNCTION(BlueprintCallable, Category="Multiplay | ServerQuery")bool IsConnected() const

返回

类型

描述

bool
布尔值，指示服务器是否正在主动监听服务器查询请求。

GetCurrentPlayers()

获取当前连接到服务器的玩家人数。

声明

UFUNCTION(BlueprintGetter, Category="Multiplay | ServerQuery")const int32& GetCurrentPlayers() const

返回

类型

描述

const
int32
&
当前连接到服务器的玩家人数。

IncrementCurrentPlayers()

以原子操作的方式增加当前连接到服务器的玩家人数。 每当有玩家加入游戏对战时都应调用此方法。 请参阅 SetCurrentPlayers()，了解覆盖当前值的替代方法。

声明

UFUNCTION(BlueprintCallable, Category="Multiplay | ServerQuery")void IncrementCurrentPlayers()

DecrementCurrentPlayers()

以原子操作的方式减少当前连接到服务器的玩家人数。 每当有玩家离开游戏对战时都应调用此方法。 请参阅 SetCurrentPlayers()，了解覆盖当前值的替代方法。

声明

UFUNCTION(BlueprintCallable, Category="Multiplay | ServerQuery")void DecrementCurrentPlayers()

SetCurrentPlayers(int32)

设置当前连接到服务器的玩家人数。 每当有玩家加入或离开游戏对战时都应调用此方法。 请参阅 IncrementCurrentPlayers() 和 DecrementCurrentPlayers()，了解 SetCurrentPlayers(int32) 的原子替代方法。

声明

UFUNCTION(BlueprintSetter, Category="Multiplay | ServerQuery")void SetCurrentPlayers(int32 Value)

参数

Name

类型

描述

Value
int32当前玩家数量。

GetMaxPlayers()

获取服务器上允许存在的最大玩家人数。

声明

UFUNCTION(BlueprintGetter, Category="Multiplay | ServerQuery")const int32& GetMaxPlayers() const

返回

类型

描述

const
int32
&
允许存在的最大玩家人数。

SetMaxPlayers(int32)

设置服务器上允许存在的最大玩家人数。

声明

UFUNCTION(BlueprintSetter, Category="Multiplay | ServerQuery")void SetMaxPlayers(int32 Value)

参数

Name

类型

描述

Value
int32最大玩家人数。

GetServerName()

获取服务器的名称。

声明

UFUNCTION(BlueprintGetter, Category="Multiplay | ServerQuery")const FString& GetServerName() const

返回

类型

描述

const
FString
&
服务器的名称。

SetServerName(FString)

设置服务器的名称。

声明

UFUNCTION(BlueprintSetter, Category="Multiplay | ServerQuery")void SetServerName(FString Value)

参数

Name

类型

描述

Value
FString服务器的名称。

GetGameType()

获取当前分配给服务器的游戏类型。

声明

UFUNCTION(BlueprintGetter, Category="Multiplay | ServerQuery")const FString& GetGameType() const

返回

类型

描述

const
FString
&
服务器的游戏类型名称。

SetGameType(FString)

设置服务器的游戏类型。

声明

UFUNCTION(BlueprintSetter, Category="Multiplay | ServerQuery")void SetGameType(FString Value)

参数

Name

类型

描述

Value
FString服务器的游戏类型。

GetBuildId()

获取服务器的版本 ID。

声明

UFUNCTION(BlueprintGetter, Category="Multiplay | ServerQuery")const FString& GetBuildId() const

返回

类型

描述

const
FString
&
服务器的版本 ID。

SetBuildId(FString)

设置服务器的版本 ID。

声明

UFUNCTION(BlueprintSetter, Category="Multiplay | ServerQuery")void SetBuildId(FString Value)

参数

Name

类型

描述

Value
FString服务器的版本 ID。

GetMap()

获取服务器当前所在的地图。

声明

UFUNCTION(BlueprintGetter, Category="Multiplay | ServerQuery")const FString& GetMap() const

返回

类型

描述

const
FString
&
服务器当前地图的名称。

SetMap(FString)

设置服务器的地图。

声明

UFUNCTION(BlueprintSetter, Category="Multiplay | ServerQuery")void SetMap(FString Value)

参数

Name

类型

描述

Value
FString服务器的地图。

GetPort()

获取服务器正在监听的 SQP 端口。

声明

UFUNCTION(BlueprintGetter, Category="Multiplay | ServerQuery")const int32& GetPort() const

返回

类型

描述

const
int32
&
服务器的端口。

SetPort(int32)

设置服务器监听的 SQP 端口。

声明

UFUNCTION(BlueprintSetter, Category="Multiplay | ServerQuery")void SetPort(int32 Value)

参数

Name

类型

描述

Value
int32服务器的端口。