| Parameter | Description |
|---|---|
| snapshot | A snapshot produced by PhysicsWorld.CreateSnapshot on a compatible world. |
bool Whether the world was restored. Returns false if the snapshot or world is invalid, or the image is rejected, in which case the world is unchanged.
Restore this world to the state captured in snapshot, in place.
The world keeps the same handles, so any PhysicsBody, PhysicsShape and PhysicsJoint you already hold remain valid.
Applying a snapshot taken from a different world means existing handles for this world may alias objects restored from the snapshot or report invalid.
The snapshot image is fully validated before the world is touched, so a rejected snapshot leaves the world unchanged.
Validating and applying a snapshot processes the whole image, so this is not intended to be called at high frequency.