types

package
v1.0.58 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 1, 2023 License: AGPL-3.0 Imports: 4 Imported by: 4

Documentation

Overview

Package types implements all the types used by the Friends 3DS protocol

Package types implements all the types used by the Friends 3DS protocol

Package types implements all the types used by the Friends 3DS protocol

Package types implements all the types used by the Friends 3DS protocol

Package types implements all the types used by the Friends 3DS protocol

Package types implements all the types used by the Friends 3DS protocol

Package types implements all the types used by the Friends 3DS protocol

Package types implements all the types used by the Friends 3DS protocol

Package types implements all the types used by the Friends 3DS protocol

Package types implements all the types used by the Friends 3DS protocol

Package types implements all the types used by the Friends 3DS protocol

Package types implements all the types used by the Friends 3DS protocol

Package types implements all the types used by the Friends 3DS protocol

Package types implements all the types used by the Friends 3DS protocol

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type FriendComment added in v1.0.43 

type FriendComment struct {
	nex.Structure
	*nex.Data
	PID        uint32
	Comment    string
	ModifiedAt *nex.DateTime
}

FriendComment is a data structure used by the Friends 3DS protocol to hold information about a friends Mii

func NewFriendComment added in v1.0.43 

func NewFriendComment() *FriendComment

NewFriendComment returns a new FriendComment

func (*FriendComment) Bytes added in v1.0.43 

func (friendComment *FriendComment) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the FriendComment and returns a byte array

func (*FriendComment) Copy added in v1.0.43 

func (friendComment *FriendComment) Copy() nex.StructureInterface

Copy returns a new copied instance of FriendComment

func (*FriendComment) Equals added in v1.0.43 

func (friendComment *FriendComment) Equals(structure nex.StructureInterface) bool

Equals checks if the passed Structure contains the same data as the current instance

func (*FriendComment) FormatToString added in v1.0.43 

func (friendComment *FriendComment) FormatToString(indentationLevel int) string

FormatToString pretty-prints the struct data using the provided indentation level

func (*FriendComment) String added in v1.0.43 

func (friendComment *FriendComment) String() string

String returns a string representation of the struct

type FriendInfo added in v1.0.43 

type FriendInfo struct {
	nex.Structure
	PID     uint32
	Unknown *nex.DateTime
}

FriendInfo is a data structure used by the Friends 3DS protocol to hold information about a friends Mii

func NewFriendInfo added in v1.0.43 

func NewFriendInfo() *FriendInfo

NewFriendInfo returns a new FriendInfo

func (*FriendInfo) Bytes added in v1.0.43 

func (friendInfo *FriendInfo) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the FriendInfo and returns a byte array

func (*FriendInfo) Copy added in v1.0.43 

func (friendInfo *FriendInfo) Copy() nex.StructureInterface

Copy returns a new copied instance of FriendInfo

func (*FriendInfo) Equals added in v1.0.43 

func (friendInfo *FriendInfo) Equals(structure nex.StructureInterface) bool

Equals checks if the passed Structure contains the same data as the current instance

func (*FriendInfo) FormatToString added in v1.0.43 

func (friendInfo *FriendInfo) FormatToString(indentationLevel int) string

FormatToString pretty-prints the struct data using the provided indentation level

func (*FriendInfo) String added in v1.0.43 

func (friendInfo *FriendInfo) String() string

String returns a string representation of the struct

type FriendMii 

type FriendMii struct {
	nex.Structure
	*nex.Data
	PID        uint32
	Mii        *Mii
	ModifiedAt *nex.DateTime
}

FriendMii is a data structure used by the Friends 3DS protocol to hold information about a friends Mii

func NewFriendMii 

func NewFriendMii() *FriendMii

NewFriendMii returns a new FriendMii

func (*FriendMii) Bytes 

func (friendMii *FriendMii) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the Mii and returns a byte array

func (*FriendMii) Copy 

func (friendMii *FriendMii) Copy() nex.StructureInterface

Copy returns a new copied instance of FriendMii

func (*FriendMii) Equals 

func (friendMii *FriendMii) Equals(structure nex.StructureInterface) bool

Equals checks if the passed Structure contains the same data as the current instance

func (*FriendMii) FormatToString 

func (friendMii *FriendMii) FormatToString(indentationLevel int) string

FormatToString pretty-prints the struct data using the provided indentation level

func (*FriendMii) String 

func (friendMii *FriendMii) String() string

String returns a string representation of the struct

type FriendMiiList added in v1.0.43 

type FriendMiiList struct {
	nex.Structure
	*nex.Data
	Unknown1 uint32
	MiiList  *MiiList
	Unknown2 *nex.DateTime
}

FriendMiiList is a data structure used by the Friends 3DS protocol to hold information about a friends Mii

func NewFriendMiiList added in v1.0.43 

func NewFriendMiiList() *FriendMiiList

NewFriendMiiList returns a new FriendMiiList

func (*FriendMiiList) Bytes added in v1.0.43 

func (friendMiiList *FriendMiiList) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the Mii and returns a byte array

func (*FriendMiiList) Copy added in v1.0.43 

func (friendMiiList *FriendMiiList) Copy() nex.StructureInterface

Copy returns a new copied instance of FriendMiiList

func (*FriendMiiList) Equals added in v1.0.43 

func (friendMiiList *FriendMiiList) Equals(structure nex.StructureInterface) bool

Equals checks if the passed Structure contains the same data as the current instance

func (*FriendMiiList) FormatToString added in v1.0.43 

func (friendMiiList *FriendMiiList) FormatToString(indentationLevel int) string

FormatToString pretty-prints the struct data using the provided indentation level

func (*FriendMiiList) String added in v1.0.43 

func (friendMiiList *FriendMiiList) String() string

String returns a string representation of the struct

type FriendPersistentInfo 

type FriendPersistentInfo struct {
	nex.Structure
	*nex.Data
	PID              uint32
	Region           uint8
	Country          uint8
	Area             uint8
	Language         uint8
	Platform         uint8
	GameKey          *GameKey
	Message          string
	MessageUpdatedAt *nex.DateTime
	MiiModifiedAt    *nex.DateTime
	LastOnline       *nex.DateTime
}

FriendPersistentInfo contains user settings

func NewFriendPersistentInfo 

func NewFriendPersistentInfo() *FriendPersistentInfo

NewFriendPersistentInfo returns a new FriendPersistentInfo

func (*FriendPersistentInfo) Bytes 

func (friendPersistentInfo *FriendPersistentInfo) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the FriendPersistentInfo and returns a byte array

func (*FriendPersistentInfo) Copy 

func (friendPersistentInfo *FriendPersistentInfo) Copy() nex.StructureInterface

Copy returns a new copied instance of FriendPersistentInfo

func (*FriendPersistentInfo) Equals 

func (friendPersistentInfo *FriendPersistentInfo) Equals(structure nex.StructureInterface) bool

Equals checks if the passed Structure contains the same data as the current instance

func (*FriendPersistentInfo) FormatToString 

func (friendPersistentInfo *FriendPersistentInfo) FormatToString(indentationLevel int) string

FormatToString pretty-prints the struct data using the provided indentation level

func (*FriendPersistentInfo) String 

func (friendPersistentInfo *FriendPersistentInfo) String() string

String returns a string representation of the struct

type FriendPicture added in v1.0.43 

type FriendPicture struct {
	nex.Structure
	*nex.Data
	Unknown1    uint32
	PictureData []byte
	Unknown2    *nex.DateTime
}

FriendPicture is a data structure used by the Friends 3DS protocol to hold information about a friends PictureData

func NewFriendPicture added in v1.0.43 

func NewFriendPicture() *FriendPicture

NewFriendPicture returns a new FriendPicture

func (*FriendPicture) Bytes added in v1.0.43 

func (friendPicture *FriendPicture) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the FriendPicture and returns a byte array

func (*FriendPicture) Copy added in v1.0.43 

func (friendPicture *FriendPicture) Copy() nex.StructureInterface

Copy returns a new copied instance of FriendPicture

func (*FriendPicture) Equals added in v1.0.43 

func (friendPicture *FriendPicture) Equals(structure nex.StructureInterface) bool

Equals checks if the passed Structure contains the same data as the current instance

func (*FriendPicture) FormatToString added in v1.0.43 

func (friendPicture *FriendPicture) FormatToString(indentationLevel int) string

FormatToString pretty-prints the struct data using the provided indentation level

func (*FriendPicture) String added in v1.0.43 

func (friendPicture *FriendPicture) String() string

String returns a string representation of the struct

type FriendPresence 

type FriendPresence struct {
	nex.Structure
	*nex.Data
	PID      uint32
	Presence *NintendoPresence
}

FriendPresence contains information about a users online presence

func NewFriendPresence 

func NewFriendPresence() *FriendPresence

NewFriendPresence returns a new FriendPresence

func (*FriendPresence) Bytes 

func (presence *FriendPresence) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the FriendPresence and returns a byte array

func (*FriendPresence) Copy 

func (presence *FriendPresence) Copy() nex.StructureInterface

Copy returns a new copied instance of FriendPresence

func (*FriendPresence) Equals 

func (presence *FriendPresence) Equals(structure nex.StructureInterface) bool

Equals checks if the passed Structure contains the same data as the current instance

func (*FriendPresence) FormatToString 

func (presence *FriendPresence) FormatToString(indentationLevel int) string

FormatToString pretty-prints the struct data using the provided indentation level

func (*FriendPresence) String 

func (presence *FriendPresence) String() string

String returns a string representation of the struct

type FriendRelationship 

type FriendRelationship struct {
	nex.Structure
	*nex.Data
	PID              uint32
	LFC              uint64
	RelationshipType uint8
}

FriendRelationship contains information about a users relationship with another PID

func NewFriendRelationship 

func NewFriendRelationship() *FriendRelationship

NewFriendRelationship returns a new FriendRelationship

func (*FriendRelationship) Bytes 

func (relationship *FriendRelationship) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the FriendRelationship and returns a byte array

func (*FriendRelationship) Copy 

func (relationship *FriendRelationship) Copy() nex.StructureInterface

Copy returns a new copied instance of FriendRelationship

func (*FriendRelationship) Equals 

func (relationship *FriendRelationship) Equals(structure nex.StructureInterface) bool

Equals checks if the passed Structure contains the same data as the current instance

func (*FriendRelationship) FormatToString 

func (relationship *FriendRelationship) FormatToString(indentationLevel int) string

FormatToString pretty-prints the struct data using the provided indentation level

func (*FriendRelationship) String 

func (relationship *FriendRelationship) String() string

String returns a string representation of the struct

type GameKey 

type GameKey struct {
	nex.Structure
	*nex.Data
	TitleID      uint64
	TitleVersion uint16
}

GameKey contains the title ID and version for a title

func NewGameKey 

func NewGameKey() *GameKey

NewGameKey returns a new GameKey

func (*GameKey) Bytes 

func (gameKey *GameKey) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the GameKey and returns a byte array

func (*GameKey) Copy 

func (gameKey *GameKey) Copy() nex.StructureInterface

Copy returns a new copied instance of GameKey

func (*GameKey) Equals 

func (gameKey *GameKey) Equals(structure nex.StructureInterface) bool

Equals checks if the passed Structure contains the same data as the current instance

func (*GameKey) ExtractFromStream 

func (gameKey *GameKey) ExtractFromStream(stream *nex.StreamIn) error

ExtractFromStream extracts a GameKey structure from a stream

func (*GameKey) FormatToString 

func (gameKey *GameKey) FormatToString(indentationLevel int) string

FormatToString pretty-prints the struct data using the provided indentation level

func (*GameKey) String 

func (gameKey *GameKey) String() string

String returns a string representation of the struct

type Mii 

type Mii struct {
	nex.Structure
	*nex.Data
	Name     string
	Unknown2 bool
	Unknown3 uint8
	MiiData  []byte
}

Mii is a data structure used by the Friends 3DS protocol to hold information about a Mii

func NewMii 

func NewMii() *Mii

NewMii returns a new Mii

func (*Mii) Bytes 

func (mii *Mii) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the Mii and returns a byte array

func (*Mii) Copy 

func (mii *Mii) Copy() nex.StructureInterface

Copy returns a new copied instance of Mii

func (*Mii) Equals 

func (mii *Mii) Equals(structure nex.StructureInterface) bool

Equals checks if the passed Structure contains the same data as the current instance

func (*Mii) ExtractFromStream 

func (mii *Mii) ExtractFromStream(stream *nex.StreamIn) error

ExtractFromStream extracts a Mii from a stream

func (*Mii) FormatToString 

func (mii *Mii) FormatToString(indentationLevel int) string

FormatToString pretty-prints the struct data using the provided indentation level

func (*Mii) String 

func (mii *Mii) String() string

String returns a string representation of the struct

type MiiList added in v1.0.43 

type MiiList struct {
	nex.Structure
	*nex.Data
	Unknown1    string
	Unknown2    bool
	Unknown3    uint8
	MiiDataList [][]byte
}

MiiList is a data structure used by the Friends 3DS protocol to hold information about a MiiList

func NewMiiList added in v1.0.43 

func NewMiiList() *MiiList

NewMiiList returns a new MiiList

func (*MiiList) Bytes added in v1.0.43 

func (miiList *MiiList) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the MiiList and returns a byte array

func (*MiiList) Copy added in v1.0.43 

func (miiList *MiiList) Copy() nex.StructureInterface

Copy returns a new copied instance of MiiList

func (*MiiList) Equals added in v1.0.43 

func (miiList *MiiList) Equals(structure nex.StructureInterface) bool

Equals checks if the passed Structure contains the same data as the current instance

func (*MiiList) ExtractFromStream added in v1.0.43 

func (miiList *MiiList) ExtractFromStream(stream *nex.StreamIn) error

ExtractFromStream extracts a MiiList from a stream

func (*MiiList) FormatToString added in v1.0.43 

func (miiList *MiiList) FormatToString(indentationLevel int) string

FormatToString pretty-prints the struct data using the provided indentation level

func (*MiiList) String added in v1.0.43 

func (miiList *MiiList) String() string

String returns a string representation of the struct

type MyProfile 

type MyProfile struct {
	nex.Structure
	*nex.Data
	Region   uint8
	Country  uint8
	Area     uint8
	Language uint8
	Platform uint8
	Unknown1 uint64
	Unknown2 string
	Unknown3 string
}

MyProfile is a data structure used by the Friends 3DS protocol to hold user profile information

func NewMyProfile 

func NewMyProfile() *MyProfile

NewMyProfile returns a new MyProfile

func (*MyProfile) Copy 

func (myProfile *MyProfile) Copy() nex.StructureInterface

Copy returns a new copied instance of MyProfile

func (*MyProfile) Equals 

func (myProfile *MyProfile) Equals(structure nex.StructureInterface) bool

Equals checks if the passed Structure contains the same data as the current instance

func (*MyProfile) ExtractFromStream 

func (myProfile *MyProfile) ExtractFromStream(stream *nex.StreamIn) error

ExtractFromStream extracts a MyProfile from a stream

func (*MyProfile) FormatToString 

func (myProfile *MyProfile) FormatToString(indentationLevel int) string

FormatToString pretty-prints the struct data using the provided indentation level

func (*MyProfile) String 

func (myProfile *MyProfile) String() string

String returns a string representation of the struct

type NintendoPresence 

type NintendoPresence struct {
	nex.Structure
	*nex.Data
	ChangedFlags      uint32
	GameKey           *GameKey
	Message           string
	JoinAvailableFlag uint32
	MatchmakeType     uint8
	JoinGameID        uint32
	JoinGameMode      uint32
	OwnerPID          uint32
	JoinGroupID       uint32
	ApplicationArg    []byte
}

NintendoPresence contains information about a users online presence

func NewNintendoPresence 

func NewNintendoPresence() *NintendoPresence

NewNintendoPresence returns a new NintendoPresence

func (*NintendoPresence) Bytes 

func (presence *NintendoPresence) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the NintendoPresence and returns a byte array

func (*NintendoPresence) Copy 

func (presence *NintendoPresence) Copy() nex.StructureInterface

Copy returns a new copied instance of NintendoPresence

func (*NintendoPresence) Equals 

func (presence *NintendoPresence) Equals(structure nex.StructureInterface) bool

Equals checks if the passed Structure contains the same data as the current instance

func (*NintendoPresence) ExtractFromStream 

func (presence *NintendoPresence) ExtractFromStream(stream *nex.StreamIn) error

ExtractFromStream extracts a NintendoPresence structure from a stream

func (*NintendoPresence) FormatToString 

func (presence *NintendoPresence) FormatToString(indentationLevel int) string

FormatToString pretty-prints the struct data using the provided indentation level

func (*NintendoPresence) String 

func (presence *NintendoPresence) String() string

String returns a string representation of the struct

type PlayedGame added in v1.0.43 

type PlayedGame struct {
	nex.Structure
	GameKey *GameKey
	Unknown *nex.DateTime
}

PlayedGame is a data structure used by the Friends 3DS protocol to hold information about a friends Mii

func NewPlayedGame added in v1.0.43 

func NewPlayedGame() *PlayedGame

NewPlayedGame returns a new PlayedGame

func (*PlayedGame) Bytes added in v1.0.43 

func (playedGame *PlayedGame) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the PlayedGame and returns a byte array

func (*PlayedGame) Copy added in v1.0.43 

func (playedGame *PlayedGame) Copy() nex.StructureInterface

Copy returns a new copied instance of PlayedGame

func (*PlayedGame) Equals added in v1.0.43 

func (playedGame *PlayedGame) Equals(structure nex.StructureInterface) bool

Equals checks if the passed Structure contains the same data as the current instance

func (*PlayedGame) FormatToString added in v1.0.43 

func (playedGame *PlayedGame) FormatToString(indentationLevel int) string

FormatToString pretty-prints the struct data using the provided indentation level

func (*PlayedGame) String added in v1.0.43 

func (playedGame *PlayedGame) String() string

String returns a string representation of the struct

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.