The help window shows the version like the main window. The checker skips folders of other addons.
121 lines
5.7 KiB
Lua
121 lines
5.7 KiB
Lua
-- PokeHuntLog: "How to use" window. Opens with the Help button in the log, /petlog help, or Shift-clicking
|
|
-- the minimap icon.
|
|
|
|
local HPL = PokeHuntLog
|
|
|
|
local GOLD = "|cffffd100"
|
|
local GREEN = "|cff40ff40"
|
|
local RED = "|cffff4040"
|
|
local ORANGE = "|cffff9933"
|
|
local GREY = "|cff9d9d9d"
|
|
local WHITE = "|cffffffff"
|
|
local END = "|r"
|
|
|
|
local HELP_TEXT = table.concat({
|
|
GOLD .. "Pet log" .. END,
|
|
"- Open it with the " .. WHITE .. "beast icon on your minimap" .. END .. " or " .. WHITE .. "/petlog" .. END .. ".",
|
|
"- Tamed beasts are added automatically. Call each of your pets and visit a stable master once so the pets you already have are added too.",
|
|
"- Tick " .. WHITE .. "Show uncaught" .. END .. " to see every skin and where to tame it.",
|
|
"- Hover a wild beast and its tooltip says " .. GREEN .. "NEW skin!" .. END .. " if you haven't caught that look yet.",
|
|
"- " .. WHITE .. "Collapse all" .. END .. " folds the whole list up; press it again to open it.",
|
|
"- " .. WHITE .. "Search" .. END .. " filters by skin, creature or zone, for example " .. WHITE .. "durotar" .. END .. ".",
|
|
"- Hover a family for its role, stat modifiers, abilities and diet. Hover a skin for your best pet's stats.",
|
|
"- " .. WHITE .. "Export" .. END .. " gives you the whole collection as text to paste into Discord.",
|
|
"- A pet under " .. ORANGE .. "Pets with unknown skin" .. END .. ": click it. If the log can work out which beast " ..
|
|
"it was from what it knows, press " .. WHITE .. "Use guess" .. END .. ". Otherwise press " .. WHITE .. "Assign skin" .. END ..
|
|
" and click its skin in the list.",
|
|
" ",
|
|
GOLD .. "Training" .. END,
|
|
"- " .. WHITE .. "Training" .. END .. " shows your pet's unspent training points, what its family can learn, " ..
|
|
"which ranks you have unlocked by taming, and where to tame the next one.",
|
|
"- Taming a beast unlocks the ability rank it knows; a pet trainer then teaches it to any of your pets.",
|
|
"- Visit a pet trainer once and the log remembers what it offers, then tells you when something is ready.",
|
|
"- " .. WHITE .. "All abilities" .. END .. " in the Training panel lists every pet ability, each rank with its pet level and cost, and which beast teaches it.",
|
|
" ",
|
|
GOLD .. "Roles" .. END,
|
|
"- " .. WHITE .. "Tank" .. END .. " takes hits, " .. WHITE .. "DPS" .. END .. " deals damage, " ..
|
|
WHITE .. "Balanced" .. END .. " is in between, and gorillas are " .. WHITE .. "AoE tank" .. END ..
|
|
" because Thunderstomp grabs everything nearby.",
|
|
" ",
|
|
GOLD .. "Range icon, feed reminder, swing timer" .. END,
|
|
"- These moved to " .. WHITE .. "Class Toolkit" .. END .. ", a separate addon with tools for every class. " ..
|
|
"Install it next to PokeHuntLog and type " .. WHITE .. "/ctk" .. END .. ".",
|
|
" ",
|
|
GOLD .. "Commands" .. END,
|
|
WHITE .. "/petlog" .. END .. " - open the log " .. WHITE .. "/petlog help" .. END .. " - this window",
|
|
WHITE .. "/petlog uncaught" .. END .. " - show or hide skins you haven't caught",
|
|
WHITE .. "/petlog tooltip" .. END .. " - turn the beast tooltip line on or off",
|
|
WHITE .. "/petlog export" .. END .. " - your collection as text",
|
|
WHITE .. "/petlog training" .. END .. " - the training panel " .. WHITE .. "/petlog trainer" .. END .. " - reminders on/off",
|
|
WHITE .. "/petlog commands" .. END .. " - list every command in chat",
|
|
WHITE .. "/petlog debug on" .. END .. " - show what the addon notices in chat (handy for bug reports)",
|
|
}, "\n")
|
|
|
|
local frame
|
|
|
|
local function CreateHelp()
|
|
frame = CreateFrame("Frame", "PokeHuntLogHelpFrame", UIParent)
|
|
frame:SetWidth(500)
|
|
frame:SetHeight(560)
|
|
frame:SetPoint("CENTER", UIParent, "CENTER", 0, 20)
|
|
frame:SetFrameStrata("DIALOG")
|
|
frame:SetClampedToScreen(true)
|
|
frame:EnableMouse(true)
|
|
frame:SetMovable(true)
|
|
frame:RegisterForDrag("LeftButton")
|
|
frame:SetScript("OnDragStart", function() this:StartMoving() end)
|
|
frame:SetScript("OnDragStop", function() this:StopMovingOrSizing() end)
|
|
HPL.Opaque(frame, 11)
|
|
frame:SetBackdrop({
|
|
bgFile = "Interface\\DialogFrame\\UI-DialogBox-Background",
|
|
edgeFile = "Interface\\DialogFrame\\UI-DialogBox-Border",
|
|
tile = true, tileSize = 32, edgeSize = 32,
|
|
insets = { left = 11, right = 12, top = 12, bottom = 11 },
|
|
})
|
|
frame:Hide()
|
|
table.insert(UISpecialFrames, "PokeHuntLogHelpFrame")
|
|
|
|
local title = frame:CreateFontString(nil, "ARTWORK", "GameFontNormalLarge")
|
|
title:SetPoint("TOP", frame, "TOP", 0, -20)
|
|
title:SetText("PokeHuntLog - How to use")
|
|
local version = frame:CreateFontString(nil, "ARTWORK", "GameFontHighlightSmall")
|
|
version:SetPoint("TOP", title, "BOTTOM", 0, -2)
|
|
version:SetText(GREY .. "version " .. HPL.VERSION .. END)
|
|
|
|
local close = CreateFrame("Button", "PokeHuntLogHelpCloseButton", frame, "UIPanelCloseButton")
|
|
close:SetPoint("TOPRIGHT", frame, "TOPRIGHT", -6, -6)
|
|
close:SetScript("OnClick", function() frame:Hide() end)
|
|
|
|
local text = frame:CreateFontString(nil, "ARTWORK", "GameFontHighlightSmall")
|
|
text:SetPoint("TOPLEFT", frame, "TOPLEFT", 26, -68)
|
|
text:SetWidth(448)
|
|
text:SetHeight(430)
|
|
text:SetJustifyH("LEFT")
|
|
text:SetJustifyV("TOP")
|
|
text:SetText(HELP_TEXT)
|
|
|
|
local ok = CreateFrame("Button", "PokeHuntLogHelpOkButton", frame, "UIPanelButtonTemplate")
|
|
ok:SetWidth(120)
|
|
ok:SetHeight(24)
|
|
ok:SetPoint("BOTTOMRIGHT", frame, "BOTTOMRIGHT", -24, 20)
|
|
ok:SetText("Got it")
|
|
ok:SetScript("OnClick", function() frame:Hide() end)
|
|
|
|
local credit = frame:CreateFontString(nil, "ARTWORK", "GameFontHighlightSmall")
|
|
credit:SetPoint("BOTTOM", frame, "BOTTOM", 0, 26)
|
|
credit:SetText(GREY .. "Made by " .. END .. "|cffabd473stealthzi" .. END .. GREY .. " v" .. HPL.VERSION .. END)
|
|
end
|
|
|
|
function HPL.ShowHelp()
|
|
if not frame then CreateHelp() end
|
|
frame:Show()
|
|
end
|
|
|
|
function HPL.ToggleHelp()
|
|
if frame and frame:IsShown() then
|
|
frame:Hide()
|
|
else
|
|
HPL.ShowHelp()
|
|
end
|
|
end
|