移動先: 概要 戻り値 キーワード. フラグ. Python 例.
displayString([delete=boolean], [exists=boolean], [keys=boolean], [replace=boolean], [value=string])
注意: オブジェクト名や引数を表す文字列はカンマで区切ります。これは概要には示されていません。
displayString は 「元に戻す」が不可能、「照会」が可能、「編集」が不可能 です。
文字列識別子に文字列値を割り当てます。文字列を 1 箇所で定義し、識別子を使用することで別の位置でも参照できます。
フォーマット文字列もサポートしています（注: この機能は format コマンドによって、より一般的な形で提供されるようになりました。format の使用をお勧めします）。最大 3 つの特殊文字シーケンス ^1、^2、^3 を埋め込んで、文字列を自動置換できます。埋め込まれた文字は追加のコマンド引数に置換されます。詳細については、例のセクションを参照してください。追加のコマンド引数は、表示文字列識別子である必要はありません。
なし
戻り値の型は照会モードでは照会フラグが基になります。
display, string
delete, exists, keys, replace, value
| ロング ネーム（ショート ネーム） |
引数型 |
プロパティ |
value(v)
|
string
|
 
|
|
表示文字列の値。表示文字列の作成時にこのフラグを指定しない場合、値は識別子と同じになります。
|
|
exists(ex)
|
boolean
|
|
|
指定した識別子の存在の有無によって、true か false を返します。
|
|
replace(r)
|
boolean
|
|
|
既存の識別子に新しい値を割り当てようとすると displayString コマンドが失敗するため、既存の識別子の値に対する更新を許可するためには、このフラグが必要です。識別子が存在しない場合は、-replace フラグが存在しないかのように、新しい識別子が追加されます。
|
|
delete(d)
|
boolean
|
|
|
このフラグを使用して、識別子文字列を削除します。
識別子が存在しない場合は失敗します。
|
|
keys(k)
|
boolean
|
|
|
識別子文字列に一致するすべての displayString キーをリスト表示します。
識別文字列はキー文字列の全体でもその一部でもかまいません。
このコマンドは、識別文字列を従属文字列とするすべての識別キーのリストを返します。
|
|
|
: コマンドの作成モードで使用可能なフラグ
|
: コマンドの編集モードで使用可能なフラグ
|
|
: コマンドの照会モードで使用可能なフラグ
|
: タプルまたはリストとして渡された複数の引数を持てるフラグ
|
import maya.cmds as cmds
# Associate a string with an identifier.
#
cmds.displayString( 'kExampleHelloWorld', value='Hello world' )
# Query string associated with an identifer.
#
cmds.displayString( 'kExampleHelloWorld', query=True, value=True )
# Define a simple formatted string to append ellipses.
#
cmds.displayString( 'kExampleEllipsesFormat', value='^1s...' )
cmds.displayString( 'kExampleEllipsesFormat', 'kExampleHelloWorld', query=True, value=True )
# Define a formatted string using all the available
# embedded characters.
#
cmds.displayString( 'kExampleAnotherFormat', value='These ^1s are ^2s me ^3s' )
cmds.displayString( 'kExamplePretzels', value='pretzels' )
cmds.displayString( 'kExampleAnotherFormat', 'kExamplePretzels', 'making', 'thirsty', query=True, value=True )
# Obtain a list of matching displayString keys.
# In the first example a list of all keys containing the substring
# "niceName".
# In the second example a list of all keys in the string set
# m_testStrings
cmds.displayString( 'niceName', query=True, keys=True )
cmds.displayString( 'm_testStrings.', query=True, keys=True )
# If you do not specify the -v/value flag on creating then
# the value will be the same as the identifier.
#
cmds.displayString( 'kExampleMissingValue' )
cmds.displayString( 'kExampleMissingValue', query=True, value=True )