unreal.DMXComponent
¶
-
class
unreal.
DMXComponent
(outer=None, name='None')¶ Bases:
unreal.ActorComponent
Component that receives DMX input each Tick from a fixture patch. Only useful if updates are required each tick (otherwise use DMX Fixture Patch Ref variable and acess Data on demand from there).
C++ Source:
Plugin: DMXEngine
Module: DMXRuntime
File: DMXComponent.h
Editor Properties: (see get_editor_property/set_editor_property)
asset_user_data
(Array(AssetUserData)): [Read-Write] Array of user data stored with the componentauto_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 navigationcomponent_tags
(Array(Name)): [Read-Write] Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.editable_when_inherited
(bool): [Read-Write] True if this component can be modified when it was inherited from a parent actor classfixture_patch_ref
(DMXEntityFixturePatchRef): [Read-Write] Fixture Patch Refis_editor_only
(bool): [Read-Write] If true, the component will be excluded from non-editor buildson_component_activated
(ActorComponentActivatedSignature): [Read-Write] Called when the component has been activated, with parameter indicating if it was from a reseton_component_deactivated
(ActorComponentDeactivateSignature): [Read-Write] Called when the component has been deactivatedon_fixture_patch_received
(DMXComponentFixturePatchReceivedSignature): [Read-Write] Broadcast when the component’s fixture patch received DMXprimary_component_tick
(ActorComponentTickFunction): [Read-Write] Main tick function for the Componentreplicates
(bool): [Read-Write] Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!
-
get_fixture_patch
() → DMXEntityFixturePatch¶ Get Fixture Patch
- Returns
- Return type
-
property
on_fixture_patch_received
¶ [Read-Write] Broadcast when the component’s fixture patch received DMX
-
set_fixture_patch
(fixture_patch) → None¶ Set Fixture Patch
- Parameters
fixture_patch (DMXEntityFixturePatch) –