unreal.DMXFixtureFunction

class unreal.DMXFixtureFunction(attribute=[], function_name='', description='', default_value=0, channel=1, 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] Attribute: 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] Channel: This function’s starting channel (use editor above to make changes)

  • channel_offset (int32): [Read-Write] Channel Offset: DEPRECATED 5.0. Instead the ‘Channel’ property is EditAnywhere so any function can be assigned freely deprecated: Deprecated since the Channel property can be set in the DMX Library Editor.

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

  • default_value (int64): [Read-Write] Default Value: The Default Value of the function, imported from GDTF. The plugin doesn’t make use of this value, but it can be used in blueprints

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

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

  • use_lsb_mode (bool): [Read-Write] Use LSBMode: 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 (endianness).

    E.g., given a 16 bit function with two channel values set to [0, 1], they would be interpreted as the binary number 0x01 0x00, 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 0x00 0x01, which means 1. The first byte (0) became the highest part in binary form and the following byte (1), the lowest.

property attribute

[Read-Write] Attribute: 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] Channel: This function’s starting channel (use editor above to make changes)

Type

(int32)

property channel_offset

[Read-Write] Channel Offset: DEPRECATED 5.0. Instead the ‘Channel’ property is EditAnywhere so any function can be assigned freely deprecated: Deprecated since the Channel property can be set in the DMX Library Editor.

Type

(int32)

property data_type

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

Type

(DMXFixtureSignalFormat)

property default_value

[Read-Write] Default Value: The Default Value of the function, imported from GDTF. The plugin doesn’t make use of this value, but it can be used in blueprints

Type

(int64)

property description

[Read-Write] Description

Type

(str)

property function_name

[Read-Write] Function Name

Type

(str)

property use_lsb_mode

[Read-Write] Use LSBMode: 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 (endianness).

E.g., given a 16 bit function with two channel values set to [0, 1], they would be interpreted as the binary number 0x01 0x00, 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 0x00 0x01, which means 1. The first byte (0) became the highest part in binary form and the following byte (1), the lowest.

Type

(bool)