Automated: update Fields, Categories |
Added a video. |
||
(One intermediate revision by the same user not shown) | |||
Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
{{Infobox Component | {{Infobox Component | ||
|Image=AxisMultiViewportPannerComponent.png | |Image=AxisMultiViewportPannerComponent.png | ||
Line 9: | Line 8: | ||
<!--T:2--> | <!--T:2--> | ||
The '''AxisMultiViewportPanner''' component toggles through [[UIX]] element's active state, min and max of the [[Component:RectTransform|RectTransform]]'s anchor. This allows a [[User|user]] to make "pages" in UIX. | |||
<!--T:3--> | <!--T:3--> | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|ViewportIndex|Int| | |ViewportIndex|Int|The current focused viewport [[UIX]] element. | ||
|AnimationTime|Float| | |AnimationTime|Float|The time it takes to pan across to get to the selected viewport index. | ||
|Direction|'''[[#AlignDirection|AlignDirection]]'''|TypeAdv2=true| | |Direction|'''[[#AlignDirection|AlignDirection]]'''|TypeAdv2=true|The direction this animates to get to the selected viewport index. | ||
|Viewports|{{RootFieldType|SyncList`1|[[#Viewport|Viewport]]}}|TypeAdv3=true| | |Viewports|{{RootFieldType|SyncList`1|[[#Viewport|Viewport]]}}|TypeAdv3=true|The list of [[UIX]] element viewports to pan to. | ||
}} | }} | ||
<!--T:4--> | <!--T:4--> | ||
== | == Usage == | ||
This is useful if you want to make a slideshow, tab pages for [[UIX]], or anything that you want to have pan across for multiple pages in your design. | |||
{{Note|This component does not have the capability of jumping or skipping from on page directly to the next while also using the animation time. It will go through each page one at a time to get to the destination. If you want to have the functionality to jump to a page, you will need to do a bit of math currently.|warning}} | |||
<!--T:5--> | <!--T:5--> | ||
== Examples == | == Examples == | ||
=== Videos === | |||
[[User:ProbablePrime|ProbablePrime]]'s tutorial video about the AxisMultiViewportPanner: | |||
<youtube>kbASFui7YWk</youtube> | |||
<!--T:6--> | <!--T:6--> | ||
Line 30: | Line 36: | ||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}|Axis Multi Viewport Panner]] | [[Category:Components{{#translation:}}|Axis Multi Viewport Panner]] | ||
[[Category:Components With Nested Enums{{#translation:}}|Axis Multi Viewport Panner]] | [[Category:Components With Nested Enums{{#translation:}}|Axis Multi Viewport Panner]] | ||
[[Category:Components With Nested Types{{#translation:}}|Axis Multi Viewport Panner]] | [[Category:Components With Nested Types{{#translation:}}|Axis Multi Viewport Panner]] | ||
[[Category:Components:UIX:Utility{{#translation:}}|Axis Multi Viewport Panner]] | [[Category:Components:UIX:Utility{{#translation:}}|Axis Multi Viewport Panner]] |
Latest revision as of 00:47, 29 July 2024
Component image
The AxisMultiViewportPanner component toggles through UIX element's active state, min and max of the RectTransform's anchor. This allows a user to make "pages" in UIX.
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. |
ViewportIndex
|
Int | The current focused viewport UIX element. |
AnimationTime
|
Float | The time it takes to pan across to get to the selected viewport index. |
Direction
|
AlignDirection | The direction this animates to get to the selected viewport index. |
Viewports
|
list of Viewport | The list of UIX element viewports to pan to. |
Usage
This is useful if you want to make a slideshow, tab pages for UIX, or anything that you want to have pan across for multiple pages in your design.
Examples
Videos
ProbablePrime's tutorial video about the AxisMultiViewportPanner: