The PhysicsWorld class represents a world in which physics objects exist. It is part of the Sandbox namespace and provides functionality for managing and simulating physics interactions. While you can create your own physics world, a default world is automatically created for the map on both client and server sides.
| Member Name | Summary |
|---|---|
| SetupPhysicsFromModel | Initializes physics from a model with specified motion type. |
| SetupPhysicsFromModel | Initializes physics from a model with a transform and specified motion type. |
| Delete | Delete this world and all objects inside. Throws an exception if the world wasn't manually created. |
| Step | Advances the physics simulation by a given time step. |
| Step | Advances the physics simulation by a given time step with substeps. |
| Step | Advances the physics simulation by a given world time, delta, and substeps. |
| DebugDraw | Updates all the SceneObjects in the DebugSceneWorld, call once per tick or frame. |
| SetCollisionRules | Sets collision rules. (Obsolete: Use CollisionRules Property) |
| GetCollisionRule | Retrieves the collision rule between two specified entities. |
| RunTrace | Performs a physics trace using the specified trace builder. |
| RunTraceAll | Performs a physics trace and returns all results using the specified trace builder. |
| Bodies | All bodies in the world. |
| CollisionRules | Set or retrieve the collision rules for this PhysicsWorld. |
| DebugSceneWorld | A SceneWorld where debug SceneObjects exist. |
| Gravity | Access the world's current gravity. |
| AirDensity | Air density of this physics world, for things like air drag. |
| Body | The body of this physics world. |
| Group | The physics group of this physics world. A physics world will contain only 1 body. |
| SleepingEnabled | If true, bodies will be able to sleep after a period of inactivity. |
| SimulationMode | Physics simulation mode. See PhysicsSimulationMode for explanation of each mode. |
| PositionIterations | Used for constraints (joints). Higher values should result in more accurate simulation. |
| VelocityIterations | Used for constraints (joints). Higher values should result in more accurate simulation. |
| SubSteps | Increases the number of physics substeps to prevent objects from passing through each other. |
| TimeScale | Physics time scale. 0.5 is half speed, 1 is full speed, etc. |
| Trace | Raytrace against this world. |