Difference between revisions of "API:Krakensbane"
From Kerbal Space Program Wiki
Rocketdocker (talk | contribs) ({{Orphan}}) |
|||
| (8 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{Orphan}} | |
| − | <!-- Autogenerated by DOCTOOL. Yell at N3X15 if it breaks. -- It broke I did it manually. --> | + | <!-- 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 | ||
| Line 10: | Line 12: | ||
|desc=Unknown | |desc=Unknown | ||
}} | }} | ||
| − | |||
{{Field | {{Field | ||
|type=Vector3d | |type=Vector3d | ||
| Line 24: | Line 25: | ||
{{Field | {{Field | ||
| − | |type= | + | |type=float |
|name=MaxV | |name=MaxV | ||
|desc=The value of this is 750f, by default. I'm not sure if its constant. | |desc=The value of this is 750f, by default. I'm not sure if its constant. | ||
| Line 49: | Line 50: | ||
|args= | |args= | ||
|desc=Returns the velocity of the Krakensbane velocity frame. | |desc=Returns the velocity of the Krakensbane velocity frame. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
}} | }} | ||
{{StaticMethod | {{StaticMethod | ||
| Line 62: | Line 56: | ||
|name=GetFrameVelocityV3f | |name=GetFrameVelocityV3f | ||
|args= | |args= | ||
| − | |desc=Returns the velocity of the Krakensbane velocity frame | + | |desc=Returns the velocity of the Krakensbane velocity frame in unity format. |
}} | }} | ||
{{StaticMethod | {{StaticMethod | ||
| Line 77: | Line 71: | ||
|name=ResetVelocityFrame | |name=ResetVelocityFrame | ||
|args= | |args= | ||
| − | |desc= | + | |desc=Sets the frame velocity back to 0m/s. Use this if setting the world space velocity of vessels directly. |
}} | }} | ||
{{Method | {{Method | ||
| Line 84: | Line 78: | ||
|name=setOffset | |name=setOffset | ||
|args=Vector3d offset | |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
Krakensbane Class
| Inherits | Implements |
|---|---|
|
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. |
