Returns the index'th argument of the specified flag as an MTime. Raises RuntimeError if the flag has been enabled for multi-use.
OpenMaya.MArgParser.flagArgumentString
(
)
flagArgumentString(flagName, argIndex) -> string
Returns the specified argument of the specified single-use flag as
a string.
Signature:
flagArgumentString(flag, index)
Parameters:
flag - string
index - int
Returns:
string
Description:
Returns the index'th argument of the specified flag as a string. Raises RuntimeError if the flag has been enabled for multi-use.
OpenMaya.MArgParser.getFlagArgumentList
(
)
getFlagArgumentList(flagName, occurrence) -> MArgList
Returns the arguments for the specified occurrence of the given
multi-use flag as an MArgList. Raises RuntimeError if the flag has
not been enabled for multi-use. Raises IndexError if occurrence is
out of range.
Returns the arguments for the specified occurrence of the given multi-use flag as an MArgList. Raises RuntimeError if the flag has not been enabled for multi-use. Raises IndexError if occurrence is out of range.
OpenMaya.MArgParser.getFlagArgumentPosition
(
)
getFlagArgumentPosition(flagName, occurrence) -> int
Returns the position in the argument list of the specified occurrence
of the given flag. Raises IndexError if occurrence is out of range.
Signature:
getFlagArgumentPosition(flag, occurrence)
Parameters:
flag - string
index - int
Returns:
int
Description:
Returns the position in the argument list of the specified occurrence of the given flag. Raises IndexError if occurrence is out of range.
OpenMaya.MArgParser.getObjectStrings
(
)
getObjectStrings() -> tuple of unicode strings
If the command's MSyntax has set the object format to kStringObjects
then this method will return the objects passed to the command as a
tuple of strings. If any other object format is set then an empty
tuple will be returned.
If the command's MSyntax has set the object format to kStringObjects then this method will return the objects passed to the command as a tuple of strings. If any other object format is set then an empty tuple will be returned.
OpenMaya.MArgParser.isFlagSet
(
)
isFlagSet(flagName) -> bool
Returns True if the given flag appears on the command line.
Signature:
isFlagSet(flag)
Parameters:
flag - string
Returns:
bool
Description:
Returns True if the given flag appears on the command line.
OpenMaya.MArgParser.numberOfFlagUses
(
)
numberOfFlagUses(flagName) -> int
Returns the number of times that the flag appears on the command
line.
Signature:
numberOfFlagUses(flag)
Parameters:
flag - string
Returns:
int
Description:
Returns the number of times that the flag appears on the command line.
Property Documentation
OpenMaya.MArgParser.isEdit
static
True if the edit flag is present.
Name:
isEdit
Type:
bool
Access:
R
Description:
True if the -edit flag is present.
OpenMaya.MArgParser.isQuery
static
True if the query flag is present.
Name:
isQuery
Type:
bool
Access:
R
Description:
True if the -query flag is present.
OpenMaya.MArgParser.numberOfFlagsUsed
static
Number of different flags used on the command line. If the same flag appears multiple times it is only counted once.
Name:
numberOfFlagsUsed
Type:
int
Access:
R
Description:
Number of different flags used on the command line. If the same flag appears multiple times it is only counted once.
The documentation for this class was generated from the following files: