New Global Settings - kinggath/WorkshopFramework GitHub Wiki

List of Globals

The following settings are global only and cannot be controlled at the settlement level.

  • WSFW_Setting_TradeCaravanMinimumPopulation - The number of settlers a settlement must have before caravans will start visiting them.
  • WSFW_Setting_recruitmentMinPopulationForSynth - The number of settlers a settlement must have before Synths might start invading the population.
  • WSFW_Setting_startingHappiness - The default happiness settlements start at.
  • WSFW_Setting_startingHappinessMin - The minimum happiness a settlement can start at after settlers move in.
  • WSFW_Setting_startingHappinessTarget - The happiness goal the settlement will be climbing to after settlers move in. This one is a little confusing.. You know the little up/down arrow next to happiness? This controls it. For example, if the starting happiness is 50 and the starting happiness target is 80, happiness will start at 50 with an up arrow trying to climb to 80. Of course each day the happiness target is recalculated, so there's little benefit to making this much happiness than startingHappiness.
  • WSFW_Setting_resolveAttackMaxAttackRoll - When a settlement attack occurs while the player is away, and they don't go back to help defend, a die roll will be made in the background for the attackers and the settlement to decide whether the settlement defended itself. Whoever has the highest roll wins. This allows you to control the max possible roll the attackers can make.
  • WSFW_Setting_resolveAttackAllowedDamageMin - When a settlement loses an attack that the player doesn't come back to, some number of items will be damaged and some amount of resources will be stolen from the workbench. This is a number between 0 and 100 that decides the minimum percentage of damage/theft to cause.
  • WSFW_Setting_workshopRadioInnerRadius - The radius around the settlement the Settlement Radio Broadcast comes in perfectly clear.
  • WSFW_Setting_workshopRadioOuterRadius - The radius around the settlement the Settlement Radio Broadcast comes in with static mixed in, beyond this the radio signal is lost.
  • WSFW_Setting_happinessModifierMax - Happiness can be increased directly by scripts temporarily. This happens when you complete radiant quests or protect a settlement. This setting sets the most the modifiers can improve happiness at once.
  • WSFW_Setting_happinessModifierMin - Happiness can be decreased directly by scripts temporarily. This happens when you fail radiant quests, fail to protect a settlement and it loses the attack roll, or if a settler dies. This setting sets the most the modifiers can decrease happiness at once.

Brand New Controls: While the above settings could have been edited by someone altering the numbers in the vanilla scripts, the following controls were specifically added to the workshop scripts for this framework to expand what can be done.

  • WSWF_Setting_AdjustMaxNPCsByCharisma - Toggle whether or not Charisma should affect the max number of settlers you can have at each settlement. This is available as an MCM/Holotape control.
  • WSWF_Setting_RobotsCountTowardsMaxPopulation - Toggle whether or not robots will be counted when the recruitment code decides you are at max settlers or not. This is available as an MCM/Holotape control.
  • WSWF_Setting_RecruitSettlersOnFirstBeaconActivation - Toggle whether or not settlers will be spawned immediately when a beacon is built and powered on for the first time at each settlement. This is available as an MCM/Holotape control.
  • WSWF_Setting_AllowLinkedWorkshopConsumption - Toggle whether or not settlements can consume missing resources from settlements linked by Provisioner. This is available as an MCM/Holotape control.
  • WSWF_Setting_MaintainDeficits - Toggle whether or not resource shortages should be carried forward from day to day. This is available as an MCM/Holotape control.
  • WSFW_Setting_AutoAssignBeds - Allow the game to auto-assign beds to settlers. This is available as an MCM/Holotape control.
  • WSFW_Setting_AutoAssignDefense - Allow the game to auto-assign guard posts to settlers. This is available as an MCM/Holotape control.
  • WSFW_Setting_AutoAssignFood - Allow the game to auto-assign crops to settlers. This is available as an MCM/Holotape control.
  • WSFW_Setting_MaxFoodWorkPerSettler - Max amount of food each settler can produce from working crops. This is available as an MCM/Holotape control.
  • WSFW_Setting_MaxDefenseWorkPerSettler - Max amount of defense each settler can provide from working guard posts. This is available as an MCM/Holotape control.
  • WSFW_Setting_MaxFoodWorkPerSettler - Max amount of food each settler can produce from working crops. This is available as an MCM/Holotape control.
  • WSFW_Setting_AttackDamageToTheftRatio_Food - Attack damage represents a percent from resolveAttackAllowedDamageMin to 100. This new property allows you to change the rate resources are stolen on a lost attack with a default value of 1 meaning 1% of resources are stolen per Damage percent stolen. For example, Changing this to 0.5 would mean ½ the resources would be stolen, where as changing it to 2 would double the resources lost.
  • WSFW_Setting_AttackDamageToTheftRatio_Water - See WSFW_Setting_AttackDamageToTheftRatio_Food explanation.
  • WSFW_Setting_AttackDamageToTheftRatio_Scrap - See WSFW_Setting_AttackDamageToTheftRatio_Food explanation.
  • WSFW_Setting_AttackDamageToTheftRatio_Caps - See WSFW_Setting_AttackDamageToTheftRatio_Food explanation.