ModStructures: Difference between revisions

From The Colonists
Jump to navigation Jump to search
No edit summary
Separate Icon from Dynamic Floor and refer to MiscCat image for icons, add Static Structure Floor
 
(3 intermediate revisions by the same user not shown)
Line 63: Line 63:
}
}
</pre>
</pre>
=Icon=
While there are no required icon.png files specifically for the Structures, related icons may be needed for custom buildings, or modified buildings, that use structures for Input Requirements. See [[MiscCatModIds]] <br>
=3D Models=
See [[ModsUnityAssetBundles]] for general information.<br>
=Structure Floor Rendering=
See [[StructureDynamicFloorSpecs]] for Dynamic Structure Floor rendering .<br>
See [[StructureFloor]] for Static Structure Floor rendering .<br>

Latest revision as of 15:08, 14 June 2023

Mod Structures Translation.csv

List of fields used in translation.csv for Structures

Structures Translation

placeholder for now - to link to translation.csv for Structures

Add other Structures specific info later

Mod Structures

JSON

See StructureModIds for existing values.
Type TrainPlatform, Pier, and OneWaySign not shown.

{
  "structures": [
    {
      "$type": "AnimalFieldInfo, Game",  // AnimalField (Animal Farm Plot)
      "category": 1, // 0 unless AnimalField (=1)
      "occupierType": 0, // 0 unless OneWaySign 
      "baseOffsets": [], // normal baseoffsets info for structure tiles
      "buildCosts": [],
      "isRequiresFlat": false,
      "minimumNeighbours": 2, // min number of tiles containing same type structure for placing new structure
      "canRotate": false, // structure can rotate
      "animalTypeId": 2, // 255 unless AnimalField, then = animal ID
      "typeId": 201,  // Mod ID
      "componentInfos": []
    },
    {
      "$type": "PlantableFieldInfo, Game", //PlantableField (crops)
      "seedTime": 5.0,  // time from bot has planted on tile until growth starts
      "growthTime": 90.0, // time for PlantableField to grow (to max size and harvestable)
      "harvestTileTime": 1.0, // time for bot to traverse? harvest animation?
      "unitSpeedFactor": 0.75, // bot speeds up or slows on PlanableField ?
      "plantTypeCount": 3, // # of different 3D assets plot can have? e.g. a vegetable plot has: Carrots, Turnips, Cabbage
      "category": 0, // 0 unless AnimalField (=1)
      "occupierType": 0, // 0 unless OneWaySign 
      "baseOffsets": [], // normal baseoffsets info for structure tiles
      "buildCosts": [],
      "isRequiresFlat": false,
      "minimumNeighbours": 0, // min number of tiles containing same type structure for placing new structure
      "canRotate": true, // structure can rotate
      "animalTypeId": 255, // 255 unless AnimalField, then = animal ID
      "typeId": 202, // Mod ID
      "componentInfos": []
    },
    {
      "$type": "TreeFieldInfo, Game", // Tree Plots 
      "treeGrowthTime": 0.0, // time for ??
      "growthTime": 300.0, // time for Fruit to grow on tree after harvest
      "category": 0, // 0 unless AnimalField (=1)
      "occupierType": 0, // 0 unless OneWaySign 
      "baseOffsets": [], // normal baseoffsets info for structure tiles
      "buildCosts": [],
      "isRequiresFlat": false,
      "minimumNeighbours": 0, // min number of tiles containing same type structure for placing new structure
      "canRotate": false, // structure can rotate
      "animalTypeId": 255, // 255 unless AnimalField, then = animal ID
      "typeId": 203, // Mod ID
      "componentInfos": []
    }
  ]
}

Icon

While there are no required icon.png files specifically for the Structures, related icons may be needed for custom buildings, or modified buildings, that use structures for Input Requirements. See MiscCatModIds

3D Models

See ModsUnityAssetBundles for general information.

Structure Floor Rendering

See StructureDynamicFloorSpecs for Dynamic Structure Floor rendering .
See StructureFloor for Static Structure Floor rendering .