Go to: Synopsis. Return value. Flags. Python examples.
optionVar([arraySize=string], [clearArray=string], [clearStash=string], [exists=string], [floatValue=[string, float]], [floatValueAppend=[string, float]], [intValue=[string, int]], [intValueAppend=[string, int]], [list=boolean], [remove=string], [removeFromArray=[string, int]], [stash=string], [stringValue=[string, string]], [stringValueAppend=[string, string]], [unstash=string], [version=int])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
optionVar is undoable, queryable, and NOT editable.
This command allows you to set and query variables which are
persistent between different invocations of Maya. These variables
are stored as part of the preferences.
| int | 0 or 1 for the exists option |
| string[] | When the list option is used |
In query mode, return type is based on queried flag.
arraySize, clearArray, clearStash, exists, floatValue, floatValueAppend, intValue, intValueAppend, list, remove, removeFromArray, stash, stringValue, stringValueAppend, unstash, version
| Long name (short name) |
Argument types |
Properties |
|
arraySize(arraySize)
|
string
|
|
|
returns the size of the array named "string". If no such
variable exists, it returns 0. If the variable is not an
array, it returns 1.
|
|
clearArray(ca)
|
string
|
|
|
If there is an array named "string", it is set to be empty.
Empty arrays are not saved.
|
|
clearStash(cs)
|
string
|
|
|
Clear backup copy of a variable.
|
|
exists(ex)
|
string
|
|
|
returns 1 if a variable named "string" exists, 0 otherwise.
All other flags will be ignored if this is used. (Query has
higher precedence)
|
|
floatValue(fv)
|
[string, float]
|
|
|
creates a new variable named "string" with double value "float".
If a variable already exists with this name, it is overridden
in favour of the new value (even if the type is different)
|
|
floatValueAppend(fva)
|
[string, float]
|
|
|
adds this value to the end of the array of floats named "string".
If no such array exists, one is created. If there was a float
value with this name before, it becomes the first element of the
array. If any other kind of value existed, it is overridden.
|
|
intValue(iv)
|
[string, int]
|
|
|
creates a new variable named "string" with integer value "int".
If a variable already exists with this name, it is overridden
in favour of the new value (even if the type is different).
|
|
intValueAppend(iva)
|
[string, int]
|
|
|
adds this value to the end of the array of ints named "string".
If no such array exists, one is created. If there was an int
value with this name before, it becomes the first element of the
array. If any other kind of value existed, it is overridden.
|
|
list(l)
|
boolean
|
|
|
this returns a list of all the defined variable names. All other
flags will be ignored if this one is used. (Query and exists flags
have a higher precedence).
|
|
remove(rm)
|
string
|
|
|
removes the variable named "string", if one exists.
Note: all removals are done before any value
setting, if both the -r and other (-sv, -iv, -fv) flags are
used in the same command.
|
|
removeFromArray(rfa)
|
[string, int]
|
|
|
removes the element numbered "int" in the array named "string".
Everything beyond it then gets shuffled down.
|
|
stash(st)
|
string
|
|
|
Make a backup copy of a variable.
|
|
stringValue(sv)
|
[string, string]
|
|
|
creates a new variable named using the first string with value given
by the second string.
If a variable already exists with this name, it is overridden
in favour of the new value (even if the type is different)
|
|
stringValueAppend(sva)
|
[string, string]
|
|
|
adds the value given by the second string to the end of the array of
strings named by the first string.
If no such array exists, one is created. If there was a string
value with this name before, it becomes the first element of the
array. If any other kind of value existed, it is overridden.
|
|
unstash(us)
|
string
|
|
|
Restore a variable from a backup copy.
|
|
version(v)
|
int
|
|
|
Preferences version number to warn about incompatbile preference
files
|
|
|
Flag can appear in Create mode of command
|
Flag can appear in Edit mode of command
|
Flag can appear in Query mode of command
|
Flag can have multiple arguments, passed either as a tuple or a list.
|
import maya.cmds as cmds
cmds.optionVar( iv=('defaultTriangles', 4), sv=('defaultFileName', 'buffalo.maya') )
cmds.optionVar( exists='defaultTriangles' )
# Result: 1 #
cmds.optionVar( q='defaultFileName' )
# Result: buffalo.maya #
cmds.optionVar( list=True )
cmds.optionVar( remove='defaultTriangles' )
cmds.optionVar( exists='defaultTriangles' )
# Result: 0 #