TweenBase

Mostrar obsoleto

*Pronto este contenido estará disponible en tu idioma seleccionado.

No creable
No explorable

Abstract base class for in-between interpolation handlers; parent class of Tween.

Resumen

Propiedades

Ver todos los heredados de Instance
Ver todos los heredados de Object

Métodos

  • Cancel():void

    Halts playback and resets the tween variables. If you then call TweenBase:Play(), the properties of the tween resume interpolating towards their destination, but take the full length of the animation to do so.

  • Pause():void

    Halts playback of the tween. Doesn't reset its progress variables, meaning that if you call TweenBase:Play(), the tween resumes playback from the moment it was paused.

  • Play():void

    Starts playback of a tween. Note that if playback has already started, calling Play() has no effect unless the tween has finished or is stopped (either by TweenBase:Cancel() or TweenBase:Pause()).

Ver todos los heredados de Instance
Ver todos los heredados de Object

Eventos

Ver todos los heredados de Instance
Ver todos los heredados de Object

Propiedades

PlaybackState

Enum.PlaybackState
Solo lectura
No replicado
Leer paralelo

Read-only property that shows the current stage for the Tween animation. See Enum.PlaybackState for descriptions of each state. Change using functions like Tween:Play().

Muestras de código

Tween PlaybackState
local TweenService = game:GetService("TweenService")



local part = Instance.new("Part")

part.Position = Vector3.new(0, 10, 0)

part.Anchored = true

part.Parent = workspace



local goal = {}

goal.Orientation = Vector3.new(0, 90, 0)



local tweenInfo = TweenInfo.new(1, Enum.EasingStyle.Quad, Enum.EasingDirection.InOut, 2, true, 0.5)



local tween = TweenService:Create(part, tweenInfo, goal)



local function onPlaybackChanged()

	print("Tween status has changed to:", tween.PlaybackState)

end



local playbackChanged = tween:GetPropertyChangedSignal("PlaybackState")

playbackChanged:Connect(onPlaybackChanged)



tween:Play()
Ver todos los heredados de Instance
Ver todos los heredados de Object

Métodos

Cancel

void

Halts playback of a Tween and resets the tween variables.

Only resets the tween variables, not the properties being changed by the tween. If you cancel a tween halfway through its animation, the properties do not reset to their original values. Differs from TweenBase:Pause() in that once resumed, it takes the full duration of the tween to complete the animation.


Devuelve

void

Muestras de código

Tween Cancel
local TweenService = game:GetService("TweenService")



local part = Instance.new("Part")

part.Position = Vector3.new(0, 10, 0)

part.Anchored = true

part.Parent = workspace



local goal = {}

goal.Position = Vector3.new(0, 50, 0)



local tweenInfo = TweenInfo.new(5)



local tween = TweenService:Create(part, tweenInfo, goal)



tween:Play()

task.wait(2.5)

tween:Cancel()



local playTick = tick()

tween:Play()



tween.Completed:Wait()



local timeTaken = tick() - playTick

print("Tween took " .. tostring(timeTaken) .. " secs to complete")



-- The tween will take 5 seconds to complete as the tween variables have been reset by tween:Cancel()

Pause

void

Halts playback of the tween. Doesn't reset its progress variables, meaning that if you call TweenBase:Play(), the tween resumes playback from the moment it was paused.

If you want to reset the progress variables of the tween, use TweenBase:Cancel().

You can only pause tweens that are in the PlaybackState of Enum. PlaybackState.Playing; tweens in other states won't pause. If a tween is in a different PlaybackState such as Enum. PlaybackState.Delayed (as a result of its TweenInfo.DelayTime being greater than 0), attempting to pause the tween will fail and the tween will play following its specified delay time.


Devuelve

void

Muestras de código

Pausing a Tween
local TweenService = game:GetService("TweenService")



local part = Instance.new("Part")

part.Position = Vector3.new(0, 10, 0)

part.Anchored = true

part.BrickColor = BrickColor.new("Bright green")

part.Parent = workspace



local goal = {}

goal.Position = Vector3.new(50, 10, 0)



local tweenInfo = TweenInfo.new(10, Enum.EasingStyle.Linear)



local tween = TweenService:Create(part, tweenInfo, goal)



tween:Play()



task.wait(3)

part.BrickColor = BrickColor.new("Bright red")

tween:Pause()



task.wait(2)

part.BrickColor = BrickColor.new("Bright green")

tween:Play()

Play

void

Starts playback of a tween. Note that if playback has already started, calling Play() has no effect unless the tween has finished or is stopped (either by TweenBase:Cancel() or TweenBase:Pause()).

Multiple tweens can be played on the same object at the same time, but they must not animate the same property. If two tweens attempt to modify the same property, the initial tween is cancelled and overwritten by the most recent tween (see examples).


Devuelve

void

Muestras de código

Tween Creation
local TweenService = game:GetService("TweenService")



local part = Instance.new("Part")

part.Position = Vector3.new(0, 10, 0)

part.Color = Color3.new(1, 0, 0)

part.Anchored = true

part.Parent = game.Workspace



local goal = {}

goal.Position = Vector3.new(10, 10, 0)

goal.Color = Color3.new(0, 1, 0)



local tweenInfo = TweenInfo.new(5)



local tween = TweenService:Create(part, tweenInfo, goal)



tween:Play()
Tween Conflict
local TweenService = game:GetService("TweenService")



local part = Instance.new("Part")

part.Position = Vector3.new(0, 10, 0)

part.Anchored = true

part.Parent = game.Workspace



local tweenInfo = TweenInfo.new(5)



-- create two conflicting tweens (both trying to animate part.Position)

local tween1 = TweenService:Create(part, tweenInfo, { Position = Vector3.new(0, 10, 20) })

local tween2 = TweenService:Create(part, tweenInfo, { Position = Vector3.new(0, 30, 0) })



-- listen for their completion status

tween1.Completed:Connect(function(playbackState)

	print("tween1: " .. tostring(playbackState))

end)

tween2.Completed:Connect(function(playbackState)

	print("tween2: " .. tostring(playbackState))

end)



-- try to play them both

tween1:Play()

tween2:Play()
Ver todos los heredados de Instance
Ver todos los heredados de Object

Eventos

Completed

Fires when the tween finishes playing or when stopped with TweenBase:Cancel().

Passes the Enum.PlaybackState of the tween to any connected functions to give an indication of why the tween ended. Note that calling TweenBase:Pause() does not fire the Completed event.

Parámetros

playbackState: Enum.PlaybackState

The Enum.PlaybackState of the tween upon completion.


Muestras de código

Tween Completed
local Players = game:GetService("Players")

local TweenService = game:GetService("TweenService")



local SLOW_DURATION = 10



local function slowCharacter(humanoid)

	local goal = {}

	goal.WalkSpeed = 0



	local tweenInfo = TweenInfo.new(SLOW_DURATION)



	local tweenSpeed = TweenService:Create(humanoid, tweenInfo, goal)



	tweenSpeed:Play()



	return tweenSpeed

end



local function onCharacterAdded(character)

	local humanoid = character:WaitForChild("Humanoid")

	local initialSpeed = humanoid.WalkSpeed

	local tweenSpeed = slowCharacter(humanoid)

	tweenSpeed.Completed:Wait()

	humanoid.WalkSpeed = initialSpeed

end



local function onPlayerAdded(player)

	player.CharacterAdded:Connect(onCharacterAdded)

end



Players.PlayerAdded:Connect(onPlayerAdded)
Tween Conflict
local TweenService = game:GetService("TweenService")



local part = Instance.new("Part")

part.Position = Vector3.new(0, 10, 0)

part.Anchored = true

part.Parent = game.Workspace



local tweenInfo = TweenInfo.new(5)



-- create two conflicting tweens (both trying to animate part.Position)

local tween1 = TweenService:Create(part, tweenInfo, { Position = Vector3.new(0, 10, 20) })

local tween2 = TweenService:Create(part, tweenInfo, { Position = Vector3.new(0, 30, 0) })



-- listen for their completion status

tween1.Completed:Connect(function(playbackState)

	print("tween1: " .. tostring(playbackState))

end)

tween2.Completed:Connect(function(playbackState)

	print("tween2: " .. tostring(playbackState))

end)



-- try to play them both

tween1:Play()

tween2:Play()
Verifying a Tween has Completed
local TweenService = game:GetService("TweenService")



local part = Instance.new("Part")

part.Position = Vector3.new(0, 50, 0)

part.Anchored = true

part.Parent = workspace



local goal = {}

goal.Position = Vector3.new(0, 0, 0)



local tweenInfo = TweenInfo.new(3)



local tween = TweenService:Create(part, tweenInfo, goal)



local function onTweenCompleted(playbackState)

	if playbackState == Enum.PlaybackState.Completed then

		local explosion = Instance.new("Explosion")

		explosion.Position = part.Position

		explosion.Parent = workspace

		part:Destroy()

		task.delay(2, function()

			if explosion then

				explosion:Destroy()

			end

		end)

	end

end



tween.Completed:Connect(onTweenCompleted)



tween:Play()
Ver todos los heredados de Instance
Ver todos los heredados de Object