RealDocs

UActorComponent::RegisterReplicationFragments

function Engine Since 5.1
#include "Components/ActorComponent.h"
Access: public Specifiers: virtualoverride

Description

Registers the component's replicated properties as Iris replication fragments. Called by the Iris networking subsystem during replication initialisation — do not call manually.

Caveats & Gotchas

  • This is an Iris-specific override; it has no effect when the project is using the legacy networking stack (bUseIris=false in project settings). Both stacks can coexist during migration.
  • Always call Super::RegisterReplicationFragments when overriding — the base implementation registers the standard UActorComponent properties and skipping it can cause them to stop replicating.

Signature

ENGINE_API virtual void RegisterReplicationFragments(UE::Net::FFragmentRegistrationContext& Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags) override

Parameters

Name Type Description Default
Context UE::Net::FFragmentRegistrationContext& Context used to register replication fragments with the Iris replication system.
RegistrationFlags UE::Net::EFragmentRegistrationFlags Flags controlling how fragments are registered.

Return Type

void

Example

Register additional Iris fragments in a subclass C++
void UMyComponent::RegisterReplicationFragments(
	UE::Net::FFragmentRegistrationContext& Context,
	UE::Net::EFragmentRegistrationFlags RegistrationFlags)
{
	Super::RegisterReplicationFragments(Context, RegistrationFlags);
	// Register custom property fragments here if needed
}

Version History

Introduced in: 5.1

Version Status Notes
5.6 stable

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.