Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

spawn

package module

Go to main page

Versions in this module

v0

v0.1.2

Dec 16, 2025

v0.1.1

Aug 27, 2025

Changes in this version

+ var EntitySpawnedTopic = events.DefineTypedTopic[EntitySpawnedEvent]("spawn.entity.spawned")

+ var RoomScaledTopic = events.DefineTypedTopic[RoomScaledEvent]("spawn.room.scaled")

+ var SplitRecommendedTopic = events.DefineTypedTopic[SplitRecommendedEvent]("spawn.split.recommended")

type BasicSpawnEngine

+ func (e *BasicSpawnEngine) ConnectToEventBus(bus events.EventBus)

+ type EntitySpawnedEvent struct

+ Constraints []string

+ EntityID string

+ EntityType string

+ Position spatial.Position

+ RoomID string

+ SpawnGroupID string

+ SpawnType string

+ SpawnedAt time.Time

+ type RoomScaledEvent struct

+ NewCapacity int

+ OldCapacity int

+ RoomID string

+ ScaleReason string

+ ScaleType string

+ ScaledAt time.Time

+ type SplitRecommendedEvent struct

+ CurrentCapacity int

+ Reason string

+ RecommendationType string

+ RequiredCapacity int

+ RoomID string

+ Timestamp time.Time

v0.1.0

Aug 11, 2025

Changes in this version

+ type BasicSelectablesRegistry struct

+ func NewBasicSelectablesRegistry() *BasicSelectablesRegistry

+ func (r *BasicSelectablesRegistry) GetEntities(tableID string, quantity int) ([]core.Entity, error)

+ func (r *BasicSelectablesRegistry) ListTables() []string

+ func (r *BasicSelectablesRegistry) RegisterTable(tableID string, entities []core.Entity) error

+ type BasicSpawnEngine struct

+ func NewBasicSpawnEngine(config BasicSpawnEngineConfig) *BasicSpawnEngine

+ func (e *BasicSpawnEngine) AnalyzeRoomStructure(roomID string) RoomStructureInfo

+ func (e *BasicSpawnEngine) PopulateRoom(ctx context.Context, roomID string, config SpawnConfig) (SpawnResult, error)

+ func (e *BasicSpawnEngine) PopulateSpace(ctx context.Context, roomOrGroup interface{}, config SpawnConfig) (SpawnResult, error)

+ func (e *BasicSpawnEngine) PopulateSplitRooms(ctx context.Context, connectedRooms []string, config SpawnConfig) (SpawnResult, error)

+ func (e *BasicSpawnEngine) ValidateSpawnConfig(config SpawnConfig) error

+ type BasicSpawnEngineConfig struct

+ EnableEvents bool

+ EnvironmentHandler *environments.BasicQueryHandler

+ EventBus events.EventBus

+ ID string

+ MaxAttempts int

+ SelectablesReg SelectablesRegistry

+ SpatialHandler spatial.QueryHandler

+ type ConstraintSolver struct

+ func NewConstraintSolver() *ConstraintSolver

+ func (cs *ConstraintSolver) FindValidPositions(room spatial.Room, entity core.Entity, constraints SpatialConstraints, ...) ([]spatial.Position, error)

+ func (cs *ConstraintSolver) ValidatePosition(room spatial.Room, position spatial.Position, entity core.Entity, ...) error

+ type EntityGroup struct

+ ID string

+ Quantity QuantitySpec

+ SelectionTable string

+ Type string

+ type EntityPair struct

+ From string

+ To string

+ type FormationConstraints struct

+ MinSpacing float64

+ RequiredSpace float64

+ WallClearance float64

+ type FormationPattern struct

+ Constraints FormationConstraints

+ Name string

+ Positions []RelativePosition

+ Scaling FormationScaling

+ type FormationScaling struct

+ AllowRotation bool

+ AllowStretching bool

+ PreserveRatios bool

+ type LineOfSightRules struct

+ BlockedSight []EntityPair

+ RequiredSight []EntityPair

+ type PathingConstraints struct

+ MaintainExitAccess bool

+ MinPathWidth float64

+ type PlacementRules struct

+ MaintainExitAccess bool

+ MinPathWidth float64

+ PreferredAreas []string

+ type PlayerSpawnChoice struct

+ PlayerID string

+ Position spatial.Position

+ ZoneID string

+ type QuantitySpec struct

+ Fixed *int

+ type RelativePosition struct

+ Priority int

+ X float64

+ Y float64

+ type RoomModification struct

+ NewValue interface{}

+ OldValue interface{}

+ Reason string

+ RoomID string

+ Type string

+ type RoomSplit struct

+ ConnectionPoints []spatial.Position

+ EntityDistribution map[string]int

+ SplitReason string

+ SuggestedSize spatial.Dimensions

+ type RoomStructureInfo struct

+ ConnectedRooms []string

+ IsSplit bool

+ PrimaryRoomID string

+ type ScalingConfig struct

+ EmitEvents bool

+ Enabled bool

+ PreserveAspect bool

+ ScalingFactor float64

+ type SelectablesRegistry interface

+ GetEntities func(tableID string, quantity int) ([]core.Entity, error)

+ ListTables func() []string

+ RegisterTable func(tableID string, entities []core.Entity) error

+ type SeparationConstraints struct

+ MinTeamDistance float64

+ TeamPlacement TeamPlacementStrategy

+ type SimpleRoomEntity struct

+ func (r *SimpleRoomEntity) GetID() string

+ func (r *SimpleRoomEntity) GetType() string

+ type SpatialConstraints struct

+ AreaOfEffect map[string]float64

+ LineOfSight LineOfSightRules

+ MinDistance map[string]float64

+ PathingRules PathingConstraints

+ WallProximity float64

+ type SpawnConfig struct

+ AdaptiveScaling *ScalingConfig

+ EntityGroups []EntityGroup

+ Pattern SpawnPattern

+ Placement PlacementRules

+ PlayerChoices []PlayerSpawnChoice

+ PlayerSpawnZones []SpawnZone

+ SpatialRules SpatialConstraints

+ Strategy SpawnStrategy

+ TeamConfiguration *TeamConfig

+ type SpawnEngine interface

+ AnalyzeRoomStructure func(roomID string) RoomStructureInfo

+ PopulateRoom func(ctx context.Context, roomID string, config SpawnConfig) (SpawnResult, error)

+ PopulateSpace func(ctx context.Context, roomOrGroup interface{}, config SpawnConfig) (SpawnResult, error)

+ PopulateSplitRooms func(ctx context.Context, connectedRooms []string, config SpawnConfig) (SpawnResult, error)

+ ValidateSpawnConfig func(config SpawnConfig) error

+ type SpawnFailure struct

+ EntityType string

+ Reason string

+ type SpawnPattern string

+ const PatternClustered

+ const PatternFormation

+ const PatternPlayerChoice

+ const PatternScattered

+ const PatternTeamBased

+ type SpawnResult struct

+ Failures []SpawnFailure

+ RoomModifications []RoomModification

+ RoomStructure RoomStructureInfo

+ SpawnedEntities []SpawnedEntity

+ SplitRecommendations []RoomSplit

+ Success bool

+ type SpawnStrategy string

+ const StrategyBalanced

+ const StrategyDeterministic

+ const StrategyRandomized

+ type SpawnZone struct

+ Area spatial.Rectangle

+ EntityTypes []string

+ ID string

+ MaxEntities int

+ type SpawnedEntity struct

+ Entity core.Entity

+ Position spatial.Position

+ RoomID string

+ type Team struct

+ Cohesion float64

+ EntityTypes []string

+ Formation *FormationPattern

+ ID string

+ PreferredZone string

+ type TeamCohesionRules struct

+ KeepEnemiesTogether bool

+ KeepFriendliesTogether bool

+ MinTeamSeparation float64

+ type TeamConfig struct

+ CohesionRules TeamCohesionRules

+ SeparationRules SeparationConstraints

+ Teams []Team

+ type TeamPlacementStrategy string

+ const TeamPlacementCorners

+ const TeamPlacementOppositeSides

+ const TeamPlacementRandom