Weapons and Items as Original Data

This plugin allows the creation of Original Data entries that act as weapons or items. This means that you can, for example, make a magic system where the magic is not in the inventory, but instead it is from Original Data entries.

Weapons and Items

To make this system work, you need to do the following for each spell/weapon/item you create:

1. First, you need to create the weapon and add the custom parameter {magic: true}. This also applies to items.
2. Create and Original Data entry in one of the tabs. Keep in mind that all entries must be in the same tab, which will be specified in the _config.js file.
3. In the item option, select the weapon or magic that you will use.
4. Change the value in Value 1 to set the level requirement. If you leave it at zero, there is no level requirement.
5. You can also add the following requirements in the Multiple Data window: units and classes. If a unit that gains a level meets at least one of the requirements, on top of already meeting the level requirement, then it will be able to use that weapon or item.
6. Original data needs to have keyword "Spell"

Important: To make this work, you need to create a Execute Script event of the type Execute Code and write the next line of code: MagicAttackControl.setSpellsAllUnits();

Known issue: This system doesn't work on guest units. However, it does work for event guest units. If you use guest units that are not created through events, the game will crash

Known issue: In Database > Config, make sure "Skip weapon select menu when only have 1 weapon" is NOT checked. This option does not consider Weapon and Items as Original Data. These are the possible problems:

• If you have 1 normal weapon, the game will incorrectly ignore any Original Data weapons and skip the weapon select menu.
• If you have no normal weapons but do have Original Data weapons, the game will crash when trying to show the weapon select menu.

Settings

You can change some options of this plugin by opening the _config.js file with a text editor like Notepad. There are three options to change:

• ADD_WINDOW: If it is true, the spells window will be added to the unit menu screen. Else, it won't be added. By default it is set to true.
• NAME: Name for the category of weapons and items used as original data. Used by the spells window. By default the value is "Spells".
• ORIGINAL_DATA_TAB: The tab of Original Data entries. Note that the first tab has the number 0, the second tab 1, and so on. The default value is zero.

Assign Weapons/Items to Units

To make an unit start with some weapons or items as Original Data entries, you need to use the custom parameter spells. For example: {spells: [2]} or {spells: [0, 1, 5]}. Each number is an ID of an Original Data entry. Keep in mind that all entries must be in the same tab, which will be specified in the _config.js file.

Event Command

You can create a Execute Script event with the type "Call Event Command". To make this work, you need to set the Object Name to "AddSpell". Finally, you need to specifiy in the Original Data tab the unit that will receive the new weapon/item, and also change the Value 1 to the ID of the Original Data that will be added to the unit.

Custom Item - Learn Spell

You can create an item that will teach a unit a specific spell if the unit has the ability to use any magic type.

1. Create an item of type Custom with the keyword "SpellItem".
2. Add custom parameters to define the weapon or item to give to the user and the prerequisites to use the teaching item.
   • teachSpell: the ID of the weapon or item to teach in Original Data.
   • reqCategory*: the weapon category the user must be able to use at least one of in order to use the item (0: weapons, 1: bows, 2: magic)
   • staffReq*: true or false. True if staff users also allowed to use this item, and false otherwise

*Optional parameters. If you leave off both optional parameters, then there is no prerequisite and any unit can use the item.

Example: {teachSpell:2, reqCategory:1, staffReq:true} allows units who can use bows to learn the spell with ID 2. Staff users are also eligible.

Ballista

You can also make a unit use a specific weapon in a specific tile, like for example a ballista that is fixed in a tile and can be used by archers. This system uses skills instead of Original Data.

To use this, you make the same process as when you make any other skill weapon, except for the following:

• The weapon must have the custom parameter {ballista:true} instead of using the magic custom parameter.
• The skill kewyord must be "MapAttack". The custom parameter of the skill needs to be weapon with the ID of the weapon to use.
• Add the skill to the terrain that is assigned to the ballista tile. This is done in the Optional Skills option of the terrain.
• During an Opening event, create a Execute Script event command of the type Execute Code with the following line of code: BallistaControl.addBallista();
• Add a custom parameter to the map, so you can specifiy which tiles will be the one to use this type of attack. For example: {ballista: [ {x:5, y:3, skill:32}, {x:0, y:7, skill:32} ]}. This means that in the tiles (5, 3) and (0, 7) there are ballista tiles. The units that can use the weapon assigned to the skill with ID 32 will be able to deal the attack.