Skip to content

Commit

Permalink
docs(prefabs/mesh/plane): add description to the properties
Browse files Browse the repository at this point in the history
  • Loading branch information
meszaros-lajos-gyorgy committed Aug 16, 2023
1 parent e6e6f77 commit ae39f0f
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions src/prefabs/mesh/plane.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,30 @@ export const INDEXED = 'indexed'
export const NONINDEXED = 'non-indexed'

type createPlaneMeshProps = {
/**
* width and height of the plane
*/
size: Vector2 | number
/**
* the plane will be made from smaller squares with the size given via this prop
* setting tileSize to 50 will subdivide the mesh into 50x50 squares
*
* default value is 100
*/
tileSize?: number
texture: TextureOrMaterial
/**
* If set to true, then the texture will be placed on every tile, otherwise the
* texture will be stretched throughout the whole mesh
*
* default value is true
*/
tileUV?: boolean
/**
* when a mesh is indexed, then polygons reuse the vertices: moving one vertex
* will modify multiple polygons. If non-indexed, then all polygons have their
* own vertices.
*
* default value is INDEXED
*/
isIndexed?: typeof INDEXED | typeof NONINDEXED
Expand Down

0 comments on commit ae39f0f

Please sign in to comment.