@bendyline/molen-kernel/character

Molen headless deterministic simulation kernel (no DOM, no three.js).

import { /* … */ } from '@bendyline/molen-kernel/character';

Interfaces

CharacterData

Extends

• JsonObject

Indexable

[key: string]: JsonValue | undefined

Properties

gravity

gravity: number;

grounded

grounded: boolean;

jumpSpeed

jumpSpeed: number;

speed

speed: number;

vy

vy: number;

Vertical velocity (kernel-owned).

---

CharacterOptions

Properties

groundHeight?

optional groundHeight?: (x, z) => number;

Terrain/ground height at a world XZ. Default: the world's registered ground field (installTerrain, resolved lazily each tick so install order does not matter), else a flat ground at y=0.

Parameters

x

number

z

number

Returns

number

---

MoveIntentData

Extends

• JsonObject

Indexable

[key: string]: JsonValue | undefined

Properties

dir

dir: [number, number];

Desired planar move direction (need not be normalized).

jump

jump: boolean;

Variables

Character

const Character: ComponentType<CharacterData>;

---

MoveIntent

const MoveIntent: ComponentType<MoveIntentData>;

Functions

installCharacterController()

function installCharacterController(world, opts?): void;

Install the character controller system (physics phase).

Parameters

world

World

opts?

CharacterOptions

Returns

void