Class: Spriteset_Map

Inherits:
Object show all
Includes:
Hooks
Defined in:
docs/01450_Systems_00003_Map_Engine.rb

Overview

Display everything that should be displayed during the Scene_Map

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Hooks

#exec_hooks, #force_return, included, register, remove, remove_without_name

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



325
326
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 325

def initialize(zone = nil)
end

Instance Attribute Details

#game_player_sprite ⇒ Sprite_Character (readonly)

Retrieve the Game Player sprite

Returns:



322
323
324
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 322

def game_player_sprite
  @game_player_sprite
end

Instance Method Details

#create_panel(zone)

create the zone panel of the current zone

Parameters:

  • zone (Integer, nil) —

    the id of the zone where the player is



413
414
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 413

def create_panel(zone)
end

#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



392
393
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 392

def dispose(from_warp = false)
end

#dispose_sp_map

Dispose the zone panel



417
418
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 417

def dispose_sp_map
end

#disposed? ⇒ Boolean

Tell if the spriteset is disposed

Returns:

  • (Boolean) 


387
388
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 387

def disposed?
end

#finish_init(zone)

Last step of the Spriteset initialization

Parameters:

  • zone (Integer, nil) —

    the id of the zone where the player is



341
342
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 341

def finish_init(zone)
end

#inform_quest(name, quest_status)

Add a new quest informer

Parameters:

  • name (String) —

    Name of the quest

  • quest_status (Symbol) —

    status of quest (:new, :completed, :failed)



436
437
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 436

def inform_quest(name, quest_status)
end

#init_characters

Sprite_Character initialization



369
370
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 369

def init_characters
end

#init_panorama_fog

Panorama and fog initialization



361
362
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 361

def init_panorama_fog
end

#init_player

Player initialization



376
377
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 376

def init_player
end

#init_psdk_add

PSDK related thing initialization



364
365
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 364

def init_psdk_add
end

#init_quest_informer

Create the quest informer array



382
383
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 382

def init_quest_informer
end

#init_tilemap

Tilemap initialization



348
349
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 348

def init_tilemap
end

#init_viewports(viewport_type)

Method responsive of initializing the viewports

Parameters:

  • viewport_type (Symbol) 


329
330
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 329

def init_viewports(viewport_type)
end

#init_weather_picture_timer

Weather, picture and timer initialization



379
380
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 379

def init_weather_picture_timer
end

#load_autotile(filename) ⇒ Texture

Attempt to load an autotile

Parameters:

  • filename (String) —

    name of the autotile

Returns:

  • (Texture) —

    the bitmap of the autotile



353
354
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 353

def load_autotile(filename)
end

#load_autotile_internal(filename) ⇒ Texture

Attempt to load an autotile

Parameters:

  • filename (String) —

    name of the autotile

Returns:

  • (Texture) —

    the bitmap of the autotile



358
359
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 358

def load_autotile_internal(filename)
end

#map_viewport ⇒ Viewport

Return the map viewport

Returns:



431
432
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 431

def map_viewport
end

#recycle_characters(character_sprites)

Recycled Sprite_Character initialization

Parameters:



373
374
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 373

def recycle_characters(character_sprites)
end

#reload(zone = nil)

Do the same as initialize but without viewport initialization (opti)

Parameters:

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

    the id of the zone where the player is



337
338
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 337

def reload(zone = nil)
end

#snap_to_bitmaps ⇒ Array<Texture>

Take a snapshot of the spriteset

Returns:



333
334
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 333

def snap_to_bitmaps
end

#sprite_picture(id_game_picture) ⇒ Sprite_Picture

Get the Sprite_Picture linked to the ID of the Game_Picture

Parameters:

  • the (Integer) —

    ID of the Game_Picture

Returns:



409
410
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 409

def sprite_picture(id_game_picture)
end

#tilemap_class ⇒ Class

Return the prefered tilemap class

Returns:

  • (Class) 


345
346
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 345

def tilemap_class
end

#update

Update every sprite



395
396
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 395

def update
end

#update_events

update event sprite



398
399
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 398

def update_events
end

#update_panel

Update the zone panel



422
423
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 422

def update_panel
end

#update_panorama_fog

update panorama and fog sprites



404
405
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 404

def update_panorama_fog
end

#update_weather_picture

update weather and picture sprites



401
402
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 401

def update_weather_picture
end

#visible=(value)

Change the visible state of the Spriteset

Parameters:

  • value (Boolean) —

    the new visibility state



427
428
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 427

def visible=(value)
end