WoW API: GetLFGTypeEntries

From AddOn Studio
Revision as of 13:50, 30 December 2008 by WoWWiki>Sylvanaar (Removed commentary)
Jump to navigation Jump to search

WoW API < GetLFGTypeEntries

Returns all available LFG objectives for a category

objective1, objective2, objective3, ... = GetLFGTypeEntries(category)

Takes

Number category
Index of the category to retrieve objectives for

Returns

String objectiveN
Name of Nth objective

Events

Needs UPDATE_LFG_LIST

Details

This always only returns objectives fitting for your level, however WoW is very tolerant here. The results in the example are from a level 44 character.
Also, WoW does not distinguish between hostile and friendy area when doing a lookup in the zone category, this is probably quite useful for arranging raids onto enemy territory, especially because dishonorable kills probably will be gone with the new honor system in Burning Crusade.
When using this function to feed other LFG functions with its results, remember that these functions only want the index of the value, not the value itself. If you wanted to use 'Maraudon' as objective, you would have to supply the number 2. Look at the example!

Example

local entries = {GetLFGTypeEntries(1)}
for i,objective in entries do
  DEFAULT_CHAT_FRAME:AddMessage(format('Objective %u: %s', i, objective))
end

Output:

Objective 1: Razorfen Downs
Objective 2: Maraudon
Objective 3: Scarlet Monastery
Objective 4: Uldaman
Objective 5: Sunken Temple
Objective 6: Zul'Farrak