sm.construction.validateLocalPosition

Validates if a shape can be built on another shape.

Kind: Function

Environments: Game

Game

Overload 1

sm.construction.validateLocalPosition( uuid, localPosition, localNormal, shape )

Open the full Game reference

Parameters:

Name Type Description
uuid Uuid The uuid of the shape to validate.
localPosition Vec3 The position local to the body.
localNormal Vec3 The normal of the surface to validate placement.
shape Shape The shape to build on.

Returns:

Type Description
boolean True if position is valid.

Overload 2

sm.construction.validateLocalPosition( uuid, localPosition, localNormal, joint )

Open the full Game reference

Validates if a shape can be built on another joint.

Parameters:

Name Type Description
uuid Uuid The uuid of the shape to validate.
localPosition Vec3 The position local to the body.
localNormal Vec3 The normal of the surface to validate placement.
joint Joint The joint to build on.

Returns:

Type Description
boolean True if position is valid.

Overload 3

sm.construction.validateLocalPosition( uuid, localPosition, localNormal )

Open the full Game reference

Validates if a shape can be built on terrain.

Parameters:

Name Type Description
uuid Uuid The uuid of the shape to validate.
localPosition Vec3 The position local to the body.
localNormal Vec3 The normal of the surface to validate placement.

Returns:

Type Description
boolean True if position is valid.