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 (MagicLeapSingleContactResultDelegateMulti): [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 (MagicLeapSingleContactResultDelegateMulti): [Read-Write] On Delete Contact Result

  • on_edit_contact_result (MagicLeapSingleContactResultDelegateMulti): [Read-Write] On Edit Contact Result

  • on_log_message (MagicLeapContactsLogMessageMulti): [Read-Write] On Log Message

  • on_request_contacts_result (MagicLeapMultipleContactsResultDelegateMulti): [Read-Write] On Request Contacts Result

  • on_search_contacts_result (MagicLeapMultipleContactsResultDelegateMulti): [Read-Write] On Search Contacts Result

  • on_select_contacts_result (MagicLeapMultipleContactsResultDelegateMulti): [Read-Write] On Select Contacts Result

  • 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!

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.

Return type

Guid

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.

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.

Return type

Guid

property on_add_contact_result

[Read-Write] Delegate instances

Type

(MagicLeapSingleContactResultDelegateMulti)

property on_delete_contact_result

[Read-Write] On Delete Contact Result

Type

(MagicLeapSingleContactResultDelegateMulti)

property on_edit_contact_result

[Read-Write] On Edit Contact Result

Type

(MagicLeapSingleContactResultDelegateMulti)

property on_log_message

[Read-Write] On Log Message

Type

(MagicLeapContactsLogMessageMulti)

property on_request_contacts_result

[Read-Write] On Request Contacts Result

Type

(MagicLeapMultipleContactsResultDelegateMulti)

property on_search_contacts_result

[Read-Write] On Search Contacts Result

Type

(MagicLeapMultipleContactsResultDelegateMulti)

property on_select_contacts_result

[Read-Write] On Select Contacts Result

Type

(MagicLeapMultipleContactsResultDelegateMulti)

request_contacts_async(max_num_results)Guid

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

Parameters

max_num_results (int32) – The maximum number of results to return.

Returns

A unique identifier for this request.

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.

Return type

Guid

select_contacts_async(max_num_results, search_field)Guid

Pops up a dialog allowing the user to manually select the contacts they wish to query.

Parameters
  • max_num_results (int32) – The maximum number of contacts to display (values greater than number of contacts will result in an invalid param error).

  • search_field (MagicLeapContactsSearchField) – Specifies which field(s) to retrieve for each selected contact.

Returns

A unique identifier for this request.

Return type

Guid