Skip to content

Minor parse_tags fix + doc update, mapgen parameter doc update #81810

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Procyonae
Copy link
Contributor

@Procyonae Procyonae commented Jul 14, 2025

Summary

None

Purpose of change

Forgot to document keybind tags when I moved them to parse_tags
Forgot to document omt_stack scope for parameters when I added that

Describe the solution

Rewrite mapgen parameter docs bc I didn't think the ordering was ideal and they didn't feel very approachable
Update parse_tags docs from the code
Made a snippet along its already snippetised brethren bc it doesn't need to be a tag and parse_tags already expands snippets so there's no coverage issue
Remove the legacy keybind tag handling that I'm not sure why I left

Describe alternatives you've considered

Not overly happy with the unbound message bc there's no sensible way to contextualise the category id that I'm aware of but it at least provides the translated name to search for if you can find the right menu.
Adding a usage of parameters picking palettes, the syntax is identical though it'd just be to drive home that you can use these in most fields

Testing

Tested the new keybind tag error messages fire correctly
Checked tutorial snippets going via parse_tags doesn't magically blow up anything

Additional context

Snippetises <punc> and deduplicates time_durations to_string()
No clue why I didn't do this originally, it works fine
@github-actions github-actions bot added <Documentation> Design documents, internal info, guides and help. NPC / Factions NPCs, AI, Speech, Factions, Ownership [JSON] Changes (can be) made in JSON [C++] Changes (can be) made in C++. Previously named `Code` [Markdown] Markdown issues and PRs labels Jul 14, 2025
`<spell_description:ID>` | The description of the trait from ID
Certain entries like the snippets above are taken from the game state as opposed to JSON; they are found in the npctalk function parse_tags. In dialogue the alpha talker is the avatar and the beta talker is the NPC.

| Field | Uses alpha | Uses beta | Description
Copy link
Member

@RenechCDDA RenechCDDA Jul 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a really obnoxious table to read. The "uses alpha"/"uses beta" columsn should just be one column which lists either "Alpha" or "Beta" or "N/A". Since checking alpha or beta is mutually exclusive, there is no need for two columns.

(The entry for context_val appears to be just plain wrong, since it is a context val.)

@github-actions github-actions bot added json-styled JSON lint passed, label assigned by github actions astyled astyled PR, label is assigned by github actions BasicBuildPassed This PR builds correctly, label assigned by github actions labels Jul 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
astyled astyled PR, label is assigned by github actions BasicBuildPassed This PR builds correctly, label assigned by github actions [C++] Changes (can be) made in C++. Previously named `Code` <Documentation> Design documents, internal info, guides and help. [JSON] Changes (can be) made in JSON json-styled JSON lint passed, label assigned by github actions [Markdown] Markdown issues and PRs NPC / Factions NPCs, AI, Speech, Factions, Ownership
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants