$next list item

From UBot Studio
(Difference between revisions)
Jump to: navigation, search
(Example)
Line 6: Line 6:
 
== Example ==
 
== Example ==
  
Given a list containing the numbers 1-25, we will loop through the list using the  
+
In this example, we use the next list item to populate a list, and we will use the alert command from the flow commands to create an alert from each list item.
$next list item function:
+
  
[[File:nextlistitem.png]]
+
add list to list(%my list, $list from text("hello,hi,how are ya", ","), "Delete", "Global")
 +
[[File:nextlistitem.jpg]]
  
We will create the [[loop command]] using the [[$List total|$list total function]]:
+
We are populating our list with a list created from text we typed into the list from text command. Our delimiter is the comma.
  
[[File:nextlistitem0.png]]
+
set list position(%my list, 0)
 +
[[File:nextlistitem0.jpg]]
  
Inside the loop we will use an [[if then else command]] to set a condition.
+
We are then setting the list position for our list to 0 so that the list starts from the beginning each time the script is run.
In this case we will simply stop the script when the list item is greater than 15:
+
  
[[File:nextlistitem1.png]]
+
loop($list total(%my list)){alert($next list item(%my list))}
  
Place an if/then node in the scripting area and click on the qualifier place holder to
+
[[File:nextlistitem1.jpg]]
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 variable 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. 
+
  
 +
This loop is set to loop according to the number of items in our list. Notice the list item inside the alert command. Each loop will pop up each list item from the list and stop when all list items have been shown.
  
 
== Additional Information ==
 
== Additional Information ==

Revision as of 20:49, 10 October 2012

$next list item is a Variable Function. 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

In this example, we use the next list item to populate a list, and we will use the alert command from the flow commands to create an alert from each list item.

add list to list(%my list, $list from text("hello,hi,how are ya", ","), "Delete", "Global") File:Nextlistitem.jpg

We are populating our list with a list created from text we typed into the list from text command. Our delimiter is the comma.

set list position(%my list, 0) File:Nextlistitem0.jpg

We are then setting the list position for our list to 0 so that the list starts from the beginning each time the script is run.

loop($list total(%my list)){alert($next list item(%my list))}

File:Nextlistitem1.jpg

This loop is set to loop according to the number of items in our list. Notice the list item inside the alert command. Each loop will pop up each list item from the list and stop when all list items have been shown.

Additional Information

It is important to note that if you place a set list position command just above the loop command 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