|
|
| Line 1: |
Line 1: |
| − | test
| |
| − |
| |
| − | {{Class
| |
| − | |inherits={{Type|MonoBehaviour}}
| |
| − | |implements=<ul><li>{{Type|IDiscoverable}}</li><li>{{Type|IShipconstruct}}</li><li>{{Type|ITargetable}}</li></ul>
| |
| − | |name=Vessel
| |
| − | |summary=Vessels define individual ships in flight. They work essentially as a header for the set of parts that make up the ship.
| |
| − | }}
| |
| | {{PropertiesStart}} | | {{PropertiesStart}} |
| | {{Property | | {{Property |
| Line 15: |
Line 7: |
| | |hasset= | | |hasset= |
| | }} | | }} |
| − | {{Property
| |
| − | |type=Part
| |
| − | |name=this
| |
| − | |desc=
| |
| − | |hasget=1
| |
| − | |hasset=
| |
| − | }}
| |
| − | {{Property
| |
| − | |type=enum
| |
| − | |name=Situations
| |
| − | |desc=
| |
| − | |hasget=
| |
| − | |hasset=
| |
| − | }}
| |
| − | {{Property
| |
| − | |type=bool
| |
| − | |name=isCommandable
| |
| − | |desc=
| |
| − | |hasget=
| |
| − | |hasset=
| |
| − | }}
| |
| − | {{Property
| |
| − | |type=bool
| |
| − | |name=packed
| |
| − | |desc=
| |
| − | |hasget=
| |
| − | |hasset=
| |
| − | }}
| |
| − | {{Property
| |
| − | |type=bool
| |
| − | |name=LandedOrSplashed
| |
| − | |desc=
| |
| − | |hasget=1
| |
| − | |hasset=1
| |
| − | }}
| |
| − | {{Property
| |
| − | |type=ActionGroupList
| |
| − | |name=ActionGroups
| |
| − | |desc=
| |
| − | |hasget=
| |
| − | |hasset=
| |
| − | }}
| |
| − | {{Property
| |
| − | |type=Transform
| |
| − | |name=ReferenceTransform
| |
| − | |desc=The reference transform is used to define the orientation of a vessel for controls and gauges. It defines which way is 'up' or 'forward' or which way pitch rotates, for instance. Read only. Use SetReferenceTransform to set. Defaults to vessel transform if no other transform is set.
| |
| − | |hasget=1
| |
| − | |hasset=
| |
| − | }}
| |
| − | {{Property
| |
| − | |type=double
| |
| − | |name=launchTime
| |
| − | |desc=
| |
| − | |hasget=
| |
| − | |hasset=
| |
| − | }}
| |
| − | {{Property
| |
| − | |type=bool
| |
| − | |name=HoldPhysics
| |
| − | |desc=
| |
| − | |hasget=
| |
| − | |hasset=
| |
| − | }}
| |
| − | {{Property
| |
| − | |type=PatchedConicSolver
| |
| − | |name=patchedConicSolver
| |
| − | |desc=
| |
| − | |hasget=1
| |
| − | |hasset=
| |
| − | }}
| |
| − | {{Property
| |
| − | |type=Vessel.Situations
| |
| − | |name=situation
| |
| − | |desc=
| |
| − | |hasget=
| |
| − | |hasset=
| |
| − | }}
| |
| − | {{PropertiesEnd}}
| |
| − | {{FieldsStart}}
| |
| − | {{Field
| |
| − | |type=double
| |
| − | |name=verticalSpeed
| |
| − | |desc=The vertical speed of the vessel, relative to the surface of the reference body.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=Vector3
| |
| − | |name=rb_velocity
| |
| − | |desc=The current velocity of the Unity physics rigidbody.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=Quaternion
| |
| − | |name=srfRelRotation
| |
| − | |desc=The Quaternion corresponding to the vessel's rotation, relative to the surface of reference body.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=double
| |
| − | |name=staticPressure
| |
| − | |desc=The current static pressure of the vessel, presumably in newtons per meter squared.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=Vector3d
| |
| − | |name=acceleration
| |
| − | |desc=The current acceleration vector of the vessel.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=double
| |
| − | |name=geeForce
| |
| − | |desc=The current magnitude of gravity, in meters per second squared.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=int
| |
| − | |name=currentStage
| |
| − | |desc=Current stage of the vessel.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=ProtoVessel
| |
| − | |name=protoVessel
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=Vector3d
| |
| − | |name=obt_velocity
| |
| − | |desc=The orbital velocity vector of the vessel, relative to the reference body.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=Vector3d
| |
| − | |name=upAxis
| |
| − | |desc=Vector corresponding to the vessel's up facing direction.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=string
| |
| − | |name=vesselName
| |
| − | |desc=Name identifier of the vessel.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=double
| |
| − | |name=specificAcceleration
| |
| − | |desc=Specific acceleration is the vessel's potential acceleration per unit of throttle. Used to estimate burn times and such. NOTE: this value is calculated based on smoothed acceleration, so it isn't completely accurate. It will also change as the vessel's mass is reduced as fuel burns away. (it does get pretty accurate after burning for a few seconds)
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=float
| |
| − | |name=heightFromTerrain
| |
| − | |desc=The vessel's altitude above the reference body's terrain, not including liquid bodies.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=OrbitDriver
| |
| − | |name=orbitDriver
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=FlightIntegrator
| |
| − | |name=flightIntegrator
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=FlightCtrlState
| |
| − | |name=ctrlState
| |
| − | |desc=The vessel's flight control state object, used for accessing and modifying user and fly-by-wire input.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=Vector3
| |
| − | |name=terrainNormal
| |
| − | |desc=The vector perpendicular to the terrain.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=static
| |
| − | |name=float
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=double
| |
| − | |name=pqsAltitude
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=double
| |
| − | |name=terrainAltitude
| |
| − | |desc=The height of the terrain, relative to the center of the reference body.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=Vector3
| |
| − | |name=angularVelocity
| |
| − | |desc=The angular velocity vector of the vessel.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=PatchedConicRenderer
| |
| − | |name=patchedConicRenderer
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=CelestialBody
| |
| − | |name=mainBody
| |
| − | |desc=The reference body of the vessel.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=bool
| |
| − | |name=isPersistent
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=OrbitTargeter
| |
| − | |name=orbitTargeter
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=float
| |
| − | |name=heightFromSurface
| |
| − | |desc=The height above the surface of the reference body, including liquid bodies.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=bool
| |
| − | |name=Landed
| |
| − | |desc=True if the vessel has landed.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=bool
| |
| − | |name=isEVA
| |
| − | |desc=True if the vessel is an EVA kerbal.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=bool
| |
| − | |name=HasActiveCrew
| |
| − | |desc=True if the vessel has at least one crewmember and is active (focused).
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=Vector3d
| |
| − | |name=perturbation
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=double
| |
| − | |name=missionTime
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=Vector3
| |
| − | |name=CoM
| |
| − | |desc=The vector corresponding to the vessel's center of mass, relative to the vessel origin.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=double
| |
| − | |name=longitude
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=Part
| |
| − | |name=rootPart
| |
| − | |desc=The root part of the vessel.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=Orbit
| |
| − | |name=orbit
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=bool
| |
| − | |name=loaded
| |
| − | |desc=True if the vessel has loaded.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=uint
| |
| − | |name=referenceTransformId
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=double
| |
| − | |name=latitude
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=bool
| |
| − | |name=isActiveVessel
| |
| − | |desc=True if the vessel is the active vessel.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=double
| |
| − | |name=altitude
| |
| − | |desc=Height above the surface of the reference body, including liquid bodies.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=State
| |
| − | |name=state
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=enum
| |
| − | |name=State
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=Vector3
| |
| − | |name=localCoM
| |
| − | |desc=This is used for persistence purposes. Use findLocalCenterOfMass() if you just want the center of mass.
| |
| − | }}
| |
| − | {{Field
| |
| − | |type=Guid
| |
| − | |name=id
| |
| − | |desc=Unique identifier for each vessel.
| |
| − | }}
| |
| − | {{FieldsEnd}}
| |
| − | {{MethodsStart}}
| |
| − | {{StaticMethod
| |
| − | |returntype=string
| |
| − | |returndesc=
| |
| − | |name=GetMETString
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{StaticMethod
| |
| − | |returntype=string
| |
| − | |returndesc=
| |
| − | |name=GetSituationString
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=Vector3
| |
| − | |returndesc=
| |
| − | |name=findWorldCenterOfMass
| |
| − | |args=
| |
| − | |desc=Finds the world center of mass recursively from the given ship part.
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=bool
| |
| − | |returndesc=
| |
| − | |name=checkSplashed
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=GoOffRails
| |
| − | |args=
| |
| − | |desc=puts the ship back into a simulated orbit and reenables physics
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=OrbitDriver
| |
| − | |returndesc=
| |
| − | |name=GetOrbitDriver
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=Vector3
| |
| − | |returndesc=
| |
| − | |name=GetObtVelocity
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=FallBackReferenceTransform
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=ClearStaging
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=DestroyVesselComponents
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=ResetCollisionIgnores
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=Transform
| |
| − | |returndesc=
| |
| − | |name=GetTransform
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=ChangeWorldVelocity
| |
| − | |args=
| |
| − | |desc=change the worldspace velocity of this vessel
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=float
| |
| − | |returndesc=
| |
| − | |name=GetHeightFromTerrain
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=string
| |
| − | |returndesc=
| |
| − | |name=GetName
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=SpawnCrew
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=float
| |
| − | |returndesc=
| |
| − | |name=GetHeightFromSurface
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=ProtoVessel
| |
| − | |returndesc=
| |
| − | |name=BackupVessel
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=FeedInputFeed
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=Vector3
| |
| − | |returndesc=
| |
| − | |name=GetSrfVelocity
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=ResumeStaging
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=Orbit
| |
| − | |returndesc=
| |
| − | |name=GetOrbit
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=SetPosition
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=printGroundContacts
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=SetWorldVelocity
| |
| − | |args=
| |
| − | |desc=set the absolute world velocity of this vessel
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=SetRotation
| |
| − | |args=
| |
| − | |desc=Sets the worldspace rotation of this vessel, and all its parts
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=DespawnCrew
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=List<ProtoCrewMember>
| |
| − | |returndesc=
| |
| − | |name=GetVesselCrew
| |
| − | |args=
| |
| − | |desc= Returns a list of ProtoCrewMembers corresponding to each kerbal on board. ProtoCrewMember contains many fields relating to the kerbals stats such as name, courage, etc.
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=Vector3
| |
| − | |returndesc=
| |
| − | |name=findLocalCenterOfMass
| |
| − | |args=
| |
| − | |desc=Finds the local center of mass recursively from the given ship part.
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=OnLoadFlightState
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=int
| |
| − | |returndesc=
| |
| − | |name=GetCrewCount
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=OnDestroy
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=OnSaveFlightState
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=ClearToSaveStatus
| |
| − | |returndesc=
| |
| − | |name=IsClearToSave
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=Vector3
| |
| − | |returndesc=
| |
| − | |name=GetFwdVector
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=Translate
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=Vector3d
| |
| − | |returndesc=
| |
| − | |name=GetWorldPos3D
| |
| − | |args=
| |
| − | |desc=Get a double precision vector for the vessel's worldspace position (for when transform.position isn't accurate enough)
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=Vector3
| |
| − | |returndesc=
| |
| − | |name=findLocalCenterOfPressure
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=Unload
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=StartFromBackup
| |
| − | |args=
| |
| − | |desc=Start from backup is used when the scene is being resumed, and the Vessel component is added before the parts themselves. Note that this method won't load the parts. It only creates the vessel object. To load parts, use the Vessel.Load() method.
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=bool
| |
| − | |returndesc=
| |
| − | |name=checkVisibility
| |
| − | |args=
| |
| − | |desc=Returns true if this vessel is within the visible range of any commandable (focusable) vessel, false otherwise.
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=int
| |
| − | |returndesc=
| |
| − | |name=GetCrewCapacity
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=float
| |
| − | |returndesc=
| |
| − | |name=GetTotalMass
| |
| − | |args=
| |
| − | |desc=Get the sum of the mass of all (physical) parts on this vessel
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=Vessel
| |
| − | |returndesc=
| |
| − | |name=GetVessel
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=Die
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=Vector3
| |
| − | |returndesc=
| |
| − | |name=findLocalMOI
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=GoOnRails
| |
| − | |args=
| |
| − | |desc=disables physics and puts the ship into a propagated orbit
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=bool
| |
| − | |returndesc=
| |
| − | |name=checkLanded
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=MakeInactive
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=SetReferenceTransform
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=printCollisions
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=MakeActive
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=Initialize
| |
| − | |args=
| |
| − | |desc=Initialize is used in cases where the Vessel component is added to a ship that already exists.
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=SetPosition
| |
| − | |args={{arg|Vector3|position}}
| |
| − | |desc=Sets the worldspace position of this vessel, and all its parts
| |
| − | }}
| |
| − | {{Method
| |
| − | |returntype=void
| |
| − | |returndesc=
| |
| − | |name=Load
| |
| − | |args=
| |
| − | |desc=
| |
| − | }}
| |
| − | {{MethodsEnd}}
| |
