BlueprintVisualization
A userdata object representing a blueprint visualziation.
Operations:
| Operation | Returns | Description |
|---|---|---|
BlueprintVisualization == BlueprintVisualization |
boolean | Checks if two instances of BlueprintVisualization refer to the same BlueprintVisualization. |
Client-only
destroy
blueprintVisualization:destroy( )
Destroy a BlueprintVisualization.
Parameters:
| Name | Type | Description |
|---|---|---|
blueprintVisualization |
BlueprintVisualization | The blueprint visualization to be destroyed |
setPosition
blueprintVisualization:setPosition( position )
Set the world position of a BlueprintVisualization.
Parameters:
| Name | Type | Description |
|---|---|---|
blueprintVisualization |
BlueprintVisualization | A blueprint visualization |
position |
Vec3 | World position |
setRotation
blueprintVisualization:setRotation( rotation )
Set the rotation of a BlueprintVisualization.
Parameters:
| Name | Type | Description |
|---|---|---|
blueprintVisualization |
BlueprintVisualization | A blueprint visualization |
rotation |
Quat | Rotation |
setScale
blueprintVisualization:setScale( scale )
Set the scale of a BlueprintVisualization.
Parameters:
| Name | Type | Description |
|---|---|---|
blueprintVisualization |
BlueprintVisualization | A blueprint visualization |
scale |
Vec3 | Scale |
setVisualizationColor
blueprintVisualization:setVisualizationColor( visualizationColor )
Controls the rendering of the BlueprintVisualization.
Parameters:
| Name | Type | Description |
|---|---|---|
blueprintVisualization |
BlueprintVisualization | A blueprint visualization |
visualizationColor |
string | Visualization color name to render the blueprint in. |
updateBuilderGuide
blueprintVisualization:updateBuilderGuide( )
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:
| Name | Type | Description |
|---|---|---|
blueprintVisualization |
BlueprintVisualization | A blueprint visualization created with sm.visualization.createBuilderGuide |