Class: GameData::WorldMap

Inherits:

Base

• Object
• Base
• GameData::WorldMap

Extended by:

DataSource

Defined in:

scripts/00800 GameData/00100 Serializable/00950 WorldMap.rb

Overview

Data structure of world maps

Author:

• Leikt, Nuri Yuri

Constant Summary

Constants included from DataSource

DataSource::SOURCES

Instance Attribute Summary

• #data ⇒ Table, Array<WorldMapObject>

  Informations on the map.

• #image ⇒ String

  Filename of the image used to display the world map.

• #name_file_id ⇒ Integer, ...

  Wolrd map name file id.

• #name_id ⇒ Integer

  World map name text id.

Attributes inherited from Base

#db_symbol, #id

Class Method Summary

• .data_filename

  Name of the file containing the data.

• .each_id(&block)

  Run the given block on each worldmap id.

• .get(id) ⇒ WorldMap

  Return a WorldMap.

• .worldmap_image_filename(filename) ⇒ String

  Give the appropriate filename for the worldmap image in Graphics/interface.

• .zone_list(id) ⇒ Array<Integer>

  Get the zones id of this worldmap.

Instance Method Summary

• #initialize(img, name_id, name_file_id) ⇒ WorldMap constructor

  Create a new GameData::WorldMap.

• #name ⇒ String

  Get the name of the worldmap.

• #zone_list_from_data ⇒ Array<Integer>

  Gather the zone list from data.

Methods included from DataSource

[], all, convert_to_symbols, db_symbol, get_id, id_valid?, load

Constructor Details

#initialize(img, name_id, name_file_id) ⇒ WorldMap

Create a new GameData::WorldMap

Instance Attribute Details

#data ⇒ Table, Array<WorldMapObject>

Informations on the map

Returns:

• (Table, Array<WorldMapObject>)

#image ⇒ String

Filename of the image used to display the world map

Returns:

• (String)

#name_file_id ⇒ Integer, ...

Wolrd map name file id

Returns:

• (Integer, String, nil)

#name_id ⇒ Integer

World map name text id

Returns:

• (Integer)

Class Method Details

.data_filename

Name of the file containing the data

.each_id(&block)

Run the given block on each worldmap id

Parameters:

• block (Proc)

.get(id) ⇒ WorldMap

Return a WorldMap

Parameters:

• id (Integer)

Returns:

• (WorldMap)

.worldmap_image_filename(filename) ⇒ String

Give the appropriate filename for the worldmap image in Graphics/interface

Parameters:

• filename (String)

Returns:

• (String)

.zone_list(id) ⇒ Array<Integer>

Get the zones id of this worldmap

Parameters:

• id (Integer) —

  the worldmap id

Returns:

• (Array<Integer>)

Instance Method Details

#name ⇒ String

Get the name of the worldmap

Returns:

• (String)

#zone_list_from_data ⇒ Array<Integer>

Gather the zone list from data. REALLY CONSUMING

Returns:

• (Array<Integer>)