Window

ウィンドウ (Window) 要素はウィンドウを作成する際に使用する基本的な要素です。他のウィンドウ要素もこの要素の内容を継承しており、全ての属性、要素、データメンバー、関数をサポートしています。

Summary
Windowウィンドウ (Window) 要素はウィンドウを作成する際に使用する基本的な要素です。他のウィンドウ要素もこの要素の内容を継承しており、全ての属性、要素、データメンバー、関数をサポートしています。
XML定義
XMLタグ
必須属性
nameウィンドウの名前。
任意属性
inherits他のウィンドウ要素から属性を継承できるようにします。
layerウィンドウのUIを定義します。
movableウィンドウをドラッグアンドドロップで移動可能にします。
popableウィンドウをクリックした時に、レイヤーの最前面に表示させます。
taborderタブがフォーカスを循環する順番です。
id数字上のID番号。固有の値である必要はありません。
handleinputウィンドウ要素がマウスイベントを処理するかどうかを判断します。
skipinput親ウィンドウが入力内容を処理せずに、そのまま子ウィンドウに渡すことができるようにします。
stickyウィンドウをドラッグしてスクリーンの外に出すことができるかどうかを指定します。
draganddropウィンドウへのアイテムのドラッグアンドドロップを許可するかどうかを指定します。
localscriptvarsローカルスクリプト変数を使用するかどうかを指定します。
gameactionbuttonこのウィンドウにゲームアクションが関連付けられている場合に、どちらのマウスボタンでゲームアクションを発生させるかを指定します。
alphaウィンドウのアルファ値を指定します。
savesettingsウィンドウの設定を ModSettings.xml ファイルの Windows セクションに保存するかどうかを指定します。
要素
要素
Sizeこの要素はウィンドウの最初のサイズを定義します。
Anchors他のウィンドウとの相対的なウィンドウ位置を定義します。
EventHandlers_一般的なウィンドウイベント用のコールバックと、呼び出す関数を指定することができます。
Soundsイベント発生時に呼び出すLua関数を指定して音を鳴らします。
TintColorウィンドウのテクスチャ要素の色の濃淡値を指定します。
Othersその他に以下の要素が使用できます。
定数
定数 (Animation Types)
Window.AnimationType.SINGLE開始値と終了値の間でスムーズにフェードします。完了すると元の値に戻ります。
Window.AnimationType.SINGLE_NO_RESET開始値と終了値の間でスムーズにフェードしますが、完了しても値をリセットしません。
Window.AnimationType.EASE_OUTシングルパスでは、終了値が近づくにつれより早くフェードします。SINGLE_NO_RESET に似ていますが、放物線補間を使っています。
Window.AnimationType.LOOP開始値 -> 終了値 -> 開始値 -> 終了値の間で連続的にスムーズにフェードします。
Window.AnimationType.REPEAT開始値 -> 終了値、開始値 -> 終了値の間で連続的にスムーズにフェードします。
Window.AnimationType.POP開始値から終了値へフェードし、少し待ってから、フェードインしたのと同じ速度で終了値から開始値へフェードします。
Window.AnimationType.POP_AND_EASE開始値から終了値へ素早くフェードし、それから終了値から開始値へとゆっくりとフェードします。
定数 (Window Layers)
Window.Layers.BACKGROUNDXMLの “background” 値に対応。
Window.Layers.DEFAULTXMLの “default” 値に対応。
Window.Layers.SECONDARYXMLの “secondary” 値に対応。
Window.Layers.POPUPXMLの “popup” 値に対応。
Window.Layers.OVERLAYXMLの “overlay” 値に対応。
定数 (Game Action Buttons)
Window.GameActionButtons.LEFTXMLの “left” 値に対応。
Window.GameActionButtons.RIGHTXMLの “right” 値に対応。
関数
関数
WindowRegisterCoreEventHandler()ウィンドウのコアイベントにコールバックを登録します。
WindowUnregisterCoreEventHandler()ウィンドウのコアイベントに登録されているコールバックを解除します。
WindowRegisterEventHandler()ゲームイベントにコールバックを登録します。
WindowUnregisterEventHandler()ウィンドウのイベントに登録されているコールバックを解除します。
WindowSetId()ウィンドウにID番号を設定します。
WindowGetId()指定したウィンドウのID番号を返します。
WindowSetTabOrder()ウィンドウにタブオーダー番号を設定します。
WindowGetTabOrder()指定したウィンドウのタブオーダー番号を返します。
WindowSetAlpha()ウィンドウのテクスチャ要素のアルファ値を設定します。
WindowGetAlpha()ウィンドウの現在のアルファ値を返します。
WindowSetTintColor()ウィンドウのテクスチャ要素の色の濃淡値を設定します。
WindowGetTintColor()ウィンドウのテクスチャ要素の色の濃淡値を返します。
WindowSetFontAlpha()ウィンドウのテクスチャ要素のアルファ値を設定します。
WindowGetFontAlpha()ウィンドウの現在のフォントアルファ値を返します。
WindowSetOffsetFromParent()親ウィンドウからの位置を設定します。
WindowGetOffsetFromParent()親ウィンドウからの位置を返します。
WindowGetScreenPosition()ウィンドウの現在位置を返します。
WindowSetDimensions()ウィンドウの縦横のサイズを設定します。
WindowGetDimensions()ウィンドウの縦横のサイズを返します。
WindowSetShowing()ウィンドウを画面上に表示します。
WindowGetShowing()ウィンドウが現在画面上に表示されているかどうかを調べて値を返します。
WindowSetLayer()ウィンドウが描画するべきレイヤーを設定します。
WindowGetLayer()ウィンドウが現在描画しているレイヤーの番号を返します。
WindowSetHandleInput()ウィンドウがマウス入力を扱うかどうかを設定します。
WindowGetHandleInput()ウィンドウがマウス入力を扱う設定になっているかどうかを調べて値を返します。
WindowSetPopable()ウィンドウのポップアップを設定します。
WindowGetPopable()ウィンドウの現在のポップアップ設定(有効か無効か)を返します。
WindowSetMovable()ウィンドウが移動できるようにするかどうかを設定します。
WindowGetMovable()ウィンドウの現在の移動可能設定(可能か不可能か)を返します。
WindowIsSticky()ウィンドウの sticky 属性を調べて値を返します。
WindowSetMoving()指定したウィンドウがカーソルと共に移動するようにするかどうかを設定します。
WindowGetMoving()ウィンドウが現在カーソルに沿って移動しているのかどうかを調べて値を返します。
WindowClearAnchors()ウィンドウから全てのアンカーを取り除きます。
WindowAddAnchor()ウィンドウに新しいアンカーを追加します。
WindowGetAnchorCount()このウィンドウが持つアンカーの数を返します。
WindowGetAnchor()アンカー情報を返します。
WindowForceProcessAnchors()ウィンドウにアンカーを強制的に処理させます。
WindowAssignFocus()このウィンドウ要素にダイレクトフォーカスを割り当てたり、取り除いたりします。
WindowHasFocus()ウィンドウが現在フォーカスされているかどうかを調べて値を返します。
WindowSetResizing()マウスでドラッグされている時にウィンドウを断続的にリサイズするかどうかを設定します。
WindowGetResizing()ウィンドウの現在のリサイズ設定を返します。
WindowStartAlphaAnimation()関数パラメータから得られたウィンドウで、自動化されたアルファアニメーションを開始します。
WindowStopAlphaAnimation()現在のアルファアニメーションを停止し、本来のアルファ値にウィンドウをリセットします。
WindowStartPositionAnimation()関数パラメータから得られたウィンドウで、自動化された位置アニメーションを開始します。
WindowStopPositionAnimation()現在の位置でアニメーションを停止し、アンカーが設定された位置にウィンドウを戻します。
WindowStartScaleAnimation()関数パラメータから得られたウィンドウで、自動化されたスケールアニメーションを開始します。
WindowStopScaleAnimation()現在のスケールアニメーションを停止し、ウィンドウを元の縮尺に戻します。
WindowSetParent()指定したウィンドウの親ウィンドウを変更します。
WindowGetParent()指定したウィンドウの親ウィンドウの名前を返します。
WindowSetScale()ウィンドウの現在の縮尺を設定します。
WindowGetScale()ウィンドウの現在の縮尺を返します。
WindowSetRelativeScale()現在の縮尺を基準として、ウィンドウを相対的にスケーリングします。
DoesWindowExist()指定した名前のウィンドウが存在しているかどうかを調べます。
WindowResizeOnChildren()子ウィンドウの最大サイズを基準に親ウィンドウのサイズを変更します。
WindowSetGameActionTrigger()このウィンドウをクリックした時にキーバインド可能なアクションを設定します。
WindowSetGameActionData()このウィンドウをクリックした時に発動するゲームアクション(キーバインドできるアクション)を設定します。
WindowSetGameActionButton()ウィンドウと結びつけられたゲームアクションを発動するのに使うゲームアクションボタンを設定します。
WindowGetGameActionButton()指定したウィンドウでのゲームアクションの発動に設定されているボタンの値を返します。
WindowIsGameActionLocked()指定したウィンドウが現在ゲームアクションの編集をロックされているかどうかを調べます。
WindowSetDrawWhenInterfaceHidden()メインUIが隠れている時に、ウィンドウを描写すべきかどうかを設定します。
WindowRestoreDefaultSettings()ウィンドウを初期化して、デフォルトのアンカー、サイズ、スケール、アルファ値に戻します。

XML定義

Summary
XMLタグ
必須属性
nameウィンドウの名前。
任意属性
inherits他のウィンドウ要素から属性を継承できるようにします。
layerウィンドウのUIを定義します。
movableウィンドウをドラッグアンドドロップで移動可能にします。
popableウィンドウをクリックした時に、レイヤーの最前面に表示させます。
taborderタブがフォーカスを循環する順番です。
id数字上のID番号。固有の値である必要はありません。
handleinputウィンドウ要素がマウスイベントを処理するかどうかを判断します。
skipinput親ウィンドウが入力内容を処理せずに、そのまま子ウィンドウに渡すことができるようにします。
stickyウィンドウをドラッグしてスクリーンの外に出すことができるかどうかを指定します。
draganddropウィンドウへのアイテムのドラッグアンドドロップを許可するかどうかを指定します。
localscriptvarsローカルスクリプト変数を使用するかどうかを指定します。
gameactionbuttonこのウィンドウにゲームアクションが関連付けられている場合に、どちらのマウスボタンでゲームアクションを発生させるかを指定します。
alphaウィンドウのアルファ値を指定します。
savesettingsウィンドウの設定を ModSettings.xml ファイルの Windows セクションに保存するかどうかを指定します。

XMLタグ

<Window>
....
</Window>

必須属性

name

ウィンドウの名前。

インターフェース全体を通じて固有の名前でなければなりません。

データ型

string

メモ

  • nameタグの中に “$parent” タグを挿入することで、親ウィンドウの名前を先頭に付け加えることができます。例えば、以下のケースでは、二つのウィンドウは同じ名前(TargetWindowBackground)になります。
<Window name="TargetWindow" >
    <Windows>
        <Window name="$parentBackground/>
    </Windows>
</Window>

任意属性

inherits

他のウィンドウ要素から属性を継承できるようにします。

継承タイプは作成中のウィンドウタイプと同じでなければなりません。例えば、ボタンはボタン定義のみを継承でき、ラベルはラベル定義のみを継承できます。

データ型

string同じタイプの有効なウィンドウ定義の名前

デフォルト値

  • ””

メモ

  • ”CoreWindowTemplates.xml” と “UO_Default_UI_Templates.xml” に様々な要素のテンプレートがまとめられています。

layer

ウィンドウのUIを定義します。

シングルレイヤーは全てのレイヤーの一番上に表示されます。クリックすることで最前面に表示する popable 属性を設定することもできます。UIでセカンダリウィンドウを作る際にしばしば使われます。

データ型

string次の中からどれか一つが入ります:
  • ”background”
  • ”default”
  • ”secondary”
  • ”popup”
  • ”overlay”

デフォルト値

  • ”default”

movable

ウィンドウをドラッグアンドドロップで移動可能にします。

この属性が設定されたウィンドウは常に OnLButtonDown , OnLButtonUp イベントで扱われるため、移動可能なウィンドウの内側をクリックしても移動してしまうことはありません。

データ型

boolean

trueウィンドウをマウスでドラッグすることを許可する。
falseウィンドウをマウスでドラッグすることを許可しない。

デフォルト値

  • false

関連する関数

popable

ウィンドウをクリックした時に、レイヤーの最前面に表示させます。

データ型

boolean

trueレイヤーの最前面に表示させる。
falseウィンドウの描画順を守る。

デフォルト値

  • true

taborder

タブがフォーカスを循環する順番です。

既存のウィンドウでは、全ての子要素が設定されたタブ順の値を持っている可能性があります。タブ順が設定されている場合、ウィンドウが表示される時に順番の最初に指定されている要素が自動的にフォーカスされます。これはウィンドウを開いたときに、エディットボックスにデフォルトでフォーカスするよう設定する際に役立ちます。

データ型

integer親ウィンドウのタブ順内のアイテムの最大値。

デフォルト値

  • 0

id

数字上のID番号。固有の値である必要はありません。

一連の要素のための単独のコールバックを作成するのに非常によく使います。

データ型

Integerマイナスの値も使用できます。

デフォルト値

  • 0

関連する関数

handleinput

ウィンドウ要素がマウスイベントを処理するかどうかを判断します。

falseに設定された場合、UIはこのウィンドウや子ウィンドウ内で行われたあらゆるクリックやマウスオーバーイベントを無視します。このフラグが役立つのは次の二つのケースです:

  • ウィンドウを第一階層に表示させつつも、クリックが常にメインウィンドウにフォーカスするようにするケース。
  • いくつかのピースから成り立つ複雑なウィンドウ要素を作るが、マウスに反応するのを親だけにしたいケース。

データ型

boolean

trueマウスイベントを処理する。
false全てのマウスイベントを無視する。

デフォルト値

  • true

skipinput

親ウィンドウが入力内容を処理せずに、そのまま子ウィンドウに渡すことができるようにします。

入力内容を受け取る子ウィンドウは親の中に含まれていなければなりませんが、親ウィンドウはボタンクリックもマウスオーバーも処理しません。ボタンイベントを処理しない、レイアウト目的だけの大きなコンテナウィンドウを作る際に役立ちます。

データ型

boolean

trueマウスイベントを処理する。
false全てのマウスイベントを無視する。

デフォルト値

  • false

sticky

ウィンドウをドラッグしてスクリーンの外に出すことができるかどうかを指定します。

データ型

boolean

true出すことができる。
false出すことができない。

デフォルト値

  • false

関連する関数

draganddrop

ウィンドウへのアイテムのドラッグアンドドロップを許可するかどうかを指定します。

データ型

boolean

true許可する。
false許可しない。

デフォルト値

  • false

localscriptvars

ローカルスクリプト変数を使用するかどうかを指定します。

使用する場合、システムはLuaウィンドウステートテーブルを作り、直接C関数を呼び出す代わりにクエリとして使用します。

データ型

boolean

true使用する。
false使用しない。

デフォルト値

  • false

gameactionbutton

このウィンドウにゲームアクションが関連付けられている場合に、どちらのマウスボタンでゲームアクションを発生させるかを指定します。

データ型

string

”left”左マウスボタンを押した時。
”right”右マウスボタンを押した時。

デフォルト値

  • ”left”

alpha

ウィンドウのアルファ値を指定します。

データ型

float_t0 〜 1.0

デフォルト値

  • 1.0

savesettings

ウィンドウの設定を ModSettings.xml ファイルの Windows セクションに保存するかどうかを指定します。

データ型

string

”true”このウィンドウの設定は自動的に保存・読み出しされません。
”false”このウィンドウの設定は保存・読み出しされません。
”auto”第一階層のウィンドウ(ルートウィンドウの直接の子)の場合、設定は保存されます。

デフォルト値

  • ”auto”

要素

Summary
要素
Sizeこの要素はウィンドウの最初のサイズを定義します。
Anchors他のウィンドウとの相対的なウィンドウ位置を定義します。
EventHandlers_一般的なウィンドウイベント用のコールバックと、呼び出す関数を指定することができます。
Soundsイベント発生時に呼び出すLua関数を指定して音を鳴らします。
TintColorウィンドウのテクスチャ要素の色の濃淡値を指定します。
Othersその他に以下の要素が使用できます。

要素

Size

この要素はウィンドウの最初のサイズを定義します。

この要素が指定されていない場合、ウィンドウは x=”0”, Y=”0” で初期化されます。

構文

<Size>
    <AbsPoint x="800" y="600" />
</Size>
AbsPointウィンドウの絶対サイズ。
xXピクセルサイズ。
yYピクセルサイズ。

メモ

  • ここで宣言した値に縮尺 (Scale) が適用されます。

Anchors

他のウィンドウとの相対的なウィンドウ位置を定義します。

ウィンドウがアンカー要素を持っていない場合、親の位置がデフォルトになります。

構文

<Anchors>
    <Anchor point="topright" relativePoint="topleft" relativeTo="SomeOtherWindow">
        <AbsPoint x="0" y="0" />
    </Anchor>
</Anchors>
pointウィンドウのアンカーポイント (AbsPointの子要素では絶対座標を指定)。
relativePoint子ウィンドウから見て、アンカーポイントがどの位置にあるかを指定します。
relativeTo条件付けをするウィンドウ。

メモ-01

”point” と “relativePoint” に指定できる内容は次の通りです:

  • ”topleft”
  • ”top”
  • ”topright”
  • ”left”
  • ”center”
  • ”right”
  • ”bottomleft”
  • ”bottom”
  • ”bottomright”

メモ-02

  • <Anchor point=”topleft”>で、”relativePoint = “ を指定する際のイメージは次の通りです:

メモ-03

  • Luaコードの中にウィンドウを移動可能にするアンカリングを設定することができます。以下のコードでは”ドラッグ”効果を表示するため、現在のカーソル位置にウィンドウを再描画します。
WindowClearAnchors( windowName )
WindowAddAnchor(windowName, "topleft", "Root", "topleft", SystemData.MousePosition.x, SystemData.MousePosition.y+150)

関連する関数

EventHandlers_

一般的なウィンドウイベント用のコールバックと、呼び出す関数を指定することができます。

詳細については、 EventHandlers のページを参照してください。

構文

<EventHandlers>
    <EventHandler event="OnLButtonUp" function="ActionEditWindow.EquipLButtonUp" />
</EventHandlers>

Sounds

イベント発生時に呼び出すLua関数を指定して音を鳴らします。

構文

<Sounds>
    <Sound event="OnLButtonDown" script="Sound.Play( Sound.BUTTON_CLICK )" />
    <Sound event="OnMouseOver" script="Sound.Play( Sound.BUTTON_OVER )" />
</Sounds>

TintColor

ウィンドウのテクスチャ要素の色の濃淡値を指定します。

構文

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

Others

その他に以下の要素が使用できます。

定数

Summary
定数 (Animation Types)
Window.AnimationType.SINGLE開始値と終了値の間でスムーズにフェードします。完了すると元の値に戻ります。
Window.AnimationType.SINGLE_NO_RESET開始値と終了値の間でスムーズにフェードしますが、完了しても値をリセットしません。
Window.AnimationType.EASE_OUTシングルパスでは、終了値が近づくにつれより早くフェードします。SINGLE_NO_RESET に似ていますが、放物線補間を使っています。
Window.AnimationType.LOOP開始値 -> 終了値 -> 開始値 -> 終了値の間で連続的にスムーズにフェードします。
Window.AnimationType.REPEAT開始値 -> 終了値、開始値 -> 終了値の間で連続的にスムーズにフェードします。
Window.AnimationType.POP開始値から終了値へフェードし、少し待ってから、フェードインしたのと同じ速度で終了値から開始値へフェードします。
Window.AnimationType.POP_AND_EASE開始値から終了値へ素早くフェードし、それから終了値から開始値へとゆっくりとフェードします。
定数 (Window Layers)
Window.Layers.BACKGROUNDXMLの “background” 値に対応。
Window.Layers.DEFAULTXMLの “default” 値に対応。
Window.Layers.SECONDARYXMLの “secondary” 値に対応。
Window.Layers.POPUPXMLの “popup” 値に対応。
Window.Layers.OVERLAYXMLの “overlay” 値に対応。
定数 (Game Action Buttons)
Window.GameActionButtons.LEFTXMLの “left” 値に対応。
Window.GameActionButtons.RIGHTXMLの “right” 値に対応。

定数 (Animation Types)

Window.AnimationType.SINGLE

開始値と終了値の間でスムーズにフェードします。完了すると元の値に戻ります。

Window.AnimationType.SINGLE_NO_RESET

開始値と終了値の間でスムーズにフェードしますが、完了しても値をリセットしません。

Window.AnimationType.EASE_OUT

シングルパスでは、終了値が近づくにつれより早くフェードします。SINGLE_NO_RESET に似ていますが、放物線補間を使っています。

Window.AnimationType.LOOP

開始値 -> 終了値 -> 開始値 -> 終了値の間で連続的にスムーズにフェードします。

Window.AnimationType.REPEAT

開始値 -> 終了値、開始値 -> 終了値の間で連続的にスムーズにフェードします。

Window.AnimationType.POP

開始値から終了値へフェードし、少し待ってから、フェードインしたのと同じ速度で終了値から開始値へフェードします。

Window.AnimationType.POP_AND_EASE

開始値から終了値へ素早くフェードし、それから終了値から開始値へとゆっくりとフェードします。

定数 (Window Layers)

Window.Layers.BACKGROUND

XMLの “background” 値に対応。

Window.Layers.DEFAULT

XMLの “default” 値に対応。

Window.Layers.SECONDARY

XMLの “secondary” 値に対応。

Window.Layers.POPUP

XMLの “popup” 値に対応。

Window.Layers.OVERLAY

XMLの “overlay” 値に対応。

定数 (Game Action Buttons)

Window.GameActionButtons.LEFT

XMLの “left” 値に対応。

Window.GameActionButtons.RIGHT

XMLの “right” 値に対応。

関数

Summary
関数
WindowRegisterCoreEventHandler()ウィンドウのコアイベントにコールバックを登録します。
WindowUnregisterCoreEventHandler()ウィンドウのコアイベントに登録されているコールバックを解除します。
WindowRegisterEventHandler()ゲームイベントにコールバックを登録します。
WindowUnregisterEventHandler()ウィンドウのイベントに登録されているコールバックを解除します。
WindowSetId()ウィンドウにID番号を設定します。
WindowGetId()指定したウィンドウのID番号を返します。
WindowSetTabOrder()ウィンドウにタブオーダー番号を設定します。
WindowGetTabOrder()指定したウィンドウのタブオーダー番号を返します。
WindowSetAlpha()ウィンドウのテクスチャ要素のアルファ値を設定します。
WindowGetAlpha()ウィンドウの現在のアルファ値を返します。
WindowSetTintColor()ウィンドウのテクスチャ要素の色の濃淡値を設定します。
WindowGetTintColor()ウィンドウのテクスチャ要素の色の濃淡値を返します。
WindowSetFontAlpha()ウィンドウのテクスチャ要素のアルファ値を設定します。
WindowGetFontAlpha()ウィンドウの現在のフォントアルファ値を返します。
WindowSetOffsetFromParent()親ウィンドウからの位置を設定します。
WindowGetOffsetFromParent()親ウィンドウからの位置を返します。
WindowGetScreenPosition()ウィンドウの現在位置を返します。
WindowSetDimensions()ウィンドウの縦横のサイズを設定します。
WindowGetDimensions()ウィンドウの縦横のサイズを返します。
WindowSetShowing()ウィンドウを画面上に表示します。
WindowGetShowing()ウィンドウが現在画面上に表示されているかどうかを調べて値を返します。
WindowSetLayer()ウィンドウが描画するべきレイヤーを設定します。
WindowGetLayer()ウィンドウが現在描画しているレイヤーの番号を返します。
WindowSetHandleInput()ウィンドウがマウス入力を扱うかどうかを設定します。
WindowGetHandleInput()ウィンドウがマウス入力を扱う設定になっているかどうかを調べて値を返します。
WindowSetPopable()ウィンドウのポップアップを設定します。
WindowGetPopable()ウィンドウの現在のポップアップ設定(有効か無効か)を返します。
WindowSetMovable()ウィンドウが移動できるようにするかどうかを設定します。
WindowGetMovable()ウィンドウの現在の移動可能設定(可能か不可能か)を返します。
WindowIsSticky()ウィンドウの sticky 属性を調べて値を返します。
WindowSetMoving()指定したウィンドウがカーソルと共に移動するようにするかどうかを設定します。
WindowGetMoving()ウィンドウが現在カーソルに沿って移動しているのかどうかを調べて値を返します。
WindowClearAnchors()ウィンドウから全てのアンカーを取り除きます。
WindowAddAnchor()ウィンドウに新しいアンカーを追加します。
WindowGetAnchorCount()このウィンドウが持つアンカーの数を返します。
WindowGetAnchor()アンカー情報を返します。
WindowForceProcessAnchors()ウィンドウにアンカーを強制的に処理させます。
WindowAssignFocus()このウィンドウ要素にダイレクトフォーカスを割り当てたり、取り除いたりします。
WindowHasFocus()ウィンドウが現在フォーカスされているかどうかを調べて値を返します。
WindowSetResizing()マウスでドラッグされている時にウィンドウを断続的にリサイズするかどうかを設定します。
WindowGetResizing()ウィンドウの現在のリサイズ設定を返します。
WindowStartAlphaAnimation()関数パラメータから得られたウィンドウで、自動化されたアルファアニメーションを開始します。
WindowStopAlphaAnimation()現在のアルファアニメーションを停止し、本来のアルファ値にウィンドウをリセットします。
WindowStartPositionAnimation()関数パラメータから得られたウィンドウで、自動化された位置アニメーションを開始します。
WindowStopPositionAnimation()現在の位置でアニメーションを停止し、アンカーが設定された位置にウィンドウを戻します。
WindowStartScaleAnimation()関数パラメータから得られたウィンドウで、自動化されたスケールアニメーションを開始します。
WindowStopScaleAnimation()現在のスケールアニメーションを停止し、ウィンドウを元の縮尺に戻します。
WindowSetParent()指定したウィンドウの親ウィンドウを変更します。
WindowGetParent()指定したウィンドウの親ウィンドウの名前を返します。
WindowSetScale()ウィンドウの現在の縮尺を設定します。
WindowGetScale()ウィンドウの現在の縮尺を返します。
WindowSetRelativeScale()現在の縮尺を基準として、ウィンドウを相対的にスケーリングします。
DoesWindowExist()指定した名前のウィンドウが存在しているかどうかを調べます。
WindowResizeOnChildren()子ウィンドウの最大サイズを基準に親ウィンドウのサイズを変更します。
WindowSetGameActionTrigger()このウィンドウをクリックした時にキーバインド可能なアクションを設定します。
WindowSetGameActionData()このウィンドウをクリックした時に発動するゲームアクション(キーバインドできるアクション)を設定します。
WindowSetGameActionButton()ウィンドウと結びつけられたゲームアクションを発動するのに使うゲームアクションボタンを設定します。
WindowGetGameActionButton()指定したウィンドウでのゲームアクションの発動に設定されているボタンの値を返します。
WindowIsGameActionLocked()指定したウィンドウが現在ゲームアクションの編集をロックされているかどうかを調べます。
WindowSetDrawWhenInterfaceHidden()メインUIが隠れている時に、ウィンドウを描写すべきかどうかを設定します。
WindowRestoreDefaultSettings()ウィンドウを初期化して、デフォルトのアンカー、サイズ、スケール、アルファ値に戻します。

関数

WindowRegisterCoreEventHandler()

ウィンドウのコアイベントにコールバックを登録します。

パラメータ

windowName(string) ウィンドウの名前。
eventName(string) コールバックを発生させるイベントの名前 (参考: EventHandler )。
callback(string) イベントが発生した時に呼び出されるLua関数の名前。

戻り値

nil戻り値無し。

メモ

各ウィンドウは特定のコアイベント用のコールバックを一つだけ持つことができます。コールバックが登録済みの場合、エラーメッセージが <UiLog> に記録されます。イベント登録を変更したい場合には、パラメータに古いイベントを指定して、最初に WindowUnregisterCoreEventHandler を呼び出す必要があります。

WindowRegisterCoreEventHandler(

        "PlayerWindow", "OnMouseOver", "PlayerWindow.OnMouseOver")

WindowUnregisterCoreEventHandler()

ウィンドウのコアイベントに登録されているコールバックを解除します。

パラメータ

windowName(string) ウィンドウの名前。
eventName(string) コールバックの登録を解除するイベントの名前。

戻り値

nil戻り値無し。

WindowUnregisterCoreEventHandler( "PlayerWindow", "OnMouseOver" )

WindowRegisterEventHandler()

ゲームイベントにコールバックを登録します。

パラメータ

windowName(string) ウィンドウの名前。
eventId(integer) コールバックを登録したいイベントのID番号。
callback(string) イベントが発生した時に呼び出されるLua関数の名前。

戻り値

nil戻り値無し。

メモ

  • 各ウィンドウは特定のイベント用のコールバックを一つだけ持つことができます。コールバックが登録済みの場合、エラーメッセージが <UiLog> に記録されます。イベント登録を変更したい場合には、パラメータに古いイベントを指定して、最初に WindowUnregisterEventHandler を呼び出す必要があります。

WindowRegisterEventHandler("PlayerWindow", SystemData.Events.PLAYER_CUR_HIT_POINTS_UPDATED,
"PlayerWindow.UpdateCurrentHitPoints")

WindowUnregisterEventHandler()

ウィンドウのイベントに登録されているコールバックを解除します。

パラメータ

windowName(string) ウィンドウの名前。
eventId(integer) コールバックの登録を解除するイベントのID番号。

戻り値

nil戻り値無し。

WindowUnregisterEventHandler( "PlayerWindow", SystemData.Events.PLAYER_CUR_HIT_POINTS_UPDATED )

WindowSetId()

ウィンドウにID番号を設定します。

パラメータ

windowName(string) ウィンドウの名前。
id(integer) ウィンドウに割り当てられたID番号。

戻り値

nil戻り値無し。

関連するXML

メモ

  • ウィンドウのID番号は固有の値である必要はありません。固有かどうかの判断にはウィンドウの名前が使われるので、ID番号はXML/Lua内での用途に応じて定義してください。

WindowSetId( "GroupWindowMember3", 3 )

WindowGetId()

指定したウィンドウのID番号を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

id(integer) ウィンドウのID番号。

関連するXML

メモ

  • ウィンドウのID番号は固有の値である必要はありません。固有かどうかの判断にはウィンドウの名前が使われるので、ID番号はXML/Lua内での用途に応じて定義してください。

local index = WindowGetId( <SystemData.ActiveWindow.name> )

WindowSetTabOrder()

ウィンドウにタブオーダー番号を設定します。

パラメータ

windowName(string) ウィンドウの名前。
tabOrder(integer) ウィンドウに割り当てるタブオーダー番号。

戻り値

nil戻り値無し。

関連するXML

WindowSetTabOrder( "EditBox1", 1 )

WindowGetTabOrder()

指定したウィンドウのタブオーダー番号を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

TabOrder(integer) ウィンドウのタブオーダー番号。

関連するXML

local tabOrder = WindowGetTabOrder( <SystemData.ActiveWindow.name> )

WindowSetAlpha()

ウィンドウのテクスチャ要素のアルファ値を設定します。

この値は「親のアルファ」値として、全ての子要素に伝播します。画面上に表示される最終的なアルファ値は、ウィンドウのアルファ値と親のアルファ値を掛け合わせた値になります。

パラメータ

windowName(string) ウィンドウの名前。
alpha(float_t) アルファ値: 0.0 〜 1.0

戻り値

nil戻り値無し。

メモ

ウィンドウ要素でアルファを動かしたい場合には、フレーム毎に直接 WindowSetAlpha を呼ぶよりも、以下のanimation関数を使った方が良いでしょう:

WindowSetAlpha( "ChatBubbleWindow"..index, 0.5 )

WindowGetAlpha()

ウィンドウの現在のアルファ値を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

alpha(float_t) アルファ値: 0.0 〜 1.0

メモ

  • このアルファ値はこの特定のウィンドウ要素に設定された値です。もしウィンドウの親要素の一つが「アルファ値 < 1.0」なら、戻ってくるアルファ値はそれ以下です。

local alpha = WindowGetAlpha( "ChatBubbleWindow"..index, 0.5 )

WindowSetTintColor()

ウィンドウのテクスチャ要素の色の濃淡値を設定します。

パラメータ

windowName(string) ウィンドウの名前。
red(integer) 赤色の値(0-255)。
green(integer) 緑色の値(0-255)。
blue(integer) 青色の値(0-255)。

戻り値

nil戻り値無し。

関連するXML

local row_mod = math.mod (rowIndex, 2)

local color = DataUtils.GetAlternatingRowColor( row_mod )

WindowSetTintColor("KeyMappingWindowActionsListRow"..rowIndex.."BackgroundName", color.r, color.g, color.b);

WindowGetTintColor()

ウィンドウのテクスチャ要素の色の濃淡値を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

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

関連するXML

メモ

  • 濃淡値が0..1の範囲よりも下になった場合、値は0..255の範囲外になります。

local r, g, b = WindowGetTintColor("TargetWindowPortraitBackground")

WindowSetFontAlpha()

ウィンドウのテクスチャ要素のアルファ値を設定します。

この値は全ての子要素に伝播します。

パラメータ

windowName(string) ウィンドウの名前。
alpha(float_t) アルファ値: 0.0 〜 1.0

戻り値

nil戻り値無し。

WindowSetFontAlpha( "ChatBubbleWindow"..index., 0.5 )

WindowGetFontAlpha()

ウィンドウの現在のフォントアルファ値を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

alpha(float_t) アルファ値:0.0 〜 1.0

local fontAlpha = WindowGetFontAlpha( "ChatBubbleWindow"..index )

WindowSetOffsetFromParent()

親ウィンドウからの位置を設定します。

パラメータ

windowName(string) ウィンドウの名前。
xOffset(integer) 親ウィンドウの左上角からのXピクセル数。
yOffset(integer) 親ウィンドウの左上角からのYピクセル数。

戻り値

nil戻り値無し。

メモ

  • この関数はアンカーによる調整なしにウィンドウを手作業で動かします。もしウィンドウに正確にアンカーを打ちたいなら、適切なパラメータを付けて WindowClearAnchorsWindowAddAnchor を呼び出してください。
  • 親ウィンドウのサイズよりも大きな値を設定してしまった場合、そのウィンドウはマウスイベントを受け取ることができなくなります。

WindowSetOffsetFromParent( "ChatWindow", SystemData.Settings.Chat.windowPos.x, SystemData.Settings.Chat.windowPos.y )

WindowGetOffsetFromParent()

親ウィンドウからの位置を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

xOffset(integer) 親ウィンドウの左上角からのXピクセル数。
yOffset(integer) 親ウィンドウの左上角からのYピクセル数。

メモ

  • 親ウィンドウを基準としたウィンドウ位置は、ウィンドウの画面位置と同じではありません。画面位置が必要な場合には、代わりに WindowGetScreenPosition を使ってください。

WindowGetOffsetFromParent( "ChatWindow", SystemData.Settings.Chat.windowPos.x, SystemData.Settings.Chat.windowPos.y )

WindowGetScreenPosition()

ウィンドウの現在位置を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

xOffset(integer) 左上角のXピクセル。
yOffset(integer) 左上角のYピクセル。

local mouseoverX, mouseoverY    = WindowGetScreenPosition (Tooltips.curMouseOverWindow);

WindowSetDimensions()

ウィンドウの縦横のサイズを設定します。

パラメータ

windowName(string) ウィンドウの名前。
x(integer) Xのサイズ(縮尺なし)。
y(integer) Yのサイズ(縮尺なし)。

戻り値

nil戻り値無し。

メモ

  • XとYには縮尺が適用される前の値を指定してください。

WindowSetDimensions( "QuestTrackerWindow", totalWidth, height)

WindowGetDimensions()

ウィンドウの縦横のサイズを返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

x(integer) Xのサイズ(縮尺なし)。
y(integer) Yのサイズ(縮尺なし)。

local x, y = WindowGetDimensions( "MapPointsTooltipInfo"..index )

WindowSetShowing()

ウィンドウを画面上に表示します。

表示されていないウィンドウは、更新やマウスイベントを受け取ることができません。一般的なイベントハンドラは依然として処理されます。

パラメータ

windowName(string) ウィンドウの名前。
showing(boolean) true = 表示する, false = 表示しない

戻り値

nil戻り値無し。

メモ

  • ウィンドウが popable の場合、表示時にレイヤーの一番上にポップアップします。
  • 子ウィンドウに taborder が指定されている場合、表示時にタブオーダーの最初のアイテムをフォーカスします。

WindowSetShowing("QuestTrackerWindowMinMaxToggleMaxButton", QuestTrackerWindow.isMinimized == true)

WindowGetShowing()

ウィンドウが現在画面上に表示されているかどうかを調べて値を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

showing(boolean) true = 表示されている, false = 表示されていない

local showing = WindowGetShowing( "QuestTrackerWindow" )

WindowSetLayer()

ウィンドウが描画するべきレイヤーを設定します。

パラメータ

windowName(string) ウィンドウの名前。
layer(string) ウィンドウが描画するレイヤー。値は 定数 (Window Layers) を参照してください。

戻り値

nil戻り値無し。

関連するXML

WindowGetLayer()

ウィンドウが現在描画しているレイヤーの番号を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

layer(string) ウィンドウが描画しているレイヤー。値は 定数 (Window Layers) を参照してください。

local layer = WindowGetLayer( "" )

WindowSetHandleInput()

ウィンドウがマウス入力を扱うかどうかを設定します。

パラメータ

windowName(string) ウィンドウの名前。
handleinput(boolean) true = マウス入力を扱う, false = マウス入力を扱わない

戻り値

nil戻り値無し。

関連するXML

WindowGetHandleInput()

ウィンドウがマウス入力を扱う設定になっているかどうかを調べて値を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

handlingInput(boolean) true = マウス入力を扱う, false = マウス入力を扱わない

local isHandlingInput = WindowGetHandleInput( "SomeWindow" )

WindowSetPopable()

ウィンドウのポップアップを設定します。

設定をTrueにした場合、クリック時にウィンドウの layer が前面にポップアップします。

パラメータ

windowName(string) ウィンドウの名前。
popable(boolean) true = ポップアップさせる, false = ポップアップさせない

戻り値

nil戻り値無し。

関連するXML

WindowGetPopable()

ウィンドウの現在のポップアップ設定(有効か無効か)を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

isPopable(boolean) true = ポップアップする, false = ポップアップしない

local isPopable = WindowGetPopable( "SomeWindowName" )

WindowSetMovable()

ウィンドウが移動できるようにするかどうかを設定します。

Trueに設定した場合、ウィンドウをドラッグして移動できるようになります。

パラメータ

windowName(string) ウィンドウの名前。
movable(boolean) true = 移動可能にする, false = 移動不可能にする

戻り値

nil戻り値無し。

関連するXML

メモ

  • 右クリックメニューに”Lock/Unlock”オプションを追加することで、移動可能なウィンドウを移動できないように切り替えることもできます。

SystemData.Settings.Interface.lockTacticalMap = ButtonGetPressedFlag( "ScenarioMapMenuWindowLockButton" )

WindowSetMovable("ScenarioMapWindow", not SystemData.Settings.Interface.lockTacticalMap )

WindowGetMovable()

ウィンドウの現在の移動可能設定(可能か不可能か)を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

movable(boolean) true = 移動可能, false = 移動不可能

local movable = WindowGetShowing( "ScenarioMapWindowMapImage" )

WindowIsSticky()

ウィンドウの sticky 属性を調べて値を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

sticky(boolean) true = スクリーン外に出せる, false = スクリーン外に出せない

メモ

  • Stickyはウィンドウをスクリーン外に出せるかどうかを決める属性です。

WindowSetMoving()

指定したウィンドウがカーソルと共に移動するようにするかどうかを設定します。

パラメータ

windowName(string) ウィンドウの名前。
moving(boolean) true = 移動するようにする, false = 移動しないようにする

戻り値

nil戻り値無し。

メモ

  • この関数は movable に設定されたウィンドウ上での、通常の LButtonDown と LButtonUP よりも優先されます。

WindowGetMoving()

ウィンドウが現在カーソルに沿って移動しているのかどうかを調べて値を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

moving(boolean) true = 移動している, false = 移動していない

WindowClearAnchors()

ウィンドウから全てのアンカーを取り除きます。

全てのアンカーが取り除かれたウィンドウは、親ウィンドウの位置に戻ります。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

nil戻り値無し。

関連するXML

メモ

  • Luaでアンカーを取り除くのは、その場その場で動的にウィンドウにアンカーを追加したり、位置変更を行ったりする際に便利です。

WindowClearAnchors( windowName )

WindowAddAnchor()

ウィンドウに新しいアンカーを追加します。

パラメータ

windowName(string) ウィンドウの名前。
anchorPoint(string) ウィンドウにアンカーを追加する位置。 { “topleft”, “top”, “topright”, “left”, “center”, “right”, “bottomleft”, “bottom”, “bottomright” }
relativeTo(string) このアンカーを追加したい別のウィンドウの名前。
relativePoint(string) 別ウィンドウにアンカーを追加する位置。 { “topleft”, “top”, “topright”, “left”, “center”, “right”, “bottomleft”, “bottom”, “bottomright” }
xOffset(integer) このアンカー座標からのXピクセルの距離。
yOffset(integer) このアンカー座標からのYピクセルの距離。

戻り値

nil戻り値無し。

関連するXML

メモ

  • ウィンドウに一つか二つのアンカーがある場合に有効です。
  • ウィンドウが二つのアンカーを持っている場合、ウィンドウは二つのパラメータに合うよう自動的にリサイズされます。

WindowAddAnchor( windowName, "topleft", "Root", "topleft", SystemData.MousePosition.x, SystemData.MousePosition.y+150)

WindowGetAnchorCount()

このウィンドウが持つアンカーの数を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

integerこのウィンドウが持つアンカーの数。

関連するXML

WindowGetAnchor()

アンカー情報を返します。

パラメータ

windowName(string) ウィンドウの名前。
anchorId(integer) 調べたいアンカーのID。1から WindowGetAnchorCount の範囲です。

戻り値

point(string)
relativePoint(string)
relativeTo(string)
xOffset(integer)
yOffset(integer)

関連するXML

メモ

  • 戻ってくるオフセットの値は縮尺が適用される前のものです。

local point, relativePoint, relativeTo, xOffs, yOffs = WindowGetAnchor ("MyWindow", 1)

WindowForceProcessAnchors()

ウィンドウにアンカーを強制的に処理させます。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

nil戻り値無し。

関連するXML

メモ

  • 正しくないサイズ設定やアンカーが中途半端に組み合わさってしまった際に、ウィンドウの位置を「修正」するのに役立ちます。

WindowAssignFocus()

このウィンドウ要素にダイレクトフォーカスを割り当てたり、取り除いたりします。

結果として、全ての親ウィンドウ要素もフォーカスされます。

パラメータ

windowName(string) ウィンドウの名前。
focus(boolean) true = フォーカスを割り当てる, false = フォーカスを取り除く

戻り値

nil戻り値無し。

メモ

  • EditBox のような特定のウィンドウ要素は、表示されていないときもフォーカスを維持することができます。明示的に表示/非表示要素にフォーカスを合わせる際には注意してください。

WindowHasFocus()

ウィンドウが現在フォーカスされているかどうかを調べて値を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

focus(boolean) true = フォーカスされている, false = フォーカスされていない

WindowSetResizing()

マウスでドラッグされている時にウィンドウを断続的にリサイズするかどうかを設定します。

パラメータ

windowName(string) ウィンドウの名前。
resizing(boolean) true = リサイズを有効にする, false = リサイズを有効にしない

戻り値

nil戻り値無し。

メモ

  • 複数のウィンドウをリサイズすると、負荷がかかって処理が遅くなる可能性があります。直接ウィンドウのサイズを変えるよりは、 <WindowUtils> , <WindowUtils.BeginResize> , <WindowUtils.EndResize> などのリサイズ中にウィンドウの周りに灰色のリサイズボックスを作り出す関数を使ってください。そうすれば、実際のウィンドウサイズを一度更新するだけで済みます。

WindowGetResizing()

ウィンドウの現在のリサイズ設定を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

resizing(boolean) true = リサイズON, false = リサイズOFF

WindowStartAlphaAnimation()

関数パラメータから得られたウィンドウで、自動化されたアルファアニメーションを開始します。

パラメータ

windowName(string) ウィンドウの名前。
animType(number) アニメーションタイプ。有効な値は 定数 (Animation Types) を参照してください。
startAlpha(number) アニメーション開始時のアルファ値。
endAlpha(number) アニメーション終了時のアルファ値。
duration(number) 最小アルファ値から最大アルファ値へとフェードしていく時間(秒)。
setStartBeforeDelay(boolean) ディレイよりも先にウィンドウにスタートアニメーション値を設定するかどうか?
delay(number) この関数呼び出すのと、アニメーションを開始する間のディレイ。
numLoop(number) アニメーションをループさせる回数。0の時はループしません。

戻り値

nil戻り値無し。

メモ

  • アニメーションの終わりには <StopAlphaAnimation()> を呼び出す必要があります。これは現在、シングルパスのアニメーションでも必要です。
  • ウィンドウの実際のアルファ値はアルファフェード中に増加します。もしアニメーション中にウィンドウアルファを設定した場合、設定した値はアニメーションが停止するまでスクリーン上に反映されないでしょう。

WindowStopAlphaAnimation()

現在のアルファアニメーションを停止し、本来のアルファ値にウィンドウをリセットします。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

nil戻り値無し。

WindowStartPositionAnimation()

関数パラメータから得られたウィンドウで、自動化された位置アニメーションを開始します。

パラメータ

windowName(string) ウィンドウの名前。
animType(number) アニメーションタイプ。有効な値は 定数 (Animation Types) を参照してください。
startX(number) アニメーション開始地点の親からのX方向の距離 (POPタイプアニメの始まりと終わり)。
startY(number) アニメーション開始地点の親からのY方向の距離 (POPタイプアニメの始まりと終わり)。
endX(number) アニメーション終了地点の親からのX方向の距離 (POPタイプアニメの中間点)。
endY(number) アニメーション終了地点の親からのY方向の距離 (POPタイプアニメの中間点)。
duration(number) ミッドアルファとマックスアルファ間のフェード時間(秒)。
setStartBeforeDelay(boolean) ディレイよりも先にウィンドウにスタートアニメーション値を設定するかどうか?
delay(number) この関数呼び出すのと、アニメーションを開始する間のディレイ。
numLoop(number) アニメーションをループさせる回数。0の時はループしません。

戻り値

nil戻り値無し。

メモ

  • アニメーションの終わりには <StopPositionaAnimation()> を呼び出す必要があります。これは現在、シングルパスのアニメーションでも必要です。
  • アニメーションはアニメーションが続いている間はウィンドウアンカーよりも優先されます。

WindowStopPositionAnimation()

現在の位置でアニメーションを停止し、アンカーが設定された位置にウィンドウを戻します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

nil戻り値無し。

WindowStartScaleAnimation()

関数パラメータから得られたウィンドウで、自動化されたスケールアニメーションを開始します。

パラメータ

windowName(string) ウィンドウの名前。
animType(number) アニメーションタイプ。有効な値は 定数 (Animation Types) を参照してください。
startAlpha(number) アニメーション開始時のアルファ値。
endAlpha(number) アニメーション終了時のアルファ値。
duration(number) 最小アルファ値から最大アルファ値へとフェードしていく時間(秒)。
setStartBeforeDelay(boolean) ディレイよりも先にウィンドウにスタートアニメーション値を設定するかどうか?
delay(number) この関数呼び出すのと、アニメーションを開始する間のディレイ。
numLoop(number) アニメーションをループさせる回数。0の時はループしません。

戻り値

nil戻り値無し。

メモ

  • アニメーションの終わりには <StopPositionaAnimation()> を呼び出す必要があります。これは現在、シングルパスのアニメーションでも必要です。
  • アニメーションはアニメーションが続いている間はウィンドウアンカーよりも優先されます。

WindowStopScaleAnimation()

現在のスケールアニメーションを停止し、ウィンドウを元の縮尺に戻します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

nil戻り値無し。

WindowSetParent()

指定したウィンドウの親ウィンドウを変更します。

パラメータ

windowName(string) ウィンドウの名前。
parentWindowName(string) 新しい親ウィンドウの名前。

戻り値

nil戻り値無し。

WindowGetParent()

指定したウィンドウの親ウィンドウの名前を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

parentWindowName(string) 親ウィンドウの名前。

メモ

  • この関数は、親ウィンドウのID番号を使いつつ、子ウィンドウに入力とクリックイベントの処理をさせたい時の入れ子構造のウィンドウ要素として役立ちます。

local quest = WindowGetId( WindowGetParent( SystemData.ActiveWindow.name ) )

WindowSetScale()

ウィンドウの現在の縮尺を設定します。

パラメータ

windowName(string) ウィンドウの名前。
scale(float_t) 0.0 から 1.0 の間の値。

戻り値

nil戻り値無し。

メモ

  • スクリーン上のウィンドウのビジュアルサイズは、縮尺とサイズを乗算することで決定されます。

WindowGetScale()

ウィンドウの現在の縮尺を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

scale(float_t) 0.0 から 1.0 の間の値。

メモ

  • スクリーン上のウィンドウのビジュアルサイズは、縮尺とサイズを乗算することで決定されます。

WindowSetRelativeScale()

現在の縮尺を基準として、ウィンドウを相対的にスケーリングします。

例えば相対スケールが0.5なら、ウィンドウの大きさは現在の半分になります。

パラメータ

windowName(string) ウィンドウの名前。
scale(float_t) 0.0 から 1.0 の間の値。

戻り値

nil戻り値無し。

メモ

  • スクリーン上のウィンドウのビジュアルサイズは、縮尺とサイズを乗算することで決定されます。

WindowSetRelativeScale( "SomeWindow", 0.5 )

DoesWindowExist()

指定した名前のウィンドウが存在しているかどうかを調べます。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

exists(boolean) true = 存在している, false = 存在しない

if (DoesWindowExist ("MySpecialWindow") == true) then

    DEBUG (L"Thanks for avoiding error spew!");

end

WindowResizeOnChildren()

子ウィンドウの最大サイズを基準に親ウィンドウのサイズを変更します。

パラメータ

windowName(string) サイズを変える親ウィンドウの名前。
recursive(boolean) 子ウィンドウの子を通じて再帰処理をするかどうか。
borderSpacing(integer) 下と右に追加するパディングの量。

戻り値

nil戻り値無し。

WindowResizeOnChildren( "BadlySizedParentWindow", true, 2 )

WindowSetGameActionTrigger()

このウィンドウをクリックした時にキーバインド可能なアクションを設定します。

パラメータ

windowName(string) ウィンドウの名前。
gameActionId(integer) ウィンドウがクリックされた時に発動するキーバインディングアクションID。

戻り値

nil戻り値無し。

WindowSetGameActionTrigger( "SomeWindow", 2 )

WindowSetGameActionData()

このウィンドウをクリックした時に発動するゲームアクション(キーバインドできるアクション)を設定します。

パラメータ

windowName(string) ウィンドウの名前。
gameActionType(integer) アクションのタイプ。
gameActionId(integer) アクションのID番号。
gameActionText(integer) アクションと関連したテキスト。

戻り値

nil戻り値無し。

WindowSetGameActionData( "SomeWindow", true, 2 )

WindowSetGameActionButton()

ウィンドウと結びつけられたゲームアクションを発動するのに使うゲームアクションボタンを設定します。

パラメータ

windowName(string) ウィンドウの名前。
gameActionButton(integer) このウィンドウに使用するゲームアクションボタン。

戻り値

nil戻り値無し。

関連

WindowGetGameActionButton()

指定したウィンドウでのゲームアクションの発動に設定されているボタンの値を返します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

GameActionButton(integer) 設定されているゲームアクションボタン 。

local button = WindowGetGameActionButton( "WindowName" )

関連

WindowIsGameActionLocked()

指定したウィンドウが現在ゲームアクションの編集をロックされているかどうかを調べます。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

locked(boolean) true = ロックされている, false = ロックされていない

local locked = WindowIsGameActionLocked( "WindowName" )

WindowSetDrawWhenInterfaceHidden()

メインUIが隠れている時に、ウィンドウを描写すべきかどうかを設定します。

パラメータ

windowName(string) ウィンドウの名前。
showWhenUiHidden(boolean) true = 描写する, false = 描写しない

戻り値

nil戻り値無し。

WindowSetDrawWhenInterfaceHidden( "SiegeWeaponCannonAimWindow", true )

WindowRestoreDefaultSettings()

ウィンドウを初期化して、デフォルトのアンカー、サイズ、スケール、アルファ値に戻します。

パラメータ

windowName(string) ウィンドウの名前。

戻り値

nil戻り値無し。

WindowRestoreDefaultSettings( "OverheadMapWindow" )
ウィンドウに新しく子ウィンドウを追加することができます。
ウィンドウをドラッグしてスクリーンの外に出すことができるかどうかを指定します。
ウィンドウをクリックした時に、レイヤーの最前面に表示させます。
マウスの左ボタンが押された時に呼び出されます。
マウスの左ボタンが離された時に呼び出されます。
ウィンドウが移動できるようにするかどうかを設定します。
ウィンドウの現在の移動可能設定(可能か不可能か)を返します。
ウィンドウにID番号を設定します。
指定したウィンドウのID番号を返します。
ウィンドウの sticky 属性を調べて値を返します。
ウィンドウから全てのアンカーを取り除きます。
ウィンドウに新しいアンカーを追加します。
アンカー情報を返します。
ウィンドウにアンカーを強制的に処理させます。
イベントハンドラ (EventHandlers) 要素を使用することで、トリガーとなるコールバックと、コールバック発生時に呼び出すLua関数を指定することができます。
トリガーとなるコールバックと、そのコールバックと同時に呼び出す関数を指定します。
ウィンドウのコアイベントに登録されているコールバックを解除します。
ウィンドウのイベントに登録されているコールバックを解除します。
数字上のID番号。固有の値である必要はありません。
タブがフォーカスを循環する順番です。
関数パラメータから得られたウィンドウで、自動化されたアルファアニメーションを開始します。
現在のアルファアニメーションを停止し、本来のアルファ値にウィンドウをリセットします。
ウィンドウのテクスチャ要素の色の濃淡値を指定します。
ウィンドウの現在位置を返します。
ウィンドウのUIを定義します。
ウィンドウ要素がマウスイベントを処理するかどうかを判断します。
ウィンドウをドラッグアンドドロップで移動可能にします。
他のウィンドウとの相対的なウィンドウ位置を定義します。
このウィンドウが持つアンカーの数を返します。
エディットボックス (EditBox) は、一般的なテキスト入力ウィンドウ要素です。
Close