This plugin sets the stats of every "Mob" enemy on the game automatically.
You only need to add a custom parameter on each class for the class growths,
and a optional global parameter for random variance, if you choose to add that to your game.
Note that 'Subleader' and 'Leader' enemy units will have to be set up its stats manually.
How to use
First, you need to add a custom parameter called 'growths' to each class to define the base growths used by enemy units.
This parameter contains as a value an object that has more custom parameters.
For example: {growths: {all: 50, str:100, mag: 25, mov:0}}
This means that the units of that class with have a growth of 100% on Str, 25% on Mag, 0% on Mov, and 50% on every other stat.
Basically, you have a custom paramete for each stat, and the custom parameter 'all' that is used when some of the other parameters are not present.
All of those parameters are optional, if they are not present, they use the 'all' value, and if that is not present either, it will have the default value of 0.
The custom parameters used are: all - mhp - str - mag - ski - spd - luk - def - res - bld - mov - wlv
Random variance
By default, this system makes every unit with the same level and class have the exact same stats.
If you want to add some random variance, you can do it with the global parameter 'variance'. (To access global parameters, go to Database->Config->Script->Global Parameters)
This parameter uses the same parameters as the 'growths' parameter.
For example: {variance: {all:1, ski: 2, spd:0, bld:0, mov:0}}
This means that the units will have a variance of 2 on Ski, 0 on Spd, Bld and Mov, and 1 in every other stat.
Note that a variance of 2 means that the stat can be modified from -2 to 2.
So for example, if a unit has 10 on a certain stat and there is a variance of 2 in that stat, the possible values are 8, 9, 10, 11 and 12.
Additional feature with the Weapons Rank plugin
If you are using the plugin for Weapon Ranks, this plugin will also update the ranks of every "Mob" enemy unit,
setting them with the necessary ranks to use every weapon and item in their inventory.
This plugin allows to change the default bottom window of the unit menu screen, so you can show data from the unit that is not available by default.
You can also add more windows, with each window showing differen data of the unit.
The data that will be displayed will be choosen by the user from the list of data that was added to the plugin.
You don't need to use custom parameters and you don't need to know about progamming. To modify the window, you only need to change some options (more detailed instructions below).
For example, you can make windows show things like races, states, class type, among other things.
How the windows work
The windows are divided into four sectors: top left, top right, bottom left and bottom right.
Each of these sector can hold one type of data. In particular, the top sectors are bigger than the bottom ones, so they can have more detailed information.
For example, if you insert the races in a top sector, you can see the name and icon of the race, but if you add it to a bottom sector, you can only see the icon.
Note that not all data is available in all sectors. Some are exclusive to top and some to bottom.
In addition to that, most data can be selected, which allows to show the description of the data below the window. In the example used above, it would show
the description of the selected race.
How to assign data to each sector
To assign data to a sector, you need to open the _config.js file with a text editor like Notepad. In there, you will find some variables.
The variables TOP_OPTIONS and BOTTOM_OPTIONS have the data available to use, while the Options variable is where you can assign one of those data options.
Notice that each variable is not just a value, but an array of values. This is done like this so each value represents the data from that section of each window.
For example, if the TOPLEFT value has [TopRaceInteraction, GrowthInteraction] it means that the first window will have a list of races at the top left,
and the second window will have a list of the growths of that unit.
Before modifyin those values, make sure to define the value you want for WINDOWS_COUNT, which determines the amount of windows the screen will have.
Also, make sure that each array has the same amount of elements as the amount of windows defined in WINDOWS_COUNT.
Now, here is a list of all the possible values for the top and bottom sections:
TOP_OPTIONS: this is an array containing with all the options available for top sectors:
NullInteraction: Empty space. Used when you don't want to fill this sector with data.
InventoryInteraction: List of weapons and items that the unit has in its inventory.
StatsInteraction: Current stats of the unit. It doesn't include the HP stat.
AltStatsInteraction: Alternative version of StatsInteraction. The difference is that it has 3 columns instead of 2.
Useful if you have too many stats and they don't fit in the window.
TopWeaponTypeInteraction: List of weapon types available to the unit. Shows icon and name.
TopSkillInteraction: List of skills of the unit. Shows icon and name.
TopRaceInteraction: Races list. Shows name and icon.
TopStateInteraction: States list. While by default the game shows the current states of an unit, this will let you see its name and description.
GrowthInteraction: Unit's growth values.
PlayerGrowthInteraction: An alternative version of GrowthInteraction. It is the same, but this one is only displayed for units of the player's army.
SupportInteraction: Supports list.
TopTraitsInteraction: List of traits. This only works if you also have the plugin Traits System installed.
CustomCombatArtsInteraction: List of combat arts. This only works if you also have the plugin Combat Arts installed.
CustomSpellsInteraction: List of weapons and items from Orignal Data entries. This only works with the plugin Weapons and Items as Original Data installed.
BOTTOM_OPTIONS:
NullInteraction: Empty space. Used when you don't want to fill this sector with data.
BottomWeaponTypeInteraction: List of weapon types available to the unit. Shows icon.
BottomSkillInteraction: List of skills of the unit. Shows icon.
BottomRaceInteraction: Races list. Shows icon.
BottomStateInteraction: States list. While by default the game shows the current states of an unit, this will let you see its description.
ClassTypeInteraction: Class type of the unit's current class. Shows name and icon.
BottomTraitsInteraction: List of traits. This only works if you also have the plugin Traits System installed.
Options: this variable has 4 fields, where each field correspond to one of the window's sectors.
Each field has its name explaning the sector that will be assigned, for example the field TOPLEFT is assigned to the top left sector.
There are two way to assign a value to the field:
You can do something like TOP_OPTIONS[2], in this case you are using the third value found in the array of TOP_OPTIONS.
Note that the index starts with zero, so the first element is TOP_OPTIONS[0], the second TOP_OPTIONS[1], and so on.
The other option is to directly specify the name of the data, like for example writing BottomRaceInteraction or BottomStateInteraction.
There are also two other fields: WINDOWS_COUNT and SECTION_DISTANCE. The first one was already explained before,
and the other sets the distance between the top and bottom sections. By default the value is 0, but it can be changed if your menu window has a differnt size than the default value.
Use a positive number to increase the distance and a negative number to decrease the distance between the top and bottom sections.
About the sections of stats and growths
If you use the StatsInteraction, AltStatsInteraction and/or GrowthInteraction, you will notice that you can't select each stat to check their description.
That is the default behaviour, but it can be changed. To enable this, set true to the variable ENABLE_STAT_DESCRIPTION in the _config.js file
To do this, you need to create and Original Data entry for each stat. Each entry must have exactly the same name as the stat, and you can write the description in the Description field.
All entries must be in the same tab, which will be specified by the STAT_TAB variable. Note that the value zero means the first tab, one is for the second tab, and so on.
This plugins changes how the damage of weapons is calculated.
By default, weapons use the Strength and Magic stats for physical and magical attacks, respectively.
But with the use of this plugin and some custom parameters on the weapon, you can change which stats are used for each weapons.
For example, you could make a Dagger use Skill instead of Strength, or use 50% of Strength and 50% of Skill.
Custom parameters
There is only one obligatory parameter, which is the "alternative" parameter. It has to have the 'true' value, so
weapons can use the custom damage formula, which is described using all the other parameters. There is one parameter for
each stat, and you can use one of them or more. You can even use no parameters, so the weapon doesn't use the stats from the unit
and does fixed damage. Each parameter must have as a value the percentage that the stat will be used. For example, 100 means that it will
use the stat at its full value, 50 means half, 200 means double, and so on. Here is the list of parameters:
zlife: Current life of the unit.
hp: Max possible life of that unit.
str: Strength stat.
mag: Magic stat.
ski: Skill stat.
spd: Speed stat.
lck: Luck stat.
def: Defense stat.
res: Resistance stat.
mov: Movement stat.
wlv: Weapon Level stat.
bld: Build stat.
Examples
{alternative: true, spd: 100} 100% Speed.
{alternative: true, str: 50, ski: 50} 50% Strength and 50% Skill.
{alternative: true, res: 150} 150% Resistance.
{alternative: true} Only uses the weapon's might.
This plugins adds a custom skill, which allows a unit to attack twice in one turn.
It works similar to a normal attack, but once you select the weapon and the target, you can choose again for a weapon and a target.
Both the weapons and the targets can be repetade, or you can choose to change either of them.
For example: first attack is with Iron Sword to Enemy A, and second attack is with the same Iron Sword against Enemy B.
How to use
To make a unit be able to use this command, you need to assing a custom skill with the keyword "DoubleAttack".
If the keyword is already used by some other plugin or you want to use a different keyword, you can change it in the _settings.js file.
Also, you need to specify which weapon types are compatible with the skill. This means that the skill can only be used with weapons beloning to one of these weapon types.
To do this, you need to use custom parameters on said skill. For example:
{ weaponTypes: [ {id: 1, category: 0}, {id: 2, category: 0} ] }
"weaponTypes" is the list of the compatible weapon types.
"id" refers to the weapon type's ID
"category" is the weapon category used by the engine: 0 is Fighters, 1 is Archers and 2 is Mages.
In this example, assuming that the project uses default data, this skill would be only compatible with the weapon types Lance and Axe.
Settings
There are some things you can change in the _settings.js file:
Name of the command.
Name of the skill custom keyword, as explained above.
Messages of each information window: one for first weapon, one for first target, one for second weapon and one for second target.
Width of the information window. The default messages fit correctly in the window, but if you change those messages you can also
change the width of this window to make sure the message doesn't go over the window.
This plugin adds two features regarding the display of enemy range.
First, it adds an individual enemy range, which keep tracks of certain units' range. Each individual range is activated or deactivaded by pressing the select
button while the cursor is over that unit.
Also, you can now edit the color and transparency of the enemy range. You can also assign a different color and transparency to the individual enemy range.
How to use
This plugin doesn't require any custom parameters. Instead, you need to change the values on the config-range.js using a text editor like Notepad.
The variable called ENEMY_RANGE is for the normal enemy range that applies to the entire enemy army,
and the variable INDIVIDUAL_RANGE is the enemy range that you can apply to individual enemy units.
In both cases, to change the color you need to use an RGB value, and for the transparency you need to change the alpha number using a value between 0 and 255.
Individual Enemy Range
With this plugin you can select an enemy unit to mark it and see only its range.
Once this is done, you can select it again to unmark it. You can also mark another unit to see the range of more that one unit at the same time.
This plugin changes the battle formulas used by the engine to match the ones used in the Fire Emblem games for the Game Boy Advance.
To use it, you just need to drag this folder into the Plugin folder of your project.
Optional changes
You can modify some things by modifying the formula-settings.js file. You don't need programming knowledge to use that file.
In there, you will find two variables. These variables are already set up in the same way as the FE GBA games, but you can change them
if you want to have some difference from those games.
MAGIC_ENABLED: This enables ('true') or disables ('false') the Magic stat. By default, the value is false.
If you set it up as true, the Magic stat will be added to the game, so magic attacks and staves will use that stat.
TWO_RN_ENABLED: This adds the option to use 2RN for the hit calculations. By default, the value is true.
If you set it up as false, the hit calculations will use 1RN.
There are also the experience calculations, which are handled by the file exp-formula.js.
If you don't want to use those formulas, remove that file from your project.
With this script, you can make weapons and items cost HP to use.
You need to use the custom parameter "lifeCost" on the weapons/items and write as value the HP cost of each attack of that weapon.
For example, a weapon with {lifeCost:5} costs 5 HP for every attack, even if the unit misses.
It is important to notice that if the unit doesn't have enought HP to use a weapon that costs life, it can't initiate an attack. The unit also won't be able to counterattack.
On the other hand, if the unit had another weapon available in its inventory, it will use that second weapon to counterattack.
If the unit can make two attacks during a round of combat, but doesn't have enough HP to make the second attack, it won't do it, even if it has other available weapons.
This also applies to counterattacks: if the unit has enough HP to wield the weapon, but receives too much damage before being able to counterattack, it won't counterattack.
Known bug
This plugin doesn't work with custom items. If you are using a plugin that creates a custom plugin and you want to make that item cost life,
then you need to modify the code. In the readme file there are instructions on how to do that.
This plugin allows to create "hybrid weapons", which behave as different weapon types depending on the range of the attack.
For example, you can make a "Wind Sword" which acts as a Sword weapon during melee and acts as a Wind weapon during ranged attacks.
In this example, you can even make the melee attacks deal phyisical damage, while the ranged attacks deal magic damage, or make all attacks do phyisical or magic damage.
How to use
To use this plugin, you need to add the custom parameter "hybrid" to the weapon. For example:
{hybrid: [ {type:"Sword", range: 1, physical: true}, {type:"Wind", range: 2, physical: false} ]}
This is a complex parameter, so let's analyze it part by part:
type: this parameter needs to be the name of the weapon type that will replace the default weapon type.
range: the range of the attack.
physical: true if you want the weapon to deal phyisical damage. False if you want the weapon to deal magic damage.
Note that if the unit attacks from a range that is not specified on the custom parameter, the weapon type and type of damage will be the default used by the weapon.
Also, in the example used above, if the weapon belongs to the Sword weapon type and deals phyisical damage by default, then the object that specifies the damage at melee was not necessary.
That means that you don't need to specify the type of weapon and damage at ranges where the weapon uses its default values.
This plugin allows to make a untis learns skill at a specific level and class.
By default, the engine only lets you specify the level required to make an unit learn a skill, but with this you can also specify the class.
To make this, you need to assign a custom parameter 'skills' to the class.
Note that you don't have to assign the skills to the Learned Data of each unit. Ignore that part of the editor and just use the class custom parameter.
How to use
Here is an example of the custom parameter:
{skills: [ {id:4, level:10}, {id:7, level:15}, {id:12, level: 20} ]}
In this example, the class can learn three skills: it will learn the skill with ID 4 at level 10, the skill with ID 7 at level 15 and the skill with ID 12 at level 20.
Note that if, for some reason, the unit is over the required level and has not learned the skill, then the next time it levels up, it will learn the skill.
Also, if an unit changes to a different class, it may be able to learn a new skill, assuming that the unit has the required level.
This plugin contains a group of skills that allow to increase the range of a unit when using a weapon, staff and/or item.
It also comes with a way to make the range of a staff or item depend on the Mag stat of the unit.
Extended range skills
There are three skills that allows to change the range of weapons, items and staves.
The custom keyword for those skills are "WeaponRange" for weapons, "StaffRange" for staves and "ItemRange" for items.
To change the range, you use the custom parameter 'startRange' and 'endRange'. Those specify how much extra range have at the start and the end of the range, respectively.
Note that for weapons, you also need the custom parameter 'type', which specify the name of the weapon type that gets the extra range.
For example, an unit with a 2-3 range bow with a skill that has the following custom parameters:
{type:"Bow", startRange: -1, endRange: 2} will have 1-5 range instead.
Note that both startRange and endRange are optional. You can have one and remove the other.
By default, if the parameter is not specified, it is assumed the default value is zero.
Dynamic magic range
With this plugin, you can also make the range of a staff or item depend on the Magic stat of an unit.
To do this, you need to use the custom parameter 'magicRange' in the item.
The value of the parameter is a number that the Magic stat will be divided into.
For example, an unit with 5 Magic and an item with the parameter {magicRange: 2} will have range 2,
because 5/2 = 2.5, and if we round it down is 2.
This plugin changes how the Attack Count option works for weapons that use the custom parameter 'brave'.
Basically, an unit with a "brave" weapon will only attack once if it is the defending unit.
For example, a "Brave Sword" with an attack count of 2 will attack twice if the unit is the attacker, and it
will attack once if the unit is the defender.
To make a weapon use this restriction, you need to assign it the custom parameter {brave: true}
This plugin contains a collection of custom skills.
All of the skills are compatible with any other plugin, so even if you don't use some of them, they won't be a problem.
Below is a list of all the skills, along with their descriptions, custom keyword and custom parameters (if there have any):
Live to Serve
When healing an ally, the skill's user recovers the same amount of HP.
Custom keyword: "LiveToServe".
Custom parameters: none.
Critical Factor
Normally, the critical multiplier is the same for all the critical hits of all the units.
With this skill, a unit can have a different critical multiplier that the rest of the units.
Custom keyword: "CritFactor".
Custom parameter: "critFactor" - The critical multiplier for the unit. For example: {critFactor: 4}.
Wary Fighter
A unit with this skill can't double or be doubled. The exception are weapons that can attack more than once for round.
Custom keyword: "WaryFighter".
Custom parameters: none.
Extra Healing
A healer unit with this skill has bonus to all healing done. You can choose to make this skill work on all items or staves only.
Custom keyword: "ExtraHeal".
Custom parameters:
"wand": if this value is true, then the skill only works on staves. Otherwise, it works on all items.
"heal": the bonus healing for this unit. Example of this two parameters: {wand: true, heal: 5}.
Note: There is a graphical bug with this skill. If the healing item has the scope Self (also known as Single),
then the extra healing value will not be displayed correctly. The healing animations will still show the correct healing.
Movement skills
All these skills work similar, they all involve the skill user being adjacent to another unit and
changing the position of both or one of them. This skills only work for interacting between player's units, not for enemies or allies.
Shove - A unit can move another adjacent unit one space away from it.
Custom keyword: "Shove".
Custom parameter: "name" - The name of the skill command. If this parameter is not used, the command will be called "Shove".
Swap - Swaps the position between the skill user and another adjacent unit.
Custom keyword: "Swap".
Custom parameter: "name" - The name of the skill command. If this parameter is not used, the command will be called "Swap".
Smite - A unit can move another adjacent unit two spaces away from it.
Custom keyword: "Smite".
Custom parameter: "name" - The name of the skill command. If this parameter is not used, the command will be called "Smite".
Draw Back - Moves the skill's user one space away from the other unit. The other unit moves one space too, in the direction that makes both units keep being adjacent.
Custom keyword: "Draw Back".
Custom parameter: "name" - The name of the skill command. If this parameter is not used, the command will be called "Draw Back".
Pivot - Skill's user moves to the opposite side of target unit.
Custom keyword: "Pivot".
Custom parameter: "name" - The name of the skill command. If this parameter is not used, the command will be called "Pivot".
Reposition - The target unit moves to the opposite side of the skill's user.
Custom keyword: "Reposition".
Custom parameter: "name" - The name of the skill command. If this parameter is not used, the command will be called "Reposition".
Sacrifice
The skill's user can sacrifice its own HP to heal an adjacent unit. The amount of healing depends on the custom parameter.
If the unit doesn't have enought HP to sacrifice, it heals as much as possible, staying at 1 HP.
Custom keyword: "Sacrifice".
Custom parameters:
"name": The name of the skill command. If this parameter is not used, the command will be called "Sacrifice".
"healing": The amount of healing done.
Buff on Staff
A staff user with this skill can give a buff (state) to the units, when using staves over them.
You can choose which type of staff give this boost. For example, make healing staves and staves that cure states give the buff.
Custom keyword: "BuffWand".
Custom parameters:
"stateID": The ID of the state that represents the buff.
"type": a list of numbers, with each number being the type of staff that can give the buff. Here is the list of all the numbers and their meaning.
This plugin allows you to add "traits" to units and classes, similar to how the "Races" option works.
The main difference is that races can only be assigned to classes, while traits can be assigned to units and classes.
In order to display the traits that an unit has, a new window has been added to the unit menu screen.
How to create traits
Because traits are not something that comes with the engine, we will need to create an Original Data entry for each trait. In order to do this:
First, go to Tools->Options->Expert->Display original data on conifg tab and enable that option.
Now you can go to Database->Config->Original Data. This will take you to the Original Data window.
Inside, you have several tabs (default name go from tab 1 to tab 10). In the bottom left, you will find the "Create Original Data" button.
Once you have created an entry, you can select the icon, name and description. Only those values will be used for this plugin
Finally, to identify the entry as a trait, you need to fill the Keyword field with "Trait".
Note: all Original Data related to traits must be in the same tab.
You also need to specify which tab are you going to use in the config-traits.js file.
Configuration options
In the file config-traits.js you can modify some variables to change some of the settings.
ENABLE_WINDOW: This is the value that will enable or disable the traits window. By default it is true, so the window will be visible.
TAB_TRAITS: This is the tab that will be used in the Original Data window. Note that 0 is the first tab, 1 is the second tab, and so on.
MENU_TITLE: This is the string that will show up as the title of the traits window.
How to use custom parameters
There are several custom parameters that can be used in this script, but all of them work the same way.
They are arrays of numbers, where each number is the ID of an Original Data entry. For example: {trait: [2, 3]} or {effTrait: [6]}
Here is the list of custom parameters available to use:
"trait: Used for units and classes. An unit will have all the traits specified by itself and its current class.
"reqTrait": Used for weapons and items. To use the weapon/item, the unit must have all the traits specified by this parameter.
"effTrait": Used for weapons. An unit attacking with a weapon will deal effective damage if the target unit has at least one of the traits specified by this parameter.
"addTrait": Used for custom items. The item must have the keyword "Trait". When the item is used on an unit, that unit will obtain all the traits specified by the parameter.
Trait Event Command
You can create an event command that will add one trait to an unit.
To do this, create a Execute Script event command, select the Call Event Command type and, in the Object Name field, write "AddTrait".
Then, go to the Original Data tab and select the unit that will obtain the trait. Finally, use the Value 1 field to write the ID of the trait to add.
This plugin allows you to make individual ranks for each weapon type.
To make this work, is necessary to make several custom parameters on units, classes, weapons and staves.
Custom parameter "rank"
The parameter "rank" is used primarly for units, so they can have a base rank.
It can also be used on: classes, weapons (only the equipped weapon), items, skills (only if they are part of the "Parameter Bonus" category)
and states to give an additional bonus to the weapon ranks.
This parameter will have an array, with each element containing the name of a weapon type and the value associated with that rank.
For example, an unit with {rank: [["Sword", 31], ["Axe", 71]]}. In this case, the unit will have a D rank on swords and C rank on axes.
The values in the example are the default one used by rank-config-option.js (more details on this later).
If the unit does not have a parameter of a certain weapon, the default value is 0, meaning no rank on that weapon.
Even if the unit's class can use that weapon, if the unit doesn't have any rank on that weapon type, it can't use it.
It happens the same in the reverse case: if the unit has a parameter for a rank but their class can't use that weapon type, the unit won't be able to use it.
This can be a interesting feature if you want a unit to learn a new weapon type without changing class.
Note: It is very important that the name of the weapon type on the parameter matches exactly the name of the actual weapon type, otherwise it won't work.
Class parameters
The two parameters used by the class are "minRank" and "maxRank". "minRank" makes a certain rank the minimun rank obtained by a class,
while "maxRank" is the maximum rank obtainable by that class. For example, a class with {minRank: [ ["Axe", 31] ], maxRank: [ ["Sword", 181] ]},
will always have at least a D rank with axes, and won't be able to go beyond A rank with swords. If there is not a parameter on a certain weapon,
then there is no min and no max. In this example, it means this class doesn't have any minimun on swords, so it starts with E rank, and doesn't have
any maximum on axes, so it can reach S rank. This also applies to the other weapon types that this class can potentially use but are not in the custom parameters.
Weapon/staff parameters
There are two custom parameter for weapons and staves: they use parameter "req". This is the requirement to use that item.
They also use the parameter "wexp", that dictates how much weapon experience the unit earns by each use.
If the item is a weapon, they earn experience for each time they engage in combat with an enemy unit.
For example, a weapon with the parameters {req:"D", wexp:2}, would need a unit with a D rank on that weapon,
and that unit would gain 2 weapon experience.
Gaining skills when a weapon ranks up
You can make a unit gain a skill whenever it gets a rank up in a specific weapon type.
To do this, you use the custom parameter "rankSkills". For example:
{rankSkills: [ ["Sword", "D", 15], ["Sword", "C", 20], ["Lance", "C", 23] ] }
This makes the unit gain three different skills. First, it obtains the skill with ID 15 when it gets to rank D in swords.
Next, when it gets to C rank it obtains the skill with ID 20, and finally it obtains the skill with ID 23 when it gets to rank C in lances.
You assign the custom parameter to the unit, but if you want the skill to be earned universally, you assign them to the weapon type instead.
Note that the version of the weapon type uses the same name for the parameter, but it works differently. For example:
{rankSkills: [ ["D", 15], ["C", 20] ] }
In this case, every unit that reaches D rank with this weapon type will gain the skill with ID 15, and when it reaches C rank it will gain the skill with ID 20.
As you can probably tell, the difference is that you don't need to specify the weapon type.
Earning more weapon experience per battle
An unit with a custom skill with the "Discipline" custom keyword will be able to earn more weapon experience.
The amount of extra experience is defined with a custom parameter of the skill called "multiplier".
For example, if you want the unit to earn double the experience, you must write this in the skill: {multiplier:2}
Stat boosting items
There are 2 custom parameters that can only be used by Stat Boosting items. It won't work on any other type of items.
The first parameter is "rankUp". With this, you can increase the rank of one or more weapon types of a unit.
For example, a item with {rankUp: ["Sword", "Lance"]} will increase the rank of both weapon ranks by 1.
If the unit had C rank with swords and D rank with lances, it will have now B ranks with swords and C rank with lances.
The other parameter is "rankNew". If the unit doesn't know a weapon type, this adds the lowest rank possible to that weapon type.
For example, if a unit that only uses axes uses a item with {rankNew: ["Bow", "Magic"]} will get a E rank with bows and magic tomes.
Both of these parameter can be used at the same time with the same item, but if you have something like {rankUp: ["Sword"], rankNew: ["Sword"]},
then the units that don't use sword will only get E rank with swords. You can't make a unit learn a weapon type and increase their rank with the same item use.
Editable values
There is a file called rank-config-options that cointain some editable variables. This can be edited without code knowledge.
The options that can be edited are the values necessary to reach every weapon rank, the possibility to add more custom ranks,
and an option to remove from the weapon ranks window all the ranks unused by the unit.
About item types
This script considers item types the same as weapon types, so you can make your own item types besides the staff type, and they will work just like the others types.
But the item type called "Item" will never have a rank, so they can be used by anyone.
Also, if you have a weapon type and an item type have the same name, they will be considered to share the same rank.
This can be useful if, for example, you want some sort of magic that can attack with a weapon and heal with an item.
Changing the weapon experience gauge
By default, the gauge used in this script is one of the default assets. If you want to change that, you can either use another of the default assets of the software,
or you can use a custom gauge, as long as it has the same size and format than the default gagues.
To change it, you must use 2 global parameters. This can be done going to Databe->Config->Script->Global Parameters.
The parameters are "weaponRankGauge" and "isRuntimeGauge". The first one has as value the id of the desired gauge.
The second parameter has as value true if the gauge is a default asset, or false if the gauge is a custom asset.
For example, {weaponRankGauge:0, isRuntimeGauge:true} uses the default gauge used for the HP bar on the unit screen.
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 comes from Original Data entries.
Weapon and items
To make this system work, you need to do the following for each spell/weapon/item you create:
First, you need to create the weapon and add the custom parameter {magic: true}. This also applies to items.
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.
In the item option, select the weapon or magic that you will use.
Change the value in Value 1 to set the level requirement. If you leave it at zero, there is no level requirement.
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.
Note: 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
Configure 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 or 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 to add new weapons or items to a unit
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.
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.
For this, instead of using Original Data, you will use skills.
To do this, you make the same process as when you make any other skill weapon, except for these differences:
The weapon must have the custom parameter {ballista:true} instead of using the "magic" custom parameter.
The skill keyword must be "MapAttack". The custom parameter of the skill will need to be "weapon" with the ID of the weapon to use.
You also need to add the skill to the terrain that is assigned to the ballista tile. This is done in the Optional Skills option of the terrain.
Inside an Opening event, you need to make a Execute Script event command of the type Execute Code with the following line of code:
BallistaControl.addBallista();
Finally, you need to 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} ]}
means that in the tiles (5, 3) and (0, 7) there are ballista tiles. Those units that can be use the weapon assigned to the skill with ID 32
will be able to deal the attack.