Navigation
API > API/Plugins > API/Plugins/DMXRuntime > API/Plugins/DMXRuntime/Library
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 (Abstract, Meta=(DisplayName="DMX Entity"))
class UDMXEntity : public UDMXObjectBase
Remarks
Base class for all entity types
Variables
| Type | Name | Description | |
|---|---|---|---|
   |
FGuid | Id | Uniquely identifies the parameter, used for fixing up Blueprints that reference this Entity when renaming. |
    |
FString | Name | |
  |
TWeakObjectPtr< UDMXLibrary > | ParentLibrary |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UDMXEntity () |
Constructor, for default objects only | |
 |
UDMXEntity
(
UDMXLibrary* InParentLibrary |
Constructor that specifies the outer Library |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Destroy () |
Destroys the Entity |
  |
FString | Returns the entity name to be used in UI elements | |
  |
const FGuid & | GetID () |
This Entity's unique ID |
  |
UDMXLibrary * | Gets the library the Entity resides in | |
   |
bool | 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 | Updates this Entity's name and the UI friendly display name | |
 |
void | SetParentLibrary
(
UDMXLibrary* InParent |
Sets the DMX Library of the entity |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |