exports

new exports(name, version)

Constructor for the Overlay class.

Since:

0.0.2

Source:

Overlay.js, line 34

See:

Overlay

Parameters:

Name	Type	Description
`name`	`string`	The name of the userscript
`version`	`string`	The version of the userscript

exports

new exports(templateManager)

Constructor for ApiManager class

Since:

0.11.34

Source:

apiManager.js, line 16

Parameters:

Name	Type	Description
`templateManager`	`TemplateManager`

exports

new exports()

The constructor for the observer class

Since:

0.43.2

Source:

observers.js, line 11

exports

new exports(name, version)

The constructor for the TemplateManager class.

Since:

0.55.8

Source:

templateManager.js, line 92

Parameters:

Name	Type	Description
`name`	`string`	The name of the userscript
`version`	`string`	The version of the userscript (SemVer as string)

exports

new exports(paramsopt)

The constructor for the Template class with enhanced pixel tracking.

Since:

0.65.2

Source:

Template.js, line 24

Parameters:

Name Type Attributes Default Description

params

Object

{}

Object containing all optional parameters

Name	Type	Attributes	Default	Description
`displayName`	`string`	<optional>	'My template'	The display name of the template
`sortID`	`number`	<optional>	0	The sort number of the template for rendering priority
`authorID`	`string`	<optional>	''	The user ID of the person who exported the template (prevents sort ID collisions)
`url`	`string`	<optional>	''	The URL to the source image
`file`	`File`	<optional>	null	The template file (pre-processed File or processed bitmap)
`coords`	`Array.<number, number, number, number>`	<optional>	null	The coordinates of the top left corner as (tileX, tileY, pixelX, pixelY)
`chunked`	`Object`	<optional>	null	The affected chunks of the template, and their template for each chunk as a bitmap
`chunked32`	`Object`	<optional>	{}	The affected chunks of the template, and their template for each chunk as a Uint32Array
`tileSize`	`number`	<optional>	1000	The size of a tile in pixels (assumes square tiles)
`pixelCount`	`Object`	<optional>	{total:0, colors:Map}	Total number of pixels in the template (calculated automatically during processing)

exports

new exports(name, version)

Constructor for the main Blue Marble window

Since:

0.88.326

Source:

WindowMain.js, line 22

See:

Overlay#constructor

Parameters:

Name	Type	Description
`name`	`string`	The name of the userscript
`version`	`string`	The version of the userscript

exports

new exports(executor)

Constructor for the color filter window

Since:

0.88.329

Source:

WindowFilter.js, line 18

See:

Overlay#constructor

Parameters:

Name	Type	Description
`executor`	`*`	The executing class

exports

new exports(name, version, currentTelemetryVersion, uuid)

Constructor for the telemetry window

Since:

0.88.339

Source:

WindowTelemetry.js, line 20

See:

Overlay#constructor

Parameters:

Name	Type	Description
`name`	`string`	The name of the userscript
`version`	`string`	The version of the userscript
`currentTelemetryVersion`	`number`	The current "version" of the data collection agreement
`uuid`	`string`	The UUID of the user

exports

new exports()

The constructor for the confetti manager.

Since:

0.88.356

Source:

confetttiManager.js, line 13

exports

new exports(name, version, schemaVersionBleedingEdge, templateManageropt)

Constructor for the Template Wizard window

Since:

0.88.434

Source:

WindowWizard.js, line 21

See:

Overlay#constructor for examples

Parameters:

Name	Type	Attributes	Description
`name`	`string`		The name of the userscript
`version`	`string`		The version of the userscript
`schemaVersionBleedingEdge`	`string`		The bleeding edge of schema versions for Blue Marble
`templateManager`	`TemplateManager`	<optional>	(Optional) The TemplateManager class instance

exports

new exports(name, version)

Constructor for the Credits window

Since:

0.90.9

Source:

WindowCredits.js, line 17

See:

Overlay#constructor for examples

Parameters:

Name	Type	Description
`name`	`string`	The name of the userscript
`version`	`string`	The version of the userscript

exports

new exports(name, version)

Constructor for the Settings window

Since:

0.91.11

Source:

WindowSettings.js, line 18

See:

Overlay#constructor for examples

Parameters:

Name	Type	Description
`name`	`string`	The name of the userscript
`version`	`string`	The version of the userscript

exports

new exports(name, version, userSettings)

Constructor for the SettingsManager class

Since:

0.91.11

Source:

settingsManager.js, line 30

Parameters:

Name	Type	Description
`name`	`string`	The name of the userscript
`version`	`string`	The version of the userscript
`userSettings`	`Object`	The user settings as an object