Module:UtilsVar: Difference between revisions
Jump to navigation
Jump to search
PhantomCaleb (talk | contribs) No edit summary |
PhantomCaleb (talk | contribs) (Future-proofing in case the extension is no longer available) |
||
(5 intermediate revisions by the same user not shown) | |||
Line 4: | Line 4: | ||
function p.set(name, val) | function p.set(name, val) | ||
-- Future-proofing in case the extension is no longer available | |||
if not VariablesLua then | |||
return nil | |||
end | |||
local json = mw.text.jsonEncode(val) | local json = mw.text.jsonEncode(val) | ||
VariablesLua.vardefine(name, json) | VariablesLua.vardefine(name, json) | ||
Line 9: | Line 14: | ||
function p.get(name) | function p.get(name) | ||
if not VariablesLua then | |||
return nil | |||
end | |||
local json = VariablesLua.var(name) | local json = VariablesLua.var(name) | ||
if json == "" then | if json == "" then | ||
Line 18: | Line 27: | ||
function p.add(name, val) | function p.add(name, val) | ||
if not VariablesLua then | |||
return nil | |||
end | |||
local array = p.get(name) or {} | local array = p.get(name) or {} | ||
table.insert(array, val) | table.insert(array, val) | ||
Line 24: | Line 37: | ||
end | end | ||
function p.counter(name) | function p.counter(name, limit) | ||
if not VariablesLua then | |||
return { | |||
increment = function() return 0 end, | |||
value = function() return 0 end, | |||
} | |||
end | |||
name = name or "" | name = name or "" | ||
return { | return { | ||
Line 31: | Line 51: | ||
val = val + 1 | val = val + 1 | ||
p.set(name, val) | p.set(name, val) | ||
return val | |||
end, | end, | ||
value = function() | value = function() | ||
return p.get(name) or 0 | return p.get(name) or 0 | ||
end | end, | ||
limit = limit | |||
} | } | ||
end | end | ||
return p | return p |
Latest revision as of 13:06, 17 October 2022
This module allows for data to be shared between invocations of a module on a given page, using Extension:VariablesLua. Use cases for this include counters and previewing Cargo storage.
Not to be confused with Module:UtilsArg.
local p = {}
VariablesLua = mw.ext.VariablesLua
function p.set(name, val)
-- Future-proofing in case the extension is no longer available
if not VariablesLua then
return nil
end
local json = mw.text.jsonEncode(val)
VariablesLua.vardefine(name, json)
end
function p.get(name)
if not VariablesLua then
return nil
end
local json = VariablesLua.var(name)
if json == "" then
return nil
end
local val = mw.text.jsonDecode(json)
return val
end
function p.add(name, val)
if not VariablesLua then
return nil
end
local array = p.get(name) or {}
table.insert(array, val)
p.set(name, array)
return array
end
function p.counter(name, limit)
if not VariablesLua then
return {
increment = function() return 0 end,
value = function() return 0 end,
}
end
name = name or ""
return {
increment = function()
local val = p.get(name) or 0
val = val + 1
p.set(name, val)
return val
end,
value = function()
return p.get(name) or 0
end,
limit = limit
}
end
return p