Home Reference HScript commands 

opspare hscript command

Add, remove or list spare parameters in an operator.

Usages

  1. opspare -a [-l label] [-s size] [-r start end] [-v defaults] sparename operators ...

  2. opspare -d sparename operators ...

  3. opspare [-n] operators ...

Spare parameters can be added to an operator for extra control. Unlike creating new parameters for Operator Types, creating a spare parameter only adds the parameter to the node (or nodes) specified, not all nodes of that type.

Spare parameters can be keyframed, referenced and added to Takes. Unless referenced by a node parameter, spare parameters are ignored by the node they are attached to.

There are three different usages of opspare. The first, opspare -a, adds a new spare parameter to a node. The second, opspare -d, deletes a spare parameters from a node (you cannot delete real parameters). The third, opspare without -a or -d, lists all the spare parameters in the node.

Options

-a

Add a new spare parameter.

-d

Delete a spare parameter. Cannot be used with other flags.

-n

When listing spare parameters, include the node they belong to in the list. Cannot be used with -a or -d.

-l label

Add a more descriptive label to the parameter, which will be shown in the parameter dialog. Spaces can be used if the label is double quoted (ie “Two Words”).

-r start end

Specifies the start and end range for sliders.

-s size

Specifies the number of fields in the parameter (1-16).

-t type

Sets the parameter type, which can be one of:

  • float

  • int

  • toggle

  • string

  • color

  • angle

  • xyz

  • uvw

-v defaults

Sets the default value(s). For more than one value (if the size is greater than 1), leave spaces between the values and double quote the list (ie “0.5 1 0.5”). For string defaults with spaces, single quote the string (ie “one 'two words' three”).

Examples

opspare -a -t xyz -s 3 -l "Center of Mass" -v "0 0 0" compos geo1
opspare -a spare /obj/light*
opspare -d spare light1
opspare /obj/light*

Replaced by