roblox

Documentation

Overview

Package roblox provides generic types for Roblox's internal Binary implementations.

Index

• Constants
• Variables
• func ValidRenderer(renderer string) bool
• type BinaryType
  • func (bt BinaryType) BinaryName() string
  • func (bt BinaryType) Executable() string
  • func (bt BinaryType) String() string
• type FFlags
  • func (f FFlags) Apply(versionDir string) error
  • func (f FFlags) SetRenderer(renderer string) error

Constants

const DefaultRenderer = "D3D11"

defaultRenderer is used as the default renderer when no explicit named renderer argument has been given.

Variables

var ErrInvalidRenderer = errors.New("invalid renderer given")

Functions

func ValidRenderer

func ValidRenderer(renderer string) bool

ValidRenderer determines if the named renderer is part of the available supported Roblox renderer backends, used in SetRenderer.

Types

type BinaryType

type BinaryType int

BinaryType is a representation of available Roblox applications aka. Binaries

const (
	Player BinaryType = iota
	Studio
)

func (BinaryType) BinaryName

func (bt BinaryType) BinaryName() string

BinaryName returns Roblox's internal API name for the named BinaryType

Does not support platforms other than Windows.

func (BinaryType) Executable

func (bt BinaryType) Executable() string

Executable returns the executable file name for the named BinaryType

Does not support platforms other than Windows.

func (BinaryType) String

func (bt BinaryType) String() string

type FFlags

type FFlags map[string]interface{}

FFlags is Roblox's Fast Flags implemented in map form.

func (FFlags) Apply

func (f FFlags) Apply(versionDir string) error

Apply creates and compiles the FFlags file and directory in the named versionDir.

func (FFlags) SetRenderer

func (f FFlags) SetRenderer(renderer string) error

SetRenderer sets the named renderer to the FFlags, by disabling all other unused renderers.