Looking For Cigar/Lucky Goggles Combo

ModKeep · Dec 11, 2021

I thought I saw a mod that combines the effects of the Cigar and the Lucky Goggles. A face item that has the trade bonus and the looting bonus. It would be nice not to have to switch back and forth all the time. Most of the time I forget to equip the cigar. A20 version please. Thanks in advance.

poly · Dec 12, 2021

You will need to edit 3 files total, but lets look at items.xml first...


<item name="apparelCigar">
<property name="Tags" value="head,clothing,noMods"/>
<property name="DisplayType" value="clothingCigar"/>
<property name="UnlockedBy" value="perkUrbanCombatCigar"/>
<property name="Material" value="Mplants"/>
<property name="Stacknumber" value="1"/>
<property name="DegradationBreaksAfter" value="false"/>
<property name="EconomicValue" value="500"/>
<property name="HoldType" value="45"/>
<property name="Meshfile" value="#Other/Items?Misc/sackPrefab.prefab"/>
<property name="DropMeshfile" value="#Other/Items?Misc/sack_droppedPrefab.prefab"/>
<property name="Group" value="Clothing"/>
<property name="EquipSlot" value="Face"/>
<property class="UMA">
<property name="Mesh" value="gear_cigar"/>
<property name="Overlay0" value="gear_cigar"/>
<property name="Layer" value="1"/>
<property name="UISlot" value="Face"/>
</property>
<effect_group tiered="false">
<passive_effect name="ModSlots" operation="base_set" value="0"/>
<passive_effect name="AttributeLevel" tags="attStrength" operation="base_add" value="1"/>
<passive_effect name="BarteringBuying" operation="base_add" value=".1"/>
<passive_effect name="BarteringSelling" operation="base_add" value=".1"/>
</effect_group>
</item>


<item name="apparelAviatorGoggles">
<property name="Extends" value="apparelShades"/>
<property name="Material" value="Mleather"/>
<property name="DisplayType" value="clothingAviatorGoggles"/>
<property class="UMA">
<property name="Mesh" value="aviator_goggles"/>
<property name="Overlay0" value="aviator_goggles"/>
</property>
<effect_group tiered="false">
<passive_effect name="ModSlots" operation="base_set" value="0"/>
<passive_effect name="LootGamestage" operation="base_add" value="3,5.2"/>
<passive_effect name="TreasureBlocksPerReduction" operation="base_add" value="-1"/>
<display_value name="dTreasureBlocksPerReduction" value="-1"/>
</effect_group>
</item>

In the above code are both items for Cigar and Lucky Goggles.

We can combine both effects into one item, and call it LuckyCigar...

<item name="LuckyCigar">
<property name="Tags" value="head,clothing,noMods"/>
<property name="DisplayType" value="clothingCigar"/>
<property name="UnlockedBy" value="perkUrbanCombatCigar"/>
<property name="Material" value="Mplants"/>
<property name="Stacknumber" value="1"/>
<property name="DegradationBreaksAfter" value="false"/>
<property name="EconomicValue" value="500"/>
<property name="HoldType" value="45"/>
<property name="Meshfile" value="#Other/Items?Misc/sackPrefab.prefab"/>
<property name="DropMeshfile" value="#Other/Items?Misc/sack_droppedPrefab.prefab"/>
<property name="Group" value="Clothing"/>
<property name="EquipSlot" value="Face"/>
<property class="UMA">
<property name="Mesh" value="gear_cigar"/>
<property name="Overlay0" value="gear_cigar"/>
<property name="Layer" value="1"/>
<property name="UISlot" value="Face"/>
</property>
<effect_group tiered="false">
<passive_effect name="ModSlots" operation="base_set" value="0"/>
<passive_effect name="AttributeLevel" tags="attStrength" operation="base_add" value="1"/>
<passive_effect name="BarteringBuying" operation="base_add" value=".1"/>
<passive_effect name="BarteringSelling" operation="base_add" value=".1"/>
<passive_effect name="LootGamestage" operation="base_add" value="3,5.2"/>
<passive_effect name="TreasureBlocksPerReduction" operation="base_add" value="-1"/>
<display_value name="dTreasureBlocksPerReduction" value="-1"/>
</effect_group>
</item>

Next you will need to edit ui_display.xml, and the value we're looking for here is 'clothingCigar'.

    <item_display_info display_type="clothingCigar" display_group="groupAttire" >
           <display_entry name="AttributeLevel" tags="attStrength" title_key="statShowStrength" display_leading_plus="true"/>
           <display_entry name="BarteringBuying" title_key="statBarteringSellBuy" display_type="Percent" display_leading_plus="true"/>
       </item_display_info>

As things stand you will have a new item in game with the effects of both the cigar and lucky goggles, but this interface will only show the effects of the cigar... so in the items.xml change the the following line:

<property name="DisplayType" value="clothingCigar"/>

To a new name, e.g.

<property name="DisplayType" value="LuckyCigar"/>

Then in ui_display.xml, make the same name changes...

<item_display_info display_type="LuckyCigar" display_group="groupAttire" >
<display_entry name="AttributeLevel" tags="attStrength" title_key="statShowStrength" display_leading_plus="true"/>
<display_entry name="BarteringBuying" title_key="statBarteringSellBuy" display_type="Percent" display_leading_plus="true"/>
</item_display_info>

But add in the values from 'clothingAviatorGoggles' in ui_display.xml too...

<item_display_info display_type="clothingAviatorGoggles" display_group="groupAttire">
<display_entry name="LootGamestage" title_key="statLootGamestage" display_leading_plus="true"/>
<display_entry name="dTreasureBlocksPerReduction" title_key="statTreasureRadius" display_leading_plus="true" negative_preferred="true"/>
</item_display_info>

So your new ui_display.xml block will look like this..

<item_display_info display_type="LuckyCigar" display_group="groupAttire" >
<display_entry name="AttributeLevel" tags="attStrength" title_key="statShowStrength" display_leading_plus="true"/>
<display_entry name="BarteringBuying" title_key="statBarteringSellBuy" display_type="Percent" display_leading_plus="true"/>
<display_entry name="LootGamestage" title_key="statLootGamestage" display_leading_plus="true"/>
<display_entry name="dTreasureBlocksPerReduction" title_key="statTreasureRadius" display_leading_plus="true" negative_preferred="true"/>
</item_display_info>

Finally, reference this block in the items.xml

<item name="LuckyCigar">
<property name="Tags" value="head,clothing,noMods"/>
<property name="CustomIcon" value="apparelCigar"/>
<property name="DisplayType" value="LuckyCigar"/>
<property name="UnlockedBy" value="perkUrbanCombatCigar"/>
<property name="Material" value="Mplants"/>
<property name="Stacknumber" value="1"/>
<property name="DegradationBreaksAfter" value="false"/>
<property name="EconomicValue" value="500"/>
<property name="HoldType" value="45"/>
<property name="Meshfile" value="#Other/Items?Misc/sackPrefab.prefab"/>
<property name="DropMeshfile" value="#Other/Items?Misc/sack_droppedPrefab.prefab"/>
<property name="Group" value="Clothing"/>
<property name="EquipSlot" value="Face"/>
<property class="UMA">
<property name="Mesh" value="gear_cigar"/>
<property name="Overlay0" value="gear_cigar"/>
<property name="Layer" value="1"/>
<property name="UISlot" value="Face"/>
</property>
<effect_group tiered="false">
<passive_effect name="ModSlots" operation="base_set" value="0"/>
<passive_effect name="AttributeLevel" tags="attStrength" operation="base_add" value="1"/>
<passive_effect name="BarteringBuying" operation="base_add" value=".1"/>
<passive_effect name="BarteringSelling" operation="base_add" value=".1"/>
<passive_effect name="LootGamestage" operation="base_add" value="3,5.2"/>
<passive_effect name="TreasureBlocksPerReduction" operation="base_add" value="-1"/>
<display_value name="dTreasureBlocksPerReduction" value="-1"/>
</effect_group>
</item>

This will give you a new item with the properties of both the Cigar and Lucky Goggles, using the appearance of the Cigar.

I have also added a custom icon to the code above so it displays as a cigar in your inventory.

The only other file you might want to change would be localization.txt for the name and description.

ModKeep · Dec 12, 2021

Thank you for this. I will try it out when I have some spare time. I was looking through some of the code on other mods I downloaded to see how they work and planned on trying to figure out how to do this. It is so nice to be part of a community that is willing to teach someone new to modding how to do it. Thank you.

poly · Dec 12, 2021

If I have time tomorrow I will create a modlet just for this, so you can see exactly which files need changing in order to get a new item

BFT2020 · Dec 12, 2021

Don’t forget to put it the world via crafting, looting, and/or traders.

poly · Dec 12, 2021

BFT2020 said:
Don’t forget to put it the world via crafting, looting, and/or traders.

I think this will make changes to loot.xml, progression.xml, traders.xml and recipes.xml, so will be a good way to learn about editing different things in game, and how they all link together

poly · Dec 13, 2021

Okay here is a link to download the mod:

LuckyCigar via GitHub

I have left comments in some of the files to help you understand how everything works and links together

Essentially this adds a new item Lucky Cigar into the game. It is locked by default.

You unlock it by reading Urban Combat Vol 2 (the same book which unlocks the normal Cigar), once unlocked you can craft it using the same resources as the normal Cigar.

It also appears in the same loot groups as the normal Cigar, and shows up in the same trader group.

ModKeep · Dec 15, 2021

Thank you. I have been busy lately and will give it a try when I get time. I'm looking forward to seeing how it works.

ModKeep · Dec 16, 2021

I had a look at the code. It is quite interesting. The only thing I found odd is that my character can craft the regular cigar but the lucky cigar remains locked.

ModKeep · Dec 16, 2021

I figured it out. The sexual tyrannosaurus perk unlocked the regular cigar. Also I was thinking of adding 1 gold nugget to the recipe. I understand how to now but don't know how to reference it. Is there a list of the items internal names? I looked at the wiki but didn't find anything.

Am I missing the edit post button? I don't like to triple post.

ModKeep · Dec 16, 2021

I found the items list in the ConfigsDump folder in my save file. I was looking for "resourceGoldNugget".

mr.devolver · Dec 16, 2021

What's the deal with this? We can use both cigar and lucky goggles at once in vanilla. Am I missing something?

ModKeep · Dec 16, 2021

They both use the face slot. I don't see how that would be possible.

BFT2020 · Dec 16, 2021

ModKeep said:
They both use the face slot. I don't see how that would be possible.

That seems weird (and definitely not what the xml file indicates). Cigar uses the Face UI Slot while the lucky goggles use the Eyes UI Slot (Lucky goggles extend from the Shades which is Eyes UI Slot). Unless something else was setup wrong elsewhere and there is a conflict between the two. I know my survivor has transition between bandana to cigar while wearing eyewear, though I can't recall if I had cigar and the lucky goggles on at the same time. Going to try that out tonight when I am working on my modlets. My initial thought was that combining lucky goggles with the cigar was for people to get both bonuses and still be able to wear nerdy glasses.

Code:

&lt;item name="apparelCigar"&gt;
.....
    &lt;property name="EquipSlot" value="Face"/&gt;
    &lt;property class="UMA"&gt;
        &lt;property name="Mesh" value="gear_cigar"/&gt;
        &lt;property name="Overlay0" value="gear_cigar"/&gt;
        &lt;property name="Layer" value="1"/&gt;
        &lt;property name="UISlot" value="Face"/&gt;
    &lt;/property&gt;

Code:

&lt;item name="apparelBandana"&gt; &lt;!-- item name directly referenced in the code --&gt;
.......
    &lt;property name="EquipSlot" value="Face"/&gt;
    &lt;property class="UMA"&gt;
        &lt;property name="Mesh" value="gear_bandana"/&gt;
        &lt;property name="Overlay0" value="gear_bandana"/&gt;
        &lt;property name="Layer" value="1"/&gt;
        &lt;property name="UISlot" value="Face"/&gt;
        &lt;property name="Mask0" value="Face" param1="base"/&gt;
  &lt;/property&gt;

Code:

item name="apparelAviatorGoggles"&gt;
    &lt;property name="Extends" value="apparelShades"/&gt;
    &lt;property name="Material" value="Mleather"/&gt;
    &lt;property name="DisplayType" value="clothingAviatorGoggles"/&gt;
    &lt;property class="UMA"&gt;
        &lt;property name="Mesh" value="aviator_goggles"/&gt;
        &lt;property name="Overlay0" value="aviator_goggles"/&gt;
    &lt;/property&gt;
    &lt;effect_group tiered="false"&gt;
        &lt;passive_effect name="ModSlots" operation="base_set" value="0"/&gt;
        &lt;passive_effect name="LootGamestage" operation="base_add" value="3,5.2"/&gt;
        &lt;passive_effect name="TreasureBlocksPerReduction" operation="base_add" value="-1"/&gt;
        &lt;display_value name="dTreasureBlocksPerReduction" value="-1"/&gt;
    &lt;/effect_group&gt;
&lt;/item&gt;

Code:

&lt;item name="apparelShades"&gt; &lt;!-- item name directly referenced in the code --&gt;
........
    &lt;property name="EquipSlot" value="Eyes"/&gt;
    &lt;property name="Group" value="Clothing"/&gt;
    &lt;property class="UMA"&gt;
        &lt;property name="Mesh" value="gear_shades"/&gt;
        &lt;property name="Overlay0" value="gear_shades"/&gt;
        &lt;property name="Layer" value="1"/&gt;
        &lt;property name="UISlot" value="Eyewear"/&gt;
&lt;/property&gt;

ModKeep · Dec 16, 2021

I did some digging and figured it out. I feel really stupid now. You are correct. The "H7SB Backpacks" mod I have installed stole one of the slots and changed it to only accept backpacks. All this for almost nothing. At least I learned a bit about modding. Thanks poly and BFT2020 for helping me figure this out.

BFT2020 · Dec 16, 2021

No worries! I learn something new ever time I put on my modding hat and start working on things. I for one didn't realize that there were mods out there that took the eyes slot for backpacks. Even I learned something new today

Looking For Cigar/Lucky Goggles Combo

ModKeep

Refugee

poly

Refugee

ModKeep

Refugee

poly

Refugee

BFT2020

Hunter

poly

Refugee

poly

Refugee

ModKeep

Refugee

ModKeep

Refugee

ModKeep

Refugee

ModKeep

Refugee

mr.devolver

Refugee

ModKeep

Refugee

BFT2020

Hunter

ModKeep

Refugee

BFT2020

Hunter