BlueprintVisualization

Associated namespace: sm.visualization

A userdata object representing a blueprint visualziation.

Functions:

Operations:

OperationDescription
BlueprintVisualization == BlueprintVisualizationChecks if two instances of BlueprintVisualization refer to the same BlueprintVisualization.

destroy(blueprintVisualization)

Client only

Destroy a BlueprintVisualization.

Parameters:

TypeNameDescription
BlueprintVisualizationblueprintVisualizationThe blueprint visualization to be destroyed

setPosition(blueprintVisualization, position)

Client only

Set the world position of a BlueprintVisualization.

Parameters:

TypeNameDescription
BlueprintVisualizationblueprintVisualizationA blueprint visualization
Vec3positionWorld position

setRotation(blueprintVisualization, rotation)

Client only

Set the rotation of a BlueprintVisualization.

Parameters:

TypeNameDescription
BlueprintVisualizationblueprintVisualizationA blueprint visualization
QuatrotationRotation

setScale(blueprintVisualization, scale)

Client only

Set the scale of a BlueprintVisualization.

Parameters:

TypeNameDescription
BlueprintVisualizationblueprintVisualizationA blueprint visualization
Vec3scaleScale

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:

TypeNameDescription
BlueprintVisualizationblueprintVisualizationA blueprint visualization created with sm.visualization.createBuilderGuide