Module: Yuki::WorldMapEditor

Defined in:

scripts/01100 Yuki/01200 Yuki__WorldMapEditor.rb

Overview

Module that helps the user to edit his worldmap

Class Method Summary

• .add_worldmap(image, name_id, file_id = nil)

  Add a new world map and select it.

• .clear_map

  Clear the map.

• .delete_worldmap(id)

  Delete world map.

• .init

  Init the editor.

• .init_sprites

  Create the sprites.

• .list_worldmap(name = '')

  Display all worldmaps.

• .list_zone(name = '')

  List the zone.

• .main

  Main function.

• .remove_zone

  Remove the zone.

• .save

  Save the world map.

• .select_worldmap(id)

  Select a world map.

• .select_zone(id)

  Select a zone.

• .set_worldmap_image(id, new_image)

  Change the worldmap image to the given one.

• .set_worldmap_name(id, name_id, file_id = nil)

  Change the worldmap name to the given name text id in the given file id (by default in the ruby host).

• .show_help

  Affiche l'aide.

• .update

  Update the scene.

• .update_infobox

  Update the infobox.

• .update_origin(worldmap)

  Update the origin x/y.

• .update_zone

  Update the current zone.

Class Method Details

.add_worldmap(image, name_id, file_id = nil)

Add a new world map and select it

Parameters:

• image (String) —

  the image of the map in graphics/interface folder

• name_id (Integer) —

  the text id in the file

• file_id (String, Integer, nil) (defaults to: nil) —

  the file to pick the region name, by default the Ruby Host

.clear_map

Clear the map

.delete_worldmap(id)

Delete world map

Parameters:

• id (Integer) —

  the id of the map to delete

.init

Init the editor

.init_sprites

Create the sprites

.list_worldmap(name = '')

Display all worldmaps

Parameters:

• name (String, '') (defaults to: '') —

  the name to filter

.list_zone(name = '')

List the zone

.main

Main function

.remove_zone

Remove the zone

.save

Save the world map

.select_worldmap(id)

Select a world map

.select_zone(id)

Select a zone

.set_worldmap_image(id, new_image)

Change the worldmap image to the given one

Parameters:

• id (Integer) —

  the id of the world map to edit

• new_image (Integer) —

  the new filename of the image

.set_worldmap_name(id, name_id, file_id = nil)

Change the worldmap name to the given name text id in the given file id (by default in the ruby host)

Parameters:

• id (Integer) —

  the id of the world map to edit

• name_id (Integer) —

  the id of the text in the file

• file_id (Integer, String, nil) (defaults to: nil) —

  the file id / name by default ruby host

.show_help

Affiche l'aide

.update

Update the scene

.update_infobox

Update the infobox

.update_origin(worldmap)

Update the origin x/y

Parameters:

• worldmap (Class<GamePlay::WorldMap>) —

  should contain TileSize and BitmapOffset constants

.update_zone

Update the current zone