unreal.MultiUserFrequencyChangeRequest
¶
- class unreal.MultiUserFrequencyChangeRequest(overrides_to_remove: None = [], overrides_to_add: None = {}, new_defaults: MultiUserObjectReplicationSettings = Ellipsis, change_defaults: bool = False)¶
Bases:
StructBase
Params for changing how often objects replicate.
All objects default to a global setting that can be changed by setting bChangeDefaults = true and changing NewDefaults to contain the new defaults. Objects can have overrides mutated via OverridesToAdd and OverridesToRemove. Overrides override the default behavior.
C++ Source:
Plugin: MultiUserClient
Module: MultiUserClientLibrary
File: ChangeClientBlueprintParams.h
Editor Properties: (see get_editor_property/set_editor_property)
change_defaults
(bool): [Read-Write] Whether to replace the defaults currently registered on the server with the ones specified in NewDefaults.new_defaults
(MultiUserObjectReplicationSettings): [Read-Write] Set new frequency defaults for all objects that do not have any overrides.overrides_to_add
(Map[SoftObjectPath, MultiUserObjectReplicationSettings]): [Read-Write] Objects for which to add overridesoverrides_to_remove
(Set[SoftObjectPath]): [Read-Write] Objects for which to remove overrides.
- property change_defaults: bool¶
[Read-Write] Whether to replace the defaults currently registered on the server with the ones specified in NewDefaults.
- Type:
(bool)
- property new_defaults: MultiUserObjectReplicationSettings¶
[Read-Write] Set new frequency defaults for all objects that do not have any overrides.