Firework Component - Revision history

DeamonHunter: Update formatting.

2017-11-21T05:15:27Z

Update formatting.

DeamonHunter: Fix more redlinks.

2017-07-23T05:11:48Z

Fix more redlinks.

DeamonHunter: Spelling error.

2017-07-23T05:11:18Z

Spelling error.

DeamonHunter: Fix redlinks

2017-07-23T05:11:02Z

Fix redlinks

DeamonHunter: Initial commit.

2017-07-19T03:48:36Z

Initial commit.

New page

[[Category:Component Modding]]
[[: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 Firework component, signified by the following;
<pre>
"firwork": {
=Content=
}
</pre>
Firework components are used to help out tiles that have the [[Firework Launcher Component]]. It specifies the individual rockets' properties which mainly include the explosion.

= When and How to use =
Firework components should be used on any item that will act as a firework. That is, most items that will be spawned by the [[Fireworks launcher Component]].

To create this component you would use the following;
<pre>
"firework": {
"explodeEffect": "staxel.effect.generic.FireworkGreen",
"flightEffect": "staxel.effect.generic.FireworkGreen",
"explodeLingerTime": -1
}
</pre>

There are three properties. The first, "explodeEffect" is a code to the [[Effects|Effect]] that will play when the item explodes. The second, "flightEffect" is the effect it will play while flying upwards. The third and final, is how long the explosion will last in microseconds. Leave this at -1 for the default time.

And that is all for the firework component.

= Config Options =
All config options must be inside the body of;
<pre>
"pricing": {
=Config Here=
}
</pre>

== "explodeEffect" ==
'''Valid options (String): <code>A string containing the code to a [[Effects|Effect]].</code>'''

'''Default Value:''' No default value is specified. Always need to provide your own.

This is the effect that will play when it explodes.

== "explodeLingerTime" ==
'''Valid options (Int): <code>A positive integer number.</code>'''

'''Default Value:''' -1, the default explosion time.

This is how long, in microseconds, that the explosion will stay around.

== "flightEffect" ==
'''Valid options (String): <code>A string containing the code to a [[Effects|Effect]].</code>'''

'''Default Value:''' Can be omitted.

This is the effect that will play when it flies up into the air.

@@ 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 Firework component, signified by the following;
+On this page, we go over the Firework Component, signified by the following;
 <pre>
 "firework": {
@@ Line 8: / Line 8: @@
+}
 </pre>
-Firework components are used to help out tiles that have the [[Fireworks Launcher Component]]. It specifies the individual rockets' properties which mainly include the explosion.
+Firework Components are used to help out tiles that have the [[Fireworks Launcher Component]]. It specifies the individual rockets' properties which mainly include the explosion.
 = When and How to use =
-Firework components should be used on any item that will act as a firework. That is, most items that will be spawned by the [[Fireworks Launcher Component]].
+Firework Components should be used on any item that will act as a firework. That is, most items that will be spawned by the [[Fireworks Launcher Component]].
 To create this component you would use the following;
@@ Line 37: / Line 37: @@
 == "explodeEffect" ==
-'''Valid options (String): <code>A string containing the code to a [[Effect]].</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string containing the code to a [[Effect]].</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 46: / Line 46: @@
 == "explodeLingerTime" ==
-'''Valid options (Int): <code>A positive integer number.</code>'''
+'''Valid options ([[Modding_Key_Terms#Integer|Integer]]): <code>A positive integer number.</code>'''
-'''Default Value:''' -1, the default explosion time.
+'''Default Value:''' If not specified will linger the default amount of time. (1 second.)
@@ Line 55: / Line 55: @@
 == "flightEffect" ==
-'''Valid options (String): <code>A string containing the code to a [[Effect]].</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string containing the code to a [[Effect]].</code>'''
-'''Default Value:''' Can be omitted.
+'''Default Value:''' If not specified, will play no effect while flying.
 This is the effect that will play when it flies up into the air.

@@ Line 4: / Line 4: @@
 On this page, we go over the Firework component, signified by the following;
 <pre>
-"firwork": {
+"firework": {
    =Content=
+}