Difference between revisions of "User:Glyph/sandbox"

From Kerbal Space Program Wiki
Jump to: navigation, search
Line 1: Line 1:
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
<!-- Class tables autogenerated by Glyph's kerbal_wiki_pdoc program for KSP 1.04. Using syntax set up for the wiki by N3X15, format from DOCTOOLS (I'm not clear if DOCTOOLS is the script used to generate N3X15's old version of these tables, or some mediawiki thing). -->
 +
{{Class
 +
  |inherits={{Type|MonoBehaviour}}
 +
  |implements=<ul><li>{{Type|IShipconstruct}}</li><li>{{Type|ITargetable}}</li><li>{{Type|IDiscoverable}}</li></ul>
 +
  |name=Vessel
 +
  |summary=Class attributes: [DefaultMember("Item")]
 +
}}
 +
 +
{{PropertiesStart}}
 +
{{Property
 +
  |type=ActionGroupList
 +
  |name=ActionGroups
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=VesselAutopilot
 +
  |name=Autopilot
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=Vector3
 +
  |name=CurrentCoM
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=DiscoveryInfo
 +
  |name=DiscoveryInfo
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=float
 +
  |name=distanceLandedPackThreshold
 +
  |desc=? Has attribute [Obsolete("Use Vessel.vesselRanges instead")]
 +
  |hasget=1
 +
  |hasset=1
 +
}}
 +
{{Property
 +
  |type=float
 +
  |name=distanceLandedUnpackThreshold
 +
  |desc=? Has attribute [Obsolete("Use Vessel.vesselRanges instead")]
 +
  |hasget=1
 +
  |hasset=1
 +
}}
 +
{{Property
 +
  |type=float
 +
  |name=distancePackThreshold
 +
  |desc=? Has attribute [Obsolete("Use Vessel.vesselRanges instead")]
 +
  |hasget=1
 +
  |hasset=1
 +
}}
 +
{{Property
 +
  |type=float
 +
  |name=distanceUnpackThreshold
 +
  |desc=? Has attribute [Obsolete("Use Vessel.vesselRanges instead")]
 +
  |hasget=1
 +
  |hasset=1
 +
}}
 +
{{Property
 +
  |type=bool
 +
  |name=HoldPhysics
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=bool
 +
  |name=isActiveVessel
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=bool
 +
  |name=isCommandable
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=bool
 +
  |name=IsControllable
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=bool
 +
  |name=isEVA
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=bool
 +
  |name=isPersistent
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=1
 +
}}
 +
{{Property
 +
  |type=bool
 +
  |name=IsRecoverable
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=bool
 +
  |name=LandedOrSplashed
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=CelestialBody
 +
  |name=mainBody
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=Orbit
 +
  |name=orbit
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=List&#x3008;Part&#x3009;
 +
  |name=Parts
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=bool
 +
  |name=PatchedConicsAttached
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=Transform
 +
  |name=ReferenceTransform
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=VesselValues
 +
  |name=VesselValues
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=static float
 +
  |name=loadDistance
 +
  |desc=? Has attribute [Obsolete("Use Vessel.vesselRanges instead")]
 +
  |hasget=1
 +
  |hasset=1
 +
}}
 +
{{Property
 +
  |type=static float
 +
  |name=unloadDistance
 +
  |desc=? Has attribute [Obsolete("Use Vessel.vesselRanges instead")]
 +
  |hasget=1
 +
  |hasset=1
 +
}}
 +
{{PropertiesEnd}}
 +
 +
{{FieldsStart}}
 +
{{Field
 +
  |type=Vector3d
 +
  |name=acceleration
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=altitude
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=Vector3
 +
  |name=angularMomentum
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=Vector3
 +
  |name=angularVelocity
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=atmDensity
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=atmosphericTemperature
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=Vector3d
 +
  |name=CentrifugalAcc
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=Vector3
 +
  |name=CoM
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=convectiveCoefficient
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=convectiveMachFlux
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=Vector3d
 +
  |name=CoriolisAcc
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=FlightCtrlState
 +
  |name=ctrlState
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=int
 +
  |name=currentStage
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=bool
 +
  |name=directSunlight
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=distanceToSun
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=dynamicPressurekPa
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=KerbalEVA
 +
  |name=evaController
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=externalTemperature
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=ConfigNode
 +
  |name=flightPlanNode
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=geeForce
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=geeForce_immediate
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=Vector3d
 +
  |name=gForce
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=bool
 +
  |name=handlePhysicsStats
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=float
 +
  |name=heightFromSurface
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=float
 +
  |name=heightFromTerrain
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=horizontalSrfSpeed
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=Guid
 +
  |name=id
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=indicatedAirSpeed
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=bool
 +
  |name=Landed
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=string
 +
  |name=landedAt
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=latitude
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=launchTime
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=bool
 +
  |name=loaded
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=Vector3
 +
  |name=localCoM
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=longitude
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=mach
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=missionTime
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=Vector3
 +
  |name=MOI
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=obt_speed
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=Vector3d
 +
  |name=obt_velocity
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=FlightInputCallback
 +
  |name=OnAutopilotUpdate
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=FlightInputCallback
 +
  |name=OnFlyByWire
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=Callback
 +
  |name=OnJustAboutToBeDestroyed
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=FlightInputCallback
 +
  |name=OnPostAutopilotUpdate
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=FlightInputCallback
 +
  |name=OnPreAutopilotUpdate
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=OrbitDriver
 +
  |name=orbitDriver
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=OrbitRenderer
 +
  |name=orbitRenderer
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=OrbitTargeter
 +
  |name=orbitTargeter
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=bool
 +
  |name=packed
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=List&#x3008;Part&#x3009;
 +
  |name=parts
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=PatchedConicRenderer
 +
  |name=patchedConicRenderer
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=PatchedConicSolver
 +
  |name=patchedConicSolver
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=Vector3d
 +
  |name=perturbation
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=pqsAltitude
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=ProtoVessel
 +
  |name=protoVessel
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=Vector3
 +
  |name=rb_velocity
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=uint
 +
  |name=referenceTransformId
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=Part
 +
  |name=rootPart
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=Situations
 +
  |name=situation
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=solarFlux
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=specificAcceleration
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=speed
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=speedOfSound
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=bool
 +
  |name=Splashed
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=Vector3d
 +
  |name=srf_velocity
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=Quaternion
 +
  |name=srfRelRotation
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=srfSpeed
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=State
 +
  |name=state
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=staticPressurekPa
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=ITargetable
 +
  |name=targetObject
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=double
 +
  |name=terrainAltitude
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=Vector3
 
   |name=terrainNormal
 
   |name=terrainNormal
 
   |desc=?
 
   |desc=?

Revision as of 19:21, 12 October 2015






Vessel Class

Inherits Implements
MonoBehaviour
  • IShipconstruct
  • ITargetable
  • IDiscoverable

Class attributes: [DefaultMember("Item")]

Properties

The following are public properties available in Glyph/sandbox.

Signature Description
ActionGroupList ActionGroups { get; }  ?
VesselAutopilot Autopilot { get; }  ?
Vector3 CurrentCoM { get; }  ?
DiscoveryInfo DiscoveryInfo { get; }  ?
float distanceLandedPackThreshold { get; set; }  ? Has attribute [Obsolete("Use Vessel.vesselRanges instead")]
float distanceLandedUnpackThreshold { get; set; }  ? Has attribute [Obsolete("Use Vessel.vesselRanges instead")]
float distancePackThreshold { get; set; }  ? Has attribute [Obsolete("Use Vessel.vesselRanges instead")]
float distanceUnpackThreshold { get; set; }  ? Has attribute [Obsolete("Use Vessel.vesselRanges instead")]
bool HoldPhysics { get; }  ?
bool isActiveVessel { get; }  ?
bool isCommandable { get; }  ?
bool IsControllable { get; }  ?
bool isEVA { get; }  ?
bool isPersistent { get; set; }  ?
bool IsRecoverable { get; }  ?
bool LandedOrSplashed { get; }  ?
CelestialBody mainBody { get; }  ?
Orbit orbit { get; }  ?
List〈Part〉 Parts { get; }  ?
bool PatchedConicsAttached { get; }  ?
Transform ReferenceTransform { get; }  ?
VesselValues VesselValues { get; }  ?
static float loadDistance { get; set; }  ? Has attribute [Obsolete("Use Vessel.vesselRanges instead")]
static float unloadDistance { get; set; }  ? Has attribute [Obsolete("Use Vessel.vesselRanges instead")]

Fields

The following is a list of publically-accessible fields in Glyph/sandbox. This includes protected items, which can be accessed by subclasses.

Signature Description
Vector3d acceleration  ?
double altitude  ?
Vector3 angularMomentum  ?
Vector3 angularVelocity  ?
double atmDensity  ?
double atmosphericTemperature  ?
Vector3d CentrifugalAcc  ?
Vector3 CoM  ?
double convectiveCoefficient  ?
double convectiveMachFlux  ?
Vector3d CoriolisAcc  ?
FlightCtrlState ctrlState  ?
int currentStage  ?
bool directSunlight  ?
double distanceToSun  ?
double dynamicPressurekPa  ?
KerbalEVA evaController  ?
double externalTemperature  ?
ConfigNode flightPlanNode  ?
double geeForce  ?
double geeForce_immediate  ?
Vector3d gForce  ?
bool handlePhysicsStats  ?
float heightFromSurface  ?
float heightFromTerrain  ?
double horizontalSrfSpeed  ?
Guid id  ?
double indicatedAirSpeed  ?
bool Landed  ?
string landedAt  ?
double latitude  ?
double launchTime  ?
bool loaded  ?
Vector3 localCoM  ?
double longitude  ?
double mach  ?
double missionTime  ?
Vector3 MOI  ?
double obt_speed  ?
Vector3d obt_velocity  ?
FlightInputCallback OnAutopilotUpdate  ?
FlightInputCallback OnFlyByWire  ?
Callback OnJustAboutToBeDestroyed  ?
FlightInputCallback OnPostAutopilotUpdate  ?
FlightInputCallback OnPreAutopilotUpdate  ?
OrbitDriver orbitDriver  ?
OrbitRenderer orbitRenderer  ?
OrbitTargeter orbitTargeter  ?
bool packed  ?
List〈Part〉 parts  ?
PatchedConicRenderer patchedConicRenderer  ?
PatchedConicSolver patchedConicSolver  ?
Vector3d perturbation  ?
double pqsAltitude  ?
ProtoVessel protoVessel  ?
Vector3 rb_velocity  ?
uint referenceTransformId  ?
Part rootPart  ?
Situations situation  ?
double solarFlux  ?
double specificAcceleration  ?
double speed  ?
double speedOfSound  ?
bool Splashed  ?
Vector3d srf_velocity  ?
Quaternion srfRelRotation  ?
double srfSpeed  ?
State state  ?
double staticPressurekPa  ?
ITargetable targetObject  ?
double terrainAltitude  ?
Vector3 terrainNormal  ?
Vector3d upAxis  ?
double verticalSpeed  ?
string vesselName  ?
VesselRanges vesselRanges  ?
Transform vesselTransform  ?
VesselType vesselType  ?
enum Situations { LANDED, SPLASHED, PRELAUNCH, FLYING, SUB_ORBITAL, ORBITING, ESCAPING, DOCKED }
enum State { INACTIVE, ACTIVE, DEAD }

Methods

The following are methods included in Glyph/sandbox.

Signature Description
constructor Vessel()  ?
void AttachPatchedConicsSolver()  ?
ProtoVessel BackupVessel()  ?
void CalculatePhysicsStats()  ?
void ChangeWorldVelocity(Vector3d velOffset)  ?
bool checkLanded()  ?
bool checkSplashed()  ?
bool checkVisibility()  ?
void ClearStaging()  ?
bool ContainsCollider(Collider c)  ?
void DespawnCrew()  ?
void DestroyVesselComponents()  ?
void DetachPatchedConicsSolver()  ?
void Die()  ?
void FallBackReferenceTransform()  ?
void FeedInputFeed()  ?
VesselType FindDefaultVesselType()  ?
Vector3 findLocalCenterOfMass()  ?
Vector3 findLocalCenterOfPressure()  ?
Vector3 findLocalMOI()  ?
Vector3 findLocalMOI(Vector3 worldCoM)  ?
List〈T〉 FindPartModulesImplementing〈T〉()  ?
Vector3 findWorldCenterOfMass()  ?
List〈Part〉 GetActiveParts()  ?
ActiveResource GetActiveResource(PartResourceDefinition def)  ?
List〈ActiveResource〉 GetActiveResources()  ?
int GetCrewCapacity()  ?
int GetCrewCount()  ?
Vector3 GetFwdVector()  ?
float GetHeightFromSurface()  ?
float GetHeightFromTerrain()  ?
string GetName()  ?
Vector3 GetObtVelocity()  ?
Orbit GetOrbit()  ?
OrbitDriver GetOrbitDriver()  ?
Part GetReferenceTransformPart()  ?
Vector3 GetSrfVelocity()  ?
VesselTargetModes GetTargetingMode()  ?
float GetTotalMass()  ?
Transform GetTransform()  ?
Vessel GetVessel()  ?
List〈ProtoCrewMember〉 GetVesselCrew()  ?
Vector3d GetWorldPos3D()  ?
void GoOffRails()  ?
void GoOnRails()  ?
bool HasControlSources()  ?
bool Initialize(bool fromShipAssembly)  ?
ClearToSaveStatus IsClearToSave()  ?
void Load()  ? Has attribute [ContextMenu("Load")]
void MakeActive()  ?
void MakeInactive()  ?
void MurderCrew()  ?
void OnDestroy()  ?
void OnLoadFlightState(Dictionary〈string, KSPParseable〉 dataPool)  ?
void OnSaveFlightState(Dictionary〈string, KSPParseable〉 dataPool)  ?
double PQSAltitude()  ?
void printCollisions()  ? Has attribute [ContextMenu("Print All Collisions")]
void printGroundContacts()  ? Has attribute [ContextMenu("Print Ground Contacts")]
void RenameVessel()  ? Has attribute [ContextMenu("Rename Vessel")]
void ResetCollisionIgnores()  ? Has attribute [ContextMenu("Reset Collision Ignores")]
void ResumeStaging()  ?
void ResumeTarget()  ?
double RevealAltitude()  ?
float RevealMass()  ?
string RevealName()  ?
string RevealSituationString()  ?
double RevealSpeed()  ?
string RevealType()  ?
void SetActiveInternalPart()  ?
void SetActiveInternalPart(List〈Part〉 visibleParts)  ?
void SetActiveInternalPart(Part visiblePart)  ?
void SetPosition(Vector3 position)  ?
void SetPosition(Vector3 position,bool usePristineCoords)  ?
void SetReferenceTransform(Part p)  ?
void SetRotation(Quaternion rotation)  ?
void SetWorldVelocity(Vector3d vel)  ?
void SpawnCrew()  ?
void StartFromBackup(ProtoVessel pv)  ?
void Translate(Vector3 offset)  ?
void Unload()  ? Has attribute [ContextMenu("Unload")]
static string AutoRename(Vessel v,string baseName)  ?
static string GetLandedAtString(string landedAt)  ?
static string GetMETString(Vessel v)  ?
static string GetSituationString(Vessel v)  ?
static bool IsValidVesselName(string name)  ?