ジャンプ先: 概要. 戻り値. フラグ. Python 例.

概要

help( [string] , [documentation=boolean], [language=string], [list=boolean], [popupDisplayTime=uint], [popupMode=boolean], [popupPauseTime=uint], [popupSimpleMode=boolean], [rolloverMode=boolean], [syntaxOnly=boolean])

注: オブジェクトの名前と引数を表す文字列は、カンマで区切る必要があります。これはシノプシスに示されていません。

help は、取り消し可能、照会可能、および編集不可能です。

引数がない場合、ヘルプにはヘルプの使用方法が表示されます。コマンド名を指定すると、ヘルプはそのコマンドのクイック ヘルプを返します。他のフラグは、オンライン マニュアルを開いたり、使用可能なコマンドをパターンに基づいてリストしたりするために使うことができます。

パターンは次の構文に従います。 

*            任意の文字列に一致
?            任意の文字に一致
[agj]        a、g または j に一致
[^0-9]       数字以外に一致
x+           すぐ次の任意の数の x に一致
a{3}         aaa に一致
a{3,}        aaa、aaaa、...に一致
a{3,5}       aaa、aaaa、または aaaaa に一致
(ab)(CD)\2\1 abCDCDab に一致(\1～\9 が使用可能)

戻り値

なし

照会モードでは、戻り値のタイプは照会されたフラグに基づきます。

フラグ

documentation, language, list, popupDisplayTime, popupMode, popupPauseTime, popupSimpleMode, rolloverMode, syntaxOnly
ロング ネーム(ショート ネーム) 引数タイプ プロパティ
list(l) boolean create
名前が正規表現に一致するコマンドをすべてリスト表示します。正規表現を最初の引数として指定したコマンドに渡します。
documentation(doc) boolean create
ブラウザを使用し、指定した 1 つのコマンド名に関連したマニュアルを表示します。パターンをこのフラグと一緒に使うことはできません。コマンド名が指定されていない場合、このフラグはマニュアルのメイン インデックスに進みます。
language(lng) string create
このコマンドのヘルプを指定した言語で表示します。有効な値は、「mel」と「python」です。既定は Mel です。doc フラグと一緒に使用します。
syntaxOnly(so) boolean create
その他のフラグを指定しないと、クイック ヘルプの構文部分のみを返します。
popupMode(pm) boolean createquery
ポップアップ ヘルプ モードをオンまたはオフにします。このフラグは、list フラグと doc フラグとは相互に排他的です。
popupSimpleMode(psm) boolean createquery
簡易ポップアップ ヘルプ モードをオンまたはオフにします。設定すると、ツールクリップに名前とキーボード ショートカットだけが表示されます。
popupPauseTime(ppt) uint createquery
ポップアップ ヘルプが表示されるまでの時間をミリ秒単位で設定します。既定は 800 ミリ秒です。このフラグは、list フラグと doc フラグとは相互に排他的です。
popupDisplayTime(pdt) uint createquery
ポップアップ ヘルプが表示される時間を秒単位で設定します。既定は 4 秒です。このフラグは、list フラグと doc フラグとは相互に排他的です。
rolloverMode(rm) boolean createquery
ロールオーバー ヘルプ モードをオンまたはオフにします。このフラグは、list フラグと doc フラグとは相互に排他的です。
フラグはコマンドの作成モードで表示できます フラグはコマンドの編集モードで表示できます
フラグはコマンドの照会モードで表示できます フラグに複数の引数を指定し、タプルまたはリストとして渡すことができます。

Python 例

import maya.cmds as cmds

# List all commands starting with a, b or c
cmds.help( '[a-c]*', list=True )

# List all commands without vowels!
cmds.help( '[^aeiou]+', list=True )

# Print a message explaining how to use help
cmds.help()

# Bring up the main on-line help index
cmds.help( doc=True)

# Bring up the Python version of command documentation for the polySphere
# command
cmds.help( language='python', doc='polySphere' )

# Bring up the on-line help for the disable command.
cmds.help( 'disable', doc=True )