UE Plugin

Player Replication Config Asset

This page explains the settings in a Player Replication Config Asset and COALA's Player Replication System as well as how to create a new instance of the config asset to specify your own custom settings.

Player Replication Config Assets are used inside the "BP_Coala_PlayerRep_Handler_Example" Blueprint and its subtypes.

It is used to specify settings for COALA's Player Replication System and to make it easier to switch between different settings during development.

How to create a New Config Asset

In your project, right-click in your Content Browser and select 'Miscellaneous' and 'Data Asset'.

Inside the following dialog box, select CoalaPlayerReplicationConfig as data asset class.

This will create a new Data Asset and you can open it to edit its settings.

The Settings Explained

The settings available in this Data Asset have matching setters in COALA's Player Replication System (class UCoalaPlayerReplication) and the following explanation also applies to those.

By default, the COALA Player Replication System may trigger a player update in three cases:

  1. When you force an update using the appropriate functions

  2. When the local player moves

  3. When there has been too much time since the last update

For cases 2 and 3, the following two settings control how often an update is sent:

Seconds Between Player Refreshes (Min/Max):

When other players are visible around you, specify the minimum/maximum time between two refreshes.

Seconds Between Player Refreshes When Alone (Min/Max):

When no other players are visible around you, specify the minimum/maximum time between two refreshes.

Default Local Player Visibility:

This is a privacy setting. The position and data of the local player (the user of the device running the app) will only be sent to the COALA servers if this value is not 'Always Invisible.'

If it's set to 'Always Visible', the user's data will always be sent.

If it's set to 'Only Visible when Required,' the user's data will only be sent to other players if the local player is in a zone specified in the COALA Back-end.

Request Distance from Player in Meters (X/Y):

The values X and Y entered in these fields determine the size of the rectangular area around the user inside which other players will be visible.