989onan bot (talk | contribs) Automated: update SyncDelegates |
add more info |
||
Line 27: | Line 27: | ||
== Sync Delegates == | == Sync Delegates == | ||
{{Table ComponentTriggers | {{Table ComponentTriggers | ||
|NextPage:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| | |NextPage:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Switches to the next page via button. | ||
|PreviousPage:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| | |PreviousPage:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|Switches to the previous page via button. | ||
|NextPage:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Switches to the next page via | |NextPage:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Switches to the next page via action. | ||
|PreviousPage:[[Type:Action|Action]]|[[Type:Action|Action]]|false|Switches to the previous page via | |PreviousPage:[[Type:Action|Action]]|[[Type:Action|Action]]|false|Switches to the previous page via action. | ||
}} | }} | ||
<!--T:3--> | <!--T:3--> | ||
== Usage == | == Usage == | ||
Great for counting items. | Great for counting items, and for controlling UI that can switch pages. | ||
<!--T:4--> | <!--T:4--> | ||
Line 41: | Line 41: | ||
<!--T:5--> | <!--T:5--> | ||
== | == See Also == | ||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}|Paging Control]] | [[Category:Components{{#translation:}}|Paging Control]] | ||
[[Category:Components:Common UI:General{{#translation:}}|Paging Control]] | [[Category:Components:Common UI:General{{#translation:}}|Paging Control]] |
Latest revision as of 23:47, 31 March 2025
Component image 
Paging Control component as seen in the Scene Inspector

The PagingControl component allows for counting up a number of items specified, then outputs it to either a Text or TextRenderer 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. |
ItemsPerPage
|
Int | The increment to count up by. |
TotalItems
|
Int | The total amount of items. |
HasMoreItems
|
Bool | Allows to count beyond the max set of items. |
SkipItems
|
Int | Skips items that are listed here. |
NoItemsLabel
|
String | Shows the output as this when there are no items. |
PagingInfoLabel
|
String | The structure of how the items will be shown to the user. |
TotalPages
|
raw output of Int | The total amount of items. |
RemainingItems
|
raw output of Int | Shows how many items are remaining. |
_label
|
field drive of String | The text to output. |
_previousEnabled
|
field drive of Bool | Becomes false if the minimum is currently reached. |
_nextEnabled
|
field drive of Bool | Becomes false if the maximum is currently reached. |
Sync Delegates
Method Name | Method type and Arguments. | Is the method hidden? | Description |
---|---|---|---|
NextPage:ButtonEventHandler
|
ButtonEventHandler | ✓ | Switches to the next page via button. |
PreviousPage:ButtonEventHandler
|
ButtonEventHandler | ✓ | Switches to the previous page via button. |
NextPage:Action
|
Action | X | Switches to the next page via action. |
PreviousPage:Action
|
Action | X | Switches to the previous page via action. |
Usage
Great for counting items, and for controlling UI that can switch pages.