Skip to main content

Sporebrain

Based on game build 714014 | Last updated: 2026-03-03

Overview​

SporeBrain defines the AI behavior tree for spore-based entities, such as spore moths or spore-related minions. It uses a priority-based behavior tree with two primary actions: following nearby valid targets (players, characters, or monsters) within a specified range, or wandering near a designated "home" location (retrieved via knownlocations:GetLocation("home")) when no target is active or in range. This component is typically attached to entities that should loiter near a spawn point while occasionally pursuing targets.

Usage example​

local inst = CreateEntity()
inst:AddComponent("sporebrain")
-- The behavior tree is automatically constructed on first start;
-- no further setup is required from modders.

Dependencies & tags​

Components used: knownlocations Tags: No tags added or removed. Uses internal inst.followobj tracking.

Properties​

PropertyTypeDefault ValueDescription
btBehaviorTreenil (set in OnStart)The compiled behavior tree instance.
followobjEntity or nilnilCached target entity the spore is currently following.

Main functions​

OnStart()​

  • Description: Initializes and starts the behavior tree. This method is automatically called when the brain component begins executing (typically after the entity enters the world).
  • Parameters: None.
  • Returns: Nothing.
  • Error states: None — assumes valid knownlocations component is present on inst.

Events & listeners​

None identified.