移動先: 概要 戻り値 フラグ. Python 例.

概要

help( [string] , [documentation=boolean], [language=string], [list=boolean], [popupDisplayTime=uint], [popupMode=boolean], [popupPauseTime=uint], [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, 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 フラグとは相互に排他的です。
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 )