Class: GameData::Zone

Inherits:

Base

• Object
• Base
• GameData::Zone

Extended by:

DataSource

Defined in:

scripts/00800 GameData/00100 Serializable/00900 Zone.rb

Overview

Map Zone Data structure

Author:

• Nuri Yuri

Direct Known Subclasses

Map

Constant Summary

Constants included from DataSource

DataSource::SOURCES

Instance Attribute Summary

• #description ⇒ String^?

  Unused.

• #fly_allowed ⇒ Boolean

  If the player can use fly in this zone (otherwise he can use Dig).

• #forced_weather ⇒ Integer^?

  ID of the weather in the zone.

• #groups ⇒ Array^?

  See PFM::Wild_Battle#load_groups.

• #map_id ⇒ Integer⁺

  ID or list of MAP ID the zone is related to.

• #panel_id ⇒ Integer

  Number at the end of the Panel file (Graphics/Windowskins/Panel_#panel_id).

• #pos_x ⇒ Integer^?

  X position of the player on the World Map.

• #pos_y ⇒ Integer^?

  Y position of the player on the World Map.

• #sub_map ⇒ Array^?

  Unused.

• #warp_dissalowed ⇒ Boolean

  If its not allowed to use fly, dig or teleport in this zone.

• #warp_x ⇒ Integer^?

  X position of the Warp when using Dig, Teleport or Fly.

• #warp_y ⇒ Integer^?

  Y position of the Warp when using Dig, Teleport or Fly.

• #worldmap_id ⇒ Integer

  ID of the worldmap to display when in this zone.

Attributes inherited from Base

#db_symbol, #id

Class Method Summary

• .data_filename

  Name of the file containing the data.

• .get(id) ⇒ Zone

  Return a zone according to its id.

• .load_data(filename)

  Load the data properly.

• .origina_load_data

Instance Method Summary

• #initialize(map_id, panel_id = 0, description = nil, warp_x = nil, warp_y = nil, sub_map = nil, pos_x = nil, pos_y = nil, fly_allowed = true, warp_dissalowed = false, forced_weather = nil, worldmap_id = 0) ⇒ Zone constructor

  Create a new GameData::Map object.

• #map_included?(map_id) ⇒ Boolean

  Indicate if a map (by its id) is included in this zone.

• #map_name ⇒ String

  Return the real name of the map (multi-lang compatible).

• #warp_disallowed

  Correct name of the attribute.

Methods included from DataSource

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

Constructor Details

#initialize(map_id, panel_id = 0, description = nil, warp_x = nil, warp_y = nil, sub_map = nil, pos_x = nil, pos_y = nil, fly_allowed = true, warp_dissalowed = false, forced_weather = nil, worldmap_id = 0) ⇒ Zone

Create a new GameData::Map object

Parameters:

• map_id (Integer) —

  future value of the attribute

• panel_id (Integer) (defaults to: 0) —

  future value of the attribute

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

  future value of the attribute

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

  future value of the attribute

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

  future value of the attribute

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

  future value of the attribute

• sub_map (Array, nil) (defaults to: nil) —

  future value of the attribute

• fly_allowed (Boolean) (defaults to: true) —

  future value of the attribute

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

  future value of the attribute

• forced_weather (Integer) (defaults to: nil) —

  future value of the attribute

• description (String, nil) (defaults to: nil) —

  future value of the attribute

• worldmap_id (Integer, 0) (defaults to: 0) —

  future value of the attribute

Instance Attribute Details

#description ⇒ String^?

Unused

Returns:

• (String, nil)

#fly_allowed ⇒ Boolean

If the player can use fly in this zone (otherwise he can use Dig)

Returns:

• (Boolean)

#forced_weather ⇒ Integer^?

ID of the weather in the zone

Returns:

• (Integer, nil)

#groups ⇒ Array^?

See PFM::Wild_Battle#load_groups

Returns:

• (Array, nil)

#map_id ⇒ Integer⁺

ID or list of MAP ID the zone is related to. (RMXP MAP ID !)

Returns:

• (Integer, Array<Integer>)

#panel_id ⇒ Integer

Number at the end of the Panel file (Graphics/Windowskins/Panel_#panel_id)

Returns:

• (Integer) —

  if 0 no pannel is shown

#pos_x ⇒ Integer^?

X position of the player on the World Map

Returns:

• (Integer, nil)

#pos_y ⇒ Integer^?

Y position of the player on the World Map

Returns:

• (Integer, nil)

#sub_map ⇒ Array^?

Unused

Returns:

• (Array, nil)

#warp_dissalowed ⇒ Boolean

If its not allowed to use fly, dig or teleport in this zone

Returns:

• (Boolean)

#warp_x ⇒ Integer^?

X position of the Warp when using Dig, Teleport or Fly

Returns:

• (Integer, nil) —

  nil if no warp

#warp_y ⇒ Integer^?

Y position of the Warp when using Dig, Teleport or Fly

Returns:

• (Integer, nil) —

  nil if no warp

#worldmap_id ⇒ Integer

ID of the worldmap to display when in this zone

Returns:

• (Integer)

Class Method Details

.data_filename

Name of the file containing the data

.get(id) ⇒ Zone

Return a zone according to its id

Parameters:

• id (Integer)

Returns:

• (Zone)

.load_data(filename)

Load the data properly

.origina_load_data

Instance Method Details

#map_included?(map_id) ⇒ Boolean

Indicate if a map (by its id) is included in this zone

Returns:

• (Boolean)

#map_name ⇒ String

Return the real name of the map (multi-lang compatible)

Returns:

• (String)

#warp_disallowed

Correct name of the attribute