Fireworks Launcher Component - Revision history

DeamonHunter: Updated to new section

2017-12-05T10:04:58Z

Updated to new section

DeamonHunter: Update formatting.

2017-11-21T05:19:28Z

Update formatting.

DeamonHunter: /* "item" */ Grammar

2017-08-06T07:12:18Z

‎"item": Grammar

DeamonHunter: Spacing

2017-08-01T08:45:14Z

Spacing

DeamonHunter: Added quantity. Some fixes to formatting.

2017-07-25T04:36:52Z

Added quantity. Some fixes to formatting.

DeamonHunter: /* When and How to use */ Fix redlink

2017-07-23T05:18:07Z

‎When and How to use: Fix redlink

DeamonHunter: /* "flightSecondsSpread" */ fix redlink

2017-07-21T07:20:41Z

‎"flightSecondsSpread": fix redlink

DeamonHunter: /* "launchEffect" */ fix redlink

2017-07-21T07:20:24Z

‎"launchEffect": fix redlink

DeamonHunter: /* "flightSeconds" */ fix redlink

2017-07-21T07:20:08Z

‎"flightSeconds": fix redlink

DeamonHunter: /* "fuseEffect" */ fix redlink

2017-07-21T07:19:55Z

‎"fuseEffect": fix redlink

@@ Line 43: / Line 43: @@
 The first part is customisation of the tile itself. "fuseOffset" is the offset that the fuse effect will appear at. "fuseEffect" is the code to the [[Effect|Effects]] that plays for the fuse. "countdownOffset" is the offset that the countdown number will appear at. "interactCountdown" is whether or not the countdown will start on interacting with the tile or whether it will start when placed. (True for interact, false for placing.)
-The second part is contained within "fireworks". Fireworks is essentially a list of items that have additional properties for launching them. Inside one of the list items, "item" is a blob that is meant to choose an item to spawn. Look at [[Items#Universal Spawning Rules]] for more information. "quantity" is how many of these items you want to spawn. "countdownSeconds" is how many seconds before the item is spawned. "countdownSecondsSpread" is the additional time randomly added, not subtracted, from "countdownSeconds". "launchVelocity", is the direction you want to launch the item in. "launchVelocitySpread" is the random amount of additional speed to be added. "launchOffset" is the offset for where the item will be initially spawned. "flightSeconds" is how much time the item should be flying up into the air. "flightSecondsSpread" is the additional amount of random time added or subtracted from "flightSeconds".
+The second part is contained within "fireworks". Fireworks is essentially a list of items that have additional properties for launching them. Inside one of the list items, "item" is a blob that is meant to choose an item to spawn. Look at [[Items#How to Spawn an Item]] for more information. "quantity" is how many of these items you want to spawn. "countdownSeconds" is how many seconds before the item is spawned. "countdownSecondsSpread" is the additional time randomly added, not subtracted, from "countdownSeconds". "launchVelocity", is the direction you want to launch the item in. "launchVelocitySpread" is the random amount of additional speed to be added. "launchOffset" is the offset for where the item will be initially spawned. "flightSeconds" is how much time the item should be flying up into the air. "flightSecondsSpread" is the additional amount of random time added or subtracted from "flightSeconds".
 With that, this component is complete. You may want to also look into [[Firework Component]] for making items/tiles go into the Firework.
@@ Line 153: / Line 153: @@
 === "item" ===
-'''Valid options (Spawn Item): <code>See [[Items#Universal Spawning Rules]] for more information.</code>'''
+'''Valid options (Spawn Item): <code>See [[Items#How to Spawn an Item]] for more information.</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.

@@ Line 2: / Line 2: @@
 [[:Category:Component Modding]] are all optional properties that can be added to any file. Components are useful in extending the original files with even more information, such as the cost of the item or whether the block can be broken by a weapon.
-On this page, we go over the Fireworks Launcher component, signified by the following;
+On this page, we go over the Fireworks Launcher Component, signified by the following;
 <pre>
 "fireworksLauncher": {
@@ Line 8: / Line 8: @@
+}
 </pre>
-Fireworks Launcher components are used to add customisation to the functionality of the Launcher Tile. This component includes some aesthetic and functional changes. This component also complements the [[Firework Component]], which provides information for items to explode, but is not required.
+Fireworks Launcher Components are used to add customisation to the functionality of the Launcher Tile. This component includes some aesthetic and functional changes. This component also complements the [[Firework Component]], which provides information for items to explode, but is not required.
 = When and How to use =
-Fireworks Launcher component is needed whenever you want to make an Firework Launcher. Specifically, an Fireworks Launcher component is needed whenever a [[Tile]] has it [[Tile#"tileStateKind"]] equal to "staxel.tileState.FireworksLauncher". Otherwise Fireworks Launcher component will do nothing.
+Fireworks Launcher Component is needed whenever you want to make an Firework Launcher. Specifically, an Fireworks Launcher Component is needed whenever a [[Tile]] has it [[Tile#"tileStateKind"]] equal to "staxel.tileState.FireworksLauncher". Otherwise Fireworks Launcher component will do nothing.
 To start off with first, you will need to create a [[Tile]] with [[Tile#"tileStateKind"]] equal to "staxel.tileState.FireworksLauncher". Once that is done, you can add the following below the last property of the file;
@@ Line 57: / Line 57: @@
 == "countdownOffset" ==
-'''Valid options (Vector 3 - Double): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
+'''Valid options ([[Modding_Key_Terms#Vector 3|Vector 3]] - [[Modding_Key_Terms#Double|Double]]): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 66: / Line 66: @@
 == "fuseOffset" ==
-'''Valid options (Vector 3 - Double): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
+'''Valid options ([[Modding_Key_Terms#Vector 3|Vector 3]] - [[Modding_Key_Terms#Double|Double]]): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 75: / Line 75: @@
 == "fuseEffect" ==
-'''Valid options (String): <code>A string that is pointing to the code of an [[Effect]]</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string that is pointing to the code of an [[Effect]]</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 84: / Line 84: @@
 == "interactCountdown" ==
-'''Valid options (Bool): <code>True or False</code>'''
+'''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False.</code>'''
-'''Default Value:''' False.
+'''Default Value:''' If not specified, will default to False.
@@ Line 117: / Line 117: @@
 === "countdownSeconds" ===
-'''Valid options (Float): <code>A positive decimal number</code>'''
+'''Valid options ([[Modding_Key_Terms#Float|Float]]): <code>A positive decimal number.</code>'''
 '''Default Value:''' If not specified, will not have a countdown. (Spawn Immediately)
@@ Line 126: / Line 126: @@
 === "countdownSecondsSpread" ===
-'''Valid options (Float): <code>A positive decimal number</code>'''
+'''Valid options ([[Modding_Key_Terms#Float|Float]]): <code>A positive decimal number.</code>'''
 '''Default Value:''' If not specified, will not have any variance.
@@ Line 135: / Line 135: @@
 === "flightSeconds" ===
-'''Valid options (Float): <code>A positive decimal number</code>'''
+'''Valid options ([[Modding_Key_Terms#Float|Float]]): <code>A positive decimal number.</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 144: / Line 144: @@
 === "flightSecondsSpread" ===
-'''Valid options (Float): <code>A positive decimal number</code>'''
+'''Valid options ([[Modding_Key_Terms#Float|Float]]): <code>A positive decimal number.</code>'''
 '''Default Value:''' If not specified, will not have any variance.
@@ Line 160: / Line 160: @@
 === "launchEffect" ===
-'''Valid options (String): <code>A string that is pointing to the code of an [[Effect]]</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string that is pointing to the code of an [[Effect]].</code>'''
 '''Default Value:''' If not specified, will play no effect.
@@ Line 169: / Line 169: @@
 === "launchEffectOffset" ===
-'''Valid options (Vector 3 - Double): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
+'''Valid options ([[Modding_Key_Terms#Vector 3|Vector 3]] - [[Modding_Key_Terms#Double|Double]]): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
 '''Default Value:''' If not specified, will just have a zero vector.
@@ Line 178: / Line 178: @@
 === "launchOffset" ===
-'''Valid options (Vector 3 - Double): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
+'''Valid options ([[Modding_Key_Terms#Vector 3|Vector 3]] - [[Modding_Key_Terms#Double|Double]]): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
 '''Default Value:''' If not specified, will just have a zero vector.
@@ Line 187: / Line 187: @@
 === "launchVelocity" ===
-'''Valid options (Vector 3 - Double): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
+'''Valid options ([[Modding_Key_Terms#Vector 3|Vector 3]] - [[Modding_Key_Terms#Double|Double]]): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
 '''Default Value:''' If not specified, will just have a zero vector.
@@ Line 196: / Line 196: @@
 === "launchVelocitySpread" ===
-'''Valid options (Vector 3 - Double): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
+'''Valid options ([[Modding_Key_Terms#Vector 3|Vector 3]] - [[Modding_Key_Terms#Double|Double]]): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''
 '''Default Value:''' If not specified, will just have a zero vector (No variance).
@@ Line 205: / Line 205: @@
 === "quantity" ===
-'''Valid options (Int): <code>A positive integer number</code>'''
+'''Valid options ([[Modding_Key_Terms#Integer|Integer]]): <code>A positive integer number.</code>'''
 '''Default Value:''' If not specified, will spawn 1 item.

@@ Line 153: / Line 153: @@
 === "item" ===
-'''Valid options (Spawn Item): <code>See [[Items#Universal Spawning Rules]] for more information</code>'''
+'''Valid options (Spawn Item): <code>See [[Items#Universal Spawning Rules]] for more information.</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
 This is the item that will be spawned in. If the item has a Fireworks component, it will do extra things but it is not needed.
 === "launchEffect" ===

@@ Line 46: / Line 46: @@
 With that, this component is complete. You may want to also look into [[Firework Component]] for making items/tiles go into the Firework.
 = Config Options =
@@ Line 80: / Line 81: @@
 This is the effect that will get played as the fuse.
 == "interactCountdown" ==

@@ Line 139: / Line 139: @@
 This is the amount of seconds that the item will fly upwards. Will only work if the item has a [[Firework Component]].
 === "flightSecondsSpread" ===
@@ Line 147: / Line 148: @@
 This is the maximum amount of seconds that can be randomly added to "flightSeconds". Will only work if the item has a [[Firework Component]]
 === "item" ===
@@ Line 163: / Line 165: @@
 This is the effect that will get played as the item is launched.
 === "launchEffectOffset" ===
@@ Line 198: / Line 201: @@
 This is the additional amount of random speed that will be added to the launch velocity.