Sequencers

Sequencers are objects that remotely activate a configured sequence of other client objects.

Use Cases

Sequencers are used as the replacement for Pushbox contraptions that were widely used in older kits, and have several benefits such as them being much more consistent due to not being prone to physics issues.

Using Sequencers

Objects activated by Sequencers must be placed in the Sequencer's Sequence folder. When activated by touching any part in the Activators folder, the Sequencer will begin moving in the direction it is facing. Objects in the sequence will be activated when the Sequencer passes through the center point of the object.

The center point of an object is defined by the position of its Pivot. If the object is a Model, it is recommended to set the model's PrimaryPart to its activator part to properly position the Pivot at the activator's location.

When placing these objects in the Sequence folder, please make sure to do the following (if applicable):

• Set CanCollide & CanTouch to false on all objects.
• Disable all TouchConfigurations. This is to make sure that nothing unwanted or unpredictable happens, and to help reduce lag.

If a reached object has a YieldSequence tag, the Sequencer will pause until that object's function finishes running. In the case of button platforms, it will pause until the button platform activates. If a part named EndPoint is reached in the sequence, the Sequencer will stop running early. This can be used for debugging purposes.

For performance reasons, Sequencers will not run when the game is running below 10FPS. A warning message will also be displayed if the Sequencer is looping at an obscene rate (25+ times per second)

Stopping Sequencers

A sequence can be ended prematurely by touching any part in the Stoppers folder. Stopper parts have a special StopperConfiguration object inside of them containing attributes that behave as follows:

Name	Default Value	Description
BreakLoop	true	If enabled, the loop the sequencer is in (configured using LoopAmount) will be cancelled entirely. Otherwise, the sequence will go back to the start of the loop and keep running.

Sequence Groups

A SequenceGroup template can be found in the Extra Sequencer Stuff folder in the kit. If you parent objects into this group, they will have special behavior based on the GroupConfiguration's Mode when activated in a sequence:

• Random will simply select and activate a random object from the group.
• And and Or are conditional modes that rely on Property Checkers. The Sequencer will activate all Property Checkers in the group and cancel the sequence if their conditions are not met. If using And, all conditions have to be met, and if using Or, only one condition has to be met.

Sequence Pointers

Sequence Pointers can also be found in the Extra Sequencer Stuff folder. When activated in a sequence, the Sequencer will search for any objects with Tags matching its Pointer attribute, and activate those objects. For example, if you have a client object with the tag RemoteObject and add a Sequence Pointer set to the value RemoteObject to the sequence, that object will get activated when the Sequencer passes through the pointer object.

Sequence Variables are also supported, by making the sequence pointer's Pointer attribute a sequence variable wrapped around in curly braces (example: {VARIABLE}).

Sequence Variables

Every Activator part has a SequenceVariables Configuration object. Any attributes you add to this object can be read by Property Changers.

Sequencer Support

The following objects are currently supported by Sequencers:

Object	Notes
Attachers
Balloons
Boosters
Boost Removers
Buttons
Button Deactivators
Dialog System	You must have an entire Dialog System folder in the Sequence for it to function correctly.
Dismounters
Emitters	Use with Sequence Pointers
GUI Displayers
Lighting Changers
Morphers
Music Zone Editors
Property Changers
Pushbox Spawners
Pushbox Destroyers
Seats	Use with Sequence Pointers
Swings	Use with Sequence Pointers
Teleporters	Seamless mode will not function correctly.
Trip Parts
Turrets	Use with Sequence Pointers
Vanishers	Use with Sequence Pointers
Vines	Use with Sequence Pointers
Ziplines	Use with Sequence Pointers

Music Sync

Sequencers can be synced to the tower's music. This will adjust the speed of the Sequencer to match the BPM of the currently playing song. See the documentation on music sync for more information.

Configuration

Name	Default Value	Description
Cooldown	0	The amount of time it will take for the Sequencer to be usable again after it finishes.
HideSequence	false	When true, and Visualize is false, the Sequence folder will be parented elsewhere and fully hidden from view. Note that when enabled, any Property Changers in the sequence may not work if instances are not accessed via Tags.
LoopAmount	0	The amount of times the Sequencer will run when activated. If set to 0, it will only run once. If set to any negative number, it will keep running forever.
LoopDelay	0	The amount of time the Sequencer will wait before reactivating after every loop.
RunAtStart	false	When true, the Sequencer will automatically run when the tower is entered, without it having to be activated by touch.
Speed	1	The speed the Sequencer will move at, in studs per second.
Visualize	true	When true, the Sequencer will move to show its progress, and color itself to show its current state. Useful for debugging sequences.