unreal.VPScoutingSubsystem
¶
-
class
unreal.
VPScoutingSubsystem
(outer=None, name='None')¶ Bases:
unreal.EditorSubsystem
Subsystem used for VR Scouting
C++ Source:
Plugin: VirtualProductionUtilities
Module: VPUtilitiesEditor
File: VPScoutingSubsystem.h
Editor Properties: (see get_editor_property/set_editor_property)
gesture_manager
(VPScoutingSubsystemGestureManagerBase): [Read-Write] GestureManager that manage some user input in VR editor.grip_nav_speed_coeff
(float): [Read-Write] This is a multiplier for grip nav speed so we can keep the grip nav value in the range 0-1 and increase this variable if we need a bigger rangeis_settings_menu_open
(bool): [Read-Write] bool to keep track of whether the settings menu panel in the main menu is openvp_subsystem_helpers
(VPScoutingSubsystemHelpersBase): [Read-Write] Subsystems can’t have any Blueprint implementations, so we attach this class for any BP logic that we to provide.
-
property
gesture_manager
¶ [Read-Only] GestureManager that manage some user input in VR editor.
-
classmethod
get_active_editor_vr_controllers
()¶ Get Active Editor VRControllers
- Returns
- Return type
Get grip nav speed for scouting in VR
- Returns
- Return type
-
get_panel_actor
(panel_id) → VREditorFloatingUI¶ Get UI panel Actor from the passed ID
- Parameters
panel_id (Name) –
- Returns
- Return type
-
get_panel_widget
(panel_id) → UserWidget¶ Get UI panel widget from the passed ID
- Parameters
panel_id (Name) –
- Returns
- Return type
-
classmethod
get_v_prod_panel_id
(panel) → Name¶ Get VProd Panel ID
- Parameters
panel (VProdPanelIDs) –
- Returns
- Return type
[Read-Write] This is a multiplier for grip nav speed so we can keep the grip nav value in the range 0-1 and increase this variable if we need a bigger range
- Type
(float)
-
classmethod
is_helper_system_enabled
() → bool¶ Whether the helper system on the controllers is enabled
- Returns
- Return type
-
classmethod
is_location_grid_snapping_enabled
() → bool¶ Whether location grid snapping is enabled
- Returns
- Return type
-
classmethod
is_rotation_grid_snapping_enabled
() → bool¶ Whether rotation grid snapping is enabled
- Returns
- Return type
[Read-Write] bool to keep track of whether the settings menu panel in the main menu is open
- Type
(bool)
-
classmethod
is_using_inertia_damping
() → bool¶ Whether grip nav inertia is enabled when scouting in VR
- Returns
- Return type
-
classmethod
is_using_metric_system
() → bool¶ Whether the VR user wants to use the metric system instead of imperial
- Returns
- Return type
-
classmethod
is_using_transform_gizmo
() → bool¶ Whether the VR user wants to have the transform gizmo enabled
- Returns
- Return type
-
classmethod
set_flight_speed
(flight_speed) → None¶ Set flight speed for scouting in VR
- Parameters
flight_speed (float) –
Set grip nav speed for scouting in VR
- Parameters
grip_nav_speed (float) –
-
classmethod
set_inertia_damping_c_var
(inertia_damping) → None¶ Set value of cvar “VI.HighSpeedInertiaDamping”
- Parameters
inertia_damping (float) –
-
classmethod
set_is_helper_system_enabled
(is_helper_system_enabled) → None¶ Set whether the helper system on the controllers is enabled
- Parameters
is_helper_system_enabled (bool) –
-
classmethod
set_is_using_inertia_damping
(is_using_inertia_damping) → None¶ Set whether grip nav inertia is enabled when scouting in VR
- Parameters
is_using_inertia_damping (bool) –
-
classmethod
set_is_using_metric_system
(use_metric_system) → None¶ Set whether the VR user wants to use the metric system instead of imperial
- Parameters
use_metric_system (bool) –
-
classmethod
set_is_using_transform_gizmo
(is_using_transform_gizmo) → None¶ Set whether the VR user wants to have the transform gizmo enabled
- Parameters
is_using_transform_gizmo (bool) –
-
classmethod
set_show_transform_gizmo_c_var
(show_transform_gizmo_c_var) → None¶ Set value of cvar “VI.ShowTransformGizmo”
- Parameters
show_transform_gizmo_c_var (bool) –
-
toggle_vr_scouting_ui
(creation_context) → VREditorFloatingUICreationContext¶ Open a widget UI in front of the user. Opens default VProd UI (defined via the ‘Virtual Scouting User Interface’ setting) if null.
- Parameters
creation_context (VREditorFloatingUICreationContext) –
- Returns
creation_context (VREditorFloatingUICreationContext):
- Return type
-
property
vp_subsystem_helpers
¶ [Read-Only] Subsystems can’t have any Blueprint implementations, so we attach this class for any BP logic that we to provide.