unreal.LODSyncComponent

class unreal.LODSyncComponent(outer: Object | None = None, name: Name | str = 'None')

Bases: ActorComponent

Implement an Actor component for LOD Sync of different components

This is a component that allows multiple different components to sync together of their LOD

This allows to find the highest LOD of all the parts, and sync to that LOD

C++ Source:

  • Module: Engine

  • File: LODSyncComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_user_data (Array[AssetUserData]): [Read-Write] Array of user data stored with the component

  • asset_user_data_editor_only (Array[AssetUserData]): [Read-Write] Array of user data stored with the component

  • auto_activate (bool): [Read-Write] Whether the component is activated at creation or must be explicitly activated.

  • can_ever_affect_navigation (bool): [Read-Write] Whether this component can potentially influence navigation

  • component_tags (Array[Name]): [Read-Write] Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

  • components_to_sync (Array[ComponentSync]): [Read-Write] Array of components whose LOD may drive or be driven by this component. Components that are flagged as ‘Drive’ are treated as being in priority order, with the last component having highest priority. The highest priority visible component will set the LOD for all other components. If no components are visible, then the highest priority non-visible component will set LOD.

  • custom_lod_mapping (Map[Name, LODMappingData]): [Read-Write] by default, the mapping will be one to one but if you want custom, add here.

  • editable_when_inherited (bool): [Read-Write] True if this component can be modified when it was inherited from a parent actor class

  • forced_lod (int32): [Read-Write] if -1, it’s automatically switching

  • is_editor_only (bool): [Read-Write] If true, the component will be excluded from non-editor builds

  • min_lod (int32): [Read-Write] Minimum LOD to use when syncing components

  • num_lo_ds (int32): [Read-Write] if -1, it’s default and it will calculate the max number of LODs from all sub components if not, it is a number of LODs (not the max index of LODs)

  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] Called when the component has been activated, with parameter indicating if it was from a reset

  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] Called when the component has been deactivated

  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Main tick function for the Component

  • replicate_using_registered_sub_object_list (bool): [Read-Write] When true the replication system will only replicate the registered subobjects list When false the replication system will instead call the virtual ReplicateSubObjects() function where the subobjects need to be manually replicated.

  • replicates (bool): [Read-Write] Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

property components_to_sync: None

[Read-Write] Array of components whose LOD may drive or be driven by this component. Components that are flagged as ‘Drive’ are treated as being in priority order, with the last component having highest priority. The highest priority visible component will set the LOD for all other components. If no components are visible, then the highest priority non-visible component will set LOD.

Type:

(Array[ComponentSync])

property custom_lod_mapping: None

[Read-Write] by default, the mapping will be one to one but if you want custom, add here.

Type:

(Map[Name, LODMappingData])

property forced_lod: int

[Read-Write] if -1, it’s automatically switching

Type:

(int32)

get_lod_sync_debug_text() → str

Returns a string detailing

Return type:

str

property min_lod: int

[Read-Write] Minimum LOD to use when syncing components

Type:

(int32)

property num_lo_ds: int

[Read-Write] if -1, it’s default and it will calculate the max number of LODs from all sub components if not, it is a number of LODs (not the max index of LODs)

Type:

(int32)