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)


1280
1281
1282
# File 'docs/3_Studio.rb', line 1280

def db_symbol
  @db_symbol
end

#forced_weather ⇒ Integer? (readonly)

ID of the weather to automatically trigger

Returns:

  • (Integer, nil)


1304
1305
1306
# File 'docs/3_Studio.rb', line 1304

def forced_weather
  @forced_weather
end

#id ⇒ Integer (readonly)

ID of the zone

Returns:

  • (Integer)


1277
1278
1279
# File 'docs/3_Studio.rb', line 1277

def id
  @id
end

#is_fly_allowed ⇒ Boolean (readonly)

If the player can use fly, otherwise use dig

Returns:

  • (Boolean)


1298
1299
1300
# File 'docs/3_Studio.rb', line 1298

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)


1301
1302
1303
# File 'docs/3_Studio.rb', line 1301

def is_warp_disallowed
  @is_warp_disallowed
end

#maps ⇒ Array<Integer> (readonly)

List of maps included in this zone

Returns:

  • (Array<Integer>)


1283
1284
1285
# File 'docs/3_Studio.rb', line 1283

def maps
  @maps
end

#panel_id ⇒ Integer (readonly)

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

Returns:

  • (Integer)


1289
1290
1291
# File 'docs/3_Studio.rb', line 1289

def panel_id
  @panel_id
end

#position ⇒ MapCoordinate (readonly)

Default position of the zone on the worldmap

Returns:



1295
1296
1297
# File 'docs/3_Studio.rb', line 1295

def position
  @position
end

#warp ⇒ MapCoordinate (readonly)

Target warp coordinates when using Dig, Fly or Teleport

Returns:



1292
1293
1294
# File 'docs/3_Studio.rb', line 1292

def warp
  @warp
end

#wild_groups ⇒ Array<Symbol> (readonly)

List of wild group db_symbol included on this map

Returns:

  • (Array<Symbol>)


1307
1308
1309
# File 'docs/3_Studio.rb', line 1307

def wild_groups
  @wild_groups
end

#worldmaps ⇒ Array<Integer> (readonly)

List of worldmap included in this zone

Returns:

  • (Array<Integer>)


1286
1287
1288
# File 'docs/3_Studio.rb', line 1286

def worldmaps
  @worldmaps
end

Instance Method Details

#name ⇒ String

Get the zone name

Returns:



1310
1311
# File 'docs/3_Studio.rb', line 1310

def name
end