Pad2 - stingray.Pad2 ネームスペース リファレンス - Stingray Lua API リファレンス
説明
接続されている 2 番目のゲーム パッドを表すグローバル シングルトンです。
プラットフォームによってサポートされる各ゲーム パッド用に別々のパッド オブジェクト(Pad1、Pad2、... PadN)があります。
Xbox One および PlayStation 4 では、Pad インタフェースが、そのコンソール向けのネイティブ ゲームパッド コントローラを表します。
Windows では、Pad インタフェースが、接続された Xbox コントローラを表します。任意の PlayStation 4 コントローラは、代わりに PS4Pad1 から PS4Pad4 インタフェースとして表されます。
Xbox One
次のボタンおよび軸名は、Windows と Xbox One の両方の Xbox One コントローラに使用できます。
Xbox One ボタン名
- d_up、d_down、d_left、d_right: 方向パッドです。
- start、back
- left_thumb、right_thumb: 方向移動ではなく、サムスティックが押し込まれたときを示します。
- left_shoulder、right_shoulder
- left_trigger、right_trigger
- a、b、x、y
Xbox One 軸名
- left、right: サムスティックの左右の方向です。
- dpad: 軸として表される方向パッドです。
PlayStation 4
次のボタンおよび軸名は、Playstation 4 で動作しているゲーム内の PlayStation 4 コントローラでのみ利用可能です。
PlayStation 4 ボタン名
- triangle、circle、cross、square
- l1 と r1: 左右のトリガー ボタンです。
- l2 と r2: 左右のトリガー ボタン(アナログ)です。
- l3 と r3: 方向移動ではなく、左右のサムスティックが押し込まれたときを示します。
- up、right、down、left: 方向パッドの別々のボタンです。
- options
PlayStation 4 軸名
- dpad: 軸として表される方向パッドです。
- left と right: サムスティックの左右の方向です。
- orientation_forward、orientation_right、orientation_up: 回転センサーの前方、右、および上方向です。
- acceleration、angular_velocity: 加速度計によって測定される加速度と回転速度です。
- touch_1、touch_2: タッチ パッドの最初の 2 つの接触点です。Vector3(x, y, id) として返されます。ここで、id はこの接触イベントを識別する整数です。何の接触もない場合、Vector3(0,0,-1) を返します。
ボタンおよび軸からの値の取得
すべてのタイプの入力コントローラには名前付きボタンおよび「軸」の組み込みセットがあり、これらによりユーザがコントローラに入力を提供するさまざまな方法を表します。
- 各ボタンは、任意のフレームで押す、または放すことができます。これらのイベントは、pressed()および released()を呼び出すことで検出できます。また、コントローラは、そのボタンについて 0 と 1 の間の値を生成します。これは、button()を呼び出すことで取得できます。
- 各軸について Vector3 を生成できます。場合により、この値は正規化されます。通常は、軸が何らかの種類のスケールに沿った変数値を示している場合です(プレイヤーがサムスティックを押している方向など)。たとえば、ゲーム パッドのサムスティックの押し方は、左いっぱい(1,0,0)、上いっぱい(0,1,0)、左上に直角(0.707107, 0.707107, 0)などです。または、場合により、軸は 3D 空間または 2D スクリーン空間の座標値を生成します。
キーボードのボタン[k]が押されたかどうかを確認するには、次のようにします。
local k_key_id = stingray.Keyboard.button_id("k") -- retrieve the button ID local isPressed = stingray.Keyboard.button(k_key_id) -- use the ID to access the value
同様に、2D スクリーン空間における Windows マウス カーソルの現在位置を取得するには、次のようにします。
local cursor_axis_id = stingray.Mouse.axis_id("cursor") -- retrieve the axis ID local value = stingray.Mouse.axis(cursor_axis_id) -- use the ID to access to value
または、プレイヤーがゲーム パッドで右のサムスティックを押している方向を取得するには、次のようにします。
local right_axis_id = stingray.Pad1.axis_id("right") local value = stingray.Pad1.axis(right_axis_id)
すべてのボタン名と軸名の取得
クエリーできるボタンおよび軸の名前は各種コントローラで異なり、さまざまなプラットフォームで異なる可能性もあります。デバイスで使用可能なボタンを確認する必要がある場合は、エディタのステータス バーまたはゲーム プロジェクトで次のコード スニペットを実行することで、現在のリストを取得できます。Mouse を、値を確認する対象のコントローラの名前で置き換えてください。
-- get button names local button_id = 0 while button_id < stingray.Mouse.num_buttons() do print(stingray.Mouse.button_name(button_id)) button_id = button_id +1 end -- get axis names local axis_id = 0 while axis_id < stingray.Mouse.num_axes() do print(stingray.Mouse.axis_name(axis_id)) axis_id = axis_id +1 end
その他の関連リファレンス項目 
関数
 |
active ( ) : boolean コントローラがアクティブであるかどうか、つまり接続されていて予期したとおりに動作しているかどうかを示します。
|
| この関数はパラメータを受け入れません。 |
boolean |
コントローラがアクティブである場合は true、それ以外の場合は false を返します。 |
| |
category ( ) : stringこのコントローラが該当する入力デバイスのカテゴリを説明する文字列を返します。
|
| この関数はパラメータを受け入れません。 |
string |
gamepad、touch_panel、mouse、または keyboard のいずれかの値です。 |
| |
connected ( ) : booleanコントローラがこのフレームにアタッチされているかどうかを示します。
|
| この関数はパラメータを受け入れません。 |
boolean |
コントローラがこのフレームにアタッチされている場合は true、それ以外の場合は false を返します。 |
| |
disconnected ( ) : booleanコントローラがこのフレームから接続解除されているかどうかを示します。
|
| この関数はパラメータを受け入れません。 |
boolean |
コントローラがこのフレームから接続解除されている場合は true、それ以外の場合は false を返します。 |
| |
name ( ) : stringコントローラの一意の名前を返します(例: 「Xbox Controller 1」)。
|
| この関数はパラメータを受け入れません。 |
string |
コントローラの一意の名前が含まれている文字列です。 |
ほとんどの場合、この名前は type()で返される文字列の変形にカウンタを追加したものです。
| |
type ( ) : stringこのコントローラで使用されるハードウェア デバイスの説明を返します。
|
| この関数はパラメータを受け入れません。 |
string |
コントローラ デバイスの種類を説明する文字列です。 |
この識別子は、同じモデルのすべてのコントローラで同じになります(いくつかの例外はあります)。たとえば、xbox_controller、logitech_mx518_mouse、 generic_105_key_keyboard などです。この値は、いくつかのプラットフォームでは入力デバイス モデルには関係なく同じになる場合があることに注意してください。
その他の関連リファレンス項目
| |
user_id ( ) : integer?パッドを使用しているユーザのユーザ ID を返します。
|
| この関数はパラメータを受け入れません。 |
integer? |
パッドを使用しているユーザの Xbox Live または PSN ID、またはパッドに接続しているユーザがいない場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
PlayStation 4 および Xbox One で実行されているゲームでのみ使用でき、Windows では使用できません。
ボタンと軸
このグループ内の関数は、このコントローラによって追跡されるボタンと軸からの値の取得に関連しています。
| |
any_pressed ( ) : integer?現在のフレームでプレイヤーがいずれかのボタンを押したかどうかを示します。
|
| この関数はパラメータを受け入れません。 |
integer? |
プレイヤーがこのフレームで押した最初のボタンの ID、またはプレイヤーがいずれのボタンも押さなかった場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
その場合、プレイヤーが押した最初のボタンの ID を返します。
| |
any_released ( ) : integer?プレイヤーが現在のフレームでいずれかのボタンを放したかどうかを示します。
|
| この関数はパラメータを受け入れません。 |
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 を持つ軸に対するコントローラの入力値です。 |
デッド ゾーンの環境設定コントロールは、非接触型インタフェースの場合にのみ使用できることに注意してください。
| |
axis_id ( name ) : integerコントローラ内の指定された名前を持つ軸の ID を取得します(ある場合)。
|
name : | string | ID を取得する対象の軸の名前。 |
integer |
軸の ID、または一致する名前を持つ軸が見つからない場合は nil です。 |
その他の関連リファレンス項目
| |
axis_name ( id ) : stringコントローラ内の指定された ID を持つ軸の名前を取得します。
|
id : | integer | 名前を取得する対象の軸の ID です。 |
string |
軸の名前です。 |
| |
button ( id ) : number指定された ID を持つボタンの現在の入力値を返します。
|
| |
button_id ( name ) : integerコントローラ内の指定された名前を持つボタンの ID を取得します(ある場合)。
|
name : | string | ID を取得する対象のボタンの名前です。 |
integer |
ボタンの ID、または一致する名前を持つボタンが見つからない場合は nil です。 |
その他の関連リファレンス項目
| |
button_locale_name ( id ) : stringデバイスに対して設定されているロケールを考慮して、指定されたボタンの名前を取得します。
|
| |
button_name ( id ) : stringコントローラ内の指定された ID を持つボタンの名前を取得します。
|
| |
num_axes ( ) : integerコントローラの軸の数を返します。
|
| この関数はパラメータを受け入れません。 |
integer |
コントローラの軸の数です。 |
| |
num_buttons ( ) : integerコントローラのボタンの数を返します。
|
| |
pressed ( id ) : booleanプレイヤーがこのフレームの間に指定された ID を持つボタンを押したかどうかを示します。
|
id : | integer | テストするボタンの ID です。 |
boolean |
プレイヤーがこのフレームの間にそのボタンを押した場合は true、それ以外の場合は false を返します。 |
| |
released ( id ) : booleanプレイヤーがこのフレームの間に指定された ID を持つボタンを放したかどうかを示します。
|
id : | integer | テストするボタンの ID です。 |
boolean |
プレイヤーがこのフレームの間にそのボタンを放した場合は true、それ以外の場合は false を返します。 |
デッド ゾーン
「デッド ゾーン」は、コントローラによって読み取られた入力値がゼロに固定される領域です。
サムスティックなどのコントローラが古くなったり緩んでくると、「停止」位置でプレイヤーがアクティブにコントローラを押していなくても、小さい入力値がゲーム エンジンに送信される可能性があります。これにより、継続的に回転またはスライドするキャラクタやカメラなどの視覚的なアーティファクトが生じる可能性があります。
デッド ゾーンは、入力値に最小しきい値を適用することでこの問題を緩和します。そのしきい値より小さい値は、プレイヤーからの意図的な入力ではなくノイズとみなされます。
| |
CIRCULAR : integer サイズ値が円の半径と解釈されるデッド ゾーンを指定します。
|
この円の内側にある入力値は無視されます。
| |
INDEPENDENT : integerサイズ値が各座標軸に沿って独立して適用されるデッド ゾーンを指定し、デッド ゾーンを四角形にします。
|
この四角形の内側にある入力値は無視されます。
| |
RAW : integerデッド ゾーンを指定しません。
|
エンジンは、コントローラから読み取られた生の入力値を提供します。
| |
dead_zone ( id ) : integer, numberこのコントローラの指定された軸の現在のデッド ゾーン設定を返します。
|
id : | integer | デッド ゾーン値を取得する対象の軸の ID です。 |
integer |
指定された軸についてコントローラから読み取られた値にアクセスするときに適用されるデッド ゾーンの種類を指定します。この値は、デッド ゾーン モード定数のいずれかです。 |
number |
コントローラから読み込まれた値に適用するデッド ゾーンのサイズです。 |
| |
set_dead_zone ( id, dead_zone_mode, dead_zone_size )コントローラの単一軸に対する既定のデッド ゾーン値を設定します。
|
id : | integer | 既定のデッド ゾーンが設定される軸の ID です。 |
dead_zone_mode : | integer | コントローラから読み取られた値を返す前に適用されるデッド ゾーンの種類を指定します。この値は、デッド ゾーン モード定数のいずれかです。 |
dead_zone_size : | number | コントローラから読み取られた値に適用するデッド ゾーンのサイズです。 |
| この関数は値を返しません。 |
関数呼び出しでデッド ゾーン設定を指定せずに axis() を呼び出してコントローラの軸の入力値を取得すると、これらの既定のデッド ゾーンの値が呼び出されます。
ランブル
エンジンには、サポートするデバイス上で特定の強さと時間のランブル パルスを再生できるようにする、ランブル エフェクト システムが組み込まれています。
ランブル エフェクト システムを使用する際に必要なことは、ランブル エフェクトを開始するために rumble_effect()を 1 回呼び出すだけです。エンジンはランブルの調節を行い、その時間の終了時にランブルをフェード アウトします。複数のランブル エフェクトが再生されている場合は、それらのエフェクトが追加されます。
ランブル エフェクトはシンセサイザの音に類似しています。これは、ADSR エンベロープ(http://en.wikipedia.org/wiki/Synthesizer#ADSR_envelope を参照)内で再生される正弦波です。
ランブルをさらに詳細にコントロールする必要がある場合は、代わりに set_rumble()メソッドを使用できます。そのメソッドを使用すると、各モーターのランブル強度を直接設定できます。このメソッドを使用する場合、ランブルのフェード アウト、および必要な変更の適用は、ユーザが行うことに注意してください。
rumble_effect()と set_rumble()の両方を使用すると、値は加算されます。
このカテゴリ内の関数は、ランブル モーターが含まれている入力コントローラ(コンソール ゲームパッドなど)の場合にのみ役立ちます。
ランブル モーター名です。
ランブル モーターの名前は、次のとおりです。
Xbox One コントローラ:
- left
- right
- left_trigger (Xbox One で実行されている場合にのみ使用可能。Windows では使用不可)
- right_trigger (Xbox One で実行されている場合にのみ使用可能。Windows では使用不可)
PlayStation 4 コントローラ:
ランブル設定は、PlayStation 4 の場合、つまり、Windows で PlayStation 4 コントローラを使用しているのではなく PlayStation 4 で実行されている場合にのみ使用できます。
- small
- large
| |
is_rumble_effect_playing ( motor_id, ID ) : boolean指定されたランブル イベントが指定されたモーターで再生されているかどうかを示します。
|
motor_id : | integer | テストするランブル モーターの ID です。 |
ID : | integer | ランブル エフェクトの ID です。 |
boolean |
指定された ID を持つランブル イベントが rumble_effect()を呼び出すことにより作成され、そのエフェクトが再生されている場合は true、それ以外の場合は false を返します。 |
| |
num_rumble_motors ( ) : integerこの種類のコントローラでサポートされるランブル コントローラの数を取得します。
|
| この関数はパラメータを受け入れません。 |
integer |
コントローラ内のランブル モーターの数です。 |
| |
rumble_effect ( motor_id, params ) : integer指定されたモーターで新しいランブル エフェクトを開始します。
|
motor_id : | integer | アクティブにするランブル モーターの ID です。 |
params : | 新しいランブル エフェクトの詳細設定を提供するテーブルです。 |
integer |
新しく作成されたランブル エフェクトの ID です。 |
その他の関連リファレンス項目
| |
rumble_motor_id ( motor_name ) : integer?指定された名前を持つランブル モーターの ID を取得します。
|
motor_name : | string | ID を取得するランブル モーターの名前です。 |
integer? |
ランブル モーターの ID、または該当するモーターが存在しない場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
その他の関連リファレンス項目
| |
rumble_motor_name ( motor_id ) : string指定された ID を持つランブル モーターの名前を取得します。
|
motor_id : | integer | 名前を取得するランブル モーターの ID です。 |
string |
ランブル モーターの名前です。 |
| |
set_rumble ( motor_id, value )指定されたモーターで新しいランブル エフェクトを開始します。
|
motor_id : | integer | アクティブにするランブル モーターの ID です。 |
value : | number | 0 (ランブルなし)と 1 (最強)の間の値として表される、設定するランブルの強さです。 |
| この関数は値を返しません。 |
ランブルは、再度 set_rumble()を呼び出すかまたは rumble_effect()を呼び出すことにより変更されるまでは、同じ強さで継続します。
| |
set_rumble_enabled ( do_rumble )このコントローラでランブル エンジンを有効にするかどうかを決定します。
|
do_rumble : | boolean | このコントローラでランブル エンジンを有効にする場合は true、ランブルを無効にする場合は false を使用します。 |
| この関数は値を返しません。 |
| |
stop_all_rumble_effects ( motor_id )以前に rumble_effect()を呼び出すことにより作成されたすべてのランブル エフェクトを停止します。
|
motor_id : | integer | 非アクティブにするランブル モーターの ID です。 |
| この関数は値を返しません。 |
| |
stop_rumble_effect ( motor_id, ID )以前に rumble_effect()を呼び出すことによって作成されたランブル エフェクトを停止します。
|
motor_id : | integer | 非アクティブにするランブル モーターの ID です。 |
ID : | integer | ランブル エフェクトの ID です。 |
| この関数は値を返しません。 |
廃止予定の関数
代わりにこれらの関数の _id バージョンを使用します。
| |
axis_index ( name ) : integer廃止予定です。
|
name : | string | ID を取得する対象の軸の名前。 |
integer |
軸のインデックス、または一致する名前を持つ軸が見つからない場合は nil です。 |
軸は、インデックスではなく ID で参照する必要があります。代わりに axis_id()を使用してください。
| |
button_index ( name ) : integer廃止予定です。
|
| |
rumble_motor_index ( motor_name ) : integer?廃止予定です。
|
motor_name : | string | ID を取得するランブル モーターの名前です。 |
integer? |
ランブル モーターのインデックス、または該当するモーターが存在しない場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
ランブル モーターは、インデックスではなく ID で参照する必要があります。代わりに rumble_motor_id()を使用してください。
PlayStation 4 のパッド
このカテゴリ内の関数は、PlayStation 4 のパッドに対してのみ使用できます。
PlayStation 4 のユーザはパッドにログインできることに注意してください。ゲームが単一プレイヤーのゲームとして指定されていない限り、ユーザはいつでもログインおよびログアウトできます。したがって、変動をポーリングするためにメイン ループ内で user_id()を呼び出す必要があります。
| |
set_light_bar_color ( color )コントローラのライト バーを指定されたカラーに設定します。
|
color : | ライト バーの新しいカラーです。 |
| この関数は値を返しません。 |
PlayStation 4 で実行されているゲーム内で PlayStation 4 のパッドでのみ使用できます。