self:set_freeze_enabled

Client

Sets whether the rigid body is frozen


Syntax

local status = self:set_freeze_enabled(
    state
)

Parameters

TypeNameDescription
boolstatetrue to freeze the body, false to unfreeze it

Returns

TypeNameDescription
boolstatustrue on successful execution, false otherwise

Examples

Freeze a rigid body
local entity = physics.rigid.create()

entity:set_freeze_enabled(true)

On this page