Button

ボタン (Button) 要素は、マウスカーソルの状態に応じて自動的にテクスチャやフォントカラーを変更するなどといった、一般的なボタン要素を自動化します。

Summary
Buttonボタン (Button) 要素は、マウスカーソルの状態に応じて自動的にテクスチャやフォントカラーを変更するなどといった、一般的なボタン要素を自動化します。
実装の詳細
XML定義
XMLタグ
任意属性
backgroundtexture背景画像レイヤーに使用するテクスチャの名前。
highlighttextureハイライト画像レイヤーに使用するテクスチャの名前。
overlaytextureオーバーレイ画像レイヤーに使用するテクスチャの名前。
overlayhighlighttextureオーバーレイハイライト画像レイヤーに使用するテクスチャの名前。
texturescaleボタンに使用するテクスチャの縮尺。
font使用するフォント定義の名前。
textAutoFitMinScaleテキストの最小縮尺。
linespacingフォントの行間。
textalignテキストの位置を揃えます。
autoresizeテキストのサイズに応じて、ボタンの縦幅を自動的に変更するかどうかを設定します。
autoresizewidthテキストに合うよう、ボタンの横幅を自動的に縮めるかどうかを設定します。
drawchildrenfirstボタンの描画順を指定することができます。
drawHighlightOverBackgroundこのボタンを表示しているときに、ハイライト状態を背景画像の上に表示するかどうかを設定します。
mirrorTexCoordsボタンテクスチャを縦方向に反転させることができます。
warnOnTextCroppedテキストがカットされている場合に、ボタンログエラーの警告を表示するかどうかを設定できます。
要素
TextColorsテキストカラーをボタン状態毎に指定する要素。
TexCoordsボタンに使用しているテクスチャの基準座標を、ボタン状態毎に指定する要素。
OverlayTexCoordsボタン上のオーバーレイテクスチャの基準座標を、ボタンの状態毎に指定する要素。
TexSlices表示するテクスチャと結び付けられたスライスを、ボタン状態毎に指定する要素。
OverlayTexSlices表示するオーバーレイテクスチャと結び付けられたスライスを、ボタン状態毎に指定する要素。
AnimatedImagesトップレベルオーバーレイとして使用するアニメーテッドイメージの名前を、ボタン状態毎に指定する要素。
TextOffsetボタンに表示されているテキストのオフセットを設定します。
OverlayOffset (機能しません)オーバーレイとオーバーレイハイライト画像のためのオフセットを設定します。
OverlaySizeオーバーレイ画像のサイズを設定します。
ResizeImagesリサイズ画像の名前を、ボタン状態毎に指定するための要素です。
定数
定数
Button.ButtonState.NORMAL通常
Button.ButtonState.HIGHLIGHTED通常のハイライト
Button.ButtonState.PRESSED押されている
Button.ButtonState.PRESSED_HIGHLIGHTED押されていてハイライトしている
Button.ButtonState.DISABLED使用不可
Button.ButtonState.DISABLED_PRESSED押されているが使用不可
関数
関数
ButtonSetText()ボタン上に表示するテキストを設定します。
ButtonGetText()ボタン上に現在表示されているテキストを返します。
ButtonSetPressedFlag()ボタン表示を「押されている」状態に設定するための関数です。
ButtonGetPressedFlag()現在のボタン表示状態（押されているかどうか）を返します。
ButtonSetHighlightFlag()ボタン表示を「ハイライト」状態に設定するための関数です。
ButtonGetHighlightFlag()現在のボタン表示状態（ハイライトしているかどうか）を返します。
ButtonSetDisabledFlag()ボタン表示を「使用不可」状態に設定するための関数です。
ButtonGetDisabledFlag()現在のボタン表示状態（使用不可かどうか）を返します。
ButtonSetStayDownFlag()ユーザーがマウスの左ボタンを放しても、押されたままのボタン表示を維持するかどうかを設定します。
ButtonGetStayDownFlag()現在のボタン表示状態（マウスの左ボタンを放しても、押されたままのボタン表示を維持するかどうか）を返します。
ButtonSetCheckButtonFlag()チェックボタンのようにボタンを動作させたい場合に設定します。
ButtonGetCheckButtonFlag()ボタンが現在、チェックボタンのように動作しているかどうかを調べて値を返します。
ButtonSetTexture()特定のボタン状態に使用するテクスチャを設定します。
ButtonSetTextColor()特定のボタン状態に使用するテキストカラーを設定します。
ButtonGetTextDimensions()指定したボタンのテキストのサイズを返します。

実装の詳細

コンポーネント

ボタン要素は5段階のコンポーネントで構成されています。特殊なボタンは利用可能なコンポーネントのサブセットのどれかを含んでいる可能性があります。各コンポーネントの表示順は次の通りです：

  • テキスト
  • オーバーレイハイライト画像
  • オーバーレイ画像
  • 背景ハイライト画像
  • 背景画像

背景

背景レイヤーテクスチャコンポーネントは常に表示されます。このテクスチャーは次の4つの状態のどれかになっています：

  • 使用不可 （通常画像のグレーアウト版）
  • 通常 （ボタンが使用可能な時の基本画像）
  • 押されている （マウスカーソルがボタンの上に重なっているか、 ButtonSetStayDownFlag() が設定されているとき）
  • 押すことができない （押されている画像のグレーアウト版）

背景ハイライト

マウスカーソルがボタンの上に重なると、背景ハイライトレイヤーが背景レイヤーの上に描画されます。また、ボタンの状態に応じて次どちらかが表示されます。

  • 通常のハイライト （マウスカーソルが重なっている時の基本画像）
  • 押されているハイライト （上記の画像が押された時のバージョン）

このレイイング手法により、背景レイヤーに「輝き」エフェクトが表示されている押されたボタンの画像を作成することができます。

オーバーレイ

定義されている場合、オーバーレイとオーバーレイハイライトは背景、背景ハイライトと同じように動作します。

テキスト

テキストは現在のボタンの状態に応じた色で、常に最後に描かれます（つまり、一番上に表示されます）。

XML定義

Summary
XMLタグ
任意属性
backgroundtexture背景画像レイヤーに使用するテクスチャの名前。
highlighttextureハイライト画像レイヤーに使用するテクスチャの名前。
overlaytextureオーバーレイ画像レイヤーに使用するテクスチャの名前。
overlayhighlighttextureオーバーレイハイライト画像レイヤーに使用するテクスチャの名前。
texturescaleボタンに使用するテクスチャの縮尺。
font使用するフォント定義の名前。
textAutoFitMinScaleテキストの最小縮尺。
linespacingフォントの行間。
textalignテキストの位置を揃えます。
autoresizeテキストのサイズに応じて、ボタンの縦幅を自動的に変更するかどうかを設定します。
autoresizewidthテキストに合うよう、ボタンの横幅を自動的に縮めるかどうかを設定します。
drawchildrenfirstボタンの描画順を指定することができます。
drawHighlightOverBackgroundこのボタンを表示しているときに、ハイライト状態を背景画像の上に表示するかどうかを設定します。
mirrorTexCoordsボタンテクスチャを縦方向に反転させることができます。
warnOnTextCroppedテキストがカットされている場合に、ボタンログエラーの警告を表示するかどうかを設定できます。
要素
TextColorsテキストカラーをボタン状態毎に指定する要素。
TexCoordsボタンに使用しているテクスチャの基準座標を、ボタン状態毎に指定する要素。
OverlayTexCoordsボタン上のオーバーレイテクスチャの基準座標を、ボタンの状態毎に指定する要素。
TexSlices表示するテクスチャと結び付けられたスライスを、ボタン状態毎に指定する要素。
OverlayTexSlices表示するオーバーレイテクスチャと結び付けられたスライスを、ボタン状態毎に指定する要素。
AnimatedImagesトップレベルオーバーレイとして使用するアニメーテッドイメージの名前を、ボタン状態毎に指定する要素。
TextOffsetボタンに表示されているテキストのオフセットを設定します。
OverlayOffset (機能しません)オーバーレイとオーバーレイハイライト画像のためのオフセットを設定します。
OverlaySizeオーバーレイ画像のサイズを設定します。
ResizeImagesリサイズ画像の名前を、ボタン状態毎に指定するための要素です。

XMLタグ

<Button>
....
</Button>

代替グループ

任意属性

backgroundtexture

背景画像レイヤーに使用するテクスチャの名前。

データ型

string有効なUI Texture の名前。

デフォルト値

  • ””

highlighttexture

ハイライト画像レイヤーに使用するテクスチャの名前。

データ型

string有効なUI Texture の名前。

デフォルト値

  • ””

overlaytexture

オーバーレイ画像レイヤーに使用するテクスチャの名前。

データ型

string有効なUI Texture の名前。

デフォルト値

  • ””

overlayhighlighttexture

オーバーレイハイライト画像レイヤーに使用するテクスチャの名前。

データ型

string有効なUI Texture の名前。

デフォルト値

  • ””

texturescale

ボタンに使用するテクスチャの縮尺。

この値は、テクスチャの元画像のサイズに乗算されます。

データ型

float_t(1.0 = 100%)

デフォルト値

  • 1.0

メモ

  • TexDims 要素で無効にすることもできます。

font

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

ボタンにテキストを表示する際に必要です。

データ型

string有効な Font の名前。

textAutoFitMinScale

テキストの最小縮尺。

指定した最小縮尺までの間で、フォントのポイントサイズを自動的に落としてラベルボタンのテキストエリアにフィットするようにします。

データ型

float_t(1.0 = 100%、自動スケーリング無し)

デフォルト値

  • 1.0

linespacing

フォントの行間。

データ型

integer0にした場合、フォントの縦幅がそのまま使われます。

デフォルト値

  • 0

textalign

テキストの位置を揃えます。

データ型

string

”left”左側に揃えます。
”top”上段に揃えます。
”center”中央に揃えます。
”right”右側に揃えます。
”leftcenter”中段左に揃えます。
”rightcenter”中段右に揃えます。
”bottom”下段中央に揃えます。
”bottomleft”下段左に揃えます。
”bottomright”下段右に揃えます。

デフォルト値

  • ”left”

autoresize

テキストのサイズに応じて、ボタンの縦幅を自動的に変更するかどうかを設定します。

データ型

boolean

trueテキストのサイズに合うよう、ボタンのサイズを変更します。
false縦幅の最大値を越えた場合、ボタンテキストをカットします。

デフォルト値

  • false

メモ

  • このオートリサイズの対象はテキストのみで、水平リサイズかフルリサイズのどちらかになります。

autoresizewidth

テキストに合うよう、ボタンの横幅を自動的に縮めるかどうかを設定します。

データ型

boolean

trueテキストに合うよう横幅を縮めます。
false横幅を縮めません。

デフォルト値

  • false

メモ

  • 指定したサイズよりもボタンが大きくなることはありません。テキストが短い時に、ボタンサイズが小さくなるだけです。

drawchildrenfirst

ボタンの描画順を指定することができます。

具体的には、テキスト/ハイライトボタンコンポーネントの上と下のどちらに子ウィンドウを置くかを選ぶことができます。

データ型

boolean

trueハイライトとテキストを表示する前に子ウィンドウを表示する
falseハイライトとテキストを表示した後に子ウィンドウを表示する

デフォルト値

  • false

drawHighlightOverBackground

このボタンを表示しているときに、ハイライト状態を背景画像の上に表示するかどうかを設定します。

データ型

boolean

true背景画像を常にハイライト画像の後ろに表示します。
falseハイライト画像表示時に、背景画像を表示しません。

デフォルト値

  • true

mirrorTexCoords

ボタンテクスチャを縦方向に反転させることができます。

データ型

boolean

trueテクスチャを反転させる。
falseテクスチャを反転させない。

デフォルト値

  • false

warnOnTextCropped

テキストがカットされている場合に、ボタンログエラーの警告を表示するかどうかを設定できます。

データ型

boolean

trueテキストがカットされている場合、ログエラーを表示します。
falseテキストがカットされていても、ログエラーを表示しません。

デフォルト値

  • true

要素

TextColors

テキストカラーをボタン状態毎に指定する要素。

構文

<TextColors>
      <Normal             r="255" g="204" b="102" />
      <NormalHighlit      r="255" g="85"  b="0" />
      <Pressed            r="255" g="85"  b="0" />
      <PressedHighlit     r="255" g="85"  b="0"/>
      <Disabled           r="92"  g="92"  b="92" />
      <DisabledPressed    r="92"  g="92"  b="92" />
</TextColors>
r赤色の値
g緑色の値
b青色の値

デフォルト値

r255
g255
b255

メモ

  • テキストカラーを指定しない場合には、デフォルトカラーの白が適用されます。

TexCoords

ボタンに使用しているテクスチャの基準座標を、ボタン状態毎に指定する要素。

背景テクスチャとハイライトテクスチャの属性を設定した場合、textureのフィールドはオプションになります。

構文

<TexCoords>
      <Normal          texture="" x="474" y="6" />
      <NormalHighlit   texture="" x="474" y="45" />
      <Pressed         texture="" x="474" y="45" />
      <PressedHighlit  texture="" x="474" y="45" />
      <Disabled        texture="" x="474" y="6" />
      <DisabledPressed texture="" x="474" y="6" />
</TexCoords>
textureボタンの状態に応じたUI Texture の名前。
xテクスチャのX座標。
yテクスチャのY座標。

デフォルト値

texture””
x0
y0

OverlayTexCoords

ボタン上のオーバーレイテクスチャの基準座標を、ボタンの状態毎に指定する要素。

属性として overlaytexture と overlayhighlighttexture を設定している場合、テクスチャフィールドはオプションになります。

構文

<OverlayTexCoords>
      <Normal          texture="" x="474" y="6" />
      <NormalHighlit   texture="" x="474" y="45" />
      <Pressed         texture="" x="474" y="45" />
      <PressedHighlit  texture="" x="474" y="45" />
      <Disabled        texture="" x="474" y="6" />
      <DisabledPressed texture="" x="474" y="6" />
</OverlayTexCoords>
textureこのボタン状態で使用するUI Texture の名前。
xテクスチャのX座標。
yテクスチャのY座標。

デフォルト値

texture””
x0
y0

TexSlices

表示するテクスチャと結び付けられたスライスを、ボタン状態毎に指定する要素。

背景テクスチャとハイライトテクスチャの属性を設定した場合、textureのフィールドはオプションになります。

構文

<TexSlices>
      <Normal          texture="" id="Bag-Button"  />
      <NormalHighlit   texture="" id="Bag-Button-Highlighted"   />
      <Pressed         texture="" id="Bag-Button-Selected"   />
      <PressedHighlit  texture="" id="Bag-Button-Highlighted"   />
      <Disabled        texture="" id="Bag-Button"   />
      <DisabledPressed texture="" id="Bag-Button"   />
</TexSlices>
textureボタンの状態に応じたUI Texture の名前。
id表示するUI Texture と結び付けられたスライスのID。

デフォルト値

texture””
id””

OverlayTexSlices

表示するオーバーレイテクスチャと結び付けられたスライスを、ボタン状態毎に指定する要素。

背景テクスチャとハイライトテクスチャの属性を設定した場合、textureのフィールドはオプションになります。

構文

<OverlayTexSlices>
      <Normal          texture="" id="Bag-Button"  />
      <NormalHighlit   texture="" id="Bag-Button-Highlighted"   />
      <Pressed         texture="" id="Bag-Button-Selected"   />
      <PressedHighlit  texture="" id="Bag-Button-Highlighted"   />
      <Disabled        texture="" id="Bag-Button"   />
      <DisabledPressed texture="" id="Bag-Button"   />
</OverlayTexSlices>
textureボタンの状態に応じたUI Texture の名前。
id表示するUI Texture と結び付けられたスライスのID。

デフォルト値

texture””
id””

AnimatedImages

トップレベルオーバーレイとして使用するアニメーテッドイメージの名前を、ボタン状態毎に指定する要素。

構文

<AnimatedImages>
      <Normal          def="DefaultAnimatedImageNormal"  />
      <NormalHighlit   def="DefaultAnimatedImageNormalHightlite" />
      <Pressed         def="DefaultAnimatedImagePressed" />
      <PressedHighlit  def="DefaultAnimatedImagePressedHightlite"  />
      <Disabled        def=""  />
      <DisabledPressed def=""  />
</AnimatedImages>
defこのボタン状態で使用する AnimatedImage の名前。

デフォルト値

def””

TextOffset

ボタンに表示されているテキストのオフセットを設定します。

これを設定することで、テキストをボタンの中心に表示させることができます。

構文

<TextOffset x="5" y="10" />
x左上隅からのXピクセルオフセット。
y左上隅からのYピクセルオフセット。

デフォルト値

x0
y0

メモ

  • オフセットは、ボタンの上/下と左/右、両方の角からの距離になります。

OverlayOffset (機能しません)

オーバーレイとオーバーレイハイライト画像のためのオフセットを設定します。

この要素を指定することで、背景画像よりも小さな、または大きなオーバーレイを使用することができます。

構文

<OverlayOffset x="5" y="10" />
x左上隅からのXピクセルオフセット
y左上隅からのYピクセルオフセット

デフォルト値

x0
y0

メモ

  • オフセットは、ボタンの上/下と左/右、両方の角からの距離になります。

OverlaySize

オーバーレイ画像のサイズを設定します。

構文

<OverlaySize x="100" y="100" />
xXピクセルのサイズ。
yYピクセルのサイズ。

ResizeImages

リサイズ画像の名前を、ボタン状態毎に指定するための要素です。

この要素を指定することで、リサイズ可能なウィンドウ上のボタンを作成することができます。

構文

<ResizeImages>
      <Normal          def="DefaultHorizResizeButtonNormal"  />
      <NormalHighlit   def="DefaultHorizResizeButtonHightlite" />
      <Pressed         def="DefaultHorizResizeButtonPressed" />
      <PressedHighlit  def="DefaultHorizResizeButtonPressedHightlite"  />
      <Disabled        def="DefaultHorizResizeButtonDisabled"  />
      <DisabledPressed def="DefaultHorizResizeButtonDisabled"  />
</ResizeImages>
defボタン状態毎のリサイズ画像の名前。

デフォルト値

def””

定数

Summary
定数
Button.ButtonState.NORMAL通常
Button.ButtonState.HIGHLIGHTED通常のハイライト
Button.ButtonState.PRESSED押されている
Button.ButtonState.PRESSED_HIGHLIGHTED押されていてハイライトしている
Button.ButtonState.DISABLED使用不可
Button.ButtonState.DISABLED_PRESSED押されているが使用不可

定数

Button.ButtonState.NORMAL

通常

Button.ButtonState.HIGHLIGHTED

通常のハイライト

Button.ButtonState.PRESSED

押されている

Button.ButtonState.PRESSED_HIGHLIGHTED

押されていてハイライトしている

Button.ButtonState.DISABLED

使用不可

Button.ButtonState.DISABLED_PRESSED

押されているが使用不可

関数

Summary
関数
ButtonSetText()ボタン上に表示するテキストを設定します。
ButtonGetText()ボタン上に現在表示されているテキストを返します。
ButtonSetPressedFlag()ボタン表示を「押されている」状態に設定するための関数です。
ButtonGetPressedFlag()現在のボタン表示状態（押されているかどうか）を返します。
ButtonSetHighlightFlag()ボタン表示を「ハイライト」状態に設定するための関数です。
ButtonGetHighlightFlag()現在のボタン表示状態（ハイライトしているかどうか）を返します。
ButtonSetDisabledFlag()ボタン表示を「使用不可」状態に設定するための関数です。
ButtonGetDisabledFlag()現在のボタン表示状態（使用不可かどうか）を返します。
ButtonSetStayDownFlag()ユーザーがマウスの左ボタンを放しても、押されたままのボタン表示を維持するかどうかを設定します。
ButtonGetStayDownFlag()現在のボタン表示状態（マウスの左ボタンを放しても、押されたままのボタン表示を維持するかどうか）を返します。
ButtonSetCheckButtonFlag()チェックボタンのようにボタンを動作させたい場合に設定します。
ButtonGetCheckButtonFlag()ボタンが現在、チェックボタンのように動作しているかどうかを調べて値を返します。
ButtonSetTexture()特定のボタン状態に使用するテクスチャを設定します。
ButtonSetTextColor()特定のボタン状態に使用するテキストカラーを設定します。
ButtonGetTextDimensions()指定したボタンのテキストのサイズを返します。

関数

ButtonSetText()

ボタン上に表示するテキストを設定します。

パラメータ

buttonName(string) ボタンの名前。
text(wstring) テキスト。

戻り値

nil戻り値無し。

例

ButtonSetText("InteractionWindowQuestAccept", GetString( StringTables.Default.LABEL_ACCEPT ))

ButtonGetText()

ボタン上に現在表示されているテキストを返します。

パラメータ

buttonName(string) ボタンの名前。

戻り値

text(wstring) テキスト。

例

local currText = ButtonGetText( name )

ButtonSetPressedFlag()

ボタン表示を「押されている」状態に設定するための関数です。

パラメータ

buttonName(string) ボタンの名前。
isPressed(boolean) ボタン表示を「押されている」状態にするか否か？

戻り値

nil戻り値無し。

メモ

  • コード内で手動で「押されている」状態に設定した場合、 ButtonSetStayDownFlag() を設定する必要があります。そうすればその状態がそのまま保持されます。

例

ButtonSetPressedFlag( "SettingsResolutionUseFullscreenButton", SystemData.Settings.Resolution.useFullScreen )

ButtonGetPressedFlag()

現在のボタン表示状態（押されているかどうか）を返します。

パラメータ

buttonName(string) ボタンの名前。

戻り値

isPressed(boolean) true = 押されている, false = 押されていない

例

SystemData.Settings.Resolution.useFullScreen = ButtonGetPressedFlag( "SettingsResolutionUseFullscreenButton" )

ButtonSetHighlightFlag()

ボタン表示を「ハイライト」状態に設定するための関数です。

パラメータ

buttonName(string) ボタンの名前。
isHighlighted(boolean) ボタン表示を「ハイライト」状態にするか否か？

戻り値

nil戻り値無し。

メモ

  • 通常のボタンプロセスでは、マウスの位置に応じてハイライトのON/OFFが変化します。もしコード内でハイライトを手動で変更する場合には、このウィンドウかその親ウィンドウに OnMouseOver() と OnMouseOverEnd() があるか確認してください。

例

ButtonSetHighlightFlag( "SomeButton", true )

ButtonGetHighlightFlag()

現在のボタン表示状態（ハイライトしているかどうか）を返します。

パラメータ

buttonName(string) ボタンの名前。

戻り値

isHighlighted(boolean) true = ハイライトしている, false = ハイライトしていない

例

local isHighlighted = ButtonGetHighlightFlag( "SomeButton" )

ButtonSetDisabledFlag()

ボタン表示を「使用不可」状態に設定するための関数です。

使用不可にした場合、ボタンは「使用不可」の画像で表示され、ハイライトしないようになります。

パラメータ

buttonName(string) ボタンの名前。
isDisabled(boolean) ボタン表示を「使用不可」状態にするか否か？

戻り値

nil戻り値無し。

メモ

  • ボタン表示を「使用不可」にしても、ボタンがクリックされればマウスイベントは処理されます。ボタン自体を使用できないようにしたい場合には、マウスイベントハンドラーのトップに ButtonGetDisabledFlag() を呼び出してください。

例

ButtonSetDisabledFlag("GroupMenuWindowGroupKickButton", GameData.Player.isGroupLeader == false )

ButtonGetDisabledFlag()

現在のボタン表示状態（使用不可かどうか）を返します。

パラメータ

buttonName(string) ボタンの名前。

戻り値

isDisabled(boolean) true = 使用不可, false = 使用可能

例

local isDisabled = ButtonSetDisabledFlag("GroupMenuWindowGroupKickButton" )

ButtonSetStayDownFlag()

ユーザーがマウスの左ボタンを放しても、押されたままのボタン表示を維持するかどうかを設定します。

パラメータ

buttonName(string) ボタンの名前。
stayDown(boolean) ボタンを押されたままの状態で維持するか？

戻り値

nil戻り値無し。

メモ

  • ButtonSetPressedFlag() 関数と一緒に使用する場合にこの設定は非常に便利です。一般的なボタンをタブやラジオボタンとして使用できるようにしたり、「状態」情報を表示したりできるようにします。

例

ButtonSetStayDownFlag( ChatWindow.Tabs[index].tabButton, true )

ButtonGetStayDownFlag()

現在のボタン表示状態（マウスの左ボタンを放しても、押されたままのボタン表示を維持するかどうか）を返します。

パラメータ

buttonName(string) ボタンの名前。

戻り値

stayDown(boolean) true = 維持する, false = 維持しない

例

local stayDown = ButtonGetStayDownFlag( "SomeWindow" )

ButtonSetCheckButtonFlag()

チェックボタンのようにボタンを動作させたい場合に設定します。

このフラグを設定すると、1クリックごとにボタンの状態が切り替わるようになります。

パラメータ

buttonName(string) ボタンの名前。
isCheckButton(boolean) チェックボタンのように動作させるか否か？

戻り値

nil戻り値無し。

メモ

  • チェックボタンを作るには、ボタンが現在チェックされているかどうかを調べる ButtonGetPressedFlag() を呼び出し、<OnLButtonUp> イベントのコールバックを登録してください。

例

ButtonSetCheckButtonFlag( "SettingsResolutionUseFullscreenButton", true )

ButtonGetCheckButtonFlag()

ボタンが現在、チェックボタンのように動作しているかどうかを調べて値を返します。

パラメータ

buttonName(string) ボタンの名前。

戻り値

isCheckButton(boolean) true = 動作している, false = 動作していない

例

local isCheckButton = ButtonGetCheckButtonFlag( "SettingsResolutionUseFullscreenButton" )

ButtonSetTexture()

特定のボタン状態に使用するテクスチャを設定します。

パラメータ

buttonName(string) ボタンの名前。
buttonState(integer) 設定するボタン状態。有効な値は <Button States> で確認してください。
textureName(string) 使用するUI Texture の名前。
x(integer) テクスチャ内のX座標。
y(integer) テクスチャ内のY座標。

戻り値

nil戻り値無し。

例

ButtonSetTexture("SomeButton", Button.ButtonState.NORMAL, "texture_name", 156, 40);

ButtonSetTextColor()

特定のボタン状態に使用するテキストカラーを設定します。

パラメータ

buttonName(string) ボタンの名前。
buttonState(integer) 設定するボタン状態。有効な値は <Button States> で確認してください。
r(integer) テキストカラーの赤色の値。
g(integer) テキストカラーの緑色の値。
b(integer) テキストカラーの青色の値。

戻り値

nil戻り値無し。

例

ButtonSetTextColor("SomeButton", Button.ButtonState.NORMAL, 255, 0, 255);

ButtonGetTextDimensions()

指定したボタンのテキストのサイズを返します。

パラメータ

buttonName(string) ボタンの名前。

戻り値

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

メモ

  • 手動でウィンドウサイズを変更してデータに合わせる際にとても役立ちます。

例

local x, y = ButtonGetTextDimensions("SomeWindow")
ユーザーがマウスの左ボタンを放しても、押されたままのボタン表示を維持するかどうかを設定します。
ウィンドウ (Window) 要素はウィンドウを作成する際に使用する基本的な要素です。他のウィンドウ要素もこの要素の内容を継承しており、全ての属性、要素、データメンバー、関数をサポートしています。
単体のアートテクスチャコンポーネントを定義します。
ダイナミックイメージに使用するテクスチャのサイズを明確に指定します。
フォントを定義します。
オーバーレイ画像レイヤーに使用するテクスチャの名前。
オーバーレイハイライト画像レイヤーに使用するテクスチャの名前。
アニメーテッドイメージ (AnimatedImage) 要素を使えば、ページめくりスタイルのアニメーションを自動化することができます。
ウィンドウにマウスカーソルが重なったときに呼び出されます。
ウィンドウからマウスカーソルが外れた時に呼び出されます。
現在のボタン表示状態（使用不可かどうか）を返します。
ボタン表示を「押されている」状態に設定するための関数です。
現在のボタン表示状態（押されているかどうか）を返します。
Close