目次

概要

この記事ではC#スクリプトにおけるKeyToKey専用メンバ(プロパティ、メソッド、イベント)の概要と使用方法について解説していきます。 C#スクリプトの説明についてはこちらを参照してください。


メンバ一覧
プロパティ
Name Description
pubproperty @this
プロパティ、メソッド、イベントは全部ここにまとめてあります。 「@base」との違いは名前以外に有りません。
pubproperty @base
プロパティ、メソッド、イベントは全部ここにまとめてあります。 「@this」との違いは名前以外に有りません。
pubproperty ActiveProcessName
アクティブになっているウィンドウのプロセス名を取得します。
pubproperty ActiveWindowHandle
アクティブになっているウィンドウのウィンドウハンドルを取得します。
pubproperty SharedResources
リソースを保持しておくためのプロパティです(KeyToKey全体で共有します)。 設定ファイルをリロードするとクリアされます。
pubproperty ShouldContinue
スクリプトを続行するべきかどうかを取得します。
pubproperty CanStop
トリガーが離されたタイミングでマクロを停止できるかどうかを取得します。
pubproperty IsAvailable
現在のアクティブウィンドウで実行可能かどうかを取得します。
pubproperty IsEnabled
KeyToKeyが有効状態かどうかを取得します。
pubproperty IsModifiersPressed
割り当ての修飾キー/ボタンが押されているかどうかを取得します。
pubproperty IsRunning
マクロが実行されているかどうかを取得します。 マクロの実行・停止フラグになっており、トリガーが離されたタイミングでFalseになります。 マクロが途中停止不可・実行途中であってもFalseになります。
pubproperty IsTriggerPressed
割り当てのトリガーが押されているかどうかを取得します。
pubproperty Elapsed
アクションが実行されてからの経過時間を取得します。
pubproperty Trigger
割り当てのトリガー トリガーを取得するには以下のインターフェイスにキャストします。 Trigger is KeyToKey.Plugins.Trigger.IKeyboard Trigger is KeyToKey.Plugins.Trigger.IController
pubproperty Clipboard
クリップボード
pubproperty Controller
コントローラー
pubproperty IME
IME
pubproperty Input
キーボード、マウス、コントローラー
pubproperty Keyboard
キーボード
pubproperty Macro
マクロ
pubproperty Modifier
割り当ての修飾キー/ボタン
pubproperty Mouse
マウス
pubproperty PathSelector
パス
pubproperty Sound
サウンド
pubproperty TemplateMatching
テンプレートマッチング
pubproperty Variable
変数
pubproperty VirtualXInput
仮想XInput
pubproperty Window
ウィンドウ
メソッド
Name Description
pubmethod
Activate(IntPtr)
指定されたウィンドウをアクティブにする。
pubmethod
Activate(String, Boolean)
指定されたプロセス名のウィンドウをアクティブにします。
pubmethod
Cancel
Wait系メソッドをキャンセルします。
pubmethod
ChangeFile
設定ファイルを変更します。
pubmethod
Down
キー/マウスのボタンを押します。
pubmethod
GetClassName
ウィンドウのクラス名を取得します。
pubmethod
GetClientLocation
タイトルバー(キャプションバー)を含まないクライアント領域の座標を取得します。
pubmethod
GetClientSize
ウィンドウのサイズを取得します。
pubmethod
GetCursorPosition
マウスカーソルの位置を取得します。
pubmethod
GetTextFromClipboard
クリップボードからテキストを取得します。
pubmethod
GetVar(String)
KeyToKey側の変数を取得します。
pubmethod
GetVar<T>(String)
KeyToKey側の変数を指定した型にキャストして取得します。
pubmethod
GetWindowLocation
ウィンドウの座標を取得します。
pubmethod
GetWindowLong
指定されたウィンドウに関する情報を取得します。
pubmethod
GetWindowSize
ウィンドウのサイズを取得します。
pubmethod
GetWindowTitlte
ウィンドウのタイトルを取得します。
pubmethod
InputText
文字列を入力します。
pubmethod
Invoke(Action)
UIスレッドでデリゲートを実行します。
pubmethod
Invoke<T>(Func T)
UIスレッドでデリゲートを実行し、戻り値を取得します。
pubmethod
IsMaximized
ウィンドウが最大化されているかどうかを取得します。
pubmethod
IsMinimized
ウィンドウが最小化されているかどうかを取得します。
pubmethod
IsPressed(ControllerButtons)
コントローラーのボタンが押されているかどうかを取得します。
pubmethod
IsPressed(Keys)
キー/マウスのボタンが押されているかどうかを取得します。
pubmethod
Move(Int32, Int32, Int32)
マウスカーソルを指定した位置へ移動させます。
pubmethod
Move(Int32, Int32, Int32, Int32, Boolean, Boolean)
マウスカーソルを指定した位置へ移動させます。
pubmethod
NotifyMessage
メインウィンドウにメッセージを表示させます。
pubmethod
Offset(Int32, Int32, Int32)
マウスカーソルを指定した分だけ移動させます。
pubmethod
Offset(Int32, Int32, Int32, Int32, Boolean, Boolean)
マウスカーソルを指定した分だけ移動させます。
pubmethod
PlaySound
音声ファイルを再生します。
pubmethod
PlaySystemSound
システム音声を再生します。
pubmethod
Random
指定した範囲のランダムな値を取得します。
pubmethod
SetForegroundWindow
全面に表示するウィンドウをセットします。
pubmethod
SetTextToClipboard
クリップボードにテキストをセットします。 ※セットに失敗することがあります。
pubmethod
SetVar
KeyToKey側の変数に値を代入します。 変数が存在しない場合は変数を作成します。
pubmethod
SetWindowLong
指定されたウィンドウの属性を変更します。
pubmethod
SetWindowPosition
ウィンドウの位置や幅、Zオーダーを設定します。
pubmethod
SetWindowState
ウィンドウの表示状態を設定します。
pubmethod
SetWindowTitle
ウィンドウタイトルを変更します。
pubmethod
ShowTextBoxDialog
テキストボックスを表示します。
pubmethod
Tap
キー/マウスのボタンを押して離します。
pubmethod
ThrowIfShouldNotContinue
ShouldContinueプロパティがFalseであれば例外を投げます。
pubmethod
TryMultiple(String, out IEnumerable<MatchResult>)
テンプレート画像に類似する複数の画像を探します。
pubmethod
TrySingle(String, Int32, Int32, Int32, Int32, Double, out IEnumerable<MatchResult>)
テンプレート画像に類似する複数の画像を探します。
pubmethod
TryParse
KeyToKey側の値を解析・取得します。
pubmethod
TrySingle(String, out MatchResult)
テンプレート画像に類似する一つの画像を探します。
pubmethod
TrySingle(String, Int32, Int32, Int32, Int32, Double, out MatchResult)
テンプレート画像に類似する一つの画像を探します。
pubmethod
Up
キー/マウスのボタンを離します。
pubmethod
Wait
Cancelメソッドが呼び出されるまで待機します。
pubmethod
Wait(Int32)
指定した時間待機します。Cancelメソッドで待機をキャンセルできます。
pubmethod
Wait(TimeSpan)
指定した時間待機します。Cancelメソッドで待機をキャンセルできます。
pubmethod
WaitForInput(ControllerButtons, Boolean)
指定されたコントローラーのボタンが入力されるまで待機します。
pubmethod
WaitForInput(Keys, Boolean)
指定されたキーやマウスのボタンが入力されるまで待機します。
pubmethod
WaitForInput(ControllerButtons, ControllerButtons, Boolean)
指定されたコントローラーのボタンが入力されるまで待機します。
pubmethod
WaitForInput(Keys, Keys, Boolean)
指定されたキーやマウスのボタンが入力されるまで待機します。
pubmethod
WheelDown
ホイール下
pubmethod
WheelLeft
ホイール左
pubmethod
WheelRight
ホイール右
pubmethod
WheelUp
ホイール上
イベント
Name Description
pubevent
ControllerStateChanged
コントローラーのボタンが入力されたら発生します。
pubevent
Disposing
解放処理時が実行されたら発生します。 True:一時的な解放 False:恒久的な解放
pubevent
IsAvailableChanged
IsAvailableの値が変わったら発生します。
pubevent
IsEnabledChanged
IsEnabledの値が変わったら発生します。
pubevent
IsRunningChanged
IsRunningの値が変わったら発生します。
pubevent
KeyStateChanged
キーが入力されたら発生します。


ステータスプロパティ
キーボード/マウス
コントローラー


トリガーと修飾キー/ボタン
画像認識
待機


IME
クリップボード
変数
サウンド
仮想XInputコントローラー
パスの選択
ウィンドウ
その他
イベントのみを使用する際の実装例