Automated: create new component page |
sync delegate |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
|Name=Contact Item | |Name=Contact Item | ||
}} | }} | ||
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 == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|_background|'''[[Component:Image|Image]]'''|TypeAdv0=true| | |_background|'''[[Component:Image|Image]]'''|TypeAdv0=true| The background element of the contact item. | ||
|_statusIndicator|'''[[Component:Image|Image]]'''|TypeAdv1=true| | |_statusIndicator|'''[[Component:Image|Image]]'''|TypeAdv1=true| The image used to indicate the user status of the contact item. | ||
|_thumbnail|'''[[Component:Image|Image]]'''|TypeAdv2=true| | |_thumbnail|'''[[Component:Image|Image]]'''|TypeAdv2=true| The thumbnail Component of that user's profile picture. | ||
|_thumbnailTexture|'''[[Component:StaticTexture2D|StaticTexture2D]]'''|TypeAdv3=true| | |_thumbnailTexture|'''[[Component:StaticTexture2D|StaticTexture2D]]'''|TypeAdv3=true| The texture being used to show a user's profile picture. | ||
|_username|'''[[Component:Text|Text]]'''|TypeAdv4=true| | |_username|'''[[Component:Text|Text]]'''|TypeAdv4=true| The text showing the user's username. | ||
|_status|'''[[Component:Text|Text]]'''|TypeAdv5=true| | |_status|'''[[Component:Text|Text]]'''|TypeAdv5=true| The text showing the user's status. | ||
|_unreadCount|'''[[Component:Text|Text]]'''|TypeAdv6=true| | |_unreadCount|'''[[Component:Text|Text]]'''|TypeAdv6=true| The text showing the number of unread messages from the user. | ||
|_joinButton|'''[[Component:Button|Button]]'''|TypeAdv7=true| | |_joinButton|'''[[Component:Button|Button]]'''|TypeAdv7=true| The button that can be used to join the user. | ||
|_rawUsername|String| | |_rawUsername|String| The raw string of the user's username without ignore tags. | ||
|_alternateNames|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv9=true| | |_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. | |||
}} | }} | ||
== | == Usage == | ||
See [[Dash Menu]]. | |||
== Examples == | == Examples == | ||
See [[Dash Menu]]. | |||
== See Also == | == See Also == | ||
* [[Dash Menu]] | |||
[[Category:Components:Uncategorized{{#translation:}}|Contact Item]] | [[Category:Components:Uncategorized{{#translation:}}|Contact Item]] | ||
[[Category:Components{{#translation:}}|Contact Item]] | [[Category:Components{{#translation:}}|Contact Item]] | ||
Latest revision as of 20:20, 19 March 2025
Component image 
Contact Item component as seen in the Scene Inspector
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. |
Sync Delegates
| 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. |
Usage
See Dash Menu.
Examples
See Dash Menu.