Configuring a docking port: Difference between revisions

From KSP 2 Modding Wiki
(Add category)
No edit summary
Line 87: Line 87:


[[Category:Creating parts|<nowiki>[[Category:Tutorials]]</nowiki>]]
[[Category:Creating parts|<nowiki>[[Category:Tutorials]]</nowiki>]]
[[Category:Creating parts]]
[[Category:Parts and modules]]

Revision as of 02:08, 15 January 2024

Prerequisites
Configuring the mesh
  1. Click on Add Component > Module_Docking Node.
  2. Fill in the fields.
Field Value/Comment
Module_Docking Node
Docking Transform Name The name of your game object that defines where the docking port should attach to other docking ports.

Remember that foward in Unity is along the blue axis, so point the game object (usually a Empty object) along that direction

Control Transform Name The direction to change to when clicking on Control from Here in the Parts action menu in game.

Again, point the blue axis in the direction you want

Attachment Node id The node to connect to when docking (I think)
Node Types Any array of node sizes that determines which types of docking ports yours can dock to.

For example, size0 is stock 0.625m diameter docking ports, size1 is 1.25m, and so on.

Since this is an array, you can list multiple different types that the port can dock to.

You can also use this to create custom docking port sizes, since it is an array of strings rather than enums.

Undock Ejection Force How much force to use when undocking. The default 10 is probably too much for smaller ports.

The stock 1.25m port uses a value of 0.4

Min Distance To Reengage How far away the ship should get before the docking port will dock again
Acquire Range How close the docking port needs to get to the other port before they will magnetically attract
Acquire Torque How much torque the docking port can apply to align the connection in the non-roll axis?
Acquire TorqueRoll How much torque the docking port can apply to align the connection in the roll axis?
Capture Range How far away the two docking ports need to be before they will lock together
Capture Min Fwd This value determines how much of a difference there can be in the dot product of the two docking transforms

of both docking ports that are currently attempting to dock.

Capture Min Roll Dot Not sure
Capture Max Rvel Not sure
fx Dock Prefab Name The effect to use when docking
fx Undock Prefab Name The effect to use when undocking
Is Gendered Se to true to make this docking port gendered, which means that you need a male and female port to dock.

This could be useful for recreating soviet style drogue and probe docking ports, for example

Is Gender Female If using gendered docking ports, marking this true creates a female docking port
Snap Rotation Set to true if the docking port should snap to angles
Snap Offset The angle to snap to when using Snap Rotation
Current State The default state of the port. You probably want to leave this at Ready
Is Deployable Docking Port Set to true if this is a deployable docking port, like the stock MK1/2 deployable docking ports