Component:ModalOverlayManager: Difference between revisions

From Resonite Wiki
Automated: update Fields, Categories
Added a description and field descriptions.
 
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=ModalOverlayManagerComponent.png
|Image=ModalOverlayManagerComponent.png
Line 9: Line 8:


<!--T:2-->
<!--T:2-->
== Intoduction ==
The '''ModalOverlayManager''' component allows for the creation of [[Component:ModalOverlay|ModalOverlay]] [[Slot|slots]]. Using the <code>Template</code> field to create Modal Overlays duplicates.


<!--T:3-->
<!--T:3-->
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|Template|'''[[Component:ModalOverlay|ModalOverlay]]'''|TypeAdv0=true|
|Template|'''[[Component:ModalOverlay|ModalOverlay]]'''|TypeAdv0=true|The template ModalOverlay slot.
|Constructor|{{RootFieldType|SyncDelegate`1|[[Type:ModalOverlayConstructor|ModalOverlayConstructor]]}}|TypeAdv1=true|
|Constructor|{{RootFieldType|SyncDelegate`1|[[Type:ModalOverlayConstructor|ModalOverlayConstructor]]}}|TypeAdv1=true|The constructor to make the ModalOverlay.
|ModalOverlayRequested|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]&lt;[[Component:ModalOverlayManager|ModalOverlayManager]]&gt;}}|TypeAdv2=true|
|ModalOverlayRequested|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]&lt;[[Component:ModalOverlayManager|ModalOverlayManager]]&gt;}}|TypeAdv2=true|The action of the ModalOverlayManager.
|ModalOverlayGenerated|{{RootFieldType|SyncDelegate`1|[[Type:Action`2|Action`2]]&lt;[[Component:ModalOverlayManager|ModalOverlayManager]], [[Component:ModalOverlay|ModalOverlay]]&gt;}}|TypeAdv3=true|
|ModalOverlayGenerated|{{RootFieldType|SyncDelegate`1|[[Type:Action`2|Action`2]]&lt;[[Component:ModalOverlayManager|ModalOverlayManager]], [[Component:ModalOverlay|ModalOverlay]]&gt;}}|TypeAdv3=true|The action of the ModalOverlayManager.
|SpawnRoot|Slot|
|SpawnRoot|Slot|The slot hierarchy to spawn this modal overlay on.
}}
}}


<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==


<!--T:5-->
<!--T:5-->
Line 31: Line 29:
</translate>
</translate>
[[Category:Components{{#translation:}}|Modal Overlay Manager]]
[[Category:Components{{#translation:}}|Modal Overlay Manager]]
[[Category:ComponentStubs]]
[[Category:Components:UIX:Interaction{{#translation:}}|Modal Overlay Manager]]
[[Category:Components:UIX:Interaction{{#translation:}}|Modal Overlay Manager]]

Latest revision as of 10:27, 27 July 2024

Component image 
ModalOverlayManager component as seen in the Scene Inspector


The ModalOverlayManager component allows for the creation of ModalOverlay slots. Using the Template field to create Modal Overlays duplicates.

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.
Template ModalOverlay The template ModalOverlay slot.
Constructor ModalOverlayConstructor The constructor to make the ModalOverlay.
ModalOverlayRequested Action`1<ModalOverlayManager> The action of the ModalOverlayManager.
ModalOverlayGenerated Action`2<ModalOverlayManager, ModalOverlay> The action of the ModalOverlayManager.
SpawnRoot Slot The slot hierarchy to spawn this modal overlay on.

Usage

Examples

Related Components