TweenBase

Afficher les obsolètes

*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

Création impossible
Non navigable

Classé abstrait pour les interrupteurs d'interpolation entre interpolation ; parent classe de Tween .

Résumé

Propriétés

Afficher tous les hérités de Instance
Afficher tous les hérités de Object

Méthodes

  • Cancel():void

    Arrête la lecture et réinitialise les variables de tween. Si vous appelez ensuite TweenBase:Play(), les propriétés de la tween interpolent vers leur destination, mais prenez la longueur complète de l'animation pour le faire.

  • Pause():void

    Arrête la lecture du tween. Ne réinitialise pas ses variables de progression, ce qui signifie que si vous appelez TweenBase:Play(), le tween reprend la lecture à partir du moment qu'il a été interrompue.

  • Play():void

    Démarre la lecture d'une tween. Notez que si la lecture a déjà commencé, en appelant Play() n'a aucun effet à moins que la tween n'ait fini ou soit arrêté (par TweenBase:Cancel() ou TweenBase:Pause()).

Afficher tous les hérités de Instance
Afficher tous les hérités de Object

Évènements

Afficher tous les hérités de Instance
Afficher tous les hérités de Object

Propriétés

PlaybackState

Enum.PlaybackState
Lecture uniquement
Non répliqué
Lecture parallèle

Propriété de lecture qui montre l'étape actuelle pour l'animationsTween. Voir Enum.PlaybackState pour les descriptions de chaque étape. Modifiez-les en utilisant des fonctions comme Tween:Play().

Échantillons de code

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()
Afficher tous les hérités de Instance
Afficher tous les hérités de Object

Méthodes

Cancel

void

Arrête la lecture d'un Tween et réinitialise les variables de tween.

Ne réinitialise que les variables de tween, pas les propriétés modifiées par le tween. Si vous annulez un tween en cours d'animations, les propriétés ne sont pas réinitialisées à leurs valeurs d'origine. Diffère de TweenBase:Pause() dans la mesure où il reprend, il prend la durée complète du tween pour terminer l'animations.


Retours

void

Échantillons de code

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

Arrête la lecture du tween. Ne réinitialise pas ses variables de progression, ce qui signifie que si vous appelez TweenBase:Play(), le tween reprend la lecture à partir du moment qu'il a été interrompue.

Si vous souhaitez réinitialiser les variables de progression de la tween, utilisez TweenBase:Cancel() .

Vous ne pouvez suspendre que les jeunes qui sont dans le PlaybackState de Enum. PlaybackState.Playing ; les jeunes dans d'autres États ne


Retours

void

Échantillons de code

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

Démarre la lecture d'une tween. Notez que si la lecture a déjà commencé, en appelant Play() n'a aucun effet à moins que la tween n'ait fini ou soit arrêté (par TweenBase:Cancel() ou TweenBase:Pause()).

Plusieurs jeunes peuvent être joués sur le même objet en même temps, mais ils ne doivent pas animer la même propriété. Si deux jeunes tentent de modifier la même propriété, le tween initial est annulé et écrasé par le tween le plus récent (voir exemples).


Retours

void

Échantillons de code

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()
Afficher tous les hérités de Instance
Afficher tous les hérités de Object

Évènements

Completed

Se déclenche lorsque la fin de la balise tween est terminée ou lorsque vous l'arrêtez avec TweenBase:Cancel().

Passe le Enum.PlaybackState du tween à n'importe quelle fonction connectée pour indiquer pourquoi le tween s'est terminé. Remarquez que l'appel de Class.TweenBase:Pause() ne déclenche pas l'événement Completed.

Paramètres

playbackState: Enum.PlaybackState

Le Enum.PlaybackState de la tween à la fin de la campagne.


Échantillons de code

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()
Afficher tous les hérités de Instance
Afficher tous les hérités de Object