Difference between revisions of "Template:VisuMZ Item Crafting System Notetags"

From Yanfly.moe Wiki
Jump to navigation Jump to search
(Created page with "<noinclude>VisuMZ Item Crafting System Notetags</noinclude> The following are notetags that have been added through this plugin. These notetags...")
 
(Batch-Related Notetags)
 
(10 intermediate revisions by 2 users not shown)
Line 4: Line 4:
  
 
=== General Notetags ===
 
=== General Notetags ===
 +
 +
[[File:ItemCraftingSys_Preview1.png|600px]]
  
 
These notetags are used to mark the item as a craftable item or as items
 
These notetags are used to mark the item as a craftable item or as items
Line 79: Line 81:
 
- This item can only be crafted with custom crafting lists selected through
 
- This item can only be crafted with custom crafting lists selected through
 
   the Plugin Command.
 
   the Plugin Command.
 +
</pre>
 +
 +
---
 +
 +
=== Proxy Notetags ===
 +
 +
---
 +
 +
<pre>
 +
<Proxy: id>
 +
<Proxy: name>
 +
 +
- Used for: Item, Weapon, Armor Notetags
 +
- REQUIRES the most up to date VisuMZ Items and Equips Core!
 +
- Turns this item, weapon, or armor into a proxy for another item, allowing
 +
  you to create recipes with different ingredients in <Crafting Ingredients>
 +
  notetag contents and yield the same item.
 +
- The proxy item itself will take on the name, icon, and description of the
 +
  original item it is supposed to represent.
 +
- No other properties are carried over from the original.
 +
- When viewed through the Window_ShopStatus window, the contents will
 +
  reference the original item and not the proxy item.
 +
- Proxy items themselves cannot be acquired. This includes event commands,
 +
  item drops, or equips.
 +
- When crafted, the item yielded won't be the proxy item but the item it is
 +
  a proxy for.
 +
- Replace 'id' with a number representing the item, weapon, or armor ID of
 +
  the same item type. If the proxy is an item, this will reference an item.
 +
  If the proxy is a weapon, this will reference a weapon. Same for armors.
 +
- Replace 'name' with text representing the item, weapon, or armor's name.
 +
  The referenced item needs to be the same item type as the proxy. Item for
 +
  item, weapon for weapon, armor for armor.
 
</pre>
 
</pre>
  
Line 84: Line 118:
  
 
=== Switch-Related Notetags ===
 
=== Switch-Related Notetags ===
 +
 +
[[File:ItemCraftingSys_Preview1.png|600px]]
  
 
These notetags can make item crafting require certain switches to be on,
 
These notetags can make item crafting require certain switches to be on,
Line 125: Line 161:
  
 
=== Masking-Related Notetags ===
 
=== Masking-Related Notetags ===
 +
 +
[[File:ItemCraftingSys_Preview1.png|600px]]
  
 
These notetags can are used to determine name-masking properties for
 
These notetags can are used to determine name-masking properties for
Line 177: Line 215:
  
 
=== Crafting Animation-Related Notetags ===
 
=== Crafting Animation-Related Notetags ===
 +
 +
[[File:ItemCraftingSys_Animation.gif]]
  
 
These notetags let you set custom crafting animations when a specific item,
 
These notetags let you set custom crafting animations when a specific item,
Line 208: Line 248:
 
- Use lower numbers for slower fade speeds and higher numbers for faster
 
- Use lower numbers for slower fade speeds and higher numbers for faster
 
   fade speeds.
 
   fade speeds.
 +
</pre>
 +
 +
---
 +
 +
<pre>
 +
<Crafting Picture: filename>
 +
<Picture: filename>
 +
 +
- Used for: Item, Weapon, Armor Notetags
 +
- Uses a picture from your project's /img/pictures/ folder instead of the
 +
  item, weapon, or armor's icon during crafting instead.
 +
- Replace 'filename' with the filename of the image.
 +
  - Do not include the file extension.
 +
- Scaling will not apply to the picture.
 +
- Use the <Picture: filename> version for any other plugins that may be
 +
  using this as an image outside of crafting, too.
 +
- The size used for the image will vary based on your game's resolution.
 +
</pre>
 +
 +
---
 +
 +
=== Crafting Common Event Notetags ===
 +
 +
Requires:
 +
 +
[[File:VisuMZ.083.jpg|300px|link=Shop Common Events VisuStella MZ]]
 +
 +
---
 +
 +
<pre>
 +
<Once Craft Common Event: id>
 +
<Repeat Craft Common Event: id>
 +
 +
- Used for: Item, Weapon, Armor Notetags
 +
- Requires VisuMZ_2_ShopCommonEvents!
 +
- This will cause a specific Common Event to launch when crafted.
 +
- Replace 'id' with a number representing the ID of the Common Event that
 +
  you wish to launch upon this item being crafted.
 +
- The "Once" notetag variant will only occur once when crafted.
 +
  - Any subsequent purchases of the item will not launch the Common Event.
 +
- The "Repeat" notetag variant will occur repeatedly when crafted.
 +
- If both "Once" and "Repeat" notetags are present in the item, then the
 +
  "Once" variant will take priority first. Any subsequent purchases will go
 +
  to the "Repeat" variant.
 +
- Any switch requirement notetags need to be met in order for either
 +
  notetag to have any effect.
 +
- Use the Plugin Command "Scene: Common Event Return" to return back to the
 +
  last Item Crafting scene.
 +
</pre>
 +
 +
---
 +
 +
=== Crafting Common Event Requirement-Related Notetags ===
 +
 +
Requires:
 +
 +
[[File:VisuMZ.083.jpg|300px|link=Shop Common Events VisuStella MZ]]
 +
 +
---
 +
 +
<pre>
 +
<Once Craft Common Event Switch: id>
 +
<Once Craft Common Event All Switches: id, id, id>
 +
<Once Craft Common Event Any Switches: id, id, id>
 +
 +
<Repeat Craft Common Event Switch: id>
 +
<Repeat Craft Common Event All Switches: id, id, id>
 +
<Repeat Craft Common Event Any Switches: id, id, id>
 +
 +
- Used for: Item, Weapon, Armor Notetags
 +
- Requires VisuMZ_2_ShopCommonEvents!
 +
- Requires the respective Craft Common Events to have these Switches enabled
 +
  in the "ON" position in order for them to launch.
 +
  - "Once" variant will only affect the "Once" notetag variants.
 +
  - "Repeat" variant will only affect the "Repeat" notetag variants.
 +
- The "All" variant will require all listed Switch ID's to be "ON".
 +
- The "Any" variant will require only one listed Switch ID to be "ON".
 +
- Replace 'id' with a number representing the Switch ID that needs to be in
 +
  the "ON" position for the requirement to be met.
 +
  - Insert multiple 'id' to require more Switch ID's.
 +
</pre>
 +
 +
---
 +
 +
=== Batch-Related Notetags ===
 +
 +
[[File:VisuMZ.140.jpg|300px|link=]]
 +
 +
---
 +
 +
<pre>
 +
<Craft Batch>
 +
listing
 +
listing
 +
listing
 +
</Craft Batch>
 +
 +
- Used for: Item, Weapon, Armor Notetags
 +
- Requires VisuMZ_3_ShopBatches!
 +
- Creates a list of items, weapons, and armors that the player will gain
 +
  when this batch object is crafted.
 +
  - This also means that in addition to this notetag, the notetag for
 +
    <Crafting Ingredients> is also needed.
 +
  - This item will also not be masked.
 +
- Proxy items, weapons, or armors cannot be listed and will be bypassed.
 +
- This item, weapon, or armor cannot be crafted if all of the listed items,
 +
  weapons, or armors are at max quantity within the party's inventory.
 +
- The listed items will NOT utilize any on craft effects for the individual
 +
  listed items themselves.
 +
- Replace 'listing' with any of the listing types found below:
 +
 +
    Item id
 +
    Item name
 +
    Weapon id
 +
    Weapon name
 +
    Armor id
 +
    Armor name
 +
 +
    Item id: quantity
 +
    Item name: quantity
 +
    Weapon id: quantity
 +
    Weapon name: quantity
 +
    Armor id: quantity
 +
    Armor name: quantity
 +
 +
  - Replace 'id' with a number representing the ID of the item, weapon, or
 +
    armor that is to be listed.
 +
  - Replace 'name' with the associated item, weapon, or armor's name.
 +
  - Replace 'quantity' with a number representing the number of items,
 +
    weapons, or armors that will be acquired when the batch item is crafted.
 +
    - If the variant without 'quantity' is used, quantity will default to 1.
 +
 +
  Examples:
 +
 +
  ---
 +
 +
  <Craft Batch>
 +
  Item Potion: 10
 +
  Item Super Potion: 5
 +
  Weapon Short Sword: 3
 +
  Weapon Long Sword: 2
 +
  Armor Linen Clothing: 4
 +
  Armor Cloth Armor: 3
 +
  </Craft Batch>
 +
 +
  ---
 +
 +
  <Craft Batch>
 +
  Item 7: 10
 +
  Item 8: 5
 +
  Weapon 1: 3
 +
  Weapon 2: 2
 +
  Armor 2: 4
 +
  Armor 8: 3
 +
  </Craft Batch>
 +
 +
  ---
 
</pre>
 
</pre>
  
 
---
 
---

Latest revision as of 15:30, 14 February 2024

The following are notetags that have been added through this plugin. These notetags will not work with your game if this plugin is OFF or not present.

General Notetags

ItemCraftingSys Preview1.png

These notetags are used to mark the item as a craftable item or as items that can only be crafted through a custom crafting list.

---

<Crafting Ingredients>
 Item id: x
 Item name: x
 Weapon id: x
 Weapon name: x
 Armor id: x
 Armor name: x
 Gold: x
 Category name: x
</Crafting Ingredients>

- Used for: Item, Weapon, Armor Notetags
- Turns this item/weapon/armor into a craftable item by using the listed
  ingredients to craft with.
- If the 'Category name' variant is used, it will draw from all items,
  weapons, and armors that have matching <Category: x> notetag data.
- Insert/delete any number of copies of the ingredients as needed.
- Replace 'id' with the item/weapon/armor ID of the ingredient to be used.
- Replace 'name' with the name of the item/weapon/armor/category to be used.
- Replace 'x' with the number of ingredients needed to be used for crafting.

Category Rules:

- If the 'Category name' variant is used, it will draw from all items,
  weapons, and armors that have matching <Category: x> notetag data.
- Multiples of the same category name can be used. However, the player must
  select different items each time.
- If the selected category item already exists as a static ingredient, that
  item cannot be selected either.

Examples:

<Crafting Ingredients>
 Item 5: 1
 Item 6: 3
 Gold: 100
</Crafting Ingredients>

<Crafting Ingredients>
 Item Potion: 1
 Item Magic Water: 3
 Gold: 100
</Crafting Ingredients>

<Crafting Ingredients>
 Weapon 1: 4
 Armor 2: 2
</Crafting Ingredients>

<Crafting Ingredients>
 Weapon Sword: 4
 Armor Hat: 2
</Crafting Ingredients>

<Crafting Ingredients>
 Category Fruit: 2
 Category Meat: 3
</Crafting Ingredients>

---

<Custom Crafting Only>

- Used for: Item, Weapon, Armor Notetags
- This item can only be crafted with custom crafting lists selected through
  the Plugin Command.

---

Proxy Notetags

---

<Proxy: id>
<Proxy: name>

- Used for: Item, Weapon, Armor Notetags
- REQUIRES the most up to date VisuMZ Items and Equips Core!
- Turns this item, weapon, or armor into a proxy for another item, allowing
  you to create recipes with different ingredients in <Crafting Ingredients>
  notetag contents and yield the same item.
- The proxy item itself will take on the name, icon, and description of the
  original item it is supposed to represent.
- No other properties are carried over from the original.
- When viewed through the Window_ShopStatus window, the contents will
  reference the original item and not the proxy item.
- Proxy items themselves cannot be acquired. This includes event commands,
  item drops, or equips.
- When crafted, the item yielded won't be the proxy item but the item it is
  a proxy for.
- Replace 'id' with a number representing the item, weapon, or armor ID of
  the same item type. If the proxy is an item, this will reference an item.
  If the proxy is a weapon, this will reference a weapon. Same for armors.
- Replace 'name' with text representing the item, weapon, or armor's name.
  The referenced item needs to be the same item type as the proxy. Item for
  item, weapon for weapon, armor for armor.

---

Switch-Related Notetags

ItemCraftingSys Preview1.png

These notetags can make item crafting require certain switches to be on, or turn switches on/off upon crafting items.

---

<Crafting Show Switch: x>

<Crafting Show All Switches: x,x,x>
<Crafting Show Any Switches: x,x,x>

- Used for: Item, Weapon, Armor Notetags
- Determines the visibility of the craftable item in the crafting scene.
- Replace 'x' with the switch ID to determine the item's visibility.
- If 'All' notetag variant is used, item will be hidden until all switches
  are ON. Then, it would be shown.
- If 'Any' notetag variant is used, item will be shown if any of the
  switches are ON. Otherwise, it would be hidden.
- Insert as many switch ID's as needed.
- This can be bypassed with the custom Item Crafting list plugin command
  option if enabled.

---

<Crafting Turn On Switch: x>
<Crafting Turn On Switches: x,x,x>

<Crafting Turn Off Switch: x>
<Crafting Turn Off Switches: x,x,x>

- Used for: Item, Weapon, Armor Notetags
- Upon crafting this item, turn on/off the marked switch(es).
- Replace 'x' with the switch ID to turn on/off.

---

Masking-Related Notetags

ItemCraftingSys Preview1.png

These notetags can are used to determine name-masking properties for uncrafted items.

---

<Crafting Mask: text>

- Used for: Item, Weapon, Armor Notetags
- Displays the specific 'text' when the item has not yet been crafted.
- Replace 'text' with the text you wish to display if the item has not yet
  been crafted by the player.
- This can be bypassed with the custom Item Crafting list plugin command
  option if enabled.

---

<Crafting No Mask>

- Used for: Item, Weapon, Armor Notetags
- Bypasses name masking even if the item has not yet been crafted.

---

JavaScript Notetag: Effect-Related

The following are notetags made for users with JavaScript knowledge to make custom effects that occur upon crafting the item.

---

<JS Crafting Effect>
 code
 code
 code
</JS Crafting Effect>

- Used for: Item, Weapon, Armor Notetags
- Replace 'code' with JavaScript code to determine what kinds of effects you
  want to occur upon crafting this item.
- The 'item' variable represents the item being crafted.
- The 'number' variable represents the number of items being crafted.

---

Crafting Animation-Related Notetags

ItemCraftingSys Animation.gif

These notetags let you set custom crafting animations when a specific item, weapon, or armor is crafted so that way, they don't all have to use the default crafting animation from the plugin parameters.

---

<Crafting Animation: id>
<Crafting Animation: id, id, id>

- Used for: Item, Weapon, Armor Notetags
- Plays the animation(s) when this item, weapon, or armor is crafted.
- This will override the default animation settings found in the plugin
  parameters and use the unique one set through notetags instead.
- Replace 'id' with the ID of the animation you wish to play.
- If multiple ID's are found, then each animation will play one by one in
  the order they are listed.

---

<Crafting Fade Speed: x>

- Used for: Item, Weapon, Armor Notetags
- This determines the speed at which the item's icon fades in during the
  crafting animation.
- Replace 'x' with a number value to determine how fast the icon fades in.
- Use lower numbers for slower fade speeds and higher numbers for faster
  fade speeds.

---

<Crafting Picture: filename>
<Picture: filename>

- Used for: Item, Weapon, Armor Notetags
- Uses a picture from your project's /img/pictures/ folder instead of the
  item, weapon, or armor's icon during crafting instead.
- Replace 'filename' with the filename of the image.
  - Do not include the file extension.
- Scaling will not apply to the picture.
- Use the <Picture: filename> version for any other plugins that may be
  using this as an image outside of crafting, too.
- The size used for the image will vary based on your game's resolution.

---

Crafting Common Event Notetags

Requires:

VisuMZ.083.jpg

---

<Once Craft Common Event: id>
<Repeat Craft Common Event: id>

- Used for: Item, Weapon, Armor Notetags
- Requires VisuMZ_2_ShopCommonEvents!
- This will cause a specific Common Event to launch when crafted.
- Replace 'id' with a number representing the ID of the Common Event that
  you wish to launch upon this item being crafted.
- The "Once" notetag variant will only occur once when crafted.
  - Any subsequent purchases of the item will not launch the Common Event.
- The "Repeat" notetag variant will occur repeatedly when crafted.
- If both "Once" and "Repeat" notetags are present in the item, then the
  "Once" variant will take priority first. Any subsequent purchases will go
  to the "Repeat" variant.
- Any switch requirement notetags need to be met in order for either
  notetag to have any effect.
- Use the Plugin Command "Scene: Common Event Return" to return back to the
  last Item Crafting scene.

---

Crafting Common Event Requirement-Related Notetags

Requires:

VisuMZ.083.jpg

---

<Once Craft Common Event Switch: id>
<Once Craft Common Event All Switches: id, id, id>
<Once Craft Common Event Any Switches: id, id, id>

<Repeat Craft Common Event Switch: id>
<Repeat Craft Common Event All Switches: id, id, id>
<Repeat Craft Common Event Any Switches: id, id, id>

- Used for: Item, Weapon, Armor Notetags
- Requires VisuMZ_2_ShopCommonEvents!
- Requires the respective Craft Common Events to have these Switches enabled
  in the "ON" position in order for them to launch.
  - "Once" variant will only affect the "Once" notetag variants.
  - "Repeat" variant will only affect the "Repeat" notetag variants.
- The "All" variant will require all listed Switch ID's to be "ON".
- The "Any" variant will require only one listed Switch ID to be "ON".
- Replace 'id' with a number representing the Switch ID that needs to be in
  the "ON" position for the requirement to be met.
  - Insert multiple 'id' to require more Switch ID's.

---

Batch-Related Notetags

VisuMZ.140.jpg

---

<Craft Batch>
 listing
 listing
 listing
</Craft Batch>

- Used for: Item, Weapon, Armor Notetags
- Requires VisuMZ_3_ShopBatches!
- Creates a list of items, weapons, and armors that the player will gain
  when this batch object is crafted.
  - This also means that in addition to this notetag, the notetag for
    <Crafting Ingredients> is also needed.
  - This item will also not be masked.
- Proxy items, weapons, or armors cannot be listed and will be bypassed.
- This item, weapon, or armor cannot be crafted if all of the listed items,
  weapons, or armors are at max quantity within the party's inventory.
- The listed items will NOT utilize any on craft effects for the individual
  listed items themselves.
- Replace 'listing' with any of the listing types found below:

    Item id
    Item name
    Weapon id
    Weapon name
    Armor id
    Armor name

    Item id: quantity
    Item name: quantity
    Weapon id: quantity
    Weapon name: quantity
    Armor id: quantity
    Armor name: quantity

  - Replace 'id' with a number representing the ID of the item, weapon, or
    armor that is to be listed.
  - Replace 'name' with the associated item, weapon, or armor's name.
  - Replace 'quantity' with a number representing the number of items,
    weapons, or armors that will be acquired when the batch item is crafted.
    - If the variant without 'quantity' is used, quantity will default to 1.

  Examples:

  ---

  <Craft Batch>
   Item Potion: 10
   Item Super Potion: 5
   Weapon Short Sword: 3
   Weapon Long Sword: 2
   Armor Linen Clothing: 4
   Armor Cloth Armor: 3
  </Craft Batch>

  ---

  <Craft Batch>
   Item 7: 10
   Item 8: 5
   Weapon 1: 3
   Weapon 2: 2
   Armor 2: 4
   Armor 8: 3
  </Craft Batch>

  ---

---