mirror of https://github.com/OpenMW/openmw.git
Merge branch 'ui_pairs' into 'master'
Implement pairs and ipairs for ui.content and ui.layers. Document all iterable types in a uniform way. See merge request OpenMW/openmw!1643C++20
commit
ff7ac7192b
@ -0,0 +1,50 @@
|
||||
Iterable types
|
||||
==============
|
||||
|
||||
List Iterable
|
||||
-------------
|
||||
|
||||
An iterable with defined size and order.
|
||||
|
||||
.. code-block:: Lua
|
||||
|
||||
-- can iterate over the list with pairs
|
||||
for i, v in pairs(list) do
|
||||
-- ...
|
||||
end
|
||||
|
||||
.. code-block:: Lua
|
||||
|
||||
-- can iterate over the list with ipairs
|
||||
for i, v in ipairs(list) do
|
||||
-- ...
|
||||
end
|
||||
|
||||
.. code-block:: Lua
|
||||
|
||||
-- can get total size with the size # operator
|
||||
local length = #list
|
||||
|
||||
.. code-block:: Lua
|
||||
|
||||
-- can index the list with numbers
|
||||
for i = 1, length do
|
||||
list[i]
|
||||
end
|
||||
|
||||
Map Iterable
|
||||
------------
|
||||
|
||||
An iterable with undefined order.
|
||||
|
||||
.. code-block:: Lua
|
||||
|
||||
-- can iterate over the map with pairs
|
||||
for k, v in pairs(map) do
|
||||
-- ...
|
||||
end
|
||||
|
||||
.. code-block:: Lua
|
||||
|
||||
-- can index the map by key
|
||||
map[key]
|
Loading…
Reference in New Issue