unreal.VirtualCameraUserSettings
¶
- class unreal.VirtualCameraUserSettings(outer=None, name='None')¶
Bases:
unreal.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] Action Mappingsaxis_mappings
(Array(InputAxisKeyMapping)): [Read-Write] Axis Mappingsdefault_v_cam_class
(Class): [Read-Write] Default VCam Class: Default Vcam Class for Vcam Operator Paneldisplay_film_leader
(bool): [Read-Write] Display Film Leader: Whether to display film leader when recording a takefocus_interp_speed
(float): [Read-Write] Focus Interp Speed: Controls interpolation speed when smoothing when changing focus distance. This is used to set the value of FocusSmoothingInterpSpeed in the Virtual camera CineCamera componentis_map_grayscale
(bool): [Read-Write] Is Map Grayscale: Whether the map is displayed using grayscale or full colorjoysticks_speed
(float): [Read-Write] Joysticks Speed: Controls how fast the camera moves when using joysticksmax_joysticks_speed
(float): [Read-Write] Max Joysticks Speed: Sets the maximum possible joystick speedoverride_camera_settings_on_teleport_to_screenshot
(bool): [Read-Write] Override Camera Settings on Teleport to Screenshot: Whether to change camera lens and fstop when teleporting to a screenshot to those with which the screenshot was takenteleport_on_start
(bool): [Read-Write] Teleport on Start: Whether to teleport to the home bookmark when VCam startsvirtual_camera_filmback
(str): [Read-Write] Virtual Camera Filmback: Stores the filmback preset name selected by the user
- property action_mappings¶
[Read-Write] Action Mappings
- Type
- property axis_mappings¶
[Read-Write] Axis Mappings
- Type
- property default_v_cam_class¶
[Read-Write] Default VCam Class: Default Vcam Class for Vcam Operator Panel
- Type
(Class)
- get_action_mappings_by_name(action_name)¶
Retrieve all VirtualCamera action mappings by a certain name.
- Parameters
action_name (Name) –
- Returns
out_mappings (Array(InputActionKeyMapping)):
- Return type
- get_axis_mappings_by_name(axis_name)¶
Retrieve all VirtualCamera axis mappings by a certain name.
- Parameters
axis_name (Name) –
- Returns
out_mappings (Array(InputAxisKeyMapping)):
- Return type
- get_saved_virtual_camera_filmback_preset_name() str ¶
Get VirtualCameraFilmback variable
- Return type
- get_should_override_camera_settings_on_teleport() bool ¶
Get bOverrideCameraSettingsOnTeleportToScreenshot variable
- Return type
- 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) –