SM Docs
Docs›Game›Static Functions›sm.creation

sm.creation

A Creation represent a collection of Bodies linked together by Joints.

Server + Client

getBlueprintCost - filePath

sm.creation.getBlueprintCost( filePath, bodyId )

Returns a table with uuid's and quantity. A body can be sent in to remove from blueprint cost.

Parameters:

Name Type Description
filePath string The file path for the blueprint.
bodyId (optional) integer The id of a body.(Optional)

Returns:

Type Description
table The table of { Uuid, quantity }

getBlueprintCost - table

sm.creation.getBlueprintCost( table, bodyId )

Returns a table with uuid's and quantity. A body can be sent in to remove from blueprint cost.

Parameters:

Name Type Description
table table The lua table for the blueprint.
bodyId (optional) integer The id of a body.(Optional)

Returns:

Type Description
table The table of { Uuid, quantity }

Server-only

buildMultiShape

sm.creation.buildMultiShape(
    shape,
    worldPosition,
    worldRotation,
    localPosition,
    localRotation
)

Builds a multi shape

Parameters:

Name Type Description
shape Uuid The uuid of shape to build.
worldPosition Vec3 World position of shape.
worldRotation Quat World rotation of shape.
localPosition Vec3 Local position of shape.
localRotation Quat Local rotation of shape.

exportToString

sm.creation.exportToString( body, exportTransforms, forceDynamic )

Exports creation to blueprint formatted json string.

Parameters:

Name Type Description
body Body Any body in the creation.
exportTransforms (optional) boolean Export the current world transform of bodies. Defaults to false.
forceDynamic (optional) boolean Force export to dynamic bodies. Defaults to false.

Returns:

Type Description
string The blueprint json string.

exportToTable

sm.creation.exportToTable( body, exportTransforms, forceDynamic )

Exports creation to blueprint lua table.

Parameters:

Name Type Description
body Body Any body in the creation.
exportTransforms (optional) boolean Export the current world transform of bodies. Defaults to false.
forceDynamic (optional) boolean Force export to dynamic bodies. Defaults to false.

Returns:

Type Description
table The blueprint lua table.

importFromFile

sm.creation.importFromFile(
    world,
    pathString,
    worldPosition,
    worldRotation,
    importTransforms,
    indestructible
)

Imports blueprint json file to world.

Warning: If the blueprint was not exported with transforms the importer will treat it as if importTransforms was disabled.

Parameters:

Name Type Description
world World The world to import to.
pathString string The blueprint path.
worldPosition (optional) Vec3 World position of import. If importTransforms is enabled position is applied to the imported transform. (Defaults to vec3.zero().)
worldRotation (optional) Quat World rotation of import. If importTransforms is enabled rotation is applied to the imported transform. (Defaults to quat.identity().)
importTransforms (optional) boolean Import world transforms from bodies. (Defaults to false.)
indestructible (optional) boolean (DEPRECATED) Ignored, use setDestructable(false) on each body in creation. (Defaults to false)

Returns:

Type Description
table The table {Body, ...} of bodies created from the blueprint.

importFromString

sm.creation.importFromString(
    world,
    jsonString,
    worldPosition,
    worldRotation,
    importTransforms,
    forceInactive
)

Imports blueprint json string to world.

Warning: If the blueprint was not exported with transforms the importer will treat it as if importTransforms was disabled.

Parameters:

Name Type Description
world World The world to import to.
jsonString string The blueprint json string.
worldPosition (optional) Vec3 World position of import. If importTransforms is enabled position is applied to the imported transform. (Defaults to vec3.zero().)
worldRotation (optional) Quat World rotation of import. If importTransforms is enabled rotation is applied to the imported transform. (Defaults to quat.identity().)
importTransforms (optional) boolean Import world transforms from bodies. (Defaults to false.)
forceInactive (optional) boolean Import interactables in an inactive state. (Defaults to false.)

Returns:

Type Description
table The table {Body, ...} of bodies created from the blueprint.