Skip to main content

sm.builderGuide​

Associated object type: BuilderGuide

Builder Guide

Functions​

createBuilderGuide​

sm.builderGuide.createBuilderGuide( path, shape, ignoreBlockUuid )

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

Arguments:
  • path [ string ]: The file path to the builder guide blueprint.
  • shape [ Shape ]: Root Shape for comparing the creation from.
  • ignoreBlockUuid [ bool ]: Whether the block UUID should be ignored for stage completion. Defaults to false.
Returns: