unreal.VREditorMode

class unreal.VREditorMode(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: EditorWorldExtension

VR Editor Mode. Extends editor viewports with functionality for VR controls and object manipulation

C++ Source:

  • Module: VREditor

  • File: VREditorMode.h

Editor Properties: (see get_editor_property/set_editor_property)

  • interactor_class (Class): [Read-Write] Interactor Class: The controller to use when UnrealEd is in VR mode. Use VREditorInteractor get default editor behavior, or select a custom controller for special behavior

  • teleporter_class (Class): [Read-Write] Teleporter Class: The teleporter to use when UnrealEd is in VR mode. Use VREditorTeleporter to get default editor behavior, or select a custom teleporter

get_world_scale_factor() → float

Gets the world scale factor, which can be multiplied by a scale vector to convert to room space

Return type:

float

property interactor_class: Class

[Read-Write] Interactor Class: The controller to use when UnrealEd is in VR mode. Use VREditorInteractor get default editor behavior, or select a custom controller for special behavior

Type:

(Class)

is_in_game_view() → bool

Returns whether game view is currently active.

Return type:

bool

set_game_view(game_view) → None

Display the scene more closely to how it would appear at runtime (as opposed to edit time).

Parameters:

game_view (bool) –

property teleporter_class: Class

[Read-Write] Teleporter Class: The teleporter to use when UnrealEd is in VR mode. Use VREditorTeleporter to get default editor behavior, or select a custom teleporter

Type:

(Class)