Navigation
API > API/Plugins > API/Plugins/RemoteControl
Represents a function exposed to remote control.
| Name | FRemoteControlFunction |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RemoteControlField.h |
| Include Path | #include "RemoteControlField.h" |
Syntax
USTRUCT (BlueprintType )
struct FRemoteControlFunction : public FRemoteControlField
Inheritance Hierarchy
- FRemoteControlEntity → FRemoteControlField → FRemoteControlFunction
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| RemoteControlField.h | |||
FRemoteControlFunction
(
FName InLabel, |
RemoteControlField.h | ||
FRemoteControlFunction
(
URemoteControlPreset* InPreset, |
RemoteControlField.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FunctionArguments | TSharedPtr< class FStructOnScope > | The function arguments. | RemoteControlField.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsCallableInPackaged | bool | Whether the function is callable in a packaged build. | RemoteControlField.h | |
| CachedFunction | TWeakObjectPtr< UFunction > | Cached resolved underlying function used to avoid doing a findobject while serializing. | RemoteControlField.h | |
| CachedFunctionArgsHash | uint32 | Hash of the underlying function arguments used to check if it has changed after a recompile. | RemoteControlField.h | |
| FunctionPath | FSoftObjectPath | The exposed function. | RemoteControlField.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UFunction * GetFunction() |
Returns the underlying exposed function. | RemoteControlField.h | |
bool IsCallableInPackaged() |
Returns whether the function is callable in a packaged build. | RemoteControlField.h | |
void PostSerialize
(
const FArchive& Ar |
RemoteControlField.h | ||
void RegenerateArguments () |
Recreates the function arguments but tries to preserve old values when possible. | RemoteControlField.h | |
bool Serialize
(
FArchive& Ar |
RemoteControlField.h |
Overridden from FRemoteControlEntity
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UClass * GetSupportedBindingClass() |
Get the class of the object that can hold this field. | RemoteControlField.h | |
virtual uint32 GetUnderlyingEntityIdentifier () |
Get an identifier for the underlying entity. | RemoteControlField.h | |
virtual bool IsBound() |
Returns whether this entity can be resolved using its bound objects. | RemoteControlField.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static uint32 HashFunctionArguments
(
UFunction* InFunction |
Hash function arguments using their type and size. | RemoteControlField.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Function_DEPRECATED | TObjectPtr< UFunction > | The exposed function. | RemoteControlField.h |