Blueprint

Represents the basic information (blueprints) of the entire game, the possible settings, and the predefined and configured options.

Methods

Returns the ID of the blueprint.

getId(): string

Returns

string

---

Set the ID of the blueprint.

setId(id): void

Parameters

Name	Type	Description
id	string	The ID of the blueprint.

---

Returns the version (`SHA-256` commit version) of the blueprint.

getVersion(): string

Returns

string

---

Set the version of the blueprint.

setVersion(commit): void

Parameters

Name	Type	Description
commit	string	The version (`SHA-256` commit version) of the blueprint.

---

Returns the name of the blueprint.

getName(): string

Returns

string

---

Set the name of the blueprint.

setName(name): void

Parameters

Name	Type	Description
name	string	The name of the blueprint.

---

Returns the list of available thumbnails.

getThumbnails(): string[]

Returns

string[]

---

Sets the list of available thumbnails.

setThumbnails(thumbnails): void

Parameters

Name	Type	Description
thumbnails	string[]

---

Get a stored thumbnail by index.

getThumbnail(index): string

Parameters

Name	Type	Description
index	number

Returns

string

---

Adds a new thumbnail to the list of available thumbnails.

addThumbnail(url): void

Parameters

Name	Type	Description
url	string	The URL of the thumbnail to add.

---

Deletes an assigned thumbnail.

removeThumbnail(index): void

Parameters

Name	Type	Description
index	number	The index of the thumbnail to delete.

---

Returns all tags.

getTags(): Tag[]

Returns

Tag[]

---

Sets the tags.

setTags(tags): void

Parameters

Name	Type	Description
tags	Tag[]	Array of tags

---

Adds a tag to the list of tags.

addTag(tag): void

Parameters

Name	Type	Description
tag	Tag	The tag to add

---

Removes a tag from the list of tags.

removeTag(index): void

Parameters

Name	Type	Description
index	number	The index of the tag to remove

---

Returns all unique categories from all settings/options.

getCategories(): string[]

Returns

string[]

---

Returns all options, optionally filtered by category.

getOptions(category?): Option[]

Parameters

Name	Type	Description
category (optional)	string | undefined	Optional category name to filter by. If not provided, returns all options.

Returns

Option[]

---

Checks if a specific category exists in any of the options.

hasCategory(category): boolean

Parameters

Name	Type	Description
category	string	The category name to check

Returns

boolean

---

Converts the received JSON data into a Blueprint object.

fromJSON(json): Blueprint

Parameters

Name	Type	Description
json	any	The JSON data to convert.

Returns

Blueprint

---

Converts the blueprint object to valid JSON data.

toJSON(): any

Returns

any

---