Adds a new user parameter to the collection.
"userParameters_var" is a variable referencing a UserParameters object. |
"userParameters_var" is a variable referencing a UserParameters object. |
| Type | Description |
| UserParameter | Returns the newly created UserParameter or null if the creation failed. |
| Name | Type | Description |
| name | string | The name of the parameter. This is the name shown in the parameters dialog |
| value | ValueInput | ValueInput object that specifies the value of the parameter. If the ValueInput was created using a real, the value will be interpreted using the internal unit for the unit type specified by the "units" argument. For example, if the ValueInput was created using the real value 5 and the input to the "units" argument is any valid length unit, the value will be interpreted as 5 centimeters since centimeters is the internal unit for lengths. If the "units" argument is a valid angle unit the value will be interpreted as 5 radians. If the ValueInput was created using a string, the string is used as-is for the expression of the parameter. This means if there are units as part of the string it must evaluate to the same unit type as that specified by the "units" argument and if no units are specified it will use the current default units specified for the current document. For example, if the ValueInput was created with the string "5 in", then the "units" argument must define any valid length so they are compatible. If the ValueInput was created with the string "5", any unit type can be used and the result will be 5 of that unit. When using a ValueInput created using a string, it's the same as creating a parameter in the user-interface. You can specify any valid expression, i.e. "5", "5 in", "5 in / 2", "5 + Length", etc. and you can choose from many different types of units. The only requirement is that the units must match in type. For example, they must both be lengths, or they must both be angles. |
| units | string | The units to use for the value of the parameter. Units specified must match the units specified (if any) in the ValueInput object. To create a parameter with no units you can specify either an empty string. |
| comment | string | The comment to display in the parameters dialog. Specify an empty string ("") for no comment |