Package worlds

import "github.com/Irmine/Worlds"

Overview
Index
Subdirectories

Overview

Index

Variables
type Dimension
func NewDimension(name string, level *Level, id DimensionId) *Dimension
func (dimension *Dimension) AddEntity(entity chunks.ChunkEntity, position r3.Vector)
func (dimension *Dimension) AddViewer(viewer chunks.Viewer, position r3.Vector)
func (dimension *Dimension) Close(async bool)
func (dimension *Dimension) GetBlockAt(vector r3.Vector) (blocks.Block, error)
func (dimension *Dimension) GetChunk(x, z int32) (*chunks.Chunk, bool)
func (dimension *Dimension) GetChunkProvider() providers.Provider
func (dimension *Dimension) GetDimensionId() DimensionId
func (dimension *Dimension) GetEntities() map[uint64]chunks.ChunkEntity
func (dimension *Dimension) GetEntity(runtimeId uint64) (chunks.ChunkEntity, error)
func (dimension *Dimension) GetGenerator() generation.Generator
func (dimension *Dimension) GetLevel() *Level
func (dimension *Dimension) GetName() string
func (dimension *Dimension) GetViewer(uuid uuid.UUID) (chunks.Viewer, bool)
func (dimension *Dimension) GetViewers() map[uuid.UUID]chunks.Viewer
func (dimension *Dimension) HasBlockUpdates() bool
func (dimension *Dimension) HasEntity(runtimeId uint64) bool
func (dimension *Dimension) IsChunkLoaded(x, z int32) bool
func (dimension *Dimension) LoadChunk(x, z int32, function func(chunk *chunks.Chunk))
func (dimension *Dimension) ProcessBlockUpdates()
func (dimension *Dimension) RemoveEntity(runtimeId uint64)
func (dimension *Dimension) RemoveViewer(uuid uuid.UUID)
func (dimension *Dimension) Save()
func (dimension *Dimension) SetBlockAt(vector r3.Vector, block blocks.Block)
func (dimension *Dimension) SetBlockForUpdate(vector r3.Vector)
func (dimension *Dimension) SetChunk(x, z int32, chunk *chunks.Chunk)
func (dimension *Dimension) SetChunkProvider(provider providers.Provider)
func (dimension *Dimension) SetGenerator(generator generation.Generator)
func (dimension *Dimension) Tick()
func (dimension *Dimension) UnloadChunk(x, z int32)
func (dimension *Dimension) UnsetBlockFromUpdate(vector r3.Vector)
type DimensionId
type GameRule
func NewGameRule(name GameRuleName, value interface{}) *GameRule
func (rule *GameRule) GetName() GameRuleName
func (rule *GameRule) GetValue() interface{}
func (rule *GameRule) SetValue(value interface{}) bool
type GameRuleName
type Level
func NewLevel(levelName string, serverPath string) *Level
func (level *Level) AddDimension(dimension *Dimension) bool
func (level *Level) AddGameRule(rule *GameRule)
func (level *Level) DimensionExists(name string) bool
func (level *Level) GetCurrentTick() int64
func (level *Level) GetDefaultDimension() *Dimension
func (level *Level) GetDimension(name string) (*Dimension, bool)
func (level *Level) GetDimensions() map[string]*Dimension
func (level *Level) GetGameRule(gameRule GameRuleName) *GameRule
func (level *Level) GetGameRules() map[GameRuleName]*GameRule
func (level *Level) GetName() string
func (level *Level) RemoveDimension(name string) bool
func (level *Level) SetDefaultDimension(dimension *Dimension)
func (level *Level) Tick()
type Loader
func NewLoader(dimension *Dimension, x, z int32) *Loader
func (loader *Loader) GetChunkHash(x, z int32) int
func (loader *Loader) GetChunkXZ(hash int) (int, int)
func (loader *Loader) GetLoadedChunkCount() int
func (loader *Loader) GetLoadedChunks() map[int]*chunks.Chunk
func (loader *Loader) HasChunkInUse(chunkX, chunkZ int32) bool
func (loader *Loader) LoadChunk(x, z int32)
func (loader *Loader) Move(chunkX, chunkZ int32)
func (loader *Loader) ProcessLoadQueue(perTick int)
func (loader *Loader) ProcessUnloadQueue(perTick int)
func (loader *Loader) Request(distance int32, perTick int)
func (loader *Loader) SortChunks(viewDistance int32)
func (loader *Loader) UnloadChunk(x, z int32)
func (loader *Loader) Warp(dimension *Dimension, chunkX, chunkZ int32)
type Manager
func NewManager(serverPath string) *Manager
func (manager *Manager) Close()
func (manager *Manager) GetDefaultLevel() *Level
func (manager *Manager) GetGenerationManager() generation.Manager
func (manager *Manager) GetLevel(name string) (*Level, error)
func (manager *Manager) GetLevels() map[string]*Level
func (manager *Manager) IsLevelGenerated(levelName string) bool
func (manager *Manager) IsLevelLoaded(levelName string) bool
func (manager *Manager) LoadLevel(levelName string) bool
func (manager *Manager) Save()
func (manager *Manager) SetDefaultLevel(level *Level)
func (manager *Manager) Tick()

Package files

dimension.go game_rule.go level.go loader.go manager.go

Variables

EntityRuntimeId is an ever increasing unsigned int64. Every entity placed in the world increments the runtime ID.

var EntityRuntimeId uint64

UnavailableEntity gets returned if an entity is attempted to be retrieved but is not available in the dimension.

var UnavailableEntity = errors.New("dimension does not have entity with runtime ID available")

UnloadedChunk gets returned if a block is attempted to be retrieved from an unloaded chunk.

var UnloadedChunk = errors.New("chunk is not loaded")

type Dimension

Dimension is a struct which holds helper functions for chunks.

type Dimension struct {
    // contains filtered or unexported fields
}

func NewDimension

func NewDimension(name string, level *Level, id DimensionId) *Dimension

NewDimension returns a new dimension with the given name, levelName, dimension ID and server path. Dimension data will be written in the `serverPath/worlds/levelName/name` path.

func (*Dimension) AddEntity

func (dimension *Dimension) AddEntity(entity chunks.ChunkEntity, position r3.Vector)

AddEntity adds a new entity at the given position in the dimension.

func (*Dimension) AddViewer

func (dimension *Dimension) AddViewer(viewer chunks.Viewer, position r3.Vector)

AddViewer adds a viewer to the dimension.

func (*Dimension) Close

func (dimension *Dimension) Close(async bool)

Close closes the dimension and saves it. If async is true, closes the dimension asynchronously.

func (*Dimension) GetBlockAt

func (dimension *Dimension) GetBlockAt(vector r3.Vector) (blocks.Block, error)

GetBlockAt returns a block in the dimension at the given vector. GetBlockAt returns an error when the chunk of the block was not loaded, and an error if a block with the given ID wasn't registered.

func (*Dimension) GetChunk

func (dimension *Dimension) GetChunk(x, z int32) (*chunks.Chunk, bool)

GetChunk returns a chunk in the dimension at the given chunk X and Z.

func (*Dimension) GetChunkProvider

func (dimension *Dimension) GetChunkProvider() providers.Provider

GetChunkProvider returns the chunk provider of the dimension.

func (*Dimension) GetDimensionId

func (dimension *Dimension) GetDimensionId() DimensionId

GetDimensionId returns the dimension ID of the dimension.

func (*Dimension) GetEntities

func (dimension *Dimension) GetEntities() map[uint64]chunks.ChunkEntity

GetEntities returns all loaded entities in this dimension in a runtime ID => entity map.

func (*Dimension) GetEntity

func (dimension *Dimension) GetEntity(runtimeId uint64) (chunks.ChunkEntity, error)

GetEntity returns an entity in the dimension by its runtime ID. Returns UnavailableEntity error if no entity with that runtime ID was available in the dimension.

func (*Dimension) GetGenerator

func (dimension *Dimension) GetGenerator() generation.Generator

GetGenerator returns the generator of the dimension.

func (*Dimension) GetLevel

func (dimension *Dimension) GetLevel() *Level

GetLevel returns the level of the dimension.

func (*Dimension) GetName

func (dimension *Dimension) GetName() string

GetName returns the name of the dimension.

func (*Dimension) GetViewer

func (dimension *Dimension) GetViewer(uuid uuid.UUID) (chunks.Viewer, bool)

GetViewer returns a viewer of a dimension by its UUID. A bool gets returned indicating whether the viewer was found or not.

func (*Dimension) GetViewers

func (dimension *Dimension) GetViewers() map[uuid.UUID]chunks.Viewer

GetViewers returns all entities considered as viewers in the dimension.

func (*Dimension) HasBlockUpdates

func (dimension *Dimension) HasBlockUpdates() bool

HasBlockUpdates sets a block at a certain position to be updated on the next tick

func (*Dimension) HasEntity

func (dimension *Dimension) HasEntity(runtimeId uint64) bool

HasEntity checks if the dimension has an entity available with the given runtime ID.

func (*Dimension) IsChunkLoaded

func (dimension *Dimension) IsChunkLoaded(x, z int32) bool

IsChunkLoaded checks if a chunk at the given chunk X and Z is loaded.

func (*Dimension) LoadChunk

func (dimension *Dimension) LoadChunk(x, z int32, function func(chunk *chunks.Chunk))

LoadChunk submits a request with the given chunk X and Z to get loaded. The function given gets run as soon as the chunk gets loaded.

func (*Dimension) ProcessBlockUpdates

func (dimension *Dimension) ProcessBlockUpdates()

ProcessBlockUpdates processes all the block update requests

func (*Dimension) RemoveEntity

func (dimension *Dimension) RemoveEntity(runtimeId uint64)

RemoveEntity removes an entity in the dimension with the given runtime ID. The removed entity also gets closed if not yet done.

func (*Dimension) RemoveViewer

func (dimension *Dimension) RemoveViewer(uuid uuid.UUID)

RemoveViewer removes a viewer from the dimension.

func (*Dimension) Save

func (dimension *Dimension) Save()

Save saves the dimension.

func (*Dimension) SetBlockAt

func (dimension *Dimension) SetBlockAt(vector r3.Vector, block blocks.Block)

SetBlockAt sets a block at the given vector. If the chunk at that position was not yet loaded, it loads it and places the block.

func (*Dimension) SetBlockForUpdate

func (dimension *Dimension) SetBlockForUpdate(vector r3.Vector)

SetBlockUpdate sets a block at a certain position to be updated on the next tick

func (*Dimension) SetChunk

func (dimension *Dimension) SetChunk(x, z int32, chunk *chunks.Chunk)

SetChunk sets a new chunk at the given chunk X and Z.

func (*Dimension) SetChunkProvider

func (dimension *Dimension) SetChunkProvider(provider providers.Provider)

SetChunkProvider sets the chunk provider of the dimension.

func (*Dimension) SetGenerator

func (dimension *Dimension) SetGenerator(generator generation.Generator)

SetGenerator sets the generator of the dimension.

func (*Dimension) Tick

func (dimension *Dimension) Tick()

Tick ticks the entire dimension, such as entities.

func (*Dimension) UnloadChunk

func (dimension *Dimension) UnloadChunk(x, z int32)

UnloadChunk unloads a chunk at the given chunk X and Z.

func (*Dimension) UnsetBlockFromUpdate

func (dimension *Dimension) UnsetBlockFromUpdate(vector r3.Vector)

SetBlockUpdate removes a block at a certain position from being updated

type DimensionId

DimensionId is an ID of a dimension.

type DimensionId byte

const (
    OverworldId DimensionId = iota
    NetherId
    EndId
)

type GameRule

GameRule is a struct holding a name and data of either uint32, bool or float32.

type GameRule struct {
    // contains filtered or unexported fields
}

func NewGameRule

func NewGameRule(name GameRuleName, value interface{}) *GameRule

NewGameRule returns a new game rule with the given name and value.

func (*GameRule) GetName

func (rule *GameRule) GetName() GameRuleName

GetName returns the name of the game rule.

func (*GameRule) GetValue

func (rule *GameRule) GetValue() interface{}

GetValue returns the value of the game rule. Game rules may hold either a uint32, a bool or a float32.

func (*GameRule) SetValue

func (rule *GameRule) SetValue(value interface{}) bool

SetValue sets the value of this game rule. Returns false if the new value does not have a type compatible with the old value.

type GameRuleName

GameRuleName is the Minecraft name used for a game rule.

type GameRuleName string

const (
    GameRuleCommandBlockOutput  GameRuleName = "commandblockoutput"
    GameRuleDoDaylightCycle     GameRuleName = "dodaylightcycle"
    GameRuleDoEntityDrops       GameRuleName = "doentitydrops"
    GameRuleDoFireTick          GameRuleName = "dofiretick"
    GameRuleDoMobLoot           GameRuleName = "domobloot"
    GameRuleDoMobSpawning       GameRuleName = "domobspawning"
    GameRuleDoTileDrops         GameRuleName = "dotiledrops"
    GameRuleDoWeatherCycle      GameRuleName = "doweathercycle"
    GameRuleDrowningDamage      GameRuleName = "drowningdamage"
    GameRuleFallDamage          GameRuleName = "falldamage"
    GameRuleFireDamage          GameRuleName = "firedamage"
    GameRuleKeepInventory       GameRuleName = "keepinventory"
    GameRuleMobGriefing         GameRuleName = "mobgriefing"
    GameRuleNaturalRegeneration GameRuleName = "naturalregeneration"
    GameRulePvp                 GameRuleName = "pvp"
    GameRuleSendCommandFeedback GameRuleName = "sendcommandfeedback"
    GameRuleShowCoordinates     GameRuleName = "showcoordinates"
    GameRuleRandomTickSpeed     GameRuleName = "randomtickspeed"
    GameRuleTntExplodes         GameRuleName = "tntexplodes"
)

type Level

Level is a struct that manages an unlimited set of dimensions. Every level has its own set of game rules.

type Level struct {
    // contains filtered or unexported fields
}

func NewLevel

func NewLevel(levelName string, serverPath string) *Level

NewLevel returns a new level with the given level name and server path. World data will be generated in: `serverPath/worlds/`

func (*Level) AddDimension

func (level *Level) AddDimension(dimension *Dimension) bool

AddDimension adds a dimension to the level, overwriting it if needed. Returns a bool indicating if a dimension got overwritten.

func (*Level) AddGameRule

func (level *Level) AddGameRule(rule *GameRule)

AddGameRule adds the given game rule to the level.

func (*Level) DimensionExists

func (level *Level) DimensionExists(name string) bool

DimensionExists checks if a dimension with the given name exists in the level.

func (*Level) GetCurrentTick

func (level *Level) GetCurrentTick() int64

GetCurrentTick returns the amount of ticks this level has had.

func (*Level) GetDefaultDimension

func (level *Level) GetDefaultDimension() *Dimension

GetDefaultDimension returns the default dimension of the level.

func (*Level) GetDimension

func (level *Level) GetDimension(name string) (*Dimension, bool)

GetDimension returns a dimension by its name and a bool indicating success.

func (*Level) GetDimensions

func (level *Level) GetDimensions() map[string]*Dimension

GetDimensions returns all dimensions of the level in a name => dimension map.

func (*Level) GetGameRule

func (level *Level) GetGameRule(gameRule GameRuleName) *GameRule

GetGameRule returns a game rule with the given name.

func (*Level) GetGameRules

func (level *Level) GetGameRules() map[GameRuleName]*GameRule

GetGameRules returns all game rules of the level in a name => game rule map.

func (*Level) GetName

func (level *Level) GetName() string

GetName returns the name of the level.

func (*Level) RemoveDimension

func (level *Level) RemoveDimension(name string) bool

RemoveDimension removes a dimension in the level with the given name. It returns a bool indicating success.

func (*Level) SetDefaultDimension

func (level *Level) SetDefaultDimension(dimension *Dimension)

SetDefaultDimension sets the default dimension of the level. Also adds the level if had not yet been added.

func (*Level) Tick

func (level *Level) Tick()

Tick ticks the level, ticking all dimensions and their contents.

type Loader

Loader is a struct used to load a range of chunks from a dimension.

type Loader struct {
    Dimension *Dimension
    ChunkX    int32
    ChunkZ    int32

    // UnloadFunction gets called for every chunk that gets unloaded in this loader.
    // Chunks that exceed the request range automatically get unloaded during request.
    UnloadFunction func(*chunks.Chunk)
    // LoadFunction gets called for every chunk loaded by this loader.
    LoadFunction            func(*chunks.Chunk)
    PublisherUpdateFunction func()
    // contains filtered or unexported fields
}

func NewLoader

func NewLoader(dimension *Dimension, x, z int32) *Loader

