Broom Items - Revision history

DeamonHunter: Oops.

2017-12-12T11:40:08Z

Oops.

DeamonHunter: Readded Config options

2017-12-12T10:27:46Z

Readded Config options

DeamonHunter: Update Page.

2017-12-12T10:25:06Z

Update Page.

DeamonHunter: Small copy paste error.

2017-07-12T08:03:01Z

Small copy paste error.

DeamonHunter: Initial commit.

2017-07-12T07:58:38Z

Initial commit.

New page

[[Category:Item Modding]]
[[Items]] are fairly broad in their types. Each [[:Category:Item Modding|type]] has it's own properties and uses.

This page is for items that will act as if they were a shovel.

Brooms are all items that have the following line;
<pre>
"kind": "staxel.item.Broom",
</pre>

Brooms, currently, do have any extra components when compared to [[Craft Items]], but requires those extra components to be set when it is spawned. This will also activate the item to work exactly like a Broom. This item reacts to items on the ground, no matter what type they are.

= Creating a Broom Item =
Brooms are created in the exact same way as [[Craft Items]]. In fact you should follow the guide, [[Craft Items#Creating a Craft Item]], just replace the "kind" property with "staxel.item.Broom".

= Spawning in a Shovel Item =
Follow the guide at [[Craft Items#Spawning in a Craft Item]]. When that guide mentions "kind", make sure to use "staxel.item.Broom" instead of "staxel.item.CraftItem" else you won't be able to spawn the item.

You can also add the following to the file in order to adjust the broom;
<pre>
"sweepRadius": 1.5,
"usageDistance": 3.0,
"pushVelocity": 7.0,
</pre>
Each property is self evident. Sweep radius affects how far items can be from the point you aim at. Usage distance affects how far you can aim. Push velocity affects how fast the items are thrown.

= Config Options =
The list of basic properties is included at [[Craft Items#Config Options]].

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

'''Default Value:''' 7.0. (Currently only available when spawning an item)

This is how fast an item will get pushed.

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

'''Default Value:''' 1.5. (Currently only available when spawning an item)

This is the radius of the sphere that the game will use to search for items. A unit of 1 is a single block.

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

'''Default Value:''' 1.5. (Currently only available when spawning an item)

This is how far away you can aim before it will no longer work. A unit of 1 is a single block.

@@ Line 9: / Line 9: @@
 </pre>
-Brooms allow you to sweep items around. They also break to [[Tile|Tiles]] that have the [[Sweepable Component]] in their specifications.
+These items must also include a [[Broom Component]] in order to work. Brooms allow you to sweep items around. They also break to [[Tile|Tiles]] that have the [[Sweepable Component]] in their specifications.
 = Creating a Broom Item =
-Replacers are created in much the same way as [[Craft Items]]. In fact you should follow the guide, [[Items#How to Make a Normal Item]], until you finish all of the steps there.
+Brooms are created in much the same way as [[Craft Items]]. In fact you should follow the guide, [[Items#How to Make a Normal Item]], until you finish all of the steps there.
 Once you have gone through that guide, there are two more steps you will need to do. The first step is to change the "kind" from "staxel.item.CraftItem" to "staxel.item.Broom".
@@ Line 27: / Line 27: @@
-When you are done, close both windows by clicking "OK". Save the asset and continue to "Build and Validate Assets" like the normal item tutorial.
+When you are done, close the window by clicking "OK". Save the asset and continue to "Build and Validate Assets" like the normal item tutorial.

← Older revision		Revision as of 10:27, 12 December 2017
Line 50:		Line 50:
	= Spawning in a Broom Item =		= Spawning in a Broom Item =
	Follow the guide at [[Items#How to Spawn an Item]]. When that guide mentions "kind", make sure to use "staxel.item.Broom" instead of "staxel.item.CraftItem" else you won't be able to spawn the item.		Follow the guide at [[Items#How to Spawn an Item]]. When that guide mentions "kind", make sure to use "staxel.item.Broom" instead of "staxel.item.CraftItem" else you won't be able to spawn the item.
		+
		+
		+	= Config Options =
		+	The list of basic properties is included at [[Items#Config Options]].
		+
		+	This item does need additional information. This additional information is contained in a [[Broom Component]] which needs to be added along with the item file.

@@ Line 9: / Line 9: @@
 </pre>
-Brooms, currently, do have any extra components when compared to [[Craft Items]], but requires those extra components to be set when it is spawned. This will also activate the item to work exactly like a Broom. This item reacts to items on the ground, no matter what type they are.
+Brooms allow you to sweep items around. They also break to [[Tile|Tiles]] that have the [[Sweepable Component]] in their specifications.
 = Creating a Broom Item =
-Brooms are created in the exact same way as [[Craft Items]]. In fact you should follow the guide, [[Craft Items#Creating a Craft Item]], just replace the "kind" property with "staxel.item.Broom".
+Replacers are created in much the same way as [[Craft Items]]. In fact you should follow the guide, [[Items#How to Make a Normal Item]], until you finish all of the steps there.
-= Spawning in a Shovel Item =
+The second step depends on what you are using to create items.
-Follow the guide at [[Craft Items#Spawning in a Craft Item]]. When that guide mentions "kind", make sure to use "staxel.item.Broom" instead of "staxel.item.CraftItem" else you won't be able to spawn the item.
-= Config Options =
+== Asset Manager ==
-The list of basic properties is included at [[Craft Items#Config Options]].
+Navigate to the item you had created before. Head to the components property and click on the <code>[...]</code>. When the new window pops up, click on "Add" and select "broom".
-'''Default Value:''' 7.0. (Currently only available when spawning an item)
+Once that is done, the Asset Manager should have selected your new component. Check out the three properties and change them to suit your needs.
-This is how fast an item will get pushed.
+When you are done, close both windows by clicking "OK". Save the asset and continue to "Build and Validate Assets" like the normal item tutorial.
-== "sweepRadius" ==
+== Text Files ==
-'''Valid options (Float): <code>A positive decimal number.</code>'''
+The second step is to add the following to the end of the item file created;
+<pre>
-'''Default Value:''' 1.5. (Currently only available when spawning an item)
+"broom": {
+  "sweepRadius": 1.5,
-This is the radius of the sphere that the game will use to search for items. A unit of 1 is a single block.
+With that out of the way, it is time to start editing these values. The outermost property "broom" is known as a [[:Category:Component Modding|Component]] that holds all the information. (Specifically the [[Broom Component]]).
-== "usageDistance" ==
+Inside of that it includes three properties. "sweepRadius" determines how large the area of effect will be. "usageDistance" determines how far away from the character that the broom can be used. "pushVelocity" determines how much force will be used to push the items. Any of these properties can be removed in order to give the default values.
-'''Valid options (Float): <code>A positive decimal number.</code>'''
-'''Default Value:''' 1.5. (Currently only available when spawning an item)
+After you finished editing the values, rerun <code>Content Builder</code> and you are good to go.
-This is how far away you can aim before it will no longer work. A unit of 1 is a single block.
+= Spawning in a Broom Item =

@@ Line 2: / Line 2: @@
 [[Items]] are fairly broad in their types. Each [[:Category:Item Modding|type]] has it's own properties and uses.
-This page is for items that will act as if they were a shovel.
+This page is for items that will act as if they were a Broom.
 Brooms are all items that have the following line;