unreal.MagicLeapContactsComponent

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

Bases: unreal.ActorComponent

Component that provides access to the Contacts API functionality.

C++ Source:

  • Plugin: MagicLeapContacts
  • Module: MagicLeapContacts
  • File: MagicLeapContactsComponent.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_add_contact_result (SingleContactResultDelegateMulti): [Read-Write] Delegate instances
  • 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
  • on_delete_contact_result (SingleContactResultDelegateMulti): [Read-Write] On Delete Contact Result
  • on_edit_contact_result (SingleContactResultDelegateMulti): [Read-Write] On Edit Contact Result
  • on_log_message (ContactsLogMessageMulti): [Read-Write] On Log Message
  • on_request_contacts_result (MultipleContactsResultDelegateMulti): [Read-Write] On Request Contacts Result
  • on_search_contacts_result (MultipleContactsResultDelegateMulti): [Read-Write] On Search Contacts Result
  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Main tick function for the Component
  • replicates (bool): [Read-Write] Replicates
add_contact_async(contact) → Guid

Initiates the creation of a new contact.

Parameters:contact (MagicLeapContact) – The contact to be created.
Returns:A unique identifier for this request (required if request needs to be cancelled).
Return type:Guid
cancel_request(request_handle) → bool

Cancels a request corresponding to the FGuid.

Parameters:request_handle (Guid) – The unique identifier of the request (returned by all contact request functions).
Returns:True if the cancellation succeeded, false otherwise.
Return type:bool
delete_contact_async(contact) → Guid

Initiates the deletion of an existing contact.

Parameters:contact (MagicLeapContact) – The contact to be deleted.
Returns:A unique identifier for this request (required if request needs to be cancelled).
Return type:Guid
edit_contact_async(contact) → Guid

Initiates the update of an existing contact.

Parameters:contact (MagicLeapContact) – The contact to be updated.
Returns:A unique identifier for this request (required if request needs to be cancelled).
Return type:Guid
on_add_contact_result

(SingleContactResultDelegateMulti) – [Read-Write] Delegate instances

on_delete_contact_result

(SingleContactResultDelegateMulti) – [Read-Write] On Delete Contact Result

on_edit_contact_result

(SingleContactResultDelegateMulti) – [Read-Write] On Edit Contact Result

on_log_message

(ContactsLogMessageMulti) – [Read-Write] On Log Message

on_request_contacts_result

(MultipleContactsResultDelegateMulti) – [Read-Write] On Request Contacts Result

on_search_contacts_result

(MultipleContactsResultDelegateMulti) – [Read-Write] On Search Contacts Result

request_contacts_async() → Guid

Initiates the retrieval of the entire contacts list from the cloud.

Returns:A unique identifier for this request (required if request needs to be cancelled).
Return type:Guid
search_contacts_async(query, search_field) → Guid

Initiates a search for contacts with a given query across specified fields.

Parameters:
  • query (str) – The search string to look for instances of.
  • search_field (MagicLeapContactsSearchField) – The field within the contact to match the query against.
Returns:

A unique identifier for this request (required if request needs to be cancelled).

Return type:

Guid