Eyeon:Script/Reference/Applications/Fusion/Classes/Fusion/GetRegSummary

From VFXPedia

Jump to: navigation, search

Contents

Fusion : GetRegSummary

Usage

value = Fusion:GetRegSummary(filter)


Arguments

  • filter [optional, constant]

A filter to be applied to the results. This is usually a constant, taken from the list of valid constants found in the documentation for Fusion:FindReg. If this argument is nil, it returns a table containing a summary of all current registry items.


Returns

  • value [table]

A table containing a summary of the Name, ID, ClassType, and OpIconString of every item in the registry. Useful for returning a lightweight version of the information presented by Fusion:GetRegList.


Remarks

This function is useful for getting the full table of global preferences, or a subtable, or a specific value.


Examples

The following example could be entered in the console to return a list of the names of all tools in Fusion.

for i, reg in fusion:GetRegSummary(CT_Tool) do print(reg.REGS_Name) end


Tips for GetRegSummary (edit)

EyeonTips:Script/Reference/Applications/Fusion/Classes/Fusion/GetRegSummary