12.07.2015 Views

Wiley-World.of.Warcraft.Programming.A.Guide.and.Reference.for.Creating.WoW.Addons

Wiley-World.of.Warcraft.Programming.A.Guide.and.Reference.for.Creating.WoW.Addons

Wiley-World.of.Warcraft.Programming.A.Guide.and.Reference.for.Creating.WoW.Addons

SHOW MORE
SHOW LESS
  • No tags were found...

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

Chapter 27 ■ API <strong>Reference</strong> 867ProtectedArguments:channel—Name <strong>of</strong> a channel to join (string)JumpOrAscendStartCauses the player character to jump (or begins ascent if swimming or flying).Used by the JUMP binding, which also controls ascent when swimming orflying.KBArticle_BeginLoadingRequests a specific knowledge base article from the server.KBArticle_BeginLoading(articleId, searchType)Arguments:articleId—The unique articleId to request (number)searchType—The search type <strong>of</strong> the request (number)1—Default ‘‘top issues’’ search2—Search <strong>for</strong> specific textKBArticle_GetDataReturns in<strong>for</strong>mation about the last requested knowledge base article.id, subject, subjectAlt, text, keywords, languageId, isHot = iKBArticle_GetData()Only available once the KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS event hasfired following an article request.Returns:id—A unique identifier <strong>for</strong> the article (number)subject—The subject <strong>of</strong> the article (string)subjectAlt—Alternate text <strong>for</strong> the article subject (string)text—The body <strong>of</strong> the article (string)keywords—A comma separated list <strong>of</strong> keywords <strong>for</strong> the article (string)languageId—Identifier <strong>for</strong> the article’s language (ee KBSetup_GetLanguageData) (number)isHot—true if the article is a ‘‘Hot Item’’, otherwise false (boolean)KBArticle_IsLoadedReturns whether the requested knowledge base article has been loaded.isLoaded = KBArticle_IsLoaded()The KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS also indicates that therequested article is available; this function presents an alternative that can beused across UI reloads or login/logout.Returns:isLoaded—True if data <strong>for</strong> the last requested article is available; otherwisefalse (boolean)

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!