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: 5

Documentation

Overview

Package types implements all the types used by the Ranking protocol

Package types implements all the types used by the Ranking protocol

Package types implements all the types used by the Ranking protocol

Package types implements all the types used by the Ranking protocol

Package types implements all the types used by the Ranking protocol

Package types implements all the types used by the Ranking protocol

Package types implements all the types used by the Ranking protocol

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type RankingCachedResult added in v1.0.46

type RankingCachedResult struct {
	nex.Structure
	*RankingResult
	CreatedTime *nex.DateTime
	ExpiredTime *nex.DateTime
	MaxLength   uint8
}

RankingCachedResult holds the result of a Ranking get request

func NewRankingCachedResult added in v1.0.46

func NewRankingCachedResult() *RankingCachedResult

NewRankingCachedResult returns a new RankingCachedResult

func (*RankingCachedResult) Bytes added in v1.0.46

func (rankingCachedResult *RankingCachedResult) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the RankingCachedResult and returns a byte array

func (*RankingCachedResult) Copy added in v1.0.46

func (rankingCachedResult *RankingCachedResult) Copy() nex.StructureInterface

Copy returns a new copied instance of RankingCachedResult

func (*RankingCachedResult) Equals added in v1.0.46

func (rankingCachedResult *RankingCachedResult) Equals(structure nex.StructureInterface) bool

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

func (*RankingCachedResult) ExtractFromStream added in v1.0.46

func (rankingCachedResult *RankingCachedResult) ExtractFromStream(stream *nex.StreamIn) error

ExtractFromStream extracts a RankingCachedResult structure from a stream

func (*RankingCachedResult) FormatToString added in v1.0.46

func (rankingCachedResult *RankingCachedResult) FormatToString(indentationLevel int) string

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

func (*RankingCachedResult) String added in v1.0.46

func (rankingCachedResult *RankingCachedResult) String() string

String returns a string representation of the struct

type RankingChangeAttributesParam added in v1.0.46

type RankingChangeAttributesParam struct {
	nex.Structure
	ModificationFlag uint8
	Groups           []uint8
	Param            uint64
}

RankingChangeAttributesParam holds parameters for ordering rankings

func NewRankingChangeAttributesParam added in v1.0.46

func NewRankingChangeAttributesParam() *RankingChangeAttributesParam

NewRankingChangeAttributesParam returns a new RankingChangeAttributesParam

func (*RankingChangeAttributesParam) Bytes added in v1.0.46

func (rankingChangeAttributesParam *RankingChangeAttributesParam) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the RankingChangeAttributesParam and returns a byte array

func (*RankingChangeAttributesParam) Copy added in v1.0.46

func (rankingChangeAttributesParam *RankingChangeAttributesParam) Copy() nex.StructureInterface

Copy returns a new copied instance of RankingChangeAttributesParam

func (*RankingChangeAttributesParam) Equals added in v1.0.46

func (rankingChangeAttributesParam *RankingChangeAttributesParam) Equals(structure nex.StructureInterface) bool

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

func (*RankingChangeAttributesParam) ExtractFromStream added in v1.0.46

func (rankingChangeAttributesParam *RankingChangeAttributesParam) ExtractFromStream(stream *nex.StreamIn) error

ExtractFromStream extracts a RankingChangeAttributesParam structure from a stream

func (*RankingChangeAttributesParam) FormatToString added in v1.0.46

func (rankingChangeAttributesParam *RankingChangeAttributesParam) FormatToString(indentationLevel int) string

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

func (*RankingChangeAttributesParam) String added in v1.0.46

func (rankingChangeAttributesParam *RankingChangeAttributesParam) String() string

String returns a string representation of the struct

type RankingOrderParam

type RankingOrderParam struct {
	nex.Structure
	OrderCalculation uint8
	GroupIndex       uint8
	GroupNum         uint8
	TimeScope        uint8
	Offset           uint32
	Length           uint8
}

RankingOrderParam holds parameters for ordering rankings

func NewRankingOrderParam

func NewRankingOrderParam() *RankingOrderParam

NewRankingOrderParam returns a new RankingOrderParam

func (*RankingOrderParam) Bytes

func (rankingOrderParam *RankingOrderParam) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the RankingOrderParam and returns a byte array

func (*RankingOrderParam) Copy

func (rankingOrderParam *RankingOrderParam) Copy() nex.StructureInterface

Copy returns a new copied instance of RankingOrderParam

func (*RankingOrderParam) Equals

func (rankingOrderParam *RankingOrderParam) Equals(structure nex.StructureInterface) bool

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

func (*RankingOrderParam) ExtractFromStream

func (rankingOrderParam *RankingOrderParam) ExtractFromStream(stream *nex.StreamIn) error

ExtractFromStream extracts a RankingOrderParam structure from a stream

func (*RankingOrderParam) FormatToString

func (rankingOrderParam *RankingOrderParam) FormatToString(indentationLevel int) string

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

func (*RankingOrderParam) String

func (rankingOrderParam *RankingOrderParam) String() string

String returns a string representation of the struct

type RankingRankData

type RankingRankData struct {
	nex.Structure
	PrincipalID uint32
	UniqueID    uint64
	Order       uint32
	Category    uint32
	Score       uint32
	Groups      []byte
	Param       uint64
	CommonData  []byte
	UpdateTime  *nex.DateTime // * NEX 3.6.0+
}

RankingRankData holds parameters for ordering rankings

func NewRankingRankData

func NewRankingRankData() *RankingRankData

NewRankingRankData returns a new RankingRankData

func (*RankingRankData) Bytes

func (rankingRankData *RankingRankData) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the RankingRankData and returns a byte array

func (*RankingRankData) Copy

func (rankingRankData *RankingRankData) Copy() nex.StructureInterface

Copy returns a new copied instance of RankingRankData

func (*RankingRankData) Equals

func (rankingRankData *RankingRankData) Equals(structure nex.StructureInterface) bool

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

func (*RankingRankData) ExtractFromStream

func (rankingRankData *RankingRankData) ExtractFromStream(stream *nex.StreamIn) error

ExtractFromStream extracts a RankingRankData structure from a stream

func (*RankingRankData) FormatToString

func (rankingRankData *RankingRankData) FormatToString(indentationLevel int) string

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

func (*RankingRankData) String

func (rankingRankData *RankingRankData) String() string

String returns a string representation of the struct

type RankingResult

type RankingResult struct {
	nex.Structure
	RankDataList []*RankingRankData
	TotalCount   uint32
	SinceTime    *nex.DateTime
}

RankingResult holds the result of a Ranking get request

func NewRankingResult

func NewRankingResult() *RankingResult

NewRankingResult returns a new RankingResult

func (*RankingResult) Bytes

func (rankingResult *RankingResult) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the RankingResult and returns a byte array

func (*RankingResult) Copy

func (rankingResult *RankingResult) Copy() nex.StructureInterface

Copy returns a new copied instance of RankingResult

func (*RankingResult) Equals

func (rankingResult *RankingResult) Equals(structure nex.StructureInterface) bool

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

func (*RankingResult) ExtractFromStream

func (rankingResult *RankingResult) ExtractFromStream(stream *nex.StreamIn) error

ExtractFromStream extracts a RankingResult structure from a stream

func (*RankingResult) FormatToString

func (rankingResult *RankingResult) FormatToString(indentationLevel int) string

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

func (*RankingResult) String

func (rankingResult *RankingResult) String() string

String returns a string representation of the struct

type RankingScoreData

type RankingScoreData struct {
	nex.Structure
	Category   uint32
	Score      uint32
	OrderBy    uint8
	UpdateMode uint8
	Groups     []byte
	Param      uint64
}

RankingScoreData holds general purpose notification data

func NewRankingScoreData

func NewRankingScoreData() *RankingScoreData

NewRankingScoreData returns a new RankingScoreData

func (*RankingScoreData) Bytes

func (rankingScoreData *RankingScoreData) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the RankingScoreData and returns a byte array

func (*RankingScoreData) Copy

func (rankingScoreData *RankingScoreData) Copy() nex.StructureInterface

Copy returns a new copied instance of RankingScoreData

func (*RankingScoreData) Equals

func (rankingScoreData *RankingScoreData) Equals(structure nex.StructureInterface) bool

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

func (*RankingScoreData) ExtractFromStream

func (rankingScoreData *RankingScoreData) ExtractFromStream(stream *nex.StreamIn) error

ExtractFromStream extracts a RankingScoreData structure from a stream

func (*RankingScoreData) FormatToString

func (rankingScoreData *RankingScoreData) FormatToString(indentationLevel int) string

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

func (*RankingScoreData) String

func (rankingScoreData *RankingScoreData) String() string

String returns a string representation of the struct

type RankingStats added in v1.0.46

type RankingStats struct {
	nex.Structure
	StatsList []float64
}

RankingStats holds parameters for ordering rankings

func NewRankingStats added in v1.0.46

func NewRankingStats() *RankingStats

NewRankingStats returns a new RankingStats

func (*RankingStats) Bytes added in v1.0.46

func (rankingStats *RankingStats) Bytes(stream *nex.StreamOut) []byte

Bytes encodes the RankingStats and returns a byte array

func (*RankingStats) Copy added in v1.0.46

func (rankingStats *RankingStats) Copy() nex.StructureInterface

Copy returns a new copied instance of RankingStats

func (*RankingStats) Equals added in v1.0.46

func (rankingStats *RankingStats) Equals(structure nex.StructureInterface) bool

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

func (*RankingStats) ExtractFromStream added in v1.0.46

func (rankingStats *RankingStats) ExtractFromStream(stream *nex.StreamIn) error

ExtractFromStream extracts a RankingStats structure from a stream

func (*RankingStats) FormatToString added in v1.0.46

func (rankingStats *RankingStats) FormatToString(indentationLevel int) string

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

func (*RankingStats) String added in v1.0.46

func (rankingStats *RankingStats) String() string

String returns a string representation of the struct

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL