TweenBase

Veraltete anzeigen

*Dieser Inhalt wurde mit KI (Beta) übersetzt und kann Fehler enthalten. Um diese Seite auf Englisch zu sehen, klicke hier.

Nicht erstellbar
Nicht durchsuchbar

Abstrakte Basis-Klasse für In-Between-Interpolation-Handler; Eltern-Klasse von Tween .

Zusammenfassung

Eigenschaften

Alles Geerbte von Instance anzeigen
Alles Geerbte von Object anzeigen

Methoden

  • Cancel():void

    Stoppt die Wiedergabe und setzt die Tween- Variablen zurück. Wenn Sie dann TweenBase:Play() aufrufen, werden die Eigenschaften der Tween wieder mit ihrem Zielort interpoliert, aber nehmen Sie die gesamte Länge der Animation in Anspruch, um dies zu tun.

  • Pause():void

    Hält die Wiedergabe des Tween. Setzt seine Fortschrittsvariablen nicht zurück, sodass wenn Sie TweenBase:Play() aufrufen, die Wiedergabe vom Moment an fortgesetzt wird, in dem sie angehalten wurde.

  • Play():void

    Startet die Wiedergabe eines Tween. Beachten Sie, dass, wenn die Wiedergabe bereits gestartet wurde, das Aufrufen von Play() keinen Effekt hat, es sei denn, der Tween terminiert oder wird angehalten (either by TweenBase:Cancel() oder TweenBase:Pause()).

Alles Geerbte von Instance anzeigen
Alles Geerbte von Object anzeigen

Ereignisse

Alles Geerbte von Instance anzeigen
Alles Geerbte von Object anzeigen

Eigenschaften

PlaybackState

Enum.PlaybackState
Schreibgeschützt
Nicht repliziert
Parallel lesen

Lesen-nur-Eigenschaft, die die aktuelle Stufe für die Tween Animationenanzeigt. Siehe Enum.PlaybackState für Beschreibungen jedes Zustands. Ändern Sie mit Funktionen wie Tween:Play().

Code-Beispiele

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()
Alles Geerbte von Instance anzeigen
Alles Geerbte von Object anzeigen

Methoden

Cancel

void

Stoppt die Wiedergabe eines Tween und setzt die Tween- Variablen zurück.

Setzt nur die Tween- Variablen zurück, nicht die Eigenschaften, die vom Tween geändert werden. Wenn Sie eine Tween-Animation mitten durch seine Animationenabbrechen, werden die Eigenschaften nicht auf ihre ursprünglichen Werte zurückgesetzt. Es unterscheidet sich von TweenBase:Pause(), in dem eine Animationenwieder aufgenommen wird, dass die gesamte Dauer der Tween abgeschlossen ist.


Rückgaben

void

Code-Beispiele

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

void

Hält die Wiedergabe des Tween. Setzt seine Fortschrittsvariablen nicht zurück, sodass wenn Sie TweenBase:Play() aufrufen, die Wiedergabe vom Moment an fortgesetzt wird, in dem sie angehalten wurde.

Wenn Sie die Fortschrittsvariablen des Tween zurücksetzen möchten, verwenden Sie TweenBase:Cancel() .

Du kannst nur Tweens, die in der PlaybackState von Enum. PlaybackState.Playing anderen Spielstaaten, wie PlaybackState


Rückgaben

void

Code-Beispiele

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

void

Startet die Wiedergabe eines Tween. Beachten Sie, dass, wenn die Wiedergabe bereits gestartet wurde, das Aufrufen von Play() keinen Effekt hat, es sei denn, der Tween terminiert oder wird angehalten (either by TweenBase:Cancel() oder TweenBase:Pause()).

Mehrere Teenager können auf demselben Objekt gleichzeitig gespielt werden, aber sie dürfen nicht die gleiche Eigenschaftenanimieren. Wenn zwei Teenager versuchen, die gleiche Eigenschaftenzu ändern, wird der ursprüngliche Tween abgebrochen und überschrieben durch den neuesten Tweet (siehe Beispiele).


Rückgaben

void

Code-Beispiele

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()
Alles Geerbte von Instance anzeigen
Alles Geerbte von Object anzeigen

Ereignisse

Completed

Feuert, wenn die Anpassung fertig ist, oder wenn sie mit TweenBase:Cancel() aufgehört wird.

Überträgt die Enum.PlaybackState des Tween an alle verbundenen Funktionen, um anzuzeigen, warum das Tween beendet wurde. Beachten Sie, dass das Aufrufen von TweenBase:Pause() das Completed.

Parameter

playbackState: Enum.PlaybackState

Der Enum.PlaybackState des Tween beim Abschluss.


Code-Beispiele

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()
Alles Geerbte von Instance anzeigen
Alles Geerbte von Object anzeigen