Skip to main content

sm.builderGuide​

Associated object type: BuilderGuide

A BuilderGuide is used as a tutorial to guide the player with constructing a given creation blueprint.

Functions​

createBuilderGuide​

local guide = sm.builderGuide.createBuilderGuide(path, shape, ignoreBlockUuid)

Creates a BuilderGuide, comparing the creation from the root Shape to the blueprint given by the path.

Parameters:

  • path (string): The file path to the builder guide blueprint.
  • shape (Shape): The root shape to compare the creation from.
  • ignoreBlockUuid (boolean, optional): Whether block UUIDs should be ignored for stage completion. Defaults to false.

Returns:

destroy​

sm.builderGuide.destroy(guide)

Destroys a BuilderGuide.

Parameters: