Component:RadiantModalOverlay: Difference between revisions

From Resonite Wiki
← Older editNewer edit →
VisualWikitext
Automated: update Fields, Categories
Added a description, added field descriptions.
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=RadiantModalOverlayComponent.png
|Image=RadiantModalOverlayComponent.png
Line 9: Line 8:


<!--T:2-->
<!--T:2-->
== Intoduction ==
The '''RadiantModalOverlay''' component is similar to the [[Component:ModalOverlay|ModalOverlay]], but with the [[Context menu|radial menu]]. This also can be duplicated as a template in the [[Component:ModalOverlayManager|ModalOverlayManager]] component.


<!--T:3-->
<!--T:3-->
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|ShowLerp|Float|
|ShowLerp|Float|The lerp amount for this modal.
|AnimationTime|Float|
|AnimationTime|Float|The lerp time for this modal.
|SizeRoot|'''[[Component:RectTransform|RectTransform]]'''|TypeAdv2=true|
|SizeRoot|'''[[Component:RectTransform|RectTransform]]'''|TypeAdv2=true|The size of this modal.
|ContentRoot|'''[[Component:RectTransform|RectTransform]]'''|TypeAdv3=true|
|ContentRoot|'''[[Component:RectTransform|RectTransform]]'''|TypeAdv3=true|The center root of this modal.
|CloseOnContextMenuAction|Bool|
|CloseOnContextMenuAction|Bool|Closes the modal when the user's context menu closes.
|CloseOnClick|Bool|
|CloseOnClick|Bool|Closes this modal when it is clicked on.
|BlurSpread|Float|
|BlurSpread|Float|The blur effect amount.
|BackgroundColor|ColorX|
|BackgroundColor|ColorX|The background color of this RadiantModalOverlay.
|ContentAnimationScaleOffset|Float|
|ContentAnimationScaleOffset|Float|Offests the content animation for this RadiantModalOverlay.
|HeaderSize|Float|
|HeaderSize|Float|The header size of this RadiantModalOverlay.
|Padding|Float|
|Padding|Float|The padding amount for this RadiantModalOverlay.
|_title|'''[[Component:Text|Text]]'''|TypeAdv11=true|
|_title|'''[[Component:Text|Text]]'''|TypeAdv11=true|The title of this RadiantModalOverlay.
|_blur|'''[[BlurMaterial|BlurMaterial]]'''|TypeAdv12=true|
|_blur|'''[[BlurMaterial|BlurMaterial]]'''|TypeAdv12=true|The blur of this RadiantModalOverlay.
|_blurGraphic|'''[[Component:RawGraphic|RawGraphic]]'''|TypeAdv13=true|
|_blurGraphic|'''[[Component:RawGraphic|RawGraphic]]'''|TypeAdv13=true|The blur graphic of this RadiantModalOverlay.
|_blurSpread|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv14=true|
|_blurSpread|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv14=true|The blur speed of this RadiantModalOverlay.
|_backgroundColor|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv15=true|
|_backgroundColor|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv15=true|The background color of this RadiantModalOverlay.
|_maskRect|{{RootFieldType|FieldDrive`1|[[Type:Rect|Rect]]}}|TypeAdv16=true|
|_maskRect|{{RootFieldType|FieldDrive`1|[[Type:Rect|Rect]]}}|TypeAdv16=true|The mask rect of this RadiantModalOverlay.
|_headerOffsetMin|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv17=true|
|_headerOffsetMin|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv17=true|The header offset min of this RadiantModalOverlay.
|_headerOffsetMax|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv18=true|
|_headerOffsetMax|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv18=true|The header offset max of this RadiantModalOverlay.
|_contentOffsetMin|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv19=true|
|_contentOffsetMin|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv19=true|The content offset min of this RadiantModalOverlay.
|_contentOffsetMax|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv20=true|
|_contentOffsetMax|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv20=true|The content offset max of this RadiantModalOverlay.
|_titleOffsetMin|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv21=true|
|_titleOffsetMin|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv21=true|The title offset min of this RadiantModalOverlay.
|_titleOffsetMax|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv22=true|
|_titleOffsetMax|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv22=true|The title offset max of this RadiantModalOverlay.
|_closeOffsetMin|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv23=true|
|_closeOffsetMin|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv23=true|The close offset min of this RadiantModalOverlay.
|_closeOffsetMax|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv24=true|
|_closeOffsetMax|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv24=true|The close offset max of this RadiantModalOverlay.
}}
}}


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


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

Revision as of 11:05, 27 July 2024

Component image 
RadiantModalOverlay component as seen in the Scene Inspector


The RadiantModalOverlay component is similar to the ModalOverlay, but with the radial menu. This also can be duplicated as a template in the ModalOverlayManager component.

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.
ShowLerp Float The lerp amount for this modal.
AnimationTime Float The lerp time for this modal.
SizeRoot RectTransform The size of this modal.
ContentRoot RectTransform The center root of this modal.
CloseOnContextMenuAction Bool Closes the modal when the user's context menu closes.
CloseOnClick Bool Closes this modal when it is clicked on.
BlurSpread Float The blur effect amount.
BackgroundColor ColorX The background color of this RadiantModalOverlay.
ContentAnimationScaleOffset Float Offests the content animation for this RadiantModalOverlay.
HeaderSize Float The header size of this RadiantModalOverlay.
Padding Float The padding amount for this RadiantModalOverlay.
_title Text The title of this RadiantModalOverlay.
_blur BlurMaterial The blur of this RadiantModalOverlay.
_blurGraphic RawGraphic The blur graphic of this RadiantModalOverlay.
_blurSpread field drive of Float2 The blur speed of this RadiantModalOverlay.
_backgroundColor field drive of ColorX The background color of this RadiantModalOverlay.
_maskRect field drive of Rect The mask rect of this RadiantModalOverlay.
_headerOffsetMin field drive of Float2 The header offset min of this RadiantModalOverlay.
_headerOffsetMax field drive of Float2 The header offset max of this RadiantModalOverlay.
_contentOffsetMin field drive of Float2 The content offset min of this RadiantModalOverlay.
_contentOffsetMax field drive of Float2 The content offset max of this RadiantModalOverlay.
_titleOffsetMin field drive of Float2 The title offset min of this RadiantModalOverlay.
_titleOffsetMax field drive of Float2 The title offset max of this RadiantModalOverlay.
_closeOffsetMin field drive of Float2 The close offset min of this RadiantModalOverlay.
_closeOffsetMax field drive of Float2 The close offset max of this RadiantModalOverlay.

Usage

Examples

Related Components

Retrieved from "https://wiki.resonite.com/index.php?title=Component:RadiantModalOverlay&oldid=88766"