docs: add item descriptor guide#41
Open
Zodiarche wants to merge 1 commit into
Open
Conversation
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.
Summary
Adds an item descriptor guide as the second page of the new Data section (EN + FR), migrated from
# Describe Item.mdin the engine repository. The page explains howPFM::ItemDescriptorturnsStudio::Itemdata into in-game behavior: the wrapper read by the UIs, the 5-step usage flow, and everydefine_*function with a real vanilla example verified against the engine source (Sacred Ash, Repel, Gracidea, X items, PP Up, Bicycle), plus a custom item built from A to Z.Compared to the original .25-era document: the renamed
define_on_creature_*API, currentStudio::*examples instead ofGameData::*, the battle side fully exemplified, and previously undocumented behaviors (automaticchenfrom the Studio flags,:__undef__andno_effect,is_limitedconsumption, targeting precedence, enforced definition order, chen vs:unuseddecision criteria).Stacked on #39: this branch is based on
docs/data-access-guidebecause thepsdk/datasection is created there. Merge #39 first; GitHub will retarget this PR tomainautomatically.Related issues
Closes #40
Test plan
bun run typecheckpasses.bun run buildpasses on both locales (validates the cross-links with the data access guide, locale-specific slugs).000 ItemDescriptor.rb,001 RepelItem.rb,300 StatBoostItem.rb,300 PPIncreaseItem.rb,001 EventItem.rb)./psdk/data/item-descriptor(EN) and/fr/psdk/data/definir-le-comportement-d-un-objet(FR), right after the data access page in the sidebar.Screenshots
No image on this page (the source document had none).