format

Documentation

Overview

Package format implements several file formats for the rbxmk command. These formats can be registered to a rbxmk.Formats with the Register function.

This package also contains several reusable functions that implement rbxmk.Drill and rbxmk.OutputMerger.

Formats

The following formats are registered:

rbxl, rbxlx, rbxm, rbxmx

	Roblox Place and Model files. Reads and writes Instance data.

lua

	Lua sourc file. Reads and writes Value data of the ProtectedString
	value type.

Index

• Variables
• type JSONCodec
  • func (c JSONCodec) Decode(r io.Reader, data *rbxmk.Data) (err error)
  • func (c JSONCodec) Encode(w io.Writer, data rbxmk.Data) (err error)
• type LuaCodec
  • func (c LuaCodec) Decode(r io.Reader, data *rbxmk.Data) (err error)
  • func (c LuaCodec) Encode(w io.Writer, data rbxmk.Data) (err error)
• type LuaType
  • func (t LuaType) ClassName() string
• type RBXCodec
  • func (c *RBXCodec) Decode(r io.Reader, data *rbxmk.Data) (err error)
  • func (c *RBXCodec) Encode(w io.Writer, data rbxmk.Data) (err error)
• type TextCodec
  • func (c *TextCodec) Decode(r io.Reader, data *rbxmk.Data) (err error)
  • func (c *TextCodec) Encode(w io.Writer, data rbxmk.Data) (err error)
• type XMLCodec
  • func (c *XMLCodec) Decode(r io.Reader, data *rbxmk.Data) (err error)
  • func (c *XMLCodec) Encode(w io.Writer, data rbxmk.Data) (err error)

Variables

var Formats = rbxmk.NewFormats()

Types

type JSONCodec

type JSONCodec struct{}

func (JSONCodec) Decode

func (c JSONCodec) Decode(r io.Reader, data *rbxmk.Data) (err error)

func (JSONCodec) Encode

func (c JSONCodec) Encode(w io.Writer, data rbxmk.Data) (err error)

type LuaCodec

type LuaCodec struct {
	Type LuaType
	Name string
}

func (LuaCodec) Decode

func (c LuaCodec) Decode(r io.Reader, data *rbxmk.Data) (err error)

func (LuaCodec) Encode

func (c LuaCodec) Encode(w io.Writer, data rbxmk.Data) (err error)

type LuaType

type LuaType uint8

const (
	LuaValue LuaType = iota
	LuaScript
	LuaLocalScript
	LuaModuleScript
)

func (LuaType) ClassName

func (t LuaType) ClassName() string

type RBXCodec

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

func (*RBXCodec) Decode

func (c *RBXCodec) Decode(r io.Reader, data *rbxmk.Data) (err error)

func (*RBXCodec) Encode

func (c *RBXCodec) Encode(w io.Writer, data rbxmk.Data) (err error)

type TextCodec

type TextCodec struct {
	Binary bool
}

func (*TextCodec) Decode

func (c *TextCodec) Decode(r io.Reader, data *rbxmk.Data) (err error)

func (*TextCodec) Encode

func (c *TextCodec) Encode(w io.Writer, data rbxmk.Data) (err error)

type XMLCodec

type XMLCodec struct {
	API rbxapi.Root
}

func (*XMLCodec) Decode

func (c *XMLCodec) Decode(r io.Reader, data *rbxmk.Data) (err error)

func (*XMLCodec) Encode

func (c *XMLCodec) Encode(w io.Writer, data rbxmk.Data) (err error)