Identify written contents variable and flag names #136
Conversation
This file contains 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
item_flags2[3] is the flag that indicates that a quire or scroll has one or more itemimprovement_writingst improvements on it. It's used by workshops to determine if an object might meet the [HAS_WRITING_IMPROVEMENT] requirement for reactions like BIND_BOOK. (There's also a further check to see if there's an actual improvement in the improvements list.)
itemimprovement_writingst::anon_1 contains the writings in a quire, scroll, or book. The elements are IDs into df.global.world.written_contents.all. Naming this variable will also fix the inconvenient name collision with the anon_1 in the base class.
kane-t
changed the title
That's used for codices, whereas writingst is used for scrolls. The difference being that writingst is for items with something written on them (and then the scroll rollers are defined by the itemspecificst improvement) and pagesst is for items with things that have writing in them (the book material is the binding and the pagesst has the paper material). |
Ah! Cheers. Funnily enough, I looked at more than 20 random things in my library before submitting the pull request, to try to find a pagesst, and somehow all of them were quires and scrolls. I really wish the UI differentiated between quires, scrolls, and codices in the item name. |
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.
Finally got around to doing this myself: this names the item_flags2 flag and the vector in itemimprovement_writingst which are used for written contents things in quires, scrolls, and books.
The name for the flag comes from the [HAS_WRITTEN_CONTENTS] requirement in the BIND_BOOK reaction. The name for itemimprovement_writingst::anon_1 comes from the apparently-identical vector in itemimprovement_pagesst. (I haven't personally seen a pagesst, myself, but the ref says it points to written_contents, and that's what the writingst one does.)