WoW:API GetQuestLogPushable: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Move page script moved page API GetQuestLogPushable to API GetQuestLogPushable without leaving a redirect)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
<center>'''GetQuestLogPushable''' ''-Documentation by Myrathi-''</center>
{{wowapi}} __NOTOC__
 
Returns true if the currently loaded quest in the quest window is able to be shared with other players.
Returns true if the currently loaded quest in the quest window is able to be shared with other players.
isPushable = GetQuestLogPushable();


GetQuestLogPushable();
==Parameters==
 
===Returns===
----
:; isPushable : Boolean - 1 if the quest can be shared, nil otherwise.
;''Arguments''
 
:''none''
 
----
;''Returns''


:;Boolean
==Example==
 
----
;''Example''
   -- Determine whether the selected quest is pushable or not
   -- Determine whether the selected quest is pushable or not
   if ( GetQuestLogPushable() and GetNumPartyMembers() > 0 ) then
   if ( GetQuestLogPushable() and GetNumPartyMembers() > 0 ) then
Line 23: Line 14:
     QuestFramePushQuestButton:Disable();
     QuestFramePushQuestButton:Disable();
   end
   end
===Result===
QuestFramePushQuestButton is enabled or disabled based on whether the currently active quest is sharable (and you being in a party!).


;''Result''
==Notes==
true | false
Use [[API_SelectQuestLogEntry|SelectQuestLogEntry(questID)]] to set the currently active quest before calling GetQuestLogPushable(). To initiate pushing (sharing) of a quest, use[[API QuestLogPushQuest|QuestLogPushQuest()]].
 
----
;''Description''
 
: Returns true if the currently loaded quest in the quest window is able to be shared with other players ("pushable" simply meaning "sharable").
: To initiate pushing of a quest, see [[API QuestLogPushQuest|QuestLogPushQuest()]].
 
 
: Code sample taken from ''\Interface\FrameXML\QuestLogFrame.lua:42'' (#4150)
 
 
----
{{WoW API}}

Latest revision as of 04:46, 15 August 2023

WoW API < GetQuestLogPushable

Returns true if the currently loaded quest in the quest window is able to be shared with other players.

isPushable = GetQuestLogPushable();

Parameters[edit]

Returns[edit]

isPushable
Boolean - 1 if the quest can be shared, nil otherwise.

Example[edit]

 -- Determine whether the selected quest is pushable or not
 if ( GetQuestLogPushable() and GetNumPartyMembers() > 0 ) then
   QuestFramePushQuestButton:Enable();
 else
   QuestFramePushQuestButton:Disable();
 end

Result[edit]

QuestFramePushQuestButton is enabled or disabled based on whether the currently active quest is sharable (and you being in a party!).

Notes[edit]

Use SelectQuestLogEntry(questID) to set the currently active quest before calling GetQuestLogPushable(). To initiate pushing (sharing) of a quest, useQuestLogPushQuest().