BuilderGuide

Associated namespace: sm.builderGuide

A userdata object representing a builder guide.

Values:

Functions:

Operations:

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

id integer

Get:

Returns the id of a guide.


destroy(guide)

Destroys a guide.

Parameters:

TypeNameDescription
BuilderGuideguideThe guide to be destroyed.

getCurrentStageIndex(guide)

Returns the stage index of a guide.

Parameters:

TypeNameDescription
BuilderGuideguideThe guide.

Returns:

TypeDescription
integerThe stage index.

getId(guide)

Returns the id of a guide.

Parameters:

TypeNameDescription
BuilderGuideguideThe guide.

Returns:

TypeDescription
integerThe guide's id.

isComplete(guide)

Returns the completion status of a guide.

Parameters:

TypeNameDescription
BuilderGuideguideThe guide.

Returns:

TypeDescription
booleanTrue if the guide is completed.

update(guide)

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

Parameters:

TypeNameDescription
BuilderGuideguideThe guide