Skip to content

A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.

2.9 KB
Raw Blame

API surface — esengine/spline

Symbols: 0 public · 0 beta · 20 experimental · 0 deprecated

PathFollower — const @experimental

ComponentDef<PathFollowerData>

PathFollowerData — interface @experimental

distance: number
mode: number
orient: number
playing: boolean
speed: number
spline: number

PathMode — const @experimental

{ readonly Once: 0; readonly Loop: 1; readonly PingPong: 2; }

PathOrient — const @experimental

{ readonly None: 0; readonly FaceXZ: 1; readonly FaceXY: 2; }

RoadDecal — const @experimental

ComponentDef<RoadDecalData>

RoadDecalData — interface @experimental

across: number
edgeFade: number
lift: number
step: number
tile: number
widthScale: number

RoadGround — interface @experimental

heightAt: (x: number, z: number) => number | null
normalAt: ((x: number, z: number) => readonly [number, number, number] | null) | undefined

Spline — const @experimental

ComponentDef<SplineData>

SplineCurve — class @experimental

closed: boolean
count: number
length: number
nearest: (x: number, z: number) => SplineNearest
position: (s: number) => [number, number, number]
tangent: (s: number) => [number, number, number]
width: (s: number) => number
static new (points: readonly SplinePoint[], closed?: boolean): SplineCurve
static prototype: SplineCurve

SplineData — interface @experimental

closed: boolean
points: SplinePoint[]

SplineNearest — interface @experimental

distance: number
s: number
side: number

SplinePlugin — class @experimental

build: (app: App) => void
name: string
static new (): SplinePlugin
static prototype: SplinePlugin

SplinePoint — interface @experimental

width: number
x: number
y: number
z: number

TerrainBand2D — const @experimental

ComponentDef<TerrainBand2DData>

TerrainBand2DData — interface @experimental

collider: boolean
depth: number
edgeColor: { r: number; g: number; b: number; a: number; }
edgeTexture: number
edgeTile: number
edgeWidth: number
resolution: number
tile: number

TerrainBandBuild — interface @experimental

closed: boolean
edge: MeshRendererGeometry | null
geometry: MeshRendererGeometry
outline: Vec2[]

buildRoadDecal — function @experimental

(spline: SplineData, road: RoadDecalData, origin: { x: number; y: number; z: number; }, ground: RoadGround | null): MeshData | null

buildTerrainBand — function @experimental

(points: readonly SplinePoint[], closedCurve: boolean, band: TerrainBand2DData): TerrainBandBuild | null

pathPlace — function @experimental

(travelled: number, length: number, mode: number, forward?: boolean): { s: number; done: boolean; }

splinePlugin — const @experimental

Plugin