How to use the mapping

This is used to map different variable values to the correct property code. For every property, the different accepted incoming values are in a specific order below - it doesn't matter for the code, but makes it easier to find things manually.

The order of the values

1. $home_name['property code']

2. $home_name['property id'] - for backward compatibility only, nothing else and the number is a string index

3. $home_name['enctrance location']

4. $home_name['other locations']
   ...

Most homes_properties function and call uses this mapping to allow for the use of the different locations or simply the value of the $loc variable.

Maintaining the mapping

Property: Generally this means a house or an appartment where Sveta can live - e.g., the parents' home in Pavlovsk, the Meynold household, etc. - and frequently can have some effect on it - the residential appartment that Sveta can rent or buy - and generally has more than one location.

It doesn't have to be a home though, it could be music studio or an office that Sveta can rent or buy, or a newspaper kiosk on the corner where Sveta can work, pays rent for it, etc.

Location: A room in a property - the bedroom, the kitchen, the backyard, etc. - that has its own location.qsrc file.

Every location that belongs to the property has to be mapped to the property, otherwise the code won't be able to answer questions like "Is Sveta at home?" when standing in the bedroom.

Whenever a location that belongs to a property changes - for example, with release 8.8.0 the shulga_* locations were replaced by the single vasilyhome location - the mapping needs to be updated here.

Similarly, if a new property is introduced, the mapping has to be added to this list in the homes_properties_attr.qsrc file, otherwise the code won't recognise the locations and the home.

Valid Location and Property Mappings

CITY APARTMENT

'city_apartment' = 'city_apartment'
'1' = 'city_apartment'
'korr' = 'city_apartment'
'bedr' = 'city_apartment'
'sitr' = 'city_apartment'
'kuhr' = 'city_apartment'
'vanr' = 'city_apartment'

PARENTS HOME

'parents_home' = 'parents_home'
'2' = 'parents_home'
'code' = 'parents_home'
'korrPar' = 'parents_home'
'bedrPar' = 'parents_home'
'sitrPar' = 'parents_home'
'kuhrPar' = 'parents_home'
'vanrPar' = 'parents_home'

VILLAGE COTTAGE

'village_cottage' = 'village_cottage'
'3' = 'village_cottage'
'dachamy' = 'village_cottage'
'dachain' = 'village_cottage'
'dachaogr' = 'village_cottage'
'dachaogr0' = 'village_cottage'

OLD TOWN (PUSHKIN) APARTMENTS

'old_town_apartment' = 'old_town_apartment'
'4' = 'old_town_apartment'
'korr2x' = 'old_town_apartment'
'bedr2x' = 'old_town_apartment'
'sitr2x' = 'old_town_apartment'
'kuhr2x' = 'old_town_apartment'
'vanr2x' = 'old_town_apartment'

MATRYONA MANSION

'matryona_mansion' = 'matryona_mansion'
'5' = 'matryona_mansion'
'city_mansion_entrance' = 'matryona_mansion'
'city_mansion_residence_1' = 'matryona_mansion'
'city_mansion_residence_2' = 'matryona_mansion'
'city_mansion_residence_3' = 'matryona_mansion'

PAVLOVSK HOTEL

'pavlovsk_hotel' = 'pavlovsk_hotel'
'6' = 'pavlovsk_hotel'
'pav_hotel' = 'pavlovsk_hotel'
'HotelRoom' = 'pavlovsk_hotel'

LIVE IN MAID BEDROOM

'maid_bedroom' = 'maid_bedroom'
'7' = 'maid_bedroom'
'nichBedroomServant' = 'maid_bedroom'

NIKO'S APARTMENT

'niko_apartment' = 'niko_apartment'
'8' = 'niko_apartment'

This home actually doesn't exist yet, but it was defined, has an ID and all so, I am keeping it here

SHULGA APARTMENT

'shulga_apartment' = 'vasilyhome'
'9' = 'vasilyhome'
'vasilyhome' = 'vasilyhome'

LYCEUM DORM

'lyceum_dorm' = 'lyceum_dorm'
'10' = 'lyceum_dorm'
'dom_gor' = 'lyceum_dorm'

UNIVERSITY DORM

'university_dorm' = 'university_dorm'
'11' = 'university_dorm'
'uni_grounds' = 'university_dorm'
'uni_dorm' = 'university_dorm'

HUNTERS LODGE

'hunters_lodge' = 'hunters_lodge'
'12' = 'hunters_lodge'
'swamphouse' = 'hunters_lodge'
'swamp_yard' = 'hunters_lodge'

SHARED APARTMENT - PAVLOVSK

'shared_apartment' = 'shared_apartment'
'13' = 'shared_apartment'
'pav_shared_apt' = 'shared_apartment'

GRANDPARENTS HOUSE

'grandparents_house' = 'grandparents_house'
'14' = 'grandparents_house'
'gaddvor' = 'grandparents_house'
'gadgarden' = 'grandparents_house'
'gadbana' = 'grandparents_house'
'gadgarden' = 'grandparents_house'
'gadhouse' = 'grandparents_house'

CITY HOUSE

'city_house' = 'city_house'
'15' = 'city_house'
'city_house_res_misc' = 'city_house'
'city_house_res_bath' = 'city_house'
'city_house_re_bedr' = 'city_house'
'city_house-res_kitch' = 'city_house'

MEYNODLD HOUSEHOLD

'meynold_household' = 'meynold_household'
'16' = 'meynold_household'
'mey_home' = 'meynold_household'

HOTEL (for the therapist story)

'hotel_therapist' = 'hotel_therapist'
'17' = 'hotel_therapist'

PUSHKIN BALLET DORM

'pushkin_ballet_dorm' = 'pushkin_ballet_dorm'
'18' = 'pushkin_ballet_dorm'