BuilderGuide
A userdata object representing a builder guide.
Values:
Operations:
| Operation | Returns | Description |
|---|---|---|
BuilderGuide == BuilderGuide |
boolean | Checks if two instances of BuilderGuide refer to the same BuilderGuide. |
Functions
destroy
builderGuide:destroy( )
Destroys a guide.
Parameters:
| Name | Type | Description |
|---|---|---|
guide |
BuilderGuide | The guide to be destroyed. |
getCurrentStageIndex
builderGuide:getCurrentStageIndex( )
Returns the stage index of a guide.
Parameters:
| Name | Type | Description |
|---|---|---|
guide |
BuilderGuide | The guide. |
Returns:
| Type | Description |
|---|---|
| integer | The stage index. |
getErrorInfo
builderGuide:getErrorInfo( )
Returns error information of the builder guide.
Parameters:
| Name | Type | Description |
|---|---|---|
guide |
BuilderGuide | The guide. |
Returns:
| Type | Description |
|---|---|
| table | Table of errors { blocks = number, joints = number, parts = number, connections = number, connectionsReversed = number }, |
getId
builderGuide:getId( )
Returns the id of a guide.
Parameters:
| Name | Type | Description |
|---|---|---|
guide |
BuilderGuide | The guide. |
Returns:
| Type | Description |
|---|---|
| integer | The guide's id. |
getStageInfo
builderGuide:getStageInfo( )
Returns information about the current stage.
Parameters:
| Name | Type | Description |
|---|---|---|
guide |
BuilderGuide | The guide. |
Returns:
| Type | Description |
|---|---|
| table | Table of stage info { blocksLeft = number, jointsLeft = number, partsLeft = number, connectionsLeft = number }, |
isComplete
builderGuide:isComplete( )
Returns the completion status of a guide.
Parameters:
| Name | Type | Description |
|---|---|---|
guide |
BuilderGuide | The guide. |
Returns:
| Type | Description |
|---|---|
| boolean | True if the guide is completed. |
update
builderGuide:update( )
Update the state of a guide. Should be called whenever the root Shape of the builder guide has changed.
Parameters:
| Name | Type | Description |
|---|---|---|
guide |
BuilderGuide | The guide |