Navigation
Unreal Engine C++ API Reference > Plugins > DMXRuntime > Library
Inheritance Hierarchy
- FDMXEntityReference
- FDMXEntityControllerRef
- FDMXEntityFixturePatchRef
- FDMXEntityFixtureTypeRef
References
| Module | DMXRuntime |
| Header | /Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/Library/DMXEntityReference.h |
| Include | #include "Library/DMXEntityReference.h" |
Syntax
USTRUCT&40;Meta&61;&40;DisplayName&61;"DMX Entity Reference"&41;&41;
struct FDMXEntityReference
Remarks
Represents an Entity from a DMX Library. Used to allow objects outside the DMX Library package to store references to UDMXEntity objects
Variables
| Type | Name | Description | |
|---|---|---|---|
  |
bool | bDisplayLibraryPicker | Display the DMX Library asset picker. True by default, for Blueprint variables |
   |
TObjectPtr< UDMXLibrary > | DMXLibrary | The parent DMX library of the Entity Automatically set when calling SetEntity with a valid Entity. |
  |
TSubclassOf< UDMXEntity > | EntityType |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Construct with invalid values by default | ||
 |
FDMXEntityReference
(
UDMXEntity* InEntity |
Construct as a reference to an existing Entity and its type as EntityType |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
UDMXEntity * | GetEntity () |
Get the Entity referenced by this struct or nullptr if none was set. |
  |
TSubclassOf< UDMXEntity > | Get the type of entity this reference points to | |
 |
void | SetEntity
(
UDMXEntity* NewEntity |
Set the Entity and DMX Library this struct represents |
Operators
| Type | Name | Description | |
|---|---|---|---|
  |
bool | operator!=
(
const FDMXEntityReference& Other |
|
  |
bool | operator==
(
const FDMXEntityReference& Other |
Comparison operators |