Goodluck / API Reference

ControlPlayer

Make the entity controllable by the player. Suitable for first-person and third-person 3D games, as well as some camera control schemes.

View source on GitHub

import {Entity} from "../../lib/world.js";
import {Game} from "../game.js";
import {Has} from "../world.js";

export interface ControlPlayer {
    Move: boolean;
    Yaw: number;
    Pitch: number;
    MinPitch: number;
    MaxPitch: number;
}

Add ControlPlayer to an entity.

move param: Whether to control the entity's movement.
yaw param: Sensitivity of the yaw control. 1 means that 1 pixel traveled by the mouse is equal to 1° of rotation; that's too sensitive usually.
pitch param: Sensitivity of the pitch control. 1 means that 1 pixel traveled by the mouse is equal to 1° of rotation; that's too sensitive usually.
min_pitch param: Min pitch allowed, in arc degrees.
max_pitch param: Max pitch allowed, in arc degrees.

export function control_player(
    move: boolean,
    yaw: number,
    pitch: number,
    min_pitch = 0,
    max_pitch = 0
) {
    return (game: Game, entity: Entity) => {
        game.World.Signature[entity] |= Has.ControlPlayer;
        game.World.ControlPlayer[entity] = {
            Move: move,
            Yaw: yaw,
            Pitch: pitch,
            MinPitch: min_pitch,
            MaxPitch: max_pitch,
        };
    };
}