Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Create

Create a PhysicsWorld using the _defaultDefinition.
Read time 1 minuteLast updated 12 days ago

Definition

  • Type: Method
  • Namespace: Unity.U2D.Physics
  • Assembly: UnityEngine.PhysicsCore2DModule

Create()

Create a PhysicsWorld using the _defaultDefinition.
public static PhysicsWorld Create()

Returns

Type

Description

PhysicsWorldThe created world.

Create(PhysicsWorldDefinition)

Create a PhysicsWorld.
public static PhysicsWorld Create(PhysicsWorldDefinition definition)

Parameters

The world definition to use.

Returns

Type

Description

PhysicsWorldThe created world.

Create(Snapshot, PhysicsWorldDefinition)

Creates a new PhysicsWorld from
snapshot
, using
definition
for the settings a snapshot does not store.
public static PhysicsWorld Create(PhysicsWorld.Snapshot snapshot, PhysicsWorldDefinition definition)

Parameters

snapshot

A snapshot produced by PhysicsWorld.CreateSnapshot.

The world definition supplying the settings the snapshot does not store.

Returns

Type

Description

PhysicsWorldThe created world restored to the snapshot state, or an invalid world if the snapshot was rejected or no world could be created.

Remarks

A snapshot restores the full simulation configuration, so these PhysicsWorldDefinition properties are taken from
snapshot
and their values in
definition
are ignored: _gravity, _bounceThreshold, _contactHitEventThreshold, _contactFrequency, _contactDamping, _contactSpeed, _contactRecycleDistance, _maximumLinearSpeed, _sleepingAllowed, _continuousAllowed and _capacity. All other
definition
properties are applied normally, for example _simulationWorkers and _simulationSubSteps. To use a value other than the snapshot's, set the matching property on the returned world after this call. Creating and restoring a world processes the whole image, so this is not intended to be called at high frequency.