unreal.VirtualCameraUserSettings

class unreal.VirtualCameraUserSettings(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

Virtual Camera User Settings

C++ Source:

  • Plugin: VirtualCamera

  • Module: VirtualCamera

  • File: VirtualCameraUserSettings.h

Editor Properties: (see get_editor_property/set_editor_property)

  • action_mappings (Array[InputActionKeyMapping]): [Read-Write]

  • axis_mappings (Array[InputAxisKeyMapping]): [Read-Write]

  • default_v_cam_class (Class): [Read-Write] Default Vcam Class for Vcam Operator Panel

  • display_film_leader (bool): [Read-Write] Whether to display film leader when recording a take

  • focus_interp_speed (float): [Read-Write] Controls interpolation speed when smoothing when changing focus distance. This is used to set the value of FocusSmoothingInterpSpeed in the Virtual camera CineCamera component

  • is_map_grayscale (bool): [Read-Write] Whether the map is displayed using grayscale or full color

  • joysticks_speed (float): [Read-Write] Controls how fast the camera moves when using joysticks

  • max_joysticks_speed (float): [Read-Write] Sets the maximum possible joystick speed

  • override_camera_settings_on_teleport_to_screenshot (bool): [Read-Write] Whether to change camera lens and fstop when teleporting to a screenshot to those with which the screenshot was taken

  • teleport_on_start (bool): [Read-Write] Whether to teleport to the home bookmark when VCam starts

  • virtual_camera_filmback (str): [Read-Write] Stores the filmback preset name selected by the user

property action_mappings: None

[Read-Write]

Type:

(Array[InputActionKeyMapping])

property axis_mappings: None

[Read-Write]

Type:

(Array[InputAxisKeyMapping])

property default_v_cam_class: Class

[Read-Write] Default Vcam Class for Vcam Operator Panel

Type:

(Class)

get_action_mappings_by_name(action_name) → Array[InputActionKeyMapping]

Retrieve all VirtualCamera action mappings by a certain name.

Parameters:

action_name (Name) –

Returns:

out_mappings (Array[InputActionKeyMapping]):

Return type:

Array[InputActionKeyMapping]

get_axis_mappings_by_name(axis_name) → Array[InputAxisKeyMapping]

Retrieve all VirtualCamera axis mappings by a certain name.

Parameters:

axis_name (Name) –

Returns:

out_mappings (Array[InputAxisKeyMapping]):

Return type:

Array[InputAxisKeyMapping]

get_focus_interp_speed() → float

Get FocusInterpSpeed variable

Return type:

float

get_joysticks_speed() → float

Get JoysticksSpeed variable

Return type:

float

get_max_joysticks_speed() → float

Get MaxJoysticksSpeed variable

Return type:

float

get_saved_virtual_camera_filmback_preset_name() → str

Get VirtualCameraFilmback variable

Return type:

str

get_should_display_film_leader() → bool

Get bDisplayFilmLeader variable

Return type:

bool

get_should_override_camera_settings_on_teleport() → bool

Get bOverrideCameraSettingsOnTeleportToScreenshot variable

Return type:

bool

get_teleport_on_start() → bool

Get bTeleportOnStart variable

Return type:

bool

inject_gamepad_keybinds() → None

Fills the Axis/Action mappings with assosiated gamepad bindings

is_map_grayscle() → bool

Get bIsMapGrayscale variable

Return type:

bool

set_focus_interp_speed(focus_interp_speed) → None

Set FocusInterpSpeed variable

Parameters:

focus_interp_speed (float) –

set_is_map_grayscle(is_map_grayscle) → None

Set bIsMapGrayscale variable

Parameters:

is_map_grayscle (bool) –

set_joysticks_speed(joysticks_speed) → None

Set JoysticksSpeed variable

Parameters:

joysticks_speed (float) –

set_max_joysticks_speed(max_joysticks_speed) → None

Set MaxJoysticksSpeed variable

Parameters:

max_joysticks_speed (float) –

set_saved_virtual_camera_filmback_preset_name(filmback) → None

Set VirtualCameraFilmback variable

Parameters:

filmback (str) –

set_should_display_film_leader(display_film_leader) → None

Set bDisplayFilmLeader variable

Parameters:

display_film_leader (bool) –

set_should_override_camera_settings_on_teleport(override_camera_settings) → None

Set bOverrideCameraSettingsOnTeleportToScreenshot variable

Parameters:

override_camera_settings (bool) –

set_teleport_on_start(teleport_on_start) → None

Set bTeleportOnStart variable

Parameters:

teleport_on_start (bool) –