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/Experimental/DigitalMultiplex/DMXEngine/Source/DMXRuntime/Public/Library/DMXLibrary.h
Include	#include "Library/DMXLibrary.h"

Syntax

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

Functions

	Name	Description
void	AddEntity ( UDMXEntity* InEntity )	Adds an existing Entity, likely created from a copy/paste operation.
UDMXEntity &...	FindEntity ( const FString& InSearchName )	Returns an Entity named InSearchName.
UDMXEntity &...	FindEntity ( const FGuid& Id )	Returns an Entity with the passed in ID.
int32	FindEntityIndex ( UDMXEntity* InEntity )	The finds the index of an existing entity.
void	ForEachEntityOfType ( TFunction< void> ... )	Calls Predicate on all Entities of the template type. This is the version without break.
void	ForEachEntityOfType ( TSubclassOf< UDMXEntity > InEntityC..., TFunction< void*)> ... )	Calls Predicate on all Entities of the passed in type.
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.
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.
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
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.

Overridden from UObject

		Name	Description
	void	PostDuplicate ( EDuplicateMode::Type DuplicateMode )

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

Take our survey

Dismiss