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

SDFs omitted from Scenedit docs TOC #675

Closed
NQNStudios opened this issue Mar 3, 2025 · 6 comments · Fixed by #676
Closed

SDFs omitted from Scenedit docs TOC #675

NQNStudios opened this issue Mar 3, 2025 · 6 comments · Fixed by #676
Labels
meta Related to the build system or other things other than the code

Comments

@NQNStudios
Copy link
Collaborator

I went to double-check whether the 350 is rows or columns, and expected the Scenedit documentation TOC https://openboe.com/docs/editor/Contents.html to have a heading for "SDF" or "Stuff Done Flags" because that's such a core concept. But there isn't one--I haven't found the info yet.

@NQNStudios NQNStudios added the meta Related to the build system or other things other than the code label Mar 3, 2025
@NQNStudios
Copy link
Collaborator Author

It's a subtopic of 9. Advanced Topics Introduction and I think it should be listed as 9a or something in the TOC.

@CelticMinstrel
Copy link
Member

CelticMinstrel commented Mar 4, 2025

…and apparently it's even wrong, nice!

EDIT: And now I checked back to the first revision of the docs, and it says the same thing – 300 wide and 10 tall. That's not the original version though. I'm not sure if I have that… and there's at least one real mechanic in the game that clearly treats the array as taller than it is wide.

@CelticMinstrel
Copy link
Member

CelticMinstrel commented Mar 4, 2025

I looked up the original original documentation in DocMaker format (found it on my old computer). I can't run the DocMaker app anymore, but opening it in a resource editor easily reveals the actual text.

In Section 9, it says:

Picture a grid of numbers, 300 wide and 10 high, all of which start at 0.

So that would seem to suggest that I was, indeed, incorrect.

Then in Appendix 1a, it says:

Type 22: Set Many Flags     This node sets 10 Stuff Done flags to a desired value.

But in special.hpp, we have:

SET_SDF_ROW = 22

So I'm not quite sure what conclusion to draw from that. It's possible I chose the wrong name for node 22?

Anyway, the SDF picker was built with the assumption of 350 rows and 50 columns. Considering it that way makes the picker work better, I think, since an entry must be much wider than it is high. So I think I've in favour of changing the documentation here.

@NQNStudios
Copy link
Collaborator Author

Could I leave it to you to decide what it should be and make the change?

Both in the docs and in my commit with the nested maps, if you could make them how you want it I think I could use a break. (Or I'll come back to it later, maybe this weekend.)

@CelticMinstrel
Copy link
Member

Could I leave it to you to decide what it should be and make the change?

Maybe, but I'm working on more pickers at the moment, so it probably wouldn't be for at least a couple of days.

@NQNStudios
Copy link
Collaborator Author

My brain is fried. Deleted my comments because I was very mixed up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Related to the build system or other things other than the code
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants