ModBuildingProductionDataInfo: Difference between revisions

From The Colonists
Jump to navigation Jump to search
No edit summary
correct itemRequirements
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=BuildingProduction Types=
place holder, under construction. <br>
place holder, under construction. <br>
List of all the BuildingConstructionDataInfo entries and example values. <br>
List of all the BuildingProductionDataInfo entries and example values. <br>


=Mod Building.json - ageComponentsDict - BuildingProductionDataInfo =
==Mod Building.json - ageComponentsDict - BuildingProductionDataInfo ==
Table of building.json -> ageComponentsDict -> BuildingProductionDataInfo entries:
Table of building.json -> ageComponentsDict -> BuildingProductionDataInfo entries:
{| class="wikitable sortable" style="text-align: center"  
{| class="wikitable sortable" style="text-align: center"  
|-
|-
! Entry !! Description !! Used In !! Non-Default Example
! Entry !! Description !! Example !! Non-Default Example
|-
|-
| $type
| $type
Line 21: Line 22:
| Animal Field related
| Animal Field related
| -1.0
| -1.0
|
| [[Sheep_Farm]], [[Cow_Farm]]
|-
|-
| additionalTime
| additionalTime
| ??
| ??
| 0.0
| 0.0
|
| [[Bakery]], [[Fishing_Hut]], [[Forestry]], Lumberjack Hut [[Lumberjack_Hut_L1|L1]], [[Lumberjack_Hut_L2|L2]], [[Lumberjack_Hut_L3|L3]], Surface Mine [[Surface_Mine_L1|L1]], [[Surface_Mine_L2|L2]], [[Surface_Mine_L3|L3]], Road Layer [[Road_Layer_L1|L1]], [[Road_Layer_L2|L2]], [[Vegetable Farm]], [[Wheat Farm]],
|-
|-
| itemStackGroupsProduced
| itemStackGroupsProduced
Line 33: Line 34:
|
|
|-
|-
| miscCatProduced
| [[MiscCatModIds|miscCatProduced]]
| ID of icon for output panel
| ID of icon for output panel
| 255
| 255
|
| [[Forestry]], Road Layer [[Road_Layer_L1|L1]], [[Road_Layer_L2|L2]],  Shaft Mine [[Shaft_Mine_L1|L1]], [[Shaft_Mine_L2|L2]],  Workshop [[Workshop _L1|L1]], [[Workshop_L2|L2]], [[Workshop_L3|L3]]
|-
|-
| itemRequirements
| itemRequirements
| array of tech required
| array of resource, resource category, and/or tile required
| -
| -
|
|
Line 46: Line 47:
| default split for multiple outputs
| default split for multiple outputs
| 50
| 50
|
| [[Sheep_Farm]] Obsolete reasons?
|-
|-
| isClearanceModeAvailable
| isClearanceModeAvailable
| Destroy produced resource
| Destroy produced resource
| false
| false
|
| [[Lumberjack Hut L3| Lumberjack Hut L3]], [[Surface_Mine_L3| Surface_Mine_L3]]
|-
|-
| displayProcessTime
| displayProcessTime
| ??
| ??
| -1.0
| -1.0
|
| [[Blast_Furnace]], [[Brewery]], [[Brickyard]], [[Chocolate_Factory]], [[Cocoa_Farm]], [[Glassworks]], [[Blacksmith]], [[Orchard]], [[Paper_Mill]], [[Printing_Press]], [[Sawmill]], [[SteelWorks]], [[Tannery]], [[Weaponsmith]], [[Well]]
|-
|-
| workerProductionSpeedBoostFactor
| workerProductionSpeedBoostFactor
Line 66: Line 67:
| 0, unless animation called every frame, then=4
| 0, unless animation called every frame, then=4
| 4
| 4
|
| For any custom building with animation developed in Unity, the building_###.json file must have "activeDirtyType" set to 4.
|-
|-
| typeId
| typeId
Line 74: Line 75:
|-
|-
|}
|}
Other BuildingProduction Types may have additional entries:<br>
==Mod Building.json - ageComponentsDict - BuildingProductionFishingHutDataInfo==
Table of building.json -> ageComponentsDict -> BuildingProductionFishingHutDataInfoentries:
{| class="wikitable sortable" style="text-align: center"
|-
! Entry !! Description !! Example
|-
| fishingTileOffset
| tile location of fish tile
| default
|-
| intoProcessTime
| delay in?
| 1.75
|-
| outOfProcessTime
| delay out?
| 6.0
|-
|}
==Mod Building.json - ageComponentsDict - BuildingProductionForestryDataInfo==
Table of building.json -> ageComponentsDict -> BuildingProductionForestryDataInfo:
{| class="wikitable sortable" style="text-align: center"
|-
! Entry !! Description !! Example
|-
| plantableFloraSpecs
| Array of type of trees
| 2/null
|-
| radius
| bot search radius?
| 0
|-
| totalRange
| ??
| 0
|-
|}
==Mod Building.json - ageComponentsDict - BuildingProductionLumberjackDataInfo==
Table of building.json -> ageComponentsDict -> BuildingProductionLumberjackDataInfo:
{| class="wikitable sortable" style="text-align: center"
|-
! Entry !! Description !! Example
|-
| radius
| bot search radius?
| 0
|-
|}
==Mod Building.json - ageComponentsDict - BuildingProductionMountainMineDataInfo==
Table of building.json -> ageComponentsDict -> BuildingProductionMountainMineDataInfo:
{| class="wikitable sortable" style="text-align: center"
|-
! Entry !! Description !! Example
|-
| intoProcessTime
| delay in?
| 1.75
|-
| outOfProcessTime
| delay out?
| 6.0
|-
| radius
| bot search radius?
| 0
|-
| removeAmount
| ?
| 0
|-
| naturalResourceTypeProcessTimeMultiplier
| ?
|-
| mineableNaturalResourceTypesHash
| ?
| 0
|-
| entranceTileOffset
| ?
| 0
|-
| externalTrackOffsets
| ?
| 0
|-
| mineableNaturalResourceInfos
| ?
| 0
|-
|}
==Mod Building.json - ageComponentsDict - BuildingProductionPlantableFarmDataInfo==
==Mod Building.json - ageComponentsDict - BuildingProductionResourceCollectorDataInfo==
Table of building.json -> ageComponentsDict -> BuildingProductionResourceCollectorDataInfo:
{| class="wikitable sortable" style="text-align: center"
|-
! Entry !! Description !! Example
|-
| radius
| bot search radius?
| 0
|-
| removeAmount
| # resources removed from pile?
| 1
|-
| mineableNaturalResourceInfos
| array of natural resources surface mine can mine
| -
|-
|}
==Mod Building.json - ageComponentsDict - BuildingProductionRoadImproverDataInfo==
Table of building.json -> ageComponentsDict -> BuildingProductionRoadImproverDataInfo:
{| class="wikitable sortable" style="text-align: center"
|-
! Entry !! Description !! Example
|-
| roadTypeId
| ID of road
| 5
|-
| pathTypeId
| ID of Path
| 4
|-
|}
==Mod Building.json - ageComponentsDict - BuildingProductionTreeFarmDataInfo==

Latest revision as of 19:25, 14 June 2023

BuildingProduction Types

place holder, under construction.
List of all the BuildingProductionDataInfo entries and example values.

Mod Building.json - ageComponentsDict - BuildingProductionDataInfo

Table of building.json -> ageComponentsDict -> BuildingProductionDataInfo entries:

Entry Description Example Non-Default Example
$type "BuildingProductionDataInfo, Game" default
processTime length of production cycle 30.0
minProcessTime Animal Field related -1.0 Sheep_Farm, Cow_Farm
additionalTime ?? 0.0 Bakery, Fishing_Hut, Forestry, Lumberjack Hut L1, L2, L3, Surface Mine L1, L2, L3, Road Layer L1, L2, Vegetable Farm, Wheat Farm,
itemStackGroupsProduced array of resource(s) produced example
miscCatProduced ID of icon for output panel 255 Forestry, Road Layer L1, L2, Shaft Mine L1, L2, Workshop L1, L2, L3
itemRequirements array of resource, resource category, and/or tile required -
defaultProductionBalance default split for multiple outputs 50 Sheep_Farm Obsolete reasons?
isClearanceModeAvailable Destroy produced resource false Lumberjack Hut L3, Surface_Mine_L3
displayProcessTime ?? -1.0 Blast_Furnace, Brewery, Brickyard, Chocolate_Factory, Cocoa_Farm, Glassworks, Blacksmith, Orchard, Paper_Mill, Printing_Press, Sawmill, SteelWorks, Tannery, Weaponsmith, Well
workerProductionSpeedBoostFactor yyy 1.0
activeDirtyType 0, unless animation called every frame, then=4 4 For any custom building with animation developed in Unity, the building_###.json file must have "activeDirtyType" set to 4.
typeId 21 = BuildingProductionDataInfo 21

Other BuildingProduction Types may have additional entries:

Mod Building.json - ageComponentsDict - BuildingProductionFishingHutDataInfo

Table of building.json -> ageComponentsDict -> BuildingProductionFishingHutDataInfoentries:

Entry Description Example
fishingTileOffset tile location of fish tile default
intoProcessTime delay in? 1.75
outOfProcessTime delay out? 6.0

Mod Building.json - ageComponentsDict - BuildingProductionForestryDataInfo

Table of building.json -> ageComponentsDict -> BuildingProductionForestryDataInfo:

Entry Description Example
plantableFloraSpecs Array of type of trees 2/null
radius bot search radius? 0
totalRange ?? 0

Mod Building.json - ageComponentsDict - BuildingProductionLumberjackDataInfo

Table of building.json -> ageComponentsDict -> BuildingProductionLumberjackDataInfo:

Entry Description Example
radius bot search radius? 0

Mod Building.json - ageComponentsDict - BuildingProductionMountainMineDataInfo

Table of building.json -> ageComponentsDict -> BuildingProductionMountainMineDataInfo:

Entry Description Example
intoProcessTime delay in? 1.75
outOfProcessTime delay out? 6.0
radius bot search radius? 0
removeAmount ? 0
naturalResourceTypeProcessTimeMultiplier ?
mineableNaturalResourceTypesHash ? 0
entranceTileOffset ? 0
externalTrackOffsets ? 0
mineableNaturalResourceInfos ? 0

Mod Building.json - ageComponentsDict - BuildingProductionPlantableFarmDataInfo

Mod Building.json - ageComponentsDict - BuildingProductionResourceCollectorDataInfo

Table of building.json -> ageComponentsDict -> BuildingProductionResourceCollectorDataInfo:

Entry Description Example
radius bot search radius? 0
removeAmount # resources removed from pile? 1
mineableNaturalResourceInfos array of natural resources surface mine can mine -

Mod Building.json - ageComponentsDict - BuildingProductionRoadImproverDataInfo

Table of building.json -> ageComponentsDict -> BuildingProductionRoadImproverDataInfo:

Entry Description Example
roadTypeId ID of road 5
pathTypeId ID of Path 4

Mod Building.json - ageComponentsDict - BuildingProductionTreeFarmDataInfo