Class: Spriteset_Map

Overview

Display everything that should be displayed during the Scene_Map

Defined Under Namespace

Modules: CharactersPlugin, FogFixPlugin, FogPlugin, MapPanelPlugin, PanoramaPlugin, PicturesPlugin, QuestInformerPlugin, TilemapPlugin, TimerPlugin, WeatherPlugin

Instance Attribute Summary

Attributes included from CharactersPlugin

#game_player_sprite

Instance Method Summary collapse

Methods included from TilemapPlugin

#load_autotile

Methods included from PicturesPlugin

#sprite_picture

Methods included from QuestInformerPlugin

#inform_quest

Methods included from Yuki::ParticleSpriteSetMapPlugin

#init_player

Constructor Details

#initialize(zone = nil) ⇒ Spriteset_Map

Initialize a new Spriteset_Map object

Parameters:

  • zone (Integer, nil) (defaults to: nil) —

    the id of the zone where the player is



438
439
# File 'docs/4_Systems_003_Map_Engine.rb', line 438

def initialize(zone = nil)
end

Instance Method Details

#dispose(from_warp = false) ⇒ Sprite?

Spriteset_map dispose

Parameters:

  • from_warp (Boolean) (defaults to: false) —

    if true, prepare a screenshot with some conditions and cancel the sprite dispose process

Returns:

  • (Sprite, nil) —

    a screenshot or nothing



455
456
# File 'docs/4_Systems_003_Map_Engine.rb', line 455

def dispose(from_warp = false)
end

#disposed? ⇒ Boolean

Tell if the spriteset is disposed

Returns:

  • (Boolean)


450
451
# File 'docs/4_Systems_003_Map_Engine.rb', line 450

def disposed?
end

#map_viewport ⇒ Viewport

Return the map viewport

Returns:



466
467
# File 'docs/4_Systems_003_Map_Engine.rb', line 466

def map_viewport
end

#reload(zone = nil)

Reload the tilemap, characters and player upon map warp (continuity)

Parameters:

  • zone (Integer, nil) (defaults to: nil) —

    the id of the zone where the player is



446
447
# File 'docs/4_Systems_003_Map_Engine.rb', line 446

def reload(zone = nil)
end

#snap_to_bitmaps ⇒ Array<Texture>

Take a snapshot of the spriteset

Returns:



442
443
# File 'docs/4_Systems_003_Map_Engine.rb', line 442

def snap_to_bitmaps
end

#update

Update every sprite



458
459
# File 'docs/4_Systems_003_Map_Engine.rb', line 458

def update
end

#visible=(value)

Change the visible state of the Spriteset

Parameters:

  • value (Boolean) —

    the new visibility state



462
463
# File 'docs/4_Systems_003_Map_Engine.rb', line 462

def visible=(value)
end