noisemap.md

Class: noisemap

Represents a map of floats values, typically use with a noise generator.

Table of contents

Constructors

• constructor

Methods

• get
• height
• is_highest
• set
• width

Constructors

constructor

+ new noisemap(): noisemap

Returns: noisemap

Methods

get

▸ get(pos: vector_3d): number

Returns the float value at a specific 3d position.

note The 'y' value of pos is ignored by this operation.

Parameters:

Name	Type
pos	vector_3d

Returns: number

---

height

▸ height(): number

Returns: number

---

is_highest

▸ is_highest(pos: vector_3d, check_radius: number): boolean

Returns true if the float value at a 3d position is the highest position within a given range.

This is typically used for object placement.

Parameters:

Name	Type
pos	vector_3d
check_radius	number

Returns: boolean

---

set

▸ set(x: number, y: number, value: number): void

Parameters:

Name	Type
x	number
y	number
value	number

Returns: void

---

width

▸ width(): number

Returns: number