This is no longer a stub. Added a description, added field descriptions, added usage description. |
Automated: update Replace |
||
| (One intermediate revision by the same user not shown) | |||
| Line 23: | Line 23: | ||
|_previousEnabled|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv9=true| Becomes false if the minimum is currently reached. | |_previousEnabled|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv9=true| Becomes false if the minimum is currently reached. | ||
|_nextEnabled|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv10=true| Becomes false if the maximum is currently reached. | |_nextEnabled|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv10=true| Becomes false if the maximum is currently reached. | ||
}} | |||
== Sync Delegates == | |||
{{Table ComponentTriggers | |||
|NextPage()|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData>| | |||
|PreviousPage()|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData>| | |||
|NextPage()|[[Type:Action|Action]]| | |||
|PreviousPage()|[[Type:Action|Action]]| | |||
}} | }} | ||
| Line 36: | Line 44: | ||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}|Paging Control]] | [[Category:Components{{#translation:}}|Paging Control]] | ||
[[Category:ComponentStubs]] | |||
[[Category:Components:Common UI:General{{#translation:}}|Paging Control]] | [[Category:Components:Common UI:General{{#translation:}}|Paging Control]] | ||
Latest revision as of 21:06, 6 November 2024
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. |
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. | Description |
|---|---|---|
NextPage()
|
Delegate<IButton: button, ButtonEventData: eventData> | |
PreviousPage()
|
Delegate<IButton: button, ButtonEventData: eventData> | |
NextPage()
|
Action | |
PreviousPage()
|
Action |
Usage
Great for counting items.