UDMXEntity

Base class for all entity types

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

DMXRuntime

Header

/Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/Library/DMXEntity.h

Include

#include "Library/DMXEntity.h"

Syntax

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

Remarks

Base class for all entity types

Variables

Name Description

Protected variable UProperty duplicatetransient

FGuid

 

Id

Uniquely identifies the parameter, used for fixing up Blueprints that reference this Entity when renaming.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

FString

 

Name

Protected variable UProperty

TWeakObjectPtr<...

 

ParentLibrary

Constructors

Name Description

Public function

UDMXEntity()

Constructor, for default objects only

Public function

UDMXEntity

(
    UDMXLibrary* InParentLibrary
)

Constructor that specifies the outer Library

Functions

Name Description

Public function

void

 

Destroy()

Destroys the Entity

Public function Const

FString

 

GetDisplayName()

Returns the entity name to be used in UI elements

Public function Const

const FGuid ...

 

GetID()

This Entity's unique ID

Public function Const

UDMXLibrary ...

 

GetParentLibrary()

Gets the library the Entity resides in

Public function Virtual Const

bool

 

IsValidEntity()

Checks for Entity correctness for usability with protocols.

Public function Virtual Const

bool

 

IsValidEntity

(
    FText& OutReason
)

Checks for Entity correctness for usability with protocols.

Public function

void

 

RefreshID()

Used by DMX Library to resolve ID conflicts among entities

Public function

void

 

ReplicateID

(
    UDMXEntity* Other
)

Copy another Entity's ID. Used when copying, to not lose the original Entity's reference

Public function

void

 

SetName

(
    const FString& InNewName
)

Updates this Entity's name and the UI friendly display name

Overridden from UObject

Name Description

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Deprecated Functions

Name Description

Public function

void

 

SetParentLibrary

(
    UDMXLibrary* InParent
)

The library should not be set explicitly anymore. Enties register themselves with the DMXLibrary on creation.