stingray.Window オブジェクト リファレンス

説明

Win32 と Mac OS X のアプリケーション ウィンドウを表します。

他のプラットフォーム上では、ウィンドウがない場合があります。

ウィンドウ関数は次の 2 つの方法で呼び出すことができます。

• 関数にウィンドウ オブジェクトを渡さずに呼び出します。この例では、関数はメイン アプリケーション ウィンドウに影響を与えます。たとえば、次のようになります。

  -- Sets the title of the main window
  Window.set_title("main window")
  

• 別の方法として、関数にウィンドウ オブジェクトを渡して呼び出します。この例では、関数は渡されるウィンドウに影響を与えます。たとえば、次のようになります。

  -- Creates a new window and sets its title
  win = Window.open()
  Window.set_title(win, "new window")
  

関連サンプル コード

Appkit: /app.lua Appkit: /simple_project.lua 基本テンプレート: /main_menu.lua キャラクタ テンプレート: /main_menu.lua 車両テンプレート: /main_menu.lua Oculus VR テンプレート: /main_menu.lua 最小テンプレート: /boot.lua マウスを使ってユニットを選択する

その他の関連リファレンス項目

	stingray.Application.back_buffer_size() stingray.Application.render_world() stingray.Camera.screen_to_world() stingray.Camera.world_to_screen() stingray.Gui.resolution() stingray.Profiler.render_stats()
	Core

この参照ページは、次の概要トピックと関連付けられています

「ゲームプレイを作成する > Lua でスクリプトを作成する > テンプレートから Lua を開始する: Appkit を使用する > Appkit を使用してワールド、レベル、カメラを管理する」

関数

clip_cursor ( window ) : booleanclip_cursor ( ) : boolean ウィンドウの境界の外側にマウス ポインタが移動できるかどうかを示します。

パラメータ

window :

stingray.Window

テストするウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。

戻り値

boolean

マウス ポインタがウィンドウの境界内の移動に制限される場合は true を、そうでない場合は false を返します。

close ( window ) close ( ) 指定したウィンドウを閉じます。

パラメータ

window :

stingray.Window

閉じるウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。

戻り値

この関数は値を返しません。

Windows プラットフォームに対してのみ使用できます。

get_dpi_scale ( ) : number DPI スケールを取得します。

パラメータ

この関数はパラメータを受け入れません。

戻り値

number

Windows の DPI スケールです。Windows 以外のプラットフォームでは 1.0 です。

Windows プラットフォームに対してのみ使用できます。

has_focus ( window ) : booleanhas_focus ( ) : boolean ウィンドウにキーボード フォーカスがあるかどうかを示します。

パラメータ

window :

stingray.Window

テストするウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。

戻り値

boolean

ウィンドウにキーボード フォーカスがある場合は true を、そうでない場合は false を返します。

is_closing ( window ) : booleanis_closing ( ) : boolean 指定されたウィンドウを閉じることをユーザが要求したかどうかを示します。

パラメータ

window :

stingray.Window

テストするウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。

戻り値

boolean

指定されたウィンドウの[閉じる]アイコンをユーザが押した場合は true を返します。

Windows プラットフォームに対してのみ使用できます。

is_resizable ( window ) : booleanis_resizable ( ) : boolean ウィンドウのサイズを変更できるかどうかを示します。

パラメータ

window :

stingray.Window

テストするウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。

戻り値

boolean

ウィンドウの境界がサイズ変更に対応している場合は true を、そうでない場合は false を返します。

maximize ( window ) maximize ( ) ウィンドウを最大化します。

パラメータ

window :

stingray.Window

最大化するウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。

戻り値

この関数は値を返しません。

Windows プラットフォームに対してのみ使用できます。

minimize ( window ) minimize ( ) ウィンドウをタスク バーに最小化します。

パラメータ

window :

stingray.Window

最小化するウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。

戻り値

この関数は値を返しません。

Windows プラットフォームに対してのみ使用できます。

mouse_focus ( window ) : booleanmouse_focus ( ) : boolean ウィンドウにマウス フォーカスがあるかどうかを示します。

パラメータ

window :

stingray.Window

テストするウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。

戻り値

boolean

ウィンドウにマウス フォーカスがある場合は true を、そうでない場合は false を返します。

ウィンドウにマウス フォーカスがある場合、マウス ポインタを非表示にして、ポインタがウィンドウ外に出ないようにします。

open ( config ) 指定された設定で新しいウィンドウが開きます。

パラメータ

config :

window_config?

オプション。新しいウィンドウの設定を提供する window_config テーブルです。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

この関数は値を返しません。

Windows プラットフォームに対してのみ使用できます。

その他の関連リファレンス項目

window_config

rect ( window ) : number, number, number, number ウィンドウの矩形を返します。

戻り値

number	ウィンドウの x 座標です。
number	ウィンドウの y 座標です。
number	ウィンドウの幅です。
number	ウィンドウの高さです。

restore ( window ) restore ( ) 最大化または最小化ウィンドウから元のサイズに戻します。

パラメータ

window :

stingray.Window

元のサイズに戻される、最大化または最小化ウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。

戻り値

この関数は値を返しません。

Windows プラットフォームに対してのみ使用できます。

set_clip_cursor ( window, doClip ) set_clip_cursor ( doClip ) ウィンドウの境界の外側にマウス ポインタが移動できるかどうかを決定します。

パラメータ

window :	stingray.Window	カーソル設定が行われるウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。
doClip :	boolean	マウス ポインタをウィンドウの境界内の移動に制限する場合は true を、そうでない場合は false を渡します。

戻り値

この関数は値を返しません。

関連サンプル コード

Appkit: /simple_project.lua

set_cursor ( window, cursor ) set_cursor ( cursor ) どのタイプのマウス カーソル リソースをウィンドウに使用するかを決定します。

パラメータ

window :	stingray.Window	マウス カーソルが設定されるウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。
cursor :	string	このウィンドウに使用するマウス カーソル リソースの名前です。

戻り値

この関数は値を返しません。

このカーソルは、ウィンドウにフォーカスがあり、ウィンドウがカーソルを表示するように設定されている場合に使用されます (show_cursor() および set_show_cursor() も参照してください)。

cursor パラメータは、プロジェクトのデータ ディレクトリ内の、.mouse_cursor 拡張子を持つリソース ファイル名にする必要があります。このファイルには、カーソル イメージに使用する .texture リソースを指す、texture パラメータが 1 つ含まれている必要があります。

たとえば、次の行が含まれている content/camera.mouse_cursor という名前のリソースを作成します。

texture = "core/editor_slave/resources/gui/thumbnail_over"

次を呼び出すことで、ウィンドウに割り当てることができます。

stingray.Window.set_cursor("content/camera")

set_focus ( window ) set_focus ( ) ウィンドウがキーボード フォーカスを取得します。

パラメータ

window :

stingray.Window

フォーカスが設定されるウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。

戻り値

この関数は値を返しません。

set_ime_enabled ( window, isEnabled ) set_ime_enabled ( isEnabled ) 指定されたウィンドウに対して IME (Input Method Editor)を有効にするかどうかを決定します。

パラメータ

window :	stingray.Window	設定するウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。
isEnabled :	boolean	ウィンドウに対して IME を有効にする場合は true を、そうでない場合は false を返します。

戻り値

この関数は値を返しません。

IME は、既定ではオフになっています。

set_keystroke_enabled ( window, key, isEnabled ) set_keystroke_enabled ( key, isEnabled ) 指定されたウィンドウに対して特定のキーストロークまたはキーの組み合わせを有効にするかどうかを決定します。

パラメータ

window :	stingray.Window	廃止予定 - ウィンドウ パラメータは無視され、実装ではメイン アプリケーション ウィンドウを使用します。
key :	integer	有効または無効にするキーストロークまたはキーの組み合わせです。
isEnabled :	boolean	指定されたキーをこのウィンドウで有効にする必要がある場合は true を、そうでない場合は false を返します。

戻り値

この関数は値を返しません。

Window オブジェクトである KEYSTROKE_WINDOWS、KEYSTROKE_ALT_TAB、KEYSTROKE_ALT_ENTER、KEYSTROKE_ALT_F4 で定義されているキーストローク制約をすべて受け入れます。

Windows プラットフォームに対してのみ使用できます。

set_mouse_focus ( window, focus ) set_mouse_focus ( focus ) ウィンドウをマウス フォーカスするかどうかを決定します。

パラメータ

window :	stingray.Window	フォーカスが設定されるウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。
focus :	boolean	ウィンドウをマウス フォーカスする場合は true を、マウス フォーカスしない場合は false を渡します。

戻り値

この関数は値を返しません。

関連サンプル コード

Appkit: /simple_project.lua

set_rect ( window, x, y, width, height ) ウィンドウの矩形を設定します。

パラメータ

x :	number	ウィンドウの x 座標です。
y :	number	ウィンドウの y 座標です。
width :	number	ウィンドウの幅です。
height :	number	ウィンドウの高さです。

戻り値

この関数は値を返しません。

set_resizable ( window, resizeable ) set_resizable ( resizeable ) ウィンドウのサイズを変更できるかどうかを決定します。

パラメータ

window :	stingray.Window	境界が設定されるウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。
resizeable :	boolean	ウィンドウの境界をサイズ変更に対応させる場合は true を、そうでない場合は false を渡します。

戻り値

この関数は値を返しません。

set_resolution ( window, width, height ) : booleanset_resolution ( width, height ) : boolean 指定されたウィンドウの解像度を設定します。

パラメータ

window :	stingray.Window	解像度が設定されるウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。
width :	integer	ウィンドウの水平方向の幅です(ピクセル単位)。
height :	integer	ウィンドウの垂直方向の高さです(ピクセル単位)。

戻り値

boolean

解像度が正しく設定できなかった場合は true を、そうでない場合は false を返します。

set_show_cursor ( window, do_show, restore_cursor_pos ) set_show_cursor ( doShow ) ウィンドウにフォーカスがあるときにマウス ポインタを表示するかどうかを決定します。

パラメータ

window :	stingray.Window	カーソル設定が行われるウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。
do_show :	boolean	ウィンドウにフォーカスがあるときにマウス ポインタを表示する場合は false を、そうでない場合は true を渡します。
restore_cursor_pos :	boolean	非表示にした後にカーソルを表示するときは、このパラメータに true を渡して、最後に表示された位置にカーソルを表示します。オペレーティング システムによって追跡された位置にカーソルを表示するには、false を渡します。(オプション)指定しない場合の既定値は true です。

戻り値

この関数は値を返しません。

関連サンプル コード

基本テンプレート: /main_menu.lua キャラクタ テンプレート: /main_menu.lua 車両テンプレート: /main_menu.lua Oculus VR テンプレート: /main_menu.lua

その他の関連リファレンス項目

stingray.Window.set_cursor()

set_title ( window, title ) set_title ( title ) ウィンドウのタイトルを設定します。

パラメータ

window :	stingray.Window	タイトルが設定されるウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。
title :	string	ウィンドウの新しいタイトルです。

戻り値

この関数は値を返しません。

show_cursor ( window ) : booleanshow_cursor ( ) : boolean ウィンドウにフォーカスがあるときにマウス カーソルを表示するかどうかを示します。

パラメータ

window :

stingray.Window

テストするウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。

戻り値

boolean

ウィンドウでマウス カーソルを表示するように設定する場合は true を、そうでない場合は false を渡します。

関連サンプル コード

マウスを使ってユニットを選択する

その他の関連リファレンス項目

stingray.Window.set_cursor()

sync_layered_window ( window, x, y, width, height, visible, opacity ) レイヤ化されたウィンドウの長方形とアルファ状態を設定します。

パラメータ

x :	number	ウィンドウの x 座標です。
y :	number	ウィンドウの y 座標です。
width :	number	ウィンドウの幅です。
height :	number	ウィンドウの高さです。
visible :	boolean	ウィンドウの表示または非表示を示します。
opacity :	number	レイヤ化されたウィンドウの透明度を設定します。

戻り値

この関数は値を返しません。

trigger_resize ( window ) trigger_resize ( ) 指定されたウィンドウで、「on_resize」を手動でトリガします。

パラメータ

window :

stingray.Window

サイズ変更をトリガするウィンドウです。(オプション) 指定しない場合はメイン アプリケーション ウィンドウを使用します。

戻り値

この関数は値を返しません。

最後のトリガ以降にサイズが変更されていない場合には、効果はありません。Windows プラットフォームに対してのみ使用できます。

ウィンドウのキーの組み合わせ

ウィンドウとやり取りするキーストロークおよびキーの組み合わせを表す定数です。

KEYSTROKE_ALT_ENTER : integer [Alt]+[Enter]キーの組み合わせを表します。

その他の関連リファレンス項目

stingray.Window.set_keystroke_enabled()

KEYSTROKE_ALT_F4 : integer [Alt]+[F4]キーの組み合わせを表します。

その他の関連リファレンス項目

stingray.Window.set_keystroke_enabled()

KEYSTROKE_ALT_TAB : integer [Alt]+[Tab]キーの組み合わせを表します。

その他の関連リファレンス項目

stingray.Window.set_keystroke_enabled()

KEYSTROKE_WINDOWS : integer [Windows]キーを表します。

その他の関連リファレンス項目

stingray.Window.set_keystroke_enabled()