unreal.VPBlueprintLibrary

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

Bases: BlueprintFunctionLibrary

Functionality added to prototype the VR scouting tools

C++ Source:

  • Plugin: VirtualProductionUtilities

  • Module: VPUtilities

  • File: VPBlueprintLibrary.h

classmethod editor_delete_selected_objects() → bool

Editor Delete Selected Objects deprecated: Use UEditorActorSubsystem::DeleteSelectedActors instead.

Return type:

bool

classmethod editor_duplicate() → bool

Editor Duplicate deprecated: Use UEditorActorSubsystem::DuplicateSelectedActors instead.

Return type:

bool

classmethod editor_redo() → bool

Trigger an UnrealEd Redo

Return type:

bool

classmethod editor_undo() → bool

Trigger an UnrealEd Undo

Return type:

bool

classmethod get_editor_viewport_transform() → Transform

Get the location of the 2D viewport camera

Return type:

Transform

classmethod get_editor_vr_head_transform() → Transform

Get Editor VRHead Transform deprecated: VR Editor mode is deprecated; use the XR Creative Framework plugin instead.

Return type:

Transform

classmethod get_editor_vr_room_transform() → Transform

Get Editor VRRoom Transform deprecated: VR Editor mode is deprecated; use the XR Creative Framework plugin instead.

Return type:

Transform

classmethod get_editor_world() → World

Wrapper around UUnrealEditorSubsystem::GetEditorWorld. Used because you can’t get the subsystem without being an editor utility actor.

Return type:

World

classmethod get_left_interactor_location() → Vector

Get Left Interactor Location deprecated: VR Editor mode is deprecated; use the XR Creative Framework plugin instead.

Return type:

Vector

classmethod get_virtual_production_role() → GameplayTagContainer

The machine role(s) in a virtual production context.

Return type:

GameplayTagContainer

classmethod get_vr_editor_laser_hover_location() → Vector

Get VREditor Laser Hover Location deprecated: VR Editor mode is deprecated; use the XR Creative Framework plugin instead.

Return type:

Vector

classmethod is_vr_editor_mode_active() → bool

Is VREditor Mode Active deprecated: VR Editor mode is deprecated; use the XR Creative Framework plugin instead.

Return type:

bool

classmethod jump_to_bookmark_in_level_editor(bookmark) → bool

Jump to a virtual production bookmark

Parameters:

bookmark (VPBookmark)

Return type:

bool

classmethod refresh3d_editor_viewport() → None

Refresh the desktop 3D viewport so that it updates changes even when not set to ‘Realtime’

classmethod set_grab_speed(speed) → None

Set Grab Speed deprecated: VR Editor mode is deprecated; use the XR Creative Framework plugin instead.

Parameters:

speed (float)

classmethod sort_actors_by_name(actors, ascending=True) → Array[Actor]

Sort actors by actor label

Parameters:
Returns:

actors (Array[Actor]):

Return type:

Array[Actor]

classmethod sort_vp_bookmark_actors_by_timestamp(actors, ascending=True) → Array[VPBookmarkActor]

Sort VPBookmarkActors by Timestamp parameter

Parameters:
Returns:

actors (Array[VPBookmarkActor]):

Return type:

Array[VPBookmarkActor]

classmethod spawn_bookmark_at_current_level_editor_position(actor_class, creation_context, offset, flatten_rotation=True) → Actor

Spawn a virtual production bookmark

Parameters:
Return type:

Actor

classmethod spawn_vp_tickable_actor(context_object, actor_class, location, rotation) → VPViewportTickableActorBase

Spawn a virtual production tickable actor

Parameters:
Return type:

VPViewportTickableActorBase

classmethod vp_bookmark_spline_mesh_indicator_disable(spline_mesh) → None

VPBookmark Spline Mesh Indicator Disable

Parameters:

spline_mesh (SplineMeshComponent)

classmethod vp_bookmark_spline_mesh_indicator_set_start_and_end(spline_mesh) → None

VPBookmark Spline Mesh Indicator Set Start and End

Parameters:

spline_mesh (SplineMeshComponent)