Expand description
Engine-agnostic play client UI (world grid, input, presentation).
Structs§
- HudLayout
- KeyBinding
- KeyBinding
Category - MapLegend
Entry - One row in the
?help map legend (glyphs from YAML catalogs). - MapPresentation
- MapTarget
State - Movement
State - Keyboard movement state.
- Norm
Rect - PlayHud
- RgbColor
- UiKey
Event - UiKey
Modifiers - World
View - The TUI map uses one terminal cell per world meter on both axes so terrain, entities, resources, and mouse targeting share the same grid. Terminal fonts are taller than wide, so buildings look vertically stretched compared to the content-admin editor.
- World
View Options - Presentation flags for
WorldView::build_with_options.
Enums§
- Active
Overlay - Which modal overlay is open (if any).
- Combat
KeyAction - HudView
Mode - Play-client HUD density: normal sidebar, compact essentials, or map-first.
- Input
Action - Movement
Input - UiKey
Code - UiKey
Event Kind - UiMouse
Button - UiPointer
Event
Constants§
- CATEGORIES
- EDITOR_
ABILITIES - Fallback open-kit abilities when the character has no known abilities yet.
- MOVEMENT_
IDLE_ TIMEOUT - Fallback stop window when the terminal omits key-release events. Must exceed typical OS key-repeat initial delay (~500ms) so a held key that only refreshes via repeat does not stutter to a stop.
Functions§
- chest_
presentation - combat_
action_ for_ key - corpse_
presentation - door_
presentation - editor_
ability_ choices - Abilities shown in the rotation-editor picker: known (+ weapon), else fallback kit.
- entity_
fallback - format_
keybindings_ plain - Plain-text reference for
flatland3 keysand similar CLIs. - format_
map_ legend_ plain - grid_
to_ world - Inverse of [
world_to_grid]: map view cell → world meters (cell center). - hud_
layout - interior_
door_ display_ xy - Door/stair sprite position: attach to the shared wall between rooms (or perimeter fallback).
- interior_
wall_ glyph_ line - Grid row/column for the wall glyph at
fixed—roundso the glyph lands on the cell that actually contains the sim’s blocking strip (matches collision). - key_
matches - loot_
presentation - map_
legend_ entries - Map legend rows for help overlay and
flatland3 keys. - maybe_
reload_ for_ content_ rev - Reload presentation YAML when the sim reports a newer content revision (after publish).
- next_
custom_ preset - npc_for
- parse_
color - player_
presentation - preset_
deletable - quest_
board_ presentation - reload_
map_ presentation_ catalog - Reload
terrain-kinds.yaml,map-glyphs.yaml, and item glyphs from disk. - resource_
for - shallow_
water_ presentation - terrain_
for - terrain_
for_ elevation - Terrain glyph + color from zone kind and ground elevation (topographic read).
- terrain_
for_ zone - Terrain presentation for a zone cell, applying optional per-zone glyph/color overrides from YAML.
- wall_
presentation - well_
center_ presentation