Navigation
API > API/Plugins > API/Plugins/DMXProtocol
References
| Module | DMXProtocol |
| Header | /Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocol/Public/DMXProtocolTypes.h |
| Include | #include "DMXProtocolTypes.h" |
Syntax
USTRUCT&40;BlueprintType, Category&61;"DMX"&41;
struct FDMXProtocolName
Remarks
A DMX protocol as a name that can be displayed in UI. The protocol is directly accessible via GetProtocol
Variables
| Type | Name | Description | |
|---|---|---|---|
   |
FName | Name | The Protocol Name |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
|||
 |
FDMXProtocolName
(
const FName& InName |
Construct from a protocol name | |
 |
FDMXProtocolName
(
IDMXProtocolPtr InProtocol |
Construct from a protocol |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
IDMXProtocolPtr | GetProtocol () |
Returns the Protocol this name represents |
  |
bool | IsValid () |
IsValid member accessor |
Operators
| Type | Name | Description | |
|---|---|---|---|
  |
|||
  |
|||
 |
|||
 |
|||
  |
bool | operator!=
(
const FDMXProtocolName& Other |
|
  |
bool | operator!=
(
const IDMXProtocolPtr& Other |
|
  |
bool | operator!=
(
const FName& Other |
|
  |
bool | operator==
(
const IDMXProtocolPtr& Other |
|
  |
bool | operator==
(
const FDMXProtocolName& Other |
|
  |
bool | operator==
(
const FName& Other |
Constants
| Name | Description |
|---|---|
| bCanBeNone | Deprecated without replacement. Always false. |
| OnValuesChanged | Deprecated without replacement. Protocols cannot be enabled or disabled after engine startup. |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
  |
TArray< FName > | Instead please use IDMXProtocol::GetProtocolNames | |
  |
Please use IsValid() instead. |