SpritePhysicsFriction

Family: Sprite · 2 forms

What it does

SpritePhysicsFriction sets PhysicsFriction on a Sprite object. It takes iSpriteIndex (an integer) and friction (a float), and returns nothing. That is the first of 2 forms. iSpriteIndex is the id of a Sprite object, the one CreateSprite returned: it is how the call knows what to act on.

Syntax

1
SpritePhysicsFriction(iSpriteIndex integer, friction float)
2
SpritePhysicsFriction(iSpriteIndex integer, friction float, shapeID integer)

Parameters

NameTypeIn forms
iSpriteIndexintegerall
frictionfloatall
shapeIDinteger2

Every form returns

nothing

Example · generated

Form 1, the short one

image = LoadImage("assets/sprite.png", 1)sprite = CreateSprite(image)SpritePhysicsFriction(sprite, 1.0)DO  Sync()LOOP

Form 2, with every argument

image = LoadImage("assets/sprite.png", 1)sprite = CreateSprite(image)SpritePhysicsFriction(sprite, 1.0, 1)DO  Sync()LOOP

LoadImage and CreateSprite are there to give the call something to act on; SpritePhysicsFriction is the line that matters. The DO … LOOP is not decoration: a classic BASIC program ends the moment it runs out of lines, and Sync() is what draws the frame.

135 commands in Sprite