FNetRootObjectAdapter

Navigation

API > API/Runtime > API/Runtime/Engine

Class that is added by composition to any UObject that wants to be a replicated root object

This class is meant to provide an easy to use solution for quickly transforming any non-actor into an autonomous replicated object. But be aware it is not made to be the optimal solution if you intend to create alot of instances of the class using it. The memory overheaded of the variables in this class could be optimized away entirely if your class directly interacted with the Iris API in a similar way to what the adapter does. So for a more optimal solution, it is recommended to look at this class for inspiration and instead add the minimum necessary features you need to your own base class.

Important: The class that wants to be replicate autonomously must immplement a INetRootObjectFactoryExtension either in the class itself or as a standalone class able to retrieve this adapter and call FillRootObjectReplicationParams on it.

The expectation is then for the class to call at runtime in order:

1) InitAdapter() : Initialize the adapter so it knows who to replicate 2) Configure() : Configure the replication settings prior to starting replication 3) Provide the ULevel the UObject is a part of via SetAttachedLevel() or in StartReplication() 4) StartReplication() or RelevantWith() to add the object to the replication system 5) StopReplication() or RemoveRelevantWith when the object no longer should replicate 6) DeinitAdapter() before the object goes out of existing (optional)

Syntax

class FNetRootObjectAdapter  
Copy full snippet

class FNetRootObjectAdapter

Constructors

Enums

Public

Variables

Protected

Functions

Public