showHelp

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

概要

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

注意: オブジェクト名や引数を表す文字列はカンマで区切ります。これは概要には示されていません。

showHelp は 「元に戻す」が不可能、「照会」が可能、「編集」が不可能 です。

戻り値

なし

戻り値の型は照会モードでは照会フラグが基になります。

キーワード

関連項目

フラグ

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

: コマンドの作成モードで使用可能なフラグ	: コマンドの編集モードで使用可能なフラグ
: コマンドの照会モードで使用可能なフラグ	: タプルまたはリストとして渡された複数の引数を持てるフラグ

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' )