PlanetData
Defined in: sdk/src/terrain/planetPlugin.ts:47
The fields of the Planet component.
Properties
Section titled “Properties”cellSize
Section titled “cellSize”cellSize:
number
Defined in: sdk/src/terrain/planetPlugin.ts:56
The finest cell of the ground’s mesh, in metres, and how far out the finest cells reach before the ground coarsens (above 1 is further).
collision
Section titled “collision”collision:
boolean
Defined in: sdk/src/terrain/planetPlugin.ts:67
Whether bodies and characters collide with the ground; how far round each thing that moves it is built for collision; its layer and friction.
collisionDistance
Section titled “collisionDistance”collisionDistance:
number
Defined in: sdk/src/terrain/planetPlugin.ts:68
collisionLayer
Section titled “collisionLayer”collisionLayer:
number
Defined in: sdk/src/terrain/planetPlugin.ts:69
detail
Section titled “detail”detail:
number
Defined in: sdk/src/terrain/planetPlugin.ts:57
friction
Section titled “friction”friction:
number
Defined in: sdk/src/terrain/planetPlugin.ts:70
generatorVersion
Section titled “generatorVersion”generatorVersion:
number
Defined in: sdk/src/terrain/planetPlugin.ts:53
gravity
Section titled “gravity”gravity:
number
Defined in: sdk/src/terrain/planetPlugin.ts:78
How hard the planet pulls what is on it, in metres a second squared at the surface; 0 pulls nothing. Bodies are pulled toward the centre of the nearest planet that pulls (physics3d/planetGravity.ts).
layerColor0
Section titled “layerColor0”layerColor0:
Color
Defined in: sdk/src/terrain/planetPlugin.ts:59
The four layers’ colours: grass, dirt, snow, rock.
layerColor1
Section titled “layerColor1”layerColor1:
Color
Defined in: sdk/src/terrain/planetPlugin.ts:60
layerColor2
Section titled “layerColor2”layerColor2:
Color
Defined in: sdk/src/terrain/planetPlugin.ts:61
layerColor3
Section titled “layerColor3”layerColor3:
Color
Defined in: sdk/src/terrain/planetPlugin.ts:62
layers
Section titled “layers”layers:
string[]
Defined in: sdk/src/terrain/planetPlugin.ts:80
The terrain layers (.esterrainlayer files, up to four) the ground is drawn with, in the order the paint weighs them. Empty draws the four layer colours.
macroScale
Section titled “macroScale”macroScale:
number
Defined in: sdk/src/terrain/planetPlugin.ts:64
The size, in metres, of the ground’s own wander in brightness, and how strong it is (0 to 1).
macroVariation
Section titled “macroVariation”macroVariation:
number
Defined in: sdk/src/terrain/planetPlugin.ts:65
provider
Section titled “provider”provider:
string
Defined in: sdk/src/terrain/planetPlugin.ts:51
The generator the ground is made by (registerPlanetProvider), the world it belongs to as the game names it, its version and its seed.
radius
Section titled “radius”radius:
number
Defined in: sdk/src/terrain/planetPlugin.ts:49
The planet’s radius in metres.
sea:
boolean
Defined in: sdk/src/terrain/planetPlugin.ts:72
Whether the planet has a sea: a sphere at seaLevel above the radius, which the ground that dips below it stands in.
seaColor
Section titled “seaColor”seaColor:
Color
Defined in: sdk/src/terrain/planetPlugin.ts:75
The sea’s colour and how much of it there is over what is under it (0 to 1).
seaLevel
Section titled “seaLevel”seaLevel:
number
Defined in: sdk/src/terrain/planetPlugin.ts:73
seaOpacity
Section titled “seaOpacity”seaOpacity:
number
Defined in: sdk/src/terrain/planetPlugin.ts:76
seed:
number
Defined in: sdk/src/terrain/planetPlugin.ts:54
world:
string
Defined in: sdk/src/terrain/planetPlugin.ts:52