Keyboard

Keyboard.hook()

hook(key: Keyboard.Key, fn: Keyboard.HookFunc): Uuid;

キー入力をフックします。 fn が true を返した場合、デフォルトの処理が無視され、 false を返した場合、続いてデフォルトの処理が実行されます。

• TypeScript
• JavaScript

// Aを入力するとコンポをつくる。
const uuid = Atarabi.keyboard.hook({ code: 'A' }, ctx => {
    app.project.items.addComp('Comp', 1000, 1000, 1, 100, 30);
    return true; // trueを返した場合、デフォルトの処理が呼ばれなくなる。
});

// Aを入力するとコンポをつくる。
var uuid = Atarabi.keyboard.hook({ code: 'A' }, function (ctx) {
    app.project.items.addComp('Comp', 1000, 1000, 1, 100, 30);
    return true; // trueを返した場合、デフォルトの処理が呼ばれなくなる。
});

Added in version 0.2.0.

Keyboard.unhook()

unhook(uuid: Uuid): void;

キー入力のフックを解除します。

• TypeScript
• JavaScript

const uuid = Atarabi.keyboard.hook({ code: 'C', ctrlOrCmdKey: true }, ctx => {
    alert('C');
    return true;
});

Atarabi.keyboard.unhook(uuid);

var uuid = Atarabi.keyboard.hook({ code: 'C', ctrlOrCmdKey: true }, function (ctx) {
    alert('C');
    return true;
});
Atarabi.keyboard.unhook(uuid);

Added in version 0.2.0.

Keyboard.enableHook()

enableHook(enable: boolean): void;

フック機能をオンorオフにします。

• TypeScript
• JavaScript

Atarabi.keyboard.enableHook(false);

Atarabi.keyboard.enableHook(false);

Added in version 0.2.0.

Keyboard.enableHookByUuid()

enableHookByUuid(uuid: Uuid, enable: boolean): void;

個別のフックに対してオンorオフにします。

• TypeScript
• JavaScript

const uuid = Atarabi.keyboard.hook({ code: 'D', ctrlOrCmdKey: true }, ctx => {
    alert('D');
    return true;
});

Atarabi.keyboard.enableHookByUuid(uuid, false);

var uuid = Atarabi.keyboard.hook({ code: 'D', ctrlOrCmdKey: true }, function (ctx) {
    alert('D');
    return true;
});
Atarabi.keyboard.enableHookByUuid(uuid, false);

Added in version 0.2.0.

Keyboard.sendKeys()

sendKeys(keys: Keyboard.Key[]): void;

キー入力します。

• TypeScript
• JavaScript

// 新規カメラレイヤー
Atarabi.keyboard.sendKeys([{ code: 'C', ctrlOrCmdKey: true, altKey: true, shiftKey: true }]);

// 新規カメラレイヤー
Atarabi.keyboard.sendKeys([{ code: 'C', ctrlOrCmdKey: true, altKey: true, shiftKey: true }]);

Added in version 0.2.0.