FRemoteControlProtocol | Unreal Engine 5.7 Documentation

Base class implementation for remote control protocol


Name	FRemoteControlProtocol
Type	class
Header File	/Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControlProtocol/Public/RemoteControlProtocol.h
Include Path	#include "RemoteControlProtocol.h"

Syntax

class FRemoteControlProtocol : public IRemoteControlProtocol

Name	Remarks	Include Path	Unreal Specifiers
FRemoteControlProtocol ( FName InProtocolName )		RemoteControlProtocol.h

Name	Remarks	Include Path	Unreal Specifiers
~FRemoteControlProtocol()		RemoteControlProtocol.h

Name	Type	Remarks	Include Path	Unreal Specifiers
EntityValuesToApply	TMap< FRemoteControlProtocolEntityPtr, double >	Map of the entities and protocol values about to apply	RemoteControlProtocol.h

Name	Remarks	Include Path
virtual FRemoteControlProtocolEntityPtr CreateNewProtocolEntity ( FProperty* InProperty, URemoteControlPreset* InOwner, FGuid InPropertyId ) const	Add the new protocol entity. That is created based on protocol specific script struct	RemoteControlProtocol.h
virtual FProtocolColumnPtr GetRegisteredColumn ( const FName& ByColumnName ) const	Retrieves the column reference by its name.	RemoteControlProtocol.h
virtual void GetRegisteredColumns ( TSet< FName >& OutColumns )	Retrieves the set of columns registered by this protocol.	RemoteControlProtocol.h
virtual void Init()	Add custom initializing of the protocol	RemoteControlProtocol.h
virtual void OnBeginFrame()	Build to core engine delegated and called at the beginning of a frame	RemoteControlProtocol.h
virtual void QueueValue ( const FRemoteControlProtocolEntityPtr InProtocolEntity, const double InProtocolValue )	Queue protocol entity and value to apply for the protocol It stores only unique tick entities which should be apply next frame.	RemoteControlProtocol.h

Name	Remarks	Include Path	Unreal Specifiers
virtual void RegisterColumns()	Populates protocol specific columns.	RemoteControlProtocol.h

Name	Remarks	Include Path	Unreal Specifiers
static TFunction< bool(FRemoteControlProtocolEntityWeakPtr InProtocolEntityWeakPtr)> CreateProtocolComparator ( FGuid InPropertyId )	Helper function for comparing the Protocol Entity with given Property Id inside returned lambda	RemoteControlProtocol.h