unreal.VRNotificationsComponent

class unreal.VRNotificationsComponent(outer=None, name='None')

Bases: unreal.ActorComponent

VRNotifications Component

C++ Source:

• Module: HeadMountedDisplay

• File: VRNotificationsComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

• asset_user_data (Array(AssetUserData)): [Read-Write] Asset User Data: Array of user data stored with the component

• auto_activate (bool): [Read-Write] Auto Activate: Whether the component is activated at creation or must be explicitly activated.

• can_ever_affect_navigation (bool): [Read-Write] Can Ever Affect Navigation: Whether this component can potentially influence navigation

• component_tags (Array(Name)): [Read-Write] Component Tags: Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

• editable_when_inherited (bool): [Read-Write] Editable when Inherited: True if this component can be modified when it was inherited from a parent actor class

• hmd_connect_canceled_delegate (VRNotificationsDelegate): [Read-Write] HMDConnect Canceled Delegate: This will be called when the user declines to connect the HMD when prompted to do so by a system dialog. (PS4 Only)

• hmd_lost_delegate (VRNotificationsDelegate): [Read-Write] HMDLost Delegate: This will be called when connection to HMD is lost.

• hmd_put_on_head_delegate (VRNotificationsDelegate): [Read-Write] HMDPut on Head Delegate: This will be called when the HMD detects that it has been put on by a player.

• hmd_recentered_delegate (VRNotificationsDelegate): [Read-Write] HMDRecentered Delegate: This will be called when the application is asked for VR headset recenter.

• hmd_reconnected_delegate (VRNotificationsDelegate): [Read-Write] HMDReconnected Delegate: This will be called when connection to HMD is restored.

• hmd_removed_from_head_delegate (VRNotificationsDelegate): [Read-Write] HMDRemoved from Head Delegate: This will be called when the HMD detects that it has been taken off by a player (disconnecting the hmd also causes it to register as taken off).

• hmd_tracking_initialized_delegate (VRNotificationsDelegate): [Read-Write] HMDTracking Initialized Delegate: This will be called on Morpheus when the HMD is done initializing and therefore reprojection will start functioning. The app can continue now. (PS4 Only)

• hmd_tracking_initializing_and_needs_hmd_to_be_tracked_delegate (VRNotificationsDelegate): [Read-Write] HMDTracking Initializing and Needs HMDTo be Tracked Delegate: This will be called on Morpheus if the HMD starts up and is not fully initialized (in NOT_STARTED or CALIBRATING states). The HMD will stay in NOT_STARTED until it is successfully position tracked. Until it exits NOT_STARTED orientation based reprojection does not happen. Therefore we do not update rotation at all to avoid user discomfort. Instructions to get the hmd tracked should be shown to the user. Sony may fix this eventually. (PS4 Only)

• is_editor_only (bool): [Read-Write] Is Editor Only: If true, the component will be excluded from non-editor builds

• on_component_activated (ActorComponentActivatedSignature): [Read-Write] On Component Activated: Called when the component has been activated, with parameter indicating if it was from a reset

• on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] On Component Deactivated: Called when the component has been deactivated

• primary_component_tick (ActorComponentTickFunction): [Read-Write] Primary Component Tick: Main tick function for the Component

• replicates (bool): [Read-Write] Replicates: Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

• vr_controller_recentered_delegate (VRNotificationsDelegate): [Read-Write] VRController Recentered Delegate: This will be called when the VR system recenters a controller.

property hmd_connect_canceled_delegate

[Read-Write] HMDConnect Canceled Delegate: This will be called when the user declines to connect the HMD when prompted to do so by a system dialog. (PS4 Only)

Type

(VRNotificationsDelegate)

property hmd_lost_delegate

[Read-Write] HMDLost Delegate: This will be called when connection to HMD is lost.

Type

(VRNotificationsDelegate)

property hmd_put_on_head_delegate

[Read-Write] HMDPut on Head Delegate: This will be called when the HMD detects that it has been put on by a player.

Type

(VRNotificationsDelegate)

property hmd_recentered_delegate

[Read-Write] HMDRecentered Delegate: This will be called when the application is asked for VR headset recenter.

Type

(VRNotificationsDelegate)

property hmd_reconnected_delegate

[Read-Write] HMDReconnected Delegate: This will be called when connection to HMD is restored.

Type

(VRNotificationsDelegate)

property hmd_removed_from_head_delegate

[Read-Write] HMDRemoved from Head Delegate: This will be called when the HMD detects that it has been taken off by a player (disconnecting the hmd also causes it to register as taken off).

Type

(VRNotificationsDelegate)

property hmd_tracking_initialized_delegate

[Read-Write] HMDTracking Initialized Delegate: This will be called on Morpheus when the HMD is done initializing and therefore reprojection will start functioning. The app can continue now. (PS4 Only)

Type

(VRNotificationsDelegate)

property hmd_tracking_initializing_and_needs_hmd_to_be_tracked_delegate

[Read-Write] HMDTracking Initializing and Needs HMDTo be Tracked Delegate: This will be called on Morpheus if the HMD starts up and is not fully initialized (in NOT_STARTED or CALIBRATING states). The HMD will stay in NOT_STARTED until it is successfully position tracked. Until it exits NOT_STARTED orientation based reprojection does not happen. Therefore we do not update rotation at all to avoid user discomfort. Instructions to get the hmd tracked should be shown to the user. Sony may fix this eventually. (PS4 Only)

Type

(VRNotificationsDelegate)

property vr_controller_recentered_delegate

[Read-Write] VRController Recentered Delegate: This will be called when the VR system recenters a controller.

Type

(VRNotificationsDelegate)