WoW:API ItemTextGetPage: Difference between revisions

Latest revision as of 04:46, 15 August 2023

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < ItemTextGetPage

Get the number of the current item text page.

pageNum = ItemTextGetPage()

Parameters

Arguments

()

Returns

pageNum

pageNum: Number - The page number of the currently displayed page, starting at 1.

Details

This is used one the ITEM_TEXT_READY event has been received for a page.

Note that there is no function to return the total number of pages of the text, it must be found by iterating through until ItemTextHasNextPage returns nil.

@@ Line 1: / Line 1: @@
-<center>'''ItemTextGetPage''' - ''Documentation by [[User:Flickering|Flickering]]''</center>
+{{wowapi}}
 Get the number of the current item text page.
@@ Line 16: / Line 16: @@
 : This is used one the ITEM_TEXT_READY event has been received for a page.
-: Note that there is no function to return the total number of pages of the text, it must be found by iterating through until [[API ItemTextHasNext|ItemTextHasNext]] returns nil.
+: Note that there is no function to return the total number of pages of the text, it must be found by iterating through until [[API ItemTextHasNextPage|ItemTextHasNextPage]] returns nil.
 ----
 __NOTOC__
-{{Template:WoW API}}
-[[Category:API Item Text Functions|ItemTextGetPage]]