EverambleGAME API / 1

CONTENT CONTRACT · VERSION 1

structure

A placeable building or furniture piece with health and repair.

Signature

{ ["function"]: (StructureFunction)?, id: ContentId, item: (ItemId)?, kind: "structure", max_health: PositiveHitPoints, model: Name, name: TextKey, prompt: (TextKey)?, repair_recipe: (RecipeId)? }

Fields

NameTypeMeaning
functionStructureFunctionWhat the structure does besides standing: defend, let one sleep or sit.
idContentIdPackage-qualified identity; unique within its declaring namespace.
Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$
itemItemIdItem the structure is built from and dismantled into; absent for village buildings.
Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$; Reference: item
kind"structure"Discriminant
max_healthPositiveHitPointsMaximum hit points and upper healing cap.
Range: 1…2147483647; Unit: hp
modelNameEngine prefab kind supplying geometry, placement and interior until native prefabs replace it.
Length: 1…96; Pattern: ^[a-z][a-z0-9_]{0,95}$
nameTextKeyLocalization key for the displayed name.
Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$; Reference: text
promptTextKeyLocalization key of the interaction prompt shown next to it.
Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$; Reference: text
repair_recipeRecipeIdRepair recipe whose result names this structure.
Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$; Reference: recipe

Validated example

{
  "kind": "structure",
  "structure": "core:barrel_structure"
}