Writing Joystick Code: Part 2: Difference between revisions

Jump to navigation Jump to search
m
no edit summary
No edit summary
mNo edit summary
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{WIP}}
{{JoystickScripting Navigation}}


== Code snippets  ==
== Code snippets  ==
Line 5: Line 5:
Make sure you have read [[Input device]] and [[Writing Joystick Code: Part 1]] first.
Make sure you have read [[Input device]] and [[Writing Joystick Code: Part 1]] first.


These are what you use instead of ''Your code goes here'' amd ''Ctrl-Alt button released''. You just need to put them in the right place - inbetween the <script> and </script> tags.


Please note that some of them have concepts that will be explained in a later section.
Code snippets are what you use instead of ''Your code goes here'' and ''Ctrl-Alt button released'' as seen in Part 1.
You just need to put them in the right place - in between the <script> and </script> tags.
 
 
'''Please note that some of them have concepts that will be explained in Part 3.'''
 


Each snippet has the following format:
Each snippet has the following format:
  Action R/NR
  Action R/NR S C
     Code for action
     Code for action
  U
  U
     Code for <mod-up>
     Code for <mod-up>


Where Action is what you want to do, R means use with a repeatable button, NR means use with a non-repeatable button, and U is the code for <mod-up>. If it is empty, a <mod-up> is not needed.
Where Action is what you want to do, R means use with a repeatable button, NR means use with a non-repeatable button,
and U is the code for <mod-up>. If it is not there, a <mod-up> is not needed.
 
An S, if present, means that it is a step action. gearDown is not a step-action, the gear is either up or down. flapsDown is a step action. Each time you send a flapsDown command the flaps go down one notch. This matters not if you are using a non-repeatable button, but if you use a repeating button, as long as you are pressing the button, flapsDown commands are being sent. This means that if you are still pressing the button when the flaps reach the next notch, they will go down one more notch.
 
The C, if present, means that whatever is being controlled is continously variable between its limits. An example is elevator trim. It moves between full-down to full-up in very tiny steps. Very tiny.


Some Actions will have code for use with repeatable and non-repeatable buttons.
Some Actions will have code for use with repeatable and non-repeatable buttons. Sometimes it is not wise to use the wrong type for a certain action. And sometimes you must use the correct type for an action - using a non-repeating button for Zoom is a bad idea, the user will have to constantly keep triggering the button to reach the zoom level he requires. Using a repeatable button is possible for something like gearDown, as long as the use knows to just use a brief push, but it is a bad idea.


Notice that some commands have a +1 or a -1 in brackets to specify the direction of the action, and a 0 to say stop doing that.
Notice that some commands have a +1 or a -1 in brackets to specify the direction of the action, and a 0 to say stop doing that. The 0 version will of course be in the <mod-up> section.


If the action is upside-down for you, swap the + and - signs.
If the action is upside-down for you, swap the + and - signs.


Also, sometimes the 1 is replaced by a number, which specifies by how much the action should be carried out. If the action is too viscious for you, make the number smaller.
Also, sometimes the 1 is replaced by a number, which specifies by how much the action should be carried out. This is of course not approprite for all actions - you would not want to lower the gear just 75% of the way.
If the action is too vicious for you, make the number smaller.


=== The snippets ===
=== The snippets ===
Line 29: Line 39:
  Gear down NR
  Gear down NR
   controls.gearDown(1)
   controls.gearDown(1)
U
  controls.gearDown(0)
   
   
  Gear up NR
  Gear up NR
  controls.gearDown(-1)
    controls.gearDown(-1)
U
  controls.gearDown(0)
-----------------------------------------------------------------------------
-----------------------------------------------------------------------------
  Flaps down one notch NR
  Flaps down one notch NR S
  controls.gearDown(1)
    controls.flapsDown(1)
U
  controls.gearDown(0)
   
   
  Flaps up one notch NR
  Flaps up one notch NR S
  controls.gearDown(-1)
    controls.flapsDown(-1)
U
  controls.gearDown(0)
-----------------------------------------------------------------------------
-----------------------------------------------------------------------------
  Deploy spoilers NR
  Deploy spoilers NR S
  controls.stepSpoilers(1)
    controls.stepSpoilers(1)
U
  controls.stepSpoilers(0)
   
   
  Retract spoilers NR
  Retract spoilers NR S
   controls.stepSpoilers(-1)
   controls.stepSpoilers(-1)
U
  controls.stepSpoilers(0)
-----------------------------------------------------------------------------
-----------------------------------------------------------------------------
  Cycle View NR
  Cycle View NR
  view.stepView(1)
    view.stepView(1)
U
-----------------------------------------------------------------------------
-----------------------------------------------------------------------------
  Elevator trim down R
  Elevator trim down R C
  controls.elevatorTrim(0.75)
    controls.elevatorTrim(0.75)
U
   
   
  Elevator trim up R
  Elevator trim up R C
  controls.elevatorTrim(-0.75)
    controls.elevatorTrim(-0.75)
U
-----------------------------------------------------------------------------
-----------------------------------------------------------------------------
  Elevator Trim down NR
  Elevator Trim down NR C
  interpolate("/controls/flight/elevator-trim", 1, 30 * (1 - getprop("controls/flight/elevator-trim")))
    interpolate("/controls/flight/elevator-trim", 1, 30 * (1 - getprop("controls/flight/elevator-trim")))
  U
  U
  interpolate("/controls/flight/elevator-trim", getprop("controls/flight/elevator-trim"), 0)
    interpolate("/controls/flight/elevator-trim", getprop("controls/flight/elevator-trim"), 0)
   
   
  Elevator trim up NR
  Elevator trim up NR C
  interpolate("/controls/flight/elevator-trim", -1, 30 * (1 - getprop("controls/flight/elevator-trim")))
    interpolate("/controls/flight/elevator-trim", -1, 30 * (1 - getprop("controls/flight/elevator-trim")))
  U
  U
  interpolate("/controls/flight/elevator-trim", getprop("controls/flight/elevator-trim"), 0)
    interpolate("/controls/flight/elevator-trim", getprop("controls/flight/elevator-trim"), 0)
   
   
These commands are all on one line.
  To make it go faster, make the 30 smaller.
  To make it go faster, make the 30 smaller.
-----------------------------------------------------------------------------
-----------------------------------------------------------------------------
  Aileron trim left R
  Aileron trim left R C
  controls.aileronTrim(-0.75)
    controls.aileronTrim(-0.75)
U
   
   
  Aileron trim right R
  Aileron trim right R C
  controls.aileronTrim(0.75)
    controls.aileronTrim(0.75)
U
-----------------------------------------------------------------------------
-----------------------------------------------------------------------------
  Aileron trim left NR
  Aileron trim left NR C
  interpolate("/controls/flight/aileron-trim", -1, 30 * (1 - getprop("controls/flight/aileron-trim")))
    interpolate("/controls/flight/aileron-trim", -1, 30 * (1 - getprop("controls/flight/aileron-trim")))
  U
  U
  interpolate("/controls/flight/aileron-trim", getprop("controls/flight/aileron-trim"), 0)
    interpolate("/controls/flight/aileron-trim", getprop("controls/flight/aileron-trim"), 0)
   
   
  Aileron trim right NR
  Aileron trim right NR C
  interpolate("/controls/flight/aileron-trim", 1, 30 * (1 - getprop("controls/flight/aileron-trim")))
    interpolate("/controls/flight/aileron-trim", 1, 30 * (1 - getprop("controls/flight/aileron-trim")))
  U
  U
  interpolate("/controls/flight/aileron-trim", getprop("controls/flight/aileron-trim"), 0)
    interpolate("/controls/flight/aileron-trim", getprop("controls/flight/aileron-trim"), 0)
   
   
  To make it go faster, make the 30 smaller.
  To make it go faster, make the 30 smaller.
-----------------------------------------------------------------------------
-----------------------------------------------------------------------------
  If you want rudder-trim, use either the repeatable or non-repeatable above, changing elevator/aileron to rudder
  If you want rudder-trim, use either the repeatable or non-repeatable above, changing elevator-trim/aileron-trim to rudder-trim.
-----------------------------------------------------------------------------
-----------------------------------------------------------------------------
Apply all brakes NR
  controls.applyBrakes(1)
U
  controls.applyBrakes(0)
  Apply left brake NR
  Apply left brake NR
  controls.applyBrakes(1, -1)
    controls.applyBrakes(1, -1)
  U
  U
  controls.applyBrakes(0, -1)
    controls.applyBrakes(0, -1)
   
   
  Apply Right brake NR
  Apply Right brake NR
  controls.applyBrakes(1, 1)
    controls.applyBrakes(1, 1)
  U
  U
  controls.applyBrakes(0, 1)
    controls.applyBrakes(0, 1)
-----------------------------------------------------------------------------
-----------------------------------------------------------------------------
  Start Stopwatch NR
  Start Stopwatch NR
  globals["__dlg:stopwatch-dialog"].start()
    globals["__dlg:stopwatch-dialog"].start()
   
   
  Stop Stopwatch NR
  Stop Stopwatch NR
  globals["__dlg:stopwatch-dialog"].stop()
    globals["__dlg:stopwatch-dialog"].stop()
   
   
  Reset Stopwatch NR
  Reset Stopwatch NR
  globals["__dlg:stopwatch-dialog"].reset()
    globals["__dlg:stopwatch-dialog"].reset()
-----------------------------------------------------------------------------
-----------------------------------------------------------------------------
  Make mixture richer NR
  Make mixture richer R C
  <![CDATA[
    controls.adjMixture(0.05)
    if(getprop("controls/engines/engine/mixture") < 1 ) {
      setprop("controls/engines/engine/mixture", getprop ("controls/engines/engine/mixture") + 0.05)
    }
  ]]>
U
   
   
  Make mixture leaner NR
  Make mixture leaner R C
  <![CDATA[
    controls.adjMixture(-0.05)
    if(getprop("controls/engines/engine/mixture") > 0 ) {
        setprop("controls/engines/engine/mixture", getprop("controls/engines/engine/mixture") - 0.05)
    }
  ]]>
U
-----------------------------------------------------------------------------
-----------------------------------------------------------------------------
  Start all engine all R
  Start all engines R
  controls.startEngine(1)
    controls.startEngine(1)
  U
  U
  controls.startEngine(0)
    controls.startEngine(0)
   
   
  Start specific engine R
  Start specific engine R
  controls.startEngine(1, x)
    controls.startEngine(1, x)
  U
  U
  controls.startEngine(0, x)
    controls.startEngine(0, x)
   
   
  x is the engine number. First engine is 0.
  x is the engine number. First engine is 0.
Line 161: Line 135:
  Wingsweep
  Wingsweep
   
   
  Each aircraft that implements Wingsweep has a specific number of steps between fully forward and fully swept-back.
  How this is implemented in each aircraft depends on the design of the aircraft. If it has predefined wingsweep settings it will step through these settings.
  You set the wingsweep by specifying how many steps the wings must sweep forwards or backwards.
  If not, it will step 20% of the way each time called.
   
   
  Wingsweep forward NR
  Wingsweep forward NR
  controls.wingSweep(n)
    controls.wingSweep(1)
  U
 
Wingsweep backwards NR
    controls.wingSweep(-1)
 
It is possible (but desirable?) to use any value from 1 to 5 in the brackets. This will make the wings sweep more steps at a time.
-----------------------------------------------------------------------------
  Weapons
   
  Fire selected weapon NR
  controls.trigger(1)
  U
  controls.trigger(0)
   
   
Wingsweep backwards NR
  Select previous weapon NR
  controls.wingSweep(-n)
    controls.weaponSelect(-1)
U
   
   
Where n is the number of steps. This means that the number of steps implemented per button press is hard-coded
  Select next weapon NR
in your joystick file. You could of course use a modifier for larger (or smaller) steps.
    controls.weaponSelect(-1)
In this case you would have different values of n.
-----------------------------------------------------------------------------
weapons
-----------------------------------------------------------------------------
-----------------------------------------------------------------------------
  Toggle all lights on/off NR
  Toggle all lights on/off NR
  controls.toggleLights()
    controls.toggleLights()
U
   
   
  Switch specific lights on NR
  Switch specific lights on NR
   setProp(("controls/lighting/xxx"), true)
   setProp(("controls/lighting/xxx"), true)
U
   
   
  Switch specific lights off NR
  Switch specific lights off NR
   setProp(("controls/lighting/xxx"), false)
   setProp(("controls/lighting/xxx"), false)
   
   
  Where xxx = beacon, landing-lights, landing-light, landing-light[1] logo-lights, nav-lights, strobe, taxi-light, taxi-lights, cabin-lights, map-lights.  
  Where xxx = beacon, landing-lights, landing-light, landing-light[1] logo-lights, nav-lights, strobe, taxi-light,
taxi-lights, cabin-lights, map-lights.  
-----------------------------------------------------------------------------
-----------------------------------------------------------------------------
  Instrument lights level up R
  Instrument lights level brighter R
  <![CDATA[  
    <![CDATA[  
    if(getprop("controls/lighting/instruments-norm") < 1 ) {
      if(getprop("controls/lighting/instruments-norm") < 1 ) {
      setprop("controls/lighting/instruments-norm", getprop ("controls/lighting/instruments-norm") + 0.05)
          setprop("controls/lighting/instruments-norm", getprop ("controls/lighting/instruments-norm") + 0.05)
    }
      }
  ]]>
    ]]>
U
   
   
  Instrument lights level down R
  Instrument lights level dimmer R
  <![CDATA[  
    <![CDATA[  
    if(getprop("controls/lighting/instruments-norm") > 0 ) {
      if(getprop("controls/lighting/instruments-norm") > 0 ) {
      setprop("controls/lighting/instruments-norm", getprop ("controls/lighting/instruments-norm") - 0.05)
          setprop("controls/lighting/instruments-norm", getprop ("controls/lighting/instruments-norm") - 0.05)
    }
      }
  ]]>
    ]]>
U
   
   
  Instrument lights level up NR
  Instrument lights level up NR
  <![CDATA[  
    <![CDATA[  
    if(getprop("controls/lighting/instruments-norm") < 1 ) {
      if(getprop("controls/lighting/instruments-norm") < 1 ) {
      setprop("controls/lighting/instruments-norm", getprop ("controls/lighting/instruments-norm") + 0.2)
          setprop("controls/lighting/instruments-norm", getprop ("controls/lighting/instruments-norm") + 0.2)
    }
      }
  ]]>
    ]]>
U
   
   
  Instrument lights level down NR
  Instrument lights level down NR
  <![CDATA[  
    <![CDATA[  
    if(getprop("controls/lighting/instruments-norm") > 0 ) {
      if(getprop("controls/lighting/instruments-norm") > 0 ) {
      setprop("controls/lighting/instruments-norm", getprop ("controls/lighting/instruments-norm") - 0.2)
          setprop("controls/lighting/instruments-norm", getprop ("controls/lighting/instruments-norm") - 0.2)
    }
      }
  ]]>
    ]]>
U
-----------------------------------------------------------------------------
-----------------------------------------------------------------------------
  Step magnetos up NR
  Step magnetos up NR
  controls.stepMagnetos(1)
    controls.stepMagnetos(1)
U
   
   
  Step magnetos down NR
  Step magnetos down NR
  controls.stepMagnetos(-1)
    controls.stepMagnetos(-1)
U
-----------------------------------------------------------------------------
-----------------------------------------------------------------------------


   
   
If you find a line is too long for your page width, then you can press Enter and go to a new line. FG will be happy - it needs a tag or a ; at the end of a line to tell it that the current line of code is finished.
While editing an xml file, if you find a line is too long for your page width, then you can press Enter and go to a new line.
  setprop("controls/engines/engine/mixture", getprop ("controls/engines/engine/mixture") + 0.05)
FG will be happy - it needs a tag or a ; at the end of a line to tell it that the current line of code is finished.
  setprop("controls/engines/engine/mixture", getprop ("controls/engines/engine/mixture") + 0.05)
becomes
becomes
  setprop("controls/engines/engine/mixture",
  setprop("controls/engines/engine/mixture",
    getprop ("controls/engines/engine/mixture") + 0.05)
      getprop ("controls/engines/engine/mixture") + 0.05)
Notice where I put the newline and how I indented the second line. Both are designed to make it easy for people to read, as part of being a programmer is making your code legible for others.
Notice where I put the newline and how I indented the second line. Both are designed to make it easy for people to read,
 
as part of being a programmer is making your code legible for others.
 
-----------------------------------------------------------------------------
 


Go back to [[Writing Joystick Code: Part 1]].




Line 250: Line 221:




Any complaints/suggestions/questions/kudos can be posted [http://flightgear.org/forums/viewtopic.php?f=24&t=17892 here].
Any complaints/suggestions/questions/kudos can be posted [http://forum.flightgear.org/viewtopic.php?f=24&t=17892 here].


== Related content ==
* [[Joystick xml library]]


[[Category:Hardware]]
[[Category:Hardware]]
6

edits

Navigation menu