# SetTweenSpriteYByOffset

## Description

Sets the Y parameter of the given tween ID. A Tween can modify several parameters of a sprite at the same time. Set the begin value and the end value and an interpolation method. A tween is just a template that can be applied to many sprites or chains at the same time with PlayTweenSprite or AddTweenChainSprite. This modifies the position of the sprite using its offset point, usually the center of the sprite. Available interpolation methods are TweenLinear(), TweenSmooth1(), TweenSmooth2(), TweenEaseIn1(), TweenEaseIn2(), TweenEaseOut1(), TweenEaseOut2(), TweenBounce(), TweenOvershoot() Use an interpolation method of -1 to turn off interpolation on this value

## Definition

SetTweenSpriteYByOffset( tweenID, beginY, endY, interpolation )

void agk::SetTweenSpriteYByOffset( UINT tweenID, float beginY, float endY, int interpolation )

## Parameters

- tweenID - ID of the tween to modify
- beginY - The starting Y value for the sprite, the sprite will be positioned here when playing starts
- endY - The end Y value for the sprite, the sprite will be positioned here when playing ends
- interpolation - The interpolation method whilst the sprite is moving from beginY to endY