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

19.5.13 setFriction

self = physics.Shape:setFriction(f)

Parameter

Type

Description

self

in physics.Shape

The input Shape

f

in number

Coefficient of friction for the surface of the Shape

self

out physics.Shape

The input Shape is returned as the output

Sets the friction coefficient for the shape. Returns self.

Note

May not behave as expected for f larger than 1.0 or less than 0.

Introduced in platform.apiLevel = '2.0'