Scripting API

Parameter Description

<<GenPreferences

Main Index

GetMaterial>>

GetCommandInfo

Back

This is the description of the command GetCommandInfo's parameter named Command Parameter Info Tuple:

Name	Script Name	Type	Description	Supports None	Default	Minimum	Maximum
Parameter Name	ParamName	String	Scripting name of parameter	No
Parameter Description	ParamDesc	String	Description of parameter	No
Parameter Type	ParamType	Integer	The type of the parameter being described	No	0	-2	2147483647
Default Integer	ParamDefaultInt	Integer	Integer parameter default value	No	0	-65535	2147483647
Minimum Integer	ParamMinInt	Integer	Integer parameter minimum value	No	0	-2147483647	2147483647
Maximum Integer	ParamMaxInt	Integer	Integer parameter maximum value	No	0	-65535	2147483647
Default Red	ParamDefaultRed	Integer	Color parameter default red value	No	0	-65535	2147483647
Default Blue	ParamDefaultBlue	Integer	Color parameter default blue value	No	0	-65535	2147483647
Default Green	ParamDefaultGreen	Integer	Color parameter default green value	No	0	-65535	2147483647
Default X	ParamDefaultPointX	Real	Point parameter default X value	No	0.0	-65535.0	2147483647.0
Default Y	ParamDefaultPointY	Real	Point parameter default Y value	No	0.0	-65535.0	2147483647.0
Default Real	ParamDefaultReal	Real	Real parameter default value	No	0.0	-65535.0	2147483647.0
Minimum Real	ParamMinReal	Real	Real parameter minimum value	No	0.0	-200000000000.0	2147483647.0
Maximum Real	ParamMaxReal	Real	Real parameter maximum value	No	0.0	-65535.0	400000000000.0
Default Left	ParamDefaultRectLeft	Real	Rect parameter default left value	No	0.0	-65535.0	2147483647.0
Default Right	ParamDefaultRectRight	Real	Rect parameter default right value	No	0.0	-65535.0	2147483647.0
Default Top	ParamDefaultRectTop	Real	Rect parameter default top value	No	0.0	-65535.0	2147483647.0
Default Bottom	ParamDefaultRectBottom	Real	Rect parameter default bottom value	No	0.0	-65535.0	2147483647.0
Default String	ParamDefaultString	String	String parameter default value	No
Is None	ParamIsNone	Integer	Parameter has no value	No	0	-65535	2147483647
Is Script	ParamIsScript	Integer	Parameter is a script	No	0	-65535	2147483647
Uses None	ParamUsesNone	Integer	Parameter uses none	No	0	-65535	2147483647
Is Optional	ParamIsOptional	Integer	Parameter is optional	No	0	-65535	2147483647
Localized Name	ParamLocalName	String	Localized name of parameter	No

Scripting API

Parameter Description