Difference between revisions of "TrainCarts/Attachments/Sequencer"
Jump to navigation
Jump to search
Bergerkiller (talk | contribs) |
Bergerkiller (talk | contribs) (Marked this version for translation) |
||
| (9 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<languages/> | <languages/> | ||
<translate> | <translate> | ||
| + | <!--T:1--> | ||
[[Special:MyLanguage/TrainCarts/Attachments|« Go back]] | [[Special:MyLanguage/TrainCarts/Attachments|« Go back]] | ||
| + | <!--T:2--> | ||
[[File:sequencer_attachment.png|thumb|Sequencer attachment being configured]] | [[File:sequencer_attachment.png|thumb|Sequencer attachment being configured]] | ||
| − | == Introduction == | + | == Introduction == <!--T:3--> |
| − | The sequencer attachment is like the real-life equivalent of a music sequencer. It can be used to activate effects in sequence on a loop. It supports the engine start-loop-stop logic to allow for realistic train engine sounds to be played. The sequencer itself does not configure any sounds. It activates other named effect attachments like the [[Special:MyLanguage/TrainCarts/Attachments/Sound|sound attachment]]. | + | <!--T:4--> |
| + | The sequencer attachment is like the real-life equivalent of a music sequencer. It can be used to activate effects in sequence on a loop. It supports the engine start-loop-stop logic to allow for realistic train engine sounds to be played. The sequencer itself does not configure any sounds. It activates other [[TrainCarts/Attachments/General#Name|named]] effect attachments like the [[Special:MyLanguage/TrainCarts/Attachments/Sound|sound attachment]]. | ||
| − | == Categories | + | <!--T:35--> |
| + | Like other effect attachments, the sequencer must be [[Special:MyLanguage/TrainCarts/Attachments#Effect_Activation|activated]]. It can also be set to [[#Autoplay|automatically play]]. | ||
| + | |||
| + | == Categories == <!--T:5--> | ||
There are three categories, each with their own configuration and list of effects to play: | There are three categories, each with their own configuration and list of effects to play: | ||
* '''Start''' - Plays once when the effect is first played | * '''Start''' - Plays once when the effect is first played | ||
| Line 15: | Line 21: | ||
* '''Stop''' - Plays once when the effect is stopped after playing | * '''Stop''' - Plays once when the effect is stopped after playing | ||
| − | === Duration === | + | === Duration === <!--T:6--> |
| + | <!--T:7--> | ||
For how long this category plays or loops. The category is enabled if the duration is set to more than 0 (off). | For how long this category plays or loops. The category is enabled if the duration is set to more than 0 (off). | ||
| − | === Playback Speed === | + | === Playback Speed === <!--T:8--> |
| + | <!--T:9--> | ||
Controls the rate of playback of all effects under this category. Can be tied with functions to inputs such as the train speed. | Controls the rate of playback of all effects under this category. Can be tied with functions to inputs such as the train speed. | ||
| − | === Interrupt Play === | + | === Interrupt Play === <!--T:10--> |
| + | <!--T:11--> | ||
Whether to interrupt playback when playing state changes. For example, if enabled for Start, the playback is aborted when the sequencer is stopped moving straight to the stop sequence. | Whether to interrupt playback when playing state changes. For example, if enabled for Start, the playback is aborted when the sequencer is stopped moving straight to the stop sequence. | ||
| − | == Adding Sequences == | + | == Adding Sequences == <!--T:12--> |
| + | |||
| + | <!--T:34--> | ||
| + | [[File:sequencer_piano_roll.png|thumb|MIDI Sequence [[TrainCarts/Attachments/Sequencer/PianoRoll|Piano Roll]]]] | ||
| + | <!--T:13--> | ||
The '''[+]''' button can be used to add new effects to play under a category. The menu first asks for the [[Special:MyLanguage/TrainCarts/Attachments/General#Name|effect name]] to play. It then can add one of several sequence types: | The '''[+]''' button can be used to add new effects to play under a category. The menu first asks for the [[Special:MyLanguage/TrainCarts/Attachments/General#Name|effect name]] to play. It then can add one of several sequence types: | ||
| − | * Simple - Simply plays the effect once, optionally with a delay | + | * '''Simple''' - Simply plays the effect once, optionally with a delay |
| − | * MIDI - Allows for a melody to be configured using a [[Special:MyLanguage/TrainCarts/Attachments/ | + | * '''MIDI''' - Allows for a melody to be configured using a [[Special:MyLanguage/TrainCarts/Attachments/Sequencer/PianoRoll|piano roll]] |
| + | |||
| − | == Configuration == | + | == Configuration == <!--T:14--> |
| + | <!--T:15--> | ||
After selecting a sequence, multiple options are available. From left to right: | After selecting a sequence, multiple options are available. From left to right: | ||
| − | === Preview button === | + | === Preview button === <!--T:16--> |
| + | <!--T:17--> | ||
Plays the sequence. In the case of MIDI, plays the full melody. | Plays the sequence. In the case of MIDI, plays the full melody. | ||
| − | === Configure Type === | + | === Configure Type === <!--T:18--> |
| − | Configures the [[Special:MyLanguage/TrainCarts/Attachments/ | + | <!--T:19--> |
| + | Configures the [[Special:MyLanguage/TrainCarts/Attachments/Sequencer/PianoRoll|piano roll]] for MIDI, or opens a menu to configure the delay for the simple sequence. | ||
| − | === Configure Effect === | + | === Configure Effect === <!--T:20--> |
| + | <!--T:21--> | ||
Configures the effect name activated by the sequence. | Configures the effect name activated by the sequence. | ||
| − | === Configure Sequence === | + | === Configure Sequence === <!--T:22--> |
| + | <!--T:23--> | ||
Opens a menu to configure three options: | Opens a menu to configure three options: | ||
* '''Active''' - Makes the effect conditionally play. You can use this with input functions to, for example, only play the sound when a player is in a seat, or when a certain tag is set on the train. | * '''Active''' - Makes the effect conditionally play. You can use this with input functions to, for example, only play the sound when a player is in a seat, or when a certain tag is set on the train. | ||
| Line 56: | Line 75: | ||
* '''Pitch''' - Pitch (speed) multiplier for the effect. Use this to have an effect pitch controlled by, for example, the speed of the train. | * '''Pitch''' - Pitch (speed) multiplier for the effect. Use this to have an effect pitch controlled by, for example, the speed of the train. | ||
| − | === Delete === | + | === Delete === <!--T:24--> |
| + | <!--T:25--> | ||
Deletes the sequence. Asks to confirm first. | Deletes the sequence. Asks to confirm first. | ||
| − | |||
| + | == Other Options == <!--T:26--> | ||
| + | |||
| + | <!--T:27--> | ||
At the top of the menu several other options are available | At the top of the menu several other options are available | ||
| − | === Synchronous === | + | === Synchronous === <!--T:28--> |
| + | <!--T:29--> | ||
Switch between async/sync playback. Asynchronous playback is not affected by server lag. However, this can cause it to go out of sync with for example redstone-timed effects. Asynchronous is preferred, as it allows for smooth uninterrupted sound loops. | Switch between async/sync playback. Asynchronous playback is not affected by server lag. However, this can cause it to go out of sync with for example redstone-timed effects. Asynchronous is preferred, as it allows for smooth uninterrupted sound loops. | ||
| − | === Autoplay === | + | === Autoplay === <!--T:30--> |
| + | <!--T:31--> | ||
Automatically play the sequencer based on a condition, or all the time. This allows effects to be automatically played when a certain condition is met. For example, you can make a sound play when a player steps into the cart, or when the train goes from not moving to moving. | Automatically play the sequencer based on a condition, or all the time. This allows effects to be automatically played when a certain condition is met. For example, you can make a sound play when a player steps into the cart, or when the train goes from not moving to moving. | ||
| − | === Play === | + | === Play === <!--T:32--> |
| + | <!--T:33--> | ||
Override autoplay and play the sequencer, or stop it again. Use this to test the play/stop behavior | Override autoplay and play the sequencer, or stop it again. Use this to test the play/stop behavior | ||
</translate> | </translate> | ||
Latest revision as of 23:28, 30 December 2023
Introduction
The sequencer attachment is like the real-life equivalent of a music sequencer. It can be used to activate effects in sequence on a loop. It supports the engine start-loop-stop logic to allow for realistic train engine sounds to be played. The sequencer itself does not configure any sounds. It activates other named effect attachments like the sound attachment.
Like other effect attachments, the sequencer must be activated. It can also be set to automatically play.
Categories
There are three categories, each with their own configuration and list of effects to play:
- Start - Plays once when the effect is first played
- Loop - Plays on a loop over and over after the start sequence finished playing
- Stop - Plays once when the effect is stopped after playing
Duration
For how long this category plays or loops. The category is enabled if the duration is set to more than 0 (off).
Playback Speed
Controls the rate of playback of all effects under this category. Can be tied with functions to inputs such as the train speed.
Interrupt Play
Whether to interrupt playback when playing state changes. For example, if enabled for Start, the playback is aborted when the sequencer is stopped moving straight to the stop sequence.
Adding Sequences
MIDI Sequence Piano Roll
The [+] button can be used to add new effects to play under a category. The menu first asks for the effect name to play. It then can add one of several sequence types:
- Simple - Simply plays the effect once, optionally with a delay
- MIDI - Allows for a melody to be configured using a piano roll
Configuration
After selecting a sequence, multiple options are available. From left to right:
Preview button
Plays the sequence. In the case of MIDI, plays the full melody.
Configure Type
Configures the piano roll for MIDI, or opens a menu to configure the delay for the simple sequence.
Configure Effect
Configures the effect name activated by the sequence.
Configure Sequence
Opens a menu to configure three options:
- Active - Makes the effect conditionally play. You can use this with input functions to, for example, only play the sound when a player is in a seat, or when a certain tag is set on the train.
- Volume - Volume multiplier for the effect. Use this to have an effect volume controlled by, for example, the speed of the train.
- Pitch - Pitch (speed) multiplier for the effect. Use this to have an effect pitch controlled by, for example, the speed of the train.
Delete
Deletes the sequence. Asks to confirm first.
Other Options
At the top of the menu several other options are available
Synchronous
Switch between async/sync playback. Asynchronous playback is not affected by server lag. However, this can cause it to go out of sync with for example redstone-timed effects. Asynchronous is preferred, as it allows for smooth uninterrupted sound loops.
Autoplay
Automatically play the sequencer based on a condition, or all the time. This allows effects to be automatically played when a certain condition is met. For example, you can make a sound play when a player steps into the cart, or when the train goes from not moving to moving.
Play
Override autoplay and play the sequencer, or stop it again. Use this to test the play/stop behavior