module: PythonAutomationTest

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="PyAutomationTest") static bool GetIsRunningPyLatentCommand()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="PyAutomationTest") static float GetPyLatentCommandTimeout()


className: IsRunningPyLatentCommand

code: static bool IsRunningPyLatentCommand = false;


className: PyLatentCommandTimeout

code: static float PyLatentCommandTimeout = 300.0f;


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="PyAutomationTest") static void ResetPyLatentCommand()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="PyAutomationTest") static void SetIsRunningPyLatentCommand ( bool isRunning )


className: UPyAutomationTestLibrary


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="PyAutomationTest") static void SetPyLatentCommandTimeout ( float Seconds )


description: Response from the host session after making a Qos request

module: Qos

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(Client, Reliable) virtual void ClientQosResponse ( [EQosResponseType](API\Plugins\Qos\EQosResponseType) Response )


description: A connection has been made and RPC/replication can begin

code: virtual void OnConnected()


description:
Delegate triggered when a response from the Qos beacon has been received
QosResponse response from the server


description: Initiate a Qos request with a given server

code: virtual void SendQosRequest ( const [FOnlineSessionSearchResult](API\Plugins\OnlineSubsystem\FOnlineSessionSearchResult) & DesiredHost )


description: Contact the server with a Qos request and begin timing

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(Server, Reliable, WithValidation) virtual void ServerQosRequest ( const [FString](API\Runtime\Core\Containers\FString) & InSessionId )


code: AQosBeaconClient ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


code: bool DoesSessionMatch ( const [FString](API\Runtime\Core\Containers\FString) & SessionId ) const


className: AQosBeaconClient

description: A beacon client used for quality timings to a specified session

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Transient, Config=Engine) class AQosBeaconClient : public [AOnlineBeaconClient](API\Plugins\OnlineSubsystemUtils\AOnlineBeaconClient)

bPendingQosRequest

type: bool

description: Is there a Qos request in flight

ConnectionStartTime

type: double

description: Time connection was established

DestSessionId

type: FString

description: Session Id of the destination host

QosRequestComplete

type: FOnQosRequestCo...

description: Delegate for Qos request responses

QosStartTime

description: Time the Qos started


description: Output current state of beacon to log

code: void DumpState() const


code: bool Init ( [FName](API\Runtime\Core\UObject\FName) InSessionName )


description: Handle a single Qos request received from an incoming client

code: void ProcessQosRequest ( [AQosBeaconClient](API\Plugins\Qos\AQosBeaconClient) * Client, const [FString](API\Runtime\Core\Containers\FString) & SessionId )


code: AQosBeaconHost ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: AQosBeaconHost

description: A beacon host listening for Qos requests from a potential client

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Transient, Config=Engine) class AQosBeaconHost : public [AOnlineBeaconHostObject](API\Plugins\OnlineSubsystemUtils\AOnlineBeaconHostObject)

NumQosRequests

description: Running total of Qos requests received since the beacon was created

SessionName

type: FName

description: Name of session this beacon is associated with


className: EQosCompletionResult

description: Enum for possible QoS return codes

code: enum EQosCompletionResult { Invalid, Success, Failure, Canceled, }


className: EQosDatacenterResult

description: Enum for single region QoS return codes

code: enum EQosDatacenterResult { Invalid, Success, Incomplete, }


className: EQosResponseType

description: Types of responses that can come back from the beacon

code: enum EQosResponseType { NoResponse, Success, Failure, }


description: FDatacenterQosInstance::IsNonSubspaceRecommended(const FDatacenterQosInstance&, const FDatacenterQosInstance&, const FQosSubspaceComparisonParams&)

code: static const [FDatacenterQosInstance](API\Plugins\Qos\FDatacenterQosInstance) & CompareBiasedTowardsNonSubspace ( const [FDatacenterQosInstance](API\Plugins\Qos\FDatacenterQosInstance) & NonSubspace, const [FDatacenterQosInstance](API\Plugins\Qos\FDatacenterQosInstance) & Subspace, const [FQosSubspaceComparisonParams](API\Plugins\Qos\FQosSubspaceComparisonParams) & ComparisonParams )


code: static const [FDatacenterQosInstance](API\Plugins\Qos\FDatacenterQosInstance) *const CompareBiasedTowardsNonSubspace ( const [FDatacenterQosInstance](API\Plugins\Qos\FDatacenterQosInstance) *const NonSubspace, const [FDatacenterQosInstance](API\Plugins\Qos\FDatacenterQosInstance) *const Subspace, const [FQosSubspaceComparisonParams](API\Plugins\Qos\FQosSubspaceComparisonParams) & ComparisonParams )


code: static bool IsLessWhenBiasedTowardsNonSubspace ( const [FDatacenterQosInstance](API\Plugins\Qos\FDatacenterQosInstance) & A, const [FDatacenterQosInstance](API\Plugins\Qos\FDatacenterQosInstance) & B, const [FQosSubspaceComparisonParams](API\Plugins\Qos\FQosSubspaceComparisonParams) & ComparisonParams, const TCHAR *const SubspaceDelimiter )


description:
Compares a subspace datacenter and a non-subspace datacenter, applying the qualifying rules to bias non-subspaces, configured via the supplied comparison parameters.
True if the NonSubspace is "better" (i.e. passes the qualifying rules), otherwise false.

code: static bool IsNonSubspaceRecommended ( const [FDatacenterQosInstance](API\Plugins\Qos\FDatacenterQosInstance) & NonSubspace, const [FDatacenterQosInstance](API\Plugins\Qos\FDatacenterQosInstance) & Subspace, const [FQosSubspaceComparisonParams](API\Plugins\Qos\FQosSubspaceComparisonParams) & ComparisonParams )


description: Reset the data to its default state

code: void Reset()


code: FDatacenterQosInstance ( const [FQosDatacenterInfo](API\Plugins\Qos\FQosDatacenterInfo) & InMeta, bool bInUsable )


className: FOnQosRequestComplete

description: Delegate triggered when a response from the Qos beacon has been received

code: typedef TBaseDelegate_TwoParams< void, [EQosResponseType](API\Plugins\Qos\EQosResponseType), int32 > FOnQosRequestComplete


className: FDatacenterQosInstance

description: Runtime information about a given region

AvgPingMs

description: Avg ping times across all search results

bUsable

description: Is the parent region usable

Definition

type: FQosDatacenterI...

description: Information about the datacenter

LastCheckTimestamp

type: FDateTime

description: Last time this datacenter was checked

NumResponses

description: Number of good results

PingResults

type: TArray< int32 >

description: Transient list of ping times obtained for this datacenter

Result

type: EQosDatacenterR...

description: Success of the qos evaluation


code: bool IsSubspace ( const TCHAR *const SubspaceDelimiter ) const


className: FQosDatacenterInfo

description: Metadata about datacenters that can be queried

bEnabled

description: Is this region tested (only valid if region is enabled)

Id

description: Id for this datacenter

RegionId

description: Parent Region

Servers

type: TArray<FQosPin...

description: Addresses of ping servers


description: FGCObjectinterface

code: virtual void AddReferencedObjects ( [FReferenceCollector](API\Runtime\CoreUObject\UObject\FReferenceCollector) & Collector )


description: true if a reasonable enough number of results were returned from all known regions, false otherwise

code: bool AllRegionsFound() const


description: Start running the async QoS evaluation

code: void BeginQosEvaluation ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAnalyticsProvider](API\Runtime\Analytics\Interfaces\IAnalyticsProvider) > & AnalyticsProvider, const FSimpleDelegate & OnComplete )


description: Clear the region to nothing, used for logging out

code: void ClearSelectedRegion()


description: Debug output for current region / datacenter information

code: void DumpRegionStats()


className: FOnQosEvalCompleteDelegate

code: typedef TMulticastDelegate_NoParams< void > FOnQosEvalCompleteDelegate


className: FOnQosRegionIdChanged

description: Delegate that fires whenever the current QoS region ID changes.

code: typedef TMulticastDelegate_TwoParams< void, const [FString](API\Runtime\Core\Containers\FString) &, const [FString](API\Runtime\Core\Containers\FString) & > FOnQosRegionIdChanged


description: Force the selected region creating a fake RegionOption if necessary

code: void ForceSelectRegion ( const [FString](API\Runtime\Core\Containers\FString) & RegionId )


description: Get the subregion id for this instance, checking ini and commandline overrides This is only relevant for dedicated servers (so they can advertise). Client does not search on this (but may choose to prioritize results later)


description: Get the interface singleton

code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FQosInterface](API\Plugins\Qos\FQosInterface) > Get()


description:
Get the region ID with the current best ping time, checking ini and commandline overrides.
the default region identifier


description:
Get the datacenter id for this instance, checking ini and commandline overrides This is only relevant for dedicated servers (so they can advertise). Client does not search on this in any way
the default datacenter identifier


description:
Clients pull this value from the settings (or command line) and do a ping test to determine if the setting is viable.
the current region identifier


description: Overload this method to report a name for your referencer

code: virtual [FString](API\Runtime\Core\Containers\FString) GetReferencerName() const


description: If this list is empty, the client cannot play.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FRegionQosInstance](API\Plugins\Qos\FRegionQosInstance) > & GetRegionOptions() const


description: Get a sorted list of subregions within a region

code: void GetSubregionPreferences ( const [FString](API\Runtime\Core\Containers\FString) & RegionId, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutSubregions ) const


description: Re-initialize our FQosRegionManager instance

code: bool Init()


description: Returns true if Qos is in the process of being evaluated

code: bool IsQosEvaluationInProgress() const


description: true if this is a usable region, false otherwise

code: bool IsUsableRegion ( const [FString](API\Runtime\Core\Containers\FString) & InRegionId ) const


description: Get the delegate that is invoked when the current/next QoS evaluation completes.


description: Register a delegate to be called when QoS settings have changed.

code: void RegisterQoSSettingsChangedDelegate ( const FSimpleDelegate & OnQoSSettingsChanged )


description: Try to set the selected region ID (must be present in GetRegionOptions)

code: bool SetSelectedRegion ( const [FString](API\Runtime\Core\Containers\FString) & RegionId )


description: FSelfRegisteringExec.

code: virtual bool Exec_Runtime ( [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld, const TCHAR * Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


className: FQosInterface

description: Main Qos interface for actions related to server quality of service

code: class FQosInterface : public [TSharedFromThis< FQosInterface >](API\Runtime\Core\Templates\TSharedFromThis), public [FGCObject](API\Runtime\CoreUObject\UObject\FGCObject)


description: Get the interface singleton

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FQosInterface](API\Plugins\Qos\FQosInterface) > GetQosInterface()


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [FQosModule](API\Plugins\Qos\FQosModule) & Get()


description:
Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true.
True if the module is loaded and ready to use

code: static bool IsAvailable()


className: FQosModule

description: Logging related to parties Module for QoS service utilities

code: class FQosModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface), public [FSelfRegisteringExec](API\Runtime\Core\Misc\FSelfRegisteringExec)


className: FQosPingServerInfo

description: Individual ping server details

Address

description: Address of server

Port

description: Port of server


description: true if this region can be auto assigned

code: bool IsAutoAssignable() const


description: true if a user can select this region in game

code: bool IsUsable() const


description: true if this region is supposed to be tested

code: bool IsPingable() const


className: FQosRegionInfo

description: Metadata about regions made up of datacenters

bAllowSubspaceBias

description: Enable biased sorting algorithm on results for this region, which prefers non-subspaces over subspaces

bAutoAssignable

description: Can this region be considered for auto detection

bEnabled

description: Is this region tested at all (if false, overrides individual datacenters)

bVisible

description: Is this region visible in the UI (can be saved by user, replaced with auto if region disappears

DisplayName

type: FText

description: Localized name of the region

RegionId

description: Id for the region, all datacenters must reference one of these

SubspaceBiasParams

type: FQosSubspaceCom...

description: Granular settings for biased subspace-based sorting algorithm, if enabled for this region


code: float CalcScaledMaxToleranceMs ( int32 PingMs ) const


code: FQosSubspaceComparisonParams ( int32 InMaxNonSubspacePingMs, int32 InMinSubspacePingMs, int32 InConstantMaxToleranceMs, float InScaledMaxTolerancePct )


className: FQosSubspaceComparisonParams

description: FDatacenterQosInstance::IsNonSubspaceRecommended(const FDatacenterQosInstance&, const FDatacenterQosInstance&, const FQosSubspaceComparisonParams&)

ConstantMaxToleranceMs

description: Maximum allowed difference between the subspace and non-subspace's ping values in milliseconds.

MaxNonSubspacePingMs

description: Maximum allowed ping of the non-subspace.

MinSubspacePingMs

description: Minimum allowed ping of the subspace.

ScaledMaxTolerancePct

type: float

description: Maximum allowed difference between the subspace and non-subspace's ping values, which scales as a proportion of the non-subspace's ping, so will differ between comparisons when sorting a single list of datacenters.


description: the ping recorded in the best sub region

code: int32 GetBestAvgPing() const


description: the subregion with the best ping


description: the region id for this region instance

code: const [FString](API\Runtime\Core\Containers\FString) & GetRegionId() const


description: sorted list of subregions by best ping

code: void GetSubregionPreferences ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutSubregions ) const


description: the result of this region ping request


description: true if this region can be consider for auto detection


description: if this region data is usable externally


description: Print list of datacenters results for this region to QoS log.

code: void LogDatacenterResults() const


description: Sort the list of datacenter options into ascending order of average ping


description: FDatacenterQosInstance::IsLessWhenBiasedTowardsNonSubspace(const FDatacenterQosInstance&, const FDatacenterQosInstance&, const FQosSubspaceComparisonParams&, const TCHAR*);

code: void SortDatacenterSubspacesByRecommended ( const [FQosSubspaceComparisonParams](API\Plugins\Qos\FQosSubspaceComparisonParams) & ComparisonParams, const TCHAR *const SubspaceDelimiter )


code: FRegionQosInstance ( const [FQosRegionInfo](API\Plugins\Qos\FQosRegionInfo) & InMeta )


className: FRegionQosInstance

DatacenterOptions

type: TArray<FDatace...

description: Array of all known datacenters and their status

Definition

type: FQosRegionInfo

description: Information about the region


className: LexToString

code: const TCHAR * LexToString ( [EQosDatacenterResult](API\Plugins\Qos\EQosDatacenterResult) Result )


code: const TCHAR * LexToString ( [EQosCompletionResult](API\Plugins\Qos\EQosCompletionResult) Result )


description: true if a reasonable enough number of results were returned from all known regions, false otherwise

code: bool AllRegionsFound() const


description: Start running the async QoS evaluation

code: void BeginQosEvaluation ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAnalyticsProvider](API\Runtime\Analytics\Interfaces\IAnalyticsProvider) > & AnalyticsProvider, const FSimpleDelegate & OnComplete )


description: Clear the region to nothing, used for logging out

code: void ClearSelectedRegion()


description: Debug output for current region / datacenter information

code: void DumpRegionStats() const


code: typedef TMulticastDelegate_NoParams< void > FOnQosEvalCompleteDelegate


description: Delegate that fires whenever the current QoS region ID changes.

code: typedef TMulticastDelegate_TwoParams< void, const [FString](API\Runtime\Core\Containers\FString) &, const [FString](API\Runtime\Core\Containers\FString) & > FOnQosRegionIdChanged


description: Force the selected region creating a fake RegionOption if necessary

code: void ForceSelectRegion ( const [FString](API\Runtime\Core\Containers\FString) & RegionId )


description: Get the subregion id for this instance, checking ini and commandline overrides This is only relevant for dedicated servers (so they can advertise). Client does not search on this (but may choose to prioritize results later)


description:
Get the region ID with the current best ping time, checking ini and commandline overrides.
the default region identifier


description:
Clients pull this value from the settings (or command line) and do a ping test to determine if the setting is viable.
the current region identifier


description:
Get the datacenter id for this instance, checking ini and commandline overrides This is only relevant for dedicated servers (so they can advertise). Client does not search on this in any way
the default datacenter identifier


description: If this list is empty, the client cannot play.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FRegionQosInstance](API\Plugins\Qos\FRegionQosInstance) > & GetRegionOptions() const


description: Get a sorted list of subregions within a region

code: void GetSubregionPreferences ( const [FString](API\Runtime\Core\Containers\FString) & RegionId, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutSubregions ) const


description: Returns true if Qos is in the process of being evaluated

code: bool IsQosEvaluationInProgress() const


description: true if this is a usable region, false otherwise

code: bool IsUsableRegion ( const [FString](API\Runtime\Core\Containers\FString) & InRegionId ) const


description: Get the delegate that is invoked when the current/next QoS evaluation completes.


code: void RegisterQoSSettingsChangedDelegate ( const FSimpleDelegate & OnQoSSettingsChanged )


description: BeginUObjectinterface

code: virtual void PostReloadConfig ( class [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * PropertyThatWasLoaded )


description: Try to set the selected region ID (must be present in GetRegionOptions)

code: bool SetSelectedRegion ( const [FString](API\Runtime\Core\Containers\FString) & RegionId, bool bForce )


className: SubspaceDelimiterDefault

code: static const TCHAR * SubspaceDelimiterDefault = TEXT("_");


code: UQosRegionManager ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UQosRegionManager

description: Main Qos interface for actions related to server quality of service

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Engine) class UQosRegionManager : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: EQuicClientConnectionState

description: Enumerates QuicClient connection state to the remote endpoint.

module: QuicMessaging

code: enum EQuicClientConnectionState { Connected, Disconnected, }


className: FOnQuicMetaMessageReceived

code: typedef TMulticastDelegate_TwoParams< void, const [FGuid](API\Runtime\Core\Misc\FGuid), const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext) > & > FOnQuicMetaMessageReceived


className: FOnQuicClientConnectionChanged

description: Delegate informing bound functions when a QuicClient has connected to or disconnected from a remote endpoint (QuicServer).

code: typedef TMulticastDelegate_ThreeParams< void, const [FGuid](API\Runtime\Core\Misc\FGuid) &, const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) &, const [EQuicClientConnectionState](API\Plugins\QuicMessaging\EQuicClientConnectionState) > FOnQuicClientConnectionChanged


className: FQuicAuthMessage

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FQuicAuthMessage : public [FQuicMetaMessage](API\Plugins\QuicMessaging\FQuicMetaMessage)


className: FQuicAuthResponseMessage

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FQuicAuthResponseMessage : public [FQuicMetaMessage](API\Plugins\QuicMessaging\FQuicMetaMessage)


description:
Gets the optional message annotations.
Message header collection.

code: virtual const [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [FString](API\Runtime\Core\Containers\FString) > & GetAnnotations() const


description:
Gets the message attachment, if present.
A pointer to the message attachment, or nullptr if no attachment is present.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageAttachment](API\Runtime\Messaging\IMessageAttachment), ESPMode::ThreadSafe > GetAttachment() const


description:
Gets the date and time at which the message expires.
Expiration time.

code: virtual const [FDateTime](API\Runtime\Core\Misc\FDateTime) & GetExpiration() const


description: GetMessageTypeInfo

code: virtual const void * GetMessage() const


description:
Gets the scope to which the message was sent.
The message scope.

code: virtual EMessageFlags GetFlags() const


description: GetSenderThread

code: virtual const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & GetForwarder() const


description: GetMessageType

code: virtual const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) > & GetMessageTypeInfo() const


description:
Returns the original message context in case the message was forwarded.
The original message context, or nullptr if the message wasn't forwarded.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > GetOriginalContext() const


description: GetSender

code: virtual const [TArray](API\Runtime\Core\Containers\TArray)< [FMessageAddress](API\Runtime\Messaging\FMessageAddress) > & GetRecipients() const


code: virtual EMessageScope GetScope() const


description: GetSenderThread

code: virtual const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & GetSender() const


description: GetSender

code: virtual [ENamedThreads::Type](API\Runtime\Core\Async\ENamedThreads__Type) GetSenderThread() const


description: IsForwarded

code: virtual const [FDateTime](API\Runtime\Core\Misc\FDateTime) & GetTimeForwarded() const


description: GetTimeForwarded

code: virtual const [FDateTime](API\Runtime\Core\Misc\FDateTime) & GetTimeSent() const


code: template<typename MessageType> FQuicMetaMessageContext ( MessageType * InMessage )


className: FQuicMetaMessageContext

code: class FQuicMetaMessageContext : public [IMessageContext](API\Runtime\Messaging\IMessageContext)


description: Disconnect a node.

code: void DisconnectNode ( const [FGuid](API\Runtime\Core\Misc\FGuid) & NodeId )


description:
Get the generated Guid for this instance.
The Guid


description:
Get the NodeId of the remote endpoint.
OptionalFGuidif the node was found

code: [TOptional](API\Runtime\Core\IO\TOptional)< [FGuid](API\Runtime\Core\Misc\FGuid) > GetNodeId ( const [FString](API\Runtime\Core\Containers\FString) & RemoteEndpoint )


description:
Delegate that notifies bound functions when a QuicClient has connected to or disconnected from a remote endpoint (QuicServer).
The delegate


description:
Check if this node is authenticated.
Whether the node is authenticated

code: bool IsNodeAuthenticated ( const [FGuid](API\Runtime\Core\Misc\FGuid) & NodeId ) const


description:
Delegate that notifies bound functions when a meta / authentication message has been received.
The delegate


description: Set the connection cooldown.

code: void SetConnectionCooldown ( const bool bEnabled, const uint32 MaxAttempts, const uint32 PeriodSeconds, const uint32 CooldownSeconds, const uint32 CooldownMaxSeconds )


description: Set this node as authenticated.

code: void SetNodeAuthenticated ( const [FGuid](API\Runtime\Core\Misc\FGuid) & NodeId )


description: Set the maximum size an authentication message can have.

code: void SetMaxAuthenticationMessageSize ( const uint32 MaxBytes )


description:
Transport authentication message to endpoint.
Whether the message was sent

code: bool TransportAuthMessage ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context, const [FGuid](API\Runtime\Core\Misc\FGuid) & Recipient )


description:
Transport authentication response message to endpoint.
Whether the message was sent

code: bool TransportAuthResponseMessage ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context, const [FGuid](API\Runtime\Core\Misc\FGuid) & Recipient )


className: IQuicNetworkMessagingExtension

description: Interface for the messaging module network extension Plugins or modules implementing messaging transport for MessageBus can implement this modular feature to provide control on the service it provides.

code: class IQuicNetworkMessagingExtension : public [INetworkMessagingExtension](API\Runtime\Messaging\INetworkMessagingExtension)


code: UQuicMessagingSettings ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: EQuicMessageFormat

description: Defines the Quic message format available (how the message data is encoded).

code: enum EQuicMessageFormat { None = 0, Json, TaggedProperty, CborPlatformEndianness, CborStandardEndianness, }


className: UQuicMessagingSettings

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Engine) class UQuicMessagingSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

AutoRepairAttemptLimit

description: The number of consecutive attempt the auto repair routine will try to repair.

bAuthEnabled

description: Whether server side authentication is enabled

bAutoRepair

description: Whether the Quic transport channel should try to auto repair when in error.

bClientVerificationEnabled

description: Whether the QUIC client should verify the server certificate

bConnectionCooldownEnabled

description: Whether server has a cooldown for connection attempts.

bEncryption

description: Whether encryption should be used after the quic handshake

bIsClient

description: Whether the QUIC transport endpoint is a client (true) or a server (false)

bStopServiceWhenAppDeactivates

description: Whether to stop the transport service when the application deactivates, and restart it when the application is reactivated

ConnectionCooldownMaxAttempts

description: Maximum number of connection attempts until the cooldown is triggered.

ConnectionCooldownMaxSeconds

description: Maximum connection cooldown in seconds for exponential backoff.

ConnectionCooldownPeriodSeconds

description: Time period in seconds within which the maximum attempts must happen.

ConnectionCooldownSeconds

description: Connection cooldown in seconds used with exponential backoff.

DiscoveryTimeoutSeconds

description: Timeout in seconds when the remote endpoint cannot be discovered.

EnabledByDefault

description: Whether Quic messaging is enabled by default.

EnableTransport

description: Whether the Quic transport channel is enabled.

EndpointGuid

type: FGuid

description: Guid of this endpoint

MaxAuthenticationMessageSize

description: Maximum authentication message size for server side authentication

MessageFormat

type: EQuicMessageFor...

description: The format used to serialize the Quic message payload.

QuicServerCertificate

description: Server certificate to encrypt QUIC transport

QuicServerPrivateKey

description: Server private key to encrypt QUIC transport

StaticEndpoints

type: TArray<FString...

description: The IP endpoints of static devices.

UnicastEndpoint

description: The IP endpoint to listen to and send packets from.


className: EAuthenticationMode

description: Enumerates authentication mode.

module: QuicMessagingTransport

code: enum EAuthenticationMode { Enabled, Disabled, }


className: EEncryptionMode

description: Both endpoints must have the same setting to successfully connect.

code: enum EEncryptionMode { Enabled, Disabled, }


className: EConnectionCooldownMode

description: This is a server-only flag

code: enum EConnectionCooldownMode { Enabled, Disabled, }


className: EQuicClientConnectionChange

description: Enumerates client connection changes.

code: enum EQuicClientConnectionChange { Connected, Disconnected, }


className: EEndpointMode

description: Enumerates endpoint mode.

code: enum EEndpointMode { Client, Server, }


className: EQuicClientSelfSignedCertificate

description: Enumerates client self signed certificates mode.

code: enum EQuicClientSelfSignedCertificate { Reject, Allow, }


className: EQuicClientState

description: Enumerates client connection state.

code: enum EQuicClientState { Connecting, Connected, Failed, Disconnected, Closed, Stopped, }


className: EQuicClientVerificationMode

description: Enumerates client certificate verification.

code: enum EQuicClientVerificationMode { Verify, Pass, }


className: EQuicEndpointError

description: Enumerates endpoint error.

code: enum EQuicEndpointError { Normal, OutOfMemory, InvalidParameter, InvalidState, NotSupported, NotFound, BufferTooSmall, ConnectionHandshake, ConnectionAbort, AddressInUse, InvalidAddress, ConnectionTimeout, ConnectionIdle, InternalError, ServerUnreachable, ConnectionRefused, Protocol, VersionNegotiation, UserCanceled, AlpnNegotiation, StreamLimit, Unknown, }


className: EQuicHandlerState

description: Enumerates server handler state.

code: enum EQuicHandlerState { Starting, Running, Stopping, Failed, Disconnected, }


className: EQuicMessageType

description: Enumerates message type.

code: enum EQuicMessageType { Hello, Authentication, AuthenticationResponse, Data, Bye, }


className: EQuicServerState

description: Enumerates server state.

code: enum EQuicServerState { Starting, Running, Failed, Stopped, }


description: Default constructor.

code: FInboundMessage()


description: Creates and initializes a new instance.

code: FInboundMessage ( FQuicPayloadPtr InUnserializedMessage, const [FMessageHeader](API\Plugins\QuicMessagingTransport\FMessageHeader) & InMessageHeader, const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & InSender, const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & InReceiver )


className: FInboundMessage

description: Structure for unserialized inbound messages.

code: struct FInboundMessage

MessageHeader

type: FMessageHeader

description: Holds the message header.

Receiver

description: Holds the receiver's network endpoint.

Sender

description: Holds the sender's network endpoint.

UnserializedMessage

type: FQuicPayloadPtr

description: Holds the message data.


description: Default constructor.

code: FMessageHeader()


description: Creates and initializes a new instance.

code: FMessageHeader ( const [EQuicMessageType](API\Plugins\QuicMessagingTransport\EQuicMessageType) InMessageType, const [FGuid](API\Runtime\Core\Misc\FGuid) InRecipientId, const [FGuid](API\Runtime\Core\Misc\FGuid) InSenderId, const uint32 InSerializedMessageSize )


className: FMessageHeader

description: Structure for QUIC message headers.

code: struct FMessageHeader

MessageType

type: EQuicMessageTyp...

description: Holds the message type.

RecipientId

description: Holds the recipient node id.

SenderId

description: Holds the sender node id.

SerializedMessageSize

description: Holds the serialized message size.


description: Default constructor.

code: FOutboundMessage()


description: Creates and initializes a new instance.

code: FOutboundMessage ( const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) InRecipient, const FQuicPayloadPtr InSerializedMessage, const FQuicPayloadPtr InSerializedHeader )


className: FOutboundMessage

description: Structure for serialized outbound messages.

code: struct FOutboundMessage

bHasPayload

type: bool

description: Flag indicating whether this message has a payload.

Recipient

description: Holds the recipient endpoint address.

SerializedHeader

description: Holds the serialized message header.

SerializedPayload

description: Holds the serialized payload data.


className: FQuicClientConfig

code: struct FQuicClientConfig : public [FQuicEndpointConfig](API\Plugins\QuicMessagingTransport\FQuicEndpointConfig)

ClientVerificationMode

type: EQuicClientVeri...

description: Holds flag indicating whether the client should verify the server certificate.


description: Add remote endpoint client.

code: void AddClient ( const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & ClientEndpoint )


className: FQuicEndpointConfig

code: struct FQuicEndpointConfig

DiscoveryTimeoutSec

description: Holds the discovery timeout in seconds.

EncryptionMode

type: EEncryptionMode

description: Holds flag indicating whether encryption is enabled.

Endpoint

description: Holds the local/remote endpoint.

LocalNodeId

description: Holds the local node id.


description: Regularly called to check if any of the endpoints have reached the discovery timeout. Timed out endpoints will be disconnected.

code: void CheckDiscoveryTimeout()


description: Creates and initializes a new header-only instance.

code: FOutboundMessage ( const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) InRecipient, const FQuicPayloadPtr InSerializedHeader )


description: Checks if the lost endpoint node is still registered and removes it.

code: void CheckLoseNode ( const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) LostEndpoint )


description: Forward for the deserialize header delegate.

code: [FMessageHeader](API\Plugins\QuicMessagingTransport\FMessageHeader) DeserializeHeader ( const FQuicPayloadPtr HeaderData ) const


description: Disconnect an endpoint.

code: void DisconnectEndpoint ( const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & Endpoint )


description: Disconnect a node.

code: void DisconnectNode ( const [FGuid](API\Runtime\Core\Misc\FGuid) & NodeId )


description: Adds a DiscoveryTimeout entry if discovery timeouts are enabled.

code: void EndpointConnected ( const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & ConnectedEndpoint )


description: Removes a disconnected endpoint.

code: void EndpointDisconnected ( const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) DisconnectedEndpoint, [EQuicEndpointError](API\Plugins\QuicMessagingTransport\EQuicEndpointError) Reason )


description: Register discovered endpoint node.

code: void EndpointNodeDiscovered ( const [FGuid](API\Runtime\Core\Misc\FGuid) NodeId, const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & NodeEndpoint, const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & LocalEndpoint )


description: De-register lost endpoint node.

code: void EndpointNodeLost ( const [FGuid](API\Runtime\Core\Misc\FGuid) NodeId, const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) LostEndpoint )


description: AuthenticationandEQuicMessageType

code: void EnqueueOutboundMessages ( FQuicPayloadPtr Data, const [TArray](API\Runtime\Core\Containers\TArray)< [TTuple](API\Runtime\Core\Misc\TTuple)< [FGuid](API\Runtime\Core\Misc\FGuid), uint32 >> & MessageMetas, const [EQuicMessageType](API\Plugins\QuicMessagingTransport\EQuicMessageType) MessageType )


className: FOnClientConnectionChanged

description: Delegate for when a client connection changes.

code: typedef TBaseDelegate_ThreeParams< void, const [FGuid](API\Runtime\Core\Misc\FGuid) &, const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) &, const [EQuicClientConnectionChange](API\Plugins\QuicMessagingTransport\EQuicClientConnectionChange) > FOnClientConnectionChanged


description: Updates a KnownNode with new endpoint transport statistics.

code: void EndpointStatisticsUpdated ( const [FMessageTransportStatistics](API\Runtime\Messaging\FMessageTransportStatistics) TransportStats )


className: FOnEndpointNodeDiscovered

description: Delegate for when a node was discovered.

code: typedef TBaseDelegate_OneParam< void, const [FGuid](API\Runtime\Core\Misc\FGuid) & > FOnEndpointNodeDiscovered


className: FOnDeserializeHeader

description: Delegate for when a header needs to be deserialized.

code: typedef TBaseDelegate_OneParam< [FMessageHeader](API\Plugins\QuicMessagingTransport\FMessageHeader), FQuicPayloadPtr > FOnDeserializeHeader


className: FOnMessageDelivered

description: Delegate for when a message has been delivered.

code: typedef TBaseDelegate_OneParam< void, const uint32 > FOnMessageDelivered


className: FOnEndpointNodeLost

description: Delegate for when a node was lost.

code: typedef TBaseDelegate_OneParam< void, const [FGuid](API\Runtime\Core\Misc\FGuid) & > FOnEndpointNodeLost


className: FOnMessageValidated

description: Delegate for when a message has been received and validated.

code: typedef TBaseDelegate_OneParam< void, const [FInboundMessage](API\Plugins\QuicMessagingTransport\FInboundMessage) > FOnMessageValidated


className: FOnSerializeHeader

description: Delegate for when a header needs to be serialized.

code: typedef TBaseDelegate_OneParam< FQuicPayloadPtr, [FMessageHeader](API\Plugins\QuicMessagingTransport\FMessageHeader) & > FOnSerializeHeader


description:
Get the NodeId of a known endpoint.
OptionalFGuidif the node was found

code: [TOptional](API\Runtime\Core\IO\TOptional)< [FGuid](API\Runtime\Core\Misc\FGuid) > GetKnownNodeId ( const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & Endpoint ) const


description: Get a list of the known endpoints.

code: [TArray](API\Runtime\Core\Containers\TArray)< [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) > GetKnownEndpoints() const


description: Get a list of known NodeIds.

code: [TArray](API\Runtime\Core\Containers\TArray)< [FGuid](API\Runtime\Core\Misc\FGuid) > GetKnownNodeIds() const


description: Get the network/transport statistics for a node.

code: [FMessageTransportStatistics](API\Runtime\Messaging\FMessageTransportStatistics) GetStats ( [FGuid](API\Runtime\Core\Misc\FGuid) NodeId ) const


description: Authentication

code: void InitializeServer()


description: Authentication

code: bool IsEndpointAuthenticated ( const [FGuid](API\Runtime\Core\Misc\FGuid) & NodeId ) const


description: Check if an endpoint is associated with a known node.

code: bool IsEndpointKnown ( const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) Endpoint ) const


description: Checks if a message is valid.

code: bool IsMessageValid ( const [FInboundMessage](API\Plugins\QuicMessagingTransport\FInboundMessage) InboundMessage )


description: Reconnect remote endpoint client.

code: void ReconnectClient ( const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) ClientEndpoint )


description: Remove remote endpoint client.

code: void RemoveClient ( const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & ClientEndpoint )


description: Instructs the appropriate endpoint or handler to send a hello message.

code: void SendEndpointHello ( const [FInboundMessage](API\Plugins\QuicMessagingTransport\FInboundMessage) & InboundMessage )


description: Forward for the serialize header delegate.

code: FQuicPayloadPtr SerializeHeader ( [FMessageHeader](API\Plugins\QuicMessagingTransport\FMessageHeader) & MessageHeader ) const


description: Authentication

code: void SetEndpointAuthenticated ( const [FGuid](API\Runtime\Core\Misc\FGuid) & NodeId )


description: Shutdown endpoint manager and kill client/server threads.

code: void Shutdown()


description: Validates InboundMessage and passes it to MessageProcessor.

code: void ValidateInboundMessage ( const [FInboundMessage](API\Plugins\QuicMessagingTransport\FInboundMessage) InboundMessage )


code: FQuicEndpointManager()


description: Initialize endpoint manager with default mode as client.

code: FQuicEndpointManager ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FQuicEndpointConfig](API\Plugins\QuicMessagingTransport\FQuicEndpointConfig) > InEndpointConfig )


description: Default destructor.

code: ~FQuicEndpointManager()


className: FQuicEndpointManager

description: Client/Server:

code: class FQuicEndpointManager


className: FQuicEndpointPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< FQuicEndpoint, ESPMode::ThreadSafe > FQuicEndpointPtr


description: Creates and initializes a new instance.

code: FQuicNodeInfo ( const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & InEndpoint, const [FGuid](API\Runtime\Core\Misc\FGuid) & InNodeId, const [FIPv4Endpoint](API\Runtime\Networking\Interfaces\IPv4\FIPv4Endpoint) & InLocalEndpoint )


description: Default constructor.

code: FQuicNodeInfo()


className: FQuicNodeInfo

description: Structure for known remote endpoints.

code: struct FQuicNodeInfo

bIsAuthenticated

description: Denotes wheter this remote node is authenticated or not.

Endpoint

description: Holds the node's endpoint.

LocalEndpoint

description: Holds the node's local quic endpoint.

NodeId

description: Holds the endpoint's node identifier.

Statistics

type: FMessageTranspo...

description: Various transport statistics for this endpoint


className: FQuicPayload

code: typedef [TArray](API\Runtime\Core\Containers\TArray)< uint8 > FQuicPayload


className: FQuicPayloadPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FQuicPayload](API\Plugins\QuicMessagingTransport\FQuicPayload), ESPMode::ThreadSafe > FQuicPayloadPtr


className: FQuicServerConfig

code: struct FQuicServerConfig : public [FQuicEndpointConfig](API\Plugins\QuicMessagingTransport\FQuicEndpointConfig)

AuthenticationMode

type: EAuthentication...

description: Holds flag indicating whether the server should authenticate clients.

Certificate

type: FString

description: Holds the certificate for Quic communication.

ConnCooldownMaxAttempts

description: Holds the maximum attempts until the connection cooldown is triggered.

ConnCooldownMaxSec

description: Holds the maximum connection cooldown in seconds.

ConnCooldownMode

type: EConnectionCool...

description: Holds flag indicating whether there is a cooldown for connection attempts.

ConnCooldownPeriodSec

description: Holds the time period in seconds within the max attempts must happen.

ConnCooldownSec

description: Holds the connection cooldown in seconds.

MaxAuthenticationMessageSize

description: Holds the maximum authentication message size.

PrivateKey

description: Holds the private key.


className: HQUIC

code: typedef QUIC_HANDLE * HQUIC


description: Get the QuicMessagingTransport module

code: static [IQuicMessagingTransportModule](API\Plugins\QuicMessagingTransport\IQuicMessagingTransportModule) & Get()


className: IQuicMessagingTransportModule

description: Interface for QuicMessagingTransport module

code: class IQuicMessagingTransportModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: FRawInputDataDelegate

module: RawInput

code: typedef TBaseDelegate_TwoParams< bool, int32, const struct tagRAWINPUT * > FRawInputDataDelegate


className: FRawInputDeviceAxisProperties

bEnabled

type: uint8: 1

description: Whether the axis is enabled.

bGamepadStick

description: Whether this is a gamepad stick, which means it should scale from -1 to 1 instead of 0 to 1

bInverted

description: Whether the value of the axis as supplied from the driver should be inverted.

Key

type: FKey

description: Which key to emit the values from this axis to.

Offset

description: The amount to offset the axis value by to get the desired range (note that this offset is applied after the value has been inverted).


code: FRawInputDeviceButtonProperties()


className: FRawInputDeviceButtonProperties

bEnabled

description: Whether the button is enabled.

Key

description: Which key to emit the values from this button to.


className: FRawInputDeviceConfiguration

AxisProperties

type: TArray<FRawInp...

ProductID

description: The hexadecimal product ID in string form (e.g. 0xC262). If this is empty, will match all products

VendorID

description: The hexadecimal vendor ID in string form (e.g. 0x046D). If this is empty, will match all vendors


className: FRawInputKeyNames

code: struct FRawInputKeyNames


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis1;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis10;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis11;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis12;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis13;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis14;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis15;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis16;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis17;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis18;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis19;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis2;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis20;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis21;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis22;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis23;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis24;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis3;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis4;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis5;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis6;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis7;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis8;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Axis9;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button1;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button10;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button11;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button12;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button13;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button14;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button15;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button16;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button17;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button18;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button19;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button2;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button20;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button21;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button22;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button23;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button24;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button25;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button26;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button27;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button28;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button29;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button3;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button30;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button31;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button32;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button33;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button34;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button35;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button36;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button37;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button38;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button39;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button4;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button40;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button41;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button42;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button43;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button44;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button45;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button46;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button47;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button48;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button49;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button5;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button50;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button51;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button52;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button54;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button53;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button55;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button56;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button57;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button58;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button59;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button6;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button60;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button61;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button62;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button63;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button64;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button65;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button66;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button67;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button68;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button69;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button7;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button70;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button71;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button72;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button73;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button74;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button75;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button76;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button77;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button78;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button79;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button8;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button80;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button81;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button82;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button83;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button84;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button85;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button86;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button88;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button87;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button9;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button90;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button91;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button92;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button93;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button94;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button95;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button96;


code: static const [FKey](API\Runtime\InputCore\FKey) GenericUSBController_Button89;


className: FRawInputKeys

code: struct FRawInputKeys


code: static [FRawInputPlugin](API\Plugins\RawInput\FRawInputPlugin) & Get()


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [IRawInput](API\Plugins\RawInput\IRawInput) > & GetRawInputDevice()


description: FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

code: virtual void StartupModule()


className: FRawInputPlugin

code: class FRawInputPlugin : public [IInputDeviceModule](API\Runtime\InputDevice\IInputDeviceModule)


className: FRegisteredDeviceInfo

DeviceName

description: Driver supplied device name.

ProductID

description: Integer representation of the product ID (e.g. 0xC262 = 49762)

description: Integer representation of the vendor ID (e.g. 0xC262 = 49762)


description: Register axis/analog on a device to send input events with a given name

code: virtual void BindAnalogForDevice ( int32 DeviceHandle, [FName](API\Runtime\Core\UObject\FName) KeyName, int32 AxisIndex )


description: Register a button on a device to send input events with a given name

code: virtual void BindButtonForDevice ( int32 DeviceHandle, [FName](API\Runtime\Core\UObject\FName) EventName, int32 ButtonIndex )


description: Returns the delegate for a data received handler


description: Helper to get next input handle to assign.

code: int32 GetNextInputHandle()


description: Query connected devices and populate the ConnectedDeviceInfoList

code: virtual void QueryConnectedDevices()


description: Register a device for use.

code: int32 RegisterInputDevice ( int32 DeviceType, int32 Flags, uint16 DeviceID, int16 PageID, void * Handle )


description: Remove a registered device

code: virtual void RemoveRegisteredInputDevice ( int32 DeviceHandle )


description: Set whether an axis is inverted

code: virtual void SetAnalogAxisIsInverted ( int32 DeviceHandle, int32 AxisIndex, bool bInvert )


description: Sets the offset of the given axis

code: virtual void SetAnalogAxisOffset ( int32 DeviceHandle, int32 AxisIndex, float Offset )


code: IRawInput ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericApplicationMessageHandler](API\Runtime\ApplicationCore\GenericPlatform\FGenericApplicationMessageHandle-) > & InMessageHandler )


className: IRawInput

code: class IRawInput : public [IInputDevice](API\Runtime\InputDevice\IInputDevice)

DataReceivedHandler

type: FRawInputDataDe...

description: Delegate to allow for manual parsing of HID data.

MessageHandler

type: TSharedRef<FGe...

description: Handler to send all messages to.


className: URawInputFunctionLibrary

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class URawInputFunctionLibrary : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary)


description: Gets the category for the settings, some high level grouping like, Editor, Engine, Game...etc.

code: virtual [FName](API\Runtime\Core\UObject\FName) GetCategoryName() const


description: Gets the section text, uses the classes DisplayName by default.

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetSectionText() const


description: This alternate version of PostEditChange is called when properties inside structs are modified. The property that was actually modified is located at the tail of the list. The head of the list of theFStructPropertymember variable that contains the property that was modified.

code: virtual void PostEditChangeChainProperty ( struct [FPropertyChangedChainEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedChainEvent) & PropertyChangedEvent )


className: URawInputSettings

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Input, defaultconfig) class URawInputSettings : public [UDeveloperSettings](API\Runtime\DeveloperSettings\Engine\UDeveloperSettings)

bRegisterDefaultDevice

description: Whether the plugin should try to register a default device to handle generic gamepads and joysticks

DeviceConfigurations

description: List of bindings to apply based on Vendor and Product Id, these are applied in order.


className: EReflexMode

module: Reflex

code: enum EReflexMode { Disabled = 0, Enabled = 1, EnabledPlusBoost = 3, }


description: Implementation of Exec that is called on all targets where UE_ALLOW_EXEC_COMMANDS is true

code: virtual bool Exec_Runtime ( [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld, const TCHAR * Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


code: virtual float GetDriverLatencyInMs()


code: virtual bool GetFlashIndicatorEnabled()


code: virtual float GetGameLatencyInMs()


code: virtual float GetGPURenderLatencyInMs()


code: virtual float GetPresentLatencyInMs()


code: virtual float GetRenderLatencyInMs()


description: Return the stat id to use for this tickable

code: virtual [TStatId](API\Runtime\Core\Stats\TStatId) GetStatId() const


code: virtual float GetTotalLatencyInMs()


description:
Virtual that can be overloaded by the inheriting class. It is used to determine whether an object is ready to be ticked. This is required for example for allUObjectderived classes as they might be loaded async and therefore won't be ready immediately.
true if object is ready to be ticked, false otherwise.

code: virtual bool IsTickable() const


description:
Used to determine whether the object should be ticked in the editor. Defaults to false since that is the previous behavior.
true if this tickable object can be ticked in the editor

code: virtual bool IsTickableInEditor() const


description:
Used to determine if an object should be ticked when the game is paused. Defaults to false, as that mimics old behavior.
true if it should be ticked when paused, false otherwise

code: virtual bool IsTickableWhenPaused() const


code: virtual void SetCustomLatencyMarker ( uint32 MarkerId, uint64 FrameNumber )


code: virtual void SetEnabled ( bool bInEnabled )


code: virtual void SetFlashIndicatorEnabled ( bool bInEnabled )


code: virtual void SetFlashIndicatorLatencyMarker ( uint64 FrameNumber )


code: virtual void SetInputSampleLatencyMarker ( uint64 FrameNumber )


code: virtual void SetPresentLatencyMarkerEnd ( uint64 FrameNumber )


code: virtual void SetPresentLatencyMarkerStart ( uint64 FrameNumber )


code: virtual void SetRenderSubmitLatencyMarkerEnd ( uint64 FrameNumber )


code: virtual void SetRenderSubmitLatencyMarkerStart ( uint64 FrameNumber )


code: virtual void SetSimulationLatencyMarkerEnd ( uint64 FrameNumber )


code: virtual void SetSimulationLatencyMarkerStart ( uint64 FrameNumber )


description: Pure virtual that must be overloaded by the inheriting class. It will be called from within LevelTick.cpp after ticking all actors or from the rendering thread (depending on bIsRenderingThreadObject)

code: virtual void Tick ( float DeltaTime )


className: FReflexLatencyMarkers

code: class FReflexLatencyMarkers : public [ILatencyMarkerModule](API\Runtime\Engine\Performance\ILatencyMarkerModule), public [FTickableGameObject](API\Runtime\Engine\FTickableGameObject), public [FSelfRegisteringExec](API\Runtime\Core\Misc\FSelfRegisteringExec)

AverageDriverLatencyMs

type: float


code: virtual bool Exec_Runtime ( [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld, const TCHAR * Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


description: Return true if waiting occurred in the plugin, if false engine will use the default sleep setup.

code: virtual bool HandleMaxTickRate ( float DesiredMaxTickRate )


description: Used to provide a generic customization interface for custom tick rate handlers.

code: virtual void SetFlags ( uint32 Flags )


code: virtual ~FReflexMaxTickRateHandler()


className: FReflexMaxTickRateHandler

code: class FReflexMaxTickRateHandler : public [IMaxTickRateHandlerModule](API\Runtime\Engine\Performance\IMaxTickRateHandlerModule), public [FSelfRegisteringExec](API\Runtime\Core\Misc\FSelfRegisteringExec)


code: virtual float GetDriverLatencyInMs()


code: virtual bool GetFlashIndicatorEnabled()


code: virtual float GetGameLatencyInMs()


code: virtual float GetGPURenderLatencyInMs()


code: virtual float GetPresentLatencyInMs()


code: virtual float GetRenderLatencyInMs()


code: virtual float GetTotalLatencyInMs()


code: virtual bool ProcessMessage ( HWND hwnd, uint32 msg, WPARAM wParam, LPARAM lParam, int32 & OutResult )


code: virtual void SetCustomLatencyMarker ( uint32 MarkerId, uint64 FrameNumber )


code: virtual void SetEnabled ( bool bInEnabled )


code: virtual void SetFlashIndicatorEnabled ( bool bInEnabled )


code: virtual void SetFlashIndicatorLatencyMarker ( uint64 FrameNumber )


code: virtual void SetInputSampleLatencyMarker ( uint64 FrameNumber )


code: virtual void SetPresentLatencyMarkerEnd ( uint64 FrameNumber )


code: virtual void SetPresentLatencyMarkerStart ( uint64 FrameNumber )


code: virtual void SetRenderSubmitLatencyMarkerEnd ( uint64 FrameNumber )


code: virtual void SetRenderSubmitLatencyMarkerStart ( uint64 FrameNumber )


code: virtual void SetSimulationLatencyMarkerEnd ( uint64 FrameNumber )


code: virtual void SetSimulationLatencyMarkerStart ( uint64 FrameNumber )


code: virtual ~FReflexStatsLatencyMarkers()


className: FReflexStatsLatencyMarkers

code: class FReflexStatsLatencyMarkers : public [ILatencyMarkerModule](API\Runtime\Engine\Performance\ILatencyMarkerModule), public IWindowsMessageHandler


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Reflex") static bool GetFlashIndicatorEnabled()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Reflex") static float GetGameLatencyInMs()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Reflex") static float GetGameToRenderLatencyInMs()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Reflex") static bool GetReflexAvailable()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Reflex") static float GetRenderLatencyInMs()


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Reflex") static void SetFlashIndicatorEnabled ( const bool bEnabled )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Reflex") static void SetReflexMode ( const [EReflexMode](API\Plugins\Reflex\EReflexMode) Mode )


code: UReflexBlueprintLibrary ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UReflexBlueprintLibrary

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UReflexBlueprintLibrary : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary)


className: ERejoinAttemptResult

description: Possible end conditions that a rejoin attempt can be in after a user indicates intent to rejoin a session

module: Rejoin

code: enum ERejoinAttemptResult { RejoinFailure, RejoinInProgress, RejoinSuccess, NothingToRejoin, InvalidSessionFailure, JoinSessionFailure, RejoinTravelFailure, }


className: ERejoinStatus

description: Possible states that a rejoin check can be in at any given time

code: enum ERejoinStatus { NoMatchToRejoin, RejoinAvailable, UpdatingStatus, NeedsRecheck, NoMatchToRejoin_MatchEnded, }


className: FOnRejoinCheckComplete

description: Delegate fired when a rejoin check has completed against the backend

code: typedef TBaseDelegate_OneParam< void, [ERejoinStatus](API\Plugins\Rejoin\ERejoinStatus) > FOnRejoinCheckComplete


className: FOnRejoinCheckStatusChanged

description: Multicast delegate fired when a rejoin check state has changed

code: typedef TMulticastDelegate_OneParam< void, [ERejoinStatus](API\Plugins\Rejoin\ERejoinStatus) > FOnRejoinCheckStatusChanged


className: FOnRejoinCheckStatusChangedDelegate


className: FRejoinModule

description: Module for Rejoin base implementation

code: class FRejoinModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: FOnRejoinLastSessionComplete

description: Delegate fired at the completion of an attempt to rejoin a session

code: typedef TBaseDelegate_OneParam< void, [ERejoinAttemptResult](API\Plugins\Rejoin\ERejoinAttemptResult) > FOnRejoinLastSessionComplete


className: ToString

code: const TCHAR * ToString ( [ERejoinStatus](API\Plugins\Rejoin\ERejoinStatus) Result )


code: const TCHAR * ToString ( [ERejoinAttemptResult](API\Plugins\Rejoin\ERejoinAttemptResult) Result )


description: Check the backend for the existence of game session that the local player is registered with It will continue to return a valid value until that session is complete

code: virtual void CheckRejoinStatus ( const [FOnRejoinCheckComplete](API\Plugins\Rejoin\FOnRejoinCheckComplete) & CompletionDelegate )


description: Clear all timers associated with rejoin

code: void ClearTimers()


code: template<typename T> T * GetGameInstance() const


description:
Helpers
the search result that is currently associated with a rejoin

code: const [FOnlineSessionSearchResult](API\Plugins\OnlineSubsystem\FOnlineSessionSearchResult) & GetSearchResult() const


description: Get the current state in the rejoin check flow. Dev mode may return CVarDebugRejoin if it was set


code: [UWorld](API\Runtime\Engine\Engine\UWorld) * GetWorld() const


description: True if the rejoin check has completed and does not need to be rerun.

code: bool HasCompletedCheck() const


description: true if a rejoin attempt is in progress

code: bool IsAttemptingRejoin() const


description: True if it's possible that there's a match to rejoin

code: bool IsRejoinAvailable() const


code: virtual bool IsRejoinCheckEnabled() const


description: Access to the multicast delegate fired when a rejoin check status update is given


description: Called any time there is a failure to complete the attempted rejoin

code: virtual void OnRejoinFailure ( [ERejoinAttemptResult](API\Plugins\Rejoin\ERejoinAttemptResult) Result )


description: Rejoin the last session if one is found. One final call to CheckRejoinStatus is made to verify the session still exists

code: void RejoinLastSession ( const [FOnRejoinLastSessionComplete](API\Plugins\Rejoin\FOnRejoinLastSessionComplete) & InCompletionDelegate )


description: Reset the rejoin state. Sets status to NeedsRecheck, clears the cached search result, timer, and flags.

code: virtual void Reset()


description: Manually set the status of rejoins. Used when entering/leaving a map as a hint for future check requirements

code: void SetStatus ( [ERejoinStatus](API\Plugins\Rejoin\ERejoinStatus) NewStatus )


description: Use the search result to travel to the given server session Called after a session has been joined by the online platform

code: void TravelToSession()


className: URejoinCheck

description: Class responsible for maintaining the status/availability of a session already in progress for a client to join

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract) class URejoinCheck : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

LastKnownStatus

type: ERejoinStatus

description: Rejoin status


module: RemoteControl

code: ARemoteControlPresetActor()


className: ARemoteControlPresetActor

description: Actor that wraps a remote control preset, allows linking a specific preset to a level.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)( HideCategories=(Rendering, Physics, LOD, Activation, Input, Replication, Collision, Actor, Cooking)) class ARemoteControlPresetActor : public [AActor](API\Runtime\Engine\GameFramework\AActor)

Preset

type: TObjectPtr<URe...


className: EExposedFieldType

description: The type of the exposed field.

code: enum EExposedFieldType { Invalid, Property, Function, }


className: ERCAccess

description: Requested access mode to a remote property

code: enum ERCAccess { NO_ACCESS, READ_ACCESS, WRITE_ACCESS, WRITE_TRANSACTION_ACCESS, WRITE_MANUAL_TRANSACTION_ACCESS, }


className: ERCBindingStatus

description: Status of the binding

code: enum ERCBindingStatus { Unassigned, Awaiting, Bound, }


className: ERCModifyOperation

description: Type of operation to perform when setting a remote property's value

code: enum ERCModifyOperation { EQUAL, ADD, SUBTRACT, MULTIPLY, DIVIDE, }


className: ERCPayloadType

description: Deserialize payload type for interception purposes

code: enum ERCPayloadType { Cbor, Json, }


className: ERCTransactionMode

code: enum ERCTransactionMode { NONE = 0, AUTOMATIC, MANUAL, }


className: EVerbosityLevel

description: Log verbosity level

code: enum EVerbosityLevel { Log, Warning, Error, Log, Warning, Error, }


code: bool HasMask ( [ERCMask](API\Plugins\RemoteControlCommon\ERCMask) InMaskBit ) const


code: FRCMaskingOperation ( const [FRCObjectReference](API\Plugins\RemoteControl\FRCObjectReference) & InObjectRef )


code: FRCMaskingOperation ( [FRCFieldPathInfo](API\Plugins\RemoteControl\FRCFieldPathInfo) InPathInfo, [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObject )


className: FRCMaskingOperation

description: Reference to aUObjector one of its properties for the purpose of masking.

code: struct FRCMaskingOperation

Masks

type: ERCMask

description: Masks to be applied.

ObjectRef

type: FRCObjectRefere...

description: Holds Object reference.

OperationId

type: FGuid

description: Unique identifier of the operation being performed.

PreMaskingCache

description: Holds the state of this RC property before applying any masking.


code: [FRCResetToDefaultArgs](API\Plugins\RemoteControl\Factories\FRCResetToDefaultArgs) & operator= ( const [FRCResetToDefaultArgs](API\Plugins\RemoteControl\Factories\FRCResetToDefaultArgs) & )


code: FRCResetToDefaultArgs ( const [FRCResetToDefaultArgs](API\Plugins\RemoteControl\Factories\FRCResetToDefaultArgs) & )


className: FRCResetToDefaultArgs

description: Holds the arguments required by the Reset Factories.

code: struct FRCResetToDefaultArgs

ArrayIndex

description: Holds the index of the property being modified incase it is embeded in an array.

bCreateTransaction

type: bool

description: Determines whether should we notify the transaction manager or not.

Path

description: Holds the property path of the actual property.

Property

type: FProperty*

description: Holds a reference to the actual property.


description: Returns true when the given object can be reset to its default value, false otherwise.

code: bool CanResetToDefaultValue ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObject, const [FRCResetToDefaultArgs](API\Plugins\RemoteControl\Factories\FRCResetToDefaultArgs) & InArgs ) const


description: Performs actual data reset on the given remote object.

code: void ResetToDefaultValue ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObject, [FRCResetToDefaultArgs](API\Plugins\RemoteControl\Factories\FRCResetToDefaultArgs) & InArgs )


