Class WalkModePlugin

Viewer plugin for first-person walking through a model, with gravity, collisions and steps.

Requires a Z-up World (viewer.camera.worldAxis = [1, 0, 0, 0, 0, 1, 0, -1, 0]).

Default controls: mouse to look (pointer lock), WASD to move, Shift to run, Space to fly up, G free flight (Space / Ctrl up / down), F go through the targeted door, Esc to exit. Keys are configurable with cfg.keys, modes can be switched off with cfg.modes, and speeds, body dimensions, physics and object types are set by the WalkModeSettings options.

import {Viewer} from "@xeokit/xeokit-sdk";
import {WalkModePlugin} from "@xeokit/sdk-plugins";

const viewer = new Viewer({canvasId: "myCanvas"});
const walkMode = new WalkModePlugin(viewer, {
    keys: {forward: ["KeyW", "ArrowUp"], fly: ["KeyV"]},
    modes: {jetpack: false},
    walkSpeed: 2,
    eyeHeight: 1.6
});

walkMode.on("target", (target) => console.log(target)); // "door" or null
walkMode.on("active", (active) => console.log(active ? "walking" : "orbiting"));

button.onclick = () => walkMode.activate(); // Pointer lock needs a user gesture
Copy