unreal.DMXFixtureFunction

class unreal.DMXFixtureFunction(attribute: DMXAttributeName = [], function_name: str = '', description: str = '', default_value: int = 0, channel: int = 0, data_type: DMXFixtureSignalFormat = Ellipsis, use_lsb_mode: bool = False)

Bases: 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 (use editor above to make changes)

  • channel_offset (int32): [Read-Write] deprecated: Deprecated, instead please refer to the Channel property.

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

  • default_value (int64): [Read-Write] The Default DMX Value of the function

  • description (str): [Read-Write]

  • function_name (str): [Read-Write]

  • physical_default_value (double): [Read-Write] The Physical Value used by default, based on the Physical Unit

  • physical_from (double): [Read-Write] The starting value of the Physical Value range, based on the Physical Unit

  • physical_to (double): [Read-Write] The ending value of the Physical Value range, based on the Physical Unit

  • physical_unit (DMXGDTFPhysicalUnit): [Read-Write] The Physical Unit this Physical Value is based on

  • 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 (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: 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

Type:

(DMXAttributeName)

property channel: int

[Read-Only] This function’s starting channel (use editor above to make changes)

Type:

(int32)

property channel_offset: int

[Read-Write] deprecated: Deprecated, instead please refer to the Channel property.

Type:

(int32)

property data_type: DMXFixtureSignalFormat

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

Type:

(DMXFixtureSignalFormat)

property default_value: int

[Read-Write] The Default DMX Value of the function

Type:

(int64)

property description: str

[Read-Write]

Type:

(str)

property function_name: str

[Read-Write]

Type:

(str)

property 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 (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)