doc/lua: Lua API name consistency

This commit updates the documentation of the SCFlow* function names
available to Lua scripts.

Formerly, they used the prefix "Sc"; now they use "SC".
pull/5727/head
Jeff Lucovsky 4 years ago committed by Victor Julien
parent c845974639
commit 25e9483168

@ -879,39 +879,39 @@ index so in our case we need to use 0.
:: ::
function match(args) function match(args)
a = ScFlowintGet(0); a = SCFlowintGet(0);
if a then if a then
ScFlowintSet(0, a + 1) SCFlowintSet(0, a + 1)
else else
ScFlowintSet(0, 1) SCFlowintSet(0, 1)
end end
ScFlowintGet SCFlowintGet
~~~~~~~~~~~~ ~~~~~~~~~~~~
Get the Flowint at index given by the parameter. Get the Flowint at index given by the parameter.
ScFlowintSet SCFlowintSet
~~~~~~~~~~~~ ~~~~~~~~~~~~
Set the Flowint at index given by the first parameter. The second parameter is the value. Set the Flowint at index given by the first parameter. The second parameter is the value.
ScFlowintIncr SCFlowintIncr
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
Increment Flowint at index given by the first parameter. Increment Flowint at index given by the first parameter.
ScFlowintDecr SCFlowintDecr
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
Decrement Flowint at index given by the first parameter. Decrement Flowint at index given by the first parameter.
ScFlowvarGet SCFlowvarGet
~~~~~~~~~~~~ ~~~~~~~~~~~~
Get the Flowvar at index given by the parameter. Get the Flowvar at index given by the parameter.
ScFlowvarSet SCFlowvarSet
~~~~~~~~~~~~ ~~~~~~~~~~~~
Set a Flowvar. First parameter is the index, second is the data Set a Flowvar. First parameter is the index, second is the data
@ -929,13 +929,13 @@ You can use it to set string
end end
function match(args) function match(args)
a = ScFlowvarGet(0); a = SCFlowvarGet(0);
if a then if a then
a = tostring(tonumber(a)+1) a = tostring(tonumber(a)+1)
ScFlowvarSet(0, a, #a) SCFlowvarSet(0, a, #a)
else else
a = tostring(1) a = tostring(1)
ScFlowvarSet(0, a, #a) SCFlowvarSet(0, a, #a)
end end
Misc Misc

Loading…
Cancel
Save