Documentation ¶
Overview ¶
The rbxdump package is used to represent Roblox Lua API dumps.
Index ¶
- type Callback
- func (member *Callback) Copy() *Callback
- func (member *Callback) Fields(fields Fields) Fields
- func (member *Callback) MarshalJSON() ([]byte, error)
- func (member *Callback) MemberCopy() Member
- func (member *Callback) MemberName() string
- func (member *Callback) MemberType() string
- func (member *Callback) SetFields(fields Fields)
- type Class
- type Enum
- type EnumItem
- type Event
- func (member *Event) Copy() *Event
- func (member *Event) Fields(fields Fields) Fields
- func (member *Event) MarshalJSON() ([]byte, error)
- func (member *Event) MemberCopy() Member
- func (member *Event) MemberName() string
- func (member *Event) MemberType() string
- func (member *Event) SetFields(fields Fields)
- type Fielder
- type Fields
- type Function
- func (member *Function) Copy() *Function
- func (member *Function) Fields(fields Fields) Fields
- func (member *Function) MarshalJSON() ([]byte, error)
- func (member *Function) MemberCopy() Member
- func (member *Function) MemberName() string
- func (member *Function) MemberType() string
- func (member *Function) SetFields(fields Fields)
- type Member
- type Parameter
- type PreferredDescriptor
- type Property
- func (member *Property) Copy() *Property
- func (member *Property) Fields(fields Fields) Fields
- func (member *Property) MarshalJSON() ([]byte, error)
- func (member *Property) MemberCopy() Member
- func (member *Property) MemberName() string
- func (member *Property) MemberType() string
- func (member *Property) SetFields(fields Fields)
- type Root
- type Tagger
- type Tags
- type Type
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Callback ¶
type Callback struct { Name string Parameters []Parameter ReturnType []Type Security string ThreadSafety string PreferredDescriptor PreferredDescriptor Tags }
Callback is a Member that represents a class callback.
func (*Callback) MarshalJSON ¶ added in v0.10.1
func (*Callback) MemberCopy ¶ added in v0.2.0
MemberCopy returns a deep copy of the member.
MemberType implements the Member interface.
func (*Callback) MemberName ¶ added in v0.2.0
MemberName returns the name of the member.
MemberType implements the Member interface.
func (*Callback) MemberType ¶ added in v0.2.0
MemberType returns a string indicating the the type of member.
MemberType implements the Member interface.
type Class ¶
type Class struct { Name string Superclass string MemoryCategory string Members map[string]Member PreferredDescriptor PreferredDescriptor Tags }
Class represents a class defined in an API dump.
func (*Class) GetMembers ¶
GetMembers returns a list of members belonging to the class, sorted by name.
type Enum ¶
type Enum struct { Name string Items map[string]*EnumItem PreferredDescriptor PreferredDescriptor Tags }
Enum represents an enum defined in an API dump.
func (*Enum) Fields ¶ added in v0.2.0
Fields implements the Fielder interface. Does not return the Items field.
func (*Enum) GetEnumItems ¶
GetEnumItems returns a list of items of the enum.
type EnumItem ¶
type EnumItem struct { Name string Value int Index int // Index determines the item's order among its sibling items. LegacyNames []string PreferredDescriptor PreferredDescriptor Tags }
EnumItem represents an enum item.
type Event ¶
type Event struct { Name string Parameters []Parameter Security string ThreadSafety string PreferredDescriptor PreferredDescriptor Tags }
Event is a Member that represents a class event.
func (*Event) MarshalJSON ¶ added in v0.10.1
func (*Event) MemberCopy ¶ added in v0.2.0
MemberCopy returns a deep copy of the member.
MemberType implements the Member interface.
func (*Event) MemberName ¶ added in v0.2.0
MemberName returns the name of the member.
MemberType implements the Member interface.
func (*Event) MemberType ¶ added in v0.2.0
MemberType returns a string indicating the the type of member.
MemberType implements the Member interface.
type Fielder ¶ added in v0.2.0
type Fielder interface { // Fields populates f with the fields of the value that are present in f. // Fields that are not present in the value are deleted from f. If f is nil, // then a new Fields is created and populated with all fields. Returns the // populated Fields. // // Must include only fields that are expected to be diffed and patched. // // Implementations may retain returned values. Fields(f Fields) Fields // SetFields receives fields from f and sets them on the value. Irrelevant // fields are ignored. // // If possible, SetFields may convert any type to the field's canonical // type. At a minimu, the implemntation must convert the field's type, and a // general interface representation, according to the json package. // // Implementations must not retain received values; they should be copied if // necessary. SetFields(f Fields) }
Fielder is implemented by any value that can get and set its fields from a Fields map.
type Fields ¶ added in v0.2.0
Fields describes a set of names mapped to values, for the purpose of diffing and patching fields of an element. Entries may be set and deleted, but values must not be modified.
type Function ¶
type Function struct { Name string Parameters []Parameter ReturnType []Type Security string ThreadSafety string PreferredDescriptor PreferredDescriptor Tags }
Function is a Member that represents a class function.
func (*Function) MarshalJSON ¶ added in v0.10.1
func (*Function) MemberCopy ¶ added in v0.2.0
MemberCopy returns a deep copy of the member.
MemberType implements the Member interface.
func (*Function) MemberName ¶ added in v0.2.0
MemberName returns the name of the member.
MemberType implements the Member interface.
func (*Function) MemberType ¶ added in v0.2.0
MemberType returns a string indicating the the type of member.
MemberType implements the Member interface.
type Member ¶
type Member interface { Fielder Tagger // MemberType returns a string indicating the type of member. MemberType() string // MemberName returns the name of the member. MemberName() string // MemberCopy returns a deep copy of the member. MemberCopy() Member // contains filtered or unexported methods }
Member represents a member of a Class.
type Parameter ¶
Parameter represents a parameter of a function, event, or callback member.
func CopyParams ¶ added in v0.2.0
CopyParams returns a copy of the given parameters.
type PreferredDescriptor ¶ added in v0.7.0
type PreferredDescriptor struct { // The name of the alternative descriptor. Name string ThreadSafety string }
PreferredDescriptor refers to an alternative of a deprecated descriptor.
type Property ¶
type Property struct { Name string ValueType Type Default string Category string ReadSecurity string WriteSecurity string CanLoad bool CanSave bool ThreadSafety string PreferredDescriptor PreferredDescriptor Tags }
Property is a Member that represents a class property.
func (*Property) MarshalJSON ¶ added in v0.10.1
func (*Property) MemberCopy ¶ added in v0.2.0
MemberCopy returns a deep copy of the member.
MemberType implements the Member interface.
func (*Property) MemberName ¶ added in v0.2.0
MemberName returns the name of the member.
MemberType implements the Member interface.
func (*Property) MemberType ¶ added in v0.2.0
MemberType returns a string indicating the the type of member.
MemberType implements the Member interface.
type Root ¶
Root represents the top-level structure of an API dump.
func (*Root) GetClasses ¶
GetClasses returns the Classes in the root as a slice, ordered by name.
type Tagger ¶ added in v0.2.0
type Tagger interface { // GetTag returns whether the given tag is present. GetTag(tag string) bool // GetTags returns a list of all present tags. Implementations must not // retain the result. GetTags() []string // SetTag adds one or more tags. Duplicate tags are removed. SetTag(tag ...string) // UnsetTag removes one or more tags. Duplicate tags are removed. UnsetTag(tag ...string) }
Tagger is implemented by any value that contains a set of tags.
type Tags ¶ added in v0.2.0
type Tags []string
Tags implements a Tagger, to be embedded by taggable elements.
Directories ¶
Path | Synopsis |
---|---|
The diff package provides operations for diffing and patching rbxdump structures.
|
The diff package provides operations for diffing and patching rbxdump structures. |
The json package is used to serialize between rbxdump and Roblox JSON API dump format.
|
The json package is used to serialize between rbxdump and Roblox JSON API dump format. |
The legacy package is used to serialize between rbxdump and Roblox legacy API dump format.
|
The legacy package is used to serialize between rbxdump and Roblox legacy API dump format. |