Difference between revisions of "Clothing Items"

From wiki
Jump to: navigation, search
(Initial commit.)
 
m (Oops.)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
[[Category:Item Modding]]
 
[[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 can be worn, Clothing Items.
+
[[Items]] are fairly broad in their types. Each [[:Category:Item Modding|type]] has it's own properties and uses.  
  
Clothing items are all items that have the following line;
+
This page is for items that can be worn, Clothing Items.
 +
 
 +
Clothing Items are all items that have the following line;
 
<pre>
 
<pre>
 
"kind": "staxel.item.Clothing",
 
"kind": "staxel.item.Clothing",
 
</pre>
 
</pre>
  
Clothing items contain only two pieces of information, the accessory to wear and the palette to colour that accessory. Otherwise they act like a normal item.
+
Clothing items allow the player to wear new clothes. These items contain the information to swap out models of clothing from the base model.
  
  
 
= Creating a Clothing Item =
 
= Creating a Clothing Item =
Unlike [[Craft Items]], Clothing Items are automatically generated from [[Accessory|Accessories]]. You cannot make the item yourself, form a "*.item", as the game will not be able to generate it properly. As such you will have to rely on "*.accessory" files to create clothing items.
+
Unlike [[Craft Items]], Clothing Items are automatically generated from [[Accessory|Accessories]]. You cannot make the item yourself. (i.e. Create an "*.item" file for clothing items.) As such you will have to rely on [[Accessory|Accessory files]] to create Clothing Items.
  
  
 
= Spawning in a Clothing Item =
 
= Spawning in a Clothing Item =
As it is not possible to create a proper clothing item. You can only create a clothing item using the following;
+
As it is not possible to create a proper Clothing Item, you can create a clothing item using the following;
 
<pre>
 
<pre>
 
{
 
{
Line 23: Line 25:
 
}
 
}
 
</pre>
 
</pre>
All 3 properties must be included and both kind and accessory cannot be blank (i.e. It must have something inside of the quotes ""). The "kind" property has to be "staxel.item.Clothing" for the game to recognise it is an article of Clothing. The "accessory" is the code of an [[Accessory]] in which you want to spawn. The "palette" property is the code of the [[Palettes|Palette]] you want to apply, you can leave it blank to just have it apply the default palette, but it must still be included. Be sure to only put a palette that can be used for the item, as other palettes will crash the game.
 
 
 
Example Input: <code>{"kind": "staxel.item.Clothing", "accessory": "staxel.accessories.characters.accessories.tiaras.GoldTiara", "palette": "" }</code>
 
 
 
= Config Options =
 
== "kind" ==
 
'''Valid options (String): <code>A unique string which type of item this object is.</code>'''
 
 
This page is referring to <code>staxel.item.Clothing</code> to view other types of items head to [[:Category:Item Modding]]
 
 
 
A string containing the type of item of the design the blob will be referring to.
 
 
 
== "accessory" ==
 
'''Valid options (String): <code>The code to an [[Accessory]] file</code>'''
 
 
'''Default Value:''' No default value is specified. Always need to provide your own.
 
 
 
A string containing which accessory you want to spawn.
 
 
  
== "accessory" ==
 
'''Valid options (String): <code>The code to an [[Palettes|Palette]] file</code>'''
 
  
'''Default Value:''' No default value is specified. Always need to provide your own. A Blank value (i.e. "") is acceptable and will lead to using the default palette.
+
All 3 properties must be included and both kind and accessory cannot be blank (i.e. It must have something inside of the quotes ""). The "kind" property has to be "staxel.item.Clothing" for the game to recognise it is an article of Clothing. The "accessory" is the code of the [[Accessory]] in which you want to spawn. The "palette" property is the code of the [[Palettes|Palette]] you want to apply, you can leave it blank to just have it apply the default palette, but it must still be included. Be sure to only put a palette that can be used for the item, as other palettes will crash the game.
  
  
A string containing which palette you want the accessory to spawn with. Be sure the accessory can use this palette, otherwise it can cause issues.
+
Example Input: <code>{"kind": "staxel.item.Clothing", "accessory": "staxel.accessories.characters.accessories.tiaras.GoldTiara", "palette": ""}</code>

Latest revision as of 07:27, 12 December 2017

Items are fairly broad in their types. Each type has it's own properties and uses.

This page is for items that can be worn, Clothing Items.

Clothing Items are all items that have the following line;

"kind": "staxel.item.Clothing",

Clothing items allow the player to wear new clothes. These items contain the information to swap out models of clothing from the base model.


Creating a Clothing Item

Unlike Craft Items, Clothing Items are automatically generated from Accessories. You cannot make the item yourself. (i.e. Create an "*.item" file for clothing items.) As such you will have to rely on Accessory files to create Clothing Items.


Spawning in a Clothing Item

As it is not possible to create a proper Clothing Item, you can create a clothing item using the following;

{
  "kind": "staxel.item.Clothing",
  "accessory": "your.accessory.here",
  "palette": "your.palette.here"
}


All 3 properties must be included and both kind and accessory cannot be blank (i.e. It must have something inside of the quotes ""). The "kind" property has to be "staxel.item.Clothing" for the game to recognise it is an article of Clothing. The "accessory" is the code of the Accessory in which you want to spawn. The "palette" property is the code of the Palette you want to apply, you can leave it blank to just have it apply the default palette, but it must still be included. Be sure to only put a palette that can be used for the item, as other palettes will crash the game.


Example Input: {"kind": "staxel.item.Clothing", "accessory": "staxel.accessories.characters.accessories.tiaras.GoldTiara", "palette": ""}