region

package

v1.20.1 Latest Latest Go to latest Published: Nov 14, 2023 License: MIT Imports: 5 Imported by: 10

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Tnze/go-mc

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrNoSector             = errors.New("sector does not exist")
	ErrNoData               = errors.New("data is missing")
	ErrSectorNegativeLength = errors.New("declared length of data is negative")
	ErrTooLarge             = errors.New("data too large")
)

Functions ¶

func At ¶ added in v1.19.0

func At(cx, cz int) (int, int)

At calculate the region's coordinates where the chunk in 计算chunk在哪一个region中

func In ¶

func In(cx, cz int) (int, int)

In calculate chunk's coordinates relative to region 计算chunk在region中的相对坐标。即，除以32并取余。

Types ¶

type Region ¶

type Region struct {
	Timestamps [32][32]int32
	// contains filtered or unexported fields
}

Region contain 32*32 chunks in one .mca file Not MT-Safe!

func Create ¶

func Create(name string) (*Region, error)

Create open .mca file with os.O_CREATE|os. O_EXCL, and init the region

func CreateWriter ¶ added in v1.19.0

func CreateWriter(f io.ReadWriteSeeker) (r *Region, err error)

CreateWriter create Region by an io.ReadWriteSeeker

func Load ¶ added in v1.17.1

func Load(f io.ReadWriteSeeker) (r *Region, err error)

Load works like Open but read from an io.ReadWriteSeeker.

func Open ¶

func Open(name string) (r *Region, err error)

Open a .mca file and read the head. Close the Region after used.

func (*Region) Close ¶

func (r *Region) Close() error

Close the region file if possible. The responsibility for Close the file with who Open it. If you made the Region with Load(), this method close the file only if your io.ReadWriteSeeker implement io.Close

func (*Region) ExistSector ¶

func (r *Region) ExistSector(x, z int) bool

ExistSector return if a sector is existed

func (*Region) PadToFullSector ¶ added in v1.19.0

func (r *Region) PadToFullSector() error

PadToFullSector writes zeros to the end of the file to make size a multiple of 4096. Legacy versions of Minecraft require this. Need to be called right before Close.

func (*Region) ReadSector ¶

func (r *Region) ReadSector(x, z int) (data []byte, err error)

ReadSector find and read the Chunk data from region

func (*Region) WriteSector ¶

func (r *Region) WriteSector(x, z int, data []byte) error

WriteSector write Chunk data into region file

Source Files ¶

View all Source files

mca.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL