本文为B站系列教学视频 《UE5_C++多人TPS完整教程》 —— 《P19 (使用子系统函数)创建会话(Create Session)》 的学习笔记,该系列教学视频为 Udemy 课程 《Unreal Engine 5 C++ Multiplayer Shooter》 的中文字幕翻译版,UP主(也是译者)为 游戏引擎能吃么。
P19(实现子系统函数)创建会话
本节课我们将实现子系统会话接口函数 “CreateSession()
” ,以便创建在线游戏会话、前往关卡 “Lobby
”;我们还将向函数 “MenuSetup()
” 中添加输入功能,这样玩家就可以设置各种连接属性,例如公共连接数。
19.1 实现创建会话接口函数
-
在 “
MultiplayerSessionsSubsystem.h
” 中添加头文件 “"OnlineSessionSettings.h"
”,定义一个在线会话设置 “FOnlineSessionSettings
” 类型的变量,保存上次创建的会话的设置。... #include "CoreMinimal.h" #include "Subsystems/GameInstanceSubsystem.h" #include "Interfaces/OnlineSessionInterface.h" #include "OnlineSubsystem.h" /* P19(实现子系统函数)创建会话(Create Session)*/ #include "OnlineSessionSettings.h" /* P19(实现子系统函数)创建会话(Create Session)*/ #include "MultiplayerSessionsSubsystem.generated.h" ... UCLASS() class MULTIPLAYERSESSIONS_API UMultiplayerSessionsSubsystem : public UGameInstanceSubsystem { GENERATED_BODY() ... private: // 会话接口智能指针 IOnlineSessionPtr SessionInterface; // 添加头文件 "Interfaces/OnlineSessionInterface.h" 后使用,更具可读性 // TSharedPtr<class IOnlineSession, ESPMode::ThreadSafe> SessionInterface; // 使用 TSharedPtr 智能指针包装器进行声明 /* P19(实现子系统函数)创建会话(Create Session)*/ TSharedPtr<FOnlineSessionSettings> LastSessionSettings; // 上次创建的会话的设置 /* P19(实现子系统函数)创建会话(Create Session)*/ ... };
-
在 “
MultiplayerSessionsSubsystem.cpp
” 中实现创建会话接口函数 “CreateSession()
”。/* P19(实现子系统函数)创建会话(Create Session)*/ void UMultiplayerSessionsSubsystem::CreateSession(int32 NumpublicConnections, FString MatchType) { // 检查会话接口是否有效 if (!SessionInterface.IsValid()) { return; } // 检查是否先前存在会话 auto ExistingSession = SessionInterface->GetNamedSession(NAME_GameSession); if (ExistingSession != nullptr) { // 如果先前存在会话 SessionInterface->DestroySession(NAME_GameSession); // 销毁会话 } // 保存委托句柄,以便此后移出委托列表 CreateSessionCompleteDelegateHandle = SessionInterface->AddOnCreateSessionCompleteDelegate_Handle(CreateSessionCompleteDelegate); // 添加委托到会话接口的委托列表 // FOnlineSessionSettings 在头文件 "OnlineSessionSettings.h" 中 LastSessionSettings = MakeShareable(new FOnlineSessionSettings()); // 创建会话设置,利用函数 MakeShareable 初始化 // 会话设置成员变量参阅及含义:https://docs.unrealengine.com/5.3/en-US/API/Plugins/OnlineSubsystem/FOnlineSessionSettings/ LastSessionSettings->bIsLANMatch = IOnlineSubsystem::Get()->GetSubsystemName() == "NULL" ? true : false; // 会话设置:如果找到的子系统名称为 “NULL”,则使用 LAN 连接,否则不使用 LastSessionSettings->NumPublicConnections = NumpublicConnections; // 会话设置:设置最大公共连接数为函数输入变量 NumpublicConnections LastSessionSettings->bAllowJoinInProgress = true; // 会话设置:在会话运行时允许其他玩家加入 LastSessionSettings->bAllowJoinViaPresence = true; // 会话设置:Steam 使用 Presence 搜索会话所在地区,确保连接正常工作 LastSessionSettings->bShouldAdvertise = true; // 会话设置:允许 Steam 发布会话 LastSessionSettings->bUsesPresence = true; // 会话设置:允许显示用户 Presence 信息 LastSessionSettings->bUseLobbiesIfAvailable = true; // 会话设置:优先选择 Lobby API(Steam 支持 Lobby API) // void FOnlineSessionSettings::Set(FName Key, const FString& Value, EOnlineDataAdvertisementType::Type InType); LastSessionSettings->Set(FName("MatchType"), FString("FreeForAll"), EOnlineDataAdvertisementType::ViaOnlineServiceAndPing); // 会话设置:匹配类型 // 创建会话 const ULocalPlayer* LocalPlayer = GetWorld()->GetFirstLocalPlayerFromController(); // 获取本地玩家指针 /* SessionInterface->CreateSession(*LocalPlayer->GetPreferredUniqueNetId(), // 第一个参数类型为 strut FUniqueNetIdRepl,公共继承了 struct FUniqueNetIdWrapper // 这个包装器重载了引用运算符 *,它表示 * 返回一个引用 *UniquenetId NAME_GameSession, // 第二个参数类型为 FName SessionName,游戏会话名称 *LastSessionSettings); // 第三个参数类型为 const FOnlineSessionSettings &NewSessionSettings */ if (!SessionInterface->CreateSession(*LocalPlayer->GetPreferredUniqueNetId(), NAME_GameSession, *LastSessionSettings)) { // 如果会话创建失败,将委托移出委托列表 SessionInterface->ClearOnCreateSessionCompleteDelegate_Handle(CreateSessionCompleteDelegateHandle); } } /* P19(实现子系统函数)创建会话(Create Session)*/
19.2 实现传送至关卡 Lobby
-
在 “
Menu.cpp
” 的 “HostButtonClicked()
” 函数中添加传送至关卡 “Lobby
” 的代码。void UMenu::HostButtonClicked() // 回调函数:响应鼠标单击 HostButton 事件 { if (GEngine) { GEngine->AddOnScreenDebugMessage( // 添加调试信息到屏幕上 -1, // 使用 -1 不会覆盖前面的调试信息 15.f, // 调试信息的显示时间 FColor::Yellow, // 字体颜色:黄色 FString::Printf(TEXT("Host Button Clicked!")) // 打印点击事件消息 ); } if (MultiplayerSessionsSubsystem) { MultiplayerSessionsSubsystem->CreateSession(4, FString("FreeForAll")); // 创建游戏会话 /* P19(实现子系统函数)创建会话(Create Session)*/ // 会话创建后传送至关卡 Lobby UWorld* World = GetWorld(); if (World) { // Uworld->ServerTravel:https://docs.unrealengine.com/5.0/en-US/API/Runtime/Engine/Engine/UWorld/ServerTravel/ World->ServerTravel(FString("/Game/ThirdPerson/Maps/Lobby?listen")); // 作为监听服务器打开 Lobby 关卡 } /* P19(实现子系统函数)创建会话(Create Session)*/ } }
-
在 VS 中生成解决方案,在 “
MenuSystem
”项目目录下右键单击 “MenuSystem.uproject
”,在弹出的菜单栏选择 “Launch Game
”,进入游戏后可以找到Steam
在线子系统,点击按钮 “Host
”,我们就可以前往大厅 “Lobby
”。
-
但注意到此时我们无法用鼠标和键盘控制角色,这是因为我们在 “
MenuSetup()
” 当中更改了玩家角色控制器的输入,设置了一个只允许控制 UI 的输入模式(“FInputModeUIOnly
” 类型),这并不包含角色的控制输入,先前控制玩家角色的输入模式失效,并且这个控制 UI 的输入模式一直保存到了关卡 “Lobby” 中。解决这个问题的简单办法是再创建一个函数MenuTearDown()
,用以重置所有输入设置,撤销(Undo)先前设置的输入模式。 -
在
Menu.h
中定义输入模式重置函数 “MenuTearDown()
”;定义 “OnLevelRemovedFromWorld()
” 函数重写,该函数在跳转关卡、世界结束时被调用,我们将重写它,让它自动删除视口上的控件的同时,调用函数 “MenuTearDown()
”,撤销先前设置的输入模式。注意在 5.1 之后的版本中 “virtual void OnLevelRemoveFromWorld()
” 被去除,取而代之的是 “virtual void NativeDestruct()
”。... UCLASS() class MULTIPLAYERSESSIONS_API UMenu : public UUserWidget { GENERATED_BODY() ... protected: virtual bool Initialize() override; // 初始化函数重写,绑定按钮与回调函数 /* P19(实现子系统函数)创建会话(Create Session)*/ // 在 5.1 之后的版本中 virtual void OnLevelRemoveFromWorld() 被去除,取而代之的是 virtual void NativeDestruct() // virtual void OnLevelRemovedFromWorld(): https://docs.unrealengine.com/5.0/en-US/API/Runtime/UMG/Blueprint/UUserWidget/OnLevelRemovedFromWorld/ // void NativeDestruct(): https://docs.unrealengine.com/5.1/en-US/API/Runtime/UMG/Blueprint/UUserWidget/NativeDestruct/ virtual void OnLevelRemovedFromWorld(ULevel* InLevel, UWorld* InWorld) override; // 当跳转关卡时 OnLevelRemovedFromWorld() 被调用,它自动删除视口上的控件 // virtual void NativeDestruct() override; /* P19(实现子系统函数)创建会话(Create Session)*/ private: UPROPERTY(meta = (BindWidget)) // 与虚幻引擎中的按钮控件链接 class UButton* HostButton; // 保证 C++ 变量名和虚幻引擎中的按钮控件名称相同 UPROPERTY(meta = (BindWidget)) // 与虚幻引擎中的按钮控件链接 UButton* JoinButton; // 保证 C++ 变量名和虚幻引擎中的按钮控件名称相同 UFUNCTION() void HostButtonClicked(); // 回调函数:响应鼠标单击 HostButton 事件 UFUNCTION() void JoinButtonClicked(); // 回调函数:响应鼠标单击 HostButton 事件 /* P19(实现子系统函数)创建会话(Create Session)*/ void MenuTearDown(); // 撤销先前设置的输入模式 /* P19(实现子系统函数)创建会话(Create Session)*/ class UMultiplayerSessionsSubsystem* MultiplayerSessionsSubsystem; // 处理所有在线会话功能的子系统 };
-
在 “
Menu.cpp
” 中重写 “OnLevelRemovedFromWorld()
” 函数,并完善函数 “MenuTearDown()
” 的定义。... /* P19(实现子系统函数)创建会话(Create Session)*/ void UMenu::OnLevelRemovedFromWorld(ULevel* InLevel, UWorld* InWorld) { MenuTearDown(); Super::OnLevelRemovedFromWorld(InLevel, InWorld); // 调用父类的 OnLevelRemovedFromWorld() 函数 } /* void UMenu::NativeDestruct() { MenuTearDown(); Super::NativeDestruct(); // 调用父类的 NativeDestruct() 函数 } */ /* P19(实现子系统函数)创建会话(Create Session)*/ ... /* P19(实现子系统函数)创建会话(Create Session)*/ void UMenu::MenuTearDown() { RemoveFromParent(); UWorld* World = GetWorld(); if (World) { APlayerController* PlayerController = World->GetFirstPlayerController(); // 获取玩家控制器指针 if (PlayerController) { FInputModeGameOnly InputModeData; // 用于设置可以控制游戏的输入模式 PlayerController->SetInputMode(InputModeData); // 设置玩家控制器的输入模式 PlayerController->SetShowMouseCursor(false); // 隐藏鼠标光标 } } } /* P19(实现子系统函数)创建会话(Create Session)*/ ...
19.3 添加可供玩家输入的参数
-
在 “
Menu.h
” 中添加可供玩家输入的变量(包括公共连接数和匹配类型)作为 “MenuSetup()
” 函数的入参。... UCLASS() class MULTIPLAYERSESSIONS_API UMenu : public UUserWidget { GENERATED_BODY() public: /* P19(实现子系统函数)创建会话(Create Session)*/ // 为 MenuSetup() 添加可供玩家输入的参数项(公共连接数和匹配类型) // 设置 NumberOfPublicConnections 默认值为 4,TypeOfMatch 默认值为 "FreeForAll" UFUNCTION(BlueprintCallable) void MenuSetup(int32 NumberOfPublicConnections = 4, FString TypeOfMatch = FString(TEXT("FreeForAll"))); /* P19(实现子系统函数)创建会话(Create Session)*/ ... private: ... class UMultiplayerSessionsSubsystem* MultiplayerSessionsSubsystem; // 处理所有在线会话功能的子系统 /* P19(实现子系统函数)创建会话(Create Session)*/ int32 NumPublicConnections{ 4 }; // 公共连接数 FString MatchType = { TEXT("FreeForAll") }; // 匹配类型 /* P19(实现子系统函数)创建会话(Create Session)*/ };
-
在 “
Menu.cpp
” 中修改 “MenuSetup()
” 函数的定义,然后在 “HostButtonClicked()
” 中修改 “CreateSession()
” 的入参,进行编译。... void UMenu::MenuSetup(int32 NumberOfPublicConnections, FString TypeOfMatch) { /* P19(实现子系统函数)创建会话(Create Session)*/ NumPublicConnections = NumberOfPublicConnections; MatchType = TypeOfMatch; /* P19(实现子系统函数)创建会话(Create Session)*/ AddToViewport(); // 添加到视口 SetVisibility(ESlateVisibility::Visible); // 设置菜单可见 bIsFocusable = true; // 允许鼠标点击的时候聚焦 ... } ... void UMenu::HostButtonClicked() // 回调函数:响应鼠标单击 HostButton 事件 { if (GEngine) { GEngine->AddOnScreenDebugMessage( // 添加调试信息到屏幕上 -1, // 使用 -1 不会覆盖前面的调试信息 15.f, // 调试信息的显示时间 FColor::Yellow, // 字体颜色:黄色 FString::Printf(TEXT("Host Button Clicked!")) // 打印点击事件消息 ); } if (MultiplayerSessionsSubsystem) { /* P19(实现子系统函数)创建会话(Create Session)*/ MultiplayerSessionsSubsystem->CreateSession(NumPublicConnections, MatchType); // 创建游戏会话 /* P19(实现子系统函数)创建会话(Create Session)*/ ... } ... } ...
-
在虚幻引擎打开 “
ThirdPersonMap
” 关卡蓝图,可以看到蓝图节点中多了两个自带默认值的参数引脚。
19.4 Summary
本节课我们实现了“MultiplayerSessionsSubsystem.cpp
” 中的 “CreateSession()
” 函数,在函数体中完成会话设置、创建会话等功能。接着,在 “Menu.cpp
” 的 “HostButtonClicked()
” 函数中添加了传送至大厅 “Lobby
” 的代码,但在进行测试时,我们注意到传送到该关卡后无法用鼠标和键盘控制角色,这是因为我们在 “MenuSetup()
” 当中更改了玩家角色控制器的输入,设置了一个不包含角色的控制输入、只允许控制 UI 的输入模式。为解决这个问题,我们创建了一个函数 MenuTearDown()
撤销先前设置的输入模式,然后对 “OnLevelRemovedFromWorld()
” 函数进行重写,添加对 MenuTearDown()
的调用,这样在跳转关卡、世界结束时,被重写的函数 “OnLevelRemovedFromWorld()
” 被调用,它在自动删除视口中控件的同时也会调用 MenuTearDown()
函数重置先前的输入模式。最后,我们修改了 “MenuSetup()
” 函数的入参,添加了可供玩家输入的变量(包括公共连接数和匹配类型)。
在 19.2 实现传送至关卡 Lobby 的 步骤 2 中我们可以学到除了在虚幻引擎中使用 PIE 模式、打包后运行游戏之外的第三种测试方法:在项目目录下右键单击虚幻引擎项目文件 “.uproject
”,在弹出的菜单栏选择 “Launch Game
” 。
在 步骤 4 中重写函数 OnLevelRemovedFromWorld()
时,要注意在虚幻引擎 5.1 之后的版本中 “virtual void OnLevelRemoveFromWorld()
” 被去除,取而代之的是 “virtual void NativeDestruct()
”,因此 5.1 之后的版本需要重写函数 “virtual void NativeDestruct()
”,否则会报错无法重写基类成员。