XRWS 0 º È ¬ ¶ext_01.cat subst_01.cat ext_01.dat subst_01.dat aiscripts/move.flee.xml 199 1523932088 b92fd0f30aadc90d6fe2d8cb69b442b2
md/Notifications.xml 395 1523934107 428ea7731a90cf8281cb5abf9b674cff
t/0001.xml 196 1523663156 afec5be43dc4477caa78b55850cfd192
ui/addons/ego_helpText/helptext.lua 23307 1527059661 2aad112c81c9b3fbc49ef707cb0a212f
ui/addons/ego_helpText/helptext.xpl 23307 1527059661 2aad112c81c9b3fbc49ef707cb0a212f

tips
tips
tips
tips

{30152,601}
local gameversion = tonumber(GetVersionString():match("^(%d*%.%d+)%s.*$"))
-- Ingame Help Text Display
-- ffi setup
local ffi = require("ffi")
local C = ffi.C
if gameversion < 4.10 then
ffi.cdef[[
typedef uint64_t UniverseID;
typedef struct {
const char* objectiveText;
float timeout;
size_t numTargets;
} MissionObjective;
typedef struct {
const char* missionName;
const char* missionDescription;
int difficulty;
const char* mainType;
const char* subType;
const char* faction;
int64_t reward;
const char* rewardText;
size_t numBriefingObjectives;
int activeBriefingStep;
const char* opposingFaction;
const char* license;
float timeLeft;
double duration;
bool abortable;
bool hasObjective;
UniverseID associatedComponent;
} MissionDetails2;
uint64_t GetActiveMissionID(void);
MissionDetails2 GetMissionIDDetails2(uint64_t missionid);
MissionObjective GetMissionIDObjective(uint64_t missionid, const char* fontname, uint32_t fontsize, uint32_t textwidth);
bool IsGamePaused(void);
bool IsPlayerValid(void);
]]
elseif gameversion < 4.30 then
ffi.cdef[[
typedef uint64_t UniverseID;
typedef struct {
const char* objectiveText;
float timeout;
size_t numTargets;
} MissionObjective;
typedef struct {
const char* missionName;
const char* missionDescription;
int difficulty;
const char* mainType;
const char* subType;
const char* faction;
int64_t reward;
const char* rewardText;
size_t numBriefingObjectives;
int activeBriefingStep;
const char* opposingFaction;
const char* license;
float timeLeft;
double duration;
bool abortable;
bool hasObjective;
UniverseID associatedComponent;
} MissionDetails2;
uint64_t GetActiveMissionID(void);
MissionDetails2 GetMissionIDDetails2(uint64_t missionid);
MissionObjective GetMissionIDObjective(uint64_t missionid, const char* fontname, uint32_t fontsize, uint32_t textwidth);
bool IsGamePaused(void);
bool IsPlayerValid(void);
bool IsVRVersion(void);
]]
else
ffi.cdef[[
typedef uint64_t UniverseID;
typedef struct {
const char* objectiveText;
float timeout;
size_t numTargets;
} MissionObjective;
typedef struct {
const char* missionName;
const char* missionDescription;
int difficulty;
const char* mainType;
const char* subType;
const char* faction;
int64_t reward;
const char* rewardText;
size_t numBriefingObjectives;
int activeBriefingStep;
const char* opposingFaction;
const char* license;
float timeLeft;
double duration;
bool abortable;
bool hasObjective;
UniverseID associatedComponent;
} MissionDetails2;
uint64_t GetActiveMissionID(void);
MissionDetails2 GetMissionIDDetails2(uint64_t missionid);
MissionObjective GetMissionIDObjective(uint64_t missionid, const char* fontname, uint32_t fontsize, uint32_t textwidth);
bool IsGamePaused(void);
bool IsPlayerValid(void);
bool IsVRMode(void);
]]
end
local menu = {
name = "HelpTextMenu",
}
local config = {
height = 400,
width = 230,
offsetx = 0,
offsety = 0,
textoffsetx = 5,
textoffsety = 2,
backgroundColor = { r = 37, g = 48, b = 54, a = 70 },
font = "Zekton_unfiltered",
fontsize = 14
}
if gameversion < 4.10 then
config.tableoffsetx = 5
config.tableoffsety = 5
elseif gameversion < 4.30 then
config.tableoffsetx = C.IsVRVersion() and 25 or 5
config.tableoffsety = C.IsVRVersion() and 225 or 5
else
config.tableoffsetx = C.IsVRMode() and 25 or 5
config.tableoffsety = C.IsVRMode() and 225 or 5
config.alertEffectColor = C.IsVRMode() and { r = 32, g = 50, b = 60, a = 100 } or nil
end
local function init()
__CORE_HELPTEXT_DISPLAYEDHINTS = __CORE_HELPTEXT_DISPLAYEDHINTS or {}
menu.queue = menu.queue or {}
menu.missionqueue = menu.missionqueue or {}
menu.lastupdate = 0
RegisterEvent("helptext", menu.onShowHelp)
RegisterEvent("missiontimer", menu.onShowMissionTimer)
RegisterEvent("clearhelptext", menu.onClearHelp)
registerForEvent("gameplanchange", getElement("Scene.UIContract"), menu.onGamePlanChange)
end
function menu.onGamePlanChange(_, mode)
if mode == "extro" then
UnregisterEvent("helptext", menu.onShowHelp)
UnregisterEvent("missiontimer", menu.onShowMissionTimer)
menu.cleanup()
end
end
function menu.cleanup()
if menu.frame then
HideView(menu.frame)
end
menu.table = nil
menu.frame = nil
menu.duration = nil
menu.hasMissionTimer = nil
end
function menu.onShowHelp(event, text)
local textid = tonumber(string.match(text, "%d+"))
text = string.sub(text, string.find(text, ";") + 1)
local force = tonumber(string.match(text, "%d")) == 1
text = string.sub(text, string.find(text, ";") + 1)
local writelog = tonumber(string.match(text, "%d")) == 1
text = string.sub(text, string.find(text, ";") + 1)
local silent = tonumber(string.match(text, "%d")) == 1
text = string.sub(text, string.find(text, ";") + 1)
local duration = string.match(text, "[0-9.]+")
text = string.sub(text, string.find(text, ";") + 1)
local position = tonumber(string.match(text, "%d+"))
text = string.sub(text, string.find(text, ";") + 1)
if force or not __CORE_HELPTEXT_DISPLAYEDHINTS[textid] then
if textid ~= 0 then
__CORE_HELPTEXT_DISPLAYEDHINTS[textid] = true
end
table.insert(menu.queue, {text = text, textid = textid, duration = duration, position = position, silent = silent})
if not menu.duration then
if menu.hasMissionTimer then
RemoveScript("onUpdate", menu.onUpdate)
end
menu.displayHelp()
end
end
end
function menu.onClearHelp(event, id)
if menu.queue[1] then
if id == "current" then
table.remove(menu.queue, 1)
elseif id == "all" then
menu.queue = {}
else
local textid = tonumber(id)
if textid > 0 then
local idx = 0
for i, entry in ipairs(menu.queue) do
if entry.textid == textid then
idx = i
break
end
end
if idx > 0 then
table.remove(menu.queue, idx)
end
if idx ~= 1 then
return
end
end
end
RemoveScript("onUpdate", menu.onUpdate)
if menu.queue[1] then
-- display next hint
menu.duration = nil
menu.displayHelp()
else
if menu.hasMissionTimer then
-- has missiontimer -> update
menu.duration = nil
menu.displayHelp()
else
-- clean up
menu.cleanup()
end
end
end
end
function menu.onShowMissionTimer(event, id)
-- important --- we must store the IDs string representation since id is a cdata (64-bit) and therefore could differ for indexing
-- also note that since we are mixing LuaJIT 64-bit values and Lua 64-bit values we must convert the string-representation and add a "ULL" so the
-- string-representation for both is the same
menu.missionqueue[tostring(id).."ULL"] = true
local activeMission = C.GetActiveMissionID()
if activeMission == id then
if menu.duration or menu.hasMissionTimer then
RemoveScript("onUpdate", menu.onUpdate)
end
menu.displayHelp()
end
end
if gameversion < 4.10 then
menu.displayHelp = function()
local realtime = GetCurRealTime()
menu.lastupdate = realtime
local activeMission = C.GetActiveMissionID()
local content = {}
if menu.missionqueue[tostring(activeMission)] then
-- missiontimer found
local missionDetails = C.GetMissionIDDetails2(activeMission)
local missionObjective
if missionDetails.hasObjective then
missionObjective = C.GetMissionIDObjective(activeMission, config.font, menu.scaleFont(config.font, config.fontsize), menu.scaleX(config.width - config.tableoffsetx - config.textoffsetx))
end
if missionObjective ~= nil and missionObjective.timeout >= 0 then
-- still valid -> display
if not menu.hasMissionTimer then
PlaySound("notification_hint")
end
menu.hasMissionTimer = true
local missionstring = CreateFontString(ffi.string(missionObjective.objectiveText) .. " (" .. ConvertTimeString(missionObjective.timeout, "%m:%S") .. ")", "left", 255, 255, 255, 100, config.font, menu.scaleFont(config.font, config.fontsize), true, menu.scaleX(config.textoffsetx), menu.scaleY(config.textoffsety), 0, menu.scaleX(config.width - config.tableoffsetx) - menu.scaleX(config.textoffsetx))
table.insert(content, { color = config.backgroundColor, selectable = false, cols = { [1] = { colspan = 1, content = missionstring } } })
elseif ffi.string(missionDetails.missionName) ~= "" and missionDetails.timeLeft > 0 then
-- still valid -> display
if not menu.hasMissionTimer then
PlaySound("notification_hint")
end
menu.hasMissionTimer = true
local missionstring = CreateFontString(ffi.string(missionDetails.missionName) .. " (" .. ConvertTimeString(missionDetails.timeLeft, "%m:%S") .. ")", "left", 255, 255, 255, 100, config.font, menu.scaleFont(config.font, config.fontsize), true, menu.scaleX(config.textoffsetx), menu.scaleY(config.textoffsety), 0, menu.scaleX(config.width - config.tableoffsetx) - menu.scaleX(config.textoffsetx))
table.insert(content, { color = config.backgroundColor, selectable = false, cols = { [1] = { colspan = 1, content = missionstring } } })
else
-- invalid -> remove
menu.hasMissionTimer = false
menu.missionqueue[tostring(activeMission)] = nil
end
else
-- no missiontimer found
menu.hasMissionTimer = false
end
local hintcontent
if menu.queue[1] then
-- hint found
local hintstring = CreateFontString(menu.queue[1].text, "left", 255, 255, 255, 100, config.font, menu.scaleFont(config.font, config.fontsize), true, menu.scaleX(config.textoffsetx), menu.scaleY(config.textoffsety), 0, menu.scaleX(config.width - config.tableoffsetx) - menu.scaleX(config.textoffsetx))
hintcontent = { [1] = { color = config.backgroundColor, selectable = false, cols = { [1] = { colspan = 1, content = hintstring } } } }
if (not menu.queue[1].silent) and (not menu.duration) then
PlaySound("notification_hint")
end
menu.duration = menu.duration or (realtime + menu.queue[1].duration)
end
local view_x, view_y = GetViewSize()
local view
if menu.duration then
-- get position data
local position_x, position_y = GetHintPosition(menu.queue[1].position)
local offsetx, offsety = 0, 0
if view_x and view_y then
offsetx = position_x / 100 * view_x
offsety = position_y / 100 * view_y
end
if menu.hasMissionTimer then
local desc1 = CreateTable("", content, { menu.scaleX(config.width - config.tableoffsetx) }, false, true, 0, #content, menu.scaleX(config.tableoffsetx), menu.scaleY(config.tableoffsety), menu.scaleY(config.height - config.tableoffsety))
local desc2 = CreateTable("", hintcontent, { menu.scaleX(config.width - config.tableoffsetx) }, false, true, 0, #content, offsetx, offsety, menu.scaleY(config.height - config.tableoffsety))
view = CreateTwoTableView(desc1, desc2, false, "", "", view_x, view_y, menu.scaleX(config.offsetx), menu.scaleY(config.offsety), "none", true)
else
local desc = CreateTable("", hintcontent, { menu.scaleX(config.width - config.tableoffsetx) }, false, true, 0, #content, offsetx, offsety, menu.scaleY(config.height - config.tableoffsety))
view = CreateTableView(desc, false, "", "", view_x, view_y, menu.scaleX(config.offsetx), menu.scaleY(config.offsety), "none", true)
end
elseif menu.hasMissionTimer then
local desc = CreateTable("", content, { menu.scaleX(config.width - config.tableoffsetx) }, false, true, 0, #content, menu.scaleX(config.tableoffsetx), menu.scaleY(config.tableoffsety), menu.scaleY(config.height - config.tableoffsety))
view = CreateTableView(desc, false, "", "", view_x, view_y, menu.scaleX(config.offsetx), menu.scaleY(config.offsety), "none", true)
end
if C.IsPlayerValid() and (menu.hasMissionTimer or menu.duration) then
menu.frame = DisplayView(view)
menu.table = GetChildren(menu.frame)
SetScript("onUpdate", menu.onUpdate)
else
menu.cleanup()
end
end
elseif gameversion < 4.30 then
menu.displayHelp = function()
local realtime = GetCurRealTime()
menu.lastupdate = realtime
local width = menu.scaleX(config.width - config.tableoffsetx) * (C.IsVRVersion() and 2 or 1)
local height = menu.scaleY(config.height - config.tableoffsety)
local activeMission = C.GetActiveMissionID()
local content = {}
if menu.missionqueue[tostring(activeMission)] then
-- missiontimer found
local missionDetails = C.GetMissionIDDetails2(activeMission)
local missionObjective
if missionDetails.hasObjective then
missionObjective = C.GetMissionIDObjective(activeMission, config.font, menu.scaleFont(config.font, config.fontsize), width - menu.scaleX(config.textoffsetx))
end
if missionObjective ~= nil and missionObjective.timeout >= 0 then
-- still valid -> display
if not menu.hasMissionTimer then
PlaySound("notification_hint")
end
menu.hasMissionTimer = true
local missionstring = CreateFontString(ffi.string(missionObjective.objectiveText) .. " (" .. ConvertTimeString(missionObjective.timeout, "%m:%S") .. ")", "left", 255, 255, 255, 100, config.font, menu.scaleFont(config.font, config.fontsize), true, menu.scaleX(config.textoffsetx), menu.scaleY(config.textoffsety), 0, width - menu.scaleX(config.textoffsetx))
table.insert(content, { color = config.backgroundColor, selectable = false, cols = { [1] = { colspan = 1, content = missionstring } } })
elseif ffi.string(missionDetails.missionName) ~= "" and missionDetails.timeLeft > 0 then
-- still valid -> display
if not menu.hasMissionTimer then
PlaySound("notification_hint")
end
menu.hasMissionTimer = true
local missionstring = CreateFontString(ffi.string(missionDetails.missionName) .. " (" .. ConvertTimeString(missionDetails.timeLeft, "%m:%S") .. ")", "left", 255, 255, 255, 100, config.font, menu.scaleFont(config.font, config.fontsize), true, menu.scaleX(config.textoffsetx), menu.scaleY(config.textoffsety), 0, width - menu.scaleX(config.textoffsetx))
table.insert(content, { color = config.backgroundColor, selectable = false, cols = { [1] = { colspan = 1, content = missionstring } } })
else
-- invalid -> remove
menu.hasMissionTimer = false
menu.missionqueue[tostring(activeMission)] = nil
end
else
-- no missiontimer found
menu.hasMissionTimer = false
end
local hintcontent
if menu.queue[1] then
-- hint found
local hintstring = CreateFontString(menu.queue[1].text, "left", 255, 255, 255, 100, config.font, menu.scaleFont(config.font, config.fontsize), true, menu.scaleX(config.textoffsetx), menu.scaleY(config.textoffsety), 0, width - menu.scaleX(config.textoffsetx))
hintcontent = { [1] = { color = config.backgroundColor, selectable = false, cols = { [1] = { colspan = 1, content = hintstring } } } }
if (not menu.queue[1].silent) and (not menu.duration) then
PlaySound("notification_hint")
end
menu.duration = menu.duration or (realtime + menu.queue[1].duration)
end
local view_x, view_y = GetViewSize()
local view
if menu.duration then
-- get position data
local position_x, position_y = GetHintPosition(menu.queue[1].position)
local offsetx, offsety = 0, 0
if view_x and view_y then
offsetx = math.min(position_x / 100 * view_x, view_x - width)
offsety = position_y / 100 * view_y
end
if menu.hasMissionTimer then
local desc1 = CreateTable("", content, { width }, false, true, 0, #content, menu.scaleX(config.tableoffsetx), menu.scaleY(config.tableoffsety), height)
local desc2 = CreateTable("", hintcontent, { width }, false, true, 0, #content, offsetx, offsety, height)
view = CreateTwoTableView(desc1, desc2, false, "", "", view_x, view_y, menu.scaleX(config.offsetx), menu.scaleY(config.offsety), "none", true, false, true)
else
local desc = CreateTable("", hintcontent, { width }, false, true, 0, #content, offsetx, offsety, height)
view = CreateTableView(desc, false, "", "", view_x, view_y, menu.scaleX(config.offsetx), menu.scaleY(config.offsety), "none", true, false, true)
end
elseif menu.hasMissionTimer then
local desc = CreateTable("", content, { width }, false, true, 0, #content, menu.scaleX(config.tableoffsetx), menu.scaleY(config.tableoffsety), height)
view = CreateTableView(desc, false, "", "", view_x, view_y, menu.scaleX(config.offsetx), menu.scaleY(config.offsety), "none", true, false, true)
end
if C.IsPlayerValid() and (menu.hasMissionTimer or menu.duration) then
menu.frame = DisplayView(view)
menu.table = GetChildren(menu.frame)
SetScript("onUpdate", menu.onUpdate)
else
menu.cleanup()
end
end
else
menu.displayHelp = function()
local realtime = GetCurRealTime()
menu.lastupdate = realtime
local width = menu.scaleX(config.width - config.tableoffsetx) * (C.IsVRMode() and 2 or 1)
local height = menu.scaleY(config.height - config.tableoffsety)
local activeMission = C.GetActiveMissionID()
local content = {}
if menu.missionqueue[tostring(activeMission)] then
-- missiontimer found
local missionDetails = C.GetMissionIDDetails2(activeMission)
local missionObjective
if missionDetails.hasObjective then
missionObjective = C.GetMissionIDObjective(activeMission, config.font, menu.scaleFont(config.font, config.fontsize), width - menu.scaleX(config.textoffsetx))
end
if missionObjective ~= nil and missionObjective.timeout >= 0 then
-- still valid -> display
if not menu.hasMissionTimer then
PlaySound("notification_hint")
end
menu.hasMissionTimer = true
local missionstring = CreateFontString(ffi.string(missionObjective.objectiveText) .. " (" .. ConvertTimeString(missionObjective.timeout, "%m:%S") .. ")", "left", 255, 255, 255, 100, config.font, menu.scaleFont(config.font, config.fontsize), true, menu.scaleX(config.textoffsetx), menu.scaleY(config.textoffsety), 0, width - menu.scaleX(config.textoffsetx))
table.insert(content, { color = config.backgroundColor, selectable = false, cols = { [1] = { colspan = 1, content = missionstring } } })
elseif ffi.string(missionDetails.missionName) ~= "" and missionDetails.timeLeft > 0 then
-- still valid -> display
if not menu.hasMissionTimer then
PlaySound("notification_hint")
end
menu.hasMissionTimer = true
local missionstring = CreateFontString(ffi.string(missionDetails.missionName) .. " (" .. ConvertTimeString(missionDetails.timeLeft, "%m:%S") .. ")", "left", 255, 255, 255, 100, config.font, menu.scaleFont(config.font, config.fontsize), true, menu.scaleX(config.textoffsetx), menu.scaleY(config.textoffsety), 0, width - menu.scaleX(config.textoffsetx))
table.insert(content, { color = config.backgroundColor, selectable = false, cols = { [1] = { colspan = 1, content = missionstring } } })
else
-- invalid -> remove
menu.hasMissionTimer = false
menu.missionqueue[tostring(activeMission)] = nil
end
else
-- no missiontimer found
menu.hasMissionTimer = false
end
local hintcontent
if menu.queue[1] then
-- hint found
local hintstring = CreateFontString(menu.queue[1].text, "left", 255, 255, 255, 100, config.font, menu.scaleFont(config.font, config.fontsize), true, menu.scaleX(config.textoffsetx), menu.scaleY(config.textoffsety), 0, width - menu.scaleX(config.textoffsetx))
hintcontent = { [1] = { color = config.backgroundColor, selectable = false, cols = { [1] = { colspan = 1, content = hintstring } } } }
if (not menu.queue[1].silent) and (not menu.duration) then
PlaySound("notification_hint")
end
menu.duration = menu.duration or (realtime + menu.queue[1].duration)
end
local view_x, view_y = GetViewSize()
local view
if menu.duration then
-- get position data
local position_x, position_y = GetHintPosition(menu.queue[1].position)
local offsetx, offsety = 0, 0
if view_x and view_y then
offsetx = math.min(position_x / 100 * view_x, view_x - width)
offsety = position_y / 100 * view_y
end
if menu.hasMissionTimer then
local desc1 = CreateTable("", content, { width }, false, true, 0, #content, menu.scaleX(config.tableoffsetx), menu.scaleY(config.tableoffsety), height)
local desc2 = CreateTable("", hintcontent, { width }, false, true, 0, #content, offsetx, offsety, height)
view = CreateTwoTableView(desc1, desc2, false, "", "", view_x, view_y, menu.scaleX(config.offsetx), menu.scaleY(config.offsety), "none", true, false, true)
else
local desc = CreateTable("", hintcontent, { width }, false, true, 0, #content, offsetx, offsety, height, 0, 0, 0, false, config.alertEffectColor)
view = CreateTableView(desc, false, "", "", view_x, view_y, menu.scaleX(config.offsetx), menu.scaleY(config.offsety), "none", true, false, true)
end
elseif menu.hasMissionTimer then
local desc = CreateTable("", content, { width }, false, true, 0, #content, menu.scaleX(config.tableoffsetx), menu.scaleY(config.tableoffsety), height)
view = CreateTableView(desc, false, "", "", view_x, view_y, menu.scaleX(config.offsetx), menu.scaleY(config.offsety), "none", true, false, true)
end
if C.IsPlayerValid() and (menu.hasMissionTimer or menu.duration) then
menu.frame = DisplayView(view)
menu.table = GetChildren(menu.frame)
SetScript("onUpdate", menu.onUpdate)
else
menu.cleanup()
end
end
end
function menu.onUpdate()
if not C.IsGamePaused() then
local realtime = GetCurRealTime()
-- only check every second
if menu.lastupdate + 1 < realtime then
menu.lastupdate = realtime
if menu.duration and menu.duration < realtime then
-- hint displayed, but expired
table.remove(menu.queue, 1)
RemoveScript("onUpdate", menu.onUpdate)
if menu.queue[1] then
-- display next hint
menu.duration = nil
menu.displayHelp()
else
if menu.hasMissionTimer then
-- has missiontimer -> update
menu.duration = nil
menu.displayHelp()
else
-- clean up
menu.cleanup()
end
end
return
end
if menu.hasMissionTimer then
-- has missiontimer -> update
-- TODO Florian - change to use updateCellText when issues with debuglog are resolved
RemoveScript("onUpdate", menu.onUpdate)
menu.displayHelp()
end
end
end
end
function menu.round(x, digits)
local mult = 1
if digits and digits > 0 then
mult = 10^digits
end
return math.floor(x * mult + 0.5) / mult
end
function menu.scaleX(x)
local xx = GetViewSize()
if not xx then
return x
else
return menu.round(x * xx / 1280)
end
end
function menu.scaleY(y)
local _, yy = GetViewSize()
if not yy then
return y
else
return menu.round(y * yy / 720)
end
end
function menu.scaleFont(fontname, fontsize)
fontsize = menu.scaleY(fontsize)
return GetBestFontSize(fontname, fontsize)
end
init()
local gameversion = tonumber(GetVersionString():match("^(%d*%.%d+)%s.*$"))
-- Ingame Help Text Display
-- ffi setup
local ffi = require("ffi")
local C = ffi.C
if gameversion < 4.10 then
ffi.cdef[[
typedef uint64_t UniverseID;
typedef struct {
const char* objectiveText;
float timeout;
size_t numTargets;
} MissionObjective;
typedef struct {
const char* missionName;
const char* missionDescription;
int difficulty;
const char* mainType;
const char* subType;
const char* faction;
int64_t reward;
const char* rewardText;
size_t numBriefingObjectives;
int activeBriefingStep;
const char* opposingFaction;
const char* license;
float timeLeft;
double duration;
bool abortable;
bool hasObjective;
UniverseID associatedComponent;
} MissionDetails2;
uint64_t GetActiveMissionID(void);
MissionDetails2 GetMissionIDDetails2(uint64_t missionid);
MissionObjective GetMissionIDObjective(uint64_t missionid, const char* fontname, uint32_t fontsize, uint32_t textwidth);
bool IsGamePaused(void);
bool IsPlayerValid(void);
]]
elseif gameversion < 4.30 then
ffi.cdef[[
typedef uint64_t UniverseID;
typedef struct {
const char* objectiveText;
float timeout;
size_t numTargets;
} MissionObjective;
typedef struct {
const char* missionName;
const char* missionDescription;
int difficulty;
const char* mainType;
const char* subType;
const char* faction;
int64_t reward;
const char* rewardText;
size_t numBriefingObjectives;
int activeBriefingStep;
const char* opposingFaction;
const char* license;
float timeLeft;
double duration;
bool abortable;
bool hasObjective;
UniverseID associatedComponent;
} MissionDetails2;
uint64_t GetActiveMissionID(void);
MissionDetails2 GetMissionIDDetails2(uint64_t missionid);
MissionObjective GetMissionIDObjective(uint64_t missionid, const char* fontname, uint32_t fontsize, uint32_t textwidth);
bool IsGamePaused(void);
bool IsPlayerValid(void);
bool IsVRVersion(void);
]]
else
ffi.cdef[[
typedef uint64_t UniverseID;
typedef struct {
const char* objectiveText;
float timeout;
size_t numTargets;
} MissionObjective;
typedef struct {
const char* missionName;
const char* missionDescription;
int difficulty;
const char* mainType;
const char* subType;
const char* faction;
int64_t reward;
const char* rewardText;
size_t numBriefingObjectives;
int activeBriefingStep;
const char* opposingFaction;
const char* license;
float timeLeft;
double duration;
bool abortable;
bool hasObjective;
UniverseID associatedComponent;
} MissionDetails2;
uint64_t GetActiveMissionID(void);
MissionDetails2 GetMissionIDDetails2(uint64_t missionid);
MissionObjective GetMissionIDObjective(uint64_t missionid, const char* fontname, uint32_t fontsize, uint32_t textwidth);
bool IsGamePaused(void);
bool IsPlayerValid(void);
bool IsVRMode(void);
]]
end
local menu = {
name = "HelpTextMenu",
}
local config = {
height = 400,
width = 230,
offsetx = 0,
offsety = 0,
textoffsetx = 5,
textoffsety = 2,
backgroundColor = { r = 37, g = 48, b = 54, a = 70 },
font = "Zekton_unfiltered",
fontsize = 14
}
if gameversion < 4.10 then
config.tableoffsetx = 5
config.tableoffsety = 5
elseif gameversion < 4.30 then
config.tableoffsetx = C.IsVRVersion() and 25 or 5
config.tableoffsety = C.IsVRVersion() and 225 or 5
else
config.tableoffsetx = C.IsVRMode() and 25 or 5
config.tableoffsety = C.IsVRMode() and 225 or 5
config.alertEffectColor = C.IsVRMode() and { r = 32, g = 50, b = 60, a = 100 } or nil
end
local function init()
__CORE_HELPTEXT_DISPLAYEDHINTS = __CORE_HELPTEXT_DISPLAYEDHINTS or {}
menu.queue = menu.queue or {}
menu.missionqueue = menu.missionqueue or {}
menu.lastupdate = 0
RegisterEvent("helptext", menu.onShowHelp)
RegisterEvent("missiontimer", menu.onShowMissionTimer)
RegisterEvent("clearhelptext", menu.onClearHelp)
registerForEvent("gameplanchange", getElement("Scene.UIContract"), menu.onGamePlanChange)
end
function menu.onGamePlanChange(_, mode)
if mode == "extro" then
UnregisterEvent("helptext", menu.onShowHelp)
UnregisterEvent("missiontimer", menu.onShowMissionTimer)
menu.cleanup()
end
end
function menu.cleanup()
if menu.frame then
HideView(menu.frame)
end
menu.table = nil
menu.frame = nil
menu.duration = nil
menu.hasMissionTimer = nil
end
function menu.onShowHelp(event, text)
local textid = tonumber(string.match(text, "%d+"))
text = string.sub(text, string.find(text, ";") + 1)
local force = tonumber(string.match(text, "%d")) == 1
text = string.sub(text, string.find(text, ";") + 1)
local writelog = tonumber(string.match(text, "%d")) == 1
text = string.sub(text, string.find(text, ";") + 1)
local silent = tonumber(string.match(text, "%d")) == 1
text = string.sub(text, string.find(text, ";") + 1)
local duration = string.match(text, "[0-9.]+")
text = string.sub(text, string.find(text, ";") + 1)
local position = tonumber(string.match(text, "%d+"))
text = string.sub(text, string.find(text, ";") + 1)
if force or not __CORE_HELPTEXT_DISPLAYEDHINTS[textid] then
if textid ~= 0 then
__CORE_HELPTEXT_DISPLAYEDHINTS[textid] = true
end
table.insert(menu.queue, {text = text, textid = textid, duration = duration, position = position, silent = silent})
if not menu.duration then
if menu.hasMissionTimer then
RemoveScript("onUpdate", menu.onUpdate)
end
menu.displayHelp()
end
end
end
function menu.onClearHelp(event, id)
if menu.queue[1] then
if id == "current" then
table.remove(menu.queue, 1)
elseif id == "all" then
menu.queue = {}
else
local textid = tonumber(id)
if textid > 0 then
local idx = 0
for i, entry in ipairs(menu.queue) do
if entry.textid == textid then
idx = i
break
end
end
if idx > 0 then
table.remove(menu.queue, idx)
end
if idx ~= 1 then
return
end
end
end
RemoveScript("onUpdate", menu.onUpdate)
if menu.queue[1] then
-- display next hint
menu.duration = nil
menu.displayHelp()
else
if menu.hasMissionTimer then
-- has missiontimer -> update
menu.duration = nil
menu.displayHelp()
else
-- clean up
menu.cleanup()
end
end
end
end
function menu.onShowMissionTimer(event, id)
-- important --- we must store the IDs string representation since id is a cdata (64-bit) and therefore could differ for indexing
-- also note that since we are mixing LuaJIT 64-bit values and Lua 64-bit values we must convert the string-representation and add a "ULL" so the
-- string-representation for both is the same
menu.missionqueue[tostring(id).."ULL"] = true
local activeMission = C.GetActiveMissionID()
if activeMission == id then
if menu.duration or menu.hasMissionTimer then
RemoveScript("onUpdate", menu.onUpdate)
end
menu.displayHelp()
end
end
if gameversion < 4.10 then
menu.displayHelp = function()
local realtime = GetCurRealTime()
menu.lastupdate = realtime
local activeMission = C.GetActiveMissionID()
local content = {}
if menu.missionqueue[tostring(activeMission)] then
-- missiontimer found
local missionDetails = C.GetMissionIDDetails2(activeMission)
local missionObjective
if missionDetails.hasObjective then
missionObjective = C.GetMissionIDObjective(activeMission, config.font, menu.scaleFont(config.font, config.fontsize), menu.scaleX(config.width - config.tableoffsetx - config.textoffsetx))
end
if missionObjective ~= nil and missionObjective.timeout >= 0 then
-- still valid -> display
if not menu.hasMissionTimer then
PlaySound("notification_hint")
end
menu.hasMissionTimer = true
local missionstring = CreateFontString(ffi.string(missionObjective.objectiveText) .. " (" .. ConvertTimeString(missionObjective.timeout, "%m:%S") .. ")", "left", 255, 255, 255, 100, config.font, menu.scaleFont(config.font, config.fontsize), true, menu.scaleX(config.textoffsetx), menu.scaleY(config.textoffsety), 0, menu.scaleX(config.width - config.tableoffsetx) - menu.scaleX(config.textoffsetx))
table.insert(content, { color = config.backgroundColor, selectable = false, cols = { [1] = { colspan = 1, content = missionstring } } })
elseif ffi.string(missionDetails.missionName) ~= "" and missionDetails.timeLeft > 0 then
-- still valid -> display
if not menu.hasMissionTimer then
PlaySound("notification_hint")
end
menu.hasMissionTimer = true
local missionstring = CreateFontString(ffi.string(missionDetails.missionName) .. " (" .. ConvertTimeString(missionDetails.timeLeft, "%m:%S") .. ")", "left", 255, 255, 255, 100, config.font, menu.scaleFont(config.font, config.fontsize), true, menu.scaleX(config.textoffsetx), menu.scaleY(config.textoffsety), 0, menu.scaleX(config.width - config.tableoffsetx) - menu.scaleX(config.textoffsetx))
table.insert(content, { color = config.backgroundColor, selectable = false, cols = { [1] = { colspan = 1, content = missionstring } } })
else
-- invalid -> remove
menu.hasMissionTimer = false
menu.missionqueue[tostring(activeMission)] = nil
end
else
-- no missiontimer found
menu.hasMissionTimer = false
end
local hintcontent
if menu.queue[1] then
-- hint found
local hintstring = CreateFontString(menu.queue[1].text, "left", 255, 255, 255, 100, config.font, menu.scaleFont(config.font, config.fontsize), true, menu.scaleX(config.textoffsetx), menu.scaleY(config.textoffsety), 0, menu.scaleX(config.width - config.tableoffsetx) - menu.scaleX(config.textoffsetx))
hintcontent = { [1] = { color = config.backgroundColor, selectable = false, cols = { [1] = { colspan = 1, content = hintstring } } } }
if (not menu.queue[1].silent) and (not menu.duration) then
PlaySound("notification_hint")
end
menu.duration = menu.duration or (realtime + menu.queue[1].duration)
end
local view_x, view_y = GetViewSize()
local view
if menu.duration then
-- get position data
local position_x, position_y = GetHintPosition(menu.queue[1].position)
local offsetx, offsety = 0, 0
if view_x and view_y then
offsetx = position_x / 100 * view_x
offsety = position_y / 100 * view_y
end
if menu.hasMissionTimer then
local desc1 = CreateTable("", content, { menu.scaleX(config.width - config.tableoffsetx) }, false, true, 0, #content, menu.scaleX(config.tableoffsetx), menu.scaleY(config.tableoffsety), menu.scaleY(config.height - config.tableoffsety))
local desc2 = CreateTable("", hintcontent, { menu.scaleX(config.width - config.tableoffsetx) }, false, true, 0, #content, offsetx, offsety, menu.scaleY(config.height - config.tableoffsety))
view = CreateTwoTableView(desc1, desc2, false, "", "", view_x, view_y, menu.scaleX(config.offsetx), menu.scaleY(config.offsety), "none", true)
else
local desc = CreateTable("", hintcontent, { menu.scaleX(config.width - config.tableoffsetx) }, false, true, 0, #content, offsetx, offsety, menu.scaleY(config.height - config.tableoffsety))
view = CreateTableView(desc, false, "", "", view_x, view_y, menu.scaleX(config.offsetx), menu.scaleY(config.offsety), "none", true)
end
elseif menu.hasMissionTimer then
local desc = CreateTable("", content, { menu.scaleX(config.width - config.tableoffsetx) }, false, true, 0, #content, menu.scaleX(config.tableoffsetx), menu.scaleY(config.tableoffsety), menu.scaleY(config.height - config.tableoffsety))
view = CreateTableView(desc, false, "", "", view_x, view_y, menu.scaleX(config.offsetx), menu.scaleY(config.offsety), "none", true)
end
if C.IsPlayerValid() and (menu.hasMissionTimer or menu.duration) then
menu.frame = DisplayView(view)
menu.table = GetChildren(menu.frame)
SetScript("onUpdate", menu.onUpdate)
else
menu.cleanup()
end
end
elseif gameversion < 4.30 then
menu.displayHelp = function()
local realtime = GetCurRealTime()
menu.lastupdate = realtime
local width = menu.scaleX(config.width - config.tableoffsetx) * (C.IsVRVersion() and 2 or 1)
local height = menu.scaleY(config.height - config.tableoffsety)
local activeMission = C.GetActiveMissionID()
local content = {}
if menu.missionqueue[tostring(activeMission)] then
-- missiontimer found
local missionDetails = C.GetMissionIDDetails2(activeMission)
local missionObjective
if missionDetails.hasObjective then
missionObjective = C.GetMissionIDObjective(activeMission, config.font, menu.scaleFont(config.font, config.fontsize), width - menu.scaleX(config.textoffsetx))
end
if missionObjective ~= nil and missionObjective.timeout >= 0 then
-- still valid -> display
if not menu.hasMissionTimer then
PlaySound("notification_hint")
end
menu.hasMissionTimer = true
local missionstring = CreateFontString(ffi.string(missionObjective.objectiveText) .. " (" .. ConvertTimeString(missionObjective.timeout, "%m:%S") .. ")", "left", 255, 255, 255, 100, config.font, menu.scaleFont(config.font, config.fontsize), true, menu.scaleX(config.textoffsetx), menu.scaleY(config.textoffsety), 0, width - menu.scaleX(config.textoffsetx))
table.insert(content, { color = config.backgroundColor, selectable = false, cols = { [1] = { colspan = 1, content = missionstring } } })
elseif ffi.string(missionDetails.missionName) ~= "" and missionDetails.timeLeft > 0 then
-- still valid -> display
if not menu.hasMissionTimer then
PlaySound("notification_hint")
end
menu.hasMissionTimer = true
local missionstring = CreateFontString(ffi.string(missionDetails.missionName) .. " (" .. ConvertTimeString(missionDetails.timeLeft, "%m:%S") .. ")", "left", 255, 255, 255, 100, config.font, menu.scaleFont(config.font, config.fontsize), true, menu.scaleX(config.textoffsetx), menu.scaleY(config.textoffsety), 0, width - menu.scaleX(config.textoffsetx))
table.insert(content, { color = config.backgroundColor, selectable = false, cols = { [1] = { colspan = 1, content = missionstring } } })
else
-- invalid -> remove
menu.hasMissionTimer = false
menu.missionqueue[tostring(activeMission)] = nil
end
else
-- no missiontimer found
menu.hasMissionTimer = false
end
local hintcontent
if menu.queue[1] then
-- hint found
local hintstring = CreateFontString(menu.queue[1].text, "left", 255, 255, 255, 100, config.font, menu.scaleFont(config.font, config.fontsize), true, menu.scaleX(config.textoffsetx), menu.scaleY(config.textoffsety), 0, width - menu.scaleX(config.textoffsetx))
hintcontent = { [1] = { color = config.backgroundColor, selectable = false, cols = { [1] = { colspan = 1, content = hintstring } } } }
if (not menu.queue[1].silent) and (not menu.duration) then
PlaySound("notification_hint")
end
menu.duration = menu.duration or (realtime + menu.queue[1].duration)
end
local view_x, view_y = GetViewSize()
local view
if menu.duration then
-- get position data
local position_x, position_y = GetHintPosition(menu.queue[1].position)
local offsetx, offsety = 0, 0
if view_x and view_y then
offsetx = math.min(position_x / 100 * view_x, view_x - width)
offsety = position_y / 100 * view_y
end
if menu.hasMissionTimer then
local desc1 = CreateTable("", content, { width }, false, true, 0, #content, menu.scaleX(config.tableoffsetx), menu.scaleY(config.tableoffsety), height)
local desc2 = CreateTable("", hintcontent, { width }, false, true, 0, #content, offsetx, offsety, height)
view = CreateTwoTableView(desc1, desc2, false, "", "", view_x, view_y, menu.scaleX(config.offsetx), menu.scaleY(config.offsety), "none", true, false, true)
else
local desc = CreateTable("", hintcontent, { width }, false, true, 0, #content, offsetx, offsety, height)
view = CreateTableView(desc, false, "", "", view_x, view_y, menu.scaleX(config.offsetx), menu.scaleY(config.offsety), "none", true, false, true)
end
elseif menu.hasMissionTimer then
local desc = CreateTable("", content, { width }, false, true, 0, #content, menu.scaleX(config.tableoffsetx), menu.scaleY(config.tableoffsety), height)
view = CreateTableView(desc, false, "", "", view_x, view_y, menu.scaleX(config.offsetx), menu.scaleY(config.offsety), "none", true, false, true)
end
if C.IsPlayerValid() and (menu.hasMissionTimer or menu.duration) then
menu.frame = DisplayView(view)
menu.table = GetChildren(menu.frame)
SetScript("onUpdate", menu.onUpdate)
else
menu.cleanup()
end
end
else
menu.displayHelp = function()
local realtime = GetCurRealTime()
menu.lastupdate = realtime
local width = menu.scaleX(config.width - config.tableoffsetx) * (C.IsVRMode() and 2 or 1)
local height = menu.scaleY(config.height - config.tableoffsety)
local activeMission = C.GetActiveMissionID()
local content = {}
if menu.missionqueue[tostring(activeMission)] then
-- missiontimer found
local missionDetails = C.GetMissionIDDetails2(activeMission)
local missionObjective
if missionDetails.hasObjective then
missionObjective = C.GetMissionIDObjective(activeMission, config.font, menu.scaleFont(config.font, config.fontsize), width - menu.scaleX(config.textoffsetx))
end
if missionObjective ~= nil and missionObjective.timeout >= 0 then
-- still valid -> display
if not menu.hasMissionTimer then
PlaySound("notification_hint")
end
menu.hasMissionTimer = true
local missionstring = CreateFontString(ffi.string(missionObjective.objectiveText) .. " (" .. ConvertTimeString(missionObjective.timeout, "%m:%S") .. ")", "left", 255, 255, 255, 100, config.font, menu.scaleFont(config.font, config.fontsize), true, menu.scaleX(config.textoffsetx), menu.scaleY(config.textoffsety), 0, width - menu.scaleX(config.textoffsetx))
table.insert(content, { color = config.backgroundColor, selectable = false, cols = { [1] = { colspan = 1, content = missionstring } } })
elseif ffi.string(missionDetails.missionName) ~= "" and missionDetails.timeLeft > 0 then
-- still valid -> display
if not menu.hasMissionTimer then
PlaySound("notification_hint")
end
menu.hasMissionTimer = true
local missionstring = CreateFontString(ffi.string(missionDetails.missionName) .. " (" .. ConvertTimeString(missionDetails.timeLeft, "%m:%S") .. ")", "left", 255, 255, 255, 100, config.font, menu.scaleFont(config.font, config.fontsize), true, menu.scaleX(config.textoffsetx), menu.scaleY(config.textoffsety), 0, width - menu.scaleX(config.textoffsetx))
table.insert(content, { color = config.backgroundColor, selectable = false, cols = { [1] = { colspan = 1, content = missionstring } } })
else
-- invalid -> remove
menu.hasMissionTimer = false
menu.missionqueue[tostring(activeMission)] = nil
end
else
-- no missiontimer found
menu.hasMissionTimer = false
end
local hintcontent
if menu.queue[1] then
-- hint found
local hintstring = CreateFontString(menu.queue[1].text, "left", 255, 255, 255, 100, config.font, menu.scaleFont(config.font, config.fontsize), true, menu.scaleX(config.textoffsetx), menu.scaleY(config.textoffsety), 0, width - menu.scaleX(config.textoffsetx))
hintcontent = { [1] = { color = config.backgroundColor, selectable = false, cols = { [1] = { colspan = 1, content = hintstring } } } }
if (not menu.queue[1].silent) and (not menu.duration) then
PlaySound("notification_hint")
end
menu.duration = menu.duration or (realtime + menu.queue[1].duration)
end
local view_x, view_y = GetViewSize()
local view
if menu.duration then
-- get position data
local position_x, position_y = GetHintPosition(menu.queue[1].position)
local offsetx, offsety = 0, 0
if view_x and view_y then
offsetx = math.min(position_x / 100 * view_x, view_x - width)
offsety = position_y / 100 * view_y
end
if menu.hasMissionTimer then
local desc1 = CreateTable("", content, { width }, false, true, 0, #content, menu.scaleX(config.tableoffsetx), menu.scaleY(config.tableoffsety), height)
local desc2 = CreateTable("", hintcontent, { width }, false, true, 0, #content, offsetx, offsety, height)
view = CreateTwoTableView(desc1, desc2, false, "", "", view_x, view_y, menu.scaleX(config.offsetx), menu.scaleY(config.offsety), "none", true, false, true)
else
local desc = CreateTable("", hintcontent, { width }, false, true, 0, #content, offsetx, offsety, height, 0, 0, 0, false, config.alertEffectColor)
view = CreateTableView(desc, false, "", "", view_x, view_y, menu.scaleX(config.offsetx), menu.scaleY(config.offsety), "none", true, false, true)
end
elseif menu.hasMissionTimer then
local desc = CreateTable("", content, { width }, false, true, 0, #content, menu.scaleX(config.tableoffsetx), menu.scaleY(config.tableoffsety), height)
view = CreateTableView(desc, false, "", "", view_x, view_y, menu.scaleX(config.offsetx), menu.scaleY(config.offsety), "none", true, false, true)
end
if C.IsPlayerValid() and (menu.hasMissionTimer or menu.duration) then
menu.frame = DisplayView(view)
menu.table = GetChildren(menu.frame)
SetScript("onUpdate", menu.onUpdate)
else
menu.cleanup()
end
end
end
function menu.onUpdate()
if not C.IsGamePaused() then
local realtime = GetCurRealTime()
-- only check every second
if menu.lastupdate + 1 < realtime then
menu.lastupdate = realtime
if menu.duration and menu.duration < realtime then
-- hint displayed, but expired
table.remove(menu.queue, 1)
RemoveScript("onUpdate", menu.onUpdate)
if menu.queue[1] then
-- display next hint
menu.duration = nil
menu.displayHelp()
else
if menu.hasMissionTimer then
-- has missiontimer -> update
menu.duration = nil
menu.displayHelp()
else
-- clean up
menu.cleanup()
end
end
return
end
if menu.hasMissionTimer then
-- has missiontimer -> update
-- TODO Florian - change to use updateCellText when issues with debuglog are resolved
RemoveScript("onUpdate", menu.onUpdate)
menu.displayHelp()
end
end
end
end
function menu.round(x, digits)
local mult = 1
if digits and digits > 0 then
mult = 10^digits
end
return math.floor(x * mult + 0.5) / mult
end
function menu.scaleX(x)
local xx = GetViewSize()
if not xx then
return x
else
return menu.round(x * xx / 1280)
end
end
function menu.scaleY(y)
local _, yy = GetViewSize()
if not yy then
return y
else
return menu.round(y * yy / 720)
end
end
function menu.scaleFont(fontname, fontsize)
fontsize = menu.scaleY(fontsize)
return GetBestFontSize(fontname, fontsize)
end
init()