UDMXEntity | Unreal Engine 5.6 Documentation

Base class for all entity types


Name	UDMXEntity
Type	class
Header File	/Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/Library/DMXEntity.h
Include Path	#include "Library/DMXEntity.h"

Syntax

UCLASS (Abstract, Meta=(DisplayName="DMX Entity"))  
class UDMXEntity : public UDMXObjectBase

Name	Remarks	Include Path	Unreal Specifiers
UDMXEntity ()	Constructor, for default objects only	Library/DMXEntity.h
UDMXEntity ( UDMXLibrary* InParentLibrary )	Constructor that specifies the outer Library	Library/DMXEntity.h

Name	Type	Remarks	Include Path	Unreal Specifiers
Name	FString		Library/DMXEntity.h	EditAnywhere BlueprintReadOnly Category="Entity Properties" Meta=(DisplayName="Name", DisplayPriority="1")

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

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostInitProperties()		Library/DMXEntity.h