In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
-addRule(-add)
|
string
|
|
|
Add a rule with the argument name to the list of rules, as the
highest-priority rule. If this flag is used, the pattern, extension, and
colorSpace flags must be used as well, to specify the file rule pattern,
extension, and color space, respectively.
|
|
-colorSpace(-cs)
|
string
|
|
|
The input color space for the rule. If the rule matches a file path, this
is the color space that is returned. This color space must match an existing
color space in the input color space list.
|
|
-colorSpaceDescription(-csd)
|
string
|
|
|
Returns the description for a specific color space.
In query mode, this flag needs a value.
|
|
-colorSpaceFamilies(-csf)
|
string
|
|
|
Returns the list of families for a specific color space. Used to add submenus
when populating the color spaces UI popup of a rule.
In query mode, this flag needs a value.
|
|
-colorSpaceNames(-csn)
|
|
|
|
Returns the list of available color spaces. Used to populate the color
spaces UI popup of a rule.
|
|
-down(-dwn)
|
string
|
|
|
Move the rule with the argument name down one position towards lower priority.
|
|
-enabled(-ena)
|
boolean
|
|
|
Are the file rules enabled?
|
|
-evaluate(-ev)
|
string
|
|
|
Evaluates the list of rules and returns the input color space name that
corresponds to the argument file path.
|
|
-extension(-ext)
|
string
|
|
|
The file extension for the rule is case insensitive
|
|
-listRules(-lsr)
|
|
|
|
Returns an array of rule name strings, in order, from lowest-priority (rule 0)
to highest-priority (last rule in array).
|
|
-load(-ld)
|
|
|
|
Read the rules from Maya preferences. Any existing rules are cleared.
|
|
-moveUp(-up)
|
string
|
|
|
Move the rule with the argument name up one position towards higher priority.
|
|
-pattern(-pat)
|
string
|
|
|
The file path pattern for the rule. This is the substring to match in the
file path, expressed as a glob pattern: for example, '*' matches all files.
For more information about glob pattern syntax, see
http://en.wikipedia.org/wiki/Glob_%28programming%29.
|
|
-remove(-rm)
|
string
|
|
|
Remove the rule with the argument name from the list of rules.
|
|
-restoreDefaults(-rde)
|
|
|
|
Restore the list of rules to the default ones only.
|
|
-save(-sav)
|
|
|
|
Save the rules to Maya preferences.
|
|