index

Documentation

Overview

Provides structure for the primary API data index.

Index

• Variables
• type Class
• type Enum
• type EnumItem
• type Member
• type Root
  • func (r *Root) Build(hist *history.Root, dump *rbxdump.Root) error
• type Type
• type TypeRef
• type TypeRefs
  • func (t TypeRefs) Len() int
  • func (t TypeRefs) Less(i, j int) bool
  • func (t TypeRefs) Swap(i, j int)

Variables

var MemberTypes = []id.MemberType{
	"Property",
	"Function",
	"Event",
	"Callback",
}

Types

type Class

type Class struct {
	Name         string
	Removed      bool       // Not present in latest state.
	HasRemoved   bool       // Has removed descendant class.
	Subclasses   []id.Class // Sorted by name.
	Superclasses []id.Class // Sorted by ancestry.
	Related      TypeRefs   `json:",omitempty"`
}

type Enum

type Enum struct {
	Name         string
	Removed      bool
	ItemsByValue []id.EnumItem
	ItemsByIndex []id.EnumItem
	Related      TypeRefs `json:",omitempty"`
}

type EnumItem

type EnumItem struct {
	Enum    string
	Name    string
	Removed bool
}

type Member

type Member struct {
	Class      string
	Name       string
	MemberType string
	Removed    bool
	Related    TypeRefs `json:",omitempty"`
}

type Root

type Root struct {
	RootClasses    []id.Class
	MemberTypes    []id.MemberType
	TypeCategories []string
	Tag            []string
	Security       []string
	ThreadSafety   []string

	Class    map[id.Class]*Class
	Member   map[id.Class]map[id.Member]*Member
	Enum     map[id.Enum]*Enum
	EnumItem map[id.Enum]map[id.EnumItem]*EnumItem
	Type     map[id.Type]*Type

	MinYear int
	MaxYear int
}

func (*Root) Build

func (r *Root) Build(hist *history.Root, dump *rbxdump.Root) error

type Type

type Type struct {
	Category string
	Name     string
	Removed  bool
	Related  TypeRefs `json:",omitempty"`
}

type TypeRef

type TypeRef struct {
	Class      id.Class      // Class name.
	Member     id.Member     // Member name.
	MemberType id.MemberType // Member type.
	Removed    bool          // Whether member is removed.
	Field      string        // Index of Fields.
	Kind       string        // Type: rbxdump.Type; Parameter: rbxdump.Parameter.
	Index      int           // Index within slice value. -1: Not a slice.
	Type       rbxdump.Type  // Type value.
}

TypeRef represents a reference to a type from a member.

type TypeRefs

type TypeRefs []TypeRef

func (TypeRefs) Len

func (t TypeRefs) Len() int

func (TypeRefs) Less

func (t TypeRefs) Less(i, j int) bool

func (TypeRefs) Swap

func (t TypeRefs) Swap(i, j int)