
<div class="tsd-page-title">
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
<li><a href="" aria-current="page">getPhysicsGravity</a></li></ul>
<h1>Function getPhysicsGravity</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures">
<li class="">
<div class="tsd-signature tsd-anchor-link" id="getphysicsgravity"><span class="tsd-kind-call-signature">getPhysicsGravity</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">world</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/PhysicsWorld.html" class="tsd-signature-type tsd-kind-interface">PhysicsWorld</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">worldPosition</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Vec3.html" class="tsd-signature-type tsd-kind-interface">Vec3</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Vec3.html" class="tsd-signature-type tsd-kind-interface">Vec3</a><a href="#getphysicsgravity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
<div class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Returns the world's current gravity vector, or a specific region's when <code>worldPosition</code> is given.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li><span><span class="tsd-kind-parameter">world</span>: <a href="../interfaces/PhysicsWorld.html" class="tsd-signature-type tsd-kind-interface">PhysicsWorld</a></span>
<div class="tsd-comment tsd-typography"><p>The physics world.</p>
</div></li>
<li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">worldPosition</span>: <a href="../interfaces/Vec3.html" class="tsd-signature-type tsd-kind-interface">Vec3</a></span>
<div class="tsd-comment tsd-typography"><p>Optional world position selecting the region to read; omit for the world-wide gravity.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Vec3.html" class="tsd-signature-type tsd-kind-interface">Vec3</a></h4><p>Gravity acceleration in m/s².</p>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/BabylonJS/Babylon-Lite/blob/a2601bc413c969c55610b70dc73bb8c892c7e8a7/packages/babylon-lite/src/physics/havok.ts#L513">packages/babylon-lite/src/physics/havok.ts:513</a></li></ul></aside></div></li></ul></section>

Welcome

Getting Started

Feature Comparison

Porting Guide

Playground

Headless Null Engine

Overview

Scene

Camera

Lights

Loaders

Background Skybox

PBR Material

Animation

Standard Material

Texture 2D

Mesh Generators

Scene Hierarchy Parenting

Thin Instances

Skeleton

Morph Targets

Vertex Animation Texture

Shadow Generator

Cascaded Shadow

Picking

Loader HDR

Loader Babylon

Core Math

Engine

Shader Composition

Shader Material

Grid Material

Material Plugin

Render Pipeline

Frame Graph

Post Process

Effect Renderer

Geometry Renderer

Sprites

Text

Geospatial Camera

Large World Rendering

High Precision Matrix

Resource Pool

Bundle Size Tooling

Animation Parity Testing

Material Stencil

Audio Engine

Node Particle

Physics

Webxr

Mesh Geometry Update

Storage Buffer

Mesh Geometry Access

Error Handling

Line System

Device Lost Recovery

Alpha To Coverage

Flow Graph

Screen Space Effects

Async Shader Pipeline Compilation

Compute

Texture Array

World Screen Projection

Gaussian Splat Streaming

Mesh Blending

Render Shader

Texture Region

Texture Render Target

Engine Gpu Events

Demo Antigravity Racer

Demo Ocean

Demo Playroom

Loader Usd

Node Block Selection

Architecture

Bundle Size Results

Function getPhysicsGravity

Parameters

Returns Vec3