Part¶

These are the generic properties every PART has. You can obtain a list of values of type Part using the LIST PARTS command.

structure Part¶

Members¶
Suffix	Type	Description
`NAME`	`String`	Name of this part
`TITLE`	`String`	Title as it appears in KSP
`MASS`	`Scalar`	Current mass of part and its resources
`DRYMASS`	`Scalar`	Mass of part if all resources were empty
`WETMASS`	`Scalar`	Mass of part if all resources were full
`TAG`	`String`	Name-tag if assigned by the player
`CONTROLFROM`	None	Call to control-from to this part
`STAGE`	`Scalar`	The stage this is associated with
`CID`	`String`	Craft-Unique identifying number of this part
`UID`	`String`	Universe-Unique identifying number of this part
`ROTATION`	`Direction`	The rotation of this part’s \(x\)-axis
`POSITION`	`Vector`	The location of this part in the universe
`FACING`	`Direction`	the direction that this part is facing
`BOUNDS`	`Bounds`	Bounding-box information about this part’s shape
`RESOURCES`	`List`	list of the `Resource` in this part
`TARGETABLE`	`Boolean`	true if this part can be selected as a target
`SHIP`	`Vessel`	the vessel that contains this part
`GETMODULE(name)`	`PartModule`	Get one of the `PartModules` by name
`GETMODULEBYINDEX(index)`	`PartModule`	Get one of the `PartModules` by index
`MODULES`	`List`	Names (`String`) of all `PartModules`
`ALLMODULES`	`List`	Same as `MODULES`
`HASMODULE(name)`	`Boolean`	True if the part has the named module in it, false if not.
`PARENT`	`Part`	Adjacent `Part` on this `Vessel`.
`HASPARENT`	`Boolean`	Check if this part has a parent `Part`
`DECOUPLER`	`Decoupler` or `String`	The decoupler/separator that will decouple this part when activated. None if no such exists.
`SEPARATOR`	`Decoupler` or `String`	Alias name for `DECOUPLER`
`DECOUPLEDIN`	`Scalar`	The stage number where this part will get decoupled. -1 if cannot be decoupled.
`SEPARATEDIN`	`Scalar`	Alias name for `DECOUPLEDIN`
`HASPHYSICS`	`Boolean`	Does this part have mass or drag
`CHILDREN`	`List`	List of attached `Parts`
`SYMMETRYCOUNT`	`Scalar`	How many parts in this part’s symmetry set
`REMOVESYMMETRY`	none	Like the “Remove From Symmetry” button.
`SYMMETRYPARTNER(index)`	`part`	Return one of the other parts symmetrical to this one.
`PARTSNAMED(name)`	`List` (of `Part`)	Search the branch from here down based on name.
`PARTSNAMEDPATTERN(pattern)`	`List` (of `Part`)	Regex search the branch from here down based on name.
`PARTSTITLED(name)`	`List` (of `Part`)	Search the branch from here down for parts titled this.
`PARTSTITLEDPATTERN(pattern)`	`List` (of `Part`)	Regex Search the branch from here down for parts titled this.
`PARTSTAGGED(tag)`	`List` (of `Part`)	Search the branch from here down for parts tagged this.
`PARTSTAGGEDPATTERN(pattern)`	`List` (of `Part`)	Regex Search the branch from here down for parts tagged this.
`PARTSDUBBED(name)`	`List` (of `Part`)	Search the branch from here down for parts named, titled, or tagged this.
`PARTSDUBBEDPATTERN(name)`	`List` (of `Part`)	Regex Search the branch from here down for parts named, titled, or tagged this.
`MODULESNAMED(name)`	`List` (of `PartModule`)	Search the branch from here down for modules named, titled, or tagged this.
`ALLTAGGEDPARTS`	`List` (of `Part`)	Search the branch from here down for all parts with a non-blank tag name.

Part:NAME¶

Access: Get only
Type: String

Name of part as it is used behind the scenes in the game’s API code.

A part’s name is the name it is given behind the scenes in KSP. It never appears in the normal GUI for the user to see, but it is used in places like Part.cfg files, the saved game persistence file, the ModuleManager mod, and so on.

Part:TITLE¶

Access: Get only
Type: String

The title of the part as it appears on-screen in the gui.

A part’s title is the name it has inside the GUI interface on the screen that you see as the user.

Part:TAG¶

Access: Get / Set
Type: String

The name tag value that may exist on this part if you have given the part a name via the name-tag system.

A part’s tag is whatever custom name you have given it using the name-tag system described here. This is probably the best naming convention to use because it lets you make up whatever name you like for the part and use it to pick the parts you want to deal with in your script.

WARNING: This suffix is only settable for parts attached to the CPU Vessel

Part:CONTROLFROM()¶

Access: Callable function only
Return type: None

Call this function to cause the game to do the same thing as when you right-click a part on a vessel and select “control from here” on the menu. It rotates the control orientation so that fore/aft/left/right/up/down now match the orientation of this part. NOTE that this will not work for every type of part. It only works for those parts that KSP itself allows this for (control cores and docking ports). It accepts no arguments, and returns no value. All vessels must have at least one “control from” part on them somewhere, which is why there’s no mechanism for un-setting the “control from” setting other than to pick another part and set it to that part instead.

Warning

This suffix is only callable for parts attached to the CPU Vessel

Part:STAGE¶

Access: Get only
Type: Scalar

the stage this part is part of.

Part:CID¶

Access: Get only
Type: String

Part Craft ID. This is similar to Part:UID, except that this ID is only unique per craft design. In other words if you launch two copies of the same design without editing the design at all, then the same part in both copies of the design will have the same Part:CID as each other. (This value is kept in the craft file and repeated in each instance of the vessel that you launch).

Part:UID¶

Access: Get only
Type: String

Part Universal ID. All parts have a unique ID number. Part’s uid never changes because it is the same value as stored in persistent.sfs. Although you can compare parts by comparing their uid it is recommended to compare parts directly if possible.

Part:ROTATION¶

Access: Get only
Type: Direction

The rotation of this part’s X-axis, which points out of its side and is probably not what you want. You probably want the Part:FACING suffix instead.

Part:POSITION¶

Access: Get only
Type: Vector

The location of this part in the universe. It is expressed in the same frame of reference as all the other positions in kOS, and thus can be used to help do things like navigate toward the position of a docking port.

Part:FACING¶

Access: Get only
Type: Direction

The direction that this part is facing, which is also the rotation that would transform a vector from a coordinate space where the axes were oriented to match the part, to one where they’re oriented to match the world’s ship-raw coordinates.

Part:BOUNDS¶

Access: Get only
Type: Bounds

Constructs a “bounding box” structure that can be used to give your script some idea of the extents of the part’s shape - how wide, long, and tall it is.

It can be slightly expensive in terms of CPU time to keep calling this suffix over and over, as kOS has to perform some work to build this structure. If you need to keep looking at a part’s bounds again and again in a loop, and you know that part’s shape isn’t going to be changing (i.e. you’re not going to extend a solar panel or something like that), then it’s better for you to call this :BOUNDS suffix just once at the top, storing the result in a variable that you use in the loop.

More detailed information is found on the documentation page for Bounds.

Part:MASS¶

Access: Get only
Type: Scalar

The current mass or the part and its resources. If the part has no physics this will always be 0.

Part:WETMASS¶

Access: Get only
Type: Scalar

The mass of the part if all of its resources were full. If the part has no physics this will always be 0.

Part:DRYMASS¶

Access: Get only
Type: Scalar

The mass of the part if all of its resources were empty. If the part has no physics this will always be 0.

Part:RESOURCES¶

Access: Get only
Type: List

list of the Resource in this part.

Part:TARGETABLE¶

Access: Get only
Type: Boolean

True if this part can be selected by KSP as a target.

This example assumes you have a target vessel picked, and that the target vessel is loaded into full-physics range and not “on rails”. vessels that are “on rails” do not have their full list of parts entirely populated at the moment:

LIST PARTS FROM TARGET IN tParts.

PRINT "The target vessel has a".
PRINT "partcount of " + tParts:LENGTH.

SET totTargetable to 0.
FOR part in tParts {
    IF part:TARGETABLE {
        SET totTargetable TO totTargetable + 1.
    }
}

PRINT "...and " + totTargetable.
PRINT " of them are targetable parts.".

Part:SHIP¶

Access: Get only
Type: Vessel

the vessel that contains this part.

Part:GETMODULE(name)¶

Parameters

name – (String) Name of the part module

Returns

PartModule

Get one of the PartModules attached to this part, given the name of the module. (See Part:MODULES for a list of all the names available).

Part:GETMODULEBYINDEX(index)¶

Parameters

index – (Scalar) Index number of the part module

Returns

PartModule

Get one of the PartModules attached to this part, given the index number of the module. You can use Part:MODULES for a list of names of all modules on the part. The indexes are not guaranteed to always be in the same order. It is recommended to iterate over the indexes with a loop and verify the module name:

local moduleNames is part:modules.
for idx in range(0, moduleNames:length) {
    if moduleNames[idx] = "test module" {
        local pm is part:getmodulebyindex(idx).
        DoSomething(pm).
    }
}

Part:MODULES¶

Access: Get only
Type: List of strings

list of the names of PartModules enabled for this part.

Part:ALLMODULES¶: Same as Part:MODULES

Part:HASMODULE(name)¶

Parameters

name – (String) The name of the module to check for

Returns

Boolean

Checks to see if this part contains the PartModule with the name given. If it does, this returns true, else it returns false. (If HASMODULE(name) returns false, then this means an attempt to use GETMODULE(name) would fail with an error.)

Part:PARENT¶

Access: Get only
Type: Part

When walking the tree of parts, this is the part that this part is attached to on the way “up” toward the root part.

Part:HASPARENT¶

Access: Get only
Type: Boolean

When walking the tree of parts, this is true as long as there is a parent part to this part, and is false if this part has no parent (which can only happen on the root part).

Part:DECOUPLER¶

Access: Get only
Type: Decoupler or String

The decoupler/separator that will decouple this part when activated. None if no such exists.

Part:SEPARATOR¶

Access: Get only
Type: Decoupler or String

Alias name for DECOUPLER

Part:DECOUPLEDIN¶

Access: Get only
Type: Scalar

The stage number where this part will get decoupled. -1 if cannot be decoupled.

Part:SEPARATEDIN¶

Access: Get only
Type: Scalar

Alias name for DECOUPLEDIN

Part:HASPHYSICS¶

Access: Get only
Type: bool

This comes from a part’s configuration and is an artifact of the KSP simulation.

For a list of stock parts that have this attribute and a fuller explanation see the KSP wiki page about massless parts.

Part:CHILDREN¶

Access: Get only
Type: List of Parts

When walking the tree of parts, this is all the parts that are attached as children of this part. It returns a list of zero length when this part is a “leaf” of the parts tree.

Part:SYMMETRYCOUNT¶

Access: Get only
Type: Scalar

Returns how many parts are in the same symmetry set as this part.

Note that all parts should at least return a minimum value of 1, since even a part placed without symmetry is technically in a group of 1 part, itself.

Part:SYMMETRYTYPE¶

Access: Get only
Type: Scalar

Tells you the type of symmetry this part has by returning a number as follows:

0 = This part has radial symmetry

1 = This part has mirror symmetry

It’s unclear if this means anything when the part’s symmetry is 1x.

Part:REMOVESYMMETRY()¶

Access: method
Returns: nothing

Call this method to remove this part from its symmetry group, reverting it back to a symmetry group of 1x (just itself). This has the same effect as pressing the “Remove From Symmetry” button in the part’s action window.

Note that just like when you press the “Remove from Symmetry” button, once a part has been removed from symmetry you don’t have a way to put it back into the symmetry group again.

Part:SYMMETRYPARTNER(index)¶

Access

method

Parameters

name – (Scalar) Index of which part in the symmetry group

Returns

Part

When a set of parts has been placed with symmetry in the Vehicle Assembly Building or Space Plane Hangar, this method can be used to find all the parts that are in the same symmetrical group.

The index is numbered from zero to :attr:SYMMETRYCOUNT minus one.

The zero-th symmetry partner is this part itself. Even parts placed without symmetry still are technically in a symmetry group of 1 part.

The index also wraps around in a cycle, such that if there are 4 parts in symmetry, then SYMMETRYPARTNER(0) and SYMMETRYPARTNER(4) and SYMMETRYPARTNER(8) would all actually be the same part.

Example:

// Print the symmetry group a part is inside:
function print_sym {
  parameter a_part.

  print a_part + " is in a " + a_part:SYMMETRYCOUNT + "x symmetry set.".

  if a_part:SYMMETRAYCOUNT = 1 {
    return. // no point in printing the list when its not in a group.
  }

  if a_part:SYMMETRYTYPE = 0 {
    print "  The symmetry is radial.".
  } else if a_part:SYMMETRYTYPE = 1 {
    print "  The symmetry is mirror.".
  } else {
    print "  The symmetry is some other weird kind that".
    print "  didn't exist back when this example was written.".
  }

  print "    The Symmetry Group is: ".
  for i in range (0, a_part:SYMMETRYCOUNT) {
    print "      [" + i + "] " + a_part:SYMMETRYPARTNER(i).
  }
}

Part:PARTSNAMED(name)¶

Parameters

name – (String) Name of the parts

Returns

List of Part objects

Same as Vessel:PARTSNAMED(name) except that this version doesn’t search the entire vessel tree and instead it only searches the branch of the vessel’s part tree from the current part down through its children and its children’s children and so on.

Part:PARTSNAMEDPATTERN(namePattern)¶

Parameters

namePattern – (String) Pattern of the name of the parts

Returns

List of Part objects

Same as Vessel:PARTSNAMEDPATTERN(namePattern) except that this version doesn’t search the entire vessel tree and instead it only searches the branch of the vessel’s part tree from the current part down through its children and its children’s children and so on.

Part:PARTSTITLED(title)¶

Parameters

title – (String) Title of the parts

Returns

List of Part objects

Same as Vessel:PARTSTITLED(title) except that this version doesn’t search the entire vessel tree and instead it only searches the branch of the vessel’s part tree from the current part down through its children and its children’s children and so on.

Part:PARTSTITLEDPATTERN(titlePattern)¶

Parameters

titlePattern – (String) Patern of the title of the parts

Returns

List of Part objects

Same as Vessel:PARTSTITLEDPATTERN(titlePattern) except that this version doesn’t search the entire vessel tree and instead it only searches the branch of the vessel’s part tree from the current part down through its children and its children’s children and so on.

Part:PARTSTAGGED(tag)¶

Parameters

tag – (String) Tag of the parts

Returns

List of Part objects

Same as Vessel:PARTSTAGGED(tag) except that this version doesn’t search the entire vessel tree and instead it only searches the branch of the vessel’s part tree from the current part down through its children and its children’s children and so on.

Part:PARTSTAGGEDPATTERN(tagPattern)¶

Parameters

tagPattern – (String) Pattern of the tag of the parts

Returns

List of Part objects

Same as Vessel:PARTSTAGGEDPATTERN(tagPattern) except that this version doesn’t search the entire vessel tree and instead it only searches the branch of the vessel’s part tree from the current part down through its children and its children’s children and so on.

Part:PARTSDUBBED(name)¶

Parameters

name – (String) name, title or tag of the parts

Returns

List of Part objects

Same as Vessel:PARTSDUBBED(name) except that this version doesn’t search the entire vessel tree and instead it only searches the branch of the vessel’s part tree from the current part down through its children and its children’s children and so on.

Part:PARTSDUBBEDPATTERN(namePattern)¶

Parameters

namePattern – (String) Pattern of the name, title or tag of the parts

Returns

List of Part objects

Same as Vessel:PARTSDUBBEDPATERN(namePattern) except that this version doesn’t search the entire vessel tree and instead it only searches the branch of the vessel’s part tree from the current part down through its children and its children’s children and so on.

Part:MODULESNAMED(name)¶

Parameters

name – (String) Name of the part modules

Returns

List of PartModule objects

Same as Vessel:MODULESNAMED(name) except that this version doesn’t search the entire vessel tree and instead it only searches the branch of the vessel’s part tree from the current part down through its children and its children’s children and so on.

Part:ALLTAGGEDPARTS()¶

Returns: List of Part objects

Same as Vessel:ALLTAGGEDPARTS() except that this version doesn’t search the entire vessel tree and instead it only searches the branch of the vessel’s part tree from the current part down through its children and its children’s children and so on.