showHelp

ジャンプ先: 概要. 戻り値. キーワード. 関連. フラグ. Python 例.

概要

showHelp([string], [absolute=boolean], [docs=boolean], [helpTable=boolean], [version=boolean])

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

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

戻り値

なし

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

キーワード

関連

フラグ

ロング ネーム(ショート ネーム)	引数タイプ	プロパティ
absolute(a)	boolean
指定した「URL」は絶対 URL で、Web ブラウザへと直接渡されます。
docs(d)	boolean
オンライン マニュアルのルートに関連するヘルプ ファイルを直接指定します。
helpTable(ht)	boolean
このフラグを使用して、-d/docs フラグと -a/absolute フラグを使用していないときに、ヘルプ項目の検索に使うファイルを指定します。ファイル名のみを指定し、パスを指定していない場合、ファイルは Maya アプリケーション ディレクトリにあると仮定されます。 このフラグは、照会された場合は引数を受け取りません。 既定値は「helpTable」です。
version(v)	boolean
このフラグを使用して、showHelp コマンドが使用する Maya のバージョンを取得します。

フラグはコマンドの作成モードで表示できます	フラグはコマンドの編集モードで表示できます
フラグはコマンドの照会モードで表示できます	フラグに複数の引数を指定し、タプルまたはリストとして渡すことができます。

Python 例

import maya.cmds as cmds

# View the documentation for the launchBrowser command
#
cmds.showHelp( 'Commands/showHelp.html', docs=True )

# View the Autodesk home page
#
cmds.showHelp( 'http://www.autodesk.com/', absolute=True )

# Query for the full path to the help page on the Align Tool
#
cmds.showHelp( 'AlignTool', q=True )

# Set the help lookup-table to $MAYA_APP_DIR/customHelpTable
#
cmds.showHelp( 'customHelpTable', helpTable=True )

# View the help topic "Particle" found in customHelpTable.dat
#
cmds.showHelp( 'Particle' )