Class: Studio::Zone

Inherits:
Object show all
Defined in:
scripts/00800 Studio/00001 Data/00091 Zone.rb

Overview

Data class describing a zone (set of map under the same name, group etc…)

Defined Under Namespace

Classes: MapCoordinate

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#db_symbol ⇒ Symbol (readonly)

db_symbol of the zone

Returns:

  • (Symbol) 


10
11
12
 
# File 'scripts/00800 Studio/00001 Data/00091 Zone.rb', line 10

def db_symbol
  @db_symbol
end

#forced_weather ⇒ Integer? (readonly)

ID of the weather to automatically trigger

Returns:



42
43
44
 
# File 'scripts/00800 Studio/00001 Data/00091 Zone.rb', line 42

def forced_weather
  @forced_weather
end

#id ⇒ Integer (readonly)

ID of the zone

Returns:



6
7
8
 
# File 'scripts/00800 Studio/00001 Data/00091 Zone.rb', line 6

def id
  @id
end

#is_fly_allowed ⇒ Boolean (readonly)

If the player can use fly, otherwise use dig

Returns:

  • (Boolean) 


34
35
36
 
# File 'scripts/00800 Studio/00001 Data/00091 Zone.rb', line 34

def is_fly_allowed
  @is_fly_allowed
end

#is_warp_disallowed ⇒ Boolean (readonly)

If the player cannot use any teleportation method (fly, dig, teleport)

Returns:

  • (Boolean) 


38
39
40
 
# File 'scripts/00800 Studio/00001 Data/00091 Zone.rb', line 38

def is_warp_disallowed
  @is_warp_disallowed
end

#maps ⇒ Array<Integer> (readonly)

List of maps included in this zone

Returns:



14
15
16
 
# File 'scripts/00800 Studio/00001 Data/00091 Zone.rb', line 14

def maps
  @maps
end

#panel_id ⇒ Integer (readonly)

ID of the panel to show when entering the zone (0 = none)

Returns:



22
23
24
 
# File 'scripts/00800 Studio/00001 Data/00091 Zone.rb', line 22

def panel_id
  @panel_id
end

#position ⇒ MapCoordinate (readonly)

Default position of the zone on the worldmap

Returns:



30
31
32
 
# File 'scripts/00800 Studio/00001 Data/00091 Zone.rb', line 30

def position
  @position
end

#warp ⇒ MapCoordinate (readonly)

Target warp coordinates when using Dig, Fly or Teleport

Returns:



26
27
28
 
# File 'scripts/00800 Studio/00001 Data/00091 Zone.rb', line 26

def warp
  @warp
end

#wild_groups ⇒ Array<Symbol> (readonly)

List of wild group db_symbol included on this map

Returns:

  • (Array<Symbol>) 


46
47
48
 
# File 'scripts/00800 Studio/00001 Data/00091 Zone.rb', line 46

def wild_groups
  @wild_groups
end

#worldmaps ⇒ Array<Integer> (readonly)

List of worldmap included in this zone

Returns:



18
19
20
 
# File 'scripts/00800 Studio/00001 Data/00091 Zone.rb', line 18

def worldmaps
  @worldmaps
end

Instance Method Details

#name ⇒ String

Get the zone name

Returns:



50
51
52
 
# File 'scripts/00800 Studio/00001 Data/00091 Zone.rb', line 50

def name
  return text_get(10, @id)
end