Label

ラベル (Label) 要素は、インターフェースのテキスト描画要素として主に使用されます。

ラベルが表示するテキストはLuaスクリプトから LabelSetText() 関数で設定する必要があります。なぜなら、UIシステムで使用する全テキストをワイド文字列タイプとして維持するためです。これにより、1つのXML/Luaソースで多言語をサポートすることができます。

Summary
Labelラベル (Label) 要素は、インターフェースのテキスト描画要素として主に使用されます。
XML定義
XMLタグ
必須属性
font使用するフォント定義の名前。
任意属性
maxchars表示可能な最大文字数。
textalignテキストを整列させます。
wordwrapテキスト文字列の幅がラベルの幅よりも大きい場合に、テキストを自動改行させるか否かを指定します。
autoresizeテキストに合わせてラベルの縦幅を自動調整するか否かを指定します。
autoresizewidthテキストに合うように幅を自動的に縮小するか否かを指定します。
textAutoFitMinScaleフォントの最小縮尺値を設定します。
linespacingフォントラインスペース用のオーバーライド値。
warnOnTextCroppedテキストが途切れている場合に、ラベルログ警告メッセージを出すか否かを指定します。
ignoreFormattingTagsこのテキストの処理中は全てのフォーマットタグを無視します。
要素
Colorラベルテキストの色。
LinkColorテキストに埋め込まれたリンクの色。
LinkHighlightColorテキストに埋め込まれたリンクにマウスオーバーしたときの色。
ウィンドウ コールバック
コールバック
OnHyperLinkClickedハイパーリンク上で OnLButtonDown が発生した時に呼び出されます。
OnHyperLinkMouseOverマウスをハイパーリンクに重ねたときに呼び出されます。
関数
関数
LabelSetText()ラベルに表示するテキストを設定します。
LabelGetText()ラベルに表示されているテキストを返します。
LabelSetTextColor()ラベルに表示するテキストの色を設定します。
LabelGetTextColor()ラベルに設定されているテキスト色を返します。
LabelSetLinkColor()ラベルに表示するテキストのリンク色を設定します。
LabelGetLinkColor()ラベルに設定されているテキストのリンク色を返します。
LabelSetFont()ラベルに表示するテキストのフォントを設定します。
LabelGetFont()指定したラベルのテキストが使用しているフォントの名前を返します。
LabelGetTextDimensions()ラベルに表示されているテキストのサイズを返します。
LabelDumpGeometry()テクスチャに現在のテキストをレンダリングするデバッグ用の関数です。
LabelSetWordWrap()自動改行をオン／オフします。
LabelGetWordWrap()自動改行が有効かどうかを返します。
LabelSetTextAlign()テキスト整列を設定します。

XML定義

Summary
XMLタグ
必須属性
font使用するフォント定義の名前。
任意属性
maxchars表示可能な最大文字数。
textalignテキストを整列させます。
wordwrapテキスト文字列の幅がラベルの幅よりも大きい場合に、テキストを自動改行させるか否かを指定します。
autoresizeテキストに合わせてラベルの縦幅を自動調整するか否かを指定します。
autoresizewidthテキストに合うように幅を自動的に縮小するか否かを指定します。
textAutoFitMinScaleフォントの最小縮尺値を設定します。
linespacingフォントラインスペース用のオーバーライド値。
warnOnTextCroppedテキストが途切れている場合に、ラベルログ警告メッセージを出すか否かを指定します。
ignoreFormattingTagsこのテキストの処理中は全てのフォーマットタグを無視します。
要素
Colorラベルテキストの色。
LinkColorテキストに埋め込まれたリンクの色。
LinkHighlightColorテキストに埋め込まれたリンクにマウスオーバーしたときの色。

XMLタグ

<Label>
....
</Label>

代替グループ

必須属性

font

使用するフォント定義の名前。

データ型

string有効な Font 定義。

任意属性

maxchars

表示可能な最大文字数。

データ型

number0よりも大きな数値。

デフォルト値

  • 255

textalign

テキストを整列させます。

データ型

string

”left”左揃え。
”top”水平方向中央揃え。
”center”水平方向中央揃え ( autoresize がfalseの場合は垂直方向にも中央揃え)。
”right”右揃え。
”leftcenter”左揃え垂直方向中央揃え。
”rightcenter”右揃え垂直方向中央揃え。
”bottom”下揃え水平方向中央揃え。
”bottomleft”左揃え且つ下揃え。
”bottomright”右揃え且つ下揃え。

デフォルト値

  • ”left”

wordwrap

テキスト文字列の幅がラベルの幅よりも大きい場合に、テキストを自動改行させるか否かを指定します。

データ型

boolean

true改行させる。
false改行させない （最大幅以降のテキストは途切れます）。

デフォルト値

  • false

autoresize

テキストに合わせてラベルの縦幅を自動調整するか否かを指定します。

データ型

boolean

trueテキストに合わせてラベルの縦幅を変更する。
false縦幅の最大値を超えたテキストは切り捨てる。

デフォルト値

  • false

メモ

autoresizewidth

テキストに合うように幅を自動的に縮小するか否かを指定します。

データ型

boolean

trueテキストに合わせて幅を縮小する。
false絶対にラベル幅を短くしない。

デフォルト値

  • false

メモ

  • ラベル幅を自動調整した場合、ラベルサイズはその指定サイズを限度として変更されます。この属性はフルサイズの幅が必要ではない場合には、サイズを狭めるだけです。

textAutoFitMinScale

フォントの最小縮尺値を設定します。

サイズ変更ができないラベル上のフォントは、テキストがラベルサイズ内に納まるまで最小縮尺値を限度として自動的に縮小されます。

データ型

float_t(1.0 = 100%)

デフォルト値

  • 1.0

linespacing

フォントラインスペース用のオーバーライド値。

データ型

number0の場合はフォントの縦幅をそのまま使用します。

デフォルト値

  • 0

warnOnTextCropped

テキストが途切れている場合に、ラベルログ警告メッセージを出すか否かを指定します。

データ型

boolean

true警告メッセージを出す。
false警告メッセージを出さない。

デフォルト値

  • true

ignoreFormattingTags

このテキストの処理中は全てのフォーマットタグを無視します。

ラベルにこのフラグをセットすると、フォーマットタグを使用しなくなるためパフォーマンスを向上できます。

データ型

boolean

trueフォーマットタグを処理しません。
false全てのフォーマットタグを適切に処理します。

デフォルト値

  • false

要素

Color

ラベルテキストの色。

構文

<Color r="255" g="255" b="255"  />
r赤色の値。
g緑色の値。
b青色の値。

デフォルト値

r255
g255
b255

LinkColor

テキストに埋め込まれたリンクの色。

構文

<LinkColor r="255" g="255" b="255"  />
r赤色の値。
g緑色の値。
b青色の値。

デフォルト値

r0
g51
b255

LinkHighlightColor

テキストに埋め込まれたリンクにマウスオーバーしたときの色。

構文

<LinkHighlightColor r="255" g="255" b="255"  />
r赤色の値。
g緑色の値。
b青色の値。

デフォルト値

r167
g51
b255

ウィンドウ コールバック

Summary
コールバック
OnHyperLinkClickedハイパーリンク上で OnLButtonDown が発生した時に呼び出されます。
OnHyperLinkMouseOverマウスをハイパーリンクに重ねたときに呼び出されます。

コールバック

OnHyperLinkClicked

ハイパーリンク上で OnLButtonDown が発生した時に呼び出されます。

構文

SomeWindowName.OnHyperLinkClicked( linkParam )
linkParam(wstring) テキストからリンクタグに埋め込まれたデータ。

OnHyperLinkMouseOver

マウスをハイパーリンクに重ねたときに呼び出されます。

構文

SomeWindowName.OnHyperLinkMouseOver( linkParam )
linkParam(wstring) テキストからリンクタグに埋め込まれたデータ。

関数

Summary
関数
LabelSetText()ラベルに表示するテキストを設定します。
LabelGetText()ラベルに表示されているテキストを返します。
LabelSetTextColor()ラベルに表示するテキストの色を設定します。
LabelGetTextColor()ラベルに設定されているテキスト色を返します。
LabelSetLinkColor()ラベルに表示するテキストのリンク色を設定します。
LabelGetLinkColor()ラベルに設定されているテキストのリンク色を返します。
LabelSetFont()ラベルに表示するテキストのフォントを設定します。
LabelGetFont()指定したラベルのテキストが使用しているフォントの名前を返します。
LabelGetTextDimensions()ラベルに表示されているテキストのサイズを返します。
LabelDumpGeometry()テクスチャに現在のテキストをレンダリングするデバッグ用の関数です。
LabelSetWordWrap()自動改行をオン／オフします。
LabelGetWordWrap()自動改行が有効かどうかを返します。
LabelSetTextAlign()テキスト整列を設定します。

関数

LabelSetText()

ラベルに表示するテキストを設定します。

パラメータ

labelName(string) ラベルの名前。
text(wstring) テキスト文字列。

戻り値

nil戻り値無し。

例

LabelSetText( "CharacterWindowName", GameData.Player.name )

LabelGetText()

ラベルに表示されているテキストを返します。

パラメータ

labelName(string) ラベルの名前。

戻り値

text(wstring) テキスト文字列。

例

local currText = LabelGetText( name )

LabelSetTextColor()

ラベルに表示するテキストの色を設定します。

パラメータ

labelName(string) ラベルの名前。
red(integer) 赤色の値 (0-255)
green(integer) 緑色の値 (0-255)
blue(integer) 青色の値 (0-255)

戻り値

nil戻り値無し。

例

LabelSetTextColor ("ChatWindowContainerChannelLabel", channel.color.r, channel.color.g, channel.color.b)

LabelGetTextColor()

ラベルに設定されているテキスト色を返します。

パラメータ

labelName(string) ラベルの名前。

戻り値

red(integer) 赤色の値 (0-255)
green(integer) 緑色の値 (0-255)
blue(integer) 青色の値 (0-255)

例

local r, g, b = LabelGetTextColor( "SomeLabel" )

LabelSetLinkColor()

ラベルに表示するテキストのリンク色を設定します。

パラメータ

labelName(string) ラベルの名前。
red(integer) ハイパーリンクの赤色の値 (0-255)
green(integer) ハイパーリンクの緑色の値 (0-255)
blue(integer) ハイパーリンクの青色の値 (0-255)

戻り値

nil戻り値無し。

例

LabelSetLinkColor ("SomeWindow", color.r, color.g, color.b)

LabelGetLinkColor()

ラベルに設定されているテキストのリンク色を返します。

パラメータ

labelName(string) ラベルの名前。

戻り値

red(integer) ハイパーリンクの赤色の値 (0-255)
green(integer) ハイパーリンクの緑色の値 (0-255)
blue(integer) ハイパーリンクの青色の値 (0-255)

例

local r, g, b = LabelGetLinkColor( "SomeLabel" )

LabelSetFont()

ラベルに表示するテキストのフォントを設定します。

パラメータ

labelName(string) ラベルの名前。
fontName(string) 使用するフォントの名前。
lineSpacing(integer) 使用するラインスペースの値。

戻り値

nil戻り値無し。

関連するXML

例

LabelSetFont( "DefaultTooltipRow"..rowNum.."Col"..colNum.."Text", "font_default_text", WindowUtils.FONT_DEFAULT_TEXT_LINESPACING )

LabelGetFont()

指定したラベルのテキストが使用しているフォントの名前を返します。

パラメータ

labelName(string) ラベルの名前。

戻り値

fontName(string) フォントの名前。

関連するXML

例

local fontName = LabelGetFont("SomeWindow")

LabelGetTextDimensions()

ラベルに表示されているテキストのサイズを返します。

パラメータ

labelName(string) ラベルの名前。

戻り値

x(integer) 現在のテキストの横幅。
y(integer) 現在のテキストの縦幅。

メモ

データにあわせて手動でウィンドウをリサイズする場合に非常に役立つ関数です。

LabelDumpGeometry()

テクスチャに現在のテキストをレンダリングするデバッグ用の関数です。

パラメータ

labelName(string) ラベルの名前。

戻り値

nil戻り値無し。

LabelSetWordWrap()

自動改行をオン／オフします。

パラメータ

labelName(string) ラベルの名前。
wrapOn(boolean) true = 有効にする, false = 無効にする

戻り値

nil戻り値無し。

関連するXML

LabelGetWordWrap()

自動改行が有効かどうかを返します。

パラメータ

labelName(string) ラベルの名前。

戻り値

wrapOn(boolean) true = 有効, false = 無効

関連するXML

LabelSetTextAlign()

テキスト整列を設定します。

パラメータ

labelName(string) ラベルの名前。
textAlign(string) 整列の設定。

戻り値

nil戻り値無し。
マウスの左ボタンが押された時に呼び出されます。
ラベルに表示するテキストを設定します。
ウィンドウ (Window) 要素はウィンドウを作成する際に使用する基本的な要素です。他のウィンドウ要素もこの要素の内容を継承しており、全ての属性、要素、データメンバー、関数をサポートしています。
フォントを定義します。
テキストに合わせてラベルの縦幅を自動調整するか否かを指定します。
スクロールウィンドウ (ScrollWindow) は、全ての子ウィンドウに垂直方向のスクロールパネルを提供するコンテナウィンドウです。
水平スクロールウィンドウ (HorizontalScrollWindow) は、子ウィンドウ全てに水平スクロールパネルを提供するコンテナウィンドウです。
ページウィンドウ (PageWindow) は本のようなレイアウトを作成して自動で表示する手段を提供します。
使用するフォント定義の名前。
フォントラインスペース用のオーバーライド値。
テキスト文字列の幅がラベルの幅よりも大きい場合に、テキストを自動改行させるか否かを指定します。
Close