Repository navigation
docs: add web views, HUD, map markers and keys guides - #11
Merged
Merged
Conversation
New User interface section (orders 60-69), written against 1.8.2: web views and the page bridge, HUD groups, prompts and nametags, map blips, routes and the minimap, and key bindings, control locks and the game's menus. The sample checker now also ignores TS2584, the variant of a missing lowercase name that page globals such as document produce.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a User interface section (sidebar orders 60–69) with four guides, written for the published 1.8.2 release and checked against the v1.8.2 Mod source and its Framework pin:
filesand loading them asfw://resources/<resource>/<path>, view options and lifetime, thecallEvent/Web.on/Web.emitbridge with a ready handshake, focus and input, origin locking, and whyplayer.showUIneeds auiresource that neither the release nor Foundations ships.Game.notify.Minimap.state()/minimapChanged. Blips belong to the client rather than the resource, so the guide shows the server keeping the set and replaying it to new players.Key.bindwith the full list of key names (physical positions, US names), when bindings are suppressed,Game.lockControls, and the Field Guide, page, action screen and tool wheel holds.The overview lists the new section and the README records its order range.
scripts/check_samples.mjsnow also ignores TS2584, the "change your target library" form of a missing lowercase name. It is what a page script'sdocumentproduces, so it falls under the same rule as other lowercase names the reader's own code provides. The generator rejects<script>and<button>anywhere in a guide, so the web-view example shows the page's script as its own file rather than an HTML listing.Checks:
check_samples(86 samples, 1.8.2 contract),docs.mjs build,check_linksandgit diff --checkall pass.