Skip to content

[Docs] Document DynamicMountDefinition for companion mounts - #145

Merged
Lyeeedar merged 1 commit into
mainfrom
docs/update-20260823-002733
Aug 23, 2026
Merged

[Docs] Document DynamicMountDefinition for companion mounts#145
Lyeeedar merged 1 commit into
mainfrom
docs/update-20260823-002733

Conversation

@Lyeeedar

Copy link
Copy Markdown
Owner

Summary

Documents the DynamicMountDefinition type introduced in commit e2f4064 (issue #9058) and adds the missing CompanionCharacterDefinition interface to the Character Structure doc.

Changes

docs/characters/companions.md

  • Updated mount field in CompanionCharacterDefinition interface: mount?: MountItemmount?: MountItem | DynamicMountDefinition
  • Added new Dynamic Mounts section explaining first-match-wins condition evaluation, with a practical example showing realm-based and quest-based mount swaps
  • Updated the Realm Definition Example to use DynamicMountDefinition instead of a static MountItem

docs/characters/character-structure.md

  • Added Companion Definition subsection (previously absent — CompanionCharacterDefinition was referenced at line 132 but never defined)
  • Includes the full CompanionCharacterDefinition interface with all interaction types and the mount field
  • Added DynamicMountDefinition interface with documentation of the condition-evaluation semantics and first-match-wins resolution order

Game Changes Referenced

Commit Description
e2f40648 Dynamic mounts for companions — new getCharacterMount utility, DynamicMountDefinition type, and `mount?: MountItem

Breaking Changes

None — DynamicMountDefinition is purely additive. Existing companion mount fields using a plain MountItem are unaffected.

🤖 Mod Documentation Updater — automated AI assistant

@Lyeeedar
Lyeeedar merged commit c816249 into main Aug 23, 2026
@Lyeeedar
Lyeeedar deleted the docs/update-20260823-002733 branch August 23, 2026 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant