add-parameter

Add Parameter Code Generator

Generate PySBS code to add an input parameter to a Substance graph.

Task

Based on $ARGUMENTS, generate Python code to add the specified parameter type.

Quick Reference

Widget Types

Widget	Type	Use Case
SLIDER_FLOAT1	float	0-1 values
SLIDER_INT1	int	Count, index
COLOR_FLOAT3	RGB	Color picker
COLOR_FLOAT4	RGBA	Color with alpha
BUTTON_BOOL	bool	Toggle
DROPDOWN_INT1	int	Mode selection
ANGLE_FLOAT1	float	Rotation
POSITION_FLOAT2	[x,y]	0-1 position

Basic Pattern

from pysbs import sbsenum

param = graph.addInputParameter(
    aIdentifier='intensity',
    aWidget=sbsenum.WidgetEnum.SLIDER_FLOAT1,
    aDefaultValue=0.5,
    aLabel='Intensity',
    aGroup='Settings',
    aOptions={
        sbsenum.WidgetOptionEnum.MIN: 0.0,
        sbsenum.WidgetOptionEnum.MAX: 1.0
    }
)

Link to Node

# Create dynamic link
dyn = node.setDynamicParameter(sbsenum.CompNodeParamEnum.OPACITY)
dyn.setToInputParam(graph, aInputParamIdentifier='intensity')

# Or expose directly
graph.exposeAsInputParameter(aDoc=doc, aNode=node, aIdentifier='opacity')

Conditional Visibility

param = graph.addInputParameter(
    aIdentifier='sub_param',
    aWidget=sbsenum.WidgetEnum.SLIDER_FLOAT1,
    aDefaultValue=0.5,
    aVisibleIf='enabled'  # Show when 'enabled' is true
)

Additional Resources

• For complete widget reference, see references/parameter-reference.md