Difference between revisions of "API:Krakensbane"

From Kerbal Space Program Wiki
Jump to: navigation, search
(Release of XML code docs authorized by HarvesteR.)
 
({{Orphan}})
 
(11 intermediate revisions by one other user not shown)
Line 1: Line 1:
<!-- Autogenerated by DOCTOOL.  Yell at N3X15 if it breaks. -->
+
{{Orphan}}
 +
<!-- Autogenerated by DOCTOOL.  Yell at N3X15 if it breaks. -- It broke, I did it manually. -->
 
{{Class
 
{{Class
 
|inherits=<ul><li>{{Type|MonoBehaviour}}</li></ul>
 
|inherits=<ul><li>{{Type|MonoBehaviour}}</li></ul>
|name=Krakensbane}}
+
|name=Krakensbane
 +
|summary=The Krakensbane system is used to overcome the floating point precision errors that occur due to the environment size.
 +
}}
 
{{FieldsStart}}
 
{{FieldsStart}}
 
{{Field
 
{{Field
 
|type=Vector3d
 
|type=Vector3d
|name=FrameVel
+
|name=RBVel
|desc=
+
|desc=Unknown
 +
}}
 +
{{Field
 +
|type=Vector3d
 +
|name=excessV
 +
|desc=Unknown
 +
}}
 +
 
 +
{{Field
 +
|type=Vector3d
 +
|name=lastCorrection
 +
|desc=Unknown
 
}}
 
}}
 +
 
{{Field
 
{{Field
 
|type=float
 
|type=float
 
|name=MaxV
 
|name=MaxV
|desc=
+
|desc=The value of this is 750f, by default. I'm not sure if its constant.
 +
}}
 +
 
 +
{{Field
 +
|type=Vector3d
 +
|name=FrameVel
 +
|desc=Unknown
 +
}}
 +
 
 +
{{Field
 +
|type=Vector3d
 +
|name=totalVel
 +
|desc=Unknown
 
}}
 
}}
 +
 
{{FieldsEnd}}
 
{{FieldsEnd}}
 
{{MethodsStart}}
 
{{MethodsStart}}
Line 22: Line 50:
 
|args=
 
|args=
 
|desc=Returns the velocity of the Krakensbane velocity frame.
 
|desc=Returns the velocity of the Krakensbane velocity frame.
}}
 
{{StaticMethod
 
|returntype=void
 
|returndesc=
 
|name=ResetVelocityFrame
 
|args=
 
|desc=sets the frame velocity back to 0m/s. Use this if setting the worldspace velocity of vessels directly.
 
 
}}
 
}}
 
{{StaticMethod
 
{{StaticMethod
Line 35: Line 56:
 
|name=GetFrameVelocityV3f
 
|name=GetFrameVelocityV3f
 
|args=
 
|args=
|desc=Returns the velocity of the Krakensbane velocity frame as a single-precision vector.
+
|desc=Returns the velocity of the Krakensbane velocity frame in unity format.
 
}}
 
}}
 
{{StaticMethod
 
{{StaticMethod
Line 43: Line 64:
 
|args=
 
|args=
 
|desc=Returns the last velocity correction performed.
 
|desc=Returns the last velocity correction performed.
 +
}}
 +
 +
{{StaticMethod
 +
|returntype=void
 +
|returndesc=
 +
|name=ResetVelocityFrame
 +
|args=
 +
|desc=Sets the frame velocity back to 0m/s. Use this if setting the world space velocity of vessels directly.
 
}}
 
}}
 
{{Method
 
{{Method
Line 48: Line 77:
 
|returndesc=
 
|returndesc=
 
|name=setOffset
 
|name=setOffset
|args=
+
|args=Vector3d offset
|desc=
+
|desc=This allows you to set the world offset from the position. Remember this system moves the environment around the player.
 
}}
 
}}
 
{{MethodsEnd}}
 
{{MethodsEnd}}
 
[[Category:Community API Documentation]]
 
[[Category:Community API Documentation]]

Latest revision as of 17:13, 22 January 2020

This page is an orphan, as no other articles link to it.


Krakensbane Class

Inherits Implements
  • MonoBehaviour

The Krakensbane system is used to overcome the floating point precision errors that occur due to the environment size.

Fields

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

Signature Description
Vector3d RBVel Unknown
Vector3d excessV Unknown
Vector3d lastCorrection Unknown
float MaxV The value of this is 750f, by default. I'm not sure if its constant.
Vector3d FrameVel Unknown
Vector3d totalVel Unknown

Methods

The following are methods included in Krakensbane.

Signature Description
static Vector3d GetFrameVelocity() Returns the velocity of the Krakensbane velocity frame.
static Vector3 GetFrameVelocityV3f() Returns the velocity of the Krakensbane velocity frame in unity format.
static Vector3d GetLastCorrection() Returns the last velocity correction performed.
static void ResetVelocityFrame() Sets the frame velocity back to 0m/s. Use this if setting the world space velocity of vessels directly.
void setOffset(Vector3d offset) This allows you to set the world offset from the position. Remember this system moves the environment around the player.