This is the documentation for the Scripting APIs of this package.
Show / Hide Table of Contents
-
Unity.
Debug Display -
Unity.
Physics - Aabb
-
All
Hits Collector<T> -
Any
Hit Collector<T> -
Blob
Array -
Blob
Array. Accessor<T> -
Blob
Array. Accessor<T>. Enumerator -
Body
Frame -
Body
Index Pair -
Box
Collider - Properties
-
Methods
-
Box
Cast -
Box
Cast All -
Box
Cast Custom -
Calculate
Aabb -
Calculate
Distance -
Capsule
Cast -
Capsule
Cast All -
Capsule
Cast Custom -
Cast
Collider -
Cast
Ray -
Check
Box -
Check
Capsule -
Check
Sphere - Create
-
Get
Collision Filter - Initialize
-
Overlap
Box -
Overlap
Box Custom -
Overlap
Capsule -
Overlap
Capsule Custom -
Overlap
Sphere -
Overlap
Sphere Custom -
Set
Collision Filter -
Sphere
Cast -
Sphere
Cast All -
Sphere
Cast Custom
-
Box
-
Box
Geometry -
Capsule
Collider - Properties
-
Methods
-
Box
Cast -
Box
Cast All -
Box
Cast Custom -
Calculate
Aabb -
Calculate
Distance -
Capsule
Cast -
Capsule
Cast All -
Capsule
Cast Custom -
Cast
Collider -
Cast
Ray -
Check
Box -
Check
Capsule -
Check
Sphere - Create
-
Get
Collision Filter - Initialize
-
Overlap
Box -
Overlap
Box Custom -
Overlap
Capsule -
Overlap
Capsule Custom -
Overlap
Sphere -
Overlap
Sphere Custom -
Set
Collision Filter -
Sphere
Cast -
Sphere
Cast All -
Sphere
Cast Custom
-
Box
-
Capsule
Geometry -
Child
Collider -
Closest
Hit Collector<T> -
Collider
- Properties
-
Methods
-
Box
Cast -
Box
Cast All -
Box
Cast Custom -
Calculate
Aabb -
Calculate
Distance -
Capsule
Cast -
Capsule
Cast All -
Capsule
Cast Custom -
Cast
Collider -
Cast
Ray -
Check
Box -
Check
Capsule -
Check
Sphere - Clone
-
Get
Child -
Get
Collision Filter -
Get
Collision Response -
Get
Friction -
Get
Leaf -
Get
Leaf Collider -
Get
Leaves -
Get
Restitution -
Overlap
Box -
Overlap
Box Custom -
Overlap
Capsule -
Overlap
Capsule Custom -
Overlap
Sphere -
Overlap
Sphere Custom -
Set
Collision Filter -
Set
Collision Response -
Set
Friction -
Set
Restitution -
Sphere
Cast -
Sphere
Cast All -
Sphere
Cast Custom
-
Box
-
Collider
Cast Hit -
Collider
Cast Input -
Collider
Distance Input -
Collider
Key -
Collider
Key Pair -
Collider
Key Path -
Collider
Type -
Collision
Event -
Collision
Event. Details -
Collision
Events -
Collision
Events. Enumerator -
Collision
Filter -
Collision
Response Policy -
Collision
Type -
Collision
World - Constructors
- Properties
-
Methods
-
Box
Cast -
Box
Cast All -
Box
Cast Custom -
Build
Broadphase -
Calculate
Aabb -
Calculate
Distance -
Capsule
Cast -
Capsule
Cast All -
Capsule
Cast Custom -
Cast
Collider -
Cast
Ray -
Check
Box -
Check
Capsule -
Check
Sphere - Clone
- Dispose
-
Find
Overlaps -
Get
Rigid Body Index -
Overlap
Aabb -
Overlap
Box -
Overlap
Box Custom -
Overlap
Capsule -
Overlap
Capsule Custom -
Overlap
Sphere -
Overlap
Sphere Custom - Reset
-
Schedule
Build Broadphase Jobs -
Schedule
Find Overlaps Jobs -
Schedule
Update Dynamic Tree -
Sphere
Cast -
Sphere
Cast All -
Sphere
Cast Custom -
Update
Body Index Map -
Update
Dynamic Tree
-
Box
-
Compound
Collider - Properties
-
Methods
-
Box
Cast -
Box
Cast All -
Box
Cast Custom -
Calculate
Aabb -
Calculate
Distance -
Capsule
Cast -
Capsule
Cast All -
Capsule
Cast Custom -
Cast
Collider -
Cast
Ray -
Check
Box -
Check
Capsule -
Check
Sphere -
Convert
Child Index To Collider Key - Create
-
Get
Child -
Get
Collider Key To Children Mapping -
Get
Collision Filter -
Get
Leaf -
Get
Leaves -
Overlap
Box -
Overlap
Box Custom -
Overlap
Capsule -
Overlap
Capsule Custom -
Overlap
Sphere -
Overlap
Sphere Custom -
Refresh
Collision Filter -
Set
Collision Filter -
Sphere
Cast -
Sphere
Cast All -
Sphere
Cast Custom
-
Box
-
Compound
Collider. Child -
Compound
Collider. Collider Blob Instance - Constraint
-
Constraint
Block3 -
Constraint
Type -
Contact
Jac Ang And Vel To Reach Cp -
Contact
Jacobian Angular -
Contact
Point -
Convex
Collider - Properties
-
Methods
-
Box
Cast -
Box
Cast All -
Box
Cast Custom -
Calculate
Aabb -
Calculate
Distance -
Capsule
Cast -
Capsule
Cast All -
Capsule
Cast Custom -
Cast
Collider -
Cast
Ray -
Check
Box -
Check
Capsule -
Check
Sphere - Create
-
Get
Collision Filter -
Overlap
Box -
Overlap
Box Custom -
Overlap
Capsule -
Overlap
Capsule Custom -
Overlap
Sphere -
Overlap
Sphere Custom -
Set
Collision Filter -
Sphere
Cast -
Sphere
Cast All -
Sphere
Cast Custom
-
Box
-
Convex
Hull Generation Parameters -
Custom
Physics Proxy Driver -
Cylinder
Collider - Properties
-
Methods
-
Box
Cast -
Box
Cast All -
Box
Cast Custom -
Calculate
Aabb -
Calculate
Distance -
Capsule
Cast -
Capsule
Cast All -
Capsule
Cast Custom -
Cast
Collider -
Cast
Ray -
Check
Box -
Check
Capsule -
Check
Sphere - Create
-
Get
Collision Filter - Initialize
-
Overlap
Box -
Overlap
Box Custom -
Overlap
Capsule -
Overlap
Capsule Custom -
Overlap
Sphere -
Overlap
Sphere Custom -
Set
Collision Filter -
Sphere
Cast -
Sphere
Cast All -
Sphere
Cast Custom
-
Box
-
Cylinder
Geometry -
Distance
Hit -
Dynamics
World -
IAspect
Queryable -
IBody
Pairs Job -
IBody
Pairs Job Base -
IBody
Pairs Job Extensions - ICollector<T>
-
ICollidable
-
Methods
-
Box
Cast -
Box
Cast All -
Box
Cast Custom -
Calculate
Aabb -
Calculate
Distance -
Capsule
Cast -
Capsule
Cast All -
Capsule
Cast Custom -
Cast
Collider -
Cast
Ray -
Check
Box -
Check
Capsule -
Check
Sphere -
Overlap
Box -
Overlap
Box Custom -
Overlap
Capsule -
Overlap
Capsule Custom -
Overlap
Sphere -
Overlap
Sphere Custom -
Sphere
Cast -
Sphere
Cast All -
Sphere
Cast Custom
-
Box
-
Methods
- ICollider
-
ICollision
Event Job Extensions -
ICollision
Events Job -
ICollision
Events Job Base -
IContacts
Job -
IContacts
Job Base -
IContacts
Job Extensions -
IImpulse
Event Job Extensions -
IImpulse
Events Job -
IImpulse
Events Job Base -
IJacobians
Job -
IJacobians
Job Base -
IJacobians
Job Extensions -
ILeaf
Collider Collector -
IOverlap
Collector -
IQuery
Result - ISimulation
-
ISimulation
Event Utilities -
ISimulation
Event<T> -
ITrigger
Event Job Extensions -
ITrigger
Events Job -
ITrigger
Events Job Base -
Impulse
Event -
Impulse
Events -
Impulse
Events. Enumerator - Integrator
-
Jacobian
Flags -
Jacobian
Type - Joint
-
Joint
Type -
Mass
Distribution -
Mass
Factors -
Mass
Properties - Material
-
Material.
Combine Policy - Math
-
Math.
Constants -
Math.
Float Range -
Math.
MTransform -
Math.
Scaled MTransform -
Mesh
Collider - Properties
-
Methods
-
Box
Cast -
Box
Cast All -
Box
Cast Custom -
Calculate
Aabb -
Calculate
Distance -
Capsule
Cast -
Capsule
Cast All -
Capsule
Cast Custom -
Cast
Collider -
Cast
Ray -
Check
Box -
Check
Capsule -
Check
Sphere - Create
-
Get
Child -
Get
Collision Filter -
Get
Leaf -
Get
Leaves -
Overlap
Box -
Overlap
Box Custom -
Overlap
Capsule -
Overlap
Capsule Custom -
Overlap
Sphere -
Overlap
Sphere Custom -
Set
Collision Filter -
Sphere
Cast -
Sphere
Cast All -
Sphere
Cast Custom
-
Box
-
Modifiable
Body Pair -
Modifiable
Contact Header -
Modifiable
Contact Jacobian -
Modifiable
Contact Point -
Modifiable
Jacobian Header -
Modifiable
Trigger Jacobian -
Motion
Data -
Motion
Velocity -
Overlap
Aabb Hit -
Overlap
Aabb Input -
Physics
Collider -
Physics
Collider Key Entity Pair -
Physics
Constrained Body Pair -
Physics
Custom Tags -
Physics
Damping -
Physics
Gravity Factor -
Physics
Joint - Properties
-
Methods
-
Create
Angular Velocity Motor -
Create
Ball And Socket -
Create
Fixed -
Create
Hinge -
Create
Limited DOF -
Create
Limited Distance -
Create
Limited Hinge -
Create
Linear Velocity Motor -
Create
Position Motor -
Create
Prismatic -
Create
Ragdoll -
Create
Rotational Motor -
Get
Constraint Count -
Get
Constraints -
Set
Constraints -
Set
Impulse Event Threshold All Constraints -
Set
Impulse Event Threshold Single Constraint
-
Create
-
Physics
Joint Companion -
Physics
Mass -
Physics
Mass Override -
Physics
Step -
Physics
Velocity -
Physics
World - Constructors
- Fields
- Properties
-
Methods
-
Box
Cast -
Box
Cast All -
Box
Cast Custom -
Calculate
Aabb -
Calculate
Distance -
Capsule
Cast -
Capsule
Cast All -
Capsule
Cast Custom -
Cast
Collider -
Cast
Ray -
Check
Box -
Check
Capsule -
Check
Sphere - Clone
- Dispose
-
Get
Joint Index -
Get
Rigid Body Index -
Overlap
Aabb -
Overlap
Box -
Overlap
Box Custom -
Overlap
Capsule -
Overlap
Capsule Custom -
Overlap
Sphere -
Overlap
Sphere Custom - Reset
-
Sphere
Cast -
Sphere
Cast All -
Sphere
Cast Custom -
Update
Index Maps
-
Box
-
Physics
World Index -
Physics
World Singleton - Fields
- Properties
-
Methods
-
Box
Cast -
Box
Cast All -
Box
Cast Custom -
Calculate
Aabb -
Calculate
Distance -
Capsule
Cast -
Capsule
Cast All -
Capsule
Cast Custom -
Cast
Collider -
Cast
Ray -
Check
Box -
Check
Capsule -
Check
Sphere -
Get
Joint Index -
Get
Rigid Body Index -
Overlap
Aabb -
Overlap
Box -
Overlap
Box Custom -
Overlap
Capsule -
Overlap
Capsule Custom -
Overlap
Sphere -
Overlap
Sphere Custom -
Sphere
Cast -
Sphere
Cast All -
Sphere
Cast Custom
-
Box
- Plane
-
Point
Distance Input -
Polygon
Collider - Properties
-
Methods
-
Box
Cast -
Box
Cast All -
Box
Cast Custom -
Calculate
Aabb -
Calculate
Distance -
Capsule
Cast -
Capsule
Cast All -
Capsule
Cast Custom -
Cast
Collider -
Cast
Ray -
Check
Box -
Check
Capsule -
Check
Sphere -
Create
Quad -
Create
Triangle -
Get
Collision Filter -
Overlap
Box -
Overlap
Box Custom -
Overlap
Capsule -
Overlap
Capsule Custom -
Overlap
Sphere -
Overlap
Sphere Custom -
Set
Collision Filter -
Sphere
Cast -
Sphere
Cast All -
Sphere
Cast Custom
-
Box
-
Query
Interaction - Ray
-
Raycast
Hit -
Raycast
Input -
Rigid
Body - Fields
-
Methods
-
Box
Cast -
Box
Cast All -
Box
Cast Custom -
Calculate
Aabb -
Calculate
Distance -
Capsule
Cast -
Capsule
Cast All -
Capsule
Cast Custom -
Cast
Collider -
Cast
Ray -
Check
Box -
Check
Capsule -
Check
Sphere -
Overlap
Box -
Overlap
Box Custom -
Overlap
Capsule -
Overlap
Capsule Custom -
Overlap
Sphere -
Overlap
Sphere Custom -
Sphere
Cast -
Sphere
Cast All -
Sphere
Cast Custom
-
Box
-
Simplex
Solver - Simulation
-
Simulation
Context -
Simulation
Job Handles -
Simulation
Singleton -
Simulation
Step Input -
Simulation
Type - Solver
-
Solver.
Stabilization Data -
Solver.
Stabilization Heuristic Settings -
Sphere
Collider - Properties
-
Methods
-
Box
Cast -
Box
Cast All -
Box
Cast Custom -
Calculate
Aabb -
Calculate
Distance -
Capsule
Cast -
Capsule
Cast All -
Capsule
Cast Custom -
Cast
Collider -
Cast
Ray -
Check
Box -
Check
Capsule -
Check
Sphere - Create
-
Get
Collision Filter - Initialize
-
Overlap
Box -
Overlap
Box Custom -
Overlap
Capsule -
Overlap
Capsule Custom -
Overlap
Sphere -
Overlap
Sphere Custom -
Set
Collision Filter -
Sphere
Cast -
Sphere
Cast All -
Sphere
Cast Custom
-
Box
-
Sphere
Geometry -
Surface
Constraint Info -
Surface
Velocity -
Terrain
Collider - Fields
- Properties
-
Methods
-
Box
Cast -
Box
Cast All -
Box
Cast Custom -
Calculate
Aabb -
Calculate
Distance -
Capsule
Cast -
Capsule
Cast All -
Capsule
Cast Custom -
Cast
Collider -
Cast
Ray -
Check
Box -
Check
Capsule -
Check
Sphere - Create
-
Get
Child -
Get
Collision Filter -
Get
Leaf -
Get
Leaves -
Overlap
Box -
Overlap
Box Custom -
Overlap
Capsule -
Overlap
Capsule Custom -
Overlap
Sphere -
Overlap
Sphere Custom -
Set
Collision Filter -
Sphere
Cast -
Sphere
Cast All -
Sphere
Cast Custom
-
Box
-
Terrain
Collider. Collision Method -
Trigger
Event -
Trigger
Events -
Trigger
Events. Enumerator
-
Unity.
Physics. Aspects -
Collider
Aspect - Fields
- Properties
-
Methods
-
Box
Cast -
Box
Cast All -
Box
Cast Custom -
Calculate
Aabb -
Calculate
Distance -
Capsule
Cast -
Capsule
Cast All -
Capsule
Cast Custom -
Cast
Collider -
Cast
Ray -
Check
Box -
Check
Capsule -
Check
Sphere -
Convert
Child Index To Collider Key -
Get
Collider Key To Children Mapping -
Get
Collision Filter -
Get
Collision Response -
Get
Friction -
Get
Number Of Children -
Get
Restitution -
Overlap
Box -
Overlap
Box Custom -
Overlap
Capsule -
Overlap
Capsule Custom -
Overlap
Sphere -
Overlap
Sphere Custom -
Set
Collision Filter -
Set
Collision Response -
Set
Friction -
Set
Restitution -
Sphere
Cast -
Sphere
Cast All -
Sphere
Cast Custom
-
Box
-
Rigid
Body Aspect - Fields
- Properties
-
Methods
-
Apply
Angular Impulse Local Space -
Apply
Angular Impulse World Space -
Apply
Explosive Impulse -
Apply
Impulse At Point Local Space -
Apply
Impulse At Point World Space -
Apply
Linear Impulse Local Space -
Apply
Linear Impulse World Space -
Get
Effective Mass Local Space -
Get
Effective Mass World Space -
Get
Linear Velocity At Point Local Space -
Get
Linear Velocity At Point World Space
-
Apply
-
Collider
-
Unity.
Physics. Authoring -
Begin
Collider Baking System -
Begin
Joint Baking System -
Body
Motion Type -
Body
Smoothing -
Build
Compound Colliders Baking System -
Clean
Physics Debug Data System_Default -
Clean
Physics Debug Data System_Editor -
Custom
Physics Body Tag Names -
Custom
Physics Body Tags -
Custom
Physics Proxy Authoring -
Custom
Physics Proxy Authoring. Target World -
Custom
Physics Proxy Baking System -
Drawing
Utility -
End
Collider Baking System -
End
Joint Baking System -
Force
Unique Collider Authoring -
Physics
Compound Data -
Physics
Debug Display Authoring -
Physics
Debug Display Data -
Physics
Debug Display Group -
Physics
Debug Display Group_Editor -
Physics
Debug Display Mode -
Physics
Debug Display System -
Physics
Debug Display System_Default -
Physics
Debug Display System_Editor -
Physics
Display Debug Group -
Physics
Root Baked -
Physics
Step Authoring -
Physics
World Index Authoring -
Rigidbody
Baking Data -
Rigidbody
Baking System -
Shape
Type
-
Begin
-
Unity.
Physics. Extensions -
Unity.
Physics. Graphics Integration -
Buffer
Interpolated Rigid Bodies Motion -
Buffer
Interpolated Rigid Bodies Motion. Update Interpolation Buffers Job -
Copy
Physics Velocity To Smoothing -
Copy
Physics Velocity To Smoothing. Copy Physics Velocity Job -
Graphical
Smoothing Utility -
Most
Recent Fixed Time -
Physics
Graphical Interpolation Buffer -
Physics
Graphical Smoothing -
Physics
Render Entity -
Record
Most Recent Fixed Time -
Smooth
Rigid Bodies Graphical Motion
-
Buffer
-
Unity.
Physics. Systems -
After
Physics System Group -
Before
Physics System Group -
Build
Physics World -
Build
Physics World Data -
Custom
Physics System Group -
Custom
Physics System Group Base -
Ensure
Unique Collider System -
Export
Physics World -
Physics
Create Body Pairs Group -
Physics
Create Contacts Group -
Physics
Create Jacobians Group -
Physics
Initialize Group -
Physics
Simulation Group -
Physics
Solve And Integrate Group -
Physics
System Group -
Physics
World Builder -
Physics
World Data -
Physics
World Data. Physics World Component Handles -
Physics
World Exporter -
Physics
World Exporter. Export Physics World Type Handles -
Sync
Custom Physics Proxy System
-
After