WoW:API GetQuestBackgroundMaterial: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m ({{wowapi}})
m (Move page script moved page API GetQuestBackgroundMaterial to API GetQuestBackgroundMaterial without leaving a redirect)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{wowapi}}
{{wowapi}}
Returns the material string associated with the particular quest.
Returns the material string associated with the particular quest. The material string is non-nil if this quest uses a custom texture other than the default "Parchment" texture.


  GetQuestBackgroundMaterial();
  GetQuestBackgroundMaterial();
Line 12: Line 12:
;''Returns''
;''Returns''


:String questStory
:String material


:;questStory : The material string for this quest
:;material : The material string for this quest, or nil if the default, "Parchment", is to be used.


----
----
;''Example''
;''Example''
  local questStory = GetQuestBackgroundMaterial();
  local material = GetQuestBackgroundMaterial();


;''Result''
;''Result''
  "Arr matey. You need to go find Captain Sander's treasure..."
  nil -- This quest uses the default material, "Parchment"


----
----
Line 27: Line 27:


: Returns the material string associated with the particular quest.
: Returns the material string associated with the particular quest.
:This texture is used to paint the background of the Blizzard Quest Frame. It does not appear in the Quest Log, but only when initially reading, accepting or handing in the quest.

Latest revision as of 04:46, 15 August 2023

WoW API < GetQuestBackgroundMaterial

Returns the material string associated with the particular quest. The material string is non-nil if this quest uses a custom texture other than the default "Parchment" texture.

GetQuestBackgroundMaterial();

Arguments
none

Returns
String material
material
The material string for this quest, or nil if the default, "Parchment", is to be used.

Example
local material = GetQuestBackgroundMaterial();
Result
nil -- This quest uses the default material, "Parchment"

Description
Returns the material string associated with the particular quest.
This texture is used to paint the background of the Blizzard Quest Frame. It does not appear in the Quest Log, but only when initially reading, accepting or handing in the quest.