World

package main
 
import (
	"log"
	"time"
 
	"pkg.world.dev/world-engine/cardinal"
)
 
func main() {
	redisAddr := os.Getenv("REDIS_ADDR")
	redisPassword := os.Getenv("REDIS_PASSWORD")
 
	world, err := cardinal.NewWorld(
		redisAddr,
		redisPassword,
		cardinal.WithNamespace("my-world"),
		cardinal.WithReceiptHistorySize(10),
		cardinal.WithTickInterval(500 * time.Millisecond),
		cardinal.WithPort("4001"),
	)
	if err != nil {
		log.Fatal(err)
	}
}

func NewWorld(addr, password string, opts ...WorldOption) (*World, error)

func WithAdapter(adapter shard.Adapter) Option

func WithReceiptHistorySize(size int) Option

func WithNamespace(id string) Option

func WithPort(port string) WorldOption

func WithDisableSignatureVerification() WorldOption

func WithTickChannel(ch <-chan time.Time) WorldOption

// option to make ticks happen every 500 milliseconds.
opt := WithLoopInterval(time.Tick(500*time.Millisecond))

func RegisterSystems(w *World, s ...System)

package main
 
import (
	"github.com/my-username/my-world-engine-project/systems"
	"pkg.world.dev/world-engine/cardinal"
)
 
func main() {
	// ... world setup ...
 
	// Systems will run in order in which they are added:
	// 1. MoveSystem
	// 2. HealthRegenSystem
	// 3. AttackSystem
	cardinal.RegisterSystems(world, systems.MoveSystem, systems.HealthRegenSystem, systems.AttackSystem)
}

func RegisterComponent[T metadata.Component](world *World) error

package main
 
import (
	"log"
	"github.com/my-username/my-world-engine-project/component"
	"pkg.world.dev/world-engine/cardinal"
)
 
func main() {
	// ... world setup ...
 
	err := cardinal.RegisterComponent[LocationComponet](world)
	if err != nil {
		log.Fatal(err)
	}
	err = cardinal.RegisterComponent[AttackPowerComponent](world)
	if err != nil {
		log.Fatal(err)
	}
	err = cardinal.RegisterComponent[HealthComponent](world)
	if err != nil {
		log.Fatal(err)
	}
 
	// Alternative RegisterComponent pattern with less error checking:
	err = errors.Join(
		cardinal.RegisterComponent[LocationComponet](world),
		cardinal.RegisterComponent[AttackPowerComponent](world),
		cardinal.RegisterComponent[HealthComponent](world),
	)
	if err != nil {
		log.Fatal(err)
	}
}

func RegisterQueries(w *World, queries ...AnyQueryType) error

package main
 
import (
	"log"
 
	"github.com/my-username/my-world-engine-project/query"
	"pkg.world.dev/world-engine/cardinal"
)
 
func main() {
	// ... world setup ...
 
	err := cardinal.RegisterQueries(world,
		query.QueryLocation,
		query.QueryHealth,
		query.QueryAttackPower,
	)
	if err != nil {
		log.Fatal(err)
	}
}

func RegisterMessages(w *World, msgs ...AnyMessage) error

package main
 
import (
	"log"
 
	"github.com/my-username/my-world-engine-project/msg"
	"pkg.world.dev/world-engine/cardinal"
)
 
func main() {
	// ... world setup ...
 
	err := cardinal.RegisterMessages(world,
		msg.Move,
		msg.Attack,
	)
	if err != nil {
		log.Fatal(err)
	}
}

func CreateMany(wCtx WorldContext, num int, components ...metadata.Component) ([]EntityID, error)

package main
 
import (
	"log"
 
	"github.com/my-username/my-world-engine-project/components"
	"pkg.world.dev/world-engine/cardinal"
)
 
func main() {
	// ... world setup ...
 
	// create 10 entities with the location and health component.
	entityIDs, err := cardinal.CreateMany(worldCtx,
		10,
		components.Location{},
		components.Health{},
	)
	if err != nil {
		log.Fatal(err)
	}
}

func Create(wCtx WorldContext, components ...metadata.Component) (EntityID, error)

package main
 
import (
	"log"
 
	"github.com/my-username/my-world-engine-project/components"
	"pkg.world.dev/world-engine/cardinal"
)
 
func main() {
	// ... world setup ...
 
	// create an entity with the location and health component.
	entityID, err := cardinal.Create(worldCtx
		components.Location{},
		components.Health{},
	)
	if err != nil {
		log.Fatal(err)
	}
}

func Remove(wCtx WorldContext, id EntityID) error

package main
 
import (
	"log"
 
	"github.com/my-username/my-world-engine-project/components"
	"pkg.world.dev/world-engine/cardinal"
)
 
func main() {
	// ... world setup ...
 
	// create an entity with the location and health component.
	entityID, err := cardinal.Create(worldCtx,
		components.Location{},
		components.Health{},
	)
	if err != nil {
		log.Fatal(err)
	}
 
	// remove the entity we just created
	err = cardinal.Remove(worldCtx, entityID)
	if err != nil {
		log.Fatal(err)
	}
}

func (w *World) StartGame() error