animal_definition

Defines a tycoon animal with research tree, catalyst mechanics, fusion, and economy stats — definition entry.

Entry Information

Property	Value
Entry ID	animal_definition
Type	Definition
Color	Green
Icon	mdi:paw

Fields

Field	Type	Description
entityDefinition	Ref<EntityDefinitionEntry>	The entity definition providing the visual model (NPC, ModelEngine, vanilla mob)
category	String	Research category this animal belongs to
rarity	AnimalRarity	Rarity tier driving revenue, capture weight, and fatigue
catalystPowerRequired	Double	Total catalyst power required before fuel can be applied
acceptedCatalystItems	List<CatalystItemDef>	Items accepted by the catalyst and their power contribution
fuelItem	String	Fuel item consumed to trigger the research attempt
successChance	Double	Base chance of successful research before rarity and profession modifiers
alternativeRewards	List<AlternativeReward>	Rewards granted if the player already owns this animal
baseRevenueRate	Double	Base revenue per second at level 1
revenueScaling	Double	Revenue multiplier per level above 1
biomeAffinities	AnimalBiomeAffinity	Biome affinity map for zoo revenue bonuses
isMountable	Boolean	Whether this animal can be ridden as a mount
fatigueCapacity	Int	Base fatigue capacity in seconds when used as a mount
mountSpeed	Double	Movement speed multiplier when mounted
maxLevel	Int	Maximum level this animal can reach
xpCurve	List<Int>	XP thresholds per level (index = level-1, value = xp needed to reach next level)
fusionMinLevel	Int	Minimum level required to attempt fusion with another animal of this species
fusionParentRequired	Boolean	Whether two parents are required for fusion (true) or just one (false = breeding)
habitatBlocks	List<String>	Preferred block types for habitat happiness bonus
requiredProfessionLevel	Int	Minimum RPG profession level required
displayName	String	Display name shown in GUI and messages
description	String	Flavor description for the bestiary
icon	String	Icon item for GUI representation
modelVariants	List<ModelVariantDef>	Alternative model/skin variants — each references an existing EntityDefinition with a retrievable ID

Usage Example

- entry: animal_definition
  name: "Defines a tycoon animal with research tree, catalyst mechanics, fusion, and economy stats"
  entityDefinition: ""
  category: ""
  rarity: ""
  catalystPowerRequired: 0
  acceptedCatalystItems: []
  fuelItem: ""
  successChance: 0
  alternativeRewards: []
  baseRevenueRate: 0
  revenueScaling: 0
  biomeAffinities: ""
  isMountable: false
  fatigueCapacity: 0
  mountSpeed: 0
  maxLevel: 0
  xpCurve: 0
  fusionMinLevel: 0
  fusionParentRequired: false
  habitatBlocks: []
  requiredProfessionLevel: 0
  displayName: ""
  description: ""
  icon: ""
  modelVariants: []