mr.zeroandClaude Opus 5
92fc36bdf5
ci/woodpecker/push/woodpecker Pipeline was successful
Every change here started life as a workaround in a game and is really the same finding: a fact about an entity had nowhere to live, so the domain built machinery around the gap. Character.Label / Character.Voice — a tape is a character that speaks into the log, not a second spelling of Say. VoiceOf and CharacterLabel read them; Say obeys them. Game.Do — a real action queue, in order, so a widget can start an action. queueAction no longer drops what arrives while the runner is busy; it queues it. Widget.When + Gated + WidgetVisible — a widget declares when it is on screen. Nothing ticks, draws or blocks a click while its condition is false, so a HUD is hidden for a cutscene without a wrapper per widget. TopBar.NoteVar — the title was already discovered; the note beside it no longer needs a domain widget to push it in. Game.UseWithFail — the pair nobody authored is content, and belongs to the domain, exactly like ExitLook and ExitTake. Game.Player / Game.Walkboxes — a scene that names no cast and no floor means "the usual", instead of a defaults pass rewriting every scene. Game.WindowScale — Run's 4× is now a default, not a decision. SceneNav — the dev widget every game was writing. Colour text: DrawText paints in the colour it is handed, and GlyphW/H, TextWidth, WrapText and ClipText are the library's, not each game's. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
115 lines
3.5 KiB
Go
115 lines
3.5 KiB
Go
package inkwell
|
|
|
|
import "github.com/hajimehoshi/ebiten/v2"
|
|
|
|
// Widget is the minimal surface a HUD element must implement to participate
|
|
// in the per-frame loop. The library ships several built-in widgets
|
|
// (VerbBar, InventoryBar, DialogBox, etc.) and the domain can register
|
|
// arbitrary new ones — chat panels, minimaps, hotbars — as long as they
|
|
// satisfy this interface.
|
|
//
|
|
// Lifecycle:
|
|
// - Tick runs once per frame from the TOP layer down so the top-most
|
|
// widget gets a chance to consume input first via
|
|
// ctx.Game.Input.ConsumeLeft / ConsumeRight.
|
|
// - Draw runs once per frame from the BOTTOM layer up, so a widget on a
|
|
// higher layer is painted on top.
|
|
//
|
|
// Registration order only decides ties inside one layer — see Layer.
|
|
type Widget interface {
|
|
Named
|
|
Tick(ctx *UICtx)
|
|
Draw(dst *ebiten.Image, ctx *UICtx)
|
|
}
|
|
|
|
// Layer is a widget's place in the paint order. A widget says where it
|
|
// belongs rather than depending on the order it happened to be registered
|
|
// in, which frees a domain to register its widgets one file at a time.
|
|
type Layer int
|
|
|
|
const (
|
|
// LayerScene is over the picture and under the HUD: hotspot outlines,
|
|
// cutscene bars, and the invisible widgets that only tick.
|
|
LayerScene Layer = 0
|
|
// LayerPanel is the plate the HUD is drawn on.
|
|
LayerPanel Layer = 100
|
|
// LayerHUD is everything mounted on that plate: verbs, inventory,
|
|
// status line, top bar.
|
|
LayerHUD Layer = 200
|
|
// LayerSpeech is speech bubbles, which float over the scene.
|
|
LayerSpeech Layer = 300
|
|
// LayerDialog is the dialogue box.
|
|
LayerDialog Layer = 400
|
|
// LayerMenu is what opens on top of the game: radial verbs, menus.
|
|
LayerMenu Layer = 500
|
|
// LayerCurtain is what covers the game: end cards, fades.
|
|
LayerCurtain Layer = 600
|
|
// LayerCursor is the pointer, and nothing else belongs above it.
|
|
LayerCursor Layer = 700
|
|
)
|
|
|
|
// Layered is implemented by a widget that declares its own layer. Every
|
|
// built-in widget does. A widget that does not sits on LayerHUD.
|
|
type Layered interface {
|
|
Layer() Layer
|
|
}
|
|
|
|
// Gated is implemented by a widget that can be switched off by game
|
|
// state — every built-in is, through its When field. A widget that does
|
|
// not implement it, or whose condition is nil, is always live.
|
|
type Gated interface {
|
|
VisibleWhen() Condition
|
|
}
|
|
|
|
// WidgetVisible reports whether a widget takes part in this frame at all.
|
|
// A widget switched off neither ticks nor draws, and does not block a
|
|
// click, so a HUD can be hidden for a cutscene without unregistering it.
|
|
func WidgetVisible(ctx *Ctx, w Widget) bool {
|
|
g, ok := w.(Gated)
|
|
if !ok {
|
|
return true
|
|
}
|
|
c := g.VisibleWhen()
|
|
return c == nil || c.Eval(ctx)
|
|
}
|
|
|
|
// LayerOf reports the layer a widget paints on. A wrapper widget that
|
|
// forwards to an inner one — a visibility gate, say — should return
|
|
// LayerOf(inner) so that wrapping does not move the widget.
|
|
func LayerOf(w Widget) Layer {
|
|
if l, ok := w.(Layered); ok {
|
|
return l.Layer()
|
|
}
|
|
return LayerHUD
|
|
}
|
|
|
|
// UICtx is the per-tick context handed to widgets. Game is the root
|
|
// aggregate; DT is seconds since the previous frame.
|
|
type UICtx struct {
|
|
Game *Game
|
|
DT float64
|
|
}
|
|
|
|
// MouseButton identifies which mouse button a widget binds to (e.g. the
|
|
// RadialVerbs widget uses MouseButtonRight by default).
|
|
type MouseButton int
|
|
|
|
const (
|
|
MouseButtonLeft MouseButton = iota
|
|
MouseButtonRight
|
|
)
|
|
|
|
// Size is a {Width, Height} pair in screen-space pixels.
|
|
type Size struct {
|
|
W, H int
|
|
}
|
|
|
|
// Align controls horizontal text alignment for widgets that draw a single line.
|
|
type Align int
|
|
|
|
const (
|
|
AlignLeft Align = iota
|
|
AlignCenter
|
|
AlignRight
|
|
)
|