description:
Whether the factory support exposed entity.
true if the exposed object is supported by given factory

code: bool SupportsClass ( const [UClass](API\Runtime\CoreUObject\UObject\UClass) * InObjectClass ) const


description:
Whether the factory support property.
true if the exposed property is supported by given factory

code: bool SupportsProperty ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty ) const


description: Virtual destructor

code: virtual ~IRCDefaultValueFactory()


className: IRCDefaultValueFactory

description: Factory which resets theFRemoteControlPropertyto its default values.

code: class IRCDefaultValueFactory : public [TSharedFromThis< IRCDefaultValueFactory >](API\Runtime\Core\Templates\TSharedFromThis)


description: Caches premasking values from the given struct property.

code: void CacheRawValues ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FRCMaskingOperation](API\Plugins\RemoteControl\Factories\FRCMaskingOperation) > & InMaskingOperation )


description: Applies masked values to the given struct property.

code: void ApplyMaskedValues ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FRCMaskingOperation](API\Plugins\RemoteControl\Factories\FRCMaskingOperation) > & InMaskingOperation, bool bIsInteractive )


description:
Whether the factory support exposed entity.
true if the script struct is supported by given factory

code: bool SupportsExposedEntity ( [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * ScriptStruct ) const


description: Virtual destructor

code: virtual ~IRemoteControlMaskingFactory()


className: IRemoteControlMaskingFactory

description: Factory which is responsible for masking support forFRemoteControlProperty.

code: class IRemoteControlMaskingFactory : public [TSharedFromThis< IRemoteControlMaskingFactory >](API\Runtime\Core\Templates\TSharedFromThis)


className: FColorGradingWheelColor

description: A color value as represented by a position on a color grading wheel.

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)(Blueprintable) struct FColorGradingWheelColor : public [FColorWheelColorBase](API\Plugins\RemoteControl\FColorWheelColorBase)

Luminance

type: double

description: The color's luminance component, which is separate from the HSV color itself.


className: FColorWheelColorBase

description: Base data for a color represented as its position on a color wheel.

Position

description: The position on the unit circle. Magnitude should be in range [0, 1].

Value

description: The color's value component (as in HSV).


className: FEntityMetadataInitializer

description: Delegate called to initialize an exposed entity metadata entry registered with the RegisterDefaultEntityMetadata method. Use RemoteControlPreset::GetExposedEntity to retrieve the entity that will contain the metadata. The delegate return value will be put into metadata map for the metadata key that was used when registering the default metadata entry.

code: typedef TBaseDelegate_TwoParams< [FString](API\Runtime\Core\Containers\FString), [URemoteControlPreset](API\Plugins\RemoteControl\URemoteControlPreset) *, const [FGuid](API\Runtime\Core\Misc\FGuid) & > FEntityMetadataInitializer


className: FExposedFunction

description: Holds an exposed function, its default parameters and owner objects.

code: struct FExposedFunction

DefaultParameters

type: TSharedPtr< cla...

Function

type: UFunction*

OwnerObjects

type: TArray<UObject...


className: FExposedProperty

description: Holds an exposed property and owner objects.

code: struct FExposedProperty


className: FGetProtocolMappingCallback


className: FOnPostPropertyModifiedRemotely

description: Delegate called after a property has been modified through SetObjectProperties..

code: typedef TMulticastDelegate_OneParam< void, const [FRCObjectReference](API\Plugins\RemoteControl\FRCObjectReference) & > FOnPostPropertyModifiedRemotely


className: FColorWheelColor

description: A color as represented by a position on a color wheel.

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)(Blueprintable) struct FColorWheelColor : public [FColorWheelColorBase](API\Plugins\RemoteControl\FColorWheelColorBase)

Alpha

description: The color's alpha component.


className: FOnVirtualPropertyContainerModified

code: typedef TMulticastDelegate_NoParams< void > FOnVirtualPropertyContainerModified


className: FRCCachedFieldData

description: Data cached for every exposed field.

LayoutGroupId

description: The group the field is in.

OwnerObjectAlias

type: FName

description: The target that owns this field.


className: FRCCall

description: Object to hold aUObjectremote call

code: struct FRCCall

CallRef

type: FRCCallReferenc...

ParamData

type: TArray< uint8 >

description: Payload for native function.

ParamStruct

type: FStructOnScope

description: Payload for UFunctiom.

TransactionMode

type: ERCTransactionM...


className: FRCCallReference

description: Reference to a function in aUObject

code: struct FRCCallReference

Function

type: TWeakObjectPtr<...

PropertyWithSetter

type: TWeakFieldPtr< ...


code: virtual ~FRCFieldMetadata()


description: Returns last segment's name


description: Gets a segment from this path

code: const [FRCFieldPathSegment](API\Plugins\RemoteControl\FRCFieldPathSegment) & GetFieldSegment ( int32 Index ) const


description: Returns the resolved data of the last segment If last segment is not resolved, data won't be valid


description: Returns the number of segment in this path

code: int32 GetSegmentCount() const


description: Returns true if the hash of the string corresponds to the string we were built with

code: bool IsEqual ( FStringView OtherPath ) const


description: Returns true if hash of both PathInfo matches

code: bool IsEqual ( const [FRCFieldPathInfo](API\Plugins\RemoteControl\FRCFieldPathInfo) & OtherPath ) const


description: Returns true if last segment was resolved

code: bool IsResolved() const


code: bool operator== ( const [FRCFieldPathInfo](API\Plugins\RemoteControl\FRCFieldPathInfo) & Other ) const


code: bool operator!= ( const [FRCFieldPathInfo](API\Plugins\RemoteControl\FRCFieldPathInfo) & Other ) const


description: Go through each segment and finds the property associated + container address for a givenUObjectowner

code: bool Resolve ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Owner )


description: Builds an EditPropertyChain from the segments

code: void ToEditPropertyChain ( [FEditPropertyChain](API\Runtime\CoreUObject\UObject\FEditPropertyChain) & OutPropertyChain ) const


description: Converts this PathInfo to a string of PathToProperty format Struct.ArrayName.ArrayName[Index] If EndSegment is not none, will stop at the desired segment

code: [FString](API\Runtime\Core\Containers\FString) ToPathPropertyString ( int32 EndSegment ) const


description: Builds a property change event from all the segments

code: [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) ToPropertyChangedEvent ( [EPropertyChangeType::Type](API\Runtime\CoreUObject\UObject\Type) InChangeType ) const


description: Converts this RCPath to a property path.

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FPropertyPath](API\Editor\PropertyEditor\FPropertyPath) > ToPropertyPath() const


description: Converts this PathInfo to a string Walks the full path by default If EndSegment is not none, will stop at the desired segment

code: [FString](API\Runtime\Core\Containers\FString) ToString ( int32 EndSegment ) const


description: Builds a path info from a property.

