MASFlightComputerProxy2

MASFlightComputerProxy2.cs

Maneuver Node Category

Methods for querying and controlling maneuver nodes are in this category.

fc.AddManeuverNode(double progradedV, double normaldV, double radialdV, double timeUT)

progradedV: ΔV in the prograde direction at the time of the maneuver, in m/s.
normaldV: ΔV in the normal direction at the time of the maneuver, in m/s.
radialdV: ΔV in the radial direction at the time of the maneuver, in m/s.
timeUT: UT to schedule the maneuver, in seconds.

Returns: 1 if the manuever node was created, 0 on any errors.

Replace any scheduled maneuver nodes with this maneuver node.

fc.ClearManeuverNode()

Returns: 1 if any nodes were cleared, 0 if no nodes were cleared.

Clear all scheduled maneuver nodes.

fc.ManeuverNodeAp()

Returns: New Ap in meters, or 0 if no node is scheduled.

Returns the apoapsis of the orbit that results from the scheduled maneuver.

fc.ManeuverNodeBurnTime()

Returns: Approximate burn time in seconds, or 0 if no node is scheduled.

Returns an estimate of the maneuver node burn time, in seconds.

fc.ManeuverNodeDV()

Returns: ΔV in m/s, or 0 if no node is scheduled.

Delta-V of the next scheduled node.

fc.ManeuverNodeDVNormal()

Returns: ΔV in m/s; negative values indicate anti-normal.

The normal component of the next scheduled maneuver.

fc.ManeuverNodeDVPrograde()

Returns: ΔV in m/s; negative values indicate retrograde.

The prograde component of the next scheduled maneuver.

fc.ManeuverNodeDVRadial()

Returns: ΔV in m/s; negative values indicate anti-radial.

The radial component of the next scheduled maneuver.

fc.ManeuverNodeEcc()

Returns: New eccentricity, or 0 if no node is scheduled.

Returns the eccentricity of the orbit that results from the scheduled maneuver.

fc.ManeuverNodeExists()

Returns 1 if there is a valid maneuver node; 0 otherwise

fc.ManeuverNodeInc()

Returns: New inclination in degrees, or 0 if no node is scheduled.

Returns the inclination of the orbit that results from the scheduled maneuver.

fc.ManeuverNodeNextBody()

Returns the index to the body that the vessel will encounter after a change in SoI caused by a scheduled maneuver node. If there is no maneuver node, or the vessel does not change SoI because of the maneuver, returns -1 (current body).

fc.ManeuverNodeNextSoI()

Returns: 0 if the orbit does not transition. 1 if the vessel will encounter a body, -1 if the vessel will escape the current body.

Returns 1 if the SoI change after a scheduled maneuver is an 'encounter', -1 if it is an 'escape', and 0 if the scheduled orbit does not change SoI.

fc.ManeuverNodePe()

Returns: New Pe in meters, or 0 if no node is scheduled.

Returns the periapsis of the orbit that results from the scheduled maneuver.

fc.ManeuverNodeRelativeInclination()

Returns: New relative inclination in degrees, or 0 if there is no maneuver node, no target, or the target orbits a different body.

Returns the relative inclination of the target that will result from the scheduled maneuver.

fc.ManeuverNodeTargetClosestApproachDistance()

Returns: Closest approach to the target, or 0.

Closest approach to the target after the next maneuver completes, in meters. If there is no maneuver scheduled, or no target, returns 0.

fc.ManeuverNodeTargetClosestApproachSpeed()

Returns: Relative speed of the target at closest approach after the maneuver, m/s.

Relative speed of the target at closest approach after the scheduled maneuver, in m/s. If there is no maneuver scheduled, or no target, returns 0.

fc.ManeuverNodeTargetClosestApproachTime()

Returns: Time until closest approach after the maneuver.

Time when the closest approach with a target occurs after the scheduled maneuver, in seconds. If there is no maneuver scheduled, or no target, returns 0.

fc.ManeuverNodeTime()

Returns time in seconds until the maneuver node; 0 if no node is valid.

fc.ManeuverNodeTimeToNextSoI()

Returns: Time until the next SoI after the scheduled maneuver, or 0

Returns the time to the next SoI transition in the scheduled maneuver, in seconds. If the planned orbit does not change SoI, or no node is scheduled, returns 0.

Mass Category

Vessel mass may be queried with these methods.

fc.Mass(bool wetMass)

wetMass: wet mass if true, dry mass otherwise

Returns: Vessel mass in tonnes.

Returns the mass of the vessel in tonnes.

Math Category

Provides MAS-native methods for common math primitives. These methods generally duplicate the functions in the Lua math table, but by placing them in MAS, MAS can use native delegates instead of having to call into Lua (which is slower).

This region also contains other useful mathematical methods.

fc.Abs(double value)

Returns: The absolute value of value.

Returns the absolute value of value.

fc.Between(double value, double lowerBound, double upperBound)

value: The value to test.
lowerBound: The lower bound (inclusive) of the range to test.
upperBound: The upper bound (inclusive) of the range to test.

Returns: 1 if value is between lowerBound and upperBound, 0 otherwise.

Returns 1 if value is at least equal to lowerBound and not greater than upperBound. Returns 0 otherwise.

In other words,

If value >= lowerBound and value <= upperBound, return 1.
Otherwise, reutrn 0.

fc.Ceiling(double value)

value: The value to round

Rounds a number up to the next integer.

fc.Clamp(double value, double a, double b)

value: The value to clamp.
a: The first bound.
b: The second bound.

Returns: The clamped value.

Clamps value to stay within the range a to b, inclusive. a does not have to be less than b.

fc.Floor(double value)

value: The value to round

Rounds a number down to the next integer.

fc.Max(double a, double b)

a: The first value to test.
b: The second value to test.

Returns: a if a is larger than b; b otherwise.

Return the larger value

fc.Min(double a, double b)

a: The first value to test.
b: The second value to test.

Returns: a if a is smaller than b; b otherwise.

Return the smaller value

fc.NormalizeAngle(double angle)

angle: The de-normalized angle to correct.

Returns: A value between 0 (inclusive) and 360 (exclusive).

Normalizes an angle to the range [0, 360).

fc.NormalizeLongitude(double angle)

angle: The de-normalized angle to correct.

Returns: A value between -180 (inclusive) and +180 (exclusive).

Normalizes an angle to the range [-180, 180).

fc.NormalizePitch(double angle)

angle: The angle to convert

Returns: A value between -90 and +90, inclusive.

Converts an angle to a pitch value in the range of [-90, +90].

fc.PseudoLog10(double sourceValue)

sourceValue: An input number

Returns: A Log10-like representation of the input value.

Apply a log10-like curve to the value.

The exact formula is:

if (abs(sourceValue) < 1.0)
  return sourceValue;
else
  return (1 + Log10(abs(sourceValue))) * Sign(sourceValue);
end

fc.SafeDivide(double numerator, double denominator)

numerator: The numerator
denominator: The denominator

Returns: numerator / denominator, or 0 if the denominator is zero.

Divides numerator by denominator. If the denominator is zero, this method returns 0 instead of infinity or throwing a divide-by-zero exception.

fc.SafeModulo(double numerator, double denominator)

numerator: The numerator
denominator: The denominator

Returns: A value between 0 and denominator, or 0 if the denominator is zero.

Returns the remainder of numerator divided by denominator. If the denominator is zero, this method returns 0 instead of infinity or throwing a divide-by-zero exception.

Meta Category

Meta variables and functions are variables provide information about the game, as opposed to the vessel. They also include the fc.Conditioned() functions, which can provide some realism by disrupting lighting under low power or high G situations.

fc.AssemblyLoaded(string assemblyName)

Returns: 1 if the named assembly is loaded, 0 otherwise.

Checks for the existence of the named assembly (eg, fc.AssemblyLoaded("MechJeb2")). This can be used to determine if a particular mod has been installed when that mod is not directly supported by Avionics Systems.

fc.CancelTimeWarp(bool instantCancel)

instantCancel: If true, time warp is immediately set to x1. If false, time warp counts downward like in normal gameplay.

Returns: 1 if time warp was successfully adjusted, 0 if it could not be adjusted.

Cancel time warp.

fc.ColorTag(double red, double green, double blue)

red: Red channel value, [0, 255]
green: Green channel value, [0, 255]
blue: Blue channel value, [0, 255]

Converts the supplied RGB value into a MAS text color tag (eg, fc.HexColor(255, 255, 0) returns "[#ffff00]"). This value is slightly more efficient if you do not need to change the alpha channel.

All values are clamped to the range 0 to 255.

fc.ColorTag(double red, double green, double blue, double alpha)

red: Red channel value, [0, 255]
green: Green channel value, [0, 255]
blue: Blue channel value, [0, 255]
alpha: Alpha channel value, [0, 255]

Converts the supplied RGBA value into a MAS text color tag (eg, fc.HexColor(255, 255, 0, 255) returns "[#ffff00ff]").

All values are clamped to the range 0 to 255.

fc.Conditioned(object value)

value: A numeric value or a boolean

Returns: value if the conditions above are not met.

Applies some "realism" conditions to the variable to cause it to return zero under two general conditions:

When there is no power available (the config-file-specified power variable is below 0.0001), or
The craft is under high g-loading. G-loading limits are defined in the per-pod config file. When these limits are exceeded, there is a chance (also defined in the config file) of the variable being interrupted. This chance increases as the g-forces exceed the threshold using a square-root curve.
The optional variable powerOnVariable in MASFlightComputer returns 0 or less.

The variable fc.Conditioned(1) behaves the same as the RasterPropMonitor ASET Props custom variable CUSTOM_ALCOR_POWEROFF, with an inverted value (CUSTOM_ALCOR_POWEROFF returns 1 to indicate "disrupt", but fc.Conditioned(1) returns 0 instead).

For boolean parameters, true is treated as 1, and false is treated as 0.

fc.SIFormatValue(double value, double totalLength, double minDecimal, string delimiter, bool forceSign, bool showPrefix)

value: The number to format.
totalLength: The total length of the string.
minDecimal: The minimum decimal precision of the string.
delimiter: A custom delimiter, or an empty string "" to indicate no delimiter
forceSign: Require a space for the sign, even if the value is positive
showPrefix: Whether the SI prefix should be appended to the string.

Returns: The formatted string.

Provides a custom SI formatter with more control than the basic SIP format.

NOT IMPLEMENTED: Custom delimiter.

fc.HoursPerDay()

Returns: 6 for Kerbin time, 24 for Earth time, or another value for modded installations.

Returns the number of hours per day on Kerbin. With a stock installation, this is 6 hours or 24 hours, depending on whether the Kerbin calendar or Earth calendar is selected. Mods may change this to a different value.

fc.KerbinTime()

Returns 1 if the KSP UI is configured for the Kerbin calendar (6 hour days); returns 0 for Earth days (24 hour).

fc.LogMessage(string message)

message: The string to write. Strings may be formatted using the Lua string library, or using the .. concatenation operator.

Log messages to the KSP.log. Messages will be prefixed with [MASFlightComputerProxy].

fc.MapIconU(double iconId)

iconId: The Icon Id - either fc.TargetTypeId() or one of the numbers listed in the description.

Returns: The U shift to select the icon from the '%MAP_ICON%' texture.

Returns the U texture shift required to display the map icon listed below. This function is intended to be used in conjunction with the '%MAP_ICON%' texture in MASMonitor IMAGE nodes.

0 - Invalid (not one of the below types)
1 - Ship target
2 - Plane target
3 - Probe target
4 - Lander target
5 - Station target
6 - Relay target
7 - Rover target
8 - Base target
9 - EVA target
10 - Flag target
11 - Debris target
12 - Space Object target
13 - Unknown target
14 - Celestial Body (planet)
15 - Ap Icon
16 - Pe Icon
17 - AN Icon
18 - DN Icon
19 - Maneuver Node Icon
20 - Ship location at intercept
21 - Target location at intercept
22 - Enter an SoI
23 - Exit an SoI
24 - Point of Impact (?)

Note that entries 0 - 14 correspond to the results of fc.TargetTypeId().

fc.MapIconV(double iconId)

iconId: The Icon Id - either fc.TargetTypeId() or one of the numbers listed in the description.

Returns: The V shift to select the icon from the '%MAP_ICON%' texture.

Returns the V texture shift required to display the map icon listed below. This function is intended to be used in conjunction with the '%MAP_ICON%' texture in MASMonitor IMAGE nodes.

0 - Invalid (not one of the below types)
1 - Ship target
2 - Plane target
3 - Probe target
4 - Lander target
5 - Station target
6 - Relay target
7 - Rover target
8 - Base target
9 - EVA target
10 - Flag target
11 - Debris target
12 - Space Object target
13 - Unknown target
14 - Celestial Body (planet)
15 - Ap Icon
16 - Pe Icon
17 - AN Icon
18 - DN Icon
19 - Maneuver Node Icon
20 - Ship location at intercept
21 - Target location at intercept
22 - Enter an SoI
23 - Exit an SoI
24 - Point of Impact (?)

Note that entries 0 - 14 correspond to the results of fc.TargetTypeId().

fc.MASVersion()

Returns: MAS Version in string format.

Returns the version number of the MAS plugin, as a string, such as 1.0.1.12331.

fc.NavballB(double iconId)

iconId: The icon as explained in the description.

Returns: The B value to use in passiveColor or activeColor.

Returns the B color value for the navball marker icon selected. This function is intended to be used in conjunction with the '%NAVBALL_ICON%' texture in MASMonitor IMAGE nodes.

0 - Prograde
1 - Retrograde
2 - Radial Out
3 - Radial In
4 - Normal +
5 - Normal - (anti-normal)
6 - Maneuver Node
7 - Target +
8 - Target - (anti-target)