WoW:API ipairs: Difference between revisions

750 bytes added ,  15 August 2023
m
Move page script moved page API ipairs to WoW:API ipairs without leaving a redirect
No edit summary
 
m (Move page script moved page API ipairs to WoW:API ipairs without leaving a redirect)
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
Wrapper for lua function ipairs(t):
{{luaapi}}
Returns an iterator triple that allows the Lua for loop to iterate over the array portion of a table.
iteratorFunc, table, startState = ipairs(table)


Used in loop constructs to iterate through the values of a table where there is no index (an array).
== Example ==
 
  local fruits={"apple","orange","banana","kiwi"}
Example:
 
  local fruits={"apple","orange","banana",kiwi"}


  for index,value in ipairs(fruits) do  
  for index,value in ipairs(fruits) do  
Line 19: Line 18:


would be output to the chat window.
would be output to the chat window.
Note that ipairs() starts at index 1 and stops counting as soon as it reaches a nil value. Example:
> t = { [0]      = "zero",  --will not be counted
        [1]      = "one",    --will be counted; 1
        [2]      = "two",    --will be counted; 2
        [3]      = "three",  --will be counted; 3
        ["four"] = "four",  --will not be counted; returns 3
        [5]      = "five" }  --will never be reached
> for i,v in ipairs(t) do print(i..":"..v) end
1:one
2:two
3:three
Note that t[0] is never reached because it starts counting at [1], t["four"] is never reached because it is not an array index, and t[5] is never reached because the iterator ceases when it checks t[4] and finds a nil value.
Anonymous user