unreal.VRNotificationsComponent

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

Bases: ActorComponent

VRNotifications Component

C++ Source:

  • Plugin: XRBase

  • Module: XRBase

  • File: VRNotificationsComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

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

  • asset_user_data_editor_only (Array[AssetUserData]): [Read-Write] Array of user data stored with the component

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

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

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

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

  • hmd_connect_canceled_delegate (VRNotificationsDelegate): [Read-Write] 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] This will be called when connection to HMD is lost.

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

  • hmd_recentered_delegate (VRNotificationsDelegate): [Read-Write] This will be called when the XR runtime requests a recenter (such as when a system recenter button is pressed). Whether or not the HMD will actually be recentered on the runtime side depends on the runtime, device, and current tracking space (local/stage). By default, we do not automatically recenter on the application side. Recentering on either the runtime side or application side is sufficient to recenter the user, and recentering on both sides at once is acceptable.

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

  • hmd_removed_from_head_delegate (VRNotificationsDelegate): [Read-Write] 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] deprecated: Deprecated, no longer used.

  • hmd_tracking_initializing_and_needs_hmd_to_be_tracked_delegate (VRNotificationsDelegate): [Read-Write] deprecated: Deprecated, no longer used.

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

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

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

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

  • replicate_using_registered_sub_object_list (bool): [Read-Write] When true the replication system will only replicate the registered subobjects list When false the replication system will instead call the virtual ReplicateSubObjects() function where the subobjects need to be manually replicated.

  • replicates (bool): [Read-Write] 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] This will be called when the VR system recenters a controller.

  • xr_interaction_profile_changed_delegate (VRNotificationsDelegate): [Read-Write] This will be called whenever the interaction profile is altered.

  • xr_play_area_changed_delegate (VRNotificationsDelegate): [Read-Write] This will be called whenever the play area is altered.

  • xr_tracking_origin_changed_delegate (VRNotificationsDelegate): [Read-Write] This will be called whenever the tracking origin is altered.

property hmd_connect_canceled_delegate: VRNotificationsDelegate

[Read-Write] 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: VRNotificationsDelegate

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

Type:

(VRNotificationsDelegate)

property hmd_put_on_head_delegate: VRNotificationsDelegate

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

Type:

(VRNotificationsDelegate)

property hmd_recentered_delegate: VRNotificationsDelegate

[Read-Write] This will be called when the XR runtime requests a recenter (such as when a system recenter button is pressed). Whether or not the HMD will actually be recentered on the runtime side depends on the runtime, device, and current tracking space (local/stage). By default, we do not automatically recenter on the application side. Recentering on either the runtime side or application side is sufficient to recenter the user, and recentering on both sides at once is acceptable.

Type:

(VRNotificationsDelegate)

property hmd_reconnected_delegate: VRNotificationsDelegate

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

Type:

(VRNotificationsDelegate)

property hmd_removed_from_head_delegate: VRNotificationsDelegate

[Read-Write] 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: VRNotificationsDelegate

[Read-Write] deprecated: Deprecated, no longer used.

Type:

(VRNotificationsDelegate)

property hmd_tracking_initializing_and_needs_hmd_to_be_tracked_delegate: VRNotificationsDelegate

[Read-Write] deprecated: Deprecated, no longer used.

Type:

(VRNotificationsDelegate)

property vr_controller_recentered_delegate: VRNotificationsDelegate

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

Type:

(VRNotificationsDelegate)

property xr_interaction_profile_changed_delegate: VRNotificationsDelegate

[Read-Write] This will be called whenever the interaction profile is altered.

Type:

(VRNotificationsDelegate)

property xr_play_area_changed_delegate: VRNotificationsDelegate

[Read-Write] This will be called whenever the play area is altered.

Type:

(VRNotificationsDelegate)

property xr_tracking_origin_changed_delegate: VRNotificationsDelegate

[Read-Write] This will be called whenever the tracking origin is altered.

Type:

(VRNotificationsDelegate)