sm.visualization.createBuilderGuide

Create a builder guide BlueprintVisualization, comparing the creation from the root Shape to the blueprint give by path.

Kind: Function

Environments: Game

Game

sm.visualization.createBuilderGuide(
    path,
    shape,
    ignoreBlockUuid,
    completeEffectName,
    completeEffectAtBaseName
)

Open the full Game reference

Availability: Client only

The builder guide blueprint contains stage indices based on shape color, stage color order is the same as the color order in the PaintTool color picker.

Parameters:

Name	Type	Description
`path`	string	A file path to the builder guide blueprint
`shape`	Shape	Root Shape for comparing the creation from
`ignoreBlockUuid` (optional)	boolean	Should block uuid be evaluated for stage completion (Defaults to false)
`completeEffectName` (optional)	string	The name of the effect that should be played at the placed block once the builder guide stage is completed (Defaults to "")
`completeEffectAtBaseName` (optional)	string	The name of the effect that should be played at the base once the builder guide stage is completed (Defaults to "")

Returns:

Type	Description
BlueprintVisualization	The builder guide blueprint visualization