Window

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

パラメータ

戻り値

メモ

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

例

WindowRegisterCoreEventHandler(

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

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

パラメータ

戻り値

例

WindowUnregisterCoreEventHandler( "PlayerWindow", "OnMouseOver" )

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

パラメータ

戻り値

メモ

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

例

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

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

パラメータ

戻り値

例

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

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

パラメータ

戻り値

関連するXML

• id

メモ

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

例

WindowSetId( "GroupWindowMember3", 3 )

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

パラメータ

戻り値

関連するXML

• id

メモ

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

例

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

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

パラメータ

戻り値

関連するXML

• taborder

例

WindowSetTabOrder( "EditBox1", 1 )

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

パラメータ

戻り値

関連するXML

• taborder

例

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

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

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

パラメータ

戻り値

メモ

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

• WindowStartAlphaAnimation
• WindowStopAlphaAnimation

例

WindowSetAlpha( "ChatBubbleWindow"..index, 0.5 )

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

パラメータ

戻り値

メモ

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

例

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

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

パラメータ

戻り値

関連するXML

• TintColor

例

local row_mod = math.mod (rowIndex, 2)

local color = DataUtils.GetAlternatingRowColor( row_mod )

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

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

パラメータ

戻り値

関連するXML

• TintColor

メモ

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

例

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

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

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

パラメータ

戻り値

例

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

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

パラメータ

戻り値

例

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

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

パラメータ

戻り値

メモ

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

例

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

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

パラメータ

戻り値

メモ

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

例

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

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

パラメータ

戻り値

例

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

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

パラメータ

戻り値

メモ

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

例

WindowSetDimensions( "QuestTrackerWindow", totalWidth, height)

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

パラメータ

戻り値

例

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

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

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

パラメータ

戻り値

メモ

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

例

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

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

パラメータ

戻り値

例

local showing = WindowGetShowing( "QuestTrackerWindow" )

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

パラメータ

戻り値

関連するXML

• layer

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

パラメータ

戻り値

例

local layer = WindowGetLayer( "" )

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

パラメータ

戻り値

関連するXML

• handleinput

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

パラメータ

戻り値

例

local isHandlingInput = WindowGetHandleInput( "SomeWindow" )

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

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

パラメータ

戻り値

関連するXML

• popable

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

パラメータ

戻り値

例

local isPopable = WindowGetPopable( "SomeWindowName" )

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

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

パラメータ

戻り値

関連するXML

• movable

メモ

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

例

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

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

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

パラメータ

戻り値

例

local movable = WindowGetShowing( "ScenarioMapWindowMapImage" )

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

パラメータ

戻り値

メモ

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

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

パラメータ

戻り値

メモ

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

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

パラメータ

戻り値

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

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

パラメータ

戻り値

関連するXML

• Anchors

メモ

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

例

WindowClearAnchors( windowName )

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

パラメータ

戻り値

関連するXML

• Anchors

メモ

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

例

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

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

パラメータ

戻り値

関連するXML

• Anchors

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

パラメータ

戻り値

関連するXML

• Anchors

メモ

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

例

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

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

パラメータ

戻り値

関連するXML

• Anchors

メモ

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

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

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

パラメータ

戻り値

メモ

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

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

パラメータ

戻り値

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

パラメータ

戻り値

メモ

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

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

パラメータ

戻り値

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

パラメータ

戻り値

メモ

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

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

パラメータ

戻り値

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

パラメータ

戻り値

メモ

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

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

パラメータ

戻り値

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

パラメータ

戻り値

メモ

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

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

パラメータ

戻り値

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

パラメータ

戻り値

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

パラメータ

戻り値

メモ

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

例

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

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

パラメータ

戻り値

メモ

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

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

パラメータ

戻り値

メモ

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

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

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

パラメータ

戻り値

メモ

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

例

WindowSetRelativeScale( "SomeWindow", 0.5 )

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

パラメータ

戻り値

例

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

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

end

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

パラメータ

戻り値

例

WindowResizeOnChildren( "BadlySizedParentWindow", true, 2 )

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

パラメータ

戻り値

例

WindowSetGameActionTrigger( "SomeWindow", 2 )

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

パラメータ

戻り値

例

WindowSetGameActionData( "SomeWindow", true, 2 )

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

パラメータ

戻り値

関連

• 定数 (Game Action Buttons)

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

パラメータ

戻り値

例

local button = WindowGetGameActionButton( "WindowName" )

関連

• 定数 (Game Action Buttons)

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

パラメータ

戻り値

例

local locked = WindowIsGameActionLocked( "WindowName" )

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

パラメータ

戻り値

例

WindowSetDrawWhenInterfaceHidden( "SiegeWeaponCannonAimWindow", true )

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

パラメータ

戻り値

例

WindowRestoreDefaultSettings( "OverheadMapWindow" )