Skip to main content

BuilderGuide​

Associated namespace: sm.builderGuide

A userdata object representing a builder guide.

Values:

  • id [ int ]

    • Get: The id of the guide.

Operations:

OperationDescription
BuilderGuide == BuilderGuideChecks if two instances of BuilderGuide refer to the same BuilderGuide.

Functions​

destroy​

builderGuide:destroy()

Destroys the guide.

Parameters:

getCurrentStageIndex​

builderGuide:getCurrentStageIndex()

Returns the stage index of the guide.

Parameters:

Returns:

  • (int): The stage index.

getId​

builderGuide:getId()

Returns the id of the guide.

Parameters:

Returns:

  • (int): The guide's id.

isComplete​

builderGuide:isComplete()

Returns the completion status of the guide.

Parameters:

Returns:

  • (boolean): The guide's completion status.

update​

builderGuide:update()

Updates the state of the guide.
Should be called whenever the root Shape of the builder guide has changed.

Parameters: