delta-proxima-team/ue-module-relatedworld

Module for support separated server maps with replication to the persistent client map

Unreal Engine 4 - Related World module

About

This module will allow you to load several maps on server side of you game and replicate its to a one persistent level on a client side, or use it as a offscreen worlds in a standalone game (you need spawn actor with scene capture component for get render from this world)

Installation

• Clone latest sources into Source/RelatedWorld directory of you project
• Edit {ProjectName}{TargetType}.Target.cs file in Source directory and add next code into {ProjectName}{TargetType}Target function

ExtraModuleNames.AddRange(new string[] { "RelatedWorld" });

• Into {ProjectName}.uproject add next code into Modules section

{
  "Name": "RelatedWorld",
  "Type": "Runtime",
  "LoadingPhase": "Default"
}

• Into Config/DefaultEngine.ini add next code into [/Script/Engine.Engine] section

!NetDriverDefinitions=
NetDriverDefinitions=(DefName="GameNetDriver",DriverClassName="/Script/RelatedWorld.RwIpNetDriver",DriverClassNameFallback="/Script/RelatedWorld.RwIpNetDriver")
+NetDriverDefinitions=(DefName="DemoNetDriver",DriverClassName="/Script/Engine.DemoNetDriver",DriverClassNameFallback="/Script/Engine.DemoNetDriver")

[/Script/RelatedWorld.RwIpNetDriver]
ReplicationDriverClassName="/Script/RelatedWorld.RwReplicationGraphBase"

• Make sure plugin OnlineSubsystemUtils is on
• Make sure plugin ReplicationGraph is on
• Make sure option EnableMultiplayerWorldOriginRebasing is on
• Recompile you project

Notes

• I strongly not recommend use built in replication graph, due it was added only for experimental purpose.

Simple Usage

https://cdn.discordapp.com/attachments/644401603088089119/727580647643807855/2020-06-30_20-44-15.png

Demo Project

https://github.com/Delta-Proxima-Team/UE4-Sample-RelatedWorld

Demo Video

ue-module-relatedworld's Issues

ntdll error in Packaged Build

av error triggering in DECLARE_UFUNCTION_HOOK macro. Need to invisigate.

cleanup code, polish and documentation

WorldOrigin throw Network

For now, if RelatedWorld has origin shift, client received location as global coordinates without shifting. Need implement rebasing before replication to clients, or send origin as addition parameter and make rebase directly on a client side

RepGraph crash on client relogin

[2021.07.04-21.25.17:186][726]LogOutputDevice: Error: Ensure condition failed: IsActorValidForReplication(Actor) [File:W:\UnrealEngine4\Bin\UE_4.26\Engine\Plugins\Runtime\ReplicationGraph\Source\Public\ReplicationGraphTypes.h] [Line: 673]
This obj /Game/ColdFusion/Game.Game:PersistentLevel.ReplicationGraphDebugActor_0 is pending to kill, storing this data will generate stale data in the map.

[Inline Frame] UE4Editor-RelatedWorld.dll!FGlobalActorReplicationInfoMap::Get::__l2::<lambda_5f75b7d6f2636a965926b0ec22bd4d33>::operator()() Line 673	C++
 	UE4Editor-RelatedWorld.dll!FGlobalActorReplicationInfoMap::Get(AActor * const & Actor) Line 673	C++
>	UE4Editor-RelatedWorld.dll!UReplicationGraphNode_GlobalGridSpatialization2D::PrepareForReplication() Line 224	C++

Steps to reproduce:

1. Start dedicated server
2. Connect client
3. Disconnect client
4. Connect client

reproducibility: 100%
Affected versions: 4.26, 4.27

Editor containers and assets

Need to add several Editor only classes for visualization, management and placing

UE-4.26 support

Todo:
Review World Tick
Character Movements
View -> ViewArray

Basic replication graph

Need replace current ReplicationGraph with better one

RelatedWorld::TIck function

Some features, like Scene Capture and async traces are not worked there. Need investigate more deper

Character movement compability

For now characters movements not working properly in multiplayer if Character in a RelatedWord context with applied world translation.

[Issue] NetCullDistance

Need to check how its work with vanila replication driver.

GameplayStatics

GameplayStatics nodes such as GetPlayerPawn do not working while we are in RelatedWorld Context. So we need to implement some wrapper functions to proxing them into real one with right context object

Automatic loading and unloading

Add automatic loading and unloading of related worlds in case there are no players in the world and the world is not marked as permanent

UE-5 support

ToDo:

RelatedWorld BeginPlay without GameMode

Actors registration not fully work without GameMode.
Potential future problem with the AI subsystem

Need to implement workaround or forcing to use GameMode from PersistentWorld with some modification (separate AGameModeBase class?)