Timer

This article describes the timer function and each of its properties.
The timer function allows an interval or recurring interval to be added between events in a Squirrel project.
Add a timer to your project by opening the FUNCTIONS drawer in the object browser, select Timer from the dropdown box and click the plus button.

The timer function will appear in the FUNCTIONS drawer of the object browser. Select it from there to access its properties in the property panel.

Timer Function Properties

DATA INSERTION:

• Delay in milliseconds – This is the time it will take from the timer being triggered to timer completion.

• • Trigger when:
    • Cell changes – The timer will be triggered when the content of the cell bound to the Trigger cell property is changed.

• • Cell equals – The timer will be triggered when the content of the cell bound to the Trigger cell is equal to the value of the Equals property (this value can be typed into the Equals property or bound to another cell in the spreadsheet).

• • Trigger on load – Checking this will start the timer as soon as the Squirrel project is loaded. This can be used on its own, or in addition to one of the Trigger when options listed above.

• Insertion Type:
  • Block – This option will cause the timer to execute once only, after which (if values have been added to the Source and Destination properties), a further event can be then be initiated.
  • Loop – This option can be selected if the timer needs to be executed more than once.

• • Loop Counter – A counter will be incremented each time the timer executes, and this number will be inserted into the cell bound to this property.

• Loop options:
  • Loop for:
    • Stop after n loops – Add a numerical value into this property (or bind to a cell containing a numerical value), the timer will execute this many times.
  • Loop until:
    • Bind cell property to a cell in the spreadsheet, then either add a numerical value to the equals property, or bind to a cell in the spreadsheet that contains a suitable value.