Goal Component - Revision history

DeamonHunter: Update Page.

2017-12-14T10:06:42Z

Update Page.

DeamonHunter: Updated to new section

2017-12-05T10:05:22Z

Updated to new section

DeamonHunter: /* Config Options */ Fix property names.

2017-07-23T05:52:11Z

‎Config Options: Fix property names.

DeamonHunter: /* "flightSeconds" */ Fix wrong string.

2017-07-23T05:48:55Z

‎"flightSeconds": Fix wrong string.

DeamonHunter: Fix redlinks

2017-07-21T07:19:00Z

Fix redlinks

DeamonHunter: Initial commit.

2017-07-21T07:18:10Z

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 Goal component, signified by the following;
<pre>
"goal": {
=Content=
}
</pre>
Goal components are used to add customisation to the functionality of the Goal Tile. This component includes some aesthetic and functional changes.

= When and How to use =
Goal component is needed whenever you want to make an Goal. Specifically, an Goal 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.Goal". Once that is done, you can add the following below the last property of the file;
<pre>
"goals": {
"goalFireworkItem": {
"kind": "staxel.item.CraftItem",
"code": "staxel.item.generic.GoalFirework"
},
"fireworkItemQuantity": 3,
"fireworkLaunchVelocity": {"x": 0.0, "y": 17.5, "z": 0.0},
"fireworkLaunchVelocitySpread": {"x": 5.0, "y": 0.0, "z": 5.0},
"fireworkFlightSeconds": 0.7,
"fireworkFlightSecondsSpread": 0.0
"scoreWithItemCategories": [
"ball"
],
"hitBoxScale": 0.5
},
},
</pre>

This component will look somewhat similar to [[Fireworks Launcher Component]] but it is greatly simplified.

The "goalFireworkItem" is the item is should spawn when a goal is scored. Look at [[Items#Universal Spawning Rules]] for more information. "fireworkItemQuantity" is how many fireworks it should launch. "fireworkLaunchVelocity" is how much base speed the firework should launch at. "fireworkLaunchVelocitySpread" is the additional random speed that the firework can have. "fireworkFlightSeconds" is how long these fireworks can fly for. "fireworkFlightSecondsSpread" is the amount of additional time that these fireworks can launch for. "scoreWithItemCategories", is the item categories it will look for in order to declare a goal. "hitBoxScale" is how much the hitbox of the goal will be scaled by.

With that, this component is complete.

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

=== "flightSeconds" ===
'''Valid options (Float): <code>A positive decimal number</code>'''

'''Default Value:''' If not specified, will last 0.7 seconds.

This is the amount of seconds that the item will fly upwards. Will only work if the item has a [[Fireworks Component]].

=== "flightSecondsSpread" ===
'''Valid options (Float): <code>A positive decimal number</code>'''

'''Default Value:''' If not specified, will not have any variance.

This is the maximum amount of seconds that can be randomly added to "flightSeconds". Will only work if the item has a [[Fireworks Component]]

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

'''Default Value:''' If not specified, will spawn 1 firework.

This is the number of fireworks that will spawn.

=== "fireworkLaunchVelocity" ===
'''Valid options (Vector 3 - Double): <code>{"x": 0.0, "y": 0.0, "z": 0.0}</code>'''

'''Default Value:''' If not specified, will be {"x": 0.0, "y": 17.5, "z": 0.0}.

This is the amount of speed the item will be given when spawned.

=== "fireworkLaunchVelocitySpread" ===
'''Valid options (Vector 3 - 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).

This is the additional amount of random speed that will be added to the launch velocity.

=== "goalFireworkItem" ===
'''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.

=== "hitBoxScale" ===
'''Valid options (Float): <code>A positive decimal number</code>'''

'''Default Value:''' If not specified, will be scaled by 0.5.

This is how much the hitbox of the goal will be scaled by.

=== "scoreWithItemCategories" ===
'''Valid options (List of Strings): <code>A list of strings that are categories on items.</code>'''

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

This is the list of categories it will look for in order to declare a goal.

@@ Line 57: / Line 57: @@
 This is the amount of seconds that the item will fly upwards. Will only work if the item has a [[Firework Component]].
-=== "flightSecondsSpread" ===
 '''Valid options (Float): <code>A positive decimal number</code>'''
@@ Line 63: / Line 64: @@
-This is the maximum amount of seconds that can be randomly added to "flightSeconds". Will only work if the item has a [[Firework Component]]
+This is the maximum amount of seconds that can be randomly added to "fireworkFlightSeconds". Will only work if the item has a [[Firework Component]]

@@ Line 49: / Line 49: @@
-=== "flightSeconds" ===
+=== "fireworkFlightSeconds" ===
 '''Valid options (Float): <code>A positive decimal number</code>'''
@@ Line 56: / Line 56: @@
 This is the amount of seconds that the item will fly upwards. Will only work if the item has a [[Firework Component]].
 === "flightSecondsSpread" ===

← Older revision		Revision as of 07:19, 21 July 2017
Line 55:		Line 55:


−	This is the amount of seconds that the item will fly upwards. Will only work if the item has a [[~~Fireworks~~ Component]].	+	This is the amount of seconds that the item will fly upwards. Will only work if the item has a [[Firework Component]].


Line 64:		Line 64:


−	This is the maximum amount of seconds that can be randomly added to "flightSeconds". Will only work if the item has a [[~~Fireworks~~ Component]]	+	This is the maximum amount of seconds that can be randomly added to "flightSeconds". Will only work if the item has a [[Firework Component]]

@@ Line 50: / Line 50: @@
 === "fireworkFlightSeconds" ===
-'''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 last 0.7 seconds.
@@ Line 59: / Line 59: @@
 === "fireworkFlightSecondsSpread" ===
-'''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 68: / Line 68: @@
 === "fireworkItemQuantity" ===
-'''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 fire 1 item.
@@ Line 77: / Line 77: @@
 === "fireworkLaunchVelocity" ===
-'''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 firework.
@@ Line 86: / Line 86: @@
 === "fireworkLaunchVelocity" ===
-'''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 be {"x": 0.0, "y": 17.5, "z": 0.0}.
@@ Line 95: / Line 95: @@
 === "fireworkLaunchVelocitySpread" ===
-'''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 112: / Line 112: @@
 === "hitBoxScale" ===
-'''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 be scaled by 0.5.
@@ Line 120: / Line 120: @@
 === "scoreWithItemCategories" ===
-'''Valid options (List of Strings): <code>A list of strings that are categories on items.</code>'''
+'''Valid options ([[Modding_Key_Terms#List|List]] of [[Modding_Key_Terms#String|Strings]]): <code>A list of strings that are categories on items.</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
 This is the list of categories it will look for in order to declare a goal.

@@ Line 35: / Line 35: @@
 This component will look somewhat similar to [[Fireworks Launcher Component]] but it is greatly simplified.
-The "goalFireworkItem" is the item is should spawn when a goal is scored. Look at [[Items#Universal Spawning Rules]] for more information. "fireworkItemQuantity" is how many fireworks it should launch. "fireworkLaunchVelocity" is how much base speed the firework should launch at. "fireworkLaunchVelocitySpread" is the additional random speed that the firework can have. "fireworkFlightSeconds" is how long these fireworks can fly for. "fireworkFlightSecondsSpread" is the amount of additional time that these fireworks can launch for. "scoreWithItemCategories", is the item categories it will look for in order to declare a goal. "hitBoxScale" is how much the hitbox of the goal will be scaled by.
+The "goalFireworkItem" is the item is should spawn when a goal is scored. Look at [[Items#How to Spawn an Item]] for more information. "fireworkItemQuantity" is how many fireworks it should launch. "fireworkLaunchVelocity" is how much base speed the firework should launch at. "fireworkLaunchVelocitySpread" is the additional random speed that the firework can have. "fireworkFlightSeconds" is how long these fireworks can fly for. "fireworkFlightSecondsSpread" is the amount of additional time that these fireworks can launch for. "scoreWithItemCategories", is the item categories it will look for in order to declare a goal. "hitBoxScale" is how much the hitbox of the goal will be scaled by.
 With that, this component is complete.
@@ Line 104: / Line 104: @@
 === "goalFireworkItem" ===
-'''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.