Navigation
API > API/Plugins > API/Plugins/DMXProtocol
A DMX protocol as a name that can be displayed in UI. The protocol is directly accessible via GetProtocol
| Name | FDMXProtocolName |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocol/Public/DMXProtocolTypes.h |
| Include Path | #include "DMXProtocolTypes.h" |
Syntax
USTRUCT (BlueprintType , Category="DMX")
struct FDMXProtocolName
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| DMXProtocolTypes.h | |||
FDMXProtocolName
(
IDMXProtocolPtr InProtocol |
Construct from a protocol | DMXProtocolTypes.h | |
FDMXProtocolName
(
const FName& InName |
Construct from a protocol name | DMXProtocolTypes.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| bCanBeNone | const bool | Deprecated without replacement. Always false. | DMXProtocolTypes.h |
| OnValuesChanged | FSimpleMulticastDelegate | Deprecated without replacement. Protocols cannot be enabled or disabled after engine startup. | DMXProtocolTypes.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Name | FName | The Protocol Name | DMXProtocolTypes.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IDMXProtocolPtr GetProtocol() |
Returns the Protocol this name represents | DMXProtocolTypes.h | |
bool IsValid() |
IsValid member accessor | DMXProtocolTypes.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Deprecated members originating from deprecated FDMXNameListItem | DMXProtocolTypes.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
operator bool() |
Bool (is valid) operator | DMXProtocolTypes.h | |
operator const FName &() |
DMXProtocolTypes.h | ||
operator const IDMXProtocolPtr() |
DMXProtocolTypes.h | ||
operator FName &() |
DMXProtocolTypes.h | ||
operator IDMXProtocolPtr() |
DMXProtocolTypes.h | ||
bool operator!=
(
const FDMXProtocolName& Other |
DMXProtocolTypes.h | ||
bool operator!=
(
const IDMXProtocolPtr& Other |
DMXProtocolTypes.h | ||
bool operator!=
(
const FName& Other |
DMXProtocolTypes.h | ||
bool operator==
(
const IDMXProtocolPtr& Other |
DMXProtocolTypes.h | ||
bool operator==
(
const FDMXProtocolName& Other |
DMXProtocolTypes.h | ||
bool operator==
(
const FName& Other |
DMXProtocolTypes.h |