Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erlite/networktimesync
A simple Unreal Engine subsystem to provide a more accurate server world time to clients.
https://github.com/erlite/networktimesync
Last synced: about 5 hours ago
JSON representation
A simple Unreal Engine subsystem to provide a more accurate server world time to clients.
- Host: GitHub
- URL: https://github.com/erlite/networktimesync
- Owner: Erlite
- License: mit
- Created: 2022-05-20T15:21:39.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-03-27T23:12:57.000Z (over 1 year ago)
- Last Synced: 2024-08-03T01:15:31.335Z (3 months ago)
- Language: C++
- Size: 30.3 KB
- Stars: 16
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.MD
- License: LICENSE.txt
Awesome Lists containing this project
README
# NetworkTimeSync
A simple C++ (and Blueprint compatible) plugin that aims to provide a more accurate server world time to clients.
## Installation
Simply place the contents of this repository in a `Plugins/NetworkTimeSync/` folder of your project.
You must then enable the plugin in your Project Settings, and in your `ProjectName.Build.cs` file.
```cs
PublicDependencyModuleNames.Add("NetworkTimeSync");
```
Once compiled and enabled, simply add the `UNetworkTimeSyncComponent` to your Player Controller. This component will be in charge of synchronizing network time, every 10 seconds by default.
## Usage
The `NetworkTimeSubsystem` is a GameInstance subsystem, which will contain the latest server world time.
You can access it in C++ via the GameInstance, or by using the static provided:
```cpp
// via the GameInstance
if (UGameInstance* GI = GetWorld()->GetGameInstance())
{
UNetworkTimeSubsystem* NetworkTime = GI->GetSubsystem();
const float ServerTime = NetworkTime->GetServerWorldTime();
}
// or, you can use the static with a world context object.
UNetworkTimeSubsystem* NetworkTime = UNetworkTimeSubsystem::Get(this);
// May return null with an invalid world context object.
if (NetworkTime)
{
const float ServerTime = NetworkTime->GetServerWorldTime();
}
```
For Blueprints, you can simply access it via the generated node:
All you have to do is replace any calls to the GameState's `GetServerWorldTimeSeconds()` function with this one.
## Configuration
You can configure the synchronization interval in your Project Settings.
By default, it will reliably synchronize every ten seconds. You may want to increase or decrease that interval based on your preference.
> Warning: if you decrease the interval for it to synchronize very often, enable `Use Unreliable RPCs` to avoid saturating your bandwidth with RPCs.
