unreal.DMXEntityFixtureType

class unreal.DMXEntityFixtureType(outer: Object | None = None, name: Name | str = 'None')

Bases: DMXEntity

Class to describe a type of Fixture. Fixture Patches can be created from Fixture Types (see UDMXEntityFixturePatch::ParentFixtureTypeTemplate).

C++ Source:

  • Plugin: DMXEngine

  • Module: DMXRuntime

  • File: DMXEntityFixtureType.h

Editor Properties: (see get_editor_property/set_editor_property)

  • actor_class_to_spawn (Class): [Read-Write] The Actor Class that is spawned when the DMX Library dropped onto a Level. Only Actors that implement the MVR Fixture Actor Interface can be used.

    Can be left blank. If so, any Actor Class with the most matching Attributes will be spawned.

  • dmx_category (DMXFixtureCategory): [Read-Write] The Category of the Fixture, useful for Filtering

  • dmx_import (DMXImport): [Read-Write] deprecated: Changed to a soft object pointer to reduce the memory footprint of Fixture Types. Please use GDTF Source instead.

  • export_generated_gdtf (bool): [Read-Write] If checked, generates a new GDTF instead of exporting the imported GDTF. This adopts changes in editor but in most cases will result in data loss and is not recommended.

  • fixture_matrix_enabled (bool): [Read-Write] deprecated: FixtureMatrixEnabled is deprecated. Instead now each Mode has a FixtureMatrixEnabled property.

  • gdtf_source (DMXImportGDTF): [Read-Write] The GDTF that initializes this Fixture Type. When changed, reinitializes with data from the GDTF.

  • input_modulators (Array[DMXModulator]): [Read-Write] Modulators applied right before a patch of this type is received. NOTE: Modulators only affect the patch’s normalized values! Untouched values are still available when accesing raw values.

  • modes (Array[DMXFixtureMode]): [Read-Write]

  • name (str): [Read-Write]

classmethod create_fixture_type_in_library(construction_params, desired_name='', mark_dmx_library_dirty=True) → DMXEntityFixtureType

Creates a new Fixture Type in the DMX Library

Parameters:
Return type:

DMXEntityFixtureType

property dmx_category: DMXFixtureCategory

[Read-Only] The Category of the Fixture, useful for Filtering

Type:

(DMXFixtureCategory)

property dmx_import: DMXImport

[Read-Only] deprecated: Changed to a soft object pointer to reduce the memory footprint of Fixture Types. Please use GDTF Source instead.

Type:

(DMXImport)

property fixture_matrix_enabled: bool

[Read-Write] deprecated: FixtureMatrixEnabled is deprecated. Instead now each Mode has a FixtureMatrixEnabled property.

Type:

(bool)

property gdtf_source: DMXImportGDTF

[Read-Only] The GDTF that initializes this Fixture Type. When changed, reinitializes with data from the GDTF.

Type:

(DMXImportGDTF)

property modes: None

[Read-Only]

Type:

(Array[DMXFixtureMode])

classmethod remove_fixture_type_from_library(fixture_type_ref) → None

Removes a Fixture Type from a DMX Library

Parameters:

fixture_type_ref (DMXEntityFixtureTypeRef)

set_modes_from_dmx_import(dmx_import_asset) → None

Set Modes from DMXImport deprecated: Setting GDTFs from blueprints was never fully supported and now deprecated. Instead please refer to the Create Fixture Type In DMX Library function.

Parameters:

dmx_import_asset (DMXImport)