NewLoader returns a new loader on the given dimension with the given chunk X and Z.

func (*Loader) GetChunkHash

func (loader *Loader) GetChunkHash(x, z int32) int

Returns chunk coordinates as a identifiable hash

func (*Loader) GetChunkXZ

func (loader *Loader) GetChunkXZ(hash int) (int, int)

Returns chunk coordinates from an identifiable hash

func (*Loader) GetLoadedChunkCount

func (loader *Loader) GetLoadedChunkCount() int

GetLoadedChunkCount returns loaded chunks.

func (*Loader) GetLoadedChunks

func (loader *Loader) GetLoadedChunks() map[int]*chunks.Chunk

GetLoadedChunkCount returns the count of the loaded chunks.

func (*Loader) HasChunkInUse

func (loader *Loader) HasChunkInUse(chunkX, chunkZ int32) bool

HasChunkInUse checks if the loader has a chunk with the given chunk X and Z in use.

func (*Loader) LoadChunk

func (loader *Loader) LoadChunk(x, z int32)

Puts a chunk in the load queue to be processed

func (*Loader) Move

func (loader *Loader) Move(chunkX, chunkZ int32)

Move moves the loader to the given chunk X and Z.

func (*Loader) ProcessLoadQueue

func (loader *Loader) ProcessLoadQueue(perTick int)

ProcessLoadQueue processed all the chunk load queue with and optional chunks per tick limit

func (*Loader) ProcessUnloadQueue

func (loader *Loader) ProcessUnloadQueue(perTick int)

ProcessLoadQueue processed all the chunk unload queue with and optional chunks per tick limit

func (*Loader) Request

func (loader *Loader) Request(distance int32, perTick int)

func (*Loader) SortChunks

func (loader *Loader) SortChunks(viewDistance int32)

SortChunks determines what chunks will be put in the chunk load queue and the unload queue based on the viewDistance given.

func (*Loader) UnloadChunk

func (loader *Loader) UnloadChunk(x, z int32)

Puts a chunk in the unload queue to be processed

func (*Loader) Warp

func (loader *Loader) Warp(dimension *Dimension, chunkX, chunkZ int32)

Warp warps the loader to the given dimension and moves it to the given chunk X and Z.

type Manager

Manager is a struct managing all levels and provides helper functions.

type Manager struct {
    // contains filtered or unexported fields
}

func NewManager

func NewManager(serverPath string) *Manager

NewManager returns a new worlds manager. The manager will create its content inside of the `serverPath/worlds/` folder.

func (*Manager) Close

func (manager *Manager) Close()

Close closes all levels and their dimensions.

func (*Manager) GetDefaultLevel

func (manager *Manager) GetDefaultLevel() *Level

GetDefaultLevel returns the default level of the manager.

func (*Manager) GetGenerationManager

func (manager *Manager) GetGenerationManager() generation.Manager

GetGenerationManager returns the generator manager of the level manager.

func (*Manager) GetLevel

func (manager *Manager) GetLevel(name string) (*Level, error)

GetLevel returns a level by its name, or an error if something went wrong.

func (*Manager) GetLevels

func (manager *Manager) GetLevels() map[string]*Level

GetLoadedLevels returns all loaded levels of the manager in a name => level map.

func (*Manager) IsLevelGenerated

func (manager *Manager) IsLevelGenerated(levelName string) bool

IsLevelGenerated checks if a level with the given name has been generated.

func (*Manager) IsLevelLoaded

func (manager *Manager) IsLevelLoaded(levelName string) bool

IsLevelLoaded checks if a level is loaded with the given name.

func (*Manager) LoadLevel

func (manager *Manager) LoadLevel(levelName string) bool

LoadLevel loads a level with the given name, and returns a bool indicating success.

func (*Manager) Save

func (manager *Manager) Save()

Save saves all levels and their dimensions.

func (*Manager) SetDefaultLevel

func (manager *Manager) SetDefaultLevel(level *Level)

SetDefaultLevel sets the given level as default, and adds it if needed.

func (*Manager) Tick

func (manager *Manager) Tick()

Tick ticks all levels managed by the Manager.

Subdirectories

Name	Synopsis

blocks
chunks
entities
entities/data
generation
generation/defaults
io
providers
utils

github.com/Irmine/Worlds