1. @threlte/rapier
  2. useRigidBody

@threlte/rapier

useRigidBody

This hook provides access to the RAPIER.RigidBody from a parent <RigidBody> component.

Use this hook to e.g. add custom colliders to a RAPIER.RigidBody defined by a parent <RigidBody> component.

<script>
	import { useRapier, useRigidBody } from '@threlte/rapier'

	const { world } = useRapier()

	// rigidBody is undefined if there's
	// no parent `<RigidBody>` component
	const rigidBody = useRigidBody()

	const collider = world.createCollider(colliderDesc, rigidBody)

	onDestroy(() => {
		world.removeCollider(collider, true)
	})
</script>

Import

Source

Github View Source Code

Package

NPM View Package

Types

const rigidBody = useRigidBody() // RAPIER.RigidBody | undefined