useMoveByKeyboard

平行于地面移动。

使用W S A D进行前后左右移动，使用shift向下移动，使用space向上移动。

使用

const speed = ref(1)
useMoveByKeyboard({
  // distancePerFrame: 1,
  distancePerFrame: speed,
  keybinding: {
    forward: 'ArrowUp',
    backward: 'ArrowDown',
    left: 'ArrowLeft',
    right: 'ArrowRight'
  }
})

distancePerFrame 接受响应式的数字类型参数，以动态调整移动速度。当你希望禁用移动时，可以直接将其设置{ distancePerFrame: 0 }。 可以通过keybinding选项修改按键绑定。

distancePerFrame 还可以接受一个函数以更加细粒度的控制速度:

useMoveByKeyboard({
  distancePerFrame(key) {
    if (key === 'backward')
      return 1

    return 3
  }
})

可选的按键

按键绑定基于vueuse的useMagicKeys实现，更多可选的按键见mozilla

demo

类型声明

Details

export type UseMoveByKeyboardKeybindingList =
  | "forward"
  | "backward"
  | "left"
  | "right"
  | "down"
  | "up"
export interface UseMoveByKeyboardOptions {
  distancePerFrame?:
    | MaybeRef<number>
    | ((key: UseMoveByKeyboardKeybindingList) => number)
  keybinding?: Partial<Record<UseMoveByKeyboardKeybindingList, string>>
}
/**
 * Moving parallel to the ground.
 *
 * To move forward, backward, left, and right, use `W S A D`. Press `Shift` to move downward and `Space` to move upward.
 */
export declare function useMoveByKeyboard(
  options?: UseMoveByKeyboardOptions,
): void

源码

source • demo