Script category

Related help topics

Creating Gameplay > Communicating between Flow and Lua

Nodes

Script Call Global This node calls a named global function in the Lua environment.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Variables
		Function		string	The name of the function that will be called.
Inputs
generic		Arg 1			The first argument value passed to the function.
generic		Arg 2			The second argument value passed to the function.
generic		Arg 3			The third argument value passed to the function.
generic		Arg 4			The fourth argument value passed to the function.
generic		Arg 5			The fifth argument value passed to the function.
event		In			This event triggers the evaluation of this node.

Any argument values you pass in to this node are passed on to the function as a variable-length list of arguments, in the ... Lua variable. You can get this argument list as a table by enclosing it in curly braces, like this: {...}. Therefore, you can iterate through the arguments in your function as follows:

function myGlobalFunction(...)
    for index, argument in ipairs( {...} ) do
        -- handle each argument value, such as by assigning them to a local variable
    end
end

You can also get one or more argument values from the list by calling the Lua select() function. For example:

function myGlobalFunction(...)
    local first_arg, second_arg, third_arg = select(1, ...)
    local fourth_arg = select(4, ...)
end

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Script Do String This node runs a block of Lua code that you set directly on the node.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Variables
		Script		string	The script that will be run.
Inputs
generic		Arg 1			The first argument available in the code block.
generic		Arg 2			The second argument available in the code block.
generic		Arg 3			The third argument available in the code block.
generic		Arg 4			The fourth argument available in the code block.
generic		Arg 5			The fifth argument available in the code block.
event		In			This event triggers the evaluation of this node.

Any argument values you pass in to this node are available as a variable-length list of arguments, in the ... Lua variable. You can get this argument list as a table by enclosing it in curly braces, like this: {...}. Therefore, you can iterate through the arguments in your code block as follows:

for index, argument in ipairs( {...} ) do
    -- handle each argument value, such as by assigning them to a local variable
end

You can also get one or more argument values from the list by calling the Lua select() function. For example:

local first_arg, second_arg, third_arg = select(1, ...)
local fourth_arg = select(4, ...)

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.