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 > Game > UDMXComponent

Light Theme

Dark Theme

UDMXComponent

Component that receives DMX input each Tick from a fixture patch.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

UDMXComponent

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=(DMX), Meta=(BlueprintSpawnableComponent),
HideCategories=("Variable", "Sockets", "Tags", "Activation", "Cooking", "ComponentReplication", "AssetUserData", "Collision", "Events"))
class UDMXComponent : public UActorComponent

Remarks

Component that receives DMX input each Tick from a fixture patch. Only useful if updates are required each tick (otherwise use DMX Fixture Patch Ref variable and acess Data on demand from there).

Variables

	Name	Description
bool	bReceiveDMXFromPatch	If true, the component will receive DMX from the patch
FDMXEntityFixtu...	FixturePatchRef
FDMXComponentFi...	OnFixturePatchReceived	Broadcast when the component's fixture patch received DMX

Constructors

	Name	Description
	UDMXComponent()

Functions

	Name	Description
UDMXEntityFi...	GetFixturePatch()	Gets the fixture patch used in the component
void	OnFixturePatchReceivedDMX ( UDMXEntityFixturePatch* Fixtur..., const FDMXNormalizedAttributeValueM... )	Called when the fixture patch received DMX
void	SetFixturePatch ( UDMXEntityFixturePatch* InFixt... )	Sets the fixture patch used in the component
void	SetReceiveDMXFromPatch ( bool bReceive )	Sets whether the component receives dmx from the patch.
void	SetupReceiveDMXBinding()	Sets up binding for receiving depending on the patch's and the component's properties

Overridden from UActorComponent

		Name	Description
	void	BeginPlay()	Begins Play for the component.
	void	DestroyComponent ( bool bPromoteChildren )	Unregister the component, remove it from its outer Actor's Components array and mark for pending kill.

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally

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

Take our survey

Dismiss