createGroundSurface

createGroundSurface(values?): Readonly<{ getNormalAt: (position, target) => Vector3; map: Readonly<{ cell: number; hills: Readonly<{ amplitude: number; detail: number; wavelength: number; }>; paths: Readonly<Record<string, Readonly<{ fade: number; halfWidth: number; points: readonly readonly [number, number][]; surface?: "dirt" | "stone" | "sand"; }>>>; props: Readonly<Record<string, Readonly<{ color: string; kind: PropShape; position: readonly […, …] | readonly […, …, …]; scale: number | readonly […, …, …]; size: readonly [number, number, number]; yaw: number; }> | Readonly<{ kind: ScatterKind; position: readonly […, …] | readonly […, …, …]; scale: number; yaw: number; }> | Readonly<{ model: string; position: readonly […, …] | readonly […, …, …]; scale: number | readonly […, …, …]; yaw: number; }>>>; regions: Readonly<Record<string, Readonly<{ center: readonly [number, number]; fade: number; hills: Readonly<{ amplitude: number; detail: number; wavelength: number; }>; radius: number; scatter: Readonly<{ bushRound: number; clearing: number; grassTuft: number; rockBoulder: number; rockFlat: number; seedOffset: number; treeRound: number; treeTall: number; }>; }>>>; rim: number; scatter: Readonly<{ bushRound: number; grassTuft: number; rockBoulder: number; rockFlat: number; seedOffset: number; treeRound: number; treeTall: number; }>; seed: number; size: number; views: Readonly<Record<string, Readonly<{ eye: readonly [number, number, number]; fov: number; ortho?: number; target: readonly [number, number, number]; }>>>; }>; seed: number; segments: number; size: number; getHeightAt: number; getPathDistanceAt: number; getPathSurfaceAt: { surface: NonNullable<"dirt" | "stone" | "sand" | undefined>; weight: number; } | undefined; getRegionWeightsAt: number[]; getSlopeAt: number; }>

Defined in: packages/engine/src/gameplay/map/groundSurface.ts:43

Parameters

Parameter	Type	Default value
values	TerrainMap	terrainMap

Returns

Readonly<{ getNormalAt: (position, target) => Vector3; map: Readonly<{ cell: number; hills: Readonly<{ amplitude: number; detail: number; wavelength: number; }>; paths: Readonly<Record<string, Readonly<{ fade: number; halfWidth: number; points: readonly readonly [number, number][]; surface?: "dirt" | "stone" | "sand"; }>>>; props: Readonly<Record<string, Readonly<{ color: string; kind: PropShape; position: readonly […, …] | readonly […, …, …]; scale: number | readonly […, …, …]; size: readonly [number, number, number]; yaw: number; }> | Readonly<{ kind: ScatterKind; position: readonly […, …] | readonly […, …, …]; scale: number; yaw: number; }> | Readonly<{ model: string; position: readonly […, …] | readonly […, …, …]; scale: number | readonly […, …, …]; yaw: number; }>>>; regions: Readonly<Record<string, Readonly<{ center: readonly [number, number]; fade: number; hills: Readonly<{ amplitude: number; detail: number; wavelength: number; }>; radius: number; scatter: Readonly<{ bushRound: number; clearing: number; grassTuft: number; rockBoulder: number; rockFlat: number; seedOffset: number; treeRound: number; treeTall: number; }>; }>>>; rim: number; scatter: Readonly<{ bushRound: number; grassTuft: number; rockBoulder: number; rockFlat: number; seedOffset: number; treeRound: number; treeTall: number; }>; seed: number; size: number; views: Readonly<Record<string, Readonly<{ eye: readonly [number, number, number]; fov: number; ortho?: number; target: readonly [number, number, number]; }>>>; }>; seed: number; segments: number; size: number; getHeightAt: number; getPathDistanceAt: number; getPathSurfaceAt: { surface: NonNullable<"dirt" | "stone" | "sand" | undefined>; weight: number; } | undefined; getRegionWeightsAt: number[]; getSlopeAt: number; }>