Component:ContactItem: Difference between revisions

Latest revision as of 20:20, 19 March 2025

Component image

The ContactItem component is used in the contacts tab of the Dash Menu to be a contact in the list of contacts on that screen.

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.
`_background`	Image	The background element of the contact item.
`_statusIndicator`	Image	The image used to indicate the user status of the contact item.
`_thumbnail`	Image	The thumbnail Component of that user's profile picture.
`_thumbnailTexture`	StaticTexture2D	The texture being used to show a user's profile picture.
`_username`	Text	The text showing the user's username.
`_status`	Text	The text showing the user's status.
`_unreadCount`	Text	The text showing the number of unread messages from the user.
`_joinButton`	Button	The button that can be used to join the user.
`_rawUsername`	String	The raw string of the user's username without ignore tags.
`_alternateNames`	direct SyncFieldList`1<String>	A list of names the user may have had before.

Triggers
Method Name	Method type and Arguments.	Is the method hidden?	Description
`OnJoin:ButtonEventHandler`	ButtonEventHandler	✓	What to run when joining the user that corrosponds to this contact item.

@@ Line 8: / Line 8: @@
 {{Table ComponentFields
 |_background|'''[[Component:Image|Image]]'''|TypeAdv0=true| The background element of the contact item.
 |_statusIndicator|'''[[Component:Image|Image]]'''|TypeAdv1=true| The image used to indicate the user status of the contact item.
 |_thumbnail|'''[[Component:Image|Image]]'''|TypeAdv2=true| The thumbnail Component of that user's profile picture.
 |_thumbnailTexture|'''[[Component:StaticTexture2D|StaticTexture2D]]'''|TypeAdv3=true| The texture being used to show a user's profile picture.
 |_username|'''[[Component:Text|Text]]'''|TypeAdv4=true| The text showing the user's username.
 |_status|'''[[Component:Text|Text]]'''|TypeAdv5=true| The text showing the user's status.
@@ Line 17: / Line 17: @@
 |_rawUsername|String| The raw string of the user's username without ignore tags.
 |_alternateNames|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv9=true| A list of names the user may have had before.
+}}
+== Sync Delegates ==
+{{Table ComponentTriggers
+|OnJoin:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| What to run when joining the user that corrosponds to this contact item.
 }}