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: VCamUserSettings.h

Editor Properties: (see get_editor_property/set_editor_property)

  • photo_save_location (DirectoryPath): [Read-Write] Directory path to store vcam photos

  • photo_save_mode (VCamPhotoSaveMode): [Read-Write] VCam photo save mode

  • texture_save_location (DirectoryPath): [Read-Write] Directory path to store vcam photo texture assets

  • v_cam_tutorial_completion_state (VCamTutorialCompletionState): [Read-Write] Indicates whether the VCam tutorial is completed. You can manually reset this to Pending if you want to retake the tutorial. The tutorial shown in the default VCamHUD, e.g. to teach gestures.

classmethod get_settings() → VirtualCameraUserSettings

Get Settings

Return type:

VirtualCameraUserSettings

is_tutorial_completed() → bool
Returns:

Whether the VCam tutorial has been completed.

Return type:

bool

property photo_save_location: DirectoryPath

[Read-Write] Directory path to store vcam photos

Type:

(DirectoryPath)

property photo_save_mode: VCamPhotoSaveMode

[Read-Write] VCam photo save mode

Type:

(VCamPhotoSaveMode)

set_tutorial_completion_state(new_state) → None

Sets the tutorial completion state and saves it to the config file if it has changed.

Parameters:

new_state (VCamTutorialCompletionState)

property texture_save_location: DirectoryPath

[Read-Write] Directory path to store vcam photo texture assets

Type:

(DirectoryPath)

property v_cam_tutorial_completion_state: VCamTutorialCompletionState

[Read-Write] Indicates whether the VCam tutorial is completed. You can manually reset this to Pending if you want to retake the tutorial. The tutorial shown in the default VCamHUD, e.g. to teach gestures.

Type:

(VCamTutorialCompletionState)