Class: Studio::MapLink

Inherits:
Object show all
Defined in:
docs/3_Studio.rb

Overview

Note:

This class has an id and a map_id, this leaves room to add conditional map links in the future ;)

Data class describing a map link

Defined Under Namespace

Classes: Link

Instance Attribute Summary collapse

Instance Attribute Details

#db_symbol ⇒ Symbol (readonly)

db_symbol of the map link

Returns:

  • (Symbol)


1331
1332
1333
# File 'docs/3_Studio.rb', line 1331

def db_symbol
  @db_symbol
end

#east_maps ⇒ Array<Link> (readonly)

List of maps linked to the east cardinal of current map

Returns:



1340
1341
1342
# File 'docs/3_Studio.rb', line 1340

def east_maps
  @east_maps
end

#id ⇒ Integer (readonly)

ID of the map link

Returns:

  • (Integer)


1328
1329
1330
# File 'docs/3_Studio.rb', line 1328

def id
  @id
end

#map_id ⇒ Integer (readonly)

ID of the map player should be in to have this link

Returns:

  • (Integer)


1334
1335
1336
# File 'docs/3_Studio.rb', line 1334

def map_id
  @map_id
end

#north_maps ⇒ Array<Link> (readonly)

List of maps linked to the north cardinal of current map

Returns:



1337
1338
1339
# File 'docs/3_Studio.rb', line 1337

def north_maps
  @north_maps
end

#south_maps ⇒ Array<Link> (readonly)

List of maps linked to the south cardinal of current map

Returns:



1343
1344
1345
# File 'docs/3_Studio.rb', line 1343

def south_maps
  @south_maps
end

#west_maps ⇒ Array<Link> (readonly)

List of maps linked to the west cardinal of current map

Returns:



1346
1347
1348
# File 'docs/3_Studio.rb', line 1346

def west_maps
  @west_maps
end