BuilderGuide
A userdata object representing a builder guide.
Values:
Functions:
Operations:
id integer
Get:
Returns the id of a guide.
destroy(guide)
Destroys a guide.
Parameters:
| Type | Name | Description |
|---|
| BuilderGuide | guide | The guide to be destroyed. |
getCurrentStageIndex(guide)
Returns the stage index of a guide.
Parameters:
Returns:
| Type | Description |
|---|
| integer | The stage index. |
getErrorInfo(guide)
Returns error information of the builder guide.
Parameters:
Returns:
| Type | Description |
|---|
| table | Table of errors { blocks = number, joints = number, parts = number, connections = number, connectionsReversed = number }, |
getId(guide)
Returns the id of a guide.
Parameters:
Returns:
| Type | Description |
|---|
| integer | The guide's id. |
getStageInfo(guide)
Returns information about the current stage.
Parameters:
Returns:
| Type | Description |
|---|
| table | Table of stage info { blocksLeft = number, jointsLeft = number, partsLeft = number, connectionsLeft = number }, |
isComplete(guide)
Returns the completion status of a guide.
Parameters:
Returns:
| Type | Description |
|---|
| boolean | True 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: