Difference between revisions of "TrainCarts/Signs/Effect"

From BergerHealer Wiki
Jump to navigation Jump to search
Line 3: Line 3:
 
== Description ==
 
== Description ==
  
This sign can play a particle or sound effect when a train enters or power is supplied.
+
This sign can be used to activate an effect configured in the train's [[TrainCarts/Attachments|attachments]] when a train enters or redstone power is supplied.
  
 
== Syntax ==
 
== Syntax ==
{{sign|[!train]/[!cart]|effect|<effect>|<effect>}}
+
{{sign|[+train]/[+cart]|effect|<name>|<name>}}
 
 
  
 
=== First line ===
 
=== First line ===
Line 15: Line 14:
 
=== Second line ===
 
=== Second line ===
  
''effect'', followed up by an optional pitch and volume. Values of 1.0 are the defaults.
+
''effect'', followed up by an optional pitch and volume. Values of 1.0 are the defaults. Specifying ''effect stop'' will abort playback of the effect if possible.
  
 
=== Third and fourth lines ===
 
=== Third and fourth lines ===
  
The effects to play. These can be:
+
One or two names of effect attachments to activate. In the Attachment Editor, go to general and name the attachment there. You can then put that name here to activate it. An example of an attachment you can use is the Sound Attachment.
 +
 
 +
== Legacy ==
 +
An old version of this sign still exists which can only play (some) Bukkit effects. For this, use ''beffect'' on the second line. ''peffect'' plays the effect at the player, and ''meffect'' every tick as a train drives over the sign.
 +
 
 +
{{sign|[+train]/[+cart]|beffect|note|}}
 +
 
 +
These effects can be played:
 
* A sound effect (See: [https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html Available Sounds])
 
* A sound effect (See: [https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html Available Sounds])
 
* A particle effect (See: [https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Effect.html Available Effects])
 
* A particle effect (See: [https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Effect.html Available Effects])
 
* ''link'', to play the fizz and smoke effects at once (link effect)
 
* ''link'', to play the fizz and smoke effects at once (link effect)

Revision as of 19:21, 8 October 2023

« Go back

Description

This sign can be used to activate an effect configured in the train's attachments when a train enters or redstone power is supplied.

Syntax

Signtemplate.png
[+train]/[+cart]
effect
<name>
<name>

First line

When [train] is used, the effect is played in all the minecarts of the train. When [cart] is used, the effect is only played at the minecart that is currently above the sign. When no minecarts are near when the sign is powered, the effect is played above the sign. (at the rails)

Second line

effect, followed up by an optional pitch and volume. Values of 1.0 are the defaults. Specifying effect stop will abort playback of the effect if possible.

Third and fourth lines

One or two names of effect attachments to activate. In the Attachment Editor, go to general and name the attachment there. You can then put that name here to activate it. An example of an attachment you can use is the Sound Attachment.

Legacy

An old version of this sign still exists which can only play (some) Bukkit effects. For this, use beffect on the second line. peffect plays the effect at the player, and meffect every tick as a train drives over the sign.

Signtemplate.png
[+train]/[+cart]
beffect
note

These effects can be played: