KSP API
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
FuelTank Class Reference

The old, deprecated class that implemented fuel tanks before the resource system. Don't use this class: to allow a part to store a resource add a RESOURCE block to the part.cfg. More...

Inheritance diagram for FuelTank:
Part

Public Member Functions

 FuelTank ()
 
override bool DrainFuel (float amount)
 Deprecated. Use Part.TransferResource instead. More...
 
override bool FindFuel (Part source, List< Part > fuelSources, uint reqId)
 Obsolete - Use Part.GetConnectedResources instead. More...
 
override void OnDrawStats ()
 Obsolete("Functional behaviour should really be happening in PartModules now. In any case, this method's been replaced with OnGetStats, where you just return the string." More...
 
override void onFlightStateLoad (Dictionary< string, KSPParseable > parsedData)
 
override void onFlightStateSave (Dictionary< string, KSPParseable > partDataCollection)
 
override bool RequestFuel (Part source, float amount, uint reqId)
 Deprecated - Use Part.RequestResource instead. More...
 
- Public Member Functions inherited from Part
 Part ()
 
bool activate (int currentStage, Vessel activeVessel)
 
void AddAttachNode (ConfigNode node)
 
void addChild (Part child)
 
bool AddCrewmember (ProtoCrewMember crew)
 
bool AddCrewmemberAt (ProtoCrewMember crew, int seatIndex)
 
void AddExposedThermalFlux (double kilowatts)
 
InternalModel AddInternalPart (ConfigNode node)
 
PartModule AddModule (ConfigNode node)
 
PartModule AddModule (string moduleName)
 Add a PartModule to this part. PartModules that are dynamically added to parts and don't exist in the original part.cfg will not be properly restored from persistence. More...
 
void AddOnMouseDown (Part.OnActionDelegate method)
 
void AddOnMouseEnter (Part.OnActionDelegate method)
 
void AddOnMouseExit (Part.OnActionDelegate method)
 
PartResource AddResource (ConfigNode node)
 
Callback< IAirstreamShield > AddShield (IAirstreamShield shd)
 
void AddSkinThermalFlux (double kilowatts)
 
void AddThermalFlux (double kilowatts)
 
bool AlreadyProcessedRequest (int requestID)
 
bool CheckCollision (Collision c)
 
bool checkLanded ()
 
bool checkSplashed ()
 
void cleanReferencesFromOtherParts ()
 
void Couple (Part tgtPart)
 
void CreateInternalModel ()
 
void deactivate ()
 
void decouple (float breakForce=0f)
 
void DespawnAllCrew ()
 
void Die ()
 
void disconnect (bool controlledSeparation=false)
 
string drawStats ()
 
void Effect (string effectName)
 
void Effect (string effectName, float effectPower)
 
void explode ()
 Calling this causes the part to explode. But you guessed that, didn't you? More...
 
AttachNode findAttachNode (string nodeId)
 Find an AttachNode by its name, as a string. More...
 
AttachNode findAttachNodeByPart (Part connectedPart)
 Given a child part of this part, find the AttachNode representing the connection between this part and that child. More...
 
AttachNode[] findAttachNodes (string partialNodeId)
 
FindChildPart< T > ()
 
FindChildPart< T > (bool recursive)
 
Part FindChildPart (string childName)
 
Part FindChildPart (string childName, bool recursive)
 
T[] FindChildParts< T > ()
 
T[] FindChildParts< T > (bool recursive)
 
FXGroup findFxGroup (string groupID)
 
Animation FindModelAnimator (string animatorName, string clipName)
 
Animation[] FindModelAnimators ()
 
Animation[] FindModelAnimators (string clipName)
 
FindModelComponent< T > ()
 
FindModelComponent< T > (string childName)
 
T[] FindModelComponents< T > ()
 
T[] FindModelComponents< T > (string childName)
 
Transform FindModelTransform (string childName)
 
Transform[] FindModelTransforms (string childName)
 
FindModuleImplementing< T > ()
 
List< T > FindModulesImplementing< T > ()
 
void FindNonPhysicslessChildren (List< Part > parts)
 
Part FindNonPhysicslessParent ()
 
AttachNode FindPartThroughNodes (Part tgtPart, Part src=null)
 
bool FindResource_StackPriority (Part origin, List< PartResource > sources, int resourceID, double demand, int requestID, bool getAll, ref double total, ref double totalMax, List< Part > partList, bool checkSurf)
 
void force_activate ()
 Activates the part now, regardless of when it was scheduled to be activated in the staging order. More...
 
void freeze ()
 
void GetConnectedResources (int resourceID, ResourceFlowMode flowMode, List< PartResource > Resources)
 
void GetConnectedResources (int resourceID, ResourceFlowMode flowMode, List< PartResource > Resources, out double amount, out double maxAmount)
 
float GetModuleCosts (float defaultCost)
 
float GetModuleMass (float defaultMass)
 
Vector3 GetModuleSize (Vector3 defaultSize)
 
float GetPhysicslessChildMass ()
 
Transform GetReferenceTransform ()
 
float GetResourceMass ()
 The total mass of the resources held by the part. The total mass of the part is More...
 
float GetResourceMass (out double thermalMass)
 
float GetResourceMass (out float thermalMass)
 
Part getSymmetryCounterPart (int index)
 
void HandleCollision (Collision c)
 
bool hasIndirectChild (Part tgtPart)
 
bool hasIndirectParent (Part tgtPart)
 
void InitializeEffects ()
 
void InitializeModules ()
 
bool isSymmetryCounterPart (Part cPart)
 
virtual void LateUpdate ()
 
void LoadEffects (ConfigNode node)
 
PartModule LoadModule (ConfigNode node, ref int moduleIndex)
 
void onAttach (Part parent, bool first=true)
 
virtual void onBackup ()
 
void OnCollisionEnter (Collision c)
 
void OnCollisionExit (Collision c)
 
void OnCollisionStay (Collision c)
 
void OnCopy (Part original, bool asSymCounterpart)
 
void OnDelete ()
 
void onDetach (bool first=true)
 
virtual string OnGetStats ()
 
void OnLiftOff ()
 
void OnLoad ()
 
virtual void OnLoad (ConfigNode node)
 
void OnPartJointBreak (float breakForce)
 
virtual void OnSave (ConfigNode node)
 
void OnSplashDown ()
 
void OnTouchDown ()
 
void Pack ()
 
void PromoteToPhysicalPart ()
 
void propagateControlUpdate (FlightCtrlState st)
 
void RegisterCrew ()
 
void removeChild (Part child)
 
void RemoveCrewmember (ProtoCrewMember crew)
 
void RemoveModule (PartModule module)
 
void RemoveModules ()
 
void RemoveOnMouseDown (Part.OnActionDelegate method)
 
void RemoveOnMouseEnter (Part.OnActionDelegate method)
 
void RemoveOnMouseExit (Part.OnActionDelegate method)
 
void RemoveShield (IAirstreamShield shd)
 
virtual bool RequestRCS (float amount, int earliestStage)
 Deprecated - Use Part.RequestResource instead. More...
 
virtual double RequestResource (int resourceID, double demand)
 
virtual float RequestResource (int resourceID, float demand)
 
virtual double RequestResource (string resourceName, double demand)
 
virtual float RequestResource (string resourceName, float demand)
 
virtual double RequestResource (int resourceID, double demand, ResourceFlowMode flowMode)
 
virtual double RequestResource (string resourceName, double demand, ResourceFlowMode flowMode)
 
void ResetCollisionIgnores ()
 
IEnumerator ResetJoints ()
 
void ResumeVelocity ()
 
void SaveEffects (ConfigNode node)
 
void ScheduleSetCollisionIgnores ()
 
void SendEvent (string eventName)
 
void SendEvent (string eventName, BaseEventData data)
 
void SendEvent (string eventName, BaseEventData data, int maxDepth)
 
void SetCollisionIgnores ()
 
void SetDetectCollisions (bool setState)
 
void SetHierarchyRoot (Part root)
 
void SetHighlight (bool active, bool recursive)
 
void SetHighlightColor ()
 
void SetHighlightColor (Color color)
 
void SetHighlightDefault ()
 
void SetHighlightType (Part.HighlightType type)
 
void SetMirror (Vector3 mirrorVector)
 
void setOpacity (float opacity)
 
void setParent (Part p=null)
 
void SetReferenceTransform (Transform t)
 
void SetResource (ConfigNode node)
 
void SpawnCrew ()
 
virtual double TransferResource (int resourceID, double amount)
 
virtual double TransferResource (PartResource resource, double amount)
 
void Undock (DockedVesselInfo newVesselInfo)
 
void unfreeze ()
 
void Unpack ()
 
void UnregisterCrew ()
 
void UpdateOrgPosAndRot (Part newRoot)
 
void UpdateStageability (bool master=true, bool iconUpdate=true)
 
delegate void OnActionDelegate (Part p)
 

Public Attributes

bool allowFlow
 
float drainRate
 
float dryMass
 
float emptyExplosionPotential
 
float fuel
 
float fullExplosionPotential
 
- Public Attributes inherited from Part
bool ActivatesEvenIfDisconnected
 Whether this part will actually activate if it schedule to be activated in the same stage as it is decoupled from the rocket. In particular, sepratrons must have ActivatesEvenIfDisconnected set to true if they are to function properly. More...
 
double aerodynamicArea
 
Transform airlock
 
List< IAirstreamShield > airstreamShields
 
double analyticInternalInsulationFactor
 
double analyticSkinInsulationFactor
 
float angularDrag
 
bool angularDragByFI
 
double atmDensity
 
bool attached
 
PartJoint attachJoint
 
AttachNodeMethod attachMethod
 
AttachModes attachMode
 Whether this part is attached to its parent via a stack AttachNode or a surface AttachNode. More...
 
List< AttachNodeattachNodes
 An AttachNode represents the link between two attached parts. attachNodes is a list of possible nodes to which other parts can be attached to this part. You can find the parts that actually are attached using AttachNode.attachedPart. More...
 
AttachRules attachRules
 
Vector3 attPos
 
Vector3 attPos0
 
Quaternion attRotation
 
Quaternion attRotation0
 
Vector3 bodyLiftLocalPosition
 
Vector3 bodyLiftLocalVector
 
float bodyLiftMultiplier
 
float bodyLiftScalar
 
float breakingForce
 
float breakingTorque
 
float buoyancy
 
string buoyancyUseCubeNamed
 
bool buoyancyUseSine
 
Vector3 CenterOfBuoyancy
 
Vector3 CenterOfDisplacement
 
List< Partchildren
 The parts that are children of this part in the part tree (parts that were attached to this part in the editor after this part was already part of the vessel). More...
 
int childStageOffset
 
Collider collider
 
CollisionEnhancer collisionEnhancer
 
Vector3 CoLOffset
 
Vector3 CoMOffset
 
Vector3 CoPOffset
 
uint craftID
 
float crashTolerance
 
int CrewCapacity
 How many crew members this part can fit. More...
 
bool crewTransferAvailable
 
List< Collider > currentCollisions
 
string customPartData
 
int defaultInverseStage
 
double depth
 
Part.DragModel dragModel
 Unused? More...
 
Vector3 dragReferenceVector
 
float dragScalar
 
Vector3 dragVector
 
Vector3 dragVectorDir
 
Vector3 dragVectorDirLocal
 
float dragVectorMag
 
float dragVectorSqrMag
 
double dynamicPressurekPa
 
float edgeHighlightThresholdMult
 
Part editorCollision
 
List< ParteditorLinks
 
double emissiveConstant
 
float explosionPotential
 
double exposedArea
 
string flagURL
 
uint flightID
 A unique identifider for this part. Note that despite the name, each part on the same vessel will still have a different value in this field. This value is persistent and not affected by game load or docking/undocking or similar. This is the 'uid' value at the PART level of the persistent.sfs file. More...
 
bool frozen
 
bool fuelCrossFeed
 Whether this part allows fuel crossfeed. More...
 
List< PartfuelLookupTargets
 In the flight scene, fuelLookupTargets is the list of fuel lines through which this part can draw fuel. Also if this part is a docking node docked to a another docking node through which it can draw fuel, then the attached docking node will also be in fuelLookupTargets. More...
 
List< FXGroup > fxGroups
 
float gaugeThresholdMult
 
bool GroundContact
 
bool hasHeiarchyModel
 
bool hasLiftModule
 
float hatchObstructionCheckInwardDistance
 
float hatchObstructionCheckInwardOffset
 
float hatchObstructionCheckOutwardDistance
 
float hatchObstructionCheckSphereRadius
 
double heatConductivity
 
double heatConvectiveConstant
 
Color highlightColor
 
HighlightingSystem.Highlighter highlighter
 
Part.HighlightType highlightType
 
string initialVesselName
 
int inStageIndex
 
InternalModel internalModel
 
string InternalModelName
 
int inverseStage
 The stage in which this part will activate, as shown in the staging display. (Possibly called inverseStage because the stages in KSP count down instead of up). More...
 
bool isClone
 
bool isControlSource
 
bool isMirrored
 
bool isPersistent
 
uint lastFuelRequestId
 
uint launchID
 
double machNumber
 
int manualStageOffset
 
float mass
 The DRY mass of this part, not including the mass of any resources it contains More...
 
double maxDepth
 
float maximum_drag
 The drag coefficient of this part is equal to (total mass) * (maximum_drag) More...
 
double maxTemp
 The temperature at which this part will explode. More...
 
double minDepth
 
float minimum_drag
 Unused. More...
 
Vector3 mirrorAxis
 
Vector3 mirrorRefAxis
 
Vector3 mirrorVector
 
uint missionID
 A unique identifier assigned to the part when the vessel it is a part of is created. All parts on the vessel get the same missionID and it does not change. Splitting a vessel with a decoupler will result with two vessels whose parts have the same missionID. When two vessels spawned seperately dock, each part keeps its original missionID, undocking does not change this field either. More...
 
bool noAutoEVA
 
string NoCrossFeedNodeKey
 Specifies the name of a node through which this part will NOT draw resources. See the part.cfg of the stock tricoupler for an example of using this to prevent fuel from flowing backwards. More...
 
Callback OnEditorAttach
 Add a function to this callback and it will be called when your part is attached to another part in the editor. More...
 
Callback OnEditorDestroy
 Add a function to this callback and it will be called when your part is deleted in the editor. More...
 
Callback OnEditorDetach
 Add a function to this callback and it will be called when your part is detached, or is part of a set of parts that are detached, in the editor. More...
 
Callback OnJustAboutToBeDestroyed
 Add a function to this callback and it will be called when your part is about to be destroyed during flight. More...
 
Vector3 orgPos
 
Quaternion orgRot
 
int originalStage
 
bool packed
 
Part parent
 The parent of this part in the part tree: the part to which this part was attached in the editor. More...
 
PartBuoyancy partBuoyancy
 
AvailablePart partInfo
 Some of the part info that is displayed about this part in the editor. More...
 
string partName
 
Transform partTransform
 
bool PermanentGroundContact
 
Part.PhysicalSignificance physicalSignificance
 If physicalSignificance == Part.PhysicalSignificance.NONE, then this part doesn't actually have any physics. In particular, it has no mass, regardless of what its "mass" field is set to, and no drag. More...
 
int PhysicsSignificance
 Unused? More...
 
Part potentialParent
 
List< ProtoCrewMemberprotoModuleCrew
 
ProtoPartSnapshot protoPartSnapshot
 
double radiativeArea
 
double radiatorCritical
 
double radiatorHeadroom
 
double radiatorMax
 
Rigidbody rb
 
float rescaleFactor
 
double resourceRequestRemainingThreshold
 
double resourceThermalMass
 
PartStates ResumeState
 
float scaleFactor
 
int separationIndex
 
double skinExposedArea
 
double skinExposedAreaFrac
 
double skinExposedMassMult
 
double skinInternalConductionMult
 
double skinMassPerArea
 
double skinMaxTemp
 
double skinSkinConductionMult
 
double skinTemperature
 
double skinThermalMass
 
double skinThermalMassModifier
 
double skinThermalMassRecip
 
double skinToInternalFlux
 
double skinUnexposedMassMult
 
double skinUnexposedTemperature
 
AttachNode srfAttachNode
 IF this part is surface-attached to its parent, srfAttachNode is the attach node describing this connection. More...
 
VStackIcon stackIcon
 The sicon shown for this part in the staging display. More...
 
StackIconGrouping stackIconGrouping
 
double stackPriThreshold
 
int stackSymmetry
 
bool stageAfter
 
bool stageBefore
 
int stageOffset
 
string stagingIcon
 
bool stagingIconAlwaysShown
 
bool stagingOn
 
bool started
 
double staticPressureAtm
 
double submergedDragScalar
 
double submergedDynamicPressurekPa
 
double submergedLiftScalar
 
double submergedPortion
 
Vector3 surfaceAreas
 
SymmetryMethod symMethod
 
List< PartsymmetryCounterparts
 
double temperature
 The temperature of this part, in some arbitrary units. More...
 
PQS_PartCollider terrainCollider
 
double thermalConductionFlux
 
double thermalConvectionFlux
 
double thermalExposedFlux
 
double thermalExposedFluxPrevious
 
double thermalInternalFlux
 
double thermalInternalFluxPrevious
 
double thermalMass
 
double thermalMassModifier
 
double thermalMassReciprocal
 
double thermalRadiationFlux
 
double thermalSkinFlux
 
double thermalSkinFluxPrevious
 
AttachNode topNode
 
Vector3 vel
 
Vessel vessel
 The vessel to which this part belongs. Beware that vessel == null in the editor. More...
 
VesselType vesselType
 
float waterAngularDragMultiplier
 
bool WaterContact
 

Protected Member Functions

override void onDecouple (float breakForce)
 
override void onFlightStart ()
 
override bool onPartActivate ()
 
override void onPartAwake ()
 
override void onPartFixedUpdate ()
 
override void onPartStart ()
 
- Protected Member Functions inherited from Part
virtual void onActiveFixedUpdate ()
 
virtual void onActiveUpdate ()
 
virtual void onCopy (Part original, bool asSymCounterpart)
 
virtual void onCtrlUpd (FlightCtrlState s)
 
virtual void onDisconnect ()
 
virtual void onEditorUpdate ()
 
virtual void onFlightStartAtLaunchPad ()
 
virtual void onGamePause ()
 
virtual void onGameResume ()
 
virtual void onJointDisable ()
 
virtual void onJointReset ()
 
virtual void onPack ()
 
virtual void onPartAttach (Part parent)
 
virtual void onPartDeactivate ()
 
virtual void onPartDelete ()
 
virtual void onPartDestroy ()
 
virtual void onPartDetach ()
 
virtual void onPartExplode ()
 
virtual void onPartLiftOff ()
 
virtual void onPartLoad ()
 
virtual void onPartSplashdown ()
 
virtual void onPartTouchdown ()
 
virtual void onPartUpdate ()
 
virtual void onStartComplete ()
 
virtual void onUnpack ()
 
void SetLayer (GameObject obj, int layer)
 

Additional Inherited Members

- Public Types inherited from Part
enum  DragModel {
  DragModel.DEFAULT = 0, DragModel.CONIC = 1, DragModel.CYLINDRICAL = 2, DragModel.SPHERICAL = 3,
  DragModel.CUBE = 4, DragModel.NONE = 5
}
 
enum  HighlightType { HighlightType.Disabled = 0, HighlightType.OnMouseOver = 1, HighlightType.AlwaysOn = 2 }
 
enum  PhysicalSignificance { PhysicalSignificance.FULL = 0, PhysicalSignificance.NONE = 1 }
 Represents whether a part has physics. More...
 
- Static Public Member Functions inherited from Part
static operator Part (GameObject o)
 
static Part FromGO (GameObject obj)
 
static T GetComponentUpwards< T > (GameObject obj)
 
static Component GetComponentUpwards (string type, GameObject obj)
 
static uint getFuelReqId ()
 
static void GetPartsOutTo (Part part, HashSet< Part > parts, int maxLinks)
 
static int NewRequestID ()
 
static Vector3 PartToVesselSpaceDir (Vector3 dir, Part p, Vessel v, PartSpaceMode space)
 
static Vector3 PartToVesselSpacePos (Vector3 pos, Part p, Vessel v, PartSpaceMode space)
 
static Quaternion PartToVesselSpaceRot (Quaternion rot, Part p, Vessel v, PartSpaceMode space)
 
static Vector3 VesselToPartSpaceDir (Vector3 dir, Part p, Vessel v, PartSpaceMode space)
 
static Vector3 VesselToPartSpacePos (Vector3 pos, Part p, Vessel v, PartSpaceMode space)
 
static Quaternion VesselToPartSpaceRot (Quaternion rot, Part p, Vessel v, PartSpaceMode space)
 
- Static Public Attributes inherited from Part
static Color defaultHighlightNone
 
static Color defaultHighlightPart
 
static uint fuelRequestID
 
- Protected Attributes inherited from Part
bool connected
 
List< PartresourceTargets
 
PartStates state
 
- Properties inherited from Part
BaseActionList Actions [get]
 
int ClassID [get]
 
string ClassName [get]
 
DragCubeList DragCubes [get]
 
EffectList Effects [get]
 
BaseEventList Events [get]
 
BaseFieldList Fields [get]
 
bool hasStagingIcon [get]
 
bool isAttached [get, set]
 
bool isConnected [get, set]
 Obsolete since 0.14 and no longer working More...
 
bool isControllable [get]
 
bool Landed [get]
 
Part localRoot [get]
 
PartModuleList Modules [get]
 
Orbit orbit [get]
 Don't use this; use Vessel.orbit instead. More...
 
PartValues PartValues [get]
 
PartResourceList Resources [get]
 A list of the resources contained by this part. You can loop over them with More...
 
Rigidbody Rigidbody [get]
 The rigidbody of this part. See the Unity documentation on rigidbodies for more information. More...
 
bool ShieldedFromAirstream [get, set]
 
bool Splashed [get]
 
PartStates State [get]
 
Vector3 WCoM [get]
 

Detailed Description

The old, deprecated class that implemented fuel tanks before the resource system. Don't use this class: to allow a part to store a resource add a RESOURCE block to the part.cfg.

Constructor & Destructor Documentation

FuelTank.FuelTank ( )

Member Function Documentation

override bool FuelTank.DrainFuel ( float  amount)
virtual

Deprecated. Use Part.TransferResource instead.

Parameters
amount
Returns

Reimplemented from Part.

override bool FuelTank.FindFuel ( Part  source,
List< Part fuelSources,
uint  reqId 
)
virtual

Obsolete - Use Part.GetConnectedResources instead.

Reimplemented from Part.

override void FuelTank.onDecouple ( float  breakForce)
protectedvirtual

Reimplemented from Part.

override void FuelTank.OnDrawStats ( )
virtual

Obsolete("Functional behaviour should really be happening in PartModules now. In any case, this method's been replaced with OnGetStats, where you just return the string."

Reimplemented from Part.

override void FuelTank.onFlightStart ( )
protectedvirtual

Reimplemented from Part.

override void FuelTank.onFlightStateLoad ( Dictionary< string, KSPParseable >  parsedData)
virtual

Reimplemented from Part.

override void FuelTank.onFlightStateSave ( Dictionary< string, KSPParseable >  partDataCollection)
virtual

Reimplemented from Part.

override bool FuelTank.onPartActivate ( )
protectedvirtual

Reimplemented from Part.

override void FuelTank.onPartAwake ( )
protectedvirtual

Reimplemented from Part.

override void FuelTank.onPartFixedUpdate ( )
protectedvirtual

Reimplemented from Part.

override void FuelTank.onPartStart ( )
protectedvirtual

Reimplemented from Part.

override bool FuelTank.RequestFuel ( Part  source,
float  amount,
uint  reqId 
)
virtual

Deprecated - Use Part.RequestResource instead.

Parameters
source
amount
reqId
Returns

Reimplemented from Part.

Member Data Documentation

bool FuelTank.allowFlow
float FuelTank.drainRate
float FuelTank.dryMass
float FuelTank.emptyExplosionPotential
float FuelTank.fuel
float FuelTank.fullExplosionPotential

The documentation for this class was generated from the following file: