Class: Studio::Zone

Inherits:
Object show all
Defined in:
docs/3_Studio.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) 


1101
1102
1103
 
# File 'docs/3_Studio.rb', line 1101

def db_symbol
  @db_symbol
end

#forced_weather ⇒ Integer? (readonly)

ID of the weather to automatically trigger

Returns:

  • (Integer, nil) 


1125
1126
1127
 
# File 'docs/3_Studio.rb', line 1125

def forced_weather
  @forced_weather
end

#id ⇒ Integer (readonly)

ID of the zone

Returns:

  • (Integer) 


1098
1099
1100
 
# File 'docs/3_Studio.rb', line 1098

def id
  @id
end

#is_fly_allowed ⇒ Boolean (readonly)

If the player can use fly, otherwise use dig

Returns:

  • (Boolean) 


1119
1120
1121
 
# File 'docs/3_Studio.rb', line 1119

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) 


1122
1123
1124
 
# File 'docs/3_Studio.rb', line 1122

def is_warp_disallowed
  @is_warp_disallowed
end

#maps ⇒ Array<Integer> (readonly)

List of maps included in this zone

Returns:

  • (Array<Integer>) 


1104
1105
1106
 
# File 'docs/3_Studio.rb', line 1104

def maps
  @maps
end

#panel_id ⇒ Integer (readonly)

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

Returns:

  • (Integer) 


1110
1111
1112
 
# File 'docs/3_Studio.rb', line 1110

def panel_id
  @panel_id
end

#position ⇒ MapCoordinate (readonly)

Default position of the zone on the worldmap

Returns:



1116
1117
1118
 
# File 'docs/3_Studio.rb', line 1116

def position
  @position
end

#warp ⇒ MapCoordinate (readonly)

Target warp coordinates when using Dig, Fly or Teleport

Returns:



1113
1114
1115
 
# File 'docs/3_Studio.rb', line 1113

def warp
  @warp
end

#wild_groups ⇒ Array<Symbol> (readonly)

List of wild group db_symbol included on this map

Returns:

  • (Array<Symbol>) 


1128
1129
1130
 
# File 'docs/3_Studio.rb', line 1128

def wild_groups
  @wild_groups
end

#worldmaps ⇒ Array<Integer> (readonly)

List of worldmap included in this zone

Returns:

  • (Array<Integer>) 


1107
1108
1109
 
# File 'docs/3_Studio.rb', line 1107

def worldmaps
  @worldmaps
end

Instance Method Details

#name ⇒ String

Get the zone name

Returns:



1131
1132
 
# File 'docs/3_Studio.rb', line 1131

def name
end