Difference between revisions of "API:List of Part Modules"

From Kerbal Space Program Wiki
Jump to: navigation, search
(Created list of PartModules using Visual Studio's autocomplete menu. To do: Add explanations for each item. In future this should likely be broken up into pages for each module.)
 
(Added more info.)
Line 10: Line 10:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
The following is a list of the part modules in KSP as of 1.0.5.
+
The following is an incomplete list of the part modules in KSP as of version 1.0.5.
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
 
! Module name !! Notes
 
! Module name !! Notes
 +
|-
 +
| FXModuleAnimateThrottle || Varies the state of an animation based on the current throttle setting. Most commonly used to make rocket engines glow orange when they're running.
 +
|-
 +
| FXModuleConstrainPosition || Used to automatically position, rotate or constrain movement of a [[http://docs.unity3d.com/ScriptReference/Transform.html|transform]] relative to another. For example, rotating mounting struts to stay attached to a gimballing engine, or keeping wheel suspension attached to the wheel as it bounces.
 
|-
 
|-
 
| ModuleAblator || Used for heat shields to provide thermal protection during re-entry. The module consumes the [[resource]] named in ablativeResource as it does this (normally [[Ablator]], defined outside the part module). The part's colour is also darkened as ablataiveResource is depleted.
 
| ModuleAblator || Used for heat shields to provide thermal protection during re-entry. The module consumes the [[resource]] named in ablativeResource as it does this (normally [[Ablator]], defined outside the part module). The part's colour is also darkened as ablataiveResource is depleted.
Line 20: Line 24:
 
| ModuleActiveRadiator || Used for radiators to remove heat from the craft at the cost of a named [[resource]], normally [[Electric_charge|ElectricCharge]].
 
| ModuleActiveRadiator || Used for radiators to remove heat from the craft at the cost of a named [[resource]], normally [[Electric_charge|ElectricCharge]].
 
|-
 
|-
−
| ModuleAdvancedLandingGear || ??
+
| ModuleAdvancedLandingGear || Unknown. Currently unused.
 
|-
 
|-
−
| ModuleAerodynamicLift || ??
+
| ModuleAerodynamicLift || Unknown. Currently unused.
 
|-
 
|-
−
| ModuleAeroSurface || ??
+
| ModuleAeroSurface || Allows toggling to a high-drag mode while activating an animation. Currently used only for the [[A.I.R.B.R.A.K.E.S|airbrake]] part.
 
|-
 
|-
−
| ModuleAlternator || ??
+
| ModuleAlternator || Generates the specified [[resource]], normally [[Electric_charge|ElectricCharge]], at a rate dependent on the thrust of an engine module within the same part.
 
|-
 
|-
−
| ModuleAnalysisResource || ??
+
| ModuleAnalysisResource || Used in the [[Surface_Scanning_Module|Surface Scanning Module]] part to provide right-click abundance percentage for the given resourceName, [[Ore]].
 
|-
 
|-
−
| ModuleAnchoredDecoupler || ??
+
| ModuleAnchoredDecoupler || Used in radial decouplers to detach the part.
 
|-
 
|-
−
| ModuleAnimateGeneric || ??
+
| ModuleAnimateGeneric || Used to toggle animations via right-click menu or action group, for example toggling cockpit lights, engaging thrust reversers, or opening and closing cargo bay doors.
 
|-
 
|-
−
| ModuleAnimateHeat || ??
+
| ModuleAnimateHeat || Varies the state of an animation based on the part's heat. Used to provide the orange glow on intakes and nose cones as they heat up.
 
|-
 
|-
−
| ModuleAnimationGroup || ??
+
| ModuleAnimationGroup || Used to play "deploy" and looped "running" animations for parts such as the [[Convert-O-Tron 250]] and the [['Drill-O-Matic' Mining Excavator]]
 
|-
 
|-
 
| ModuleAnimatorLandingGear || ??
 
| ModuleAnimatorLandingGear || ??
Line 78: Line 82:
 
| ModuleEffectTest || ??
 
| ModuleEffectTest || ??
 
|-
 
|-
−
| ModuleEngines || ??
+
| ModuleEngines || This part module has been made obsolete by ModuleEnginesFX. It provides thrust in exchange for a propellant resource.
 
|-
 
|-
−
| ModuleEnginesFX || ??
+
| ModuleEnginesFX || An upgraded version of ModuleEngines which provides support for EFFECTS nodes (particle and sound effects).
 
|-
 
|-
−
| ModuleEnviroSensor || ??
+
| ModuleEnviroSensor || Provides data in the part's right-click menu in exchange for [[Electric_charge||ElectricCharge]]. The data displayed is determined by sensorType, which can be TEMP (temperature), GRAV (gravity), ACC (accelleration), or PRES (pressure).
 
|-
 
|-
 
| ModuleFuelJettison || ??
 
| ModuleFuelJettison || ??

Revision as of 12:32, 25 March 2016

Behaviour is added to parts in KSP using modular components called part modules. These are classes which derive from PartModule.

Part modules can be added to a part by editing that part's configuration file. For example, to add a part module called "ModuleName" to a part, the part's configuration file should be edited to include the following before the final closing '}' in the file: 

MODULE
{
	name = ModuleName
}

The following is an incomplete list of the part modules in KSP as of version 1.0.5.

Module name Notes
FXModuleAnimateThrottle Varies the state of an animation based on the current throttle setting. Most commonly used to make rocket engines glow orange when they're running.
FXModuleConstrainPosition Used to automatically position, rotate or constrain movement of a [[1]] relative to another. For example, rotating mounting struts to stay attached to a gimballing engine, or keeping wheel suspension attached to the wheel as it bounces.
ModuleAblator Used for heat shields to provide thermal protection during re-entry. The module consumes the resource named in ablativeResource as it does this (normally Ablator, defined outside the part module). The part's colour is also darkened as ablataiveResource is depleted.
ModuleActiveRadiator Used for radiators to remove heat from the craft at the cost of a named resource, normally ElectricCharge.
ModuleAdvancedLandingGear Unknown. Currently unused.
ModuleAerodynamicLift Unknown. Currently unused.
ModuleAeroSurface Allows toggling to a high-drag mode while activating an animation. Currently used only for the airbrake part.
ModuleAlternator Generates the specified resource, normally ElectricCharge, at a rate dependent on the thrust of an engine module within the same part.
ModuleAnalysisResource Used in the Surface Scanning Module part to provide right-click abundance percentage for the given resourceName, Ore.
ModuleAnchoredDecoupler Used in radial decouplers to detach the part.
ModuleAnimateGeneric Used to toggle animations via right-click menu or action group, for example toggling cockpit lights, engaging thrust reversers, or opening and closing cargo bay doors.
ModuleAnimateHeat Varies the state of an animation based on the part's heat. Used to provide the orange glow on intakes and nose cones as they heat up.
ModuleAnimationGroup Used to play "deploy" and looped "running" animations for parts such as the Convert-O-Tron 250 and the 'Drill-O-Matic' Mining Excavator
ModuleAnimatorLandingGear  ??
ModuleAsteroid  ??
ModuleAsteroidAnalysis  ??
ModuleAsteroidDrill  ??
ModuleAsteroidInfo  ??
ModuleAsteroidResource  ??
ModuleBiomeScanner  ??
ModuleCargoBay  ??
ModuleCommand  ??
ModuleConductionMultiplier  ??
ModuleControlSurface  ??
ModuleCoreHeat  ??
ModuleDataTransmitter  ??
ModuleDecouple  ??
ModuleDeployableRadiator  ??
ModuleDeployableSolarPanel  ??
ModuleDisplaceTweak  ??
ModuleDockingNode  ??
ModuleDragModifier  ??
ModuleEffectTest  ??
ModuleEngines This part module has been made obsolete by ModuleEnginesFX. It provides thrust in exchange for a propellant resource.
ModuleEnginesFX An upgraded version of ModuleEngines which provides support for EFFECTS nodes (particle and sound effects).
ModuleEnviroSensor Provides data in the part's right-click menu in exchange for [[Electric_charge ElectricCharge]]. The data displayed is determined by sensorType, which can be TEMP (temperature), GRAV (gravity), ACC (accelleration), or PRES (pressure).
ModuleFuelJettison  ??
ModuleGenerator  ??
ModuleGimbal  ??
ModuleGPS  ??
ModuleGrappleNode  ??
ModuleHandle  ??
ModuleHighDefCamera  ??
ModuleJettison  ??
ModuleJointMotor  ??
ModuleJointMotorTest  ??
ModuleJointPivot  ??
ModuleLandingGear  ??
ModuleLandingGearFixed  ??
ModuleLandingLeg  ??
ModuleLiftingSurface  ??
ModuleLight  ??
ModuleOrbitalScanner  ??
ModuleOrbitalSurveyor  ??
ModuleOverheadDisplay  ??
ModuleParachute  ??
ModulePhysicMaterial  ??
ModuleProceduralFairing  ??
ModuleRCS  ??
ModuleReactionWheel  ??
ModuleRemoteController  ??
ModuleResource  ??
ModuleResourceConverter  ??
ModuleResourceHarvester  ??
ModuleResourceIntake  ??
ModuleResourceScanner  ??
ModuleRotatingJoint  ??
ModuleSampleCollector  ??
ModuleSampleContainer  ??
ModuleSAS  ??
ModuleScienceContainer  ??
ModuleScienceConverter  ??
ModuleScienceExperiment  ??
ModuleScienceLab  ??
ModuleSeeThroughObject  ??
ModuleSteering  ??
ModuleSurfaceFX  ??
ModuleTestSubject  ??
ModuleToggleCrossfeed  ??
ModuleTripLogger  ??
ModuleWheel  ??
Retrieved from "https://wiki.kerbalspaceprogram.com/index.php?title=API:List_of_Part_Modules&oldid=72405"