editor requirements - magemonkeystudio/divinity GitHub Wiki
π§± Editor: Requirements
The Requirements option allows you to restrict who can equip or use the generated item. These conditions are based on player level, class, and banned class settings.
ποΈ Level Requirements
You can define what level range a player must be in to use an item, using user-requirements-by-level
.
πΉ How It Works
- The keys represent the item level.
- The values are level ranges (e.g.,
'1:10'
) or dynamic expressions using%ITEM_LEVEL%
. - Players must meet the level condition associated with the itemβs generated level.
π Example
user-requirements-by-level:
level:
'1': '1:10'
'11': '11:20'
'21': 0 + %ITEM_LEVEL%
π§ Class Requirements
Allows only specific classes to use an item based on item level.
user-requirements-by-level:
class:
'1': Fighter,Barbarian,Ranger,Paladin
'2': Fighter
At item level 1, only Fighter, Barbarian, Ranger, or Paladin may use the item. At level 2, only Fighter is permitted.
π« Banned Class Requirements
Blocks specific classes from using the item.
user-requirements-by-level:
banned-class:
'3': Mage
At item level 3, the Mage class is restricted.
π Combined Level and Class Use
Level and class requirements can be combined for fine-grained control:
user-requirements-by-level:
level:
'1': '1'
'2': '5'
'3': '11'
'4': '15'
'5': '20'
class:
'1': Fighter,Barbarian,Ranger,Paladin
'2': Fighter,Barbarian,Ranger,Paladin
'3': Fighter
'4': Fighter
'5': Fighter
This means:
- A level 2 item can only be used by Fighter, Barbarian, Ranger, or Paladin if their class level is 5+.
- A level 5 item is restricted to Fighter class at level 20+.
π§Ύ Explanation of Fields
Field | Description |
---|---|
level |
Sets valid player level range by item level. |
class |
Lists allowed classes for a given item level. |
banned-class |
Lists blocked classes for a given item level. |
Placeholder math | Supports expressions like 0 + %ITEM_LEVEL% to scale dynamically. |
π§ͺ Use Case
- Create tiered class restrictions for different item levels
- Require higher class level to equip rarer weapons
- Prevent specific classes from using restricted gear
Return to: Item Generator Module