code: FRCFieldPathInfo ( [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * Property )


description: Builds a path info from a string of format with '.' delimiters Optionally can reduce duplicates when dealing with containers If true -> Struct.ArrayName.ArrayName[2].Member will collapse to Struct.ArrayName[2].Member This is when being used with PathToProperty

code: FRCFieldPathInfo ( const [FString](API\Runtime\Core\Containers\FString) & PathInfo, bool bSkipDuplicates )


className: FRCFieldPathInfo

description: Supports array/set/map indexing.  Only String keys are currently supported for map key indexing. ie. MyStructProperty.MyStringToVectorMap["MyKey"].X Be aware that MyStringToVectorMap[2] will not correspond to the key 2 in the map, but to the index 2 of the map. This behaviour is intended to match PropertyHandle's GeneratePathToProperty method.

PathHash

description: Hash created from the string we were built from to quickly compare to paths

Segments

type: TArray<FRCFiel...

description: List of segments to point to a given field


description: Returns true if a Field was found for a given owner


description: Converts this segment to a string FieldName, FieldName[Index] If bDuplicateContainer is asked, format will be different if its indexed FieldName.FieldName[Index] -> This is to bridge for PathToProperty

code: [FString](API\Runtime\Core\Containers\FString) ToString ( bool bDuplicateContainer ) const


description: Builds a segment from a name.

code: FRCFieldPathSegment ( FStringView SegmentName )


className: FRCFieldPathSegment

description: RemoteControl Path segment holding a property layer

ArrayIndex

description: Container index if any.

MapKey

type: FString

description: Holds the key in case of a path containing an indexed map.

Name

description: Name of the segment

ResolvedData

type: FRCFieldResolve...

description: Resolved Data of the segment

ValuePropertyName

description: Value property name, in case a map is being indexed.


className: FRCFieldResolvedData

description: Small container for the resolved data of a remote control field segment

code: struct FRCFieldResolvedData

ContainerAddress

type: void *

description: Container address of this segment

Field

description: Resolved field for this segment

MapIndex

description: Indexresolved from the key of the segment.

Struct

type: UStruct*

description: Type of that segment owner


description: Returns validity of the resolved data

code: bool IsValid() const


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRCMetadata_bool : public [FRCFieldMetadata](API\Plugins\RemoteControl\FRCFieldMetadata)

DefaultValue

type: bool


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRCMetadata_byte : public [FRCFieldMetadata](API\Plugins\RemoteControl\FRCFieldMetadata)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRCMetadata_double : public [FRCFieldMetadata](API\Plugins\RemoteControl\FRCFieldMetadata)

type: double


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRCMetadata_float : public [FRCFieldMetadata](API\Plugins\RemoteControl\FRCFieldMetadata)

type: float


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRCMetadata_FName : public [FRCFieldMetadata](API\Plugins\RemoteControl\FRCFieldMetadata)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRCMetadata_FString : public [FRCFieldMetadata](API\Plugins\RemoteControl\FRCFieldMetadata)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRCMetadata_FVector : public [FRCFieldMetadata](API\Plugins\RemoteControl\FRCFieldMetadata)

type: FVector


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRCMetadata_int16 : public [FRCFieldMetadata](API\Plugins\RemoteControl\FRCFieldMetadata)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRCMetadata_int32 : public [FRCFieldMetadata](API\Plugins\RemoteControl\FRCFieldMetadata)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRCMetadata_int64 : public [FRCFieldMetadata](API\Plugins\RemoteControl\FRCFieldMetadata)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRCMetadata_int8 : public [FRCFieldMetadata](API\Plugins\RemoteControl\FRCFieldMetadata)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRCMetadata_uint16 : public [FRCFieldMetadata](API\Plugins\RemoteControl\FRCFieldMetadata)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRCMetadata_UClass : public [FRCFieldMetadata](API\Plugins\RemoteControl\FRCFieldMetadata)

type: TSoftClassPtr< ...


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRCMetadata_uint32 : public [FRCFieldMetadata](API\Plugins\RemoteControl\FRCFieldMetadata)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRCMetadata_uint64 : public [FRCFieldMetadata](API\Plugins\RemoteControl\FRCFieldMetadata)


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRCMetadata_UObject : public [FRCFieldMetadata](API\Plugins\RemoteControl\FRCFieldMetadata)

type: TSoftObjectPtr<...


className: FPostSetObjectPropertyCallback

description: Callback type for post set object properties

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool([UObject](API\Runtime\CoreUObject\UObject\UObject) *, const [FRCFieldPathInfo](API\Plugins\RemoteControl\FRCFieldPathInfo) &, bool)> FPostSetObjectPropertyCallback


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRCMetadata_UScriptStruct : public [FRCFieldMetadata](API\Plugins\RemoteControl\FRCFieldMetadata)


code: FRCObjectReference ( [ERCAccess](API\Plugins\RemoteControl\ERCAccess) InAccessType, [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObject )


code: FRCObjectReference ( [ERCAccess](API\Plugins\RemoteControl\ERCAccess) InAccessType, [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObject, [FRCFieldPathInfo](API\Plugins\RemoteControl\FRCFieldPathInfo) InPathInfo )


className: FRCObjectReference

description: Reference to aUObjector one of its properties

code: struct FRCObjectReference

Access

type: ERCAccess

description: Type of access on this object (read, write)

ContainerAdress

description: Address of the container of the property for serialization purposes in case of a nested property

ContainerType

description: Type of the container where the property resides

Object

description: UObjectowning the target property

Property

description: Actual property that is being referenced

PropertyPathInfo

type: FRCFieldPathInf...

description: Path to the property under the Object


description: Change the object this exposed entity is currently pointing to.  You should call CanBindObject before calling this method.

code: virtual void BindObject ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObjectToBind )


code: [AActor](API\Runtime\Engine\GameFramework\AActor) * GetActor() const


description: Get the class of the object that can hold this field.

code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetSupportedBindingClass() const


code: void SetActor ( [AActor](API\Runtime\Engine\GameFramework\AActor) * InActor )


description: Get an identifier for the underlying entity. This is used to figure out if two remote control entities have the same underlying field/actor.

code: virtual uint32 GetUnderlyingEntityIdentifier() const


code: FRemoteControlActor ( [URemoteControlPreset](API\Plugins\RemoteControl\URemoteControlPreset) * InOwner, [FName](API\Runtime\Core\UObject\FName) InLabel, const [TArray](API\Runtime\Core\Containers\TArray)< [URemoteControlBinding](API\Plugins\RemoteControl\URemoteControlBinding) * > & InBindings )


className: FRemoteControlActor

description: Represents an actor exposed in the panel.

Path

type: FSoftObjectPath

description: Path to the exposed object.


description: Return whether this entity supports binding to a given object.

code: virtual bool CanBindObject ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObjectToBind ) const


className: FOnEntityModified

description: Delegate called when the label of this entity changes or if one of its binding is updated.

code: typedef TBaseDelegate_OneParam< void, const [FGuid](API\Runtime\Core\Misc\FGuid) & > FOnEntityModified


description: Get the unresolved bindings of this exposed entity.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [URemoteControlBinding](API\Plugins\RemoteControl\URemoteControlBinding) > > & GetBindings() const


description: Resolve the first binding for this entity.

code: [UObject](API\Runtime\CoreUObject\UObject\UObject) * GetBoundObject() const


description: Get the id of this entity.


description: Get all resolved bindings under this entity.

code: [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > GetBoundObjects() const


description: Get the last valid binding path for this entity.


description: Get the label of this entity.


description: Get the entity's metadata.

code: const [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [FString](API\Runtime\Core\Containers\FString) > & GetMetadata() const


description: Get the preset that owns this entity.


description: Get the type of this remote control entity.

code: const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetStruct() const


description: Returns whether this entity can be resolved using its bound objects.

code: virtual bool IsBound() const


code: bool operator== ( [FGuid](API\Runtime\Core\Misc\FGuid) InEntityId ) const


code: bool operator== ( const [FRemoteControlEntity](API\Plugins\RemoteControl\FRemoteControlEntity) & InEntity ) const


description: Remove a metadata entry.

code: void RemoveMetadataEntry ( [FName](API\Runtime\Core\UObject\FName) Key )


description:
The returned label can be different from the desired one if the label was already tkaen in the preset.
The assigned label.

code: [FName](API\Runtime\Core\UObject\FName) Rename ( [FName](API\Runtime\Core\UObject\FName) NewLabel )


description: Find or add a value in the entity's metadata map.

code: void SetMetadataValue ( [FName](API\Runtime\Core\UObject\FName) Key, [FString](API\Runtime\Core\Containers\FString) Value )


code: FRemoteControlEntity ( [URemoteControlPreset](API\Plugins\RemoteControl\URemoteControlPreset) * InPreset, [FName](API\Runtime\Core\UObject\FName) InLabel, const [TArray](API\Runtime\Core\Containers\TArray)< [URemoteControlBinding](API\Plugins\RemoteControl\URemoteControlBinding) * > & InBindings )


className: FRemoteControlEntity

description: Base class for exposed objects, properties, functions etc...

Bindings

type: TArray<TWeakOb...

description: The bound objects that are exposed or that hold the exposed entity.

Id

type: FGuid

description: Unique identifier for this entity

Label

type: FName

description: This exposed entity's alias.

OnEntityModifiedDelegate

type: FOnEntityModifi...

Owner

description: The preset that owns this entity.

UserMetadata

type: TMap<FName,FS...

description: User specified metadata for this entity.


code: virtual ~FRemoteControlEntity()


description: Change the object this exposed entity is currently pointing to.  You should call CanBindObject before calling this method.

code: virtual void BindObject ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObjectToBind )


description: Disables the given mask.

code: virtual void ClearMask ( [ERCMask](API\Plugins\RemoteControlCommon\ERCMask) InMaskBit )


description: Enables the given mask.

code: virtual void EnableMask ( [ERCMask](API\Plugins\RemoteControlCommon\ERCMask) InMaskBit )


description: Retrieves the enabled masks.


description: Returns true if the given mask is enabled, false otherwise.

code: virtual bool HasMask ( [ERCMask](API\Plugins\RemoteControlCommon\ERCMask) InMaskBit ) const


code: void PostSerialize ( const [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description:
Resolve the field's owners using the section's top level objects.
The list of UObjects that own the exposed field.

code: [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > ResolveFieldOwners ( const [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > & SectionObjects ) const


description: Returns true if this field supports masking.

code: virtual bool SupportsMasking() const


code: FRemoteControlField ( [URemoteControlPreset](API\Plugins\RemoteControl\URemoteControlPreset) * InPreset, [EExposedFieldType](API\Plugins\RemoteControl\EExposedFieldType) InType, [FName](API\Runtime\Core\UObject\FName) InLabel, [FRCFieldPathInfo](API\Plugins\RemoteControl\FRCFieldPathInfo) InFieldPathInfo, const [TArray](API\Runtime\Core\Containers\TArray)< [URemoteControlBinding](API\Plugins\RemoteControl\URemoteControlBinding) * > InBindings )


className: FRemoteControlField

description: Represents a property or function that has been exposed to remote control.

ActiveMasks

description: Holds the actively enabled masks.

bIsEditorOnly

description: Whether the field is only available in editor.

FieldName

description: The exposed field's name.

FieldPathInfo

description: Path information pointing to this field

FieldType

type: EExposedFieldTy...

description: The field's type.

OwnerClass

type: FSoftClassPath

description: The class of the object that can have this field.

ProtocolBindings

type: TSet<FRemoteCo...

description: Stores the bound protocols for this exposed field It could store any types of the implemented protocols such as DMX, OSC, MIDI, etc The map holds protocol bindings stores the protocol mapping and protocol-specific mapping


description: Returns the underlying exposed function.

code: [UFunction](API\Runtime\CoreUObject\UObject\UFunction) * GetFunction() const


description: Returns whether the field is only available in editor.

code: bool IsEditorOnly() const


description: Get an identifier for the underlying entity. This is used to figure out if two remote control entities have the same underlying field/actor.

code: virtual uint32 GetUnderlyingEntityIdentifier() const


description: Get the class of the object that can hold this field.

code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetSupportedBindingClass() const


description: Returns whether this entity can be resolved using its bound objects.

code: virtual bool IsBound() const


description: Returns whether the function is callable in a packaged build.

code: bool IsCallableInPackaged() const


description: Recreates the function arguments but tries to preserve old values when possible. Useful for updating function arguments after a blueprint recompile.

code: void RegenerateArguments()


code: bool Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Deprecated* This constructor is deprecated. Use the other constructor.

code: FRemoteControlFunction ( [FName](API\Runtime\Core\UObject\FName) InLabel, [FRCFieldPathInfo](API\Plugins\RemoteControl\FRCFieldPathInfo) FieldPathInfo, [UFunction](API\Runtime\CoreUObject\UObject\UFunction) * InFunction )