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 > UDMXLibrary

Light Theme

Dark Theme

UDMXLibrary

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UDMXObjectBase

UDMXLibrary

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable, AutoExpandCategories=DMX)
class UDMXLibrary : public UDMXObjectBase

Variables

		Name	Description
	FDMXLibraryPort...	PortReferences	Input ports of the Library

Constructors

	Name	Description
	UDMXLibrary()

Functions

	Name	Description
void	AddEntity ( UDMXEntity* InEntity )	Adds an existing Entity, likely created from a copy/paste operation.
UDMXEntity &...	FindEntity ( const FGuid& Id )	Returns an Entity with the passed in ID.
UDMXEntity &...	FindEntity ( const FString& InSearchName )	Returns an Entity named InSearchName.
int32	FindEntityIndex ( UDMXEntity* InEntity )	The finds the index of an existing entity.
void	ForEachEntityOfType ( TSubclassOf< UDMXEntity > InEntityC..., TFunction< void*)> ... )	Calls Predicate on all Entities of the passed in type.
void	ForEachEntityOfType ( TFunction< void> ... )	Calls Predicate on all Entities of the template type. This is the version without break.
void	ForEachEntityOfTypeWithBreak ( TSubclassOf< UDMXEntity > InEntityC..., TFunction< bool*)> ... )	Calls Predicate on all Entities of the passed in type.
void	ForEachEntityOfTypeWithBreak ( TFunction< bool> ... )	Calls Predicate on all Entities of the template type Return false from the predicate to break the iteration loop or true to keep iterating.
TSet< FDMXPo...	GenerateAllPortsSet()	Returns all ports as a set, slower than GetInputPorts and GetOutputPorts.
TSet< int32 ...	GetAllLocalUniversesIDsInPorts()	Returns all local Universe IDs in Ports
const TArray...	GetEntities()	Returns all Entities in this DMX Library
TArray< UDMX...	GetEntitiesOfType ( TSubclassOf< UDMXEntity > InEntityC... )	Get an array with entities from the specified UClass, but not typecast.
TArray< Enti...	GetEntitiesTypeCast()	Get an array of Entities from the specified template type, already cast.
const TSet< ...	GetInputPorts()	Returns the input ports
FOnEntitiesU...	GetOnEntitiesUpdated()	Called when the list of entities is changed by either adding or removing entities
UDMXEntity &...	GetOrCreateEntityObject ( const FString& InName, TSubclassOf< UDMXEntity > DMXEntity... )	Creates a new Entity or return an existing one with the passed in name
const TSet< ...	GetOutputPorts()	Returns the output ports
FName	GetPortReferencesPropertyName()	Returns the name of the Ports property.
void	RemoveAllEntities()	Empties this DMX Library array of Entities
void	RemoveEntity ( const FString& EntityName )	Removes an Entity from this DMX Library searching it by name.
void	RemoveEntity ( UDMXEntity* InEntity )	Removes an Entity from this DMX Library.
void	SetEntityIndex ( UDMXEntity* InEntity, const int32 NewIndex )	Move an Entity to a specific index.
void	UpdatePorts()	Updates the ports from what's set in the Input and Output Port References arrays
void	UpgradeFromControllersToPorts()	Upgrades libraries that use controllers (before 4.27) to use ports instead (from 4.27 on).

Overridden from UObject

	Name	Description
void	PostDuplicate ( EDuplicateMode::Type DuplicateMode )
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

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

Take our survey

Dismiss