Fix the inaccuracy/vagueness in Vessel:ROOTPART documentation. #641
Conversation
Pulling development branch updates
This caught my eye and I decided to clarify this part of the documentation.
| @@ -217,7 +217,7 @@ All vessels share a structure. To get a variable referring to any vessel you can | |||
| :type: :struct:`Part` | |||
| :access: Get only | |||
|
|
|||
| The first :struct:`Part` that was used to begin the ship design - the command core. Vessels in KSP are built in a tree-structure, and the first part that was placed is the root of that tree. | |||
| The ROOTPART is usually the first :struct:`Part` that was used to begin the ship design - the command core. Vessels in KSP are built in a tree-structure, and the first part that was placed is the root of that tree. It is possible to change the root part in VAB/SPH by using Root tool, so ROOTPART does not always point to command core or command pod. Also keep in mind that when you detach a part of a vessel or sub-craft - for example a ComSat subassembly - it becomes a new Vessel with it's own ROOTPART. | |||
There was a problem hiding this comment.
Unless you can launch a subassembly without adding it to another craft, that second sentence of the change doesn't make any difference and is really confusing. The root part of the subassembly won't be the root part of whatever vessel you attach it to, unless its the first part added to the new vessel, in which case that's already covered by the other sentences.
The change mentioning the new editor feature that wasn't there when this was first written, however, is a good change.
There was a problem hiding this comment.
I think you misread. A detached sub-assembly becomes a new Vessel, so if your core is attached to this subassembly the ROOTPART will change on detachment.
I have a script that monitors detachment every second by comparing previous ROOTPART:TAG with current one.
There was a problem hiding this comment.
Maybe I need to clarify - When you detach a part of a vessel in flight
|
In that case you need to drop the "for example a comsat subassembly", which is a misleading part of the description. You're apparently not talking about the subassembly feature at all. How it was built is irrelevant to your point about decoupling or undocking. Basically, the word "subassembly" means that editor feature, and is not the term used to describe he similar thing that happens in flight. |
|
Hmm, yes. Maybe completely replace last sentence with something like this: Vessel:ROOTPART may change in flight as a result of docking/undocking or detaching of some part of a Vessel. It is a bit more vague, but still conveys the message. |
|
I don't agree that it's "a bit more vague". It's more accurate. The term "subassembly" has a very specific meaning in KSP and it's not the meaning you meant to say. |
Fix the inaccuracy/vagueness in Vessel:ROOTPART documentation.
No description provided.