unreal.DMXFixtureComponentDouble

class unreal.DMXFixtureComponentDouble(outer=None, name='None')

Bases: unreal.DMXFixtureComponent

Component that uses 2 DMX channels

C++ Source:

  • Plugin: DMXFixtures

  • Module: DMXFixtures

  • File: DMXFixtureComponentDouble.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 component

  • auto_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 navigation

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

  • dmx_channel1 (DMXChannelData): [Read-Write] DMXChannel 1: The first dmx attribute the component handles

  • dmx_channel2 (DMXChannelData): [Read-Write] DMXChannel 2: The second dmx attribute the component handles

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

  • interpolation_scale (float): [Read-Write] Interpolation Scale: The scale of the interpolation speed. Faster when > 1, slower when < 1

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

  • is_enabled (bool): [Read-Write] Is Enabled: If used within a DMX Fixture Actor or Fixture Matrix Actor, the component only receives data when set to true. Else needs be implemented in blueprints.

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

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

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

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

  • skip_threshold (float): [Read-Write] Skip Threshold: Value changes smaller than this threshold are ignored

  • use_interpolation (bool): [Read-Write] Use Interpolation: If used within a DMX Fixture Actor or Fixture Matrix Actor, the plugin interpolates towards the last set value.

property dmx_channel1

[Read-Only] DMXChannel 1: The first dmx attribute the component handles

Type

(DMXChannelData)

property dmx_channel2

[Read-Only] DMXChannel 2: The second dmx attribute the component handles

Type

(DMXChannelData)

dmx_interpolated_step(channel_index)

deprecated: ‘dmx_interpolated_step’ was renamed to ‘get_dmx_interpolated_step’.

dmx_interpolated_value(channel_index)

deprecated: ‘dmx_interpolated_value’ was renamed to ‘get_dmx_interpolated_value’.

dmx_is_interpolation_done(channel_index)

deprecated: ‘dmx_is_interpolation_done’ was renamed to ‘is_dmx_interpolation_done’.

dmx_target_value(channel_index)

deprecated: ‘dmx_target_value’ was renamed to ‘get_dmx_target_value’.

get_dmx_interpolated_step(channel_index) → float

Gets the interpolation delta value (step) for this frame

Parameters

channel_index (int32) –

Return type

float

get_dmx_interpolated_value(channel_index) → float

Gets the current interpolated value

Parameters

channel_index (int32) –

Return type

float

get_dmx_target_value(channel_index) → float

Gets the target value towards which the component interpolates

Parameters

channel_index (int32) –

Return type

float

is_dmx_interpolation_done(channel_index) → bool

True if the target value is reached and no interpolation is required

Parameters

channel_index (int32) –

Return type

bool

set_channel1_value_no_interp(channel1_value) → None

Sets first value of the second channel. When interpolation is enabled this function should be called until the value is reached, else just once */

Parameters

channel1_value (float) –

set_channel2_value_no_interp(channel2_value) → None

Sets second value of the second channel. When interpolation is enabled this function should be called until the value is reached, else just once

Parameters

channel2_value (float) –

set_component_channel1(channel1_value)

deprecated: ‘set_component_channel1’ was renamed to ‘set_channel1_value_no_interp’.

set_component_channel2(channel2_value)

deprecated: ‘set_component_channel2’ was renamed to ‘set_channel2_value_no_interp’.