SceneUploadBuilder
A builder for a new SceneUpload.
Reference
Methods
name
name(name);
Set the upload name.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| name | string | The name of the uploaded scene |
Returns the current builder.
fogFilled
fogFilled(filled);
Set the scenes fog filled.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| filled | boolean | The new filled state of the fog |
Returns the current builder.
fogColor
fogColor(color);
Set the scenes fog color.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| color | string | The new color of the fog |
Returns the current builder.
fogStrokeWidth
fogStrokeWidth(width);
Set the scenes fog strokeWidth.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| width | number | The new width fog stroke |
Returns the current builder.
gridScale
gridScale(scale);
Set the scenes grid scale.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| scale | string | The new raw scale of the grid |
Returns the current builder.
gridColor
gridColor(color);
Set the scenes grid color.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| color | GridColor | The new color of the grid |
Returns the current builder.
gridOpacity
gridOpacity(opacity);
Set the scenes grid opacity.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| opacity | number | The new opacity of the grid between 0 and 1 |
Returns the current builder.
gridLineType
gridLineType(lineType);
Set the scenes grid lineType.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| lineType | GridLineType | The new type of the grid line |
Returns the current builder.
gridMeasurement
gridMeasurement(measurement);
Set the scenes grid measurement.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| measurement | GridMeasurement | The new measurement type of the grid |
Returns the current builder.
gridType
gridType(type);
Set the scene grids type.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| type | GridType | The new type of the grid |
Returns the current builder.
items
items(items);
Set the scenes default items.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| Items | Item[] | The default items used for the scene |
Returns the current builder.
baseMap
baseMap(baseMap);
Set the scenes base map that should be included with this scene during upload.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| baseMap | ImageUpload | The image to upload as a map |
Returns the current builder.
build
build();
Returns the final SceneUpload.