
<div class="tsd-page-title">
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
<li><a href="" aria-current="page">getPhysicsBodyGravityFactor</a></li></ul>
<h1>Function getPhysicsBodyGravityFactor</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures">
<li class="">
<div class="tsd-signature tsd-anchor-link" id="getphysicsbodygravityfactor"><span class="tsd-kind-call-signature">getPhysicsBodyGravityFactor</span><span class="tsd-signature-symbol">(</span><br>    <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><br>    <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/PhysicsBody.html" class="tsd-signature-type tsd-kind-interface">PhysicsBody</a><span class="tsd-signature-symbol">,</span><br>    <span class="tsd-kind-parameter">instanceIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getphysicsbodygravityfactor" 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>Read gravity factor from a live body; instance 0 by default. Out-of-range indices are undefined behavior. Region-independent.</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></li>
<li><span><span class="tsd-kind-parameter">body</span>: <a href="../interfaces/PhysicsBody.html" class="tsd-signature-type tsd-kind-interface">PhysicsBody</a></span></li>
<li><span><span class="tsd-kind-parameter">instanceIndex</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></span></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/BabylonJS/Babylon-Lite/blob/bc317f91a55b2af616abf487812ac6d4888151f7/packages/babylon-lite/src/physics/havok.ts#L451">packages/babylon-lite/src/physics/havok.ts:451</a></li></ul></aside></div></li></ul></section>

Welcome

Getting Started

Feature Comparison

Porting Guide

Playground

Headless Null Engine

Area Lights

Right Handed System

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

Accessibility

Render Shader

Screen Space Ambient Occlusion

Texture Region

Texture Render Target

Engine Gpu Events

Device Input

Custom Post Process

Demo Antigravity Racer

Demo Ocean

Demo Playroom

Gaussian Point Splatting Compat Helpers

Gaussian Point Splatting

Inverse Lerp

Loader Usd

Look Direction Matrices

Mesh Indexed Indirect

Mesh Lod

Mesh Opacity

Navigation Navcat API

Navigation Navcat Data

Navigation Navcat Demo

Navigation Navcat Generation

Navigation Navcat

Node Block Selection

Sprite Instance Params

Architecture

Bundle Size Results

Function getPhysicsBodyGravityFactor

Parameters

Returns number