library

Documentation

Index

• Variables
• func All() []rbxmk.Library
• type ClipboardSource
  • func (s ClipboardSource) Read(formats ...rtypes.FormatSelector) (v types.Value, err error)
  • func (s ClipboardSource) Write(value types.Value, formats ...rtypes.FormatSelector) error
• type FSSource
  • func (s FSSource) Dir(dirname string) (files []fs.DirEntry, err error)
  • func (s FSSource) MkDir(path string, all bool) (ok bool, err error)
  • func (s FSSource) Read(filename string, selector rtypes.FormatSelector) (v types.Value, err error)
  • func (s FSSource) Remove(path string, all bool) (ok bool, err error)
  • func (s FSSource) Rename(from, to string) (ok bool, err error)
  • func (s FSSource) Stat(filename string) (info fs.FileInfo, err error)
  • func (s FSSource) Write(filename string, value types.Value, selector rtypes.FormatSelector) error
• type RBXAssetIDSource
  • func (s RBXAssetIDSource) Create(options rtypes.RBXAssetOptions) (assetID int64, err error)
  • func (s RBXAssetIDSource) Read(options rtypes.RBXAssetOptions) (body types.Value, err error)
  • func (s RBXAssetIDSource) Write(options rtypes.RBXAssetOptions) error

Variables

var Base = rbxmk.Library{
	Name:       "base",
	ImportedAs: "",
	Open:       openBase,
	Dump:       dumpBase,
}

var Clipboard = rbxmk.Library{
	Name:       "clipboard",
	ImportedAs: "clipboard",
	Open:       openClipboard,
	Dump:       dumpClipboard,
	Types: []func() rbxmk.Reflector{
		reflect.FormatSelector,
		reflect.Variant,
	},
}

var FS = rbxmk.Library{
	Name:       "fs",
	ImportedAs: "fs",
	Open:       openFS,
	Dump:       dumpFS,
	Types: []func() rbxmk.Reflector{
		reflect.Bool,
		reflect.FormatSelector,
		reflect.String,
		reflect.Variant,
	},
}

var HTTP = rbxmk.Library{
	Name:       "http",
	ImportedAs: "http",
	Open:       openHTTP,
	Dump:       dumpHTTP,
	Types: []func() rbxmk.Reflector{
		reflect.HTTPHeaders,
		reflect.HTTPOptions,
		reflect.HTTPRequest,
		reflect.HTTPResponse,
	},
}

var Math = rbxmk.Library{
	Name:       "math",
	ImportedAs: "math",
	Open:       openMath,
	Dump:       dumpMath,
}

var OS = rbxmk.Library{
	Name:       "os",
	ImportedAs: "os",
	Open:       openOS,
	Dump:       dumpOS,
}

var Path = rbxmk.Library{
	Name:       "path",
	ImportedAs: "path",
	Open:       openPath,
	Dump:       dumpPath,
}

var RBXAssetID = rbxmk.Library{
	Name:       "rbxassetid",
	ImportedAs: "rbxassetid",
	Open:       openRBXAssetID,
	Dump:       dumpRBXAssetID,
	Types: []func() rbxmk.Reflector{
		reflect.RBXAssetOptions,
	},
}

var RBXMK = rbxmk.Library{
	Name:       "rbxmk",
	ImportedAs: "rbxmk",
	Open:       openRBXMK,
	Dump:       dumpRBXMK,
	Types: []func() rbxmk.Reflector{
		reflect.AttrConfig,
		reflect.Enums,
		reflect.FormatSelector,
		reflect.Nil,
		reflect.RootDesc,
		reflect.String,
		reflect.Symbol,
		reflect.Table,
	},
}

var Roblox = rbxmk.Library{
	Name:       "roblox",
	ImportedAs: "",
	Open:       openRoblox,
	Dump:       dumpRoblox,
	Types: []func() rbxmk.Reflector{
		reflect.Array,
		reflect.Axes,
		reflect.BinaryString,
		reflect.Bool,
		reflect.BrickColor,
		reflect.CFrame,
		reflect.Color3,
		reflect.Color3uint8,
		reflect.ColorSequence,
		reflect.ColorSequenceKeypoint,
		reflect.Content,
		reflect.Dictionary,
		reflect.Double,
		reflect.Enum,
		reflect.EnumItem,
		reflect.Enums,
		reflect.Faces,
		reflect.Float,
		reflect.Instance,
		reflect.Int,
		reflect.Int64,
		reflect.Number,
		reflect.NumberRange,
		reflect.NumberSequence,
		reflect.NumberSequenceKeypoint,
		reflect.Objects,
		reflect.PhysicalProperties,
		reflect.ProtectedString,
		reflect.Ray,
		reflect.Rect,
		reflect.Region3,
		reflect.Region3int16,
		reflect.SharedString,
		reflect.String,
		reflect.Token,
		reflect.Tuple,
		reflect.UDim,
		reflect.UDim2,
		reflect.UniqueId,
		reflect.Variant,
		reflect.Vector2,
		reflect.Vector2int16,
		reflect.Vector3,
		reflect.Vector3int16,
	},
}

var String = rbxmk.Library{
	Name:       "string",
	ImportedAs: "string",
	Open:       openString,
	Dump:       dumpString,
}

var Sym = rbxmk.Library{
	Name:       "sym",
	ImportedAs: "sym",
	Open:       openSym,
	Dump:       dumpSym,
	Types: []func() rbxmk.Reflector{
		reflect.Symbol,
	},
}

var Table = rbxmk.Library{
	Name:       "table",
	ImportedAs: "table",
	Open:       openTable,
	Dump:       dumpTable,
}

var Types = rbxmk.Library{
	Name:       "types",
	ImportedAs: "types",
	Open:       openTypes,
	Dump:       dumpTypes,
}

Functions

func All

func All() []rbxmk.Library

All returns a list of Libraries defined in the package, ordered by ascending priority.

Types

type ClipboardSource

type ClipboardSource struct {
	*rbxmk.World
}

ClipboardSource provides access to the clipboard of the operating system.

func (ClipboardSource) Read

func (s ClipboardSource) Read(formats ...rtypes.FormatSelector) (v types.Value, err error)

Read reads a value from the clipboard according to the given formats. If no formats are given, or no data is found, then nil is returned with no error.

func (ClipboardSource) Write

func (s ClipboardSource) Write(value types.Value, formats ...rtypes.FormatSelector) error

Write writes a value to the clipboard according to the given formats. If no formats are given, then the clipboard is cleared.

type FSSource

type FSSource struct {
	*rbxmk.World
}

FSSource provides access to the file system.

func (FSSource) Dir

func (s FSSource) Dir(dirname string) (files []fs.DirEntry, err error)

Dir returns a list of files in the given directory.

func (FSSource) MkDir

func (s FSSource) MkDir(path string, all bool) (ok bool, err error)

MkDir creates a new directory.

func (FSSource) Read

func (s FSSource) Read(filename string, selector rtypes.FormatSelector) (v types.Value, err error)

Read reads the content of a file.

func (FSSource) Remove

func (s FSSource) Remove(path string, all bool) (ok bool, err error)

Remove removes a file or directory.

func (FSSource) Rename

func (s FSSource) Rename(from, to string) (ok bool, err error)

Rename moves a file or directory.

func (FSSource) Stat

func (s FSSource) Stat(filename string) (info fs.FileInfo, err error)

Stat gets metadata of the given file.

func (FSSource) Write

func (s FSSource) Write(filename string, value types.Value, selector rtypes.FormatSelector) error

Write writes a value to a file.

type RBXAssetIDSource

type RBXAssetIDSource struct {
	*rbxmk.World
}

RBXAssetIDSource provides access to assets on the Roblox website.

func (RBXAssetIDSource) Create

func (s RBXAssetIDSource) Create(options rtypes.RBXAssetOptions) (assetID int64, err error)

Create creates and uploads a new asset according to the given options. Returns the ID of the created asset.

func (RBXAssetIDSource) Read

func (s RBXAssetIDSource) Read(options rtypes.RBXAssetOptions) (body types.Value, err error)

Read downloads an asset according to the given options.

func (RBXAssetIDSource) Write

func (s RBXAssetIDSource) Write(options rtypes.RBXAssetOptions) error

Write uploads an asset according to the given options.