Component:ContactsDialog: Difference between revisions

Revision as of 19:37, 13 February 2025

Component image

Contacts Dialog component as seen in the Scene Inspector

The ContactsDialog component is used in the contacts screen of the Dash Menu to search, view, and talk to contacts.

Fields

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
`_searchBar`	TextField	The search bar to search for users.
`_listRoot`	Slot	The list of contacts.
`_sessionsRoot`	Slot	The slot where the list of sessions from the selected user will be.
`_messagesRoot`	Slot	The slot where the list of messages from the selected user will be.
`_status`	Image	The image icon being used for the selected user's status.
`_avatar`	Image	The image icon being used for the selected user's avatar image.
`_username`	Text	The text for the selected user's username.
`_userActionsRoot`	Slot	The root slot to store buttons for performing actions on the selected user.
`_sendMessageButton`	Button	The button for sending the currently typed message to the selected user.
`_sendVoiceMessageButton`	Button	The button for sending a voice message to the currently selected user.
`_sendMessageTextField`	TextField	The text field to type messages to send to users.
`_messagesScrollRect`	ScrollRect	The scroll rectangle component for the scroll area for messages to and from the selected user.
`_inviteButton`	Button	Invite the selected user to the currently focused session if possible.
`_banAllButton`	Button	Ban the selected user from all sessions that the current local user will host.
`_banSessionButton`	Button	Ban the selected user from the current focused session.
`_unblockedButton`	Button	The button to unblock the currently selected user.
`_avatarBlockButton`	Button	The button to block the currently selected user's avatar.
`_mutualBlockButton`	Button	The button to do a mutual block with the currently selected user.

Usage

Not used by the user. Exists as the dash's Contacts tab.

Examples

Contacts tab in the Dash Menu

@@ Line 3: / Line 3: @@
 |Name=Contacts Dialog
 }}
-{{stub}}
+The '''ContactsDialog''' component is used in the contacts screen of the [[Dash Menu]] to search, view, and talk to contacts.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|_searchBar|'''[[Component:TextField|TextField]]'''|TypeAdv0=true|
+|_searchBar|'''[[Component:TextField|TextField]]'''|TypeAdv0=true| The search bar to search for users.
-|_listRoot|Slot|
+|_listRoot|Slot| The list of contacts.
-|_sessionsRoot|Slot|
+|_sessionsRoot|Slot| The slot where the list of sessions from the selected user will be.
-|_messagesRoot|Slot|
+|_messagesRoot|Slot| The slot where the list of messages from the selected user will be.
-|_status|'''[[Component:Image|Image]]'''|TypeAdv4=true|
+|_status|'''[[Component:Image|Image]]'''|TypeAdv4=true| The image icon being used for the selected user's status.
-|_avatar|'''[[Component:Image|Image]]'''|TypeAdv5=true|
+|_avatar|'''[[Component:Image|Image]]'''|TypeAdv5=true| The image icon being used for the selected user's avatar image.
-|_username|'''[[Component:Text|Text]]'''|TypeAdv6=true|
+|_username|'''[[Component:Text|Text]]'''|TypeAdv6=true| The text for the selected user's username.
-|_userActionsRoot|Slot|
+|_userActionsRoot|Slot| The root slot to store buttons for performing actions on the selected user.
-|_sendMessageButton|'''[[Component:Button|Button]]'''|TypeAdv8=true|
+|_sendMessageButton|'''[[Component:Button|Button]]'''|TypeAdv8=true| The button for sending the currently typed message to the selected user.
-|_sendVoiceMessageButton|'''[[Component:Button|Button]]'''|TypeAdv9=true|
+|_sendVoiceMessageButton|'''[[Component:Button|Button]]'''|TypeAdv9=true| The button for sending a voice message to the currently selected user.
-|_sendMessageTextField|'''[[Component:TextField|TextField]]'''|TypeAdv10=true|
+|_sendMessageTextField|'''[[Component:TextField|TextField]]'''|TypeAdv10=true| The text field to type messages to send to users.
-|_messagesScrollRect|'''[[Component:ScrollRect|ScrollRect]]'''|TypeAdv11=true|
+|_messagesScrollRect|'''[[Component:ScrollRect|ScrollRect]]'''|TypeAdv11=true| The scroll rectangle component for the scroll area for messages to and from the selected user.
-|_inviteButton|'''[[Component:Button|Button]]'''|TypeAdv12=true|
+|_inviteButton|'''[[Component:Button|Button]]'''|TypeAdv12=true| Invite the selected user to the currently focused session if possible.
-|_banAllButton|'''[[Component:Button|Button]]'''|TypeAdv13=true|
+|_banAllButton|'''[[Component:Button|Button]]'''|TypeAdv13=true| Ban the selected user from all sessions that the current local user will host.
-|_banSessionButton|'''[[Component:Button|Button]]'''|TypeAdv14=true|
+|_banSessionButton|'''[[Component:Button|Button]]'''|TypeAdv14=true| Ban the selected user from the current focused session.
-|_unblockedButton|'''[[Component:Button|Button]]'''|TypeAdv15=true|
+|_unblockedButton|'''[[Component:Button|Button]]'''|TypeAdv15=true| The button to unblock the currently selected user.
-|_avatarBlockButton|'''[[Component:Button|Button]]'''|TypeAdv16=true|
+|_avatarBlockButton|'''[[Component:Button|Button]]'''|TypeAdv16=true| The button to block the currently selected user's avatar.
-|_mutualBlockButton|'''[[Component:Button|Button]]'''|TypeAdv17=true|
+|_mutualBlockButton|'''[[Component:Button|Button]]'''|TypeAdv17=true| The button to do a mutual block with the currently selected user.
 }}
-== Behavior ==
+== Usage ==
+Not used by the user. Exists as the dash's Contacts tab.
 == Examples ==
+Contacts tab in the [[Dash Menu]]
 == See Also ==
+* [[Dash Menu]]
 [[Category:Components:Uncategorized{{#translation:}}|Contacts Dialog]]
 [[Category:Components{{#translation:}}|Contacts Dialog]]
-[[Category:ComponentStubs]]