keywords:UE4、Replication、Relicate、reliable、RPC、RTS Movement、Dedicated Server、属性同步、demo、example
实例的完整工程下载地址见文章底部
属性同步
步骤:
1,对属性添加UPROPERTY(Replicated)宏:
//Player display name
UPROPERTY(Replicated)
FString Alias_;
2,属性所在的class中重写函数GetLifetimeReplicatedProps:
需要头文件:
#include "Net/UnrealNetwork.h"
重写函数:
void AReplTestCharacter::GetLifetimeReplicatedProps(TArray< FLifetimeProperty > & OutLifetimeProps) const
{
Super::GetLifetimeReplicatedProps(OutLifetimeProps);
DOREPLIFETIME(AReplTestCharacter, Alias_);
}
RPC(远程执行调用)
步骤:
1,对需要远程执行的函数添加宏UFUNCTION(Server, Reliable, WithValidation)或者UFUNCTION(Client, Reliable)。其中Server表示在客户端调用,在服务端执行,Client则反之;WithValidation表示是否需要验证函数,加上的画需要添加函数:bool MyFun_Validate(),函数提内容写在MyFun_Implementation函数内。cpp中不需要与函数名同名的函数体,只需要实现_Validate和_Implementation两个函数即可。 头文件:
//移动角色(只在服务端执行的函数)
UFUNCTION(Server, Reliable, WithValidation)
void ServerMoveToDest(APawn* Panw, const FVector DestLocation);
bool ServerMoveToDest_Validate(APawn* Panw, const FVector DestLocation);
void ServerMoveToDest_Implementation(APawn* Panw, const FVector DestLocation);
CPP:
bool AReplTestPlayerController::ServerMoveToDest_Validate(APawn* Panw, const FVector DestLocation)
{
return true;
}
void AReplTestPlayerController::ServerMoveToDest_Implementation(APawn* Pawn, const FVector DestLocation)
{
//logic...
}
角色身上需要设置的属性
角色蓝图上的这几个属性默认是勾选的。如果是C++,对应的属性名也是这几个。
登陆界面:
多个客户端连上服务端的最终情景:
同步相关的基础概念
NetMode
每个Actor有个接口:AActor::GetNetMode(),返回值意思如下:
- NM_Standalone:表示当前Actor在独立服务器(单机模式),可以执行客户端、服务端的所有功能。
- NM_DedicatedServer:表示当前Actor在专用服务器上,只能执行服务端相关的功能。
- NM_ListenServer:官方文档上解释的很少,我在官方论坛上问了下得到的几个解释是,ListenServer可以被游戏内的某个玩家的机器当作服务器,该服务器拥有操作每个客户端角色的权利。这种模式下,更方便来创建服务器;缺点是承载人数较少。个人理解是ListenServer可能更适合做局域网游戏,因为这种既不需要考虑外挂也不需要考虑承载压力。
DedicatedServer没有客户端的相关功能,只接收远程客户端的网络请求,适合承载大规模玩家在线。另外连接DedicatedServer的客户端,是没有权限直接修改其他玩家的数据,因为客户端上的大部分Object的Role枚举都是ROLE_AutonomousProxy(如果你逻辑有bug,也是可以被客户端发送非法请求串改其他角色的数据,所以这里所说的没有权限修改,不要以为DedicatedServer可以帮你反外挂),但是在ListenServer的玩家主机上可以,因为他拥有其他所有玩家的实例(Role枚都是ROLE_Authority类型)。UE4的一些API内部有权限检测的逻辑:判断当前Role类型是否为ROLE_Authority,这样避免非法修改数据。
Role
每个Actor有个公开属性:AActor::Role。表示当前Actor的作用权限,枚举值有:
- ROLE_SimulatedProxy:表示当前Actor是一个模拟服务端的Actor状态Object,无法修改服务端上的数据,也没有权限执行远程函数(Reliable标识的UFUNCTION)。
- ROLE_AutonomousProxy:与ROLE_SimulatedProxy相似,区别是ROLE_AutonomousProxy有权限执行远程函数,但是远程函数必须是该Object身上的,其他Object上的远程函数没有权限执行。
- ROLE_Authority:最高权限,即可以修改Server上的属性,又可以执行任何Objecct身上的远程函数。
关键函数
1,客户端登陆
void UMyUserWidget::OnBtnLoginClick()
{
if (APlayerController* PC = GetWorld()->GetFirstPlayerController())
{
FString URL = FString::Printf(TEXT("%s:%s?Alias=%s"), *(TxtServerIP->GetText().ToString()), *(TxtServerPort->GetText().ToString()), *(TxtUsername->GetText().ToString()));
PC->ClientTravel(*URL, TRAVEL_Absolute);
}
}
2,GameMode::InitNewPlayer(),处理登陆请求时的自定义参数,比如账号名和密码。
FString AReplTestGameMode::InitNewPlayer(APlayerController* NewPlayerController, const FUniqueNetIdRepl& UniqueId, const FString& Options, const FString& Portal)
{
FString Rs = Super::InitNewPlayer(NewPlayerController, UniqueId, Options, Portal);
if (AReplTestPlayerController* RTPC = Cast<AReplTestPlayerController>(NewPlayerController))
{
FString Alias = UGameplayStatics::ParseOption(Options, TEXT("Alias")).Trim();
if (Alias.Len() == 0 || AliasMap.Find(Alias))
{
return Rs;
}
RTPC->SetPlayerAlias(Alias);
PlayerData Data;
Data.Alias = Alias;
AliasMap.Add(Alias, Data);
}
return Rs;
}
3,GameMode::PostLogin(),登陆完成后的回调函数,创建角色可以放在这个函数中处理。
void AReplTestGameMode::PostLogin(APlayerController* NewPlayer)
{
Super::PostLogin(NewPlayer);
if (GetNetMode() == NM_DedicatedServer)
{
PlayerCount++;
if (CharClass)
{
if (AReplTestCharacter* Player = GetWorld()->SpawnActor<AReplTestCharacter>(CharClass, SpawnLoc, SpawnRot))
{
PlayerList.Add(Player);
/*if (AMyAIController* AIC = GetWorld()->SpawnActor<AMyAIController>(SpawnLoc, SpawnRot))
{
AIC->Possess(Player);
}*/
Player->SpawnDefaultController();
//设置角色的显示名称
if (AReplTestPlayerController* RTPC = Cast<AReplTestPlayerController>(NewPlayer))
{
if (PlayerData* Data = AliasMap.Find(RTPC->PlayerAlias()))
{
Player->SetAlias(*(Data->Alias));
Data->RTC = Player;
if (AMyAIController* AIC = Cast<AMyAIController>(Player->GetController()))
{
AIC->SetPlayerAlias(Data->Alias);
}
}
}
}
}
}
}
4,Character::BeginPlay(),当创建的Character进入场景时的回调函数,绑定摄像机的逻辑可以放在这个函数中
void AReplTestCharacter::BeginPlay()
{
Super::BeginPlay();
if (ROLE_SimulatedProxy == Role && NM_Client == GetNetMode())
{
if (APlayerController* PC = GetWorld()->GetFirstPlayerController())
{
if (AReplTestPlayerController* RTPC = Cast<AReplTestPlayerController>(PC))
{
//因为一个客户端首次加载时会有多个玩家的角色进入场景,这里判断哪个角色才是当前客户端的
if (Alias_ == RTPC->PlayerAlias())
{
PC->SetViewTarget(this);
RTPC->SetSimulatedCharacter(this);
}
}
}
}
}
5,客户端判断鼠标点击事件,这里加了一个保护,如果鼠标前后两次点击的坐标距离相差小于120,则不向服务端发送位移请求,防止频繁点击时发送消息太频繁。
void AReplTestPlayerController::MoveToMouseCursor()
{
// Trace to see what is under the mouse cursor
FHitResult Hit;
GetHitResultUnderCursor(ECC_Visibility, false, Hit);
if (Hit.bBlockingHit)
{
if (FVector::Dist(LastDestLoc, Hit.ImpactPoint) > 120)
{
LastDestLoc = Hit.ImpactPoint;
SetNewMoveDestination(Hit.ImpactPoint);
}
}
}
6,服务端处理Move请求的函数,ServerMoveToDest_Validate判断请求的逻辑是否合法:Pawn是不是当前客户端操控的角色,防止操控其他玩家的角色。
bool AReplTestPlayerController::ServerMoveToDest_Validate(APawn* Pawn, const FVector DestLocation)
{
//判断请求是否非法,不允许当前客户端操控其他客户端的角色
bool Rs = false;
if (AReplTestCharacter* RTC = Cast<AReplTestCharacter>(Pawn))
{
Rs = RTC->Alias() == PlayerAlias();
}
return Rs;
}
void AReplTestPlayerController::ServerMoveToDest_Implementation(APawn* Pawn, const FVector DestLocation)
{
if (AMyAIController* AIC = Cast<AMyAIController>(Pawn->GetController()))
{
AIC->MoveToLocation(DestLocation);
}
}
注意事项:
1,Replicated属性只能在服务端修改
Replicated属性只允许服务端修改后通知客户端,而不允许客户端修改Replicated属性后通知到服务端。 参考:Only the server can replicate variables or multicast events to all clientshttps://answers.unrealengine.com/questions/459423/change-variable-in-client-want-server-to-see-it-bu.html
2,Server或者Client函数参数只能时指针或者引用,而不能是对象
比如如果参数是FString,那么必须是引用:const FString& Str,而不能是FString对象。
3,HUD的构造函数在服务端也会执行,但是DrawHUD()函数不会在服务端执行。 也就是说你要在HUD中判断当前程序是客户端还是服务端,可以不用考虑DrawHUD()函数。
4,当客户端登陆成功后,客户端所有的对象都会被重置,登陆前设置的对数属性值将变为默认值。
比如在启动游戏后登陆之前,你给PlayerController上的string属性设置为”abc”,那么登陆成功后,这个属性值就变成了空字符串。
5,GameMode、AIController是为服务端设计的,PlayerController是为客户端设计的。两者虽然在客户端和服务端都可访问,但是前者是在服务端创建的,后者是在客户端创建的,比如PlayerController::GetHitResultAtScreenPosition只在客户端生效,而GameMode::PostLogin()只在服务端生效。
6,服务端的AIController::MoveToLocation()的效果相当于客户端UNavigationSystem::SimpleMoveToLocation()。AIController::MoveToLocation()内部有去调用NavigationSystem相关的接口。
7,客户端的PlayerController可以不用Possess玩家角色,因为客户端相关数据都是以服务端为准,操作角色也是在服务端完成,一般只需要对该角色绑定摄像机即可。
8,如果_Validate()函数返回false,则服务器会会认为客户端非法,并主动断开该客户端。断开客户端时服务端会打印:
LogRep: Error: ReceivedRPC: RPC_GetLastFailedReason: XXXX_Validate
LogNet: Error: UActorChannel::ProcessBunch: Replicator.ReceivedBunch failed. Closing connection. RepObj: ReplTestPlayerController /Game/TopDownCPP/Maps/TopDownExampleMap.TopDownExampleMap:PersistentLevel.ReplTestPlayerController_1, Channel: 2
9,当前客户端只能获取当前控制角色的Controller,无法获取其他客户端的Controller,比如玩家A在玩家B的角色为C1,那么调用C1->GetController()时返回NULL。
常见问题:
1,如果出现以下错误,表示Reliable函数的参数名和引擎生成的代码有同名的情况,把参数名重新改一下即可。
error : Function parameter: 'Pawn' cannot be defined in 'ServerMoveToDest' as it is already defined in scope 'Controller' (shadowing is not allowed)
2,如果服务端SpawnActor时返回NULL,且参数传递都正确,可能是服务端上的对应Actor未清理,比如客户端崩掉了,导致了服务端的Actor未即时清理。
示例工程下载地址:http://pan.baidu.com/s/1o7MzmRo
其他参考文章:
属性同步:http://blog.csdn.net/yangxuan0261/article/details/54766955
RPC:http://blog.csdn.net/yangxuan0261/article/details/54766955