mirror of
https://github.com/bryanthaboi/gen1recomp.git
synced 2026-08-12 08:21:02 +02:00
feat: UI LAYOUT option, centered by default
Edge docking and zoom-linked UI scaling shipped as unconditional behaviour. Both are departures from how the port composed the screen, so they become a setting instead: UI LAYOUT = CENTERED (the default) or DYNAMIC. CENTERED is a fixed letterbox. Elements stay where they were drawn in the 160x144 canvas, and the UI does not follow the survey zoom, so screen furniture neither moves nor resizes under the player. That is what the pre-anchoring builds did. DYNAMIC is the current behaviour, unchanged. Both halves matter together: gating only the anchoring would stop the dialogue box moving but leave it resizing with the zoom, which is the same complaint in a different form. Gated at Renderer:setUIAnchor and Renderer:uiScale rather than at each caller, so one switch covers the dialogue box, its YES/NO, the START menu and anything anchored later, and no caller knows the option exists. Game.dynamicUI answers true only for an explicit "dynamic", so a save written before this keeps the layout it already had. Independent of it, deliberately: BATTLE SIZE still works under either mode (uiFill overrides the scale later, in endFrame), and a battle still holds its own prompts inside its screen under DYNAMIC. Also includes the Oak intro fix (previously #674): the speech fills white over the UI canvas while its dialogue box docks to the window edge, so under DYNAMIC black showed between the two. letterboxWhite closes it, and the shrink beat's replica box rides the same anchor as the real box it stands in for.
This commit is contained in:
spiritsnails
@@ -0,0 +1,67 @@
|
||||
-- Driver: Oak's intro white field must reach the dialogue box.
|
||||
--
|
||||
-- The speech fills white over the 160x144 UI canvas, but TextBox docks to the
|
||||
-- WINDOW's bottom edge (Renderer:setUIAnchor). In a letterboxed window that
|
||||
-- left black between the bottom of the white and the top of the box.
|
||||
-- OakSpeech.letterboxWhite fills the voids with the paper shade instead.
|
||||
--
|
||||
-- Needs a window that actually letterboxes -- an exact multiple of 160x144
|
||||
-- has no voids to get wrong -- so it resizes before shooting.
|
||||
-- POKEPORT_DRIVER=tests/drivers/oak_speech_letterbox_test.lua lovec .
|
||||
return function(game)
|
||||
local U = dofile("tests/drivers/util.lua")
|
||||
local DIR = os.getenv("SHOT_DIR") or "/tmp/shots"
|
||||
local OakSpeech = require("src.ui.OakSpeech")
|
||||
|
||||
local function speechUp()
|
||||
for _, s in ipairs(game.stack.states or {}) do
|
||||
if getmetatable(s) == OakSpeech then return s end
|
||||
end
|
||||
return nil
|
||||
end
|
||||
|
||||
-- 1000x700 is not a multiple of 160x144, so the UI blits at 4x (640x576)
|
||||
-- with real bars above/below -- exactly where the seam shows
|
||||
love.window.setMode(1000, 700)
|
||||
U.wait(30)
|
||||
|
||||
U.wait(5)
|
||||
U.tap(game, "start") -- skip the intro movie
|
||||
U.wait(20)
|
||||
U.tap(game, "a") -- title -> menu
|
||||
U.wait(20)
|
||||
U.tap(game, "a") -- NEW GAME
|
||||
U.wait(30)
|
||||
|
||||
local speech
|
||||
for _ = 1, 600 do
|
||||
speech = speechUp()
|
||||
if speech then break end
|
||||
U.wait(2)
|
||||
end
|
||||
if not speech then
|
||||
U.log("FAIL never reached Oak's speech")
|
||||
return
|
||||
end
|
||||
U.log("Oak speech is up; letterboxWhite =", tostring(OakSpeech.letterboxWhite))
|
||||
|
||||
-- page through, shooting a few beats: the pic + box together is the shot
|
||||
-- that shows whether the white reaches the box
|
||||
for i = 1, 4 do
|
||||
for _ = 1, 200 do
|
||||
local top = game.stack:top()
|
||||
if top and top ~= speech and top.done then break end
|
||||
U.tap(game, "a")
|
||||
U.wait(2)
|
||||
if not speechUp() then break end
|
||||
end
|
||||
if not speechUp() then break end
|
||||
U.wait(20)
|
||||
U.shot(game, DIR .. ("/oak_%d.png"):format(i))
|
||||
U.tap(game, "a")
|
||||
U.wait(20)
|
||||
end
|
||||
|
||||
U.log("done")
|
||||
U.wait(30)
|
||||
end
|
||||
@@ -0,0 +1,53 @@
|
||||
-- Driver: UI LAYOUT centered vs dynamic, same moment shot twice.
|
||||
--
|
||||
-- Only visible when the window letterboxes, so it resizes first: at an exact
|
||||
-- multiple of 160x144 there is nowhere for a docked element to dock TO.
|
||||
-- Shoots the overworld dialogue box and the START menu, the two pieces the
|
||||
-- option moves.
|
||||
-- POKEPORT_DRIVER=tests/drivers/ui_layout_option_test.lua lovec .
|
||||
return function(game)
|
||||
local U = dofile("tests/drivers/util.lua")
|
||||
local DIR = os.getenv("SHOT_DIR") or "/tmp/shots"
|
||||
|
||||
love.window.setMode(1000, 700)
|
||||
U.wait(30)
|
||||
|
||||
-- straight into the overworld, no intro
|
||||
U.teleport(game, "PALLET_TOWN", 5, 6, "down")
|
||||
U.wait(40)
|
||||
|
||||
local function shootBoth(tag)
|
||||
-- START menu (Menu anchors "topright")
|
||||
U.tap(game, "start")
|
||||
U.wait(45)
|
||||
U.shot(game, DIR .. ("/uilayout_%s_startmenu.png"):format(tag))
|
||||
U.tap(game, "b")
|
||||
U.wait(30)
|
||||
|
||||
-- a dialogue box (TextBox anchors "bottom"): read the sign by the door
|
||||
local TextBox = require("src.render.TextBox")
|
||||
game.stack:push(TextBox.new(game, "UI LAYOUT check:\nthis box.", function() end))
|
||||
for _ = 1, 400 do
|
||||
local top = game.stack:top()
|
||||
if top and top.done then break end
|
||||
U.wait(2)
|
||||
end
|
||||
U.wait(30)
|
||||
U.shot(game, DIR .. ("/uilayout_%s_textbox.png"):format(tag))
|
||||
game.stack:pop()
|
||||
U.wait(20)
|
||||
end
|
||||
|
||||
game.save.options.uiLayout = "centered"
|
||||
U.log("UI LAYOUT = centered (the default)")
|
||||
U.wait(20)
|
||||
shootBoth("centered")
|
||||
|
||||
game.save.options.uiLayout = "dynamic"
|
||||
U.log("UI LAYOUT = dynamic")
|
||||
U.wait(20)
|
||||
shootBoth("dynamic")
|
||||
|
||||
U.log("done")
|
||||
U.wait(20)
|
||||
end
|
||||
@@ -0,0 +1,123 @@
|
||||
-- UI LAYOUT (save.options.uiLayout): "centered" keeps every element where it
|
||||
-- was drawn in the 160x144 canvas, so the letterbox centres the whole screen
|
||||
-- the way the port composed it before edge docking existed. "dynamic" opts
|
||||
-- into docking: the dialogue box to the window's bottom edge, the START menu
|
||||
-- to its top right.
|
||||
--
|
||||
-- Centered is the DEFAULT. Docking is a real change to where screen
|
||||
-- furniture sits, so it is opt-in rather than something a player has to
|
||||
-- discover and turn off.
|
||||
--
|
||||
-- One gate, at Renderer:setUIAnchor, so the switch covers the dialogue box,
|
||||
-- its YES/NO, the START menu and anything added later without any of them
|
||||
-- knowing the option exists.
|
||||
-- luajit tests/engine/ui_layout_option.lua
|
||||
|
||||
package.path = "./?.lua;./?/init.lua;" .. package.path
|
||||
|
||||
local T = require("tests.modkit")
|
||||
local Game = require("src.core.Game")
|
||||
local Renderer = require("src.render.Renderer")
|
||||
local SaveData = require("src.core.SaveData")
|
||||
|
||||
-- ------------------------------------------------------------- the default
|
||||
|
||||
T.eq(SaveData.newGame().options.uiLayout, "centered",
|
||||
"a new game starts centered, not docked")
|
||||
|
||||
-- ------------------------------------------------------ reading the option
|
||||
|
||||
-- Only the explicit "dynamic" switches docking on. Everything else means
|
||||
-- centered, which is what makes this safe for a save written before the
|
||||
-- option existed: the key is simply absent and the player keeps the layout
|
||||
-- they already had.
|
||||
T.eq(Game.dynamicUI({ options = { uiLayout = "dynamic" } }), true,
|
||||
"DYNAMIC turns edge docking on")
|
||||
T.eq(Game.dynamicUI({ options = { uiLayout = "centered" } }), false,
|
||||
"CENTERED leaves it off")
|
||||
T.eq(Game.dynamicUI({ options = {} }), false,
|
||||
"a save from before the option existed is centered")
|
||||
T.eq(Game.dynamicUI({}), false, "a save with no options at all is centered")
|
||||
T.eq(Game.dynamicUI(nil), false, "and no save at all is centered")
|
||||
|
||||
-- ------------------------------------------------------------- the gate
|
||||
|
||||
local function anchorsAfter(opts)
|
||||
Renderer.uiAnchors = nil
|
||||
Renderer.uiAnchorHold = opts.hold or false
|
||||
Renderer.uiCentered = opts.centered or false
|
||||
-- the dialogue box's own declaration (TextBox:draw)
|
||||
Renderer:setUIAnchor(0, 96, 160, 48, "bottom")
|
||||
-- and the START menu's (Menu:draw, anchor "topright")
|
||||
Renderer:setUIAnchor(80, 0, 80, 88, "topright")
|
||||
local n = #(Renderer.uiAnchors or {})
|
||||
Renderer.uiAnchors, Renderer.uiAnchorHold, Renderer.uiCentered =
|
||||
nil, false, false
|
||||
return n
|
||||
end
|
||||
|
||||
T.eq(anchorsAfter({ centered = true }), 0,
|
||||
"CENTERED: neither the dialogue box nor the START menu leaves the canvas")
|
||||
T.eq(anchorsAfter({ centered = false }), 2,
|
||||
"DYNAMIC: both dock to the window edge")
|
||||
|
||||
-- the battle hold is unchanged by any of this -- a battle still keeps its own
|
||||
-- prompts inside its screen even with DYNAMIC on (see battle_fixed_menu_scale)
|
||||
T.eq(anchorsAfter({ centered = false, hold = true }), 0,
|
||||
"a battle still holds the anchors while DYNAMIC is on")
|
||||
T.eq(anchorsAfter({ centered = true, hold = true }), 0, "and with it off")
|
||||
|
||||
-- ------------------------------------------------- the scale half of it
|
||||
|
||||
-- CENTERED is a FIXED letterbox, so the UI must not follow the survey zoom
|
||||
-- either: the box that stopped moving must not start resizing instead.
|
||||
local g = love.graphics
|
||||
local realDims, realPixelDims = g.getDimensions, g.getPixelDimensions
|
||||
g.getDimensions = function() return 640, 576 end
|
||||
g.getPixelDimensions = function() return 640, 576 end
|
||||
T.eq(Renderer:fitScale(), 4, "the fixture window fits the classic surface at 4x")
|
||||
|
||||
local Zoom = require("src.render.Zoom")
|
||||
local function scaleAt(offset, centered)
|
||||
local oldOff, oldActive, oldCentered =
|
||||
Zoom.offset, Renderer.worldActive, Renderer.uiCentered
|
||||
-- worldActive true: a live overworld pass, the one case DYNAMIC steps down
|
||||
Zoom.offset, Renderer.worldActive, Renderer.uiCentered = offset, true, centered
|
||||
local s = Renderer:uiScale()
|
||||
Zoom.offset, Renderer.worldActive, Renderer.uiCentered =
|
||||
oldOff, oldActive, oldCentered
|
||||
return s
|
||||
end
|
||||
|
||||
T.eq(scaleAt(0, true), 4, "CENTERED at rest is the fit scale")
|
||||
T.eq(scaleAt(-2, true), 4, "CENTERED zoomed out is STILL the fit scale")
|
||||
T.eq(scaleAt(0, false), 4, "DYNAMIC at rest matches it")
|
||||
T.eq(scaleAt(-2, false), 2, "DYNAMIC zoomed out steps the UI down, as before")
|
||||
|
||||
g.getDimensions, g.getPixelDimensions = realDims, realPixelDims
|
||||
|
||||
-- ------------------------------------------------------------- the row
|
||||
|
||||
local OptionsMenu = require("src.ui.OptionsMenu")
|
||||
local Font = require("src.render.Font")
|
||||
local Data = require("src.core.Data")
|
||||
if not (Data.maps and Data.maps.PALLET_TOWN) then Data:load() end
|
||||
Font.load(Data)
|
||||
|
||||
local game = { data = Data, save = SaveData.newGame(),
|
||||
stack = { states = {}, push = function() end,
|
||||
pop = function() end, top = function() end } }
|
||||
local menu = OptionsMenu.new(game)
|
||||
local row
|
||||
for _, r in ipairs(menu.rows) do
|
||||
if r.id == "uiLayout" then row = r end
|
||||
end
|
||||
T.check(row ~= nil, "OPTIONS carries a UI LAYOUT row")
|
||||
T.eq(row.value(game), "CENTERED", "and it opens on CENTERED")
|
||||
row.step(game, 1)
|
||||
T.eq(game.save.options.uiLayout, "dynamic", "stepping it turns docking on")
|
||||
T.eq(row.value(game), "DYNAMIC", "and the row says so")
|
||||
row.step(game, 1)
|
||||
T.eq(game.save.options.uiLayout, "centered", "stepping again returns to it")
|
||||
|
||||
T.finish("ui layout option")
|
||||
Reference in New Issue
Block a user