You are here: Lua Scripting Resources eGuide > Lua Scripting API Reference Guide > Physics Library > impulse

19.11.8 impulse

ivec = physics.Arbiter:impulse([friction])

Parameter

Type

Description

self

in physics.Arbiter

The input Arbiter

friction

in boolean

If true, the calculated friction is included in the calculation

ivec

out physics.Vect

The vector impulse applied to resolve the collision

Returns the vector impulse that was applied during this step to resolve the collision. If friction is true (default false), then the calculated friction is taken into account.

Introduced in platform.apiLevel = '2.0'