unreal.MagicLeapPrivileges

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

Bases: unreal.ActorComponent

Class which provides functions to check and request the priviliges the app has at runtime.

C++ Source:

  • Plugin: MagicLeap
  • Module: MagicLeap
  • File: MagicLeapPrivileges.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
  • 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
  • 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
  • replicates (bool): [Read-Write] Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!
check_privilege(privilege) → bool

Check whether the application has the specified privilege. This does not solicit consent from the end-user and is non-blocking.

Parameters:privilege (MagicLeapPrivilege) – The privilege to check.
Returns:True if the privilege is granted, false otherwise.
Return type:bool
request_privilege(privilege) → bool

Request the specified privilege. This may possibly solicit consent from the end-user; if so it will block.

Parameters:privilege (MagicLeapPrivilege) – The privilege to request.
Returns:True if the privilege is granted, false otherwise.
Return type:bool
request_privilege_async(privilege, result_delegate) → bool

Request the specified privilege asynchronously. This may possibly solicit consent from the end-user. Result will be delivered to the specified delegate.

Parameters:
Returns:

True if the privilege request was successfully dispatched, false otherwise.

Return type:

bool