Navigation
API > API/Plugins > API/Plugins/DMXRuntime > API/Plugins/DMXRuntime/Game
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&40;ClassGroup&61;&40;DMX&41;, Meta&61;&40;BlueprintSpawnableComponent&41;,
HideCategories&61;&40;"Variable", "Sockets", "Activation", "Cooking", "ComponentReplication", "Collision", "ComponentTick"&41;&41;
class UDMXComponent : public UActorComponent
Remarks
Component that receives DMX input each Tick from a fixture patch.
Variables
| Type | Name | Description | |
|---|---|---|---|
    |
bool | bReceiveDMXFromPatch | If true, the component will receive DMX from the patch |
    |
FDMXEntityFixturePatchRef | FixturePatchRef | |
    |
FDMXOnDMXComponentTickSignature | OnDMXComponentTick | Event raised each tick, when the component has a Fixture Patch set and either: |
 |
FDMXComponentFixturePatchReceivedSignature | OnFixturePatchReceived | Broadcast when the component's fixture patch received DMX |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | Name | Description | |
|---|---|---|---|
    |
UDMXEntityFixturePatch * | Gets the fixture patch used in the component | |
  |
void | OnFixturePatchReceivedDMX
(
UDMXEntityFixturePatch* FixturePatch, |
Called when the fixture patch received DMX |
   |
void | SetFixturePatch
(
UDMXEntityFixturePatch* InFixturePatch |
Sets the fixture patch used in the component |
   |
void | SetReceiveDMXFromPatch
(
bool bReceive |
Sets whether the component receives dmx from the patch. |
 |
void | Sets up binding for receiving depending on the patch's and the component's properties | |
 |
void | Enables or disables the component tick depending of it being required for the OnDXMComponentTick function |
Overridden from UActorComponent
| Type | 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. |
  |
void | OnRegister () |
Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called. |
  |
void | TickComponent
(
float DeltaTime, |
Function called every frame on this ActorComponent. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |