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

> Unreal Engine API Reference > Plugins > DMXRuntime > Library > UDMXEntity

Light Theme

Dark Theme

UDMXEntity

Base class for all entity types

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UDMXObjectBase

UDMXEntity

UDMXEntityFixturePatch

UDMXEntityFixtureType

UDMXEntityUniverseManaged

UDMXEntityController

References

Module	DMXRuntime
Header	/Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/Library/DMXEntity.h
Include	#include "Library/DMXEntity.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, Meta=(DisplayName="DMX Entity"))
class UDMXEntity : public UDMXObjectBase

Remarks

Base class for all entity types

Variables

	Name	Description
FGuid	Id	Uniquely identifies the parameter, used for fixing up Blueprints that reference this Entity when renaming.
FString	Name
TWeakObjectPtr<...	ParentLibrary

Constructors

	Name	Description
	UDMXEntity()

Functions

	Name	Description
FString	GetDisplayName()	Returns the entity name to be used in UI elements
const FGuid ...	GetID()	This Entity's unique ID
UDMXLibrary ...	GetParentLibrary()
bool	IsValidEntity()	Checks for Entity correctness for usability with protocols.
bool	IsValidEntity ( FText& OutReason )	Checks for Entity correctness for usability with protocols.
void	RefreshID()	Used by DMX Library to resolve ID conflicts among entities
void	ReplicateID ( UDMXEntity* Other )	Copy another Entity's ID. Used when copying, to not lose the original Entity's reference
void	SetName ( const FString& InNewName )	Updates this Entity's name and the UI friendly display name
void	SetParentLibrary ( UDMXLibrary* InParent )

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

Take our survey

Dismiss