unreal.USteamVRInputDeviceFunctionLibrary

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

Bases: BlueprintFunctionLibrary

  • SteamVR Input Extended Functions

  • Functions and properties defined here are safe for developer use

C++ Source:

  • Plugin: SteamVR

  • Module: SteamVRInputDevice

  • File: SteamVRInputDeviceFunctionLibrary.h

classmethod find_steam_vr_action(action_name, action_set="main") -> (result=bool, found_action=SteamVRAction, found_action_set=SteamVRActionSet)

Find Steam VR Action deprecated: The SteamVR plugin is deprecated.

Parameters:

  • action_name (Name) –

  • action_set (Name) –

Returns:

result (bool):

found_action (SteamVRAction):

found_action_set (SteamVRActionSet):

Return type:

tuple

classmethod find_steam_vr_action_origin(action_name, action_set='main') → bool

Find Steam VR Action Origin deprecated: The SteamVR plugin is deprecated.

Parameters:

  • action_name (Name) –

  • action_set (Name) –

Return type:

bool

classmethod find_steam_vr_input_binding_info(action_name, action_set='main') → Array[SteamVRInputBindingInfo]

Find Steam VR Input Binding Info deprecated: The SteamVR plugin is deprecated.

Parameters:

  • action_name (Name) –

  • action_set (Name) –

Return type:

Array[SteamVRInputBindingInfo]

classmethod find_steam_vr_origin_tracked_device_info(action_name, action_set="main") -> (result=bool, input_origin_info=SteamVRInputOriginInfo)

Find Steam VR Origin Tracked Device Info deprecated: The SteamVR plugin is deprecated.

Parameters:

  • action_name (Name) –

  • action_set (Name) –

Returns:

result (bool):

input_origin_info (SteamVRInputOriginInfo):

Return type:

tuple

classmethod get_controller_fidelity() -> (left_controller_fidelity=ControllerFidelity, right_controller_fidelity=ControllerFidelity)

Get Controller Fidelity deprecated: The SteamVR plugin is deprecated.

Returns:

left_controller_fidelity (ControllerFidelity):

right_controller_fidelity (ControllerFidelity):

Return type:

tuple

classmethod get_curls_and_splays_state() -> (left_hand_state=bool, right_hand_state=bool)

Get Curls and Splays State deprecated: The SteamVR plugin is deprecated.

Returns:

left_hand_state (bool):

right_hand_state (bool):

Return type:

tuple

classmethod get_finger_curls_and_splays(hand, summary_data_type=SkeletalSummaryDataType.VR_SUMMARY_TYPE_FROM_ANIMATION) -> (finger_curls=SteamVRFingerCurls, finger_splays=SteamVRFingerSplays)

Get Finger Curls and Splays deprecated: The SteamVR plugin is deprecated.

Parameters:
Returns:

finger_curls (SteamVRFingerCurls):

finger_splays (SteamVRFingerSplays):

Return type:

tuple

classmethod get_left_hand_pose_data() -> (position=Vector, orientation=Rotator, angular_velocity=Vector, velocity=Vector)

Get Left Hand Pose Data deprecated: The SteamVR plugin is deprecated.

Returns:

position (Vector):

orientation (Rotator):

angular_velocity (Vector):

velocity (Vector):

Return type:

tuple

classmethod get_pose_source() → bool

Get Pose Source deprecated: The SteamVR plugin is deprecated.

Returns:

using_skeleton_pose (bool):

Return type:

bool

classmethod get_right_hand_pose_data() -> (position=Vector, orientation=Rotator, angular_velocity=Vector, velocity=Vector)

Get Right Hand Pose Data deprecated: The SteamVR plugin is deprecated.

Returns:

position (Vector):

orientation (Rotator):

angular_velocity (Vector):

velocity (Vector):

Return type:

tuple

classmethod get_skeletal_state() -> (left_hand_state=bool, right_hand_state=bool)

Get Skeletal State deprecated: The SteamVR plugin is deprecated.

Returns:

left_hand_state (bool):

right_hand_state (bool):

Return type:

tuple

classmethod get_skeletal_transform(with_controller=False) -> (left_hand=SteamVRSkeletonTransform, right_hand=SteamVRSkeletonTransform)

Get Skeletal Transform deprecated: The SteamVR plugin is deprecated.

Parameters:

with_controller (bool) –

Returns:

left_hand (SteamVRSkeletonTransform):

right_hand (SteamVRSkeletonTransform):

Return type:

tuple

classmethod get_steam_vr_action_array() → Array[SteamVRAction]

Get Steam VR Action Array deprecated: The SteamVR plugin is deprecated.

Returns:

steam_vr_actions (Array[SteamVRAction]):

Return type:

Array[SteamVRAction]

classmethod get_steam_vr_action_set_array() → Array[SteamVRActionSet]

Get Steam VR Action Set Array deprecated: The SteamVR plugin is deprecated.

Returns:

steam_vr_action_sets (Array[SteamVRActionSet]):

Return type:

Array[SteamVRActionSet]

classmethod get_steam_vr_global_predicted_seconds_from_now() → float

Get Steam VR Global Predicted Seconds from Now deprecated: The SteamVR plugin is deprecated.

Return type:

float

classmethod get_steam_vr_hand_pose_relative_to_now(hand=SteamVRHand.VR_LEFT, predicted_seconds_from_now=0.000000) → (position=Vector, orientation=Rotator) or None

Get Steam VR Hand Pose Relative to Now deprecated: The SteamVR plugin is deprecated.

Parameters:
Returns:

position (Vector):

orientation (Rotator):

Return type:

tuple or None

classmethod get_steam_vr_input_binding_info(steam_vr_action_handle) → Array[SteamVRInputBindingInfo]

Get Steam VR Input Binding Info deprecated: The SteamVR plugin is deprecated.

Parameters:

steam_vr_action_handle (SteamVRAction) –

Return type:

Array[SteamVRInputBindingInfo]

classmethod get_steam_vr_origin_localized_name(steam_vr_action, localized_parts) → str

Get Steam VR Origin Localized Name deprecated: The SteamVR plugin is deprecated.

Parameters:
Returns:

origin_localized_name (str):

Return type:

str

classmethod get_steam_vr_origin_tracked_device_info(steam_vr_action) → SteamVRInputOriginInfo or None

Get Steam VR Origin Tracked Device Info deprecated: The SteamVR plugin is deprecated.

Parameters:

steam_vr_action (SteamVRAction) –

Returns:

input_origin_info (SteamVRInputOriginInfo):

Return type:

SteamVRInputOriginInfo or None

classmethod get_user_ipd() → float

Get User IPD deprecated: The SteamVR plugin is deprecated.

Return type:

float

classmethod play_steam_vr_haptic_feedback(hand, start_seconds_from_now, duration_seconds=1.000000, frequency=1.000000, amplitude=0.500000) → None

Play Steam VR Haptic Feedback deprecated: The SteamVR plugin is deprecated.

Parameters:
classmethod reset_seated_position() → bool

Reset Seated Position deprecated: The SteamVR plugin is deprecated.

Return type:

bool

classmethod set_curls_and_splays_state(new_left_hand_state, new_right_hand_state) → None

Set Curls and Splays State deprecated: The SteamVR plugin is deprecated.

Parameters:

  • new_left_hand_state (bool) –

  • new_right_hand_state (bool) –

classmethod set_pose_source(use_skeleton_pose) → None

Set Pose Source deprecated: The SteamVR plugin is deprecated.

Parameters:

use_skeleton_pose (bool) –

classmethod set_steam_vr_global_predicted_seconds_from_now(new_value) → float

Set Steam VR Global Predicted Seconds from Now deprecated: The SteamVR plugin is deprecated.

Parameters:

new_value (float) –

Return type:

float

classmethod show_all_steam_vr_action_origins() → None

Show All Steam VR Action Origins deprecated: The SteamVR plugin is deprecated.

classmethod show_steam_vr_action_origin(steam_vr_action, steam_vr_action_set) → None

Show Steam VR Action Origin deprecated: The SteamVR plugin is deprecated.

Parameters: