README
¶
Documentation
¶
Overview ¶
The rbxdump package is used to represent Roblox Lua API dumps.
Index ¶
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
Tags
}
Callback is a Member that represents a class callback.
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
Tags
}
Class represents a class defined in an API dump.
func (*Class) Fields ¶ added in v0.2.0
Fields implements the Fielder interface. Does not return the Members field.
func (*Class) GetMembers ¶
GetMembers returns a list of members belonging to the class, sorted by name.
type Enum ¶
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.
Tags
}
EnumItem represents an enum item.
type Event ¶
Event is a Member that represents a class event.
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 returns the set of fields present in the value. Values may be
// retained by the implementation.
Fields() Fields
// SetFields sets the fields of the value. Values must not be retained; they
// should be copied if necessary. Invalid fields are ignored.
SetFields(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
type Fields map[string]interface{}
Fields describes a set of names mapped to values.
func (*Fields) UnmarshalJSON ¶ added in v0.3.2
type Function ¶
type Function struct {
Name string
Parameters []Parameter
ReturnType Type
Security string
ThreadSafety string
Tags
}
Function is a Member that represents a class function.
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 Property ¶
type Property struct {
Name string
ValueType Type
Category string
ReadSecurity string
WriteSecurity string
CanLoad bool
CanSave bool
ThreadSafety string
Tags
}
Property is a Member that represents a class property.
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.
Source Files
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 histlog package is used to parse logs involving the deployment of Roblox builds.
|
The histlog package is used to parse logs involving the deployment of Roblox builds. |
|
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. |