unreal.DMXFixtureFunction

class unreal.DMXFixtureFunction(attribute=[], function_name='', description='', default_value=0, channel=1, channel_offset=0, data_type=DMXFixtureSignalFormat.E8_BIT, use_lsb_mode=False)

Bases: unreal.StructBase

DMXFixture Function

C++ Source:

• Plugin: DMXEngine

• Module: DMXRuntime

• File: DMXEntityFixtureType.h

Editor Properties: (see get_editor_property/set_editor_property)

• attribute (DMXAttributeName): [Read-Write] The Attribute name to map this Function to. This is used to easily find the Function in Blueprints, using an Attribute list instead of typing the Function name directly. The list of Attributes can be edited on Project Settings->Plugins->DMX Protocol->Fixture Settings->Fixture Function Attributes

• channel (int32): [Read-Only] This function’s starting channel

• channel_offset (int32): [Read-Write] This function’s channel offset. E.g.: if the function’s starting channel is supposed to be 10 and ChannelOffset = 5, the function’s starting channel becomes 15 and all following functions follow it accordingly.

• data_type (DMXFixtureSignalFormat): [Read-Write] This function’s data type. Defines the used number of channels (bytes)

• default_value (int64): [Read-Write] Initial value for this function when no value is set

• description (str): [Read-Write] Description

• function_name (str): [Read-Write] Function Name

• use_lsb_mode (bool): [Read-Write] Least Significant Byte mode makes the individual bytes (channels) of the function be interpreted with the first bytes being the lowest part of the number.

  E.g., given a 16 bit function with two channel values set to [0, 1], they would be interpreted as the binary number 00000001 00000000, which means 256. The first byte (0) became the lowest part in binary form and the following byte (1), the highest.

  Most Fixtures use MSB (Most Significant Byte) mode, which interprets bytes as highest first. In MSB mode, the example above would be interpreted in binary as 00000000 00000001, which means 1. The first byte (0) became the highest part in binary form and the following byte (1), the lowest.

property attribute

[Read-Only] The Attribute name to map this Function to. This is used to easily find the Function in Blueprints, using an Attribute list instead of typing the Function name directly. The list of Attributes can be edited on Project Settings->Plugins->DMX Protocol->Fixture Settings->Fixture Function Attributes

Type

(DMXAttributeName)

property channel

[Read-Only] This function’s starting channel

Type

(int32)

property channel_offset

[Read-Only] This function’s channel offset. E.g.: if the function’s starting channel is supposed to be 10 and ChannelOffset = 5, the function’s starting channel becomes 15 and all following functions follow it accordingly.

Type

(int32)

property data_type

[Read-Only] This function’s data type. Defines the used number of channels (bytes)

Type

(DMXFixtureSignalFormat)

property default_value

[Read-Only] Initial value for this function when no value is set

Type

(int64)

property description

[Read-Only] Description

Type

(str)

property function_name

[Read-Only] Function Name

Type

(str)

property use_lsb_mode

[Read-Only] Least Significant Byte mode makes the individual bytes (channels) of the function be interpreted with the first bytes being the lowest part of the number.

E.g., given a 16 bit function with two channel values set to [0, 1], they would be interpreted as the binary number 00000001 00000000, which means 256. The first byte (0) became the lowest part in binary form and the following byte (1), the highest.

Most Fixtures use MSB (Most Significant Byte) mode, which interprets bytes as highest first. In MSB mode, the example above would be interpreted in binary as 00000000 00000001, which means 1. The first byte (0) became the highest part in binary form and the following byte (1), the lowest.

Type

(bool)