Package Exports

@rbxts/boat-tween

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@rbxts/boat-tween) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

BoatTween-ts

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

Installation

$ npm i --save-dev @rbxts/boat-tween

Usage

import BoatTween from "@rbxts/boat-tween"

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

let 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

BoatTween.TweenData<T extends Instance> // Options passed to BoatTween.Create
BoatTween.TweenObject<T extends Instance> // Object returned from BoatTween.Create