Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FDMXEntityReference

Represents an Entity from a DMX Library.

Windows

MacOS

Linux

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](Programming/UnrealArchitecture/Reference/Structs)(Meta=(DisplayName="DMX Entity Reference"))
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

	Name	Description
bool	bDisplayLibraryPicker	Display the DMX Library asset picker. True by default, for Blueprint variables
UDMXLibrary ...	DMXLibrary	The parent DMX library of the Entity Automatically set when calling SetEntity with a valid Entity.
TSubclassOf< UD...	EntityType

Constructors

	Name	Description
	FDMXEntityReference()	Construct with invalid values by default
	FDMXEntityReference ( UDMXEntity* InEntity )	Construct as a reference to an existing Entity and its type as EntityType

Functions

	Name	Description
UDMXEntity &...	GetEntity()	Get the Entity referenced by this struct or nullptr if none was set.
TSubclassOf<...	GetEntityType()	Get the type of entity this reference points to
void	SetEntity ( const UDMXEntity* NewEntity )	Set the Entity and DMX Library this struct represents

Operators

		Name	Description
	bool	operator!= ( const FDMXEntityReference& Other )
	bool	operator== ( const FDMXEntityReference& Other )	Comparison operators

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss