Create CreatingFormations.md - #176
Conversation
TheGiraffe3
left a comment
There was a problem hiding this comment.
Could you add links to this page in Home.md and _Sidebar.md?
typo fix Co-authored-by: Loymdayddaud <145969603+TheGiraffe3@users.noreply.github.com>
typo fix Co-authored-by: Loymdayddaud <145969603+TheGiraffe3@users.noreply.github.com>
typo fix Co-authored-by: Loymdayddaud <145969603+TheGiraffe3@users.noreply.github.com>
Done. |
|
Ideally that would be done in this PR, since this is where the file is added. |
|
I'm guessing you're using GitHub's web editor to make these changes.
Once a file is changed by a PR, making further changes to it is a bit more straightforward, you can find a guide here: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request#making-changes-to-files-in-your-pull-request If you are using git or GitHub Desktop on your computer, you can alternatively either merge the branches with the other commits into this one, or cherry-pick those commits onto this branch. |
Apologies, I am very new at using Github. |
|
Yes. |
|
done |
petervdmeer
left a comment
There was a problem hiding this comment.
Thanks for documenting this!
I added some remarks based on the implementation and the early/original RFCs.
| ``` | ||
| Will render the first position at 0,200 and then 0,400; 0,600; etc. | ||
|
|
||
| If no repeat attribute is present, all positions will be filled, and any remaining ships will group at 0,0 underneath the flagship. |
There was a problem hiding this comment.
This description for "remaining ships at 0.0" is correct for the current implementation, but do we want this? We might want to consider such "remaining ships" behavior to be undesirable, and file a feature request to let those ships beyond the end position return to the default "flocking" behavior. What do you think?
There was a problem hiding this comment.
I personally like the way they all cluster to 0,0, since it works with some of the formations in my expansion plugin, but I am open to changing it. Definitely specify in the feature request that there should be a message "Formation is fully populated, remaining ships will not fly in formation." in the messages feed.
There was a problem hiding this comment.
I think we should change this behavior in the future in that ships that cannot move in the formation fall back to the default flocking behavior. For this text I think it is fine to just specify "If a formation is fully populated, then the remaining ships will not fly in formation."
| ... | ||
| ``` | ||
|
|
||
| To make formations scalable to any number of ships, a repeat attribute must be applied to the block. Any attribute that exists in a block can be used as a child attribute in `repeat`. |
There was a problem hiding this comment.
I think it would be nice to describe that the attributes in repeat are added on top of the original values, so repeating with a position of 1 will make each repeat iteration one larger than the previous one. While repeating an arc with an non-zero angle in the repeat section will make the repeat sections have larger angles.
There was a problem hiding this comment.
I reworded it to make it a little more clear, does it work?
There was a problem hiding this comment.
Yes, it works, although I would probably choose to say that "a repeat attribute can be applied" instead of using the word "must". There is no absolute need to scale a formation to any number of ships, and a repeat section is no guarantee that a formation can scale to any number of ships.
Changed and added various things to make more clear or fix errors, also added anchor to arcs.
petervdmeer
left a comment
There was a problem hiding this comment.
I have 2 open review comments, but the overall PR/text is fine for me.
| ... | ||
| ``` | ||
|
|
||
| To make formations scalable to any number of ships, a repeat attribute must be applied to the block. Any attribute that exists in a block can be used as a child attribute in `repeat`. |
There was a problem hiding this comment.
Yes, it works, although I would probably choose to say that "a repeat attribute can be applied" instead of using the word "must". There is no absolute need to scale a formation to any number of ships, and a repeat section is no guarantee that a formation can scale to any number of ships.
| ``` | ||
| Will render the first position at 0,200 and then 0,400; 0,600; etc. | ||
|
|
||
| If no repeat attribute is present, all positions will be filled, and any remaining ships will group at 0,0 underneath the flagship. |
There was a problem hiding this comment.
I think we should change this behavior in the future in that ships that cannot move in the formation fall back to the default flocking behavior. For this text I think it is fine to just specify "If a formation is fully populated, then the remaining ships will not fly in formation."
(Choose one heading.)
New feature
(If this PR is to include details on a new feature or a change to a feature, include a link to the PR that makes the corresponding change to Endless Sky.)
endless-sky/endless-sky#4471
Summary
Created a new wiki document called CreatingFormations to cover coding formations into the game. Written by reverse engineering syntax in formations.txt