『FOAMSTARS』のインゲームにおけるサーバー/クライアントのプレイヤー同期管理システムについて

// [サーバー限定]: プレイヤーがサーバーに参加した
AMyGameMode::PostLogin(APlayerController* LoginPlayerController){
     /* なにか高潔な参加時処理 */
}

// [サーバー・クライアント]: 毎フレーム参加プレイヤーに処理を施す
void AMyGameState::PlayerUpdate(float DeltaSec){
    for(int32 i = 0; i < PlayerArray.Num(); ++i){
      AMyPlayerState* PlState = Cast<AMyPlayerState>(PlayerArray[i]);
      if(IsValid(PlState)){
          // サーバー上
          if(HasAuthority()){
                /* サーバー上で何か魅力的で独創的な、サーバー上プレイヤーデータに対する処理 */
          }
          // クライアント上
          else{
             /* クライアント側で何か冒涜的な、クライント上プレイヤーデータに対する処理 */
          }
     }
   }
}

// サーバーから呼び出され、クライアント上で実行されるRPC関数として初期化を定義
// 大事なRPC通信なので「Reliable」をつけて、何があっても届くように圧をかけておく
UFUNCTION(Client,Reliable)
void ClientRPC_InitJoinedLobbyPlayerOnClient(const FLobbyInfo& ServerLobbyInfo);

void ALobbyPlayerController::ClientRPC_InitJoinedLobbyPlayerOnClient_Implementaion(const FLobbyInfo& ServerLobbyInfo){
    /* なにかハイセンスな初期化処理 */
}

// プレイヤーがサーバーに参加した
ALobbyGameMode::PostLogin(APlayerController* LoginPlayerController){
    ALobbyPlayerController* LobbyController = Cast<ALobbyPlayerController>(LoginPlayerController);
    if(IsValid(LobbyController)){
        // サーバーロビー状態を引数で渡してRPC（Client）でクライアント上で初期化
        LobbyController->ClientRPC_InitJoinedLobbyPlayerOnClient(ServerLobbyInfo);  
   }
}

UPROPERTY(Replicated)
int32 LobbyPlayerIDAtServer{ -1 };

int32 LocalPlayerUniqueID{ -1 };

//エンジンのBeginPlay
void ALobbyPlayerController::BeginPlay(){
    Super::BeginPlay(); 
    // サーバーではサーバー上でのIDとして設定しレプリケーションで同期する
    if(HasAuthority()){
      LobbyPlayerIDAtServer = FStaticGameUtil::MakeServerUniqueIDHash(this);
    }
    // ローカル上での初期化をしておく
   InitOnLocal();
}
//ローカル上での初期化
void ALobbyPlayerController::InitOnLocal(){
    // ローカル上でのみ使用するPlayerIDをハッシュ値で作成しておく
    LocalPlayerUniqueID = FStaticGameUtil::MakeLocalUniqueIDHash(this);

    /* その他、ロビーで使う様々な項目に対する華麗な初期化コードが並んでいる光景を想像してください */
}
// [RPC/Client] サーバーから呼び出され、クライアント上で実行されるRPC関数として初期化を定義
void ALobbyPlayerController::ClientRPC_InitJoinedLobbyPlayerOnClient_Implementaion(){
    // ローカルのプレイヤーシステムの参照をとっておく
   ALocalPlayerManager* LocalPlayerManager = FStaticGameUtil::GetLocalPlayerManager();
   // InitOnLocalで作成済みのPlayerを登録する。
   LocalPlayerManager->RegisterLocalPlayer(LobbyPlayerIDAtServer,LocalPlayerUniqueID,this);
}

void ALobbyGameState::MakeLocalManager(){
      ALocalPlayerManager* LocalPlayerManager  = SpawnLocalManager<ALocalPlayerManager>();
}

// CSNotify（Client-State-Notify）
UENUM(BlueprintType)
EClientStateNotifyID : uint8{
    READY_LOCAL_MANAGERS,            // クライアント上で各種マネージャーシステムが同期・使用できる
    REPLICATED_PLAYER_PARAMS,     // クライアント上にプレイヤーの同期パラメーターがレプリケーションされた
    CALLED_PLAYER_BEGIN_PLAY,      // クライアント上でプレイヤーのBeginPlayが呼ばれた
};

// CSNotifyの送信
UFUNCTION(Server,Reliable)
void ServerRPC_SendCSNotify(EClientStateNotifyID NotifyID);

void ServerRPC_SendCSNotify_Implementaion(EClientStateNotifyID NotifyID){
    ALobbyGameMode* LobbyMode = GetWorld()->GetAuthGameMode<ALobbyGameMode>();
    if(IsValid(LobbyMode)){
         LobbyMode->RecvCSNotify(this,NotifyID);
    }
}

 // 受信したCSNotifyを保存しておくMap
 TMap<int32,TArray<EClientStateNotifyID>> ServerRecvCSNotifyMap;

// CSNotifyの受信
void RecvCSNotify(LobbyPlayerController* Sender,EClientStateNotifyID NotifyID){
    if(IsValid(Sender)){
       // 受信リストに積む
　    ServerRecvCSNotifyMap[Sender->GetUniqueID()].Add(NotifyID);
       // 受信の種類によってなにか処理をする場合
       switch(NotifyID){
           /* それぞれのCFNotifyに対する処理 */
       };
    }
}

UFUNCTION()
void OnRep_LobbyPlayerIDAtServer();

UPROPERTY(ReplicatedUsing="OnRep_LobbyPlayerIDAtServer")
int32 LobbyPlayerIDAtServer{ -1 };

void ALobbyPlayerController::BeginPlay(){
    /* 先ほどの処理のまま... */

    // 対応するCSNotifyを送信
    ServerRPC_SendCSNotify(EClientStateNotifyID::CALLED_PLAYER_BEGIN_PLAY);
}
// [ReplicateCallback]: PlayerIDが更新されたことをクライアント側で受信する
void ALobbyPlayerController::OnRep_LobbyPlayerIDAtServer(){
     // 対応するCSNotifyを送信
     ServerRPC_SendCSNotify(EClientStateNotifyID::REPLICATED_PLAYER_PARAMS);
}

void ALobbyGameState::MakeLocalManager(){
      ALocalPlayerManager* LocalPlayerManager  = SpawnLocalManager<ALocalPlayerManager>();

    // 対応するCSNotifyを送信
    ServerRPC_SendCSNotify(EClientStateNotifyID::READY_LOCAL_MANAGERS);
}

ALobbyGameMode::PostLogin(APlayerController* LoginPlayerController){
     // ログイン時は枠だけ確保
     ServerRecvCSNotifyMap.Emplace(LoginPlayerController->GetUniqueID(),TArray<EClientStateNotifyID>());
}
void RecvCSNotify(LobbyPlayerController* Sender,EClientStateNotifyID NotifyID){
     /* 先ほどの処理のまま... */
    int32 PlayerID = Sender->GetUniqueID();

    // 必要なCFNOtifyがすべてそろったらようやく「クライアントは準備完了」とみなす
    if(CheckCSNotifyRecv(ServerRecvCSNotifyMap[PlayerID]) == EClientStateNotifyID::READY_LOCAL_MANAGERS
     && CheckCSNotifyRecv(ServerRecvCSNotifyMap[PlayerID]) == EClientStateNotifyID::CALLED_PLAYER_BEGIN_PLAY
     && CheckCSNotifyRecv(ServerRecvCSNotifyMap[PlayerID]) == EClientStateNotifyID::REPLICATED_PLAYER_PARAMS
   ){
        // サーバーロビー状態を引数で渡してRPC（Client）でクライアント上で初期化
        Sender->ClientRPC_InitJoinedLobbyPlayerOnClient(ServerLobbyInfo);  
   }
}

struct FRecvCSNotifyData{
    EClientStateNotifyID NotifyID{ };
    float RecvTimeSec{ 0.0f }; // 受信時間
}