Skip to content
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

NPCs documentation cleanup #63153

Merged
merged 10 commits into from
Jan 22, 2023
Merged

NPCs documentation cleanup #63153

merged 10 commits into from
Jan 22, 2023

Conversation

cake-pie
Copy link
Contributor

Summary

None

Purpose of change

Clean up organization and formatting of NPCs.md, part 1/?.

Describe the solution

"type": "npc", documentation:

  • fix missing paragraphing
  • code formatting
  • remove reference to obsoleted NPCATT_DEFEND (see NPC vs NPC combat #17781)
  • merge info about age and height fields, which do not deserve their own top-level heading

Special Custom Entries

  • fix missing table formatting

Talk topics, Responses

  • add links to other sections for "see ... for details" text

Responses

  • group condition, switch and default together under "Response Availability" as these control which responses are displayed to the player as possible responses
  • move section about text field so that the common basic case is discussed first, before truefalsetext is introduced as a possible substitute
  • move misplaced sample trials
  • reorganize "success and failure" so that content about each field is consolidated together rather than interleaved among one another
  • merge semi-redundant "opinion changes" into a subsection of "success and failure"
  • Undo text changes regarding mission_opinion from doc/npcs.md: fix some bugs in the formatting #28507, after confirming that relevant code from npctalk: add a bunch of new options to JSON #27734 / cf02075 is still intact: 1 2 3

@github-actions github-actions bot added <Documentation> Design documents, internal info, guides and help. [Markdown] Markdown issues and PRs NPC / Factions NPCs, AI, Speech, Factions, Ownership json-styled JSON lint passed, label assigned by github actions astyled astyled PR, label is assigned by github actions labels Jan 17, 2023
@github-actions github-actions bot added the BasicBuildPassed This PR builds correctly, label assigned by github actions label Jan 17, 2023
@dseguin dseguin merged commit 7a104c2 into CleverRaven:master Jan 22, 2023
@cake-pie cake-pie deleted the npcs-docu branch January 22, 2023 08:51
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 <Documentation> Design documents, internal info, guides and help. 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.

3 participants