TweenBase

顯示已棄用項目

*此內容是使用 AI（Beta 測試版）翻譯，可能含有錯誤。若要以英文檢視此頁面，請按一下這裡。

無法建立
無法瀏覽

介於兩者之間的插入處理器的抽象基類；Tween 的父級。

概要

屬性

檢視繼承自Instance的所有項目
檢視繼承自Object的所有項目

方法

  • Cancel():()

    暫停播放並重設暫時變量。如果您然後呼叫 TweenBase:Play()，青少年的屬性將繼續向目的地交錯，但需要全長的動畫才能這麼做。

  • Pause():()

    停止青補間動畫的播放。不重置其進度變量，意味著如果您呼叫 TweenBase:Play()，青少年將從暫停播放的那一刻開始恢復播放。

  • Play():()

    開始懷舊播補間動畫。請注意，如果播放已經開始，呼叫 Play() 沒有效果，除非青少年已經完成或被停止（通過 TweenBase:Cancel() 或 TweenBase:Pause() ）。

檢視繼承自Instance的所有項目
檢視繼承自Object的所有項目

屬性

PlaybackState

Enum.PlaybackState
唯讀
未複製
平行讀取

只讀屬性，顯示 Tween 動畫的當前階段。見 Enum.PlaybackState 每個狀態的說明。使用像 Tween:Play() 這樣的函數進行更改。

範例程式碼

In this example a part is rotated by a Tween back and forth several times. The TweenInfo in this case is configured to make the tween repeat twice after the first playback and pause between each playback. A function is connected to when the tween's PlaybackState changes. When run, this function will fire whenever the tween starts, pauses between playback, and ends.

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()
檢視繼承自Instance的所有項目
檢視繼承自Object的所有項目

方法

Cancel

()

停止播放 Tween 並重設暫時變量。

只重設暫時變量，不是被暫補間動畫變更的屬性。如果您在動畫中途取消青少年，屬性不會重設為原始值。與 TweenBase:Pause() 不同之處是，一旦恢復，它需要滿足青少年完成動畫所需的全部時間。


返回

()

範例程式碼

This sample demonstrates the impact of cancelling a tween.

A part is instanced in the Workspace and a tween is set up to move it along the Y axis. Mid way through the tween, it is cancelled. It can be observed here that the part does not return to its original position, but when it is resumed it takes the full length of the tween (5 seconds) to complete.

This is the key difference TweenBase:Pause() and TweenBase:Cancel().

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

()

停止青補間動畫的播放。不重置其進度變量，意味著如果您呼叫 TweenBase:Play()，青少年將從暫停播放的那一刻開始恢復播放。

如果你想重置青少補間動畫的進度變量，使用 TweenBase:Cancel() 。

您只能暫停在 的青少年；其他狀態的青少年不會暫停。如果青少年身處不同的 PlaybackState 例如 Enum. PlaybackState.Delayed (由於其 TweenInfo.DelayTime 大於 0 的結果)，嘗試暫停青少年將失敗，青少年將在指定的延遲時間後播放。


返回

()

範例程式碼

This sample demonstrates how the playback of a tween can be paused and resumed.

A part is instanced in the Workspace and a tween is setup that will move it 50 studs along the X axis. However during playback the tween is briefly paused, then resumed. To further illustrate this the BrickColor of the part changes from red to green while it is paused.

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

()

開始懷舊播補間動畫。請注意，如果播放已經開始，呼叫 Play() 沒有效果，除非青少年已經完成或被停止（通過 TweenBase:Cancel() 或 TweenBase:Pause() ）。

多個青少年可以同時在同一個物件上播放，但不得動畫相同的屬性。如果兩個青少年嘗試修改相同的屬性，初始青少年將被取消並覆蓋最新的青少年（見例子）。


返回

()

範例程式碼

In this example a Tween is created to animate the position and color of a Part. Because the position and color are part of the same tween, they will change at the exact same rate and will reach their goal at the same time.

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()

This code sample includes a demonstration of tween conflict. A part is instanced in the Workspace, and two tweens are created that attempt to move the part in conflicting directions.

When both tweens are played, the first tween is cancelled and overwritten by the second tween. This can be seen as the part moves along the Y axis as opposed to the Z axis.

To further demonstrate this, connections have been made for both tweens to the Tween.Completed event. Upon playing the tweens, the following is printed.

tween1: Enum.PlaybackState.Cancelled tween2: Enum.PlaybackState.Completed

These prints show that the first tween was cancelled (firing the Completed event) immediately upon the second tween being played. The second tween then went on to play until completion.

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()
檢視繼承自Instance的所有項目
檢視繼承自Object的所有項目

活動

Completed

在青少年完成遊戲或使用 TweenBase:Cancel() 停止時發生火災。

將青少年的 Enum.PlaybackState 傳給任何連接的功能，以提供為什麼青少年結束的線索。請注意，呼叫 TweenBase:Pause() 不會發射 Completed 事件。

參數

playbackState: Enum.PlaybackState

完成時的青少年的 Enum.PlaybackState 。


範例程式碼

In this example the walkspeed of any player joining the game will be slowed to 0 over 10 seconds using a Tween. The Completed event is used to reset the walkspeed after the Tween has finished playing.

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)

This code sample includes a demonstration of tween conflict. A part is instanced in the Workspace, and two tweens are created that attempt to move the part in conflicting directions.

When both tweens are played, the first tween is cancelled and overwritten by the second tween. This can be seen as the part moves along the Y axis as opposed to the Z axis.

To further demonstrate this, connections have been made for both tweens to the Tween.Completed event. Upon playing the tweens, the following is printed.

tween1: Enum.PlaybackState.Cancelled tween2: Enum.PlaybackState.Completed

These prints show that the first tween was cancelled (firing the Completed event) immediately upon the second tween being played. The second tween then went on to play until completion.

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()

This code sample includes an example of how Tween.Completed can be used to determine if a Tween has been successfully completed, or cancelled.

In this case a part is instanced and tweened towards 0, 0, 0. Once the tween has completed, if the final PlaybackState is Completed then the part will explode. Were the tween to be cancelled prior to completion, the explosion would not be created.

This method can be used to link tweens to other effects, or even chain several tweens to play after each other.

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()
檢視繼承自Instance的所有項目
檢視繼承自Object的所有項目