Interface IInput

Namespace

VMagicMirror.Buddy

キーボード、マウス、ゲームパッドなどの入力状態を取得できるAPIです。

public interface IInput

Remarks

このAPIの機能はアバター出力の一部として扱われます。 そのため、アバター出力の取得が許可されていない環境ではイベントは発火せず、値は Vector2.zero などの無効な値を返却します。

Properties

GamepadLeftStick

ゲームパッドの左スティックの値を取得します。

Vector2 GamepadLeftStick { get; }

Property Value

Vector2

Remarks

x成分は左が -1、右が 1 に対応します。 y成分は下が -1、上が 1 に対応します。 取得できるベクトルの magnitude は1以下の値になります。

GamepadRightStick

ゲームパッドの右スティックの値を取得します。

Vector2 GamepadRightStick { get; }

Property Value

Vector2

Remarks

x成分は左が -1、右が 1 に対応します。 y成分は下が -1、上が 1 に対応します。 取得できるベクトルの magnitude は1以下の値になります。

MousePosition

マウスポインターの現在の位置を、画面座標を基準として取得します。

Vector2 MousePosition { get; }

Property Value

Vector2

Remarks

x成分は左端が -0.5、右端が 0.5 を表すような値です。 y成分は下端が -0.5、上端が 0.5 を表すような値です。 値が0より小さいか、または1より大きい場合、マウスポインターがウィンドウの外側にあることを表します。

Methods

GetGamepadButton(GamepadButton)

指定したゲームパッドのボタンを押しているかどうかを取得します。

bool GetGamepadButton(GamepadButton key)

Parameters

key GamepadButton

確認したいゲームパッドのボタン

Returns

bool

指定したボタンを現在押している状態であれば true、そうでなければ false

Events

GamepadButtonDown

ゲームパッドのボタンが押されると発火します。

event Action<GamepadButton> GamepadButtonDown

Event Type

Action<GamepadButton>

GamepadButtonUp

ゲームパッドのボタンが離されると発火します。

event Action<GamepadButton> GamepadButtonUp

Event Type

Action<GamepadButton>

KeyboardKeyDown

キーボードのキーを押し下げると発火します。

event Action<string> KeyboardKeyDown

Event Type

Action<string>

Remarks

キー名はENTERキーの打鍵時に "Enter" を引数とします。 それ以外のキーについては、打鍵時してもキー名は特定できず、空文字列が引数となります。

ユーザーが打鍵をランダム表示するオプションを有効にしている場合、常に空文字列が引数になります。

KeyboardKeyUp

キーボードのキーを離すと発火します。

event Action<string> KeyboardKeyUp

Event Type

Action<string>

Remarks

キー名はENTERキーの打鍵時に "Enter" を引数とします。 それ以外のキーについては、打鍵時してもキー名は特定できず、空文字列が引数となります。

ユーザーが打鍵をランダム表示するオプションを有効にしている場合、常に空文字列が引数になります。