Component:WorldCloseDialog: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{UserspaceComponent}}
{{Infobox Component
{{Infobox Component
|Image=WorldCloseDialogComponent.png
|Image=WorldCloseDialogComponent.png
|Name=World Close Dialog
|Name=World Close Dialog
}}
}}
{{stub}}
The '''WorldCloseDialog''' component is used to confirm closing a world that the user is currently trying to close.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|_worldName|'''[[Component:Text|Text]]'''|TypeAdv0=true|
|_worldName|'''[[Component:Text|Text]]'''|TypeAdv0=true| The text field showing the name of the world being closed.
|_saveButton|'''[[Component:Button|Button]]'''|TypeAdv1=true|
|_saveButton|'''[[Component:Button|Button]]'''|TypeAdv1=true| The button used to save the world being closed.
|_saveAsButton|'''[[Component:Button|Button]]'''|TypeAdv2=true|
|_saveAsButton|'''[[Component:Button|Button]]'''|TypeAdv2=true| The button used to save the world as something for the world being closed.
|_discardButton|'''[[Component:Button|Button]]'''|TypeAdv3=true|
|_discardButton|'''[[Component:Button|Button]]'''|TypeAdv3=true| The button used to discard changes for the world being closed.
|_saveAction|'''[[Component:WorldCloseAction|WorldCloseAction]]'''|TypeAdv4=true|
|_saveAction|'''[[Component:WorldCloseAction|WorldCloseAction]]'''|TypeAdv4=true| The component to trigger with the request to save the world being closed.
|_saveAsAction|'''[[Component:WorldCloseAction|WorldCloseAction]]'''|TypeAdv5=true|
|_saveAsAction|'''[[Component:WorldCloseAction|WorldCloseAction]]'''|TypeAdv5=true| The component to trigger with the request to save the world as something for the world being closed.
|_discardAction|'''[[Component:WorldCloseAction|WorldCloseAction]]'''|TypeAdv6=true|
|_discardAction|'''[[Component:WorldCloseAction|WorldCloseAction]]'''|TypeAdv6=true| The component to trigger with the request to discard changes for the world being closed.
}}
 
== Sync Delegates ==
{{Table ComponentTriggers
|Close:[[Type:Action|Action]]|[[Type:Action|Action]]|true| Tells the world to close.
|OnCancel:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Tells the dialog to cancel closing the world.
}}
}}


== Behavior ==
== Usage ==
Not used directly by the user.


== Examples ==
== Examples ==
Generated when the user tries to close a world that has unsaved changes.


== See Also ==
== See Also ==
* [[World]]
* [[Worlds Menu]]


[[Category:Components:Uncategorized{{#translation:}}|World Close Dialog]]
[[Category:Components:Uncategorized{{#translation:}}|World Close Dialog]]
[[Category:Components{{#translation:}}|World Close Dialog]]
[[Category:Components{{#translation:}}|World Close Dialog]]
[[Category:ComponentStubs]]

Latest revision as of 00:02, 4 May 2025

This is a userspace component — you cannot attach it anywhere but the userspace. Messing with the userspace can be fun, but it is not recommended as you risk messing your dash up if you don't know what you're doing.
Component image 
World Close Dialog component as seen in the Scene Inspector

The WorldCloseDialog component is used to confirm closing a world that the user is currently trying to close.

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.
_worldName Text The text field showing the name of the world being closed.
_saveButton Button The button used to save the world being closed.
_saveAsButton Button The button used to save the world as something for the world being closed.
_discardButton Button The button used to discard changes for the world being closed.
_saveAction WorldCloseAction The component to trigger with the request to save the world being closed.
_saveAsAction WorldCloseAction The component to trigger with the request to save the world as something for the world being closed.
_discardAction WorldCloseAction The component to trigger with the request to discard changes for the world being closed.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
Close:Action Action Tells the world to close.
OnCancel:ButtonEventHandler ButtonEventHandler Tells the dialog to cancel closing the world.

Usage

Not used directly by the user.

Examples

Generated when the user tries to close a world that has unsaved changes.

See Also