unreal.VCamOutputProviderBase

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

Bases: Object

VCam Output Provider Base

C++ Source:

  • Plugin: VirtualCameraCore

  • Module: VCamCore

  • File: VCamOutputProviderBase.h

Editor Properties: (see get_editor_property/set_editor_property)

  • gameplay_view_target_policy (GameplayViewTargetPolicy): [Read-Write] In game worlds, such as PIE or shipped games, determines which a player controller whose view target should be set to the owning cine camera.

    Note that multiple output providers may have a policy set and policies might choose the same player controllers to set the view target for. This conflict is resolved as follows: if a player controller already has the cine camera as view target, the policy is not used. Hence, you can order your output providers array in the VCamComponent. The first policies will get automatically get higher priority.

  • is_active (bool): [Read-Write] If set, this output provider will execute every frame

  • on_activated_delegate_blueprint (ActivationDelegate_Blueprint): [Read-Write] Called when the activation state of this output provider changes.

  • override_resolution (IntPoint): [Read-Write] When bUseOverrideResolution is set, use this custom resolution

  • target_viewport (VCamTargetViewportID): [Read-Write] Which viewport to use for this VCam

  • umg_class (type(Class)): [Read-Write] The UMG class to be rendered in this output provider

  • use_override_resolution (bool): [Read-Write] Override the default output resolution with a custom value - NOTE you must toggle bIsActive off then back on for this to take effect

get_target_viewport() → VCamTargetViewportID

Get Target Viewport

Return type:

VCamTargetViewportID

get_umg_class()

Get UMGClass

Return type:

type(Class)

is_active() → bool

Returns if this output provider is currently active or not

Return type:

bool

is_initialized() → bool

Returns if this output provider has been initialized or not

Return type:

bool

property on_activated_delegate_blueprint: ActivationDelegate_Blueprint

[Read-Write] Called when the activation state of this output provider changes.

Type:

(ActivationDelegate_Blueprint)

property override_resolution: IntPoint

[Read-Write] When bUseOverrideResolution is set, use this custom resolution

Type:

(IntPoint)

set_active(active) → None

Called to turn on or off this output provider

Parameters:

active (bool) –

set_target_camera(target_camera) → None

Set Target Camera

Parameters:

target_camera (CineCameraComponent) –

set_target_viewport(value) → None

Set Target Viewport

Parameters:

value (VCamTargetViewportID) –

set_umg_class(umg_class) → None

Set UMGClass

Parameters:

umg_class (type(Class)) –

property target_viewport: VCamTargetViewportID

[Read-Write] Which viewport to use for this VCam

Type:

(VCamTargetViewportID)

property umg_class: Class

[Read-Write] The UMG class to be rendered in this output provider

Type:

(type(Class))

property use_override_resolution: bool

[Read-Write] Override the default output resolution with a custom value - NOTE you must toggle bIsActive off then back on for this to take effect

Type:

(bool)