BlueprintVisualization
Associated namespace: sm.visualization
A userdata object representing a blueprint visualziation.
Functions:
Operations:
| Operation | Return type | Description |
|---|---|---|
| BlueprintVisualization == BlueprintVisualization | boolean | Checks if two instances of BlueprintVisualization refer to the same BlueprintVisualization. |
destroy(blueprintVisualization)
Client only
Destroy a BlueprintVisualization.
Parameters:
| Type | Name | Description |
|---|---|---|
| BlueprintVisualization | blueprintVisualization | The blueprint visualization to be destroyed |
setPosition(blueprintVisualization, position)
Client only
Set the world position of a BlueprintVisualization.
Parameters:
| Type | Name | Description |
|---|---|---|
| BlueprintVisualization | blueprintVisualization | A blueprint visualization |
| Vec3 | position | World position |
setRotation(blueprintVisualization, rotation)
Client only
Set the rotation of a BlueprintVisualization.
Parameters:
| Type | Name | Description |
|---|---|---|
| BlueprintVisualization | blueprintVisualization | A blueprint visualization |
| Quat | rotation | Rotation |
setScale(blueprintVisualization, scale)
Client only
Set the scale of a BlueprintVisualization.
Parameters:
| Type | Name | Description |
|---|---|---|
| BlueprintVisualization | blueprintVisualization | A blueprint visualization |
| Vec3 | scale | Scale |
setVisualizationColor(blueprintVisualization, visualizationColor)
Client only
Controls the rendering of the BlueprintVisualization.
Parameters:
| Type | Name | Description |
|---|---|---|
| BlueprintVisualization | blueprintVisualization | A blueprint visualization |
| string | visualizationColor | Visualization color name to render the blueprint in. |
updateBuilderGuide(blueprintVisualization)
Client only
Update the state of a builder guide BlueprintVisualization. Should be called whenever the root Shape of the builder guide has changed.
But should not be called every frame or tick for performance.
Parameters:
| Type | Name | Description |
|---|---|---|
| BlueprintVisualization | blueprintVisualization | A blueprint visualization created with sm.visualization.createBuilderGuide |