Class YTerrain

Hierarchy

YTerrain

Index

Constructors

constructor

Accessors

modifiable

Methods

Constructors

constructor

new YTerrain(): YTerrain

Returns YTerrain

Accessors

Static modifiable

get modifiable(): boolean
set modifiable(value: boolean): any

Allows to get / set whenever it is possible to modify terrain in-game.

Returns boolean
Allows to get / set whenever it is possible to modify terrain in-game.

Parameters
- value: boolean
Returns any

Methods

Static applyShape

applyShape(shape: YTerrainStampShape, position: YVector3, rotation: YVector3, dimensions: YVector3, material: YVoxel, applyMode: YTerrainStampingMode, onSuccess: () => void, onFailure: (failReason: YTerrainStampError) => void): void

Allows to apply or remove terrain of the selected material to/from the selected shape.

Parameters
- shape: YTerrainStampShape
- position: YVector3
- rotation: YVector3
- dimensions: YVector3
- material: YVoxel
- applyMode: YTerrainStampingMode
- onSuccess: () => void
  - - (): void
    - Returns void
- onFailure: (failReason: YTerrainStampError) => void
  - - (failReason: YTerrainStampError): void
    - Parameters
      - failReason: YTerrainStampError
      Returns void
Returns void

Static getMaterial

getMaterial(position: YVector3): YVoxel

Allows to get the material property of the target ** Terrain volume** Game Logic.

Parameters
- position: YVector3
Returns YVoxel

Generated using TypeDoc