MistressNebula: MistressNebula moved page User:MistressNebula/MissionGen: Hook implementations to Mod:Nebula's Mission Board/ Hook implementations: Move to Mod namespace

2025-07-29T17:51:00Z

MistressNebula moved page User:MistressNebula/MissionGen: Hook implementations to Mod:Nebula's Mission Board/ Hook implementations: Move to Mod namespace

← Older revision	Revision as of 17:51, 29 July 2025
(No difference)

MistressNebula: Make page

2025-07-28T12:55:05Z

Make page

New page

This page contains the standard implementation of all of the library's most essential hooks, sorted by the file the are supposed to be in. You are free to copy-paste them from here, instead of the example mod's files, and edit them afterwards if you need to do so.<br/>
Most event calls just consist of calling the corresponding library function and passing all parameters down to it, but the common functions can be a bit more involved.

=== common.lua ===
<pre>
MissionGen = require("missiongen_lib.missiongen_lib")

function COMMON.ShowDestinationMenu(dungeon_entrances, ground_entrances, force_list, speaker, confirm_msg)
local job_dests = MissionGen:LoadJobDestinations()

local open_dests = {}
-- check for unlock of grounds
for ii = 1, #ground_entrances, 1 do
if ground_entrances[ii].Flag then
local ground_id = ground_entrances[ii].Zone
local zone_summary = _DATA.DataIndices[RogueEssence.Data.DataManager.DataType.Zone]:Get(ground_id)
local ground = _DATA:GetGround(zone_summary.Grounds[ground_entrances[ii].ID])
local ground_name = ground:GetColoredName()
table.insert(open_dests, {
Name = ground_name,
Dest = RogueEssence.Dungeon.ZoneLoc(ground_id, -1, ground_entrances[ii].ID, ground_entrances[ii].Entry)
})
end
end

-- check for unlock of dungeons
for ii = 1, #dungeon_entrances, 1 do
if GAME:DungeonUnlocked(dungeon_entrances[ii]) then
local zone_summary = _DATA.DataIndices[RogueEssence.Data.DataManager.DataType.Zone]:Get(dungeon_entrances[ii])
if zone_summary.Released then
local zone_name = ""
if _DATA.Save:GetDungeonUnlock(dungeon_entrances[ii]) ==
RogueEssence.Data.GameProgress.UnlockState.Completed then
zone_name = zone_summary:GetColoredName()
else
zone_name = "[color=#00FFFF]" .. zone_summary.Name:ToLocal() .. "[color]"
end
zone_name = MissionGen:FormatDestinationMenuZoneName(job_dests, dungeon_entrances[ii], zone_name) -- missiongen_lib.lua

table.insert(open_dests, {
Name = zone_name,
Dest = RogueEssence.Dungeon.ZoneLoc(dungeon_entrances[ii], 0, 0, 0)
})
end
end
end

local dest = RogueEssence.Dungeon.ZoneLoc.Invalid
if #open_dests > 1 or force_list then
if before_list ~= nil then
before_list(dest)
end

SOUND:PlaySE("Menu/Skip")
local default_choice = 1
while true do
UI:ResetSpeaker()
UI:DestinationMenu(open_dests, default_choice)
UI:WaitForChoice()
default_choice = UI:ChoiceResult()

if default_choice == nil then
break
end
local ask_dest = open_dests[default_choice].Dest
if ask_dest.StructID.Segment >= 0 then
-- chosen dungeon entry
if speaker ~= nil then
UI:SetSpeaker(speaker)
else
UI:ResetSpeaker(false)
end
UI:DungeonChoice(open_dests[default_choice].Name, ask_dest)
UI:WaitForChoice()
if UI:ChoiceResult() then
dest = ask_dest
break
end
else
dest = ask_dest
break
end
end
elseif #open_dests == 1 then
if open_dests[1].Dest.StructID.Segment < 0 then
-- single ground entry
if speaker ~= nil then
UI:SetSpeaker(speaker)
else
UI:ResetSpeaker(false)
SOUND:PlaySE("Menu/Skip")
end
UI:ChoiceMenuYesNo(STRINGS:FormatKey("DLG_ASK_ENTER_GROUND", open_dests[1].Name))
UI:WaitForChoice()
if UI:ChoiceResult() then
dest = open_dests[1].Dest
end
else
-- single dungeon entry
if speaker ~= nil then
UI:SetSpeaker(speaker)
else
UI:ResetSpeaker(false)
SOUND:PlaySE("Menu/Skip")
end
UI:DungeonChoice(open_dests[1].Name, open_dests[1].Dest)
UI:WaitForChoice()
if UI:ChoiceResult() then
dest = open_dests[1].Dest
end
end
else
PrintInfo("No valid destinations found!")
end

if dest:IsValid() then
if confirm_msg ~= nil then
UI:WaitShowDialogue(confirm_msg)
end
if dest.StructID.Segment > -1 then
-- pre-loads the zone on a separate thread while we fade out, just for a little optimization
_DATA:PreLoadZone(dest.ID)
SOUND:PlayBGM("", true)
GAME:FadeOut(false, 20)
GAME:EnterDungeon(dest.ID, dest.StructID.Segment, dest.StructID.ID, dest.EntryPoint,
RogueEssence.Data.GameProgress.DungeonStakes.Risk, true, false)
else
SOUND:PlayBGM("", true)
GAME:FadeOut(false, 20)
GAME:EnterZone(dest.ID, dest.StructID.Segment, dest.StructID.ID, dest.EntryPoint)
end
end
end

function COMMON.EnterDungeonMissionCheck(zoneId, segmentID)
local escort_jobs, removed_names = MissionGen:EnterDungeonPrepareParty(zoneId)
MissionGen:PrintSentHome(removed_names)

local added_names = MissionGen:EnterDungeonAddJobEscorts(zoneId, escort_jobs)
for _, name in ipairs(COMMON.GetSortedKeys(SV.missions.Missions)) do
local mission = SV.missions.Missions[name]
if mission.Complete == COMMON.MISSION_INCOMPLETE and zoneId == mission.DestZone and segmentID ==
mission.DestSegment then
if mission.Type == 1 then -- escort
-- add escort to team
local mon_id = mission.EscortSpecies
local new_mob = _DATA.Save.ActiveTeam:CreatePlayer(_DATA.Save.Rand, mon_id, 50, "", -1)
_DATA.Save.ActiveTeam.Guests:Add(new_mob)

local talk_evt = RogueEssence.Dungeon.BattleScriptEvent("EscortInteract")
new_mob.ActionEvents:Add(talk_evt)

local tbl = LTBL(new_mob)
tbl.Escort = name

table.insert(added_names, new_mob.Name)
end
end
end
MissionGen:PrintEscortAdd(added_names)
end
</pre>

=== common_vars.lua ===
<pre>
---Check used in missiongen_settings to see if there is an active sidequest in the current zone
function COMMON.HasSidequestInZone(zone)
for _, mission in pairs(SV.missions.Missions) do
if mission.DestZone == zone then
return true
end
end
return false
end

---Overrides origin function.
function COMMON.ExitDungeonMissionCheckEx(result, rescue, zoneId, segmentID)
--remove all guests from the dungeon
return MissionGen:ExitDungeonMissionCheckEx(result, rescue, zoneId, segmentID)
end
</pre>

=== event_battle.lua ===
<pre>
--- Reuse origin code
local base_game_escort_interact = BATTLE_SCRIPT.EscortInteract
function BATTLE_SCRIPT.EscortInteract(owner, ownerChar, context, args)
if (context.Target.LuaData.JobReference) then
MissionGen:EscortInteract(owner, ownerChar, context, args)
else
base_game_escort_interact(owner, ownerChar, context, args)
end
end

function BATTLE_SCRIPT.EscortReached(owner, ownerChar, context, args)
MissionGen:EscortReached(owner, ownerChar, context, args)
end

function BATTLE_SCRIPT.RescueReached(owner, ownerChar, context, args)
MissionGen:RescueReached(owner, ownerChar, context, args)
end
</pre>

=== event_mapgen.lua ===
<pre>
function ZONE_GEN_SCRIPT.GenerateJobInFloor(zoneContext, context, queue, seed, args)
MissionGen:GenerateJobInFloor(zoneContext, context, queue, seed, args)
end
</pre>

=== event_single.lua ===
<pre>function SINGLE_CHAR_SCRIPT.SpawnOutlaw(owner, ownerChar, context, args)
MissionGen:SpawnOutlaw(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.OutlawFloor(owner, ownerChar, context, args)
MissionGen:OutlawFloor(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.OutlawDeathCheck(owner, ownerChar, context, args)
MissionGen:OutlawDeathCheck(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.OutlawCheck(owner, ownerChar, context, args)
MissionGen:OutlawCheck(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.MonsterHouseOutlawCheck(owner, ownerChar, context, args)
MissionGen:MonsterHouseOutlawCheck(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.OutlawItemCheckItem(owner, ownerChar, context, args)
MissionGen:OutlawItemCheckItem(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.OutlawItemCheck(owner, ownerChar, context, args)
MissionGen:OutlawItemCheck(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.OutlawFleeStairsCheck(owner, ownerChar, context, args)
MissionGen:OutlawFleeStairsCheck(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.ExplorationReached(owner, ownerChar, context, args)
MissionGen:ExplorationReached(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.MissionItemCheck(owner, ownerChar, context, args)
MissionGen:MissionItemCheck(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.MissionGuestCheck(owner, ownerChar, context, args)
MissionGen:MissionGuestCheck(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.MobilityEndTurn(owner, ownerChar, context, args)
MissionGen:MobilityEndTurn(owner, ownerChar, context, args)
end
</pre>

Mod:Nebula's Mission Board/ Hook implementations - Revision history

MistressNebula: MistressNebula moved page User:MistressNebula/MissionGen: Hook implementations to Mod:Nebula's Mission Board/ Hook implementations: Move to Mod namespace

MistressNebula: Make page