From VFXPedia

Contents 1 Tool : GetInputList 1.1 Summary 1.2 Arguments 1.3 Returns 1.4 Requirements 1.5 Examples 1.6 See Also 1.7 Tips for GetInputList (edit)

Tool : GetInputList

Summary

This function returns a list of Inputs for the specified tool. Inputs are the parameters that drive a tool, including all of the controls shown in the Controls View and on the Display.

Arguments

GetInputList(string input_type)

input_type (string, optional)

This argument can be used to filter the results to return only a specific datatype. Valid values include "Image", "Number", "Point", "Gradient" and "Text".

this argument was added in fusion 5.21

Returns

Returns a table containing handles all the Inputs (controls) available for the tool.

Requirements

• eyeonScript 5.0
• Fusion 5.0

Examples

-- this Tool script prints out the name 
-- of every control on the selected tool
 
x = tool:GetInputList()
 
for i, inp in pairs(x) do
  print(in:GetAttrs().INPS_Name)
end

See Also

GetOutputList()

Tips for GetInputList (edit)

• The input_type parameter can also be "Mask". However, this will also return the regular image inputs, since masks can be connected to them. Garbage matte inputs won't get returned by GetInputList("Image") though, so the "Mask" parameter might be useful occasionally. To retrieve the effect mask input, you need to scan the attributes of the returned inputs for INPS_ID == "EffectMask".