unreal.DMXComponent
¶
- class unreal.DMXComponent(outer=None, name='None')¶
Bases:
unreal.ActorComponent
Component that receives DMX input each Tick from a fixture patch. NOTE: Does not support receive in Editor! Use the ‘Get DMX Fixture Patch’ and bind ‘On Fixture Patch Received DMX’ instead (requires the patch to be set to ‘Receive DMX in Editor’ in the library).
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] Asset User Data: Array of user data stored with the componentauto_activate
(bool): [Read-Write] Auto Activate: Whether the component is activated at creation or must be explicitly activated.can_ever_affect_navigation
(bool): [Read-Write] Can Ever Affect Navigation: Whether this component can potentially influence navigationcomponent_tags
(Array(Name)): [Read-Write] Component Tags: Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.editable_when_inherited
(bool): [Read-Write] Editable when Inherited: 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] Is Editor Only: If true, the component will be excluded from non-editor buildson_component_activated
(ActorComponentActivatedSignature): [Read-Write] On Component Activated: Called when the component has been activated, with parameter indicating if it was from a reseton_component_deactivated
(ActorComponentDeactivateSignature): [Read-Write] On Component Deactivated: Called when the component has been deactivatedon_fixture_patch_received
(DMXComponentFixturePatchReceivedSignature): [Read-Write] On Fixture Patch Received: Broadcast when the component’s fixture patch received DMXprimary_component_tick
(ActorComponentTickFunction): [Read-Write] Primary Component Tick: Main tick function for the Componentreceive_dmx_from_patch
(bool): [Read-Write] Receive DMXFrom Patch: If true, the component will receive DMX from the patchreplicates
(bool): [Read-Write] Replicates: Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!
- property fixture_patch_ref¶
[Read-Only] Fixture Patch Ref
- Type
- get_fixture_patch() DMXEntityFixturePatch ¶
Gets the fixture patch used in the component
- Return type
- property on_fixture_patch_received¶
[Read-Write] On Fixture Patch Received: Broadcast when the component’s fixture patch received DMX
- property receive_dmx_from_patch¶
[Read-Only] Receive DMXFrom Patch: If true, the component will receive DMX from the patch
- Type
(bool)
- set_fixture_patch(fixture_patch) None ¶
Sets the fixture patch used in the component
- Parameters
fixture_patch (DMXEntityFixturePatch) –