989onan bot (talk | contribs) Automated: update SyncDelegates |
add info |
||
Line 3: | Line 3: | ||
|Name=Session Item | |Name=Session Item | ||
}} | }} | ||
The '''SessionItem''' component is used to handle the session items in a world menu. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|_background|'''[[Component:Image|Image]]'''|TypeAdv0=true| | |_background|'''[[Component:Image|Image]]'''|TypeAdv0=true| The UIX image handling the background for this session item. | ||
|_statusIndicator|'''[[Component:Image|Image]]'''|TypeAdv1=true| | |_statusIndicator|'''[[Component:Image|Image]]'''|TypeAdv1=true| The UIX image used to handle showing the status for this world like access level. | ||
|_thumbnail|'''[[Component:Image|Image]]'''|TypeAdv2=true| | |_thumbnail|'''[[Component:Image|Image]]'''|TypeAdv2=true| The UIX image handling the session preview thumbnail. | ||
|_thumbnailTexture|'''[[Component:StaticTexture2D|StaticTexture2D]]'''|TypeAdv3=true| | |_thumbnailTexture|'''[[Component:StaticTexture2D|StaticTexture2D]]'''|TypeAdv3=true| The image handling the session preview thumbnail image data. | ||
|_sessionName|'''[[Component:Text|Text]]'''|TypeAdv4=true| | |_sessionName|'''[[Component:Text|Text]]'''|TypeAdv4=true| The text visual being used to show the session name. | ||
|_sessionHost|'''[[Component:Text|Text]]'''|TypeAdv5=true| | |_sessionHost|'''[[Component:Text|Text]]'''|TypeAdv5=true| The text visual being used to show the session host's name. | ||
|_userCount|'''[[Component:Text|Text]]'''|TypeAdv6=true| | |_userCount|'''[[Component:Text|Text]]'''|TypeAdv6=true| The text visual being used to show the session user count. | ||
|_joinButton|'''[[Component:Button|Button]]'''|TypeAdv7=true| | |_joinButton|'''[[Component:Button|Button]]'''|TypeAdv7=true| The button that can be used to join the specified session. | ||
}} | }} | ||
== Sync Delegates == | == Sync Delegates == | ||
{{Table ComponentTriggers | {{Table ComponentTriggers | ||
|OnJoin:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| | |OnJoin:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the join button is touched. | ||
}} | }} | ||
== | == Usage == | ||
not to be used directly by the user. | |||
== Examples == | == Examples == | ||
used in world menus. | |||
== See Also == | == See Also == | ||
Line 30: | Line 32: | ||
[[Category:Components:Uncategorized{{#translation:}}|Session Item]] | [[Category:Components:Uncategorized{{#translation:}}|Session Item]] | ||
[[Category:Components{{#translation:}}|Session Item]] | [[Category:Components{{#translation:}}|Session Item]] | ||
Latest revision as of 17:20, 8 April 2025
Component image 
Session Item component as seen in the Scene Inspector

The SessionItem component is used to handle the session items in a world menu.
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 UIX image handling the background for this session item. |
_statusIndicator
|
Image | The UIX image used to handle showing the status for this world like access level. |
_thumbnail
|
Image | The UIX image handling the session preview thumbnail. |
_thumbnailTexture
|
StaticTexture2D | The image handling the session preview thumbnail image data. |
_sessionName
|
Text | The text visual being used to show the session name. |
_sessionHost
|
Text | The text visual being used to show the session host's name. |
_userCount
|
Text | The text visual being used to show the session user count. |
_joinButton
|
Button | The button that can be used to join the specified session. |
Sync Delegates
Method Name | Method type and Arguments. | Is the method hidden? | Description |
---|---|---|---|
OnJoin:ButtonEventHandler
|
ButtonEventHandler | ✓ | Called when the join button is touched. |
Usage
not to be used directly by the user.
Examples
used in world menus.