Navigation
API > API/Plugins > API/Plugins/DMXRuntime
Represents an Entity from a DMX Library. Used to allow objects outside the DMX Library package to store references to UDMXEntity objects
| Name | FDMXEntityReference |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/Library/DMXEntityReference.h |
| Include Path | #include "Library/DMXEntityReference.h" |
Syntax
USTRUCT (Meta=(DisplayName="DMX Entity Reference"))
struct FDMXEntityReference
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Construct with invalid values by default | Library/DMXEntityReference.h | ||
FDMXEntityReference
(
UDMXEntity* InEntity |
Construct as a reference to an existing Entity and its type as EntityType | Library/DMXEntityReference.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDisplayLibraryPicker | bool | Display the DMX Library asset picker. True by default, for Blueprint variables | Library/DMXEntityReference.h | |
| DMXLibrary | TObjectPtr< UDMXLibrary > | The parent DMX library of the Entity Automatically set when calling SetEntity with a valid Entity. | Library/DMXEntityReference.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CachedEntity | TWeakObjectPtr< UDMXEntity > | Cached value this entity stands for, to speed up access instead of looking it up from the library array | Library/DMXEntityReference.h | |
| EntityId | FGuid | The entity's unique ID | Library/DMXEntityReference.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UDMXEntity * GetEntity() |
Get the Entity referenced by this struct or nullptr if none was set. | Library/DMXEntityReference.h | |
TSubclassOf< UDMXEntity > GetEntityType() |
Get the type of entity this reference points to | Library/DMXEntityReference.h | |
void SetEntity
(
UDMXEntity* NewEntity |
Set the Entity and DMX Library this struct represents | Library/DMXEntityReference.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FDMXEntityReference& Other |
Library/DMXEntityReference.h | ||
bool operator==
(
const FDMXEntityReference& Other |
Comparison operators | Library/DMXEntityReference.h |