Kift APIs

Kift provides two sets of APIs: "InfoSync APIs" and "Command APIs".

"InfoSync APIs" pull infos from the game. "Command APIs" send commands to control vessels/parts/game.

Command APIs are devided into three categories according to the target.

• InfoSync APIs
  • Real time snapshot
  • GetInfo APIs
• Command APIs
  • Vessel Control APIs
  • Part Control APIs
  • Game Control APIs

InfoSync APIs

Snapshot

Read data at real time(approximately), useful when you want to monitor any data, such as height, speed, etc.

SnapshotResponse snapshot(1:SnapshotRequest req)

GetInfo APIs

Get data from current game, such as current vessel, the part list of a vessel, etc.

listVessel()

currentVessel()

getVessel(1:string vesselId)

getVesselParts(1:string vesselId)

getVesselPartsById(1:string vesselId, 2:list partIds)

getVesselPartsByType(1:string vesselId, 2:PartType type)

getPartsById(1:list partIds)

listCelestialBody()

getCelestialBody(1:string name)

getTargetVesselOrbitInfo(1:string vesselId, 2:string targetVesselId)

getTargetBodyOrbitInfo(1:string vesselId, 2:string targetBodyName)

getTargetVesselOrbitInfoFromManeuverNode(1:string vesselId, 2:double ut, 3:string targetVesselId)

getTargetBodyOrbitInfoFromManeuverNode(1:string vesselId, 2:double ut, 3:string targetBodyName)

getVesselAttitudeInfo(1:string vesselId)

getPartAttitudeInfo(1:i64 partId)

Command APIs

Vessel Control APIs

APIs to control a vessel, such as pitch/yaw/roll, enable/disable RCS, deploy/restract landing legs, etc.

stage()

pitch(1:string vesselId, 2:double value)

yaw(1:string vesselId, 2:double value)

roll(1:string vesselId, 2:double value)

up(1:string vesselId, 2:double value)

forward(1:string vesselId, 2:double value)

right(1:string vesselId, 2:double value)

throttle(1:string vesselId, 2:double value)

wheelSteer(1:string vesselId, 2:double value)

wheelThrottle(1:string vesselId, 2:double value)

resetControl(1:string vesselId)

releaseControl(1:string vesselId)

setSAS(1:string vesselId, 2:bool enabled)

setSASMode(1:string vesselId, 2:observor.SASMode sasMode)

setRCS(1:string vesselId, 2:bool enabled)

setReactionWheels(1:string vesselId, 2:bool enabled)

setGear(1:string vesselId, 2:bool enabled)

setLegs(1:string vesselId, 2:bool enabled)

setWheels(1:string vesselId, 2:bool enabled)

setLights(1:string vesselId, 2:bool enabled)

setBrakes(1:string vesselId, 2:bool enabled)

setAntennas(1:string vesselId, 2:bool enabled)

setCargoBays(1:string vesselId, 2:bool enabled)

setIntakes(1:string vesselId, 2:bool enabled)

setParachutes(1:string vesselId, 2:bool enabled)

setRadiators(1:string vesselId, 2:bool enabled)

setResourceHarvestersDeploy(1:string vesselId, 2:bool enabled)

setResourceHarvestersActive(1:string vesselId, 2:bool enabled)

setSolarPanels(1:string vesselId, 2:bool enabled)

setActionGroup(1:string vesselId, 2:i32 groupId, 3:bool enabled)

toggleActionGroup(1:string vesselId, 2:i32 groupId)

abort(1:string vesselId, 2:bool enabled)

targetCelestialBody(1:string vesselId, 2:string targetName)

targetVessel(1:string vesselId, 2:string targetVesselId)

targetDockingPort(1:string vesselId, 2:double dockingPortId)

clearTarget()

Part Control APIs

APIs to control a part, such as deploy/restract a solar panel, open/close a cargo bay, etc.

antennaDeploy(1:i64 partId, 2:bool enabled)

antennaTransmit(1:i64 partId)

antennaCancelTransmit(1:i64 partId)

cargoBayOpen(1:i64 partId)

cargoBayClose(1:i64 partId)

controlSurfacePitchEnabled(1:i64 partId, 2:bool enabled)

controlSurfaceYawEnabled(1:i64 partId, 2:bool enabled)

controlSurfaceRollEnabled(1:i64 partId, 2:bool enabled)

controlSurfaceAuthorityLimiter(1:i64 partId, 2:double authorityLimiter)

controlSurfaceInverted(1:i64 partId, 2:bool enabled)

controlSurfaceDeployed(1:i64 partId, 2:bool enabled)

decouplerActivate(1:i64 partId)

dockingPortUndock(1:i64 partId)

dockingPortShieldOpen(1:i64 partId)

dockingPortShieldClose(1:i64 partId)

engineActivate(1:i64 partId)

engineShutDown(1:i64 partId)

engineThrustPercentage(1:i64 partId, 2:i32 limit)

engineSwitchMode(1:i64 partId, 2:string mode)

engineAutoSwitchMode(1:i64 partId, 2:bool enabled)

engineToggleMode(1:i64 partId)

engineGimbalLock(1:i64 partId, 2:bool locked)

engineGimbalLimit(1:i64 partId, 2:double limit)

fairingJettison(1:i64 partId)

intakeOpen(1:i64 partId)

intakeClose(1:i64 partId)

launchClampRelease(1:i64 partId)

legExtend(1:i64 partId)

legRetract(1:i64 partId)

lightOn(1:i64 partId)

lightOff(1:i64 partId)

parachuteDeploy(1:i64 partId)

parachuteDisarm(1:i64 partId)

parachuteDeployAltitude(1:i64 partId, 2:double altitude)

parachuteMinPressure(1:i64 partId, 2:double pressure)

radiatorExtend(1:i64 partId)

radiatorRetract(1:i64 partId)

RCSEnabled(1:i64 partId, 2:bool enabled)

RCSThrustPercentage(1:i64 partId, 2:i32 limit)

RCSPitchEnabled(1:i64 partId, 2:bool enabled)

RCSYawEnabled(1:i64 partId, 2:bool enabled)

RCSRollEnabled(1:i64 partId, 2:bool enabled)

RCSUpEnabled(1:i64 partId, 2:bool enabled)

RCSForwardEnabled(1:i64 partId, 2:bool enabled)

RCSRightEnabled(1:i64 partId, 2:bool enabled)

reactionWheelEnabled(1:i64 partId, 2:bool enabled)

resourceConverterStart(1:i64 partId, 2:i32 index)

resourceConverterStop(1:i64 partId, 2:i32 index)

resourceHarvesterDeploy(1:i64 partId)

resourceHarvesterRetract(1:i64 partId)

resourceHarvesterStart(1:i64 partId)

resourceHarvesterStop(1:i64 partId)

sensorActivate(1:i64 partId)

sensorDeactivate(1:i64 partId)

solarPanelExtend(1:i64 partId)

solarPanelRetract(1:i64 partId)

wheelBrakeEngage(1:i64 partId)

wheelBrakeRelease(1:i64 partId)

wheelBrakeForce(1:i64 partId, 2:double percentage)

wheelAutoFrictionControlEnabled(1:i64 partId, 2:bool enabled)

wheelManualFrictionControl(1:i64 partId, 2:double value)

wheelTractionControlEnabled(1:i64 partId, 2:bool enabled)

wheelTractionControl(1:i64 partId, 2:double value)

wheelDriveLimiter(1:i64 partId, 2:double limit)

wheelDeploy(1:i64 partId)

wheelRetract(1:i64 partId)

wheelMotorEnabled(1:i64 partId, 2:bool enabled)

wheelMotorInverted(1:i64 partId, 2:bool inverted)

wheelSteeringEnabled(1:i64 partId, 2:bool enabled)

wheelSteeringInverted(1:i64 partId, 2:bool inverted)

Game Control APIs

APIs to control the game, such as time warp, change camera mode, set/remove maneuver nodes etc.

setManeuverNode(1:string vesselId, 2:double ut, 3:double prograde, 4:double normal, 5:double radial)

getManeuverNode(1:string vesselId, 2:double ut)

listManeuverNodes(1:string vesselId)

removeManeuverNode(1:string vesselId, 2:double ut)

universalTime()

warpTo(1:double ut)

getTimeWarpRate()

increaseTimeWarpRate()

decreaseTimeWarpRate()