Storage module API (require “storage”)

get_bool( key ), get_number( key ), get_string( key ), get_table( key )

Get <value from storage with corresponding key.

Call
Example

Edit

storage.get_***( key )

params: key – string
return: value if it exists and can be converted to specified type, nil otherwise

Edit

				
					require "storage"
local val = storage.get_number("Pi")

set_bool( key, value )

Put bool value to storage with corresponding key

Call
Example

Edit

storage.set_bool( key, value )

params: key – string, value – bool
return: none

Edit

				
					require "storage"
storage.set_bool("IsNodeAdded", true)
print(storage.get_bool("IsNodeAdded")) -- output: true

set_string( key, value )

Put string value to storage with corresponding key

Call
Example

Edit

storage.set_string( key, value )

params: key – string, value – string
return: none

Edit

				
					require "storage"
storage.set_string("MainItemName", "zyz")
print(storage.get_string("MainItemName")) -- output: zyz

set_number( key, value )

Put number value to storage with corresponding key

Call
Example

Edit

storage.set_number( key, value )

params: key – string, value – number
Note, lua has ‘number’ type but it can can be in integer state. The difference between states are in conversion to string and printing. storage.set_number saves value in integer state if possible. See example for details.
return: none

Edit

				
					require "storage"
storage.set_number("ItemsCount", 50)
print(storage.get_number("ItemsCount")) -- output: 50

storage.set_number("Pi", 3.14159)
print(storage.get_number("Pi")) -- output: 3.14159

storage.set_number("AverageTemperature", 20.0)
print(storage.get_number("AverageTemperature")) -- output: 20 (not 20.0)

set_table( key, value )

Put table value to storage with corresponding key

Call
Example

Edit

storage.set_table( key, value )

params: key – string, value – table
Supported table key types: string, number, bool Supported table value types: string, number, bool, table. Number values are saved as integer if possible (see storage.set_number for details).
Note, recurse tables and metatables are not supported.
return: none

Edit

				
					require "storage"
storage.set_table("ItemData", {
        name = "xyz",
        type = "switch"
    })

storage.set_table("SomeData", {
        name = "xyz",
        [1] = true,
        [3] = false,
        [true] = {
            [1.1] = 7
        }
    })

local result = storage.get_table("SomeData")
print(result.name)       -- output: xyz
print(result[1])         -- output: true
print(result[true][1.1]) -- output: 7

exists( key )

Check if key is set.

Call
Example

Edit

storage.exists( key )

params: key – string
return: true if key is set, false otherwise

Edit

				
					require "storage"
if storage.exists("Pi") then
    print("Pi is stored")
else
    print("Pi is not stored")
end

delete( key )

Delete value from storage marked with key. Function has no effect if key does not exist.

Call
Example

Edit

storage.delete( key )

params: key – string
return: none

Edit

				
					require "storage"

storage.delete("Pi")

delete_all()

Clear storage. Deletes all key/value pairs from current volume

Call
Example

Edit

storage.delete_all()

params: none
return: none

Edit

				
					require "storage"
storage.delete_all()