UVirtualCameraUserSettings

Virtual Camera User Settings

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVirtualCameraUserSettings

References

Module

VirtualCamera

Header

/Engine/Plugins/Experimental/VirtualCamera/Source/VirtualCamera/Public/VirtualCameraUserSettings.h

Include

#include "VirtualCameraUserSettings.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=VirtualCamera, BlueprintType)
class UVirtualCameraUserSettings : public UObject

Remarks

Virtual Camera User Settings

Variables

Name Description

Public variable UProperty Category, Meta BlueprintReadWrite Config

TArray< struct ...

 

ActionMappings

Public variable UProperty Category, Meta BlueprintReadWrite Config

TArray< struct ...

 

AxisMappings

Public variable UProperty Category, EditAnywhere, Meta Config

bool

 

bDisplayFilmLeader

Whether to display film leader when recording a take

Public variable UProperty Category, EditAnywhere, Meta Config

bool

 

bIsMapGrayscale

Whether the map is displayed using grayscale or full color

Public variable UProperty Category, EditAnywhere, Meta Config

bool

 

bOverrideCameraSettingsOnTeleportToScreenshot

Whether to change camera lens and fstop when teleporting to a screenshot to those with which the screenshot was taken

Public variable UProperty Category, EditAnywhere, Meta Config

bool

 

bTeleportOnStart

Whether to teleport to the home bookmark when VCam starts

Public variable UProperty Category, EditAnywhere BlueprintReadWrite Config

TSoftClassPtr< ...

 

DefaultVCamClass

Default Vcam Class for Vcam Operator Panel

Public variable UProperty Category, EditAnywhere, Meta Config

float

 

FocusInterpSpeed

Controls interpolation speed when smoothing when changing focus distance.

Public variable UProperty Category, EditAnywhere, Meta Config

float

 

JoysticksSpeed

Controls how fast the camera moves when using joysticks

Public variable UProperty Category, EditAnywhere, Meta Config

float

 

MaxJoysticksSpeed

Sets the maximum possible joystick speed

Public variable UProperty Category, EditAnywhere, Meta Config

FString

 

VirtualCameraFilmback

Stores the filmback preset name selected by the user

Constructors

Name Description

Public function

UVirtualCameraUserSettings()

Functions

Name Description

Public function Const UFunction BlueprintPure, Category

void

 

GetActionMappingsByName

(
    const FName InActionName,
    TArray< FInputActionKeyMapping >& ...
)

Retrieve all VirtualCamera action mappings by a certain name.

Public function Const UFunction BlueprintPure, Category

void

 

GetAxisMappingsByName

(
    const FName InAxisName,
    TArray< FInputAxisKeyMapping >& Ou...
)

Retrieve all VirtualCamera axis mappings by a certain name.

Public function UFunction BlueprintPure, Category

float

 

GetFocusInterpSpeed()

Get FocusInterpSpeed variable

Public function UFunction BlueprintPure, Category

float

 

GetJoysticksSpeed()

Get JoysticksSpeed variable

Public function UFunction BlueprintPure, Category

float

 

GetMaxJoysticksSpeed()

Get MaxJoysticksSpeed variable

Public function UFunction BlueprintPure, Category

FString

 

GetSavedVirtualCameraFilmbackPresetName()

Get VirtualCameraFilmback variable

Public function UFunction BlueprintPure, Category

bool

 

GetShouldDisplayFilmLeader()

Get bDisplayFilmLeader variable

Public function UFunction BlueprintPure, Category

bool

 

GetShouldOverrideCameraSettingsOnTeleport()

Get bOverrideCameraSettingsOnTeleportToScreenshot variable

Public function UFunction BlueprintPure, Category

bool

 

GetTeleportOnStart()

Get bTeleportOnStart variable

Public function UFunction BlueprintCallable, Category

void

 

InjectGamepadKeybinds()

Fills the Axis/Action mappings with assosiated gamepad bindings

Public function UFunction BlueprintPure, Category

bool

 

IsMapGrayscle()

Get bIsMapGrayscale variable

Public function UFunction BlueprintCallable, Category

void

 

SetFocusInterpSpeed

(
    const float InFocusInterpSpeed
)

Set FocusInterpSpeed variable

Public function UFunction BlueprintCallable, Category

void

 

SetIsMapGrayscle

(
    const bool bInIsMapGrayscle
)

Set bIsMapGrayscale variable

Public function UFunction BlueprintCallable, Category

void

 

SetJoysticksSpeed

(
    const float InJoysticksSpeed
)

Set JoysticksSpeed variable

Public function UFunction BlueprintCallable, Category

void

 

SetMaxJoysticksSpeed

(
    const float InMaxJoysticksSpeed
)

Set MaxJoysticksSpeed variable

Public function UFunction BlueprintCallable, Category

void

 

SetSavedVirtualCameraFilmbackPresetName

(
    const FString& InFilmback
)

Set VirtualCameraFilmback variable

Public function UFunction BlueprintCallable, Category

void

 

SetShouldDisplayFilmLeader

(
    const bool bInDisplayFilmLeader
)

Set bDisplayFilmLeader variable

Public function UFunction BlueprintCallable, Category

void

 

SetShouldOverrideCameraSettingsOnTeleport

(
    const bool bInOverrideCameraSetting...
)

Set bOverrideCameraSettingsOnTeleportToScreenshot variable

Public function UFunction BlueprintCallable, Category

void

 

SetTeleportOnStart

(
    const bool bInTeleportOnStart
)

Set bTeleportOnStart variable
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss