$next list item

From UBot Studio
(Difference between revisions)
Jump to: navigation, search
Line 5: Line 5:
 
This function is the easiest way to loop through a list sequentially (from position 0  
 
This function is the easiest way to loop through a list sequentially (from position 0  
 
to the end of the list).
 
to the end of the list).
 +
 +
 +
== Example ==
 +
 
Given a list containing the numbers 1-25, we will loop through the list using the  
 
Given a list containing the numbers 1-25, we will loop through the list using the  
 
$next list item function:
 
$next list item function:
  
 
[[File:nextlistitem.png]]
 
[[File:nextlistitem.png]]
 +
 +
We will create the loop using the $list total function:
 +
 +
[[File:nextlistitem0.png]]
 +
 +
Inside the loop we will use an if/then statement to set a condition.
 +
In this case we will simply stop the script when the list item is greater than 15:
 +
 +
[[File:nextlistitem1.png]]
 +
 +
Place an if/then node in the scripting area and click on the qualifier place holder to
 +
highlight it. Drag a comparison qualifier (from the qualifier menu under Functions) into
 +
the if then else command.
 +
 +
For the first value, choose $list position from the variables functions menu and place it
 +
in the area for the First value in the comparison qualifier. Select the greater than
 +
symbol from the drop down menu within the qualifier labeled “Condition” and type the
 +
number 15 into the area for the Second Value.
 +
 +
[[File:nextlistitem2.png]]
 +
 +
 +
Now drag a stop script command into the Then command. Place a type text command
 +
into the Else command to have it fill a field of your choice, as long as the condition we
 +
set is met.
 +
When run, this script will loop through the list until it reaches a list position greater
 +
than 15 and stop the script. 
 +
 +
It is important to note that if you place a set list position node just above the loop node
 +
you can loop through the list as many times as you like without the worry of exceeding
 +
the range of the list.  The set list position command effectively “resets” the list back to
 +
the first position.

Revision as of 23:56, 9 October 2012

This function retrieves the next item in a list. Lists have internal position counters to keep track of where you are.

This function will return the list item at the list's current position, and then increment the list's position by one. This function is the easiest way to loop through a list sequentially (from position 0 to the end of the list).


Example

Given a list containing the numbers 1-25, we will loop through the list using the $next list item function:

File:Nextlistitem.png

We will create the loop using the $list total function:

File:Nextlistitem0.png

Inside the loop we will use an if/then statement to set a condition. In this case we will simply stop the script when the list item is greater than 15:

File:Nextlistitem1.png

Place an if/then node in the scripting area and click on the qualifier place holder to highlight it. Drag a comparison qualifier (from the qualifier menu under Functions) into the if then else command.

For the first value, choose $list position from the variables functions menu and place it in the area for the First value in the comparison qualifier. Select the greater than symbol from the drop down menu within the qualifier labeled “Condition” and type the number 15 into the area for the Second Value.

File:Nextlistitem2.png


Now drag a stop script command into the Then command. Place a type text command into the Else command to have it fill a field of your choice, as long as the condition we set is met. When run, this script will loop through the list until it reaches a list position greater than 15 and stop the script.

It is important to note that if you place a set list position node just above the loop node you can loop through the list as many times as you like without the worry of exceeding the range of the list. The set list position command effectively “resets” the list back to the first position.

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox