キーボードを表すグローバル シングルトンです。
次のボタン名のセットをすべてのキーボードで使用できます。
escape、enter、space、backspace、tab、0、1、2、3、4、5、6、7、8、9、a、b、c、d、e、f、g、h、i、j、k、l、m、n、o、p、q、r、s、t、u、v、w、x、y、z、minus、equal、comma、period、open bracket、close bracket、semicolon、quote、slash、backslash、backtick、left shift、left ctrl、left alt、left system、right shift、right ctrl、right alt、right system、f1、f2、f3、f4、f5、f6、f7、f8、f9、f10、f11、f12、f13、f14、f15、f16、f17、f18、f19、f20、f21、f22、f23、f24、insert、delete、home、end、page up、page down、up、down、left、right、numpad 0、numpad 1、numpad 2、numpad 3、numpad 4、numpad 5、numpad 6、numpad 7、numpad 8、numpad 9、numpad +、numpad -、numpad *、numpad /、numpad .、numpad enter、num lock、caps lock、scroll lock、print screen、break
下位互換性のために、次の代替ボタン名のセットもすべてのキーボードで使用できます。
esc、num -、scrol lock、left win、right win、arrow up、arrow down、arrow left、arrow right、oem_minus (_ -)、oem_plus (+ =)、oem_comma (< ,)、oem_period (> .), oem_1 (: ;), oem_2 (? /), oem_3 (~ `), oem_4 ({ [), oem_5 (| ), oem_6 (} ]), oem_7 (\" ')
次のボタン名のセットは、Windows キーボードでのみ使用できます。
attn、clear、cr sel、er eof、execute、ex sel、icoclr、icohlp、noname、oem_102 (> <)、oem_8 (?!)、oem attn、auto、ax、back tab、oemclr、copy、cu sel、enlw、finish、loya、mashu、roya、touroku、jump、oempa1、oempa2、oempa3、reset、wsctrl、pa1、packet、play、process、select、separator、zoom、accept、context menu、convert、final、help、ico00 *、junja、kana、kanji、app1、app2、mail、media、left button **、middle button **、next track、play / pause、previous track、stop、mode change、non convert、jisho、pause、print、right button **、shift、sleep、volume down、volume mute、volume up、x button 1 **、x button 2 **
なし。
すべての Stingray 入力コントローラで提供される共通の関数セットに加えて、キーボードには、keystrokes()関数で提供される、テキストの入力に使用されるキーストロークを読みとるための別の方法があります。このインタフェースを使用する場合、[Shift]などの拡張キーは読み取らず、代わりに入力された実際の文字を取得します。キーストロークは、印字可能文字の文字列、および単純なキーボード入力アプリケーションで検出する特殊キーの数値で表されます。
すべてのタイプの入力コントローラには名前付きボタンおよび「軸」の組み込みセットがあり、これらによりユーザがコントローラに入力を提供するさまざまな方法を表します。
- 各ボタンは、任意のフレームで押す、または放すことができます。これらのイベントは、pressed()および released()を呼び出すことで検出できます。また、コントローラは、そのボタンについて 0 と 1 の間の値を生成します。これは、button()を呼び出すことで取得できます。
- 各軸について Vector3 を生成できます。場合により、この値は正規化されます。通常は、軸が何らかの種類のスケールに沿った変数値を示している場合です(プレイヤーがサムスティックを押している方向など)。たとえば、ゲーム パッドのサムスティックの押し方は、左いっぱい(1,0,0)、上いっぱい(0,1,0)、左上に直角(0.707107, 0.707107, 0)などです。または、場合により、軸は 3D 空間または 2D スクリーン空間の座標値を生成します。
キーボードのボタン[k]が押されたかどうかを確認するには、次のようにします。
同様に、2D スクリーン空間における Windows マウス カーソルの現在位置を取得するには、次のようにします。
または、プレイヤーがゲーム パッドで右のサムスティックを押している方向を取得するには、次のようにします。
クエリーできるボタンおよび軸の名前は各種コントローラで異なり、さまざまなプラットフォームで異なる可能性もあります。デバイスで使用可能なボタンを確認する必要がある場合は、エディタのステータス バーまたはゲーム プロジェクトで次のコード スニペットを実行することで、現在のリストを取得できます。Mouse を、値を確認する対象のコントローラの名前で置き換えてください。
|
コントローラがアクティブであるかどうか、つまり接続されていて予期したとおりに動作しているかどうかを示します。
|
パラメータ 戻り値 boolean |
コントローラがアクティブである場合は true、それ以外の場合は false を返します。
|
|
このコントローラが該当する入力デバイスのカテゴリを説明する文字列を返します。
|
パラメータ 戻り値 string |
gamepad、touch_panel、mouse、または keyboard のいずれかの値です。
|
|
コントローラがこのフレームにアタッチされているかどうかを示します。
|
パラメータ 戻り値 boolean |
コントローラがこのフレームにアタッチされている場合は true、それ以外の場合は false を返します。
|
|
コントローラがこのフレームから接続解除されているかどうかを示します。
|
パラメータ 戻り値 boolean |
コントローラがこのフレームから接続解除されている場合は true、それ以外の場合は false を返します。
|
|
前のフレームでユーザが押した各キーのエントリが含まれているテーブルを返します。
|
パラメータ 戻り値 any(string, integer)[] |
返されたテーブル内の各エントリは、文字列または整数のいずれかです。文字列値は、プレイヤーが対応するキーを押したことを示しています。整数値はキーストローク定数値を示します。
any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。 |
|
コントローラの一意の名前を返します(例: 「Xbox Controller 1」)。
|
パラメータ 戻り値 string |
コントローラの一意の名前が含まれている文字列です。
|
ほとんどの場合、この名前は type()で返される文字列の変形にカウンタを追加したものです。
|
このコントローラで使用されるハードウェア デバイスの説明を返します。
|
パラメータ 戻り値 string |
コントローラ デバイスの種類を説明する文字列です。
|
この識別子は、同じモデルのすべてのコントローラで同じになります(いくつかの例外はあります)。たとえば、xbox_controller、logitech_mx518_mouse、 generic_105_key_keyboard などです。この値は、いくつかのプラットフォームでは入力デバイス モデルには関係なく同じになる場合があることに注意してください。
|
パッドを使用しているユーザのユーザ ID を返します。
|
パラメータ 戻り値 integer? |
パッドを使用しているユーザの Xbox Live または PSN ID、またはパッドに接続しているユーザがいない場合は nil です。
? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
PlayStation 4 および Xbox One で実行されているゲームでのみ使用でき、Windows では使用できません。
このグループ内の関数は、このコントローラによって追跡されるボタンと軸からの値の取得に関連しています。
|
現在のフレームでプレイヤーがいずれかのボタンを押したかどうかを示します。
|
パラメータ 戻り値 integer? |
プレイヤーがこのフレームで押した最初のボタンの ID、またはプレイヤーがいずれのボタンも押さなかった場合は nil です。
? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
その場合、プレイヤーが押した最初のボタンの ID を返します。
|
プレイヤーが現在のフレームでいずれかのボタンを放したかどうかを示します。
|
パラメータ 戻り値 integer? |
プレイヤーがこのフレームで放した最初のボタンの ID、またはプレイヤーがいずれのボタンも放さなかった場合は nil です。
? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
その場合、プレイヤーが放した最初のボタンの ID を返します。
|
axis ( id, dead_zone_mode, dead_zone_size ) : stingray.Vector3
コントローラの 1 つの軸の入力値を返します。
|
パラメータ id : | integer | 値が取得される軸の ID です。 |
dead_zone_mode : | integer? | コントローラから読み込まれた値を返す前に適用するデッド ゾーンの種類を指定します。この値は、デッド ゾーン モード定数のいずれかです。このパラメータを指定する場合は、dead_zone_size も指定する必要があります。省略した場合は、[InputController.set_dead_zone()] を使用して設定した既定のデッド ゾーン値が使用されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
dead_zone_size : | number? | コントローラから読み込まれた値に適用するデッド ゾーンのサイズです。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
戻り値
デッド ゾーンの環境設定コントロールは、非接触型インタフェースの場合にのみ使用できることに注意してください。
|
コントローラ内の指定された名前を持つ軸の ID を取得します(ある場合)。
|
パラメータ name : | string | ID を取得する対象の軸の名前。 |
戻り値 integer |
軸の ID、または一致する名前を持つ軸が見つからない場合は nil です。
|
|
コントローラ内の指定された ID を持つ軸の名前を取得します。
|
パラメータ id : | integer | 名前を取得する対象の軸の ID です。 |
戻り値
パラメータ id : | integer | 値を取得する対象のボタンの ID です。 |
戻り値 number |
0 と 1 の間の値として表される、ボタンの現在の値です。
|
パラメータ name : | string | ID を取得する対象のボタンの名前です。 |
戻り値 integer |
ボタンの ID、または一致する名前を持つボタンが見つからない場合は nil です。
|
パラメータ id : | integer | 名前を取得する対象のボタンの ID です。 |
戻り値 string |
コントローラに対して設定されているロケールでのボタンの名前です。
|
これは、通常はキーボード コントローラの場合にのみ役立ちます。
パラメータ id : | integer | 名前を取得する対象のボタンの ID です。 |
戻り値 string |
ボタンの名前です。または、一致する ID を持つボタンが見つからない場合は空の文字列です。
|
|
コントローラの軸の数を返します。
|
|
プレイヤーがこのフレームの間に指定された ID を持つボタンを押したかどうかを示します。
|
パラメータ id : | integer | テストするボタンの ID です。 |
戻り値 boolean |
プレイヤーがこのフレームの間にそのボタンを押した場合は true、それ以外の場合は false を返します。
|
|
プレイヤーがこのフレームの間に指定された ID を持つボタンを放したかどうかを示します。
|
パラメータ id : | integer | テストするボタンの ID です。 |
戻り値 boolean |
プレイヤーがこのフレームの間にそのボタンを放した場合は true、それ以外の場合は false を返します。
|
「デッド ゾーン」は、コントローラによって読み取られた入力値がゼロに固定される領域です。
サムスティックなどのコントローラが古くなったり緩んでくると、「停止」位置でプレイヤーがアクティブにコントローラを押していなくても、小さい入力値がゲーム エンジンに送信される可能性があります。これにより、継続的に回転またはスライドするキャラクタやカメラなどの視覚的なアーティファクトが生じる可能性があります。
デッド ゾーンは、入力値に最小しきい値を適用することでこの問題を緩和します。そのしきい値より小さい値は、プレイヤーからの意図的な入力ではなくノイズとみなされます。
|
サイズ値が円の半径と解釈されるデッド ゾーンを指定します。
|
|
サイズ値が各座標軸に沿って独立して適用されるデッド ゾーンを指定し、デッド ゾーンを四角形にします。
|
|
デッド ゾーンを指定しません。
|
エンジンは、コントローラから読み取られた生の入力値を提供します。
|
このコントローラの指定された軸の現在のデッド ゾーン設定を返します。
|
パラメータ id : | integer | デッド ゾーン値を取得する対象の軸の ID です。 |
戻り値 integer |
指定された軸についてコントローラから読み取られた値にアクセスするときに適用されるデッド ゾーンの種類を指定します。この値は、デッド ゾーン モード定数のいずれかです。
|
number |
コントローラから読み込まれた値に適用するデッド ゾーンのサイズです。
|
|
コントローラの単一軸に対する既定のデッド ゾーン値を設定します。
|
パラメータ id : | integer | 既定のデッド ゾーンが設定される軸の ID です。 |
dead_zone_mode : | integer | コントローラから読み取られた値を返す前に適用されるデッド ゾーンの種類を指定します。この値は、デッド ゾーン モード定数のいずれかです。 |
dead_zone_size : | number | コントローラから読み取られた値に適用するデッド ゾーンのサイズです。 |
戻り値
関数呼び出しでデッド ゾーン設定を指定せずに axis() を呼び出してコントローラの軸の入力値を取得すると、これらの既定のデッド ゾーンの値が呼び出されます。
このグループ内の定数は、keystrokes() 関数によって返されるテーブル内の文字以外のキーを表しています。
|
[Backspace]キーを表します。
|
|
[Delete]キーを表します。
|
|
下矢印キーを表します。
|
|
[End]キーを表します。
|
|
[Enter]キーを表します。
|
|
[Esc]キーを表します。
|
|
F1 : integer
[F1]キーを表します。
|
|
[F10]キーを表します。
|
|
[F11]キーを表します。
|
|
[F12]キーを表します。
|
|
F2 : integer
[F2]キーを表します。
|
|
F3 : integer
[F3]キーを表します。
|
|
F4 : integer
[F4]キーを表します。
|
|
F5 : integer
[F5]キーを表します。
|
|
F6 : integer
[F6]キーを表します。
|
|
F7 : integer
[F7]キーを表します。
|
|
F8 : integer
[F8]キーを表します。
|
|
F9 : integer
[F9]キーを表します。
|
|
[Home]キーを表します。
|
|
[Insert]キーを表します。
|
|
左矢印キーを表します。
|
|
[Page Down]キーを表します。
|
|
[Page Up]キーを表します。
|
|
右矢印キーを表します。
|
|
[Tab]キーを表します。
|
|
UP : integer
上矢印キーを表します。
|
エンジンには、サポートするデバイス上で特定の強さと時間のランブル パルスを再生できるようにする、ランブル エフェクト システムが組み込まれています。
ランブル エフェクト システムを使用する際に必要なことは、ランブル エフェクトを開始するために rumble_effect()を 1 回呼び出すだけです。エンジンはランブルの調節を行い、その時間の終了時にランブルをフェード アウトします。複数のランブル エフェクトが再生されている場合は、それらのエフェクトが追加されます。
ランブル エフェクトはシンセサイザの音に類似しています。これは、ADSR エンベロープ(http://en.wikipedia.org/wiki/Synthesizer#ADSR_envelope を参照)内で再生される正弦波です。
ランブルをさらに詳細にコントロールする必要がある場合は、代わりに set_rumble()メソッドを使用できます。そのメソッドを使用すると、各モーターのランブル強度を直接設定できます。このメソッドを使用する場合、ランブルのフェード アウト、および必要な変更の適用は、ユーザが行うことに注意してください。
rumble_effect()と set_rumble()の両方を使用すると、値は加算されます。
このカテゴリ内の関数は、ランブル モーターが含まれている入力コントローラ(コンソール ゲームパッドなど)の場合にのみ役立ちます。
ランブル モーターの名前は、次のとおりです。
- left
- right
- left_trigger (Xbox One で実行されている場合にのみ使用可能。Windows では使用不可)
- right_trigger (Xbox One で実行されている場合にのみ使用可能。Windows では使用不可)
ランブル設定は、PlayStation 4 の場合、つまり、Windows で PlayStation 4 コントローラを使用しているのではなく PlayStation 4 で実行されている場合にのみ使用できます。
|
指定されたランブル イベントが指定されたモーターで再生されているかどうかを示します。
|
パラメータ motor_id : | integer | テストするランブル モーターの ID です。 |
ID : | integer | ランブル エフェクトの ID です。 |
戻り値 boolean |
指定された ID を持つランブル イベントが rumble_effect()を呼び出すことにより作成され、そのエフェクトが再生されている場合は true、それ以外の場合は false を返します。
|
|
この種類のコントローラでサポートされるランブル コントローラの数を取得します。
|
パラメータ 戻り値 integer |
コントローラ内のランブル モーターの数です。
|
|
指定されたモーターで新しいランブル エフェクトを開始します。
|
パラメータ motor_id : | integer | アクティブにするランブル モーターの ID です。 |
params : | input_rumble_params | 新しいランブル エフェクトの詳細設定を提供するテーブルです。 |
戻り値 integer |
新しく作成されたランブル エフェクトの ID です。
|
|
指定された名前を持つランブル モーターの ID を取得します。
|
パラメータ motor_name : | string | ID を取得するランブル モーターの名前です。 |
戻り値 integer? |
ランブル モーターの ID、または該当するモーターが存在しない場合は nil です。
? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
|
指定された ID を持つランブル モーターの名前を取得します。
|
パラメータ motor_id : | integer | 名前を取得するランブル モーターの ID です。 |
戻り値
|
指定されたモーターで新しいランブル エフェクトを開始します。
|
パラメータ motor_id : | integer | アクティブにするランブル モーターの ID です。 |
value : | number | 0 (ランブルなし)と 1 (最強)の間の値として表される、設定するランブルの強さです。 |
戻り値
ランブルは、再度 set_rumble()を呼び出すかまたは rumble_effect()を呼び出すことにより変更されるまでは、同じ強さで継続します。
|
このコントローラでランブル エンジンを有効にするかどうかを決定します。
|
パラメータ do_rumble : | boolean | このコントローラでランブル エンジンを有効にする場合は true、ランブルを無効にする場合は false を使用します。 |
戻り値
パラメータ motor_id : | integer | 非アクティブにするランブル モーターの ID です。 |
戻り値
パラメータ motor_id : | integer | 非アクティブにするランブル モーターの ID です。 |
ID : | integer | ランブル エフェクトの ID です。 |
戻り値
代わりにこれらの関数の _id バージョンを使用します。
|
廃止予定です。
|
パラメータ name : | string | ID を取得する対象の軸の名前。 |
戻り値 integer |
軸のインデックス、または一致する名前を持つ軸が見つからない場合は nil です。
|
軸は、インデックスではなく ID で参照する必要があります。代わりに axis_id()を使用してください。
パラメータ name : | string | ID を取得する対象のボタンの名前です。 |
戻り値 integer |
ボタンのインデックス、または一致する名前を持つボタンが見つからない場合は nil です。
|
ボタンは、インデックスではなく ID で参照する必要があります。代わりに button_id()を使用してください。
|
廃止予定です。
|
パラメータ motor_name : | string | ID を取得するランブル モーターの名前です。 |
戻り値 integer? |
ランブル モーターのインデックス、または該当するモーターが存在しない場合は nil です。
? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
ランブル モーターは、インデックスではなく ID で参照する必要があります。代わりに rumble_motor_id()を使用してください。
このカテゴリ内の関数は、PlayStation 4 のパッドに対してのみ使用できます。
PlayStation 4 のユーザはパッドにログインできることに注意してください。ゲームが単一プレイヤーのゲームとして指定されていない限り、ユーザはいつでもログインおよびログアウトできます。したがって、変動をポーリングするためにメイン ループ内で user_id()を呼び出す必要があります。
|
コントローラのライト バーを指定されたカラーに設定します。
|
パラメータ color : | color | ライト バーの新しいカラーです。 |
戻り値
PlayStation 4 で実行されているゲーム内で PlayStation 4 のパッドでのみ使用できます。