This mod is currently in Beta Testing, use with caution.

Setup

---

Getting started with Advanced Precision Interfaces is easy! Just follow these simple steps:

• Subscribe to the Advanced Precision Interfaces mod.
  
• Subscribe to any API enabled cockpit mods you would like to use.
  
• Add the base API mod and cockpit mods in your save.

Be sure to add any API enabled cockpits ABOVE Advanced Precision Interfaces in your saves.

Mods currently using this API:

• Advanced Cockpits - API Activated [Beta]
  
• Advanced Rovers - API Activated [Beta]
  
• Advanced Consoles - API Activated [Beta]

It is recommended to enable In Game Scripts in your saves to take advantage of the Programmable Block Run Action.

Also recommended, but completely optional, is the use of the Scrollable FOV plugin through Plugin Loader.


Configuration

---

Once you have the mods in your world, you can alter any desired settings by typing /api followed by the associated command in the in-game chat.

• /api showpointer on/off
  
• /api showimage on/off
  
• /api showtext on/off

Canopy Controls

---

You will find controls for the Canopy, and any other portals that exist for the cockpit, in the terminal menu. You can open and close them individually and set whether or not they should automatically open or close when a pilot enters.

These portals can also be controlled in cockpit through button assignment.


Take a Look Around

---

To interact with your cockpit press and hold the games 'Look Around' key, bound to alt by default, while in 1st person view. You will see a small cursor appear that will change color when looking at an interactive object, as well as an icon showing what type it is. Pressing Middle Mouse Button when looking at a button will bring up the assignment window where you can see what actions are currently assigned.

If you have the Scrollable FOV plugin active then you can quick zoom when looking around by holding ctrl.


PUSH THE BUTTON!

---

There are a few different types of controls available, they are all used by pressing either left and right click, or by scrolling the mouse wheel.

• Button: Left Click single action
  
  
• Dual Button: Left Click for 1st action, Right Click for 2nd action
  
  
• Knob: Scroll Mouse Wheel up or down for positive or negative action
  
  
• Slider: Scroll Mouse Wheel up or down for positive or negative action
  
  
• Switch: Scroll Mouse Wheel up or down for positive or negative action
  
  
• Toggle: Use Left Click and Right Click to cycle through actions
  

Change the button

---

With the assignment window open (MMB) you are able to select which action to edit by scrolling the mouse wheel, empty action slots are shown with a '+'. To change an assignment simply open chat and begin typing your command, you will see the text in the assignment window. Press Enter when you're finished to set the assignment. You can continue to edit other assignments at this time.

Commands Syntax

---

Action commands are structured as a Top Level Command, either 'Control' or a filter type command, then a name in the case of the filters, then the action to be performed. When entering a name for a filter you can enter just name but if there are spaces in the name you must use quotation marks "name of my group". None of the commands are case sensitive.

Here are a few examples of action commands:

Top Level Commands

---

There are two types of Top Level Commands, Control and Filters. Control is used to directly perform actions for the entire ship, like dampeners or park, while Filters are used for selecting the blocks you wish to perform actions on.

• Control Commands
  These are the Control type commands, issue them with Control Command Argument
  
  
  Top Level

  Command

  Argument

  Control

  Toolbar

  Slot #

  Control

  MasterPower

  On/Off/Toggle

  Control

  Damping

  On/Off/Toggle

  Control

  Handbrake

  On/Off/Toggle

  Control

  Park

  On/Off/Toggle

  Control

  Portal

  "Portal Name"

  Automate On/Off/Toggle

  "Portal Name"

  Open/Close/Toggle

  Control

  NightMode

  On/Off
  
  
• Filter Commands
  There are 3 main filters to use when assigning actions to your controls; Block, Group and Grid. Block is used to select a specific block by name, Group is used to select a specific terminal group by name, and grid is used to select all the blocks in the grid by type. All Filter type commands can be followed by any Block Action Command, found in the next section.
  
  These are the Filter type commands, issue them with Filter "name" BlockAction Arguments
  
  
  Top Level

  Name/Type

  Action

  Arguments

  Block

  "Block Name"

  BlockAction

  BlockAction Arguments

  Group

  "Group Name"

  BlockAction

  BlockAction Arguments

  Grid

  BlockType

  BlockAction

  BlockAction Arguments
  
  Available Grid BlockType Filters
  
  • All
    
  • AirVents
    
  • Antennas
    
  • Batteries
    
  • Beacons
    
  • Connectors
    
  • Doors
    
  • Drills
    
  • GravGens

  • Grinders
    
  • Gyros
    
  • Hinges
    
  • JumpDrives
    
  • LandingGears
    
  • LaserAntennas
    
  • LCDs
    
  • Lights
    
  • O2H2Gens

  • OreDetectors
    
  • Parachutes
    
  • Pistons
    
  • Projectors
    
  • Reactors
    
  • RemoteControls
    
  • Rotors
    
  • Sensors
    
  • Sorters

  • SoundBlocks
    
  • Tanks
    
  • Thrusters
    
  • Timers
    
  • Tools
    
  • Turrets
    
  • Warheads
    
  • Welders
    
  • Wheels
  
  
• Shortcuts and Aliases
  There are also a some shortcuts and aliases available for convenience. They exist as alternative paths to Block Action commands, but function exactly the same as if you had used a Filter Command.
  
  
  Shortcut

  Function

  Syntax

  This

  This is a shortcut filter for selecting the cockpit block itself

  This BlockAction Arguments

  PB

  Used to select a Programming block by name

  PB "Block Name" Run

---

When filtering by Grid, calling by group, or going directly to the block; your button will attempt to run your command on any valid blocks given. The list below shows which commands will work on which types of blocks.

If you would like more information about a specific command, please see the Action Index.

---

Block Action Commands Index
Block Type
Valid Actions
All
AirVents
Depressurize
Antennas
Cast, CastShipName, CastRange
Batteries
ChargeMode
Beacons
CastRange
Connectors
SwitchLock, ThrowOut, CollectAll, TradingMode, Overridepower, AutoUnlock, UsedForParking, Strength
Doors
Portal, AnyoneCanUse
Drills
UseConveyor
GravGens
FieldWidth, FieldHeight, FieldDepth, Radius, Acceleration
Grinders
UseConveyor
Gyros
Power, OverrideControls, OverrideYaw, OverrideRoll, OverridePitch
Hinges
Head, Direction, Lock, Velocity, Torque, BrakingTorque, LowerLimit, UpperLimit
JumpDrives
Distance, recharge, Jump
LandingGears
SwitchLock, AutoLock, UsedForParking
LaserAntennas
CastRange
LCDs
Rotation, Content, SetColor, SetScript, SetBackground, GetScripts
Lights
SetColor, Radius, Falloff, Intensity, Offset, BlinkInterval, BlinkLength, BlinkOffset
O2H2Gens
UseConveyor, AutoRefill
OreDetectors
Cast, CastRange
Parachutes
Deploy, AutoDeploy, DeployAlt, AnyoneCanUse
Pistons
Head, Direction, Lock, Velocity, LowerLimit, UpperLimit
Projectors
KeepProjection, ShowBuildable, Offset
Reactors
UseConveyor
RemoteControls
ControlThrusters, ControlWheels, ControlGyros
Rotors
AddHead, Lock, Velocity, Torque, BrakingTorque, LowerLimit, UpperLimit, SetLimits, Reverse
Sensors
Extent, AudibleAlert, Detect
Sorters
DrainAll
SoundBlocks
Play, Stop, Volume, Range, LoopTime
Tanks
Stockpile, AutoRefill
Thrusters
ThrustOverride
Timers
Silent, Delay, Trigger, Start, Stop
Tools
UseConveyor
Turrets
Shoot, ShootOnce, UseConveyor, IdleMove, AimRadius, Target
Warheads
Detonator
Welders
UseConveyor
Wheels
AddWheel, Steering, Propulsion, Brake, UsedForParking, AirShock, Power, Strength, Height, Friction, SpeedLimit, PropulsionOverride, SteeringOverride

---

This is the list of Block Action Commands that can be used following a Top Level Filter Command. Some actions have an alias listed as well, these will also work but perform the same functions as the main argument would.

Anything listed in () is an optional argument. Anything listed in <> is expecting a numerical value.

---

Block Action Commands Index
Action Command
Action Arguments
Aliases
AddWheel
AimRadius
Up/Down/<float>
AirShock
On/Off/Toggle
AudibleAlert
On/Off/Toggle
AutoDeploy
On/Off/Toggle
AutoLock
On/Off/Enable/Disable/Toggle/Switch
AutoRefill
On/Off/Toggle
AutoUnlock
Up/Down/<float>
BlinkInterval
Up/Down/<float>
BlinkLength
Up/Down/<float>
BlinkOffset
Up/Down/<float>
Brake
On/Off/Toggle
BrakingTorque
Up/Down/<float>
Cast
On/Off/Toggle
CastRange
Up (<int>)
Down (<int>)
<int>
Plus/Add (<int>)
Minus/Subtract/Remove (<int>)
CastShipName
On/Off/Toggle
ChargeMode
Auto/Recharge/Discharge/Toggle
CollectAll
Delay
Up/Down/<float>
Deploy
Open/Close/Toggle
DeployAlt
Up/Down/<float>
Depressurize
On/Off/Toggle
Detonator
Timer Up/Down/<float>
Arm On/Off/Toggle
Start/Stop/Detonate
Detect
Players On/Off/Toggle
Floating On/Off/Toggle
SmallShips On/Off/Toggle
LargeShips On/Off/Toggle
Stations On/Off/Toggle
Subgrids On/Off/Toggle
Asteroids On/Off/Toggle
Owner On/Off/Toggle
Friendly On/Off/Toggle
Neutral On/Off/Toggle
Enemy On/Off/Toggle
Direction
Forward/Backward/Reverse
DrainAll
On/Off/Toggle
Extent
Left Up/Down/<float>
Right Up/Down/<float>
Bottom Up/Down/<float>
Top Up/Down/<float>
Back Up/Down/<float>
Front Up/Down/<float>
Falloff
Up/Down/<float>
Distance
Up/Down/<float>
Friction
Up/Down/<float>
GetScripts
Head
Add/Attach/Detach
Height
Up/Down/<float>
IdleMove
On/Off/Toggle
Intensity
Up/Down/<float>
Jump
Lock
On/Off/Toggle
LoopTime
Up/Down/<float>
LowerLimit
Up/Down/<float>
Off
Offset
Up/Down/<float>
Offset
Forward Up/Down/<float>
Horizontal Up/Down/<float>
Vertical Up/Down/<float>
Yaw Up/Down/<float>
Pitch Up/Down/<float>
Roll Up/Down/<float>
On
Override
On/Off/Toggle
Yaw Up/Down/<float>
Pitch Up/Down/<float>
Roll Up/Down/<float>
OverridePower
Up (<int>)
Down (<int>)
<int>
Plus/Add (<int>)
Minus/Subtract/Remove (<int>)
Play
Play/Stop/Toggle
Power
Up (<int>)
Down (<int>)
<int>
Plus/Add (<int>)
Minus/Subtract/Remove (<int>)
Propulsion
On/Off/Toggle
PropulsionOverride
On/Off/Toggle
Radius
Up/Down/<float>
Range
Up/Down/<float>
SetBackground
(<intPanel>) <R,G,B>
SetColor
(<intPanel>) <R,G,B>
SetScript
(<intPanel>) ScriptName
Recharge
On/Off/Toggle
Shoot
Once/On/Off/Toggle
ShowBuildable
On/Off/Toggle
Silent
On/Off/Toggle
Speedlimit
Up/Down/<float>
Start
Steering
On/Off/Toggle
SteeringOverride
On/Off/Toggle
Stockpile
On/Off/Toggle
Stop
Strength
Up (<int>)
Down (<int>)
<int>
Plus/Add (<int>)
Minus/Subtract/Remove (<int>)
SwitchLock
Lock/On/Unlock/Off/Toggle
Target
Meteors On/Off/Toggle
Missiles On/Off/Toggle
SmallShips On/Off/Toggle
LargeShips On/Off/Toggle
Characters On/Off/Toggle
Stations On/Off/Toggle
Neutrals On/Off/Toggle
ThrowOut
On/Off/Toggle
ThrustOverride
Up/Down/<float>
Toggle
Torque
Up/Down/<float>
TradingMode
On/Off/Toggle
Trigger
UpperLimit
Up/Down/<float>
UseConveyor
On/Off/Toggle
UsedForParking
On/Off/Toggle
Velocity
Up/Down/<float>
Volume
Up/Down/<float>

You made it!

---

We hope you enjoy using the Advanced Precision Interfaces API.

If you would like to find out more, get support, or contribute please join us in our discord server.

System Wars Discord: https://discord.gg/AVvZ2Dfs

---