Basic lua: Tables: Difference between revisions
From The Official Visionaire Studio: Adventure Game Engine Wiki
No edit summary |
No edit summary |
||
| (18 intermediate revisions by the same user not shown) | |||
| Line 103: | Line 103: | ||
{| class="ts" | {| class="ts" | ||
|- | |- | ||
! keyword tables with | ! keyword tables with index based sub-arrays containing keywords!! | ||
|- | |- | ||
| style="max-width:680px;" | <syntaxhighlight lang="lua"> | | style="max-width:680px;" | <syntaxhighlight lang="lua"> | ||
| Line 127: | Line 127: | ||
Below are various table functions & advanced methods for interacting with tables. | Below are various table functions & advanced methods for interacting with tables. | ||
=== | === Table Concatenation === | ||
{| class="ts" | |||
|- | |||
! table concatenation without any formatting (index tables only) !! | |||
|- | |||
| style="max-width:680px;" | <syntaxhighlight lang="lua"> | |||
local t = {1, 2, 3, 4} | |||
print( table.concat(t) ) | |||
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(tables)_6.png|frameless|center|180px]] | |||
|} | |||
<hr> | |||
{| class="ts" | |||
|- | |||
! table concatenation with formatting (index tables only) !! | |||
|- | |||
| style="max-width:680px;" | <syntaxhighlight lang="lua"> | |||
local t = {1, 2, 3, 4} | |||
print( table.concat(t, ", ") ) | |||
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(tables)_7.png|frameless|center|180px]] | |||
|} | |||
<hr> | |||
{| class="ts" | |||
|- | |||
! table concatenation with formatting & specified table index range (index tables only) !! | |||
|- | |||
| style="max-width:680px;" | <syntaxhighlight lang="lua"> | |||
local t = {1, 2, 3, 4} | |||
print( table.concat(t, ", ", 2, 4) ) | |||
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(tables)_8.png|frameless|center|180px]] | |||
|} | |||
=== Table Insert === | |||
{| class="ts" | |||
|- | |||
! insert a value into index position 2 in the specified table (index tables only) !! | |||
|- | |||
| style="max-width:680px;" | <syntaxhighlight lang="lua"> | |||
local t = {"one", "three"} | |||
print("before: " .. table.concat(t, ", ") ) | |||
table.insert(t, 2, "two") -- insert "two" into index position 2 | |||
print("after: " .. table.concat(t, ", ") ) | |||
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(tables)_9.png|frameless|center|180px]] | |||
|} | |||
<hr> | |||
{| class="ts" | |||
|- | |||
! append a value to the end of the specified table (index tables only) !! | |||
|- | |||
| style="max-width:680px;" | <syntaxhighlight lang="lua"> | |||
local t = {"one", "two", "three"} | |||
print("before: " .. table.concat(t, ", ") ) | |||
table.insert(t, "four") -- insert "four" at the end of the table | |||
print("after: " .. table.concat(t, ", ") ) | |||
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(tables)_10.png|frameless|center|180px]] | |||
|} | |||
<hr> | |||
{| class="ts" | |||
|- | |||
! insert a keyword & value into a table !! | |||
|- | |||
| style="max-width:680px;" | <syntaxhighlight lang="lua"> | |||
local t = { | |||
["one"] = 1, | |||
["three"] = 3 | |||
} | |||
local str = "" -- init str variable | |||
for k, v in pairs(t) do str = (str .. v .. " ") end -- concatenate data | |||
print("before: " .. str) | |||
t["two"] = 2 -- insert key "two" along with a value into the t table | |||
str = "" -- reset str | |||
for k, v in pairs(t) do str = (str .. v .. " ") end -- concatenate data | |||
print("after: " .. str) | |||
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(tables)_11.png|frameless|center|180px]] | |||
|} | |||
<hr> | |||
{| class="ts" | |||
|- | |||
| ''Quick note: Technically it's possible to mix & match keyword & index tables, but it's cleaner & less confusing all around if you don't. However feel free to use index values inside of sub-arrays if you don't want to use keywords, or keywords in sub-arrays of index tables.'' | |||
|} | |||
<hr> | |||
=== Table Remove === | |||
{| class="ts" | |||
|- | |||
! remove entry from table (index table only) !! | |||
|- | |||
| style="max-width:680px;" | <syntaxhighlight lang="lua"> | |||
local t = {1, 2, 3, 4} | |||
print("before: " .. table.concat(t, ", ") ) | |||
table.remove(t, 3) -- remove index value 3 from the table | |||
print("after: " .. table.concat(t, ", ") ) | |||
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(tables)_12.png|frameless|center|180px]] | |||
|} | |||
<hr> | |||
{| class="ts" | |||
|- | |||
| ''Quick note: Whenever you insert a new index entry into a table containing index values it will automatically adjust all of the index values; the same thing also happens whenever you remove an entry.'' | |||
|} | |||
<hr> | |||
{| class="ts" | |||
|- | |||
! remove keyword entry from specified table !! | |||
|- | |||
| style="max-width:680px;" | <syntaxhighlight lang="lua"> | |||
local t = { | |||
["one"] = 1, | |||
["two"] = 2, | |||
["three"] = 3 | |||
} | |||
local str = "" | |||
for k, v in pairs(t) do str = (str .. v .. " ") end -- concatenate data | |||
print("before: " .. str) | |||
t["two"] = nil -- remove keyword from table by setting it as nil | |||
str = "" | |||
for k, v in pairs(t) do str = (str .. v .. " ") end -- concatenate data | |||
print("after: " ..str) | |||
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(tables)_13.png|frameless|center|180px]] | |||
|} | |||
=== Table Sort === | |||
{| class="ts" | |||
|- | |||
! sort index table alphabetically (ascending) !! | |||
|- | |||
| style="max-width:680px;" | <syntaxhighlight lang="lua"> | |||
local t = {"seven", "ate", "nine", "and", "one", "ran away" } | |||
print("before: " .. table.concat(t, ", ") ) | |||
table.sort(t) -- sort alphabetically (ascending a, b, c, etc) | |||
print("after: " .. table.concat(t, ", ") ) | |||
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(tables)_14.png|frameless|center|180px]] | |||
|} | |||
<hr> | |||
{| class="ts" | |||
|- | |||
| ''Quick note: Mixed data tables will return an error if you try to sort them with the table.sort function, the tables need to contain strings '''or''' numbers, & not both at the same time; however you can get around it by inserting the numbers in as strings.'' | |||
|} | |||
<hr> | |||
{| class="ts" | |||
|- | |||
! sort index table alphabetically (descending) !! | |||
|- | |||
| style="max-width:680px;" | <syntaxhighlight lang="lua"> | |||
local t = {"7", "ate", "9", "and", "1", "ran away" } | |||
print("before: " .. table.concat(t, ", ") ) | |||
table.sort(t, function(a, b) return a > b end) -- sort alphabetically (descending c, b, a, etc) | |||
print("after: " .. table.concat(t, ", ") ) | |||
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(tables)_15.png|frameless|center|180px]] | |||
|} | |||
=== Table Count === | |||
{| class="ts" | |||
|- | |||
! get total amount of entries in index table (current level) !! | |||
|- | |||
| style="max-width:680px;" | <syntaxhighlight lang="lua"> | |||
local t = {1, 2, 3, 4} | |||
print( #t ) | |||
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(tables)_16.png|frameless|center|180px]] | |||
|} | |||
<hr> | |||
{| class="ts" | |||
|- | |||
! get total amount of entries in keyword table (current level) !! | |||
|- | |||
| style="max-width:680px;" | <syntaxhighlight lang="lua"> | |||
local t = { | |||
["one"] = 1, | |||
["two"] = 4/2, | |||
["three"] = 3 | |||
} | |||
function countKeys(tbl) | |||
local keys = 0 -- init keys variable | |||
for k, v in pairs(tbl) do -- iterate through table | |||
keys = keys + 1 -- increment key value by 1 per key found | |||
end | |||
return keys -- return the total amount of keys found | |||
end | |||
print( countKeys(t) ) | |||
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(tables)_17.png|frameless|center|180px]] | |||
|} | |||
<hr> | <hr> | ||
{| class="in" | {| class="in" | ||
Latest revision as of 01:41, 4 September 2022
| < | Index | > |
Tables are one of the features of Lua script, that make the scripting language so dynamic & easy to use, as they allow us to easily create tables, insert, remove & sort data. Tables are often comprised of arrays that usually involve keywords - or an index number - & a value. Tables can be accessed using multiple different methods.
Creating Tables
Below I am going to show you how to create various different types of tables/arrays.
Index Tables
Keyword Tables
Index Values and Sub-Arrays
| auto generated index entries with sub-arrays containing keywords | |
|---|---|
local t = {
{x = 100, y = 300},
{x = 200, y = 111}
}
print("x = " .. t[1].x .. ", y = " .. t[1].y)
|
Keywords and Sub-Arrays
Advanced Methods and Table Functions
Below are various table functions & advanced methods for interacting with tables.
Table Concatenation
| table concatenation without any formatting (index tables only) | |
|---|---|
local t = {1, 2, 3, 4}
print( table.concat(t) )
|
| table concatenation with formatting (index tables only) | |
|---|---|
local t = {1, 2, 3, 4}
print( table.concat(t, ", ") )
|
| table concatenation with formatting & specified table index range (index tables only) | |
|---|---|
local t = {1, 2, 3, 4}
print( table.concat(t, ", ", 2, 4) )
|
Table Insert
| Quick note: Technically it's possible to mix & match keyword & index tables, but it's cleaner & less confusing all around if you don't. However feel free to use index values inside of sub-arrays if you don't want to use keywords, or keywords in sub-arrays of index tables. |
Table Remove
| Quick note: Whenever you insert a new index entry into a table containing index values it will automatically adjust all of the index values; the same thing also happens whenever you remove an entry. |
Table Sort
| Quick note: Mixed data tables will return an error if you try to sort them with the table.sort function, the tables need to contain strings or numbers, & not both at the same time; however you can get around it by inserting the numbers in as strings. |
Table Count
| get total amount of entries in index table (current level) | |
|---|---|
local t = {1, 2, 3, 4}
print( #t )
|
| < | Index | > |
















