WoW:API CanShowAchievementUI: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(New page: {{wowapi}} __NOTOC__ <!-- Describe the purpose of the function, exhausting detail can be saved for a later section --> Returns a boolean indicating if the achievement UI is accessable and...)
 
m (Move page script moved page API CanShowAchievementUI to API CanShowAchievementUI without leaving a redirect)
 
(2 intermediate revisions by 2 users not shown)
Line 2: Line 2:


<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
Returns a boolean indicating if the achievement UI is accessable and wether the microbutton should be shown.
Returns a boolean indicating if the achievement UI is accessible and whether the microbutton should be shown.
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
  isEnabled = CanShowAchievementUI();
  isEnabled = CanShowAchievementUI();
Line 23: Line 23:


: Usually returns true on live realms. This function was mostly used to hide the achievement UI if it was in an unusable state on the WotLK Beta / PTR
: Usually returns true on live realms. This function was mostly used to hide the achievement UI if it was in an unusable state on the WotLK Beta / PTR
: This also returns false when the achievement data isn't available yet, which is useful if an addon want to read the achievement data after load

Latest revision as of 04:45, 15 August 2023

WoW API < CanShowAchievementUI

Returns a boolean indicating if the achievement UI is accessible and whether the microbutton should be shown.

isEnabled = CanShowAchievementUI();


Arguments[edit]

none


Returns[edit]

isEnabled
Boolean - can the achievement UI be displayed.


Details[edit]

Usually returns true on live realms. This function was mostly used to hide the achievement UI if it was in an unusable state on the WotLK Beta / PTR
This also returns false when the achievement data isn't available yet, which is useful if an addon want to read the achievement data after load