@rbxts/boat-tween

BoatTween-ts

Roblox-ts typings for BoatTween, a module made by boatbomber

Installation

$ npm i @rbxts/boat-tween

Usage

import { BoatTween } from "@rbxts/boat-tween";

const part = new Instance("Part");
part.Anchored = true;
part.CanCollide = false;
part.CFrame = new CFrame(0, 5, 0);
part.Parent = game.GetService("Workspace");

const tween = BoatTween.Create(part, {
	Time: 5,
	DelayTime: 0.5,

	EasingStyle: "Smooth",
	EasingDirection: "In",

	RepeatCount: -1,
	Reverses: true,

	StepType: "Stepped",

	Goal: {
		CFrame: new CFrame(0, 10, 0),
	},
});

tween.Play();

Exported types

BoatTweenData<T extends Instance> // Options passed to BoatTween.Create
BoatTweenObject<T extends Instance> // Object returned from BoatTween.Create