WoW API: KBSetup BeginLoading

From AddOn Studio
Jump to navigation Jump to search

WoW API < KBSetup BeginLoading

Starts the loading of articles.

KBSetup_BeginLoading(articlesPerPage, currentPage)

Parameters[edit]

Arguments[edit]

(articlesPerPage, currentPage)
articlesPerPage
Integer - Number of articles shown on one page.
currentPage
Integer - The current page (starts at 1).

Returns[edit]

nil

Example[edit]

In KnowledgeBaseFrame_OnShow():

 KBSetup_BeginLoading(KBASE_NUM_ARTICLES_PER_PAGE, KBASE_CURRENT_PAGE)

From Blizzard's KnowledgeBaseFrame.lua (l. 51)

Details[edit]

  • This will start the article loading process and return immediately.
  • When all articles are loaded the event KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS is fired.
  • If an error occurs in the loading process, the event KNOWLEDGE_BASE_SETUP_LOAD_FAILURE is fired.