[DONE][Suggestion] cantBeBuiltWith property for xcom base facilities

[Finnik]

Edit by Meridian: final solution here: https://openxcom.org/forum/index.php/topic,8017.msg125175.html#msg125175

Hello guys, im really interested what are you think about my tiny new feature for Open Xcom Extended in form of cantBeBuiltWith property for xcom base facilities.

Here is a sample ruleset code:

Code: [Select]

facilities:
  - type: STR_LARGE_RADAR_SYSTEM
    spriteShape: 1
    spriteFacility: 22
    buildCost: 800000
    buildTime: 25
    monthlyCost: 15000
    radarRange: 2577
    radarChance: 20
    mapName: XBASE_05
    cantBeBuiltWith:
      - STR_SMALL_RADAR_SYSTEM

What it actually does – its allows a modder to restrict certain facility to be built if the specified facility was already been built on that base. This will be especially useful for creating upgrades for unique facilities, that already using both buildOverFacilities and maxAllowedPerBase properties.
For example, in The Xcom Files we have the xcom HQ facility and its improved version. Thus, we would like to forbid the player to build a normal version of the headquarters if there is already an improved version, but we should allow building an improvement over the normal version of the headquarters.
There are not many changes:

https://github.com/MeridianOXC/OpenXcom/compare/oxce-plus...FinnikXCF:oxce-plus

I can make a pull request if it's ok. If not, please, let me know, I will correct it.

Any feedback from modders is also very welcome!

[Meridian]

why not use `forbiddenBaseFunc` ?

[ohartenstein23]

This is already done in Piratez and I think XCF too using the providesBaseFunc and forbiddenBaseFunc parameters to limit certain facilities to one per base.

[Finnik]

The first motivation here was to provide properties for upgrading unique facilities. Like HQ should be one per base and have an upgrade into Cyber HQ (i want to make the same for intel and bio labs here to make advanced versions of them). So we have rules like this:

Code: [Select]

facilities:
  - type: STR_HQ
    spriteShape: 1
    spriteFacility: 317
    provideBaseFunc: [BIOLAB, INTLAB]
    buildCost: 3000000
    buildTime: 40
    monthlyCost: 20000
    canBeBuiltOver: true
    maxAllowedPerBase: 1
    storage: 25
    labs: 5
    rightClickActionType: 3
    radarRange: 10800
    radarChance: 2
    mapName: XBASS_22
    listOrder: 6830
  - type: STR_CYBER_HQ
    requires:
      - STR_CYBER_HQ
    spriteShape: 1
    spriteFacility: 874
    provideBaseFunc: [BIOLAB, INTLAB, AI]
    maxAllowedPerBase: 1
    buildCost: 4000000
    buildTime: 50
    monthlyCost: 40000
    buildOverFacilities:
      - STR_HQ
    storage: 25
    labs: 10
    manaRecoveryPerDay: 2
    rightClickActionType: 3
    radarRange: 10800
    radarChance: 3
    mapName: XBASS_33
    listOrder: 6832

I tried to use `forbiddenBaseFunc` in different ways, but I can't make it work.

[Meridian]

- Airlock should provide funcA
- Small radar should require funcA and provide funcB
- Big radar should require funcB and forbid funcA

[Finnik]

Yes, I tried that...

Code: [Select]

facilities:
  - type: STR_ACCESS_LIFT
    spriteShape: 2
    spriteFacility: 17
    lift: true
    provideBaseFunc: [funcA]
    buildCost: 300000
    buildTime: 1
    monthlyCost: 4000
    mapName: XBASE_00
  - type: STR_SMALL_RADAR_SYSTEM
    spriteShape: 2
    spriteFacility: 21
    requiresBaseFunc: [funcA]
    provideBaseFunc: [funcB]
    buildCost: 500000
    buildTime: 12
    monthlyCost: 10000
    radarRange: 1695
    radarChance: 10
    mapName: XBASE_04
  - type: STR_LARGE_RADAR_SYSTEM
    spriteShape: 1
    spriteFacility: 22
    requiresBaseFunc: [funcB]
    forbiddenBaseFunc: [funcA]
    buildCost: 800000
    buildTime: 25
    monthlyCost: 15000
    radarRange: 2577
    radarChance: 20
    mapName: XBASE_05



What am I doing wrong?

[Meridian]

hmm, I guess the feature is not compatible with upgrades, probably checking too much or not enough...

I'll check later

[Finnik]

Upgrades do not count, I did this rules on pure vanilla (the screenshot was done exactly on that rules I posted), that my radars are not upgrades, but just separate buildings...

[Yankes]

If I understand correctly, you want:

FacilityA
FacilityB
FacilityC

Only one of this 3 can exists in base, and you can upgrade them (FacilityA to FacilityB and FacilityB to FacilityC).

Looking on code this is impossible right now because required and forbidden are check on populating build list.

Right now to have only one facility from list you need define same functionality for both provided and forbidden list.
But then you can't upgrade because this building is not available on list.


One way I see to fix it, is allow conditional build if `buildOverFacilities` exists in base and have same "unique" functionalities that building we want build.
Then if you tray build it on other place that this old building you will get error, but if you "over" build you will allowed.

[Meridian]

Upgrades do not count, I did this rules on pure vanilla (the screenshot was done exactly on that rules I posted), that my radars are not upgrades, but just separate buildings...

That's what I meant too.
All upgrades are currently normal facilities, you can't have a facility which is only an upgrade.

[Finnik]

That's what I meant too.
All upgrades are currently normal facilities, you can't have a facility which is only an upgrade.

cant we? =) https://openxcom.org/forum/index.php/topic,8022.0.html

[Meridian]

cant we? =) https://openxcom.org/forum/index.php/topic,8022.0.html

No, we can't.
That functionality is not in OXCE yet.

[efrenespartano]

I really like this feature. I can see many uses for the mods of the IDT.

I hope its in the next OXCE, looking forward to see it, Finnik!

Enviado desde mi LG-M400 mediante Tapatalk

[Finnik]

No, we can't.
That functionality is not in OXCE yet.

Ok, but we could, for example, with that

[Meridian]

If I understand correctly, you want:

FacilityA
FacilityB
FacilityC

Only one of this 3 can exists in base, and you can upgrade them (FacilityA to FacilityB and FacilityB to FacilityC).

Looking on code this is impossible right now because required and forbidden are check on populating build list.

Right now to have only one facility from list you need define same functionality for both provided and forbidden list.
But then you can't upgrade because this building is not available on list.


One way I see to fix it, is allow conditional build if `buildOverFacilities` exists in base and have same "unique" functionalities that building we want build.
Then if you try build it on other place than this old building you will get error, but if you "over" build you will allowed.

Yes, after reading Solarius's explanation (https://openxcom.org/forum/index.php/topic,8022.msg124856.html#msg124856) I think we can achieve it without any new attributes, the way you describe.

Just one small technical correction maybe, the upgrades don't need to have the "same" unique functionalities... they can have "same or more", for example:

FacilityA - funcX
FacilityB - funcX, funcY
FacilityC - funcX, funcY, funcZ

is allowed, but:

FacilityA - funcX, funcY, funcZ
FacilityB - funcX, funcY
FacilityC - funcX

is not allowed.