Automated: create new component page |
add info |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{UserspaceComponent}} | |||
{{Infobox Component | {{Infobox Component | ||
|Image=NotificationPanelComponent.png | |Image=NotificationPanelComponent.png | ||
|Name=Notification Panel | |Name=Notification Panel | ||
}} | }} | ||
The '''NotificationPanel''' component is used in user space to show the User their notifications. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|DisplayDuration|Float| | |DisplayDuration|Float| How long to show notifications for. | ||
|Dash|'''[[Component:UserspaceRadiantDash|UserspaceRadiantDash]]'''|TypeAdv1=true| | |Dash|'''[[Component:UserspaceRadiantDash|UserspaceRadiantDash]]'''|TypeAdv1=true| The component for the dash in the same world. | ||
|_canvas|'''[[Component:Canvas|Canvas]]'''|TypeAdv2=true| | |_canvas|'''[[Component:Canvas|Canvas]]'''|TypeAdv2=true| The canvas Component showing notifications. | ||
|_notificationClip|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv3=true| | |_notificationClip|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv3=true| The audio to play on a new notification made. | ||
|_contactRequestClip|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv4=true| | |_contactRequestClip|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv4=true| The audio to play on a new contact request being made. | ||
|_inviteClip|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv5=true| | |_inviteClip|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv5=true| The audio to play on an invite clip being made. | ||
|_sociableClip|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv6=true| The audio to play when a friend goes to social status. | |||
|_userJoinClip|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv7=true| The audio to play when a user joins. | |||
|_userLeaveClip|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv8=true| The audio to play when a user leaves. | |||
}} | |||
== Sync Delegates == | |||
{{Table ComponentTriggers | |||
|OnNotificationPressed:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]<[[Type:String|String]]>|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]<[[Type:String|String]]>|true| Called when a notification element is touched. | |||
}} | }} | ||
== | == Usage == | ||
Used internally. | |||
== Examples == | == Examples == | ||
| Line 23: | Line 33: | ||
[[Category:Components:Uncategorized{{#translation:}}|Notification Panel]] | [[Category:Components:Uncategorized{{#translation:}}|Notification Panel]] | ||
[[Category:Components{{#translation:}}|Notification Panel]] | [[Category:Components{{#translation:}}|Notification Panel]] | ||
Latest revision as of 18:59, 26 June 2025
Component image File:NotificationPanelComponent.pngNotification Panel component as seen in the Scene Inspector
The NotificationPanel component is used in user space to show the User their notifications.
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. |
DisplayDuration
|
Float | How long to show notifications for. |
Dash
|
UserspaceRadiantDash | The component for the dash in the same world. |
_canvas
|
Canvas | The canvas Component showing notifications. |
_notificationClip
|
AudioClip | The audio to play on a new notification made. |
_contactRequestClip
|
AudioClip | The audio to play on a new contact request being made. |
_inviteClip
|
AudioClip | The audio to play on an invite clip being made. |
_sociableClip
|
AudioClip | The audio to play when a friend goes to social status. |
_userJoinClip
|
AudioClip | The audio to play when a user joins. |
_userLeaveClip
|
AudioClip | The audio to play when a user leaves. |
Sync Delegates
| Method Name | Method type and Arguments. | Is the method hidden? | Description |
|---|---|---|---|
OnNotificationPressed:ButtonEventHandler`1<String>
|
ButtonEventHandler`1<String> | ✓ | Called when a notification element is touched. |
Usage
Used internally.