Skip to end of banner
Go to start of banner

Parameters in SIL Runner Gadget

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Parameters in SIL Runner Gadget


SIL Runner Gadget can be customized in a much user friendly way, asking parameters more nicely. 

In order to configure such an entry, you will need to set up the following components:

  • Name - the name of the configuration
  • Description - the description of the configuration
  • Execution script - the script that will be executed 
  • Parameter script - an optional script that will dynamically insert advanced parameter fields on the configuration's run screen. 

If no parameter script is given, the user will be able to add simple input fields for text parameters (we maintained the old functionality). In order to not show any kind of input for the parameters, use an empty script.

Example 

The execution script is the script that will be executed. If there are any parameters declared in the parameter script, their values will be received and interpreted here. In order to get the values of the parameters, you will need to use the parameter retrieval routines. 

In our case, the execution script uses the runnerLog routine and  can return as many values as you need, regardless of their type.

Example code
date start_date = gadget_getDateValue(argv, "Start Date");
string tanks = gadget_getSingleValue(argv, "Tanks");
string infantry = gadget_getSingleValue(argv, "Infantry");
string rockets = gadget_getMultiValues(argv, "Rockets");
runnerLog("Preparing to start a war...");
runnerLog("The war will start at this date: " + start_date);
runnerLog("Building tanks...");
runnerLog("Built " + tanks + " tanks.");
runnerLog("Gathering infantry...");
runnerLog("Gathered " + infantry + " brave men.");
runnerLog("Fueling rockets...");
runnerLog(rockets + " ready.");
runnerLog("Dispatching orders...");
return "Good job! The world is now at war!";

The parameter script contains the declaration of the parameters that will be used in the execution script. In order to declare the parameters you will need to use the input type routines.

Example code
gadget_createDatePicker("Start Date", currentDate(), true, "Choose a start date");
gadget_createInput("Tanks", "500", true, "The number of tanks");
gadget_createInput("Infantry", "1600", true, "The number of tanks");
gadget_createCheckboxGroup("Rockets", {"A big one", "A lot of small ones"}, "", false, "Do you want to use rockets?");

The parameters can be set to a default values, which can be edited before running the execution script. Using the scripts above, the SIL Runner Gadget will look like this:


The execution of the script above produces the output below:


  • No labels