Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


GetWorlds(Allocator)

Get all the active PhysicsWorld. This includes the _defaultWorld so will always contain at least a single world.
Read time 1 minuteLast updated 12 days ago

Definition

  • Type: Method
  • Namespace: Unity.U2D.Physics
  • Assembly: UnityEngine.PhysicsCore2DModule
public static NativeArray<PhysicsWorld> GetWorlds(Allocator allocator = Allocator.Temp)

Parameters

allocator

The memory allocator to use for the results. This can only be Allocator.Temp, Allocator.TempJob or Allocator.Persistent.

Returns

Type

Description

NativeArray<PhysicsWorld>The active world results. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty.