Skip to main content

EventSequence

A sequence of value changes and custom callbacks that can be played/stopped/etc at any time.

TypeSinceScoped
Declaration0.3.4No

Constructor​

EventSequence({
	{
		Time : number,
		ValueSource : ValueInstance,
		NewValue : any,
		Callback : () -> nil,
	},

	-- ...
})

Methods​

Play()​

Plays the event sequence in order of times provided.

Stop()​

Stops the playing event sequence.

Pause()​

Pauses the playing event sequence.

Resume()​

Resumes the paused event sequence.

Looped​

Setting .Looped to true will make sequences repeat after completion.

Usage​

EventSequence allows you to group timed callbacks with each other, and that group has methods to play and stop the sequence. This is particularly most helpful in applications such as complex animation, since it allows you to change values at time intervals.

Here is an example usage of this:

local EventSeqeuence = Seam.EventSequence({
	{1, function()
		print("a")
	end},
	
	{2, function()
		print("b")
	end},
	
	{3, function()
		print("c")
	end},
})

EventSeqeuence:Play()

In an event sequence, you pass in an array of sequence keypoints. Each keypoint contains the following, in order:

  • A time, in seconds, when the keypoint will play
  • A callback function for the keypoint