[Feature Request] Requirements for Using (Strategic and/or Tactical) One-Use Items, including Allegiance, Tech, Global Resource Value, Player Skill, Unit Skill, Unit Unitstat.

from Elemental Forums

EDIT: Since I know know that you can do all sorts of things with skills and equippable items, I now restrict the request to preventing units using certain items if they (or their player, as relevent for allegiance, tech, global resource value or player skills) don't have the correct allegiance, tech, global resource value (does not need to be taken away, although this could be an option which could be on/off for each resource to take away once it has been determined they have enough that they don't go below 0, so you could limit the number of uses of an item on a player level), player or unit skill, or unit unitstat (again, like a global resource, there could be an on/off option for an item to use up a certain amount of a certain unitstat, to restrict the number of uses of the item for any unit does not have sufficient unitstat of a certain kind, or has used it all up).

 

Similar to the Armor Proficiency skills, it would open up so many possibilities if you could make certain weapons, accessories, items etc. only equippable/usable by those with certain skills or equipped items, or have equippable/usable items that give extra bonuses to only those who have certain skills and/or equipped items.

Examples:

- So you could have Class, Skill or Profession Specific weapons, armor, trinkets, usable items;

- Class Bonuses For Particular Weapons, Armor or Accessories;

- No Initiative Penalty Ranged Staves for Mage Heroes, or Skills which offset Initiative Penalties for Ranged Staves, but only when the Stave is equipped;

- Equippable/usable Items that give an extra bonus IF you have certain skills or item/s;

- Items that can only be used/equipped if you have certain skills, or certain items equipped, or both.  This can include tactical and strategic use items.

The possibilities are endless, and especially the allowing/disallowing of certain equippable items is already in the game, that part should be easy to open to modders, why not even open this up to "allow use or equip based on skills or equipped items", "bonus to use or equip based on skills or equipped items".

Look forward to your feedback on this everyone!  Devs/players welcome!

6,968 views 12 replies
Reply #1 from Stardock Forums Top

- No Initiative Penalty Ranged Staves for Mage Heroes, or Skills which offset Initiative Penalties for Ranged Staves, but only when the Stave is equipped;
End of quote

I think you have two options for this.

1) Make separate staves that are only available to heroes

- Copy the code of the researchable staves.

- Change the internal (and display) name.

- Remove the init penalty.

- Make them unavailable for unit design.

You can now buy staves without init penalty for your heroes from the shop, but your mage units will still use staves with an init penalty.

2) Create a new skill/unit trait that allows the use of the mentioned staves (I don't think you can make a skill that boosts initiative only when a specific item is equipped) You could chose whether this trait is for heroes only or not.

 

Similar to the Armor Proficiency skills, it would open up so many possibilities if you could make certain weapons, accessories, items etc. only equippable/usable by those with certain skills or equipped items, or have equippable/usable items that give extra bonuses to only those who have certain skills and/or equipped items.
End of quote

Modders should already be able to link specific equipment to traits as far as I can tell. I didn't actually try it myself yet, so what follows is just how I would handle it (which may be very, very wrong)

- Make a new UnitStat with default value 0. e.g.

Code: xml
  3. <UnitStatType InternalName="UnitStat_StaffProficiency">
  4. <DisplayName>Staff Proficiency</DisplayName>
  5. <Description>Can this unit use special staves?</Description>
  6. <Hidden>1</Hidden>
  7. <DefaultValue>0.0</DefaultValue>
  8. </UnitStatType>

- Then make a unit trait that grants 1 Staff Proficiency. e.g. 

Code: xml
  3. <AbilityBonus InternalName="StaffProficiencyAbility">
  4. <AbilityBonusType>Unit_Design</AbilityBonusType>
  5. <AbilityBonusOption InternalName="StaffProficiency">
  6. <DisplayName>Staff Proficiency</DisplayName>
  7. <Description>Allows the unit to use staves without Initiative penalty</Description>
  8. <Icon>???.png</Icon>
  9. <GameModifier>
  10. <ModType>Unit</ModType>
  11. <Attribute>AdjustUnitStat</Attribute>
  12. <StrVal>UnitStat_StaffProficiency</StrVal>
  13. <Value>1</Value>
  14. <Provides>Allows the unit to use staves without Initiative penalty</Provides>
  15. </GameModifier>
  16. <AdditionalTrainingTurns>5</AdditionalTrainingTurns>
  17. <Type>Offensive</Type>
  18. <SupportedUnitModelType>AmarianFemale</SupportedUnitModelType>
  19. <SupportedUnitModelType>AmarianMale</SupportedUnitModelType>
  20. <SupportedUnitModelType>Banshee</SupportedUnitModelType>
  21. <SupportedUnitModelType>EmpireFemale</SupportedUnitModelType>
  22. <SupportedUnitModelType>EmpireMale</SupportedUnitModelType>
  23. <SupportedUnitModelType>FallenFemale</SupportedUnitModelType>
  24. <SupportedUnitModelType>FallenMale</SupportedUnitModelType>
  25. <SupportedUnitModelType>IroneerFemale</SupportedUnitModelType>
  26. <SupportedUnitModelType>IroneerMale</SupportedUnitModelType>
  27. <SupportedUnitModelType>KingdomFemale</SupportedUnitModelType>
  28. <SupportedUnitModelType>KingdomMale</SupportedUnitModelType>
  29. <SupportedUnitModelType>MancerFemale</SupportedUnitModelType>
  30. <SupportedUnitModelType>MancerMale</SupportedUnitModelType>
  31. <SupportedUnitModelType>QuendarFemale</SupportedUnitModelType>
  32. <SupportedUnitModelType>QuendarMale</SupportedUnitModelType>
  33. <SupportedUnitModelType>Skeleton</SupportedUnitModelType>
  34. <SupportedUnitModelType>SlaveMale</SupportedUnitModelType>
  35. <SupportedUnitModelType>TarthanFemale</SupportedUnitModelType>
  36. <SupportedUnitModelType>TarthanMale</SupportedUnitModelType>
  37. <SupportedUnitModelType>UrxenFemale</SupportedUnitModelType>
  38. <SupportedUnitModelType>UrxenMale</SupportedUnitModelType>
  39. <SupportedUnitModelType>WraithFemale</SupportedUnitModelType>
  40. <SupportedUnitModelType>WraithMale</SupportedUnitModelType>
  41. <AIData AIPersonality="AI_General">
  42. <AIPriority>5</AIPriority>
  43. </AIData>
  44. </AbilityBonusOption>

- And finally make your staves without initiative penalty and make them have 1 Staff Proficiency as Prereq (change the internalname). e.g.

Code: xml
  3. <GameItemType InternalName="Staff_Incineration2">
  4. <DisplayName>Incineration Staff</DisplayName>
  5. <Description>A jet of fire can be coaxed from the embers that eternally burn on the tip of this staff.</Description>
  6. <Type>Weapon</Type>
  7. <Type>Defense</Type>
  8. <WeaponType>Staff</WeaponType>
  9. <WeaponUpgradeType>FireStaff</WeaponUpgradeType>
  10. <CanBeEquipped>1</CanBeEquipped>
  11. <AdditionalTrainingTurns>24</AdditionalTrainingTurns>
  12. <CustomizationPointCost>1</CustomizationPointCost>
  13. <ShopValue>150</ShopValue>
  14. <ProductionRequirement>
  15. <Type>Resource</Type>
  16. <Attribute>RefinedCrystal</Attribute>
  17. <Value>3</Value>
  18. </ProductionRequirement>
  19. <GameModifier>
  20. <ModType>Unit</ModType>
  21. <Attribute>AdjustUnitStat</Attribute>
  22. <StrVal>UnitStat_Attack_Fire</StrVal>
  23. <Value>6</Value>
  24. </GameModifier>
  25. <GameModifier>
  26. <GameModifier>
  27. <ModType>Unit</ModType>
  28. <Attribute>UnlockRangedAction</Attribute>
  29. <StrVal>BowAttack_Flaming</StrVal>
  30. <Provides>Ranged attack</Provides>
  31. </GameModifier>
  32. <IsAvailableForSovereignCustomization>1</IsAvailableForSovereignCustomization>
  33. <Likelihood>200</Likelihood>
  34. <RarityDisplay>Uncommon</RarityDisplay>
  35. <TacticalRange>20</TacticalRange>
  36. <Prereq>
  37. <Type>RestrictedAbilityBonusOption</Type>
  38. <Attribute>NoRangedWeapons</Attribute>
  39. <Target>Player</Target>
  40. </Prereq>
  41. <Prereq>
  42. <Type>Tech</Type>
  43. <Attribute>Enchantment</Attribute>
  44. </Prereq>
  46. <Prereq>
  47. <Type>UnitStat</Type>
  48. <Attribute>UnitStat_StaffProficiency</Attribute>
  49. <Value>1</Value>
  50. </Prereq>
  52. <AIData AIPersonality="AI_General">
  54. <AIPrefType>AIPrefType_BLUNT</AIPrefType>
  55. <AIPriority>60</AIPriority>
  56. </AIData>
  57. <ArtDef>Staff_Incineration_ArtDef</ArtDef>
  58. <GameItemTypeArtDef InternalName="Staff_Incineration_ArtDef">
  59. <GameItemTypeModelPack InternalName="Staff_Incineration_Default">
  60. <IconFile>W_Staff_Incineration_Icon_01.png</IconFile>
  61. <TintR>0</TintR>
  62. <TintG>0</TintG>
  63. <TintB>0</TintB>
  64. <AttackSFX>Hit_FireStaff_01</AttackSFX>
  65. <AttackSFX>Hit_FireStaff_02</AttackSFX>
  66. <AttackSFX>Hit_FireStaff_03</AttackSFX>
  67. <EquipSFX>Equip_WoodenItem_01</EquipSFX>
  68. <EquipSFX>Equip_WoodenItem_02</EquipSFX>
  69. <EquipSFX>Equip_WoodenItem_03</EquipSFX>
  70. <OnHitParticleName>Staff_Attack</OnHitParticleName>
  71. <SoundPack>SoundPack_Staff_Fire</SoundPack>
  72. <SupportedUnitModelType>AmarianFemale</SupportedUnitModelType>
  73. <SupportedUnitModelType>AmarianMale</SupportedUnitModelType>
  74. <SupportedUnitModelType>Banshee</SupportedUnitModelType>
  75. <SupportedUnitModelType>DarklingMale</SupportedUnitModelType>
  76. <SupportedUnitModelType>EmpireFemale</SupportedUnitModelType>
  77. <SupportedUnitModelType>EmpireMale</SupportedUnitModelType>
  78. <SupportedUnitModelType>FallenFemale</SupportedUnitModelType>
  79. <SupportedUnitModelType>FallenMale</SupportedUnitModelType>
  80. <SupportedUnitModelType>HenchmanMale</SupportedUnitModelType>
  81. <SupportedUnitModelType>IroneerFemale</SupportedUnitModelType>
  82. <SupportedUnitModelType>IroneerMale</SupportedUnitModelType>
  83. <SupportedUnitModelType>KingdomFemale</SupportedUnitModelType>
  84. <SupportedUnitModelType>KingdomMale</SupportedUnitModelType>
  85. <SupportedUnitModelType>MancerFemale</SupportedUnitModelType>
  86. <SupportedUnitModelType>MancerMale</SupportedUnitModelType>
  87. <SupportedUnitModelType>QuendarFemale</SupportedUnitModelType>
  88. <SupportedUnitModelType>QuendarMale</SupportedUnitModelType>
  89. <SupportedUnitModelType>Skeleton</SupportedUnitModelType>
  90. <SupportedUnitModelType>SlaveMale</SupportedUnitModelType>
  91. <SupportedUnitModelType>TarthanFemale</SupportedUnitModelType>
  92. <SupportedUnitModelType>TarthanMale</SupportedUnitModelType>
  93. <SupportedUnitModelType>UrxenFemale</SupportedUnitModelType>
  94. <SupportedUnitModelType>UrxenMale</SupportedUnitModelType>
  95. <SupportedUnitModelType>WraithFemale</SupportedUnitModelType>
  96. <SupportedUnitModelType>WraithMale</SupportedUnitModelType>
  97. <GameItemTypeModel>
  98. <ModelFile>gfx/hkb/weapons/w_banishing_staff_mesh_02.hkb</ModelFile>
  99. <Texture_All>W_Club_Texture_01.png</Texture_All>
  100. <Attachment>hand_right_Lcf</Attachment>
  101. <Color_Metal>151, 39,39</Color_Metal>
  102. <EffectAttachment>
  103. <Attachment>Effect_Loc_04</Attachment>
  104. <EffectName>A_IncinerationStaff_Particle</EffectName>
  105. <EffectPosition>0,0,-5</EffectPosition>
  106. <EffectRotation>0,0,0</EffectRotation>
  107. <EffectScale>0.25</EffectScale>
  108. </EffectAttachment>
  109. </GameItemTypeModel>
  110. </GameItemTypeModelPack>
  111. </GameItemTypeArtDef>
  112. </GameItemType>

Reply #2 from Elemental Forums Top

Oh, okay, so you can use unitstats in that way.  Well, that's handy to know, thanks a lot for that. =)

Sins of a Solar Empire II
Reply #4 from Stardock Forums Top

Quoting StevenAus, reply 3

Can you have prereqs for using a usable item?
End of StevenAus's quote

I don't think any of the current usables has a prereq, but they're in the files as GameItemType (same as armor and weapons), so it might be possible. I can't give a conclusive answer without testing though (and can't test it until the weekend)

Reply #7 from Elemental Forums Top

No, it doesn't appear to work, at least with Allegiance or Unitstats.  I overwrote the Salted Pork item to have a Kingdom allegiance, tested it, then instead to require Unitstat Armor Proficiency of 1 (Chain Armor Proficiency), and tested it.  Both times I used the same Empire Sov with no armor proficiency.  It still worked, it wasn't blocked, both times.

Code: xml
  1. <GameItemTypes>
  2.     <GameItemType InternalName="SaltedPork">
  3.         <DisplayName>Salted Pork</DisplayName>
  4.         <Description>A rare type of salted pork that works wonders for a weary soul.  Eat it to heal.</Description>
  5.         <ShopValue>30</ShopValue>
  6.         <GameModifier>
  7.             <ModType>Unit</ModType>
  8.             <Attribute>CurHealth</Attribute>
  9.             <Value>12</Value>
  10.             <Provides>Heals 12 Hit Points</Provides>
  11.         </GameModifier>
  12.         <Prereq>
  13.             <Type>Allegiance</Type>
  14.             <Attribute>Kingdom</Attribute>
  15.         </Prereq>
  16.         <IsAvailableForSovereignCustomization>0</IsAvailableForSovereignCustomization>
  17.         <RarityDisplay>Common</RarityDisplay>
  18.         <IsUsable>1</IsUsable>
  19.         <UsableInBattle>1</UsableInBattle>
  20.         <ArtDef>SaltedPork_ArtDef</ArtDef>
  21.         <GameItemTypeArtDef InternalName="SaltedPork_ArtDef">
  22.             <GameItemTypeModelPack InternalName="SaltedPork_Default">
  23.                 <IconFile>SaltedPork_Item.png</IconFile>
  24.                 <MapParticle>T_Heal_Particle</MapParticle>
  25.                 <TintR>79</TintR>
  26.                 <TintG>48</TintG>
  27.                 <TintB>20</TintB>
  28.                 <SFX>Eating</SFX>
  29.                 <GameItemTypeModel>
  30.                 </GameItemTypeModel>
  31.             </GameItemTypeModelPack>
  32.         </GameItemTypeArtDef>
  33.     </GameItemType>
  34. </GameItemTypes>

Code: xml
  1. <GameItemTypes>
  2.     <GameItemType InternalName="SaltedPork">
  3.         <DisplayName>Salted Pork</DisplayName>
  4.         <Description>A rare type of salted pork that works wonders for a weary soul.  Eat it to heal.</Description>
  5.         <ShopValue>30</ShopValue>
  6.         <GameModifier>
  7.             <ModType>Unit</ModType>
  8.             <Attribute>CurHealth</Attribute>
  9.             <Value>12</Value>
  10.             <Provides>Heals 12 Hit Points</Provides>
  11.         </GameModifier>
  12.         <Prereq>
  13.             <Type>UnitStat</Type>
  14.             <Attribute>UnitStat_ArmorProficiency</Attribute>
  15.             <Value>1</Value>
  16.         </Prereq>
  17.         <IsAvailableForSovereignCustomization>0</IsAvailableForSovereignCustomization>
  18.         <RarityDisplay>Common</RarityDisplay>
  19.         <IsUsable>1</IsUsable>
  20.         <UsableInBattle>1</UsableInBattle>
  21.         <ArtDef>SaltedPork_ArtDef</ArtDef>
  22.         <GameItemTypeArtDef InternalName="SaltedPork_ArtDef">
  23.             <GameItemTypeModelPack InternalName="SaltedPork_Default">
  24.                 <IconFile>SaltedPork_Item.png</IconFile>
  25.                 <MapParticle>T_Heal_Particle</MapParticle>
  26.                 <TintR>79</TintR>
  27.                 <TintG>48</TintG>
  28.                 <TintB>20</TintB>
  29.                 <SFX>Eating</SFX>
  30.                 <GameItemTypeModel>
  31.                 </GameItemTypeModel>
  32.             </GameItemTypeModelPack>
  33.         </GameItemTypeArtDef>
  34.     </GameItemType>
  35. </GameItemTypes>

So I hereby ask for the feature request of allowing Usable Items to be restricted to be able to be used only by champions whose side has a particular allegiance, tech, Player Skill, Global Resource (for the current player) or Unit Skill, Unit Level, or other Unit Unitstat (for the specific unit trying to use the item).

Reply #8 from Elemental Forums Top

Although you don't get a prereq, you can set up the game modifier to give health if you have armor proficiency and not give anything if you don't, sort of a wasted use type thing, but you can always use it.

Reply #9 from Elemental Forums Top

I only used Salted Pork because it was a starting item at shops and it was easy to test.  What I would like is stated at the start of the OP, and includes things like expendable Tomes or other one-use bonus items.  I suppose it would be even nicer if we could control the number of a particular item that can be bought by any player (or sold from a particular player shop), but I thought it was more realistic to allow prereq tags to also restrict use of one-use items, like they already do for equippable items.  That is my feature request, stated in the "EDIT:" part of the OP, and summarised in the thread title.

Reply #10 from Stardock Forums Top

again, like a global resource, there could be an on/off option for an item to use up a certain amount of a certain unitstat, to restrict the number of uses of the item for any unit does not have sufficient unitstat of a certain kind, or has used it all up
End of quote

I'm pretty sure UnitStats can drop to values below 0 (the game will treat and display them as 0, but will still subtract any value it's told to) e.g.: I had units with -24 defense in one of my custom factions. So if you want to make an item that removes X from a certain UnitStat, it will not become unusable once the UnitStat drops below X.

Reply #11 from Elemental Forums Top

The game would have to provide a check like is available for Quest/Event Dialog options that require enough Gildar/other resource etc. for this to work.  I hope if they do implement the suggestion in the OP of this thread that you can set a requirement so that when taking it away the number resulting is no less than zero.

Although it might be already possible to do this, not sure.

Reply #12 from Elemental Forums Top

You can make equippable items unusable if you give them a GameItemTypeArtDef whose GameItemTypeModelPack doesn't specify the undesirably type of unit's unittype in a SupportedUnitModelType node.  So you could, e.g. make an item that is not useable by Wraith units by not including 

Code: xml
  3. <SupportedUnitModelType>WraithFemale</SupportedUnitModelType>
  4. <SupportedUnitModelType>WraithMale</SupportedUnitModelType>

Depending on what you're looking for, this may or may not be good enough.