[Essentials v16.2+] Overworld Shadows

WolfPP · May 27, 2019

I made a new Shadow Overworld, fixing '$game_switches' and dependent events bugs. Let's go!

First, save this image (called by shadow) inside Character folder:

If you are using v16.2 check here.

Now, find 'Sprite_WaterReflection' script and below that script, add a new script called "Sprite_ShadowOverworld" (or whatever you want) and paste this code inside the new script:

Spoiler:

New Code:

Spoiler:

Code:

# Extending so we can access some private instance variables.
class Game_Character; attr_reader :jump_count; end

class Sprite_ShadowOverworld
  attr_reader :visible; attr_accessor :event

  NO_SHADOW_EVENT=["door","nurse","healing balls","Mart","boulder","tree","HeadbuttTree","BerryPlant"]

  def initialize(sprite,event,viewport=nil)
    @rsprite  = sprite
    @sprite   = nil
    @event    = event
    @viewport = viewport
    @disposed = false
    @shadowoverworldbitmap = AnimatedBitmap.new("Graphics/Characters/shadow")
    @cws = @shadowoverworldbitmap.height*2
    @chs = @shadowoverworldbitmap.height*2
    update
  end

  def dispose; if !@disposed; @sprite.dispose if @sprite; @sprite = nil; @disposed = true; end; end

  def disposed?; @disposed; end

  def jump_sprite
    return unless @sprite
    x = (@event.real_x - @event.map.display_x + 3) / 4 + (Game_Map::TILEWIDTH / 2)
    y = (@event.real_y - @event.map.display_y + 3) / 4 + (Game_Map::TILEHEIGHT)
    @totaljump = @event.jump_count if !@totaljump
    case @event.jump_count
    when 1..(@totaljump / 3); @sprite.zoom_x += 0.1; @sprite.zoom_y += 0.1
    when (@totaljump / 3 + 1)..(@totaljump / 3 + 2); @sprite.zoom_x += 0.05; @sprite.zoom_y += 0.05
    when (@totaljump / 3 * 2 - 1)..(@totaljump / 3 * 2); @sprite.zoom_x -= 0.05; @sprite.zoom_y -= 0.05
    when (@totaljump / 3 * 2 + 1)..(@totaljump); @sprite.zoom_x -= 0.1; @sprite.zoom_y -= 0.1
    end
    if @event.jump_count == 1; @sprite.zoom_x = 1.0; @sprite.zoom_y = 1.0; @totaljump = nil; end
    @sprite.x = x; @sprite.y = y; @sprite.z = @rsprite.z - 1
  end

  def visible=(value); @visible = value; @sprite.visible = value if @sprite && [email protected]?; end
    
  def update
    return if disposed? || !$scene || !$scene.is_a?(Scene_Map)
    return jump_sprite if event.jumping?
    if event.character_name =="" || event.character_name == "nil" ||
    (PBTerrain.isGrass?(pbGetTerrainTag(event)) || PBTerrain.hasReflections?(pbGetTerrainTag(event)) || 
     PBTerrain.isSurfable?(pbGetTerrainTag(event)) || PBTerrain.isIce?(pbGetTerrainTag(event))) ||
    (event!=$game_player && pbEventCommentInput(event,0,"NoShadow")) ||
     NO_SHADOW_EVENT.include?(event.character_name) || event.transparent
      # Just-in-time disposal of sprite 
      if @sprite; @sprite.dispose; @sprite = nil; end; return; end
    # Just-in-time creation of sprite
    @sprite = Sprite.new(@viewport) if !@sprite
    if @sprite
      @sprite.bitmap = @shadowoverworldbitmap.bitmap; cw = @cws; ch = @chs
      @sprite.x       = @rsprite.x
      @sprite.y       = @rsprite.y
      @sprite.ox      = cw/2 -1
      @sprite.oy      = ch -18
      @sprite.z       = @rsprite.z-1
      @sprite.zoom_x  = @rsprite.zoom_x
      @sprite.zoom_y  = @rsprite.zoom_y
      @sprite.tone    = @rsprite.tone
      @sprite.color   = @rsprite.color
      @sprite.opacity = @rsprite.opacity
    end
  end
end

Old Code:

Spoiler:

Code:

# Extending so we can access some private instance variables.
class Game_Character
  attr_reader :jump_count
end

class Sprite_ShadowOverworld
  attr_reader :visible
  attr_accessor :event
  
  def initialize(sprite,event,viewport=nil)
    @rsprite  = sprite
    @sprite   = nil
    @event    = event
    @viewport = viewport
    @disposed = false
    @shadowoverworldbitmap = AnimatedBitmap.new("Graphics/Characters/shadow")
    @cws = @shadowoverworldbitmap.height*2
    @chs = @shadowoverworldbitmap.height*2
    update
  end

  def dispose
    if !@disposed
      @sprite.dispose if @sprite
      @sprite   = nil
      @disposed = true
    end
  end

  def disposed?
    @disposed
  end
  
  def jump_sprite
    return unless @sprite
    x = (@event.real_x - @event.map.display_x + 3) / 4 + (Game_Map::TILEWIDTH / 2)
    y = (@event.real_y - @event.map.display_y + 3) / 4 + (Game_Map::TILEHEIGHT)
    @totaljump = @event.jump_count if !@totaljump
    case @event.jump_count
    when 1..(@totaljump / 3)
      @sprite.zoom_x += 0.1
      @sprite.zoom_y += 0.1
    when (@totaljump / 3 + 1)..(@totaljump / 3 + 2)
      @sprite.zoom_x += 0.05
      @sprite.zoom_y += 0.05
    when (@totaljump / 3 * 2 - 1)..(@totaljump / 3 * 2)
      @sprite.zoom_x -= 0.05
      @sprite.zoom_y -= 0.05
    when (@totaljump / 3 * 2 + 1)..(@totaljump)
      @sprite.zoom_x -= 0.1
      @sprite.zoom_y -= 0.1
    end
    if @event.jump_count == 1
      @sprite.zoom_x = 1.0
      @sprite.zoom_y = 1.0
      @totaljump = nil
    end
    @sprite.x = x
    @sprite.y = y #- 6
    @sprite.z = @rsprite.z - 1
  end

  
  def visible=(value)
    @visible = value
    @sprite.visible = value if @sprite && [email protected]?
  end

  def update
    return if disposed?
    return jump_sprite if event.jumping?
    currentTag = pbGetTerrainTag(event)
    if event.character_name =="" || event.character_name == "nil" ||
      (PBTerrain.isGrass?(currentTag) || PBTerrain.hasReflections?(currentTag) || 
      event!=$game_player && PBTerrain.isSurfable?(currentTag)) ||
      event!=$game_player && pbEventCommentInput(event,0,"NoShadow") || event.transparent
      # Just-in-time disposal of sprite 
      if @sprite
        @sprite.dispose
        @sprite = nil
      end
      return
    end
    # Just-in-time creation of sprite
    @sprite = Sprite.new(@viewport) if !@sprite
    if @sprite
      if (event==$game_player && $PokemonTemp.surfJump)
        @sprite.x = ($PokemonTemp.surfJump[0]*[email protected]_x+3)/4+(Game_Map::TILEWIDTH/2)
        @sprite.y = ($PokemonTemp.surfJump[1]*[email protected]_y+3)/4+(Game_Map::TILEHEIGHT/2)+16
      else
        @sprite.x = @rsprite.x
        @sprite.y = @rsprite.y
      end      
      @sprite.bitmap = @shadowoverworldbitmap.bitmap; cw = @cws; ch = @chs
      @sprite.x = @rsprite.x
      @sprite.y = @rsprite.y
      @sprite.ox      = cw/2 -1
      @sprite.oy      = ch -18
      @sprite.z       = @rsprite.z-1
      @sprite.zoom_x  = @rsprite.zoom_x
      @sprite.zoom_y  = @rsprite.zoom_y
      @sprite.tone    = @rsprite.tone
      @sprite.color   = @rsprite.color
      @sprite.opacity = @rsprite.opacity
    end      
  end
end

Now, find 'Sprite_Character' script. Then:

Spoiler:

To the event doesn't works (won't show the shadow effect) you need to put a Comment NoShadow inside the event, to each page. Example to (healing balls events, inside Poke Center Map):

Spoiler:

JUST A P.S. DON'T COPY:
That is the code to check if event are walking into surfing base or grass tile or water reflection tile (to remove the shadow effect). You can add more if you want to:

Code:

    currentTag = pbGetTerrainTag(event)
    if PBTerrain.isGrass?(currentTag) || PBTerrain.hasReflections?(currentTag) ||
      PBTerrain.isSurfable?(currentTag)
      # Just-in-time disposal of sprite 
      if @sprite
        @sprite.dispose
        @sprite = nil
      end
      return
    end

Thanks Marin for the code about jump scene.
Thanks MGriffin for help me about jump scene.

Give credits to me (WolfPP) and Marin (because i copied his "jump scene" into Shadow Overworld script) if use.

Cya!

Juno and Ice · May 27, 2019

Getting a syntax error on line 82. Though I don't seem to find anything wrong.

Any idea why that might be happening?

WolfPP · May 27, 2019

Juno and Ice said:
Getting a syntax error on line 82. Though I don't seem to find anything wrong.

Any idea why that might be happening?

A single '(' into the beginning:

Code:

if [B][I][U][SIZE="2"]([/SIZE][/U][/I][/B]PBTerrain.isGrass?(currentTag) || PBTerrain.hasReflections?(currentTag) ||
      PBTerrain.isSurfable?(currentTag)

I already removed into the main code. Copy and paste again.

Lazy Catalyst · May 27, 2019

You should make a code like this for Foot prints also!
My best wishes 👍👍

Parritoso · Jun 2, 2019

Could you help me

currentTag = pbGetTerrainTag(event)
if PBTerrain.isGrass?(currentTag) || PBTerrain.hasReflections?(currentTag) ||
PBTerrain.isSurfable?(currentTag)
# Just-in-time disposal of sprite
if @sprite
@sprite.dispose
@sprite = nil
end
return
end

Where should I put this script part?

WolfPP · Jun 2, 2019

Parritoso said:
Could you help me

Where should I put this script part?

Code:

[B][I][U]That is the code to check if event are walking into surfing base or grass tile or water reflection tile (to remove the shadow effect). You can add more if you want to:[/U][/I][/B]

Nowhere. I just explained if you want to put more terraing tag to the shadow effects disappears.

WolfPP · Jun 14, 2019

ATT:
I added jump effect when the player jumps to start surfing:

Spoiler:

Atted the main script. Replace it.

WolfPP · Jun 23, 2019

ATT:
Inside 'def update', remove 'return if event!=$game_player && pbEventCommentInput(event,0,"NoShadow")' and then, paste '@sprite.visible=false if event!=$game_player && pbEventCommentInput(event,0,"NoShadow")' below 'if @sprite'.

Atted the main script.

EDIT: Better one. Inside 'def update', just replace for the code:

Code:

    if event.character_name =="" || event.character_name == "nil" ||
      (PBTerrain.isGrass?(currentTag) || PBTerrain.hasReflections?(currentTag) || 
      event!=$game_player && PBTerrain.isSurfable?(currentTag)) [B][I][U]||
      event!=$game_player && pbEventCommentInput(event,0,"NoShadow")[/U][/I][/B]
      # Just-in-time disposal of sprite 
      if @sprite
        @sprite.dispose
        @sprite = nil
      end
      return
    end

Skyflyer · Jun 25, 2019

WolfPP said:
ATT:
Inside 'def update', remove 'return if event!=$game_player && pbEventCommentInput(event,0,"NoShadow")' and then, paste '@sprite.visible=false if event!=$game_player && pbEventCommentInput(event,0,"NoShadow")' below 'if @sprite'.

Atted the main script.

EDIT: Better one. Inside 'def update', just replace for the code:

Code:

if event.character_name =="" || event.character_name == "nil" || (PBTerrain.isGrass?(currentTag) || PBTerrain.hasReflections?(currentTag) || event!=$game_player && PBTerrain.isSurfable?(currentTag)) [B][I][U]|| event!=$game_player && pbEventCommentInput(event,0,"NoShadow")[/U][/I][/B] # Just-in-time disposal of sprite if @sprite @sprite.dispose @sprite = nil end return end

Great, now it works perfectly, thanks :D

WolfPP · Jul 3, 2019

New Code. Check into main post.

Richard PT · Jul 6, 2019

WolfPP can you post the Marin overworld shadow codes that we should remove from the pokemon following script, if we want to use yours instead? Some guys and me don't understand well what lines should be removed. And when i've tried alone, i've got errors, because, maybe i don't removed it well. Sorry for the trouble. XD

WolfPP · Jul 6, 2019

Richard PT said:
WolfPP can you post the Marin overworld shadow codes that we should remove from the pokemon following script, if we want to use yours instead? Some guys and me don't understand well what lines should be removed. And when i've tried alone, i've got errors, because, maybe i don't removed it well. Sorry for the trouble. XD

Everything.

mybusiness · Jul 7, 2019

I noticed a bug. You see the lower part of the shadows?

Spoiler:

Pikalex04 · Jul 7, 2019

You need to change the priority on the database editor (the one for changing the flags, the terrain codes of the tilesets etc.).

EDIT: The shadow appears only on tiles that have a priority of 1. All tiles where you can step have a priority of 1. Since you can't walk into the walls, Essentials set the priority of 1 where you can't walk or appear (the last tilesets of the house have a priority of 2 or 3, so the player will be under the tileset, and with a priority of 1 he will be over the tileset).

mybusiness · Jul 7, 2019

The last tilesets of the house have priority 1.

Pikalex04 · Jul 7, 2019

Ooof, some things are changed from old versions of Essentials, I'm sorry. SO, you need to set the priority of the internal house tilesets to 1.

WolfPP · Jul 7, 2019

Is not a bug. You just need to edit '@sprite.oy = ch -18'. That '-18'.

mybusiness · Jul 7, 2019

Ok. Thanks!

EDIT: By the way, I included the functionality of Marin that automatically deactivates shadow if the name of the event contains a string that you define:

Code:

# In order for the shadow to be invisible, the name of the event must 
# contain a string that is defined in No_Shadow_If_Event_Name_Has, or having 
# a comment containing the exact string NoShadow (case sensitive for the comment).

# Extending so we can access some private instance variables.
class Game_Character
  attr_reader :jump_count
  attr_reader :name 
end

class Sprite_ShadowOverworld
  attr_reader :visible
  attr_accessor :event
    
  def initialize(sprite,event,viewport=nil)
    @rsprite  = sprite
    @sprite   = nil
    @event    = event
    @viewport = viewport
    @disposed = false
    @shadowoverworldbitmap = AnimatedBitmap.new("Graphics/Characters/shadow")
    @cws = @shadowoverworldbitmap.height*2
    @chs = @shadowoverworldbitmap.height*2
    update
  end

  def dispose; if !@disposed; @sprite.dispose if @sprite; @sprite = nil; @disposed = true; end; end

  def disposed?; @disposed; end
    
  No_Shadow_If_Event_Name_Has = [
    "door",
    "nurse",
    "healing balls",
    "Mart",
    "boulder",
    "tree",
    "HeadbuttTree",
   # etc
  ]
  
  def ShouldGetShadow?
    return false if event.character_name =="" || event.character_name == "nil" ||
                   (PBTerrain.isGrass?(pbGetTerrainTag(event)) || 
                   PBTerrain.hasReflections?(pbGetTerrainTag(event)) || 
                   PBTerrain.isSurfable?(pbGetTerrainTag(event)) || 
                   PBTerrain.isIce?(pbGetTerrainTag(event))) ||
                  (event!=$game_player && pbEventCommentInput(event,0,"NoShadow"))
    if event.name != nil
      name=event.name.dup
      name.downcase!
      No_Shadow_If_Event_Name_Has.each do |e|
        e.downcase!
        return false  if name.include?(e)
      end
    end
    return true
  end
    
  def jump_sprite
    return unless @sprite
    x = (@event.real_x - @event.map.display_x + 3) / 4 + (Game_Map::TILEWIDTH / 2)
    y = (@event.real_y - @event.map.display_y + 3) / 4 + (Game_Map::TILEHEIGHT)
    @totaljump = @event.jump_count if !@totaljump
    case @event.jump_count
    when 1..(@totaljump / 3); @sprite.zoom_x += 0.1; @sprite.zoom_y += 0.1
    when (@totaljump / 3 + 1)..(@totaljump / 3 + 2); @sprite.zoom_x += 0.05; @sprite.zoom_y += 0.05
    when (@totaljump / 3 * 2 - 1)..(@totaljump / 3 * 2); @sprite.zoom_x -= 0.05; @sprite.zoom_y -= 0.05
    when (@totaljump / 3 * 2 + 1)..(@totaljump); @sprite.zoom_x -= 0.1; @sprite.zoom_y -= 0.1
    end
    if @event.jump_count == 1; @sprite.zoom_x = 1.0; @sprite.zoom_y = 1.0; @totaljump = nil; end
    @sprite.x = x; @sprite.y = y; @sprite.z = @rsprite.z - 1
  end

  def visible=(value); @visible = value; @sprite.visible = value if @sprite && [email protected]?; end

  def update
    return if disposed? || !$scene || !$scene.is_a?(Scene_Map)
    return jump_sprite if event.jumping?
    if !ShouldGetShadow?
      # Just-in-time disposal of sprite 
      if @sprite; @sprite.dispose; @sprite = nil; end; return; end
    # Just-in-time creation of sprite
    @sprite = Sprite.new(@viewport) if !@sprite
    if @sprite
      @sprite.bitmap = @shadowoverworldbitmap.bitmap; cw = @cws; ch = @chs
      @sprite.x       = @rsprite.x
      @sprite.y       = @rsprite.y
      @sprite.ox      = cw/2 -1
      @sprite.oy      = ch - 15  # original:  @sprite.oy      = ch - 18
      @sprite.z       = @rsprite.z-1
      @sprite.zoom_x  = @rsprite.zoom_x
      @sprite.zoom_y  = @rsprite.zoom_y
      @sprite.tone    = @rsprite.tone
      @sprite.color   = @rsprite.color
      @sprite.opacity = @rsprite.opacity
    end
  end
end

WolfPP · Jul 7, 2019

I think this code will lag a little more the game, you know?

Code:

if event.name != nil
      name=event.name.dup
      name.downcase!
      No_Shadow_If_Event_Name_Has.each do |e|
        e.downcase!
        return false if name.include?(e)
      end
    end

I will work into other script for that case. Thanks anyway!

Done. Replace the script for:

Spoiler:

Code:

# Extending so we can access some private instance variables.
class Game_Character; attr_reader :jump_count; end

class Sprite_ShadowOverworld
  attr_reader :visible; attr_accessor :event

  NO_SHADOW_EVENT=["door","nurse","healing balls","Mart","boulder","tree","HeadbuttTree","BerryPlant"]

  def initialize(sprite,event,viewport=nil)
    @rsprite  = sprite
    @sprite   = nil
    @event    = event
    @viewport = viewport
    @disposed = false
    @shadowoverworldbitmap = AnimatedBitmap.new("Graphics/Characters/shadow")
    @cws = @shadowoverworldbitmap.height*2
    @chs = @shadowoverworldbitmap.height*2
    update
  end

  def dispose; if !@disposed; @sprite.dispose if @sprite; @sprite = nil; @disposed = true; end; end

  def disposed?; @disposed; end

  def jump_sprite
    return unless @sprite
    x = (@event.real_x - @event.map.display_x + 3) / 4 + (Game_Map::TILEWIDTH / 2)
    y = (@event.real_y - @event.map.display_y + 3) / 4 + (Game_Map::TILEHEIGHT)
    @totaljump = @event.jump_count if !@totaljump
    case @event.jump_count
    when 1..(@totaljump / 3); @sprite.zoom_x += 0.1; @sprite.zoom_y += 0.1
    when (@totaljump / 3 + 1)..(@totaljump / 3 + 2); @sprite.zoom_x += 0.05; @sprite.zoom_y += 0.05
    when (@totaljump / 3 * 2 - 1)..(@totaljump / 3 * 2); @sprite.zoom_x -= 0.05; @sprite.zoom_y -= 0.05
    when (@totaljump / 3 * 2 + 1)..(@totaljump); @sprite.zoom_x -= 0.1; @sprite.zoom_y -= 0.1
    end
    if @event.jump_count == 1; @sprite.zoom_x = 1.0; @sprite.zoom_y = 1.0; @totaljump = nil; end
    @sprite.x = x; @sprite.y = y; @sprite.z = @rsprite.z - 1
  end

  def visible=(value); @visible = value; @sprite.visible = value if @sprite && [email protected]?; end
    
  def update
    return if disposed? || !$scene || !$scene.is_a?(Scene_Map)
    return jump_sprite if event.jumping?
    if event.character_name =="" || event.character_name == "nil" ||
    (PBTerrain.isGrass?(pbGetTerrainTag(event)) || PBTerrain.hasReflections?(pbGetTerrainTag(event)) || 
     PBTerrain.isSurfable?(pbGetTerrainTag(event)) || PBTerrain.isIce?(pbGetTerrainTag(event))) ||
    (event!=$game_player && pbEventCommentInput(event,0,"NoShadow")) ||
     NO_SHADOW_EVENT.include?(event.character_name)
      # Just-in-time disposal of sprite 
      if @sprite; @sprite.dispose; @sprite = nil; end; return; end
    # Just-in-time creation of sprite
    @sprite = Sprite.new(@viewport) if !@sprite
    if @sprite
      @sprite.bitmap = @shadowoverworldbitmap.bitmap; cw = @cws; ch = @chs
      @sprite.x       = @rsprite.x
      @sprite.y       = @rsprite.y
      @sprite.ox      = cw/2 -1
      @sprite.oy      = ch -18
      @sprite.z       = @rsprite.z-1
      @sprite.zoom_x  = @rsprite.zoom_x
      @sprite.zoom_y  = @rsprite.zoom_y
      @sprite.tone    = @rsprite.tone
      @sprite.color   = @rsprite.color
      @sprite.opacity = @rsprite.opacity
    end
  end
end

ATTED THE MAIN POST.

mybusiness · Jul 9, 2019

Man, that doesn't work. I believe that is because you are checking character_name, which is not the name of the event.

[Essentials v16.2+] Overworld Shadows

More options

WolfPP

Spriter/ Pixel Artist

Juno and Ice

Developer of Pokémon Floral Tempus

WolfPP

Spriter/ Pixel Artist

Lazy Catalyst

What you do, the way you think, makes you differen

Parritoso

WolfPP

Spriter/ Pixel Artist

WolfPP

Spriter/ Pixel Artist

WolfPP

Spriter/ Pixel Artist

Skyflyer

WolfPP

Spriter/ Pixel Artist

Richard PT

WolfPP

Spriter/ Pixel Artist

mybusiness

Guest

Pikalex04

The Project Hyper creator (Discord: Pikalex04#3285

mybusiness

Guest

Pikalex04

The Project Hyper creator (Discord: Pikalex04#3285

WolfPP

Spriter/ Pixel Artist

mybusiness

Guest

WolfPP

Spriter/ Pixel Artist

mybusiness

Guest