Z-Move Add On

[felidaex]

I've been trying to implement the move-z for a while, but it doesn't work for me.

 

[WolfPP]

I've been trying to implement the move-z for a while, but it doesn't work for me.

Read all posts into the thread. Maybe some of them can help you.

 

[felidaex]

In the end all the thread served me and it works.
Thank you

I am trying to put the scrip in a Spanish edition, but I ended up having these problems.

---------------------------
Pokemon Essentials Esp v16.2
---------------------------
Excepción: NoMethodError

Mensaje: undefined method `zmove' for #<PokeBattle_Move_02E:0xc150c50>

PokeBattle_Battle:1098:in `pbPriority'

PokeBattle_Battle:1089:in `each'

PokeBattle_Battle:1089:in `pbPriority'

PokeBattle_Battle:3024:in `__clauses__pbEndOfRoundPhase'

PokeBattle_Clauses:42:in `pbEndOfRoundPhase'

PokeBattle_Battle:2658:in `pbStartBattleCore'

PokeBattle_Battle:2657:in `logonerr'

PokeBattle_Battle:2657:in `pbStartBattleCore'

PokeBattle_Battle:2639:in `loop'

PokeBattle_Battle:2662:in `pbStartBattleCore'



Esta excepción ha sido registrada en

C:\Users\Usuario\Saved Games/Pokemon Essentials Esp v16_2/errorlog.txt.

Presiona Ctrl+C para copiar este mensaje al portapapeles.
---------------------------
Aceptar
---------------------------






---------------------------
Pokemon Essentials Esp v16.2
---------------------------
Excepción: NoMethodError

Mensaje: undefined method `zmove' for #<PokeBattle_Move_02E:0xc150c50>

PokeBattle_Battle:1098:in `pbPriority'

PokeBattle_Battle:1089:in `each'

PokeBattle_Battle:1089:in `pbPriority'

PokeBattle_Battle:2852:in `pbAttackPhase'

PokeBattle_Battle:2654:in `pbStartBattleCore'

PokeBattle_Battle:2653:in `logonerr'

PokeBattle_Battle:2653:in `pbStartBattleCore'

PokeBattle_Battle:2639:in `loop'

PokeBattle_Battle:2662:in `pbStartBattleCore'

PokeBattle_Battle:2456:in `pbStartBattle'



Esta excepción ha sido registrada en

C:\Users\Usuario\Saved Games/Pokemon Essentials Esp v16_2/errorlog.txt.

Presiona Ctrl+C para copiar este mensaje al portapapeles.
---------------------------
Aceptar
---------------------------




---------------------------
Pokemon Essentials Esp v16.2
---------------------------
Excepción: NameError

Mensaje: uninitialized constant PokeBattle_Battle::NO_Z_MOVE

PokeBattle_Battle:1827:in `pbCanZMove?'

PokeBattle_AI:4019:in `pbEnemyShouldZMove?'

PokeBattle_AI:4322:in `pbDefaultChooseEnemyCommand'

PokeBattle_Scene:2784:in `pbChooseEnemyCommand'

PokeBattle_Battle:2714:in `pbCommandPhase'

PokeBattle_Battle:2709:in `each'

PokeBattle_Battle:2709:in `pbCommandPhase'

PokeBattle_Battle:2650:in `pbStartBattleCore'

PokeBattle_Battle:2649:in `logonerr'

PokeBattle_Battle:2649:in `pbStartBattleCore'



Esta excepción ha sido registrada en

C:\Users\Usuario\Saved Games/Pokemon Essentials Esp v16_2/errorlog.txt.

Presiona Ctrl+C para copiar este mensaje al portapapeles.
---------------------------
Aceptar
---------------------------

 

[WolfPP]

In the end all the thread served me and it works.
Thank you

I am trying to put the scrip in a Spanish edition, but I ended up having these problems.

---------------------------
Pokemon Essentials Esp v16.2
---------------------------
Excepción: NoMethodError

Mensaje: undefined method `zmove' for #<PokeBattle_Move_02E:0xc150c50>

PokeBattle_Battle:1098:in `pbPriority'

PokeBattle_Battle:1089:in `each'

PokeBattle_Battle:1089:in `pbPriority'

PokeBattle_Battle:3024:in `__clauses__pbEndOfRoundPhase'

PokeBattle_Clauses:42:in `pbEndOfRoundPhase'

PokeBattle_Battle:2658:in `pbStartBattleCore'

PokeBattle_Battle:2657:in `logonerr'

PokeBattle_Battle:2657:in `pbStartBattleCore'

PokeBattle_Battle:2639:in `loop'

PokeBattle_Battle:2662:in `pbStartBattleCore'



Esta excepción ha sido registrada en

C:\Users\Usuario\Saved Games/Pokemon Essentials Esp v16_2/errorlog.txt.

Presiona Ctrl+C para copiar este mensaje al portapapeles.
---------------------------
Aceptar
---------------------------






---------------------------
Pokemon Essentials Esp v16.2
---------------------------
Excepción: NoMethodError

Mensaje: undefined method `zmove' for #<PokeBattle_Move_02E:0xc150c50>

PokeBattle_Battle:1098:in `pbPriority'

PokeBattle_Battle:1089:in `each'

PokeBattle_Battle:1089:in `pbPriority'

PokeBattle_Battle:2852:in `pbAttackPhase'

PokeBattle_Battle:2654:in `pbStartBattleCore'

PokeBattle_Battle:2653:in `logonerr'

PokeBattle_Battle:2653:in `pbStartBattleCore'

PokeBattle_Battle:2639:in `loop'

PokeBattle_Battle:2662:in `pbStartBattleCore'

PokeBattle_Battle:2456:in `pbStartBattle'



Esta excepción ha sido registrada en

C:\Users\Usuario\Saved Games/Pokemon Essentials Esp v16_2/errorlog.txt.

Presiona Ctrl+C para copiar este mensaje al portapapeles.
---------------------------
Aceptar
---------------------------




---------------------------
Pokemon Essentials Esp v16.2
---------------------------
Excepción: NameError

Mensaje: uninitialized constant PokeBattle_Battle::NO_Z_MOVE

PokeBattle_Battle:1827:in `pbCanZMove?'

PokeBattle_AI:4019:in `pbEnemyShouldZMove?'

PokeBattle_AI:4322:in `pbDefaultChooseEnemyCommand'

PokeBattle_Scene:2784:in `pbChooseEnemyCommand'

PokeBattle_Battle:2714:in `pbCommandPhase'

PokeBattle_Battle:2709:in `each'

PokeBattle_Battle:2709:in `pbCommandPhase'

PokeBattle_Battle:2650:in `pbStartBattleCore'

PokeBattle_Battle:2649:in `logonerr'

PokeBattle_Battle:2649:in `pbStartBattleCore'



Esta excepción ha sido registrada en

C:\Users\Usuario\Saved Games/Pokemon Essentials Esp v16_2/errorlog.txt.

Presiona Ctrl+C para copiar este mensaje al portapapeles.
---------------------------
Aceptar
---------------------------

Well, you are using v16.2, so download Pokemon Reborn and copy its script about Z-move, because they use v16 or v16.2. Remember to give credit to them.

 

[mybusiness]

Could someone indicate how to change the move selection when z-button is switched?

 

[Gammazeth]

The button doesn't even appear for me :/

 

[Gammazeth]

Can anyone help me with that ?

 

[MillaLya]

Um, does anyone have an idea how could I put moves like Z-Metronome or Z-Assist to work under this framework?
I've dug into the code and realized that the script decides what a damaging move becomes using the Z-crystal held by the user, which confuses me on how could I utilize the existing part to script moves that turn the randomly chosen move into a Z-move.

 

[Maq47]

You have to replace your script file in the Data folder.

@Tea-Rex, can you provide a version made from Pokemon Essentials v15? I want to port these features to a friend's fan game. Thanks.

 

[yiormari]

Hi when i use a z-move, ocurried an error with ability ismoveDance?

somebody help me plis, sorry for my english

 

[WolfPP]

Hi when i use a z-move, ocurried an error with ability ismoveDance?

somebody help me plis, sorry for my english

Why you have 'ismoveDance'? Oo Delete it and try again.

 

[PauloJugoslavia]

Does anybody have the scripts or plans to make them, for the Z-Moves introduced in USUM?

 

[Swapnil2305]

I have a problem that for the z move.rxdata my day and night system in my game isn't working
Thanks

 

[grisHarlequin]

Heyo!
I tried the same as WolfPP and replaced the zmove scripts onto my script. And Z moves work pretty well, only I'm getting two problems.
1. After doing a z move once, I can do Z move again. Where do I control when the Z move can;t be repeated?
2. When doing damage against an ability like "iron barbs" there's an error message when it comes in contact with the opposite pokemon.

Spoiler:

[Pokémon Essentials version 17.2]
Exception: ArgumentError
Message: wrong number of arguments(1 for 0)
PokeBattle_Battler:2011:in `isContactMove?'
PokeBattle_Battler:2011:in `pbEffectsOnDealingDamage'
PokeBattle_Battler:3730:in `pbProcessMoveAgainstTarget'
PokeBattle_Battler:3611:in `each'
PokeBattle_Battler:3611:in `pbProcessMoveAgainstTarget'
PokeBattle_ZMoves:80:in `initialize'
PokeBattle_Battle:1845:in `new'
PokeBattle_Battle:1845:in `pbUseZMove'
PokeBattle_Battler:4455:in `pbProcessTurn'
PokeBattle_Battle:2970:in `pbAttackPhase'

I tried it on a clean slate and this error message doesn't appear. So it's probably conflicting with something I have. Does this error log tell anyone where I could solve the mistake? I'm kind of new to troubleshooting so I am having some issues.

THe alternative would be to start from scratch using the Z move script and add all the other scripts I have been adding before one by one. I'd rather not have to do that, so if anyone can help me find the source of these mistakes I'd appreciate it a lot!

 

[Golisopod User]

Heyo!
I tried the same as WolfPP and replaced the zmove scripts onto my script. And Z moves work pretty well, only I'm getting two problems.
1. After doing a z move once, I can do Z move again. Where do I control when the Z move can;t be repeated?
2. When doing damage against an ability like "iron barbs" there's an error message when it comes in contact with the opposite pokemon.

Spoiler:

[Pokémon Essentials version 17.2]
Exception: ArgumentError
Message: wrong number of arguments(1 for 0)
PokeBattle_Battler:2011:in `isContactMove?'
PokeBattle_Battler:2011:in `pbEffectsOnDealingDamage'
PokeBattle_Battler:3730:in `pbProcessMoveAgainstTarget'
PokeBattle_Battler:3611:in `each'
PokeBattle_Battler:3611:in `pbProcessMoveAgainstTarget'
PokeBattle_ZMoves:80:in `initialize'
PokeBattle_Battle:1845:in `new'
PokeBattle_Battle:1845:in `pbUseZMove'
PokeBattle_Battler:4455:in `pbProcessTurn'
PokeBattle_Battle:2970:in `pbAttackPhase'

I tried it on a clean slate and this error message doesn't appear. So it's probably conflicting with something I have. Does this error log tell anyone where I could solve the mistake? I'm kind of new to troubleshooting so I am having some issues.

THe alternative would be to start from scratch using the Z move script and add all the other scripts I have been adding before one by one. I'd rather not have to do that, so if anyone can help me find the source of these mistakes I'd appreciate it a lot!

Don't use the WolfPP version, it uses many custom scripts, it's not a clean version of Essentials. Try using the Tea Rex version.

 

[MrDoomKan]

Does any one have a version of this script without replacing the scripts.rxdata file cause i don't want to delete all my scripts i put in my game

 

[Golisopod User]

Does any one have a version of this script without replacing the scripts.rxdata file cause i don't want to delete all my scripts i put in my game

Look at the changes.txt and copy the changes over your scripts.rxdata

 

[StCooler]

EDIT: This post is outdated. If you want Z-moves for Essentials v18.dev, see this post.

This post is left unchanged inside the "spoiler" just in case someone needs the installation instructions, in order to uninstall the plugin.
YOU SHOULD NOT BE USING THIS SCRIPT ANYMORE.

Spoiler:

Hey.

I don't know if someone is working on translating this script to Essentials v18. I made this script work with Essentials v18.dev, which is the current version on GitHub, updated to Gen 8 mechanics, and which is unofficially released in the Gen 8 Project by UberDunsparce.
As far as I know, v18.dev (should be close to the next release v18.2 when I am writing these lines) mainly adds everything Gen-8, and minor bug fixes. So this plugin should also work for v18 and v18.1, even if some lines may read differently. However, I haven't tested my code for v18 and v18.1.


Z-Move plugin for Essentials v18.dev

CAUTION

As of 2021-01-11, I am working with Lucidious89 (who is behind the Dynamax plugin) in order to release a joint plugin containing Dynamax + Z-moves + Ultra-Burst.
If you download the current Z-move script, be ready to update it in a close future.

Main changes:

• PokeBattle_ZMove now is a subclass of PokeBattle_Move
• Most of the code consisting in big "if"-s was refactored. In fact, this code is hidden in a search in a new compiled file "zmovecomp.dat"
• This compiled file comes with its PBS file "zmovecomp.txt"
• The new Z-moves from Ultra-Sun/Ultra-Moon were also added. However, Ultra-Burst is not added.
• I also give a tutorial on how to add a new Z-move, now that I have changed everything in the base script.

How to install:

Spoiler:

The easy part (file additions):

Spoiler:

Merge the Data folder from the plugin, with your Data folder. I promise there will be no conflict between my files and yours.

Just so you can check, the plugin folder contains:

• Data\Scripts\012_Battle\002_Move\009_PokeBattle_ZMove.rb
• Data\Scripts\012_Battle\002_Move\010_ZMove_Effects.rb
• Data\Scripts\012_Battle\002_Move\011_Compiler_ZMoves.rb

These files should appear at the right place in your folder after the merge.

EDIT: If you use v18 or v18.1

Spoiler:

In the file Data\Scripts\012_Battle\002_Move\009_PokeBattle_ZMove.rb, find the code for pbModifyDamage(), and comment the line:

        opponent.effects[PBEffects::Obstruct] ||

This effect handles the protection move of Obstagoon, which is undefined in v18 and v18.1.

Besides, copy and paste the content of:

• PBS\items.txt
• PBS\moves.txt

inside your own items.txt and moves.txt files.
BE CAREFUL WITH THE IDS, check for any conflict between the given IDs here and the ones in your file.

Also copy-paste the file:

PBS\zmovescomp.txt

in your PBS folder.

Finally, merge the Graphics folder with your own Graphics folder ; beware of conflicts with the items icons.

Now is the tricky part. You'll have to manually add the plugin code to your code.

FILE: Data\Scripts\001_Settings.rb

Spoiler:

Just below the line:

NO_MEGA_EVOLUTION         = 34

add:

NO_Z_MOVE                 = 34

Note: This value controls the Game Switch that allows Z-Moves. If $game_switches[NO_Z_MOVE] is set to true, then no Z-Move will be allowed. In this plugin, I set this value to 34 so that Mega-Evolutions and Z-Moves are paired together (i.e. if you allow Z-Moves then you allow Mega-Evolutions, if you disallow either, you disallow both). If you don't like this behaviour, change this "34" to another value corresponding to another available switch.

FILE: Data\Scripts\012_Battle\001_Battler\001_PokeBattle_Battler.rb

Spoiler:

Find the header:

  #=============================================================================
  # Display-only properties
  #=============================================================================

Just above that header, paste this:

  #=============================================================================
  # Z-Moves 
  #=============================================================================
  
  def pbZCrystalFromType(type)
    zmovecomps = pbLoadZMoveCompatibility
  
    zmovecomps.each { |comp|
      next if !comp[PBZMove::REQ_TYPE]
      next if comp[PBZMove::REQ_TYPE] != type
      return comp[PBZMove::HELD_ZCRYSTAL]
    }
    return nil 
  end
  
  def hasZMove?
    zmovedata = pbGetZMoveDataIfCompatible(self.pokemon, self.item)
    return zmovedata != nil 
  end    
  
  def pbCompatibleZMoveFromMove?(move)  
    zmovedata = pbGetZMoveDataIfCompatible(self.pokemon, self.item, move)
    return zmovedata != nil 
  end
  
  def pbCompatibleZMoveFromIndex?(moveindex)
    return pbCompatibleZMoveFromMove?(self.moves[moveindex])
  end

This part is mainly for condition checking.

Then, find the definition of unlosableItem?:

  def unlosableItem?(check_item)

and in this definition, below the line:

    return true if pbIsMail?(check_item)

add:

    return true if pbIsZCrystal?(item)

This just makes the Z-Crystals unlosable (e.g. for Knock-Off).

FILE: Data\Scripts\012_Battle\001_Battler\007_Battler_UseMove.rb

Spoiler:

In the definition of pbProcessTurn:

  def pbProcessTurn(choice,tryFlee=true)

find the code:

    # Use the move
    PBDebug.log("[Move usage] #{pbThis} started using #{choice[2].name}")
    PBDebug.logonerr{
      pbUseMove(choice,choice[2][email protected])
    }

And replace it with:

    if choice[2].zmove 
      # Use Z-Moves 
      choice[2].zmove=false
      @battle.pbUseZMove(self.index,choice[2],self.item)
    else
      # Use the move
      PBDebug.log("[Move usage] #{pbThis} started using #{choice[2].name}")
      PBDebug.logonerr{
        pbUseMove(choice,choice[2][email protected])
      }
    end

This code handles the actual use of Z-Moves in battle. The activation is handled elsewhere, we'll come to it.

Then, in the definition of pbUseMoveSimple:

  def pbUseMoveSimple(moveID,target=-1,idxMove=-1,specialUsage=true)

find the line:

    pbUseMove(choice,specialUsage)

and replace it with:

    side=(@battle.opposes?(self.index)) ? 1 : 0
    [email protected](self.index)
    if @battle.zMove[side][owner]==self.index
      crystal = pbZCrystalFromType(choice[2].type)
      # zmove = PokeBattle_ZMove.new(@battle,self,choice[2],crystal)
      zmove = PokeBattle_ZMove.pbFromOldMoveAndCrystal(@battle,self,choice[2],crystal)
      zmove.pbUse(self, choice)
    else
      pbUseMove(choice,specialUsage)
    end

Z-Moves have a different usage to moves, that's why it's handled differently here.

FILE: Data\Scripts\012_Battle\001_Battler\009_Battler_UseMove_SuccessChecks.rb

Spoiler:

In the definition of pbSuccessCheckAgainstTarget:

  def pbSuccessCheckAgainstTarget(move,user,target)

find this line:

    if move.canProtectAgainst?

and replace it with:

    if move.canProtectAgainst? && !move.is_zmove

This ensures that Z-moves can't be protected (the damage decrease is handled elsewhere).

FILE: Data\Scripts\012_Battle\002_Move\001_PokeBattle_Move.rb

Spoiler:

In the class PokeBattle_Move, in the declaration of attributes, replace:

  attr_reader   :name

with:

  attr_accessor :name

Just below the definition of the attributes, add the following lines:

  attr_accessor :zmove # True if the player triggered the Z-Move
  attr_accessor :is_zmove # True only if the move is an actual Z-Move.

In the definition of the constructor:

  def initialize(battle,move)

go to the last line:

    @snatched   = false

and add below:

    @zmove      = false
    @is_zmove   = false

These are slight changes to make the difference between normal moves and Z-moves.

FILE: Data\Scripts\012_Battle\003_Battle\002_PokeBattle_Battle.rb

Spoiler:

In the definition of the constructor:

  def initialize(scene,p1,p2,player,opponent)

find the following lines:

    @megaEvolution     = [
       [-1] * (@player ? @player.length : 1),
       [-1] * (@opponent ? @opponent.length : 1)
    ]

and just add the following lines below:

    @zMove             = [
       [-1] * (@player ? @player.length : 1),
       [-1] * (@opponent ? @opponent.length : 1)
    ]

This new attribute stores the status of Z-moves usage. @zMove[side][t] can take the values:

• -1 if the trainer with index "t" has not used a Z-move yet.
• >=0 if the trainer with index "t" has selected a Z-move.
• -2 if the trainer with inder "t" has used a Z-move (and can't anymore for the rest of the battle).

FILE: Data\Scripts\012_Battle\003_Battle\006_Battle_Action_Switching.rb

Here, this is tricky.

For Essentials v18 and v18.1:

Spoiler:

I have not tested this on v18 and v18.1, because Healing Wish and Lunar Dance are handled differently. But still, here is something you should try.

In the definition of pbOnActiveOne:

  def pbOnActiveOne(battler)

find the code for Lunar Dance:

    # Lunar Dance
    if @positions[battler.index].effects[PBEffects::LunarDance]
      pbCommonAnimation("LunarDance",battler)
      pbDisplay(_INTL("{1} became cloaked in mystical moonlight!",battler.pbThis))
      battler.pbRecoverHP(battler.totalhp)
      battler.pbCureStatus(false)
      battler.eachMove { |m| m.pp = m.totalpp }
      @positions[battler.index].effects[PBEffects::LunarDance] = false
    end

and just below, paste this:

    if @positions[battler.index].effects[PBEffects::ZHeal]
      pbCommonAnimation("ZHeal",battler)
      pbDisplay(_INTL("The Z-Power healed {1}!",battler.pbThis))
      battler.pbRecoverHP(battler.totalhp)
      @positions[battler.index].effects[PBEffects::ZHeal] = false
    end

Note that this code doesn't handle the change in mechanics introduced in Gen 8, in which Lunar Dance / Healing Wish only activate if the entering battler has a status or is not full HP.
By the way, Z-Heal is the effect triggered by Z-Memento and Z-Parting shot, that makes a weak copy of Lunar Dance / Healing Wish.

For Essentials v18.dev:

Spoiler:

In the definition of pbActivateHealingWish:

  def pbActivateHealingWish(battler)

and just before the end of the definition, paste this code:

    # Z-Parting shot/Z-Memento 
    if @positions[battler.index].effects[PBEffects::ZHeal] && battler.canHeal?
      pbCommonAnimation("ZHeal",battler)
      pbDisplay(_INTL("The Z-Power healed {1}!",battler.pbThis))
      battler.pbRecoverHP(battler.totalhp)
      @positions[battler.index].effects[PBEffects::ZHeal] = false
    end

If you're a hardcore coder, in the definition of pbOnActiveOne:

  def pbOnActiveOne(battler)

find this comment:

	# Healing Wish / Lunar Dance

and replace it with:

    # Healing Wish / Lunar Dance / Z-Parting shot/Z-Memento

FILE: Data\Scripts\012_Battle\003_Battle\009_Battle_Action_Other.rb

Spoiler:

At the end of the definition of the class PokeBattle_Battle, right below the section handling the Primal-thing, paste this code:

  #=============================================================================
  # Use Z-Move.
  #=============================================================================
  def pbCanZMove?(index)
    return false if $game_switches[NO_Z_MOVE]
    return false if !@battlers[index].hasZMove? 
    return false if !pbHasZRing(index) 
    side=(opposes?(index)) ? 1 : 0
    owner=pbGetOwnerIndexFromBattlerIndex(index)
    return false if @zMove[side][owner]!=-1 
    return true
  end

  def pbRegisterZMove(index)
    side=(opposes?(index)) ? 1 : 0
    owner=pbGetOwnerIndexFromBattlerIndex(index)
    @zMove[side][owner]=index
  end
  
  def pbUnregisterZMove(idxBattler)
    side  = @battlers[idxBattler].idxOwnSide
    owner = pbGetOwnerIndexFromBattlerIndex(idxBattler)
    @zMove[side][owner] = -1 if @zMove[side][owner]==idxBattler
  end
  
  def pbToggleRegisteredZMove(idxBattler)
    side  = @battlers[idxBattler].idxOwnSide
    owner = pbGetOwnerIndexFromBattlerIndex(idxBattler)
    if @zMove[side][owner]==idxBattler
      @zMove[side][owner] = -1
    else
      @zMove[side][owner] = idxBattler
    end
  end
  
  def pbRegisteredZMove?(idxBattler)
    side  = @battlers[idxBattler].idxOwnSide
    owner = pbGetOwnerIndexFromBattlerIndex(idxBattler)
    return @zMove[side][owner]==idxBattler
  end
  
  def pbUseZMove(index,move,crystal)
    return if !@battlers[index] || !@battlers[index].pokemon
    return if !(@battlers[index].hasZMove? rescue false)
    ownername=pbGetOwnerName(index)
    pbDisplay(_INTL("{1} surrounded itself with its Z-Power!",@battlers[index].pbThis))         
    pbCommonAnimation("ZPower",@battlers[index],nil)        
    # pbMessage("Move: " + move.name)
    zmove = PokeBattle_ZMove.pbFromOldMoveAndCrystal(self,@battlers[index],move,crystal)
    zmove.pbUse(@battlers[index])
    side=@battlers[index].idxOwnSide
    owner=pbGetOwnerIndexFromBattlerIndex(index)
    @zMove[side][owner]=-2
  end
  
  def pbHasZRing(battlerIndex)
    return true if !pbOwnedByPlayer?(battlerIndex)
    for i in MEGA_RINGS
      next if !hasConst?(PBItems,i)
      return true if $PokemonBag.pbQuantity(i)>0
    end
    return false
  end  
  
  def zMove
    return @zMove
  end

Be careful that this code should be inside the code of the class, so there should be another "end" right below the code I am giving here.

FILE: Data\Scripts\012_Battle\003_Battle\010_Battle_Phase_Command.rb

Spoiler:

In the definition of pbCancelChoice:

  def pbCancelChoice(idxBattler)

find the line:

    pbUnregisterMegaEvolution(idxBattler)

and below, add:

    pbUnregisterZMove(idxBattler)

In the definition of pbFightMenu:

  def pbFightMenu(idxBattler)

find this code:

    @scene.pbFightMenu(idxBattler,pbCanMegaEvolve?(idxBattler)) { |cmd|
      case cmd
      when -1   # Cancel
      when -2   # Toggle Mega Evolution
        pbToggleRegisteredMegaEvolution(idxBattler)
        next false
      when -3   # Shift
        pbUnregisterMegaEvolution(idxBattler)
        pbRegisterShift(idxBattler)
        ret = true
      else      # Chose a move to use
        next false if cmd<0 || !@battlers[idxBattler].moves[cmd] ||
                                @battlers[idxBattler].moves[cmd].id<=0
        next false if !pbRegisterMove(idxBattler,cmd)
        next false if !singleBattle? &&
           !pbChooseTarget(@battlers[idxBattler],@battlers[idxBattler].moves[cmd])
        ret = true
      end
      next true
    }

and replace it with:

    canMegaEvolve = pbCanMegaEvolve?(idxBattler)
    canZMove = pbCanZMove?(idxBattler)
    @scene.pbFightMenu(idxBattler, canMegaEvolve, canZMove) { |cmd|
      case cmd
      when -1   # Cancel
      when -2   # Toggle Mega Evolution / Z-Move
        pbToggleRegisteredMegaEvolution(idxBattler) if canMegaEvolve
        pbToggleRegisteredZMove(idxBattler) if canZMove
        next false
      when -3   # Shift
        pbUnregisterMegaEvolution(idxBattler)
        pbUnregisterZMove(idxBattler)
        pbRegisterShift(idxBattler)
        ret = true
      else      # Chose a move to use
        next false if cmd<0 || !@battlers[idxBattler].moves[cmd] ||
                                @battlers[idxBattler].moves[cmd].id<=0
        next false if !pbRegisterMove(idxBattler,cmd)
        next false if !singleBattle? &&
           !pbChooseTarget(@battlers[idxBattler],@battlers[idxBattler].moves[cmd])
        ret = true
      end
      next true
    }

This is the back-end code for the selection of the Z-move (the internal management of the activation/cancelation of Z-moves).

FILE: Data\Scripts\012_Battle\003_Battle\011_Battle_Phase_Attack.rb

Spoiler:

In the definition of pbAttackPhase:

  def pbAttackPhase

find the lines:

    PBDebug.log("")
    # Calculate move order for this round
    pbCalculatePriority(true)

add this ABOVE them:

    # Prepare for Z Moves
    @battlers.each_with_index do |b,i|
      next if !b || b.fainted?
      next if @choices[i][0]!=:UseMove
      side=(opposes?(i)) ? 1 : 0
      owner=pbGetOwnerIndexFromBattlerIndex(i)
      @choices[i][2].zmove=(@zMove[side][owner]==i)
    end

This code "marks" the chosen move to be transformed into a Z-move.

FILE: Data\Scripts\012_Battle\004_AI\001_PokeBattle_AI.rb

Spoiler:

Just above the definition of pbDefaultChooseEnemyCommand:

  #=============================================================================
  # Choose an action
  #=============================================================================
  def pbDefaultChooseEnemyCommand(idxBattler)

paste the following code above:

  #=============================================================================
  # Decide whether the opponent should use a Z-Move.
  #=============================================================================
  def pbEnemyShouldZMove?(index)
    # If all opposing have less than half HP, then don't Z-Move.
    return false if [email protected]?(index) #Conditions based on effectiveness and type handled later  
    
    @battle.battlers[index].eachOpposing { |opp|
      return true if opp.hp>(opp.totalhp/2).round
    }
    return false 
  end    
  
  def pbChooseEnemyZMove(index)  #Put specific cases for trainers using status Z-Moves
    # Choose the move.
    chosenmove=false
    chosenindex=-1
    attacker = @battle.battlers[index]
    for i in 0..3
      move=attacker.moves[i]
      if attacker.pbCompatibleZMoveFromMove?(move)
        if !chosenmove
          chosenindex = i
          chosenmove=move
        else
          if move.baseDamage>chosenmove.baseDamage
            chosenindex=i
            chosenmove=move
          end          
        end
      end
    end   
    target_i = nil
    target_eff = 0 
    # Choose the target
    attacker.eachOpposing { |opp|
      temp_eff = chosenmove.pbCalcTypeMod(chosenmove.type,attacker,opp)        
      if temp_eff > target_eff
        target_i = opp.index
        target_eff = target_eff
      end 
    }
    @battle.pbRegisterZMove(index)
    @battle.pbRegisterMove(index,chosenindex,false)
    @battle.pbRegisterTarget(index,target_i)
  end

And then, in the definition of pbDefaultChooseEnemyCommand(idxBattler)

  def pbDefaultChooseEnemyCommand(idxBattler)

just below the line:

    @battle.pbRegisterMegaEvolution(idxBattler) if pbEnemyShouldMegaEvolve?(idxBattler)

paste this:

    if pbEnemyShouldZMove?(idxBattler)
      pbChooseEnemyZMove(idxBattler)
      return 
    end

FILE: Data\Scripts\012_Battle\005_Battle scene\005_PokeBattle_SceneMenus.rb

Spoiler:

In the definition of the class FightMenuDisplay:

class FightMenuDisplay < BattleMenuBase

just below the line:

  attr_reader :shiftMode

paste this:

  attr_reader :zbutton

In the constructor:

  def initialize(viewport,z)

find the code:

    if USE_GRAPHICS

and paste this ABOVE:

    @zbutton   = 0
    # Z-Move addition: same as @mode

In that same function, find:

      @megaEvoBitmap = AnimatedBitmap.new(_INTL("Graphics/Pictures/Battle/cursor_mega"))

and paste this below:

      @zmoveBitmap   = AnimatedBitmap.new(_INTL("Graphics/Pictures/Battle/cursor_zmove"))

Below the line:

      addSprite("megaButton",@megaButton)

add the following lines:

      # Create Z-Move button
      @zmoveButton = SpriteWrapper.new(viewport)
      @zmoveButton.bitmap = @zmoveBitmap.bitmap
      @zmoveButton.x      = self.x+146
      @zmoveButton.y      = [email protected]/2
      @zmoveButton.src_rect.height = @zmoveBitmap.height/2
      addSprite("zmoveButton",@zmoveButton)

In the definition of the dispose function:

  def dispose

find the line:

    @megaEvoBitmap.dispose if @megaEvoBitmap

and below that, paste:

    @zmoveBitmap.dispose if @zmoveBitmap

ABOVE the definition of refreshButtonNames:

  def refreshButtonNames

add this: (ABOVE)

  def zbutton=(value)
    oldValue = @zbutton
    @zbutton = value
    refreshZButton if @zbutton!=oldValue
  end

And ABOVE the function:

  def refresh

add this:

  def refreshZButton
    return if !USE_GRAPHICS
    @zmoveButton.src_rect.y    = (@zbutton - 1) * @zmoveBitmap.height / 2
    @zmoveButton.z             = self.z - 1
    @visibility["zmoveButton"] = (@zbutton > 0)
  end

And IN the refresh function:

  def refresh

Just below the line:

    refreshMegaEvolutionButton

add:

    refreshZButton

This attribute handles the activation of Z-moves, from the player side.
zbutton = 0 if the button should not be visible (Z-move not allowed)
zbutton = 1 if the button should be visible but not pressed
zbutton = 2 if the button should be visible and pressed.

FILE: Data\Scripts\012_Battle\005_Battle scene\008_Scene_Commands.rb

Spoiler:

Replace the signature of pbFightMenu:

  def pbFightMenu(idxBattler,megaEvoPossible=false)

with:

  def pbFightMenu(idxBattler,megaEvoPossible=false,zmovePossible=false)

In that same function, find the line:

    cw.setIndexAndMode(moveIndex,(megaEvoPossible) ? 1 : 0)

and paste above:

    # Z-Moves have priority over Mega-Evolutions
    megaEvoPossible = false if zmovePossible

In the same function, find the lines:

        pbPlayDecisionSE
        break if yield cw.index

and replace them with:

        if cw.zbutton == 2 && !battler.pbCompatibleZMoveFromIndex?(cw.index)
          pbPlayCancelSE
          @battle.pbDisplay(_INTL("{1} is not compatible with {2}!",PBMoves.getName(battler.moves[cw.index]),PBItems.getName(battler.item)))   
          break if yield -1
        else 
          pbPlayDecisionSE
          break if yield cw.index
        end

The value yielded here will be caught by the function: pbFightMenu(idxBattler) in the file Data\Scripts\012_Battle\003_Battle\010_Battle_Phase_Command.rb that we altered before.

Finally, find the lines:

      elsif Input.trigger?(Input::A)   # Toggle Mega Evolution
        if megaEvoPossible

and replace them with:

      elsif Input.trigger?(Input::A)   # Toggle Mega Evolution/Z-Moves.
        if megaEvoPossible || zmovePossible

FILE: Data\Scripts\012_Battle\005_PBEffects.rb

Spoiler:

Find the line:

    WishMaker                 = 8

and add this line below:

    ZHeal                     = 9

Again, if you have new effects, you should adapt the number.

FILE: Data\Scripts\012_Battle\006_Other battle types\007_PokeBattle_DebugScene.rb

Spoiler:

Replace the definition of pbFightMenu:

  def pbFightMenu(idxBattler,megaEvoPossible=false)

with the new definition:

  def pbFightMenu(idxBattler,megaEvoPossible=false,zmovePossible=false)

This is just in case. I suspect this pbFightMenu should be paired with the function we updated before in 012_Battle\005_Battle scene\008_Scene_Commands.rb

FILE: Data\Scripts\012_Battle\010_PokeBattle_ActiveField.rb

Spoiler:

Find the definition of the class:

  class PokeBattle_ActivePosition

In the initialize function:

    def initialize

Find the line:

      @effects[PBEffects::WishMaker]                 = -1

And add below:

      @effects[PBEffects::ZHeal]                     = false

This ensures the Z-Heal effect is initialised and set to false at the beginning of any battle.

FILE: Data\Scripts\015_Items\001_PItem_Items.rb

Spoiler:

Just above the function pbIsImportantItem

def pbIsImportantItem?(item)

paste this code:

def pbIsZCrystal?(item) 
  ret = pbGetItemData(item,ITEM_TYPE)
  return ret && ret==13
end

# Despite what the name might suggest, pbIsZCrystal? refers to the items who's 
# internal names are of the form 'BUGNIUMZ2', whereas pbIsZCrystal2? refers to 
# those of the form 'BUGNIUMZ'. This was a lack of foresight on my part, hope 
# this clears it up.

def pbIsZCrystal2?(item)
  ret = pbGetItemData(item,ITEM_TYPE)
  return ret && ret==14
end

And inside the function pbIsImportantItem

def pbIsImportantItem?(item)

find this line:

  return true if itemData[ITEM_FIELD_USE] && itemData[ITEM_FIELD_USE]==3 && INFINITE_TMS   # TM

and add this:

  return true if itemData[ITEM_FIELD_USE] && itemData[ITEM_FIELD_USE]==14  # Key item representing Z-Crystals.

In the original release of Z-Moves by AmethystRain, for v16.2, Z-crystals where given the value 7 and 8 in the items.txt PBS file. In the next releases of Essentials, 7 and 8 are reserved to (respectively) Evolution stones and fossils, see the doc.
So you will probably need to update these values if future releases of Essentials further alter this.

FILE: Data\Scripts\015_Items\002_PItem_ItemEffects.rb

Spoiler:

Just go to the end of the file, and just paste this big code:

+##################################################################################
# Z Crystals                                                                     #
##################################################################################

ItemHandlers::UseOnPokemon.add(:BUGINIUMZ,proc{|item,pokemon,scene|
  # Find the corresponding compatibility conditions 
  zcomp = pbGetZMoveDataIfCompatible(pokemon, item)
  
  if zcomp
    scene.pbDisplay(_INTL("The {1} will be given to {2} so that it can use its Z-Power!",PBItems.getName(item),pokemon.name))
    if pokemon.item!=0
      itemname=PBItems.getName(pokemon.item)
      scene.pbDisplay(_INTL("{1} is already holding one {2}.\1",pokemon.name,itemname))
      if scene.pbConfirm(_INTL("Would you like to switch the two items?"))   
        if !$PokemonBag.pbStoreItem(pokemon.item)
          scene.pbDisplay(_INTL("The Bag is full. The Pokémon's item could not be removed."))
        else
          pokemon.setItem(zcomp[PBZMove::HELD_ZCRYSTAL])
          scene.pbDisplay(_INTL("The {1} was taken and replaced with the {2}.",itemname,PBItems.getName(item)))
          next true
        end
      end
    else
      pokemon.setItem(zcomp[PBZMove::HELD_ZCRYSTAL])
      scene.pbDisplay(_INTL("{1} was given the {2} to hold.",pokemon.name,PBItems.getName(item)))
      next true      
    end
  else       
    scene.pbDisplay(_INTL("It had no effect."))
    next false
  end
})

ItemHandlers::UseOnPokemon.copy(:BUGINIUMZ, :DARKINIUMZ, :DRAGONIUMZ, :ELECTRIUMZ, :FAIRIUMZ, :FIGHTINIUMZ, :FIRIUMZ, :FLYINIUMZ, :GHOSTIUMZ, :GRASSIUMZ, :GROUNDIUMZ, :ICIUMZ, :NORMALIUMZ, :POISONIUMZ, :PSYCHIUMZ, :ROCKIUMZ, :STEELIUMZ, :WATERIUMZ, :ALORAICHIUMZ, :DECIDIUMZ, :INCINIUMZ, :PRIMARIUMZ, :EEVIUMZ, :PIKANIUMZ, :SNORLIUMZ, :MEWNIUMZ, :TAPUNIUMZ, :MARSHADIUMZ, :PIKASHUNIUMZ, :KOMMONIUMZ, :LYCANIUMZ, :MIMIKIUMZ, :LUNALIUMZ, :SOLGANIUMZ, :ULTRANECROZIUMZ)

This handles the key items representing Z-crystals. I don't know how it's supposed to work in the base game, but in this plugin, Z-crystals come in two versions: a key item (with the internal name THINGIUMZ), and items to be held (with the internal name THINGIUMZ2, with a tiny 2 at the end). The key crystals are in the key item pocket of the bag, and if you want to give a cryqtal to a POkémon, you have to use the key crystal. This key crystal will give a Z-crystal to the chosen Pokémon, if compatible.

FILE: Data\Scripts\015_Items\008_PItem_Bag.rb

Spoiler:

In the class PokemonBag:

class PokemonBag

In the function pbStoreItem:

  def pbStoreItem(item,qty=1)

just below the line:

    item = getID(PBItems,item)

add this:

    if pbIsZCrystal?(item)
      return true
    end

Not sure what this code does though, it was in the base plugin.

FILE: Data\Scripts\016_Pokemon\002_Pokemon_Forms.rb

Spoiler:

Find the description of forms of Arceus:

MultipleForms.register(:ARCEUS,{

and replace this code:

       1  => [:FISTPLATE,:FIGHTINIUMZ],
       2  => [:SKYPLATE,:FLYINIUMZ],
       3  => [:TOXICPLATE,:POISONIUMZ],
       4  => [:EARTHPLATE,:GROUNDIUMZ],
       5  => [:STONEPLATE,:ROCKIUMZ],
       6  => [:INSECTPLATE,:BUGINIUMZ],
       7  => [:SPOOKYPLATE,:GHOSTIUMZ],
       8  => [:IRONPLATE,:STEELIUMZ],
       10 => [:FLAMEPLATE,:FIRIUMZ],
       11 => [:SPLASHPLATE,:WATERIUMZ],
       12 => [:MEADOWPLATE,:GRASSIUMZ],
       13 => [:ZAPPLATE,:ELECTRIUMZ],
       14 => [:MINDPLATE,:PSYCHIUMZ],
       15 => [:ICICLEPLATE,:ICIUMZ],
       16 => [:DRACOPLATE,:DRAGONIUMZ],
       17 => [:DREADPLATE,:DARKINIUMZ],
       18 => [:PIXIEPLATE,:FAIRIUMZ]

with this code:

       1  => [:FISTPLATE,:FIGHTINIUMZ2],
       2  => [:SKYPLATE,:FLYINIUMZ2],
       3  => [:TOXICPLATE,:POISONIUMZ2],
       4  => [:EARTHPLATE,:GROUNDIUMZ2],
       5  => [:STONEPLATE,:ROCKIUMZ2],
       6  => [:INSECTPLATE,:BUGINIUMZ2],
       7  => [:SPOOKYPLATE,:GHOSTIUMZ2],
       8  => [:IRONPLATE,:STEELIUMZ2],
       10 => [:FLAMEPLATE,:FIRIUMZ2],
       11 => [:SPLASHPLATE,:WATERIUMZ2],
       12 => [:MEADOWPLATE,:GRASSIUMZ2],
       13 => [:ZAPPLATE,:ELECTRIUMZ2],
       14 => [:MINDPLATE,:PSYCHIUMZ2],
       15 => [:ICICLEPLATE,:ICIUMZ2],
       16 => [:DRACOPLATE,:DRAGONIUMZ2],
       17 => [:DREADPLATE,:DARKINIUMZ2],
       18 => [:PIXIEPLATE,:FAIRIUMZ2]

The only difference between my code and the previous code is the addition of a "2" in the Z-crystals internal names. Arceus forms also react to its held crystals.
The base code intrigues me, because before this add-on, there was no Z-crystal in the items.txt... So this code should have bugged?
Anyway, it won't bug anymore.

FILE: Data\Scripts\021_Debug\005_Editor_SaveData.rb

Spoiler:

At the end of the definition of:

def pbSaveAllData

paste the line:

  pbSaveZMoveCompatibility; Graphics.update

This decompiles the new PBS file zmovecomp.txt. The decompiling function that is called here is defined in the file Data\Scripts\012_Battle\002_Move\011_Compiler_ZMoves.rb that you copied/pasted before.

FILE: Data\Scripts\022_Compiler\001_Compiler.rb

Spoiler:

In the function:

def pbCompileAllData(mustCompile)

find the line:

    pbCompilePokemonForms

and below that line, paste the code:

    # Depends on PBSpecies, PBMoves, PBItems
    yield(_INTL("Compiling Z-Moves compatibility data"))
    pbCompileZMoveCompatibility

This compiles the new PBS file zmovecomp.txt. The compiling function that is called here is defined in the file Data\Scripts\012_Battle\002_Move\011_Compiler_ZMoves.rb that you copied/pasted before.

Done! :)

Compatibility with Lucidious89's Dynamax plugin

Spoiler:

The Dynamax plugin assumes that the Z-move plugin comes with Ultra-Burst. Lucidious and I are currently in the process of making Z-moves and Dynamax work together, and Ultra-Burst will be part of this. Just so you can work on your project until we release the result, here are a few compatibility quick fixes so that Ultra-Burst doesn't burst your code :)

FILE: Data\Scripts\023_Dynamax\003_Mechanic_Compatibility.rb

Spoiler:

At the very end of the script, paste this:

################################################################################
# SECTION 10 - Ultra Burst compatibility
#===============================================================================
# Defines empty functions for Ultra Burst. 
#-------------------------------------------------------------------------------
class PokeBattle_AI
  def pbEnemyShouldUltraBurst?(idxBattler)
    return false 
  end 
end 
class PokeBattle_Battle
  alias _ub_initialize initialize  
  def initialize(*args)
    _ub_initialize(*args)
    @ultraBurst        = [
     [-1] * (@player ? @player.length : 1),
     [-1] * (@opponent ? @opponent.length : 1)
    ]
  end 
  def pbCanUltraBurst?(idxBattler)
    return false
  end 
  
  def pbRegisterUltraBurst(idxBattler)
    return 
  end 
  def pbUnregisterUltraBurst(idxBattler)
    return 
  end 
  def pbToggleRegisteredUltraBurst(idxBattler)
    return 
  end 
  def pbRegisteredUltraBurst?(idxBattler)
    return false 
  end 
  
  def pbAttackPhaseZMoves
      # Prepare for Z Moves
    @battlers.each_with_index do |b,i|
      next if @choices[i][0]!=:UseMove
      side=(opposes?(i)) ? 1 : 0
      owner=pbGetOwnerIndexFromBattlerIndex(i)
      @choices[i][2].zmove=(@zMove[side][owner]==i)
    end
  end 
  
  def pbAttackPhaseUltraBurst
  end 
end 
class PokeBattle_Pokemon
  def makeUnUltra
  end 
end 

class PokeBattle_Battler
  def ultra?
    return false 
  end 
end

Tutorial: how to add a new Z-move (for a damaging move)

Spoiler:

If you want to add a Z-move effect to status move, close this spoiler block, and check the next one.

Let's say I want to add a Z-move for Ho-Oh. It transforms Sacred Fire into a big Fire Z-move that heals Ho-Oh, and requires the Ho-Ohium-Z (bless you!).

First, I'll have to go to the items.txt file and add the line for the key item Z-crystal:

XXX,HOOHIUMZ,Ho-Ohium-Z,,8,0,"It converts Z-Power into crystals that upgrades a Sacred Fire by Ho-Oh to an exclusive Z-Move.",5,0,14

This is the item that will be given to the player. It will be found in the key item pocket of the bag.

I also need to add the following another line, this time for the Z-crystal that will be held by Ho-Oh:

XXX,HOOHIUMZ2,Ho-Ohium-Z,,1,0,"This is a crystallized form of Z-Power. It upgrades a Sacred Fire by Ho-Oh to a Z-Move.",0,0,13

The Key item is named HOOHIUMZ and the item to be held is named HOOHIUMZ2, with a tiny "2" at the end.
When the player activates HOOHIUMZ from the bag, the game will open the Pokémon Party menu and give the HOOHIUMZ2 to the Pokémon, if compatible (this is the code from Data\Scripts\015_Items\002_PItem_ItemEffects.rb).

Then I need to define the Z-move in the moves.txt PBS file:

XXX,PHOENIXFIRE,Phoenix Fire,Z010,200,FIRE,Physical,0,1,100,NearOther,0,f,"Ho-Oh attacks with full power. Heals the user by half its HP."

This is a typical move addition, so you may just refer to the Docs if you want more explanation.

What is unusual here, is the code of the function, here Z010. This is an unused code, so just like usual moves, I need to write the code handling its effect. If you don't want to add an effect, write Z000.
So, I go to the file Data\Scripts\012_Battle\002_Move\010_ZMove_Effects.rb and I add this code:

#===============================================================================
# Heals the user. (Phoenix Fire)
# This is an example from the Z-move plugin for Essentials v18.dev
#===============================================================================
class PokeBattle_Move_Z010 < PokeBattle_ZMove # The new Z-move is a subclass of PokeBattle_ZMove
  def healingMove?;       return true; end
  def pbHealAmount(user); return user.totalhp/2;    end # Define the amount of HP to heal.

  def pbAdditionalEffect(user,target) # The effect of a Z-move is generally an additional effect.
    amt = pbHealAmount(user)
    user.pbRecoverHP(amt)
    @battle.pbDisplay(_INTL("{1}'s Z-Power restored its HP.",user.pbThis))
  end
end

But it's not over yet.
For now, the game will never know that Ho-Oh has a new Z-move, and will never trigger it. In order to tell the game that it Ho-Oh has a new Z-move, you need to alter the new PBS file: zmovecomp.txt

This file is a correspondence table between Z-crystals, Z-moves and some conditions. Let's see how a line works:

[Key Z-crystal],[Held Z-Crystal],[Required Type],[Required Move],[Required Species],[The Z-Move]

Explanation and warnings:

Spoiler:

• [Key Z-crystal] : This is the internal name of the Z-crystal that will be in the key item pocket. For my new Z-move, this will be: HOOHIUMZ (without the "2").
• [Held Z-Crystal] : This is the internal name of the Z-crystal that will be held by the Pokémon.For my new Z-move, this will be: HOOHIUMZ2 (with the "2").
• [Required Type] : Optional. Internal name of a type. The Z-move only works if the POkémon has a move with that type. If empty, then the type will not be checked. Note that if you have not added any new type, you shouldn't add any value here; all the type-specific z-moves are already defined.
• [Required Move] : Optional. Internal name of a move. The Z-move only works if the Pokémon has that specific move. If empty, then the move will not be checked.
• [Required Species] : Optional.Internal name of a species. Note that this is an fSpecies, that is, the internal name combining a species + form (e.g. RAICHU_1 for RAICHU in form 1).
• [The Z-Move] : This is the internal name of the Z-move triggered by these conditions.

Warning 1:
If you define [Required Move], then don't add a [Required Type], because it may generate conflicts.

Warning 2:
If you are adding a new type-specific Z-move, its line should look like this:

[New Key Z-Crystal],[New Held Z-Crystal],[Your New Type],,,[Your New Z-Move]

If you are adding a species-specific Z-move, its line should look like this:

[New Key Z-Crystal],[New Held Z-Crystal],,[A Move],[A Pokémon],[Your New Z-Move]

Warning 3:
At least one among [Required Type], [Required Move] and [Required Species] should be defined, otherwise the compiler will complain. However, you could easily define a Z-move that is specific to a given species, using a given type of move (but not specific to a move). The line will look like this:

[New Key Z-Crystal],[New Held Z-Crystal],[Your New Type],,[A Pokémon],[Your New Z-Move]

This is perfectly correct for the compiler, however it does not exist in the official games.

Back to my example.
I want to add a new Z-move for Ho-Oh. My addition to zmovecomp will be:

HOOHIUMZ, HOOHIUMZ2, , SACREDFIRE, HOOH, PHOENIXFIRE

And then the file will be compiled when you start your game in debug mode from RPG Maker.

Tutorial: How to add a new Z-move for a status move.

Spoiler:

Status moves do not fully convert. In fact, a status move will activate a new effect, and then it will activate its usual effect.

In order to add a new effect, go to the file:

• Data\Scripts\012_Battle\002_Move\009_PokeBattle_ZMove.rb

and go to the function:

  def pbZStatus(move,attacker)

You should first check if the effect you want is not already defined, and add the internal name of your move to the right list of moves.

Otherwise, define a new list:

    my_new_effect = [PBMoves::MyNewMove]

and at the end of all the if's, add:

    elsif my_new_effect.include?(move)
       # Here the code of my new effect.

And that's it!

Credits:

Spoiler:

For the base script (for Essentials v16.2):
Primary Scripting: Marcello
Beta Testers: Zumi, Ice Cream Sand Witch
Other Testers/Other Help: Amethyst, Jan, Sardines, Inuki

For the adaptation to Essentials v18.dev: StCooler

What's tested/not tested:

Spoiler:

• Tested basic use of Z-moves, from the bag + in battle, be they type-specific, or species-specific.
• Tested IA use of Z-moves.
• Not tested: Item storage.
• Not tested: inserting this plugin to Essentials v18 and v18.1.

Known bugs:

Spoiler:

None yet.

Enjoy :)

 

[Lucidious89]

Very interesting. I wasn't expecting an updated Z-Move script to be released so soon. I'll have to go over this when I have the time to try and make this compatible with Dynamax. It looks like there's a lot of moving pieces to this script though, so there's a lot to go over.

At a glance I see that Ultranecrozium Z was added in. Is Ultra Burst now rolled into this project?

 

[StCooler]

Very interesting. I wasn't expecting an updated Z-Move script to be released so soon. I'll have to go over this when I have the time to try and make this compatible with Dynamax.

Making it compatible with Dynamax is my next step. I have a lot of time during the holidays so I'll work on it.

It looks like there's a lot of moving pieces to this script though, so there's a lot to go over.

Yes indeed. I cried a lot while writing this post XD
I have this code on a separate branch on a GitHub fork of the current Essentials v18.dev (hence my work here). Maybe I can make a pull request to make your life easier?

At a glance I see that Ultranecrozium Z was added in. Is Ultra Burst now rolled into this project?

Ultra Burst wasn't in the base code given by the OP so I completely forgot it...
I'll do it soon.