Components and net options¶
How do I replicate components and tune actor replication?
Replicated components¶
Two ways:
- A
@ue.uclassue.ActorComponentwith replicated properties or remote functions replicates by default, so adding it to a replicating actor is enough. ue.component(cls, replicated=True)marks a default component of an actor class as replicated, for engine components too. The actor class then replicates even without replicated properties. For a@ue.scriptBlueprint component, tick "Component Replicates" in the editor.
@ue.uclass
class Ammo(ue.ActorComponent):
count: int = ue.uproperty(30, rep_notify="on_rep_count")
def on_rep_count(self) -> None: ...
@ue.uclass(always_relevant=True, net_update_frequency=30.0, net_cull_distance=8000.0, replicate_movement=True)
class Crate(ue.Actor):
ammo = ue.component(Ammo) # replicates with the crate
beacon = ue.component(ue.PointLightComponent, replicated=True)
Net options¶
@ue.uclass takes class defaults for an actor's replication properties. They apply to the CDO and every instance,
Blueprint subclasses included.
| Option | Actor property |
|---|---|
always_relevant |
bAlwaysRelevant |
only_relevant_to_owner |
bOnlyRelevantToOwner |
net_update_frequency, min_net_update_frequency |
NetUpdateFrequency, MinNetUpdateFrequency (updates per second, positive) |
net_cull_distance |
NetCullDistanceSquared, set to the square of the distance |
replicate_movement |
bReplicateMovement |
net_load_on_client |
bNetLoadOnClient |
Non-actor classes reject them (TypeError), as do wrong types. Out-of-range numbers, or a
min_net_update_frequency above net_update_frequency, raise ValueError. Setting the same property both as a
net option and as a class-body assignment is a TypeError.