StatusBar

ステータスバー (StatusBar) は、Windowsスタイルのステータスバーコントロールを提供します。このウィンドウ要素はいくつかの他のウィンドウコンポーネントを自動的に組み合わせたものです。

Summary

StatusBar	ステータスバー (StatusBar) は、Windowsスタイルのステータスバーコントロールを提供します。このウィンドウ要素はいくつかの他のウィンドウコンポーネントを自動的に組み合わせたものです。
実装の詳細	ステータスバーは最小値/最大値を元にしたパーセンテージバーを提供する複合ウィンドウ要素です。
XML定義
XMLタグ
必須属性
foregroundOffset	「塗りつぶされている」前面部分の画像定義である水平リサイズイメージの名前。
任意属性
background	「塗りつぶされていない」背景部分の画像定義である水平リサイズイメージの名前。
reverseFill	設定すると、バーが左から右ではなく、右から左に塗りつぶされます。
interpolate	値が変更された時に、バーの増減をアニメーションしながら表示するかどうかを設定します。
interpolaterate	interpolate を true に設定したときのアニメーション速度比を設定します。
関数
関数
StatusBarSetCurrentValue()	ステータスバーの現在の値を設定します。
StatusBarGetCurrentValue()	ステータスバーの現在の値を返します。
StatusBarSetMaximumValue()	ステータスバーの最大値を設定します。
StatusBarGetMaximumValue()	ステータスバーの最大値を返します。
StatusBarStopInterpolating()	アニメーション処理を止め、新しい値を即座に適用します。
StatusBarSetForegroundTint()	ステータスバーの「塗りつぶされている」部分のウィンドウに使用する色の濃淡の値を設定します。
StatusBarSetBackgroundTint()	ステータスバーの「塗りつぶされていない」部分のウィンドウに使用する色の濃淡の値を設定します。

実装の詳細

ステータスバーは最小値/最大値を元にしたパーセンテージバーを提供する複合ウィンドウ要素です。

コンポーネント

ステータスバーは下記のコンポーネントで構成されています：

「塗りつぶされていない」背景部分を定義する HorizontalResizeImage 。
「塗りつぶされている」前面部分を定義する HorizontalResizeImage 。

値

バーの最大値を設定するには StatusBarSetMaximumValue() を呼び出します。その後、 StatusBarSetCurrentValue() で現在の表示量を設定できます。初期設定では、ステータスバーの値の変更は即座に反映されます。「interpolate」属性を「true」に設定することで、即座ではなく、時間をかけてアニメーションしながら値を変更するよう変更することもできます。このアニメーション表示ステータスバーにすぐに変更を適用したい場合は、 StatusBarStopInterpolating() を呼び出してください。

XML定義

Summary

XMLタグ
必須属性
foregroundOffset	「塗りつぶされている」前面部分の画像定義である水平リサイズイメージの名前。
任意属性
background	「塗りつぶされていない」背景部分の画像定義である水平リサイズイメージの名前。
reverseFill	設定すると、バーが左から右ではなく、右から左に塗りつぶされます。
interpolate	値が変更された時に、バーの増減をアニメーションしながら表示するかどうかを設定します。
interpolaterate	interpolate を true に設定したときのアニメーション速度比を設定します。

XMLタグ

<StatusBar>
....
</StatusBar>

代替グループ

Window

必須属性

foregroundOffset

「塗りつぶされている」前面部分の画像定義である水平リサイズイメージの名前。

データ型

string

有効な HorizontalResizeImage の名前。

デフォルト値

””

任意属性

background

「塗りつぶされていない」背景部分の画像定義である水平リサイズイメージの名前。

データ型

string

有効な HorizontalResizeImage の名前。

デフォルト値

””

reverseFill

設定すると、バーが左から右ではなく、右から左に塗りつぶされます。

データ型

boolean

true	右から左に塗りつぶす。
false	右から左に塗りつぶす。

デフォルト値

false

interpolate

値が変更された時に、バーの増減をアニメーションしながら表示するかどうかを設定します。

データ型

boolean

true	アニメーションさせる。
false	アニメーションさせない。

デフォルト値

false

interpolaterate

interpolate を true に設定したときのアニメーション速度比を設定します。

データ型

float_t : 一秒間にバーがどれだけ塗りつぶされるかのパーセントを指定。

50	バー全体を2秒間で塗りつぶす。
100	バー全体を1秒間で塗りつぶす。
200	バー全体を0.5秒間で塗りつぶす。

デフォルト値

関数

Summary

関数
StatusBarSetCurrentValue()	ステータスバーの現在の値を設定します。
StatusBarGetCurrentValue()	ステータスバーの現在の値を返します。
StatusBarSetMaximumValue()	ステータスバーの最大値を設定します。
StatusBarGetMaximumValue()	ステータスバーの最大値を返します。
StatusBarStopInterpolating()	アニメーション処理を止め、新しい値を即座に適用します。
StatusBarSetForegroundTint()	ステータスバーの「塗りつぶされている」部分のウィンドウに使用する色の濃淡の値を設定します。
StatusBarSetBackgroundTint()	ステータスバーの「塗りつぶされていない」部分のウィンドウに使用する色の濃淡の値を設定します。

関数

StatusBarSetCurrentValue()

ステータスバーの現在の値を設定します。

パラメータ

statusBarName	(string) ステータスバーの名前。
curValue	(integer) ステータスバーに表示する値。

戻り値

nil

戻り値無し。

メモ

現在の値は、0から最大値までの値で設定されています。

例

StatusBarSetCurrentValue( "PlayerWindowHealthBar", GameData.Player.hitPoints.current )

StatusBarGetCurrentValue()

ステータスバーの現在の値を返します。

パラメータ

statusBarName

(string) ステータスバーの名前。

戻り値

curValue (integer) ステータスバーに表示されている値。

メモ

現在の値は、0から最大値までの値で設定されています。

例

local playerHealth = StatusBarGetCurrentValue( "PlayerWindowHealthBar" )

StatusBarSetMaximumValue()

ステータスバーの最大値を設定します。

パラメータ

statusBarName	(string) ステータスバーの名前。
maxValue	(integer) ステータスバーに設定する最大値。

戻り値

nil

戻り値無し。

例

StatusBarSetMaximumValue( "PlayerWindowHealthBar", GameData.Player.hitPoints.maximum )

StatusBarGetMaximumValue()

ステータスバーの最大値を返します。

パラメータ

statusBarName

(string) ステータスバーの名前。

戻り値

maxValue

(integer) ステータスバーに設定されている最大値。

例

local playerMaxHealth = StatusBarGetMaximumValue( "PlayerWindowHealthBar" )

StatusBarStopInterpolating()

アニメーション処理を止め、新しい値を即座に適用します。

パラメータ

statusBarName

(string) ステータスバーの名前。

戻り値

nil

戻り値無し。

メモ

アニメーションステータスバーに即座に変更を適用したい場合に、この関数を使用します。使用例は次の通りです：

StatusBarSetCurrentValue( “PlayerWindowHealthBar”, GameData.Player.hitPoints.current )
StatusBarStopInterpolating( “PlayerWindowHealthBar” )

StatusBarSetForegroundTint()

ステータスバーの「塗りつぶされている」部分のウィンドウに使用する色の濃淡の値を設定します。

パラメータ

statusBarName	(string) ステータスバーの名前。
red	(integer) 赤色の濃さ（0～255）。
green	(integer) 緑色の濃さ（0～255）。
blue	(integer) 青色の濃さ（0～255）。

戻り値

nil

戻り値無し。

例

StatusBarSetForegroundTint( "PlayerWindowHealthBar", 234, 54, 45 )

StatusBarSetBackgroundTint()

ステータスバーの「塗りつぶされていない」部分のウィンドウに使用する色の濃淡の値を設定します。

パラメータ

statusBarName	(string) ステータスバーの名前。
red	(integer) 赤色の濃さ（0～255）。
green	(integer) 緑色の濃さ（0～255）。
blue	(integer) 青色の濃さ（0～255）。

戻り値

nil

戻り値無し。

例

StatusBarSetBackgroundTint( "PlayerWindowHealthBar", 234, 54, 45 )