Extended Loot Plugin Guide

extendedLootPluginGuide.md

🪙 Extended Loot Plugin Guide

🔧 Setup: Gold Representation

To configure how gold is displayed in the Loot List or Visual Drop:

• Go to Plugin Parameters → Gold Item
• Set up the gold representation item here.

---

📜 Loot List Window

🔔 Activation

• Go to Plugin Parameters → Loot Window
• Set to TRUE to enable the Loot List system.

🛠️ How to Create a Loot List

1. Add the comment: lootList
2. Use regular event commands to give items (e.g., Change Items, Weapons, Gold)
3. Add the comment: /lootList
4. The loot window will appear at the /lootList comment, displaying all items added in step 2.

📝 Customizing Header

• Change header text:

  LL_setHeaderText("Your Header Text");

  Supports control characters like \C, \V, etc.

• Set header image:

  LL_setHeaderImage("imageName", X, Y);

  • Image must be located in img/pExtendedLoot
  • X, Y: position offsets relative to the loot window

💡 PRO Version: Offers extended Loot Window customization options via plugin parameters.

---

💬 Pop-Ups

🔔 Activation

• Go to Plugin Parameters → Pop-Up's
• Set to TRUE to enable item pop-ups.

ℹ️ How It Works

• Automatically displays a pop-up when the player receives an item.

🛑 Temporarily Disable Pop-Ups

VPU_setShouldShow(false); // Disable pop-ups
VPU_setShouldShow(true);  // Enable again

💡 PRO Version: Allows customization of pop-up behavior through plugin parameters.

---

📺 Screen Pop-Ups

🧹 Clear All Screen Pop-Ups

EL_ClearAllScreenPopUps();

📦 Show Pop-Up for a Specific Item

EL_ShowScreenPopUpForItem(item, count, [color]);

• item: Game Item object (e.g., $dataItems[7])
• count: Quantity
• color: Optional hex color ('#ffffff')

Example:

EL_ShowScreenPopUpForItem($dataItems[7], 1, '#ffffff');

✨ Show Custom Pop-Up

EL_ShowScreenPopUpCustom(iconIndex, text, count, color);

Example:

EL_ShowScreenPopUpCustom(44, 'Quest Updated', 0, '#ff88ff');

---

🎁 Visual Drop

🔔 Activation

• Go to Plugin Parameters → Visual Drop
• Set to TRUE to enable visual item drops.

⚙️ How It Works

• When using event commands like Change Item, the items visually drop from the event location.
• Some items are auto-picked up (customizable radius in plugin parameters).
• Others require a mouse click or touch to pick up.

🛑 Temporarily Disable Visual Drop

VD_setShouldDrop(false); // Disable visual drops
VD_setShouldDrop(true);  // Enable again

🔧 Extra Configuration

• Prevent auto-pickup for an item:

  <noAutoLoot>

• Assign a drop sound to an item:

  <lootDropSound:SoundName> 

  Replace SoundName with the name of the SE file.

• Assign a pickup sound to an item:

  <lootPickUpSound:SoundName> 

  Replace SoundName with the name of the SE file.

💡 PRO Version: Enables more customization of visual drop behavior via plugin parameters.

Highlight for Visual Drop

• Go to "Plugin Parameters → Visual Drop -> Highlight Key"
• Set the key to highlight the names of the items that are dropped visually.

Manual pickup items around the player

• Go to "Plugin Parameters → Visual Drop -> Pick Up Key"
• Set the key to pick up items around the player.
• You can also set the pickup radius in the plugin parameters (see Pick Up Radius below or Pick Up Radius (Variable ID)).

---

🎲 Random Loot System

🧾 Chance-Based Drop Comments

Place these above the Change Item event command:

• Fixed Chance:

  chance:50 // 50% chance
  

• Switch-Based Chance:

  chance:3|S // 100% if switch #3 is ON
  

• Variable-Based Chance:

  chance:12|V // Uses value from variable #12 as percent
  

• Check if drop succeeded:

  CH_IsGood(); // Returns true if drop succeeded

---

➕ Give Item with Special Conditions

• Basic syntax:

  add:Z:X:Y
  

  • Z: item, weapon, armor or i, w, a
  • X: ID (or X|V for variable)
  • Y: Count (or Y|V for variable)

  Examples:

  add:armor:2:1
  add:w:100|V:1
  

• Give one random from a list:

  add:Z:[X, X, ...]:Y
  

  Examples:

  add:w:[1, 2, 3, 4]:1
  add:item:[1, 100|V]:8|V
  

• Add item with inline chance:

  add:Z:X:Y:withChance:C
  

  • C: chance value, or C|V (variable), or C|S (switch)

  Examples:

  add:item:2:1:withChance:50
  add:weapon:[1, 2, 3]:2:withChance:433|V
  

---

🌈 Rarity System

🔔 Activation

• Go to Plugin Parameters → Rarity System
• Set to TRUE to enable item rarity.

🧩 How to Configure

1. Define rarity levels under Plugin Parameters → Items Rarity Levels

2. Assign a rarity level to an item using a notetag:

   <pRarity:X>

   • Replace X with the rarity level number.

---