types

package
v2.2.1 Latest Latest
Warning

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

 Go to latest Published: Feb 16, 2025 License: AGPL-3.0 Imports: 4 Imported by: 5

Documentation

Overview

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Package types implements all the types used by the Matchmaking protocol

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AutoMatchmakeParam 

type AutoMatchmakeParam struct {
	types.Structure
	SourceMatchmakeSession   MatchmakeSession
	AdditionalParticipants   types.List[types.PID]
	GIDForParticipationCheck types.UInt32
	AutoMatchmakeOption      types.UInt32
	JoinMessage              types.String
	ParticipationCount       types.UInt16
	LstSearchCriteria        types.List[MatchmakeSessionSearchCriteria]
	TargetGIDs               types.List[types.UInt32]
}

AutoMatchmakeParam is a type within the Matchmaking protocol

func NewAutoMatchmakeParam 

func NewAutoMatchmakeParam() AutoMatchmakeParam

NewAutoMatchmakeParam returns a new AutoMatchmakeParam

func (AutoMatchmakeParam) Copy 

func (amp AutoMatchmakeParam) Copy() types.RVType

Copy returns a new copied instance of AutoMatchmakeParam

func (AutoMatchmakeParam) CopyRef added in v2.1.0 

func (amp AutoMatchmakeParam) CopyRef() types.RVTypePtr

CopyRef copies the current value of the AutoMatchmakeParam and returns a pointer to the new copy

func (*AutoMatchmakeParam) Deref added in v2.1.0 

func (amp *AutoMatchmakeParam) Deref() types.RVType

Deref takes a pointer to the AutoMatchmakeParam and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (AutoMatchmakeParam) Equals 

func (amp AutoMatchmakeParam) Equals(o types.RVType) bool

Equals checks if the given AutoMatchmakeParam contains the same data as the current AutoMatchmakeParam

func (*AutoMatchmakeParam) ExtractFrom 

func (amp *AutoMatchmakeParam) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the AutoMatchmakeParam from the given readable

func (AutoMatchmakeParam) FormatToString 

func (amp AutoMatchmakeParam) FormatToString(indentationLevel int) string

FormatToString pretty-prints the AutoMatchmakeParam using the provided indentation level

func (AutoMatchmakeParam) String 

func (amp AutoMatchmakeParam) String() string

String returns the string representation of the AutoMatchmakeParam

func (AutoMatchmakeParam) WriteTo 

func (amp AutoMatchmakeParam) WriteTo(writable types.Writable)

WriteTo writes the AutoMatchmakeParam to the given writable

type CreateMatchmakeSessionParam 

type CreateMatchmakeSessionParam struct {
	types.Structure
	SourceMatchmakeSession       MatchmakeSession
	AdditionalParticipants       types.List[types.PID]
	GIDForParticipationCheck     types.UInt32
	CreateMatchmakeSessionOption types.UInt32
	JoinMessage                  types.String
	ParticipationCount           types.UInt16
}

CreateMatchmakeSessionParam is a type within the Matchmaking protocol

func NewCreateMatchmakeSessionParam 

func NewCreateMatchmakeSessionParam() CreateMatchmakeSessionParam

NewCreateMatchmakeSessionParam returns a new CreateMatchmakeSessionParam

func (CreateMatchmakeSessionParam) Copy 

func (cmsp CreateMatchmakeSessionParam) Copy() types.RVType

Copy returns a new copied instance of CreateMatchmakeSessionParam

func (CreateMatchmakeSessionParam) CopyRef added in v2.1.0 

func (cmsp CreateMatchmakeSessionParam) CopyRef() types.RVTypePtr

CopyRef copies the current value of the CreateMatchmakeSessionParam and returns a pointer to the new copy

func (*CreateMatchmakeSessionParam) Deref added in v2.1.0 

func (cmsp *CreateMatchmakeSessionParam) Deref() types.RVType

Deref takes a pointer to the CreateMatchmakeSessionParam and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (CreateMatchmakeSessionParam) Equals 

func (cmsp CreateMatchmakeSessionParam) Equals(o types.RVType) bool

Equals checks if the given CreateMatchmakeSessionParam contains the same data as the current CreateMatchmakeSessionParam

func (*CreateMatchmakeSessionParam) ExtractFrom 

func (cmsp *CreateMatchmakeSessionParam) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the CreateMatchmakeSessionParam from the given readable

func (CreateMatchmakeSessionParam) FormatToString 

func (cmsp CreateMatchmakeSessionParam) FormatToString(indentationLevel int) string

FormatToString pretty-prints the CreateMatchmakeSessionParam using the provided indentation level

func (CreateMatchmakeSessionParam) String 

func (cmsp CreateMatchmakeSessionParam) String() string

String returns the string representation of the CreateMatchmakeSessionParam

func (CreateMatchmakeSessionParam) WriteTo 

func (cmsp CreateMatchmakeSessionParam) WriteTo(writable types.Writable)

WriteTo writes the CreateMatchmakeSessionParam to the given writable

type DeletionEntry 

type DeletionEntry struct {
	types.Structure
	IDGathering types.UInt32
	PID         types.PID
	UIReason    types.UInt32
}

DeletionEntry is a type within the Matchmaking protocol

func NewDeletionEntry 

func NewDeletionEntry() DeletionEntry

NewDeletionEntry returns a new DeletionEntry

func (DeletionEntry) Copy 

func (de DeletionEntry) Copy() types.RVType

Copy returns a new copied instance of DeletionEntry

func (DeletionEntry) CopyRef added in v2.1.0 

func (de DeletionEntry) CopyRef() types.RVTypePtr

CopyRef copies the current value of the DeletionEntry and returns a pointer to the new copy

func (*DeletionEntry) Deref added in v2.1.0 

func (de *DeletionEntry) Deref() types.RVType

Deref takes a pointer to the DeletionEntry and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (DeletionEntry) Equals 

func (de DeletionEntry) Equals(o types.RVType) bool

Equals checks if the given DeletionEntry contains the same data as the current DeletionEntry

func (*DeletionEntry) ExtractFrom 

func (de *DeletionEntry) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the DeletionEntry from the given readable

func (DeletionEntry) FormatToString 

func (de DeletionEntry) FormatToString(indentationLevel int) string

FormatToString pretty-prints the DeletionEntry using the provided indentation level

func (DeletionEntry) String 

func (de DeletionEntry) String() string

String returns the string representation of the DeletionEntry

func (DeletionEntry) WriteTo 

func (de DeletionEntry) WriteTo(writable types.Writable)

WriteTo writes the DeletionEntry to the given writable

type FindMatchmakeSessionByParticipantParam 

type FindMatchmakeSessionByParticipantParam struct {
	types.Structure
	PrincipalIDList types.List[types.PID]
	ResultOptions   types.UInt32
	BlockListParam  MatchmakeBlockListParam
}

FindMatchmakeSessionByParticipantParam is a type within the Matchmaking protocol

func NewFindMatchmakeSessionByParticipantParam 

func NewFindMatchmakeSessionByParticipantParam() FindMatchmakeSessionByParticipantParam

NewFindMatchmakeSessionByParticipantParam returns a new FindMatchmakeSessionByParticipantParam

func (FindMatchmakeSessionByParticipantParam) Copy 

func (fmsbpp FindMatchmakeSessionByParticipantParam) Copy() types.RVType

Copy returns a new copied instance of FindMatchmakeSessionByParticipantParam

func (FindMatchmakeSessionByParticipantParam) CopyRef added in v2.1.0 

func (fmsbpp FindMatchmakeSessionByParticipantParam) CopyRef() types.RVTypePtr

CopyRef copies the current value of the FindMatchmakeSessionByParticipantParam and returns a pointer to the new copy

func (*FindMatchmakeSessionByParticipantParam) Deref added in v2.1.0 

func (fmsbpp *FindMatchmakeSessionByParticipantParam) Deref() types.RVType

Deref takes a pointer to the FindMatchmakeSessionByParticipantParam and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (FindMatchmakeSessionByParticipantParam) Equals 

func (fmsbpp FindMatchmakeSessionByParticipantParam) Equals(o types.RVType) bool

Equals checks if the given FindMatchmakeSessionByParticipantParam contains the same data as the current FindMatchmakeSessionByParticipantParam

func (*FindMatchmakeSessionByParticipantParam) ExtractFrom 

func (fmsbpp *FindMatchmakeSessionByParticipantParam) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the FindMatchmakeSessionByParticipantParam from the given readable

func (FindMatchmakeSessionByParticipantParam) FormatToString 

func (fmsbpp FindMatchmakeSessionByParticipantParam) FormatToString(indentationLevel int) string

FormatToString pretty-prints the FindMatchmakeSessionByParticipantParam using the provided indentation level

func (FindMatchmakeSessionByParticipantParam) String 

func (fmsbpp FindMatchmakeSessionByParticipantParam) String() string

String returns the string representation of the FindMatchmakeSessionByParticipantParam

func (FindMatchmakeSessionByParticipantParam) WriteTo 

func (fmsbpp FindMatchmakeSessionByParticipantParam) WriteTo(writable types.Writable)

WriteTo writes the FindMatchmakeSessionByParticipantParam to the given writable

type FindMatchmakeSessionByParticipantResult 

type FindMatchmakeSessionByParticipantResult struct {
	types.Structure
	PrincipalID types.PID
	Session     MatchmakeSession
}

FindMatchmakeSessionByParticipantResult is a type within the Matchmaking protocol

func NewFindMatchmakeSessionByParticipantResult 

func NewFindMatchmakeSessionByParticipantResult() FindMatchmakeSessionByParticipantResult

NewFindMatchmakeSessionByParticipantResult returns a new FindMatchmakeSessionByParticipantResult

func (FindMatchmakeSessionByParticipantResult) Copy 

func (fmsbpr FindMatchmakeSessionByParticipantResult) Copy() types.RVType

Copy returns a new copied instance of FindMatchmakeSessionByParticipantResult

func (FindMatchmakeSessionByParticipantResult) CopyRef added in v2.1.0 

func (fmsbpr FindMatchmakeSessionByParticipantResult) CopyRef() types.RVTypePtr

CopyRef copies the current value of the FindMatchmakeSessionByParticipantResult and returns a pointer to the new copy

func (*FindMatchmakeSessionByParticipantResult) Deref added in v2.1.0 

func (fmsbpr *FindMatchmakeSessionByParticipantResult) Deref() types.RVType

Deref takes a pointer to the FindMatchmakeSessionByParticipantResult and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (FindMatchmakeSessionByParticipantResult) Equals 

func (fmsbpr FindMatchmakeSessionByParticipantResult) Equals(o types.RVType) bool

Equals checks if the given FindMatchmakeSessionByParticipantResult contains the same data as the current FindMatchmakeSessionByParticipantResult

func (*FindMatchmakeSessionByParticipantResult) ExtractFrom 

func (fmsbpr *FindMatchmakeSessionByParticipantResult) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the FindMatchmakeSessionByParticipantResult from the given readable

func (FindMatchmakeSessionByParticipantResult) FormatToString 

func (fmsbpr FindMatchmakeSessionByParticipantResult) FormatToString(indentationLevel int) string

FormatToString pretty-prints the FindMatchmakeSessionByParticipantResult using the provided indentation level

func (FindMatchmakeSessionByParticipantResult) String 

func (fmsbpr FindMatchmakeSessionByParticipantResult) String() string

String returns the string representation of the FindMatchmakeSessionByParticipantResult

func (FindMatchmakeSessionByParticipantResult) WriteTo 

func (fmsbpr FindMatchmakeSessionByParticipantResult) WriteTo(writable types.Writable)

WriteTo writes the FindMatchmakeSessionByParticipantResult to the given writable

type Gathering 

type Gathering struct {
	types.Structure
	ID                  types.UInt32
	OwnerPID            types.PID
	HostPID             types.PID
	MinimumParticipants types.UInt16
	MaximumParticipants types.UInt16
	ParticipationPolicy types.UInt32
	PolicyArgument      types.UInt32
	Flags               types.UInt32
	State               types.UInt32
	Description         types.String
}

Gathering is a type within the Matchmaking protocol

func NewGathering 

func NewGathering() Gathering

NewGathering returns a new Gathering

func (Gathering) Copy 

func (g Gathering) Copy() types.RVType

Copy returns a new copied instance of Gathering

func (Gathering) CopyRef added in v2.1.0 

func (g Gathering) CopyRef() types.RVTypePtr

CopyRef copies the current value of the Gathering and returns a pointer to the new copy

func (*Gathering) Deref added in v2.1.0 

func (g *Gathering) Deref() types.RVType

Deref takes a pointer to the Gathering and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (Gathering) Equals 

func (g Gathering) Equals(o types.RVType) bool

Equals checks if the given Gathering contains the same data as the current Gathering

func (*Gathering) ExtractFrom 

func (g *Gathering) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the Gathering from the given readable

func (Gathering) FormatToString 

func (g Gathering) FormatToString(indentationLevel int) string

FormatToString pretty-prints the Gathering using the provided indentation level

func (Gathering) GatheringObjectID added in v2.1.0 

func (g Gathering) GatheringObjectID() types.RVType

DataObjectID returns the object identifier of the type embedding Gathering

func (Gathering) ObjectID added in v2.1.0 

func (g Gathering) ObjectID() types.RVType

ObjectID returns the object identifier of the type

func (Gathering) String 

func (g Gathering) String() string

String returns the string representation of the Gathering

func (Gathering) WriteTo 

func (g Gathering) WriteTo(writable types.Writable)

WriteTo writes the Gathering to the given writable

type GatheringHolder added in v2.1.0 

type GatheringHolder = types.AnyObjectHolder[GatheringInterface]

GatheringHolder is an AnyObjectHolder for types which embed Gathering

func NewGatheringHolder added in v2.1.0 

func NewGatheringHolder() GatheringHolder

NewGatheringHolder returns a new GatheringHolder

type GatheringInterface added in v2.1.0 

type GatheringInterface interface {
	types.HoldableObject
	GatheringObjectID() types.RVType // Returns the object identifier of the type embedding Gathering
}

DataInterface defines an interface to track types which have Gathering anywhere in their parent tree.

type GatheringStats 

type GatheringStats struct {
	types.Structure
	PIDParticipant types.PID
	UIFlags        types.UInt32
	LstValues      types.List[types.Float]
}

GatheringStats is a type within the Matchmaking protocol

func NewGatheringStats 

func NewGatheringStats() GatheringStats

NewGatheringStats returns a new GatheringStats

func (GatheringStats) Copy 

func (gs GatheringStats) Copy() types.RVType

Copy returns a new copied instance of GatheringStats

func (GatheringStats) CopyRef added in v2.1.0 

func (gs GatheringStats) CopyRef() types.RVTypePtr

CopyRef copies the current value of the GatheringStats and returns a pointer to the new copy

func (*GatheringStats) Deref added in v2.1.0 

func (gs *GatheringStats) Deref() types.RVType

Deref takes a pointer to the GatheringStats and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (GatheringStats) Equals 

func (gs GatheringStats) Equals(o types.RVType) bool

Equals checks if the given GatheringStats contains the same data as the current GatheringStats

func (*GatheringStats) ExtractFrom 

func (gs *GatheringStats) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the GatheringStats from the given readable

func (GatheringStats) FormatToString 

func (gs GatheringStats) FormatToString(indentationLevel int) string

FormatToString pretty-prints the GatheringStats using the provided indentation level

func (GatheringStats) String 

func (gs GatheringStats) String() string

String returns the string representation of the GatheringStats

func (GatheringStats) WriteTo 

func (gs GatheringStats) WriteTo(writable types.Writable)

WriteTo writes the GatheringStats to the given writable

type GatheringURLs 

type GatheringURLs struct {
	types.Structure
	GID            types.UInt32
	LstStationURLs types.List[types.StationURL]
}

GatheringURLs is a type within the Matchmaking protocol

func NewGatheringURLs 

func NewGatheringURLs() GatheringURLs

NewGatheringURLs returns a new GatheringURLs

func (GatheringURLs) Copy 

func (gurl GatheringURLs) Copy() types.RVType

Copy returns a new copied instance of GatheringURLs

func (GatheringURLs) CopyRef added in v2.1.0 

func (gurl GatheringURLs) CopyRef() types.RVTypePtr

CopyRef copies the current value of the GatheringURLs and returns a pointer to the new copy

func (*GatheringURLs) Deref added in v2.1.0 

func (gurl *GatheringURLs) Deref() types.RVType

Deref takes a pointer to the GatheringURLs and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (GatheringURLs) Equals 

func (gurl GatheringURLs) Equals(o types.RVType) bool

Equals checks if the given GatheringURLs contains the same data as the current GatheringURLs

func (*GatheringURLs) ExtractFrom 

func (gurl *GatheringURLs) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the GatheringURLs from the given readable

func (GatheringURLs) FormatToString 

func (gurl GatheringURLs) FormatToString(indentationLevel int) string

FormatToString pretty-prints the GatheringURLs using the provided indentation level

func (GatheringURLs) String 

func (gurl GatheringURLs) String() string

String returns the string representation of the GatheringURLs

func (GatheringURLs) WriteTo 

func (gurl GatheringURLs) WriteTo(writable types.Writable)

WriteTo writes the GatheringURLs to the given writable

type Invitation 

type Invitation struct {
	types.Structure
	IDGathering types.UInt32
	IDGuest     types.UInt32
	StrMessage  types.String
}

Invitation is a type within the Matchmaking protocol

func NewInvitation 

func NewInvitation() Invitation

NewInvitation returns a new Invitation

func (Invitation) Copy 

func (i Invitation) Copy() types.RVType

Copy returns a new copied instance of Invitation

func (Invitation) CopyRef added in v2.1.0 

func (i Invitation) CopyRef() types.RVTypePtr

CopyRef copies the current value of the Invitation and returns a pointer to the new copy

func (*Invitation) Deref added in v2.1.0 

func (i *Invitation) Deref() types.RVType

Deref takes a pointer to the Invitation and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (Invitation) Equals 

func (i Invitation) Equals(o types.RVType) bool

Equals checks if the given Invitation contains the same data as the current Invitation

func (*Invitation) ExtractFrom 

func (i *Invitation) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the Invitation from the given readable

func (Invitation) FormatToString 

func (i Invitation) FormatToString(indentationLevel int) string

FormatToString pretty-prints the Invitation using the provided indentation level

func (Invitation) String 

func (i Invitation) String() string

String returns the string representation of the Invitation

func (Invitation) WriteTo 

func (i Invitation) WriteTo(writable types.Writable)

WriteTo writes the Invitation to the given writable

type JoinMatchmakeSessionParam 

type JoinMatchmakeSessionParam struct {
	types.Structure
	GID                          types.UInt32
	AdditionalParticipants       types.List[types.PID]
	GIDForParticipationCheck     types.UInt32
	JoinMatchmakeSessionOption   types.UInt32
	JoinMatchmakeSessionBehavior types.UInt8
	StrUserPassword              types.String
	StrSystemPassword            types.String
	JoinMessage                  types.String
	ParticipationCount           types.UInt16
	ExtraParticipants            types.UInt16            // * Revision 1 or NEX v4.0
	BlockListParam               MatchmakeBlockListParam // * NEX v4.0
}

JoinMatchmakeSessionParam is a type within the Matchmaking protocol

func NewJoinMatchmakeSessionParam 

func NewJoinMatchmakeSessionParam() JoinMatchmakeSessionParam

NewJoinMatchmakeSessionParam returns a new JoinMatchmakeSessionParam

func (JoinMatchmakeSessionParam) Copy 

func (jmsp JoinMatchmakeSessionParam) Copy() types.RVType

Copy returns a new copied instance of JoinMatchmakeSessionParam

func (JoinMatchmakeSessionParam) CopyRef added in v2.1.0 

func (jmsp JoinMatchmakeSessionParam) CopyRef() types.RVTypePtr

CopyRef copies the current value of the JoinMatchmakeSessionParam and returns a pointer to the new copy

func (*JoinMatchmakeSessionParam) Deref added in v2.1.0 

func (jmsp *JoinMatchmakeSessionParam) Deref() types.RVType

Deref takes a pointer to the JoinMatchmakeSessionParam and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (JoinMatchmakeSessionParam) Equals 

func (jmsp JoinMatchmakeSessionParam) Equals(o types.RVType) bool

Equals checks if the given JoinMatchmakeSessionParam contains the same data as the current JoinMatchmakeSessionParam

func (*JoinMatchmakeSessionParam) ExtractFrom 

func (jmsp *JoinMatchmakeSessionParam) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the JoinMatchmakeSessionParam from the given readable

func (JoinMatchmakeSessionParam) FormatToString 

func (jmsp JoinMatchmakeSessionParam) FormatToString(indentationLevel int) string

FormatToString pretty-prints the JoinMatchmakeSessionParam using the provided indentation level

func (JoinMatchmakeSessionParam) String 

func (jmsp JoinMatchmakeSessionParam) String() string

String returns the string representation of the JoinMatchmakeSessionParam

func (JoinMatchmakeSessionParam) WriteTo 

func (jmsp JoinMatchmakeSessionParam) WriteTo(writable types.Writable)

WriteTo writes the JoinMatchmakeSessionParam to the given writable

type MatchmakeBlockListParam 

type MatchmakeBlockListParam struct {
	types.Structure
	OptionFlag types.UInt32
}

MatchmakeBlockListParam is a type within the Matchmaking protocol

func NewMatchmakeBlockListParam 

func NewMatchmakeBlockListParam() MatchmakeBlockListParam

NewMatchmakeBlockListParam returns a new MatchmakeBlockListParam

func (MatchmakeBlockListParam) Copy 

func (mblp MatchmakeBlockListParam) Copy() types.RVType

Copy returns a new copied instance of MatchmakeBlockListParam

func (MatchmakeBlockListParam) CopyRef added in v2.1.0 

func (mblp MatchmakeBlockListParam) CopyRef() types.RVTypePtr

CopyRef copies the current value of the MatchmakeBlockListParam and returns a pointer to the new copy

func (*MatchmakeBlockListParam) Deref added in v2.1.0 

func (mblp *MatchmakeBlockListParam) Deref() types.RVType

Deref takes a pointer to the MatchmakeBlockListParam and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (MatchmakeBlockListParam) Equals 

func (mblp MatchmakeBlockListParam) Equals(o types.RVType) bool

Equals checks if the given MatchmakeBlockListParam contains the same data as the current MatchmakeBlockListParam

func (*MatchmakeBlockListParam) ExtractFrom 

func (mblp *MatchmakeBlockListParam) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the MatchmakeBlockListParam from the given readable

func (MatchmakeBlockListParam) FormatToString 

func (mblp MatchmakeBlockListParam) FormatToString(indentationLevel int) string

FormatToString pretty-prints the MatchmakeBlockListParam using the provided indentation level

func (MatchmakeBlockListParam) String 

func (mblp MatchmakeBlockListParam) String() string

String returns the string representation of the MatchmakeBlockListParam

func (MatchmakeBlockListParam) WriteTo 

func (mblp MatchmakeBlockListParam) WriteTo(writable types.Writable)

WriteTo writes the MatchmakeBlockListParam to the given writable

type MatchmakeParam 

type MatchmakeParam struct {
	types.Structure
	Params types.Map[types.String, types.Variant]
}

MatchmakeParam is a type within the Matchmaking protocol

func NewMatchmakeParam 

func NewMatchmakeParam() MatchmakeParam

NewMatchmakeParam returns a new MatchmakeParam

func (MatchmakeParam) Copy 

func (mp MatchmakeParam) Copy() types.RVType

Copy returns a new copied instance of MatchmakeParam

func (MatchmakeParam) CopyRef added in v2.1.0 

func (mp MatchmakeParam) CopyRef() types.RVTypePtr

CopyRef copies the current value of the MatchmakeParam and returns a pointer to the new copy

func (*MatchmakeParam) Deref added in v2.1.0 

func (mp *MatchmakeParam) Deref() types.RVType

Deref takes a pointer to the MatchmakeParam and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (MatchmakeParam) Equals 

func (mp MatchmakeParam) Equals(o types.RVType) bool

Equals checks if the given MatchmakeParam contains the same data as the current MatchmakeParam

func (*MatchmakeParam) ExtractFrom 

func (mp *MatchmakeParam) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the MatchmakeParam from the given readable

func (MatchmakeParam) FormatToString 

func (mp MatchmakeParam) FormatToString(indentationLevel int) string

FormatToString pretty-prints the MatchmakeParam using the provided indentation level

func (MatchmakeParam) String 

func (mp MatchmakeParam) String() string

String returns the string representation of the MatchmakeParam

func (MatchmakeParam) WriteTo 

func (mp MatchmakeParam) WriteTo(writable types.Writable)

WriteTo writes the MatchmakeParam to the given writable

type MatchmakeSession 

type MatchmakeSession struct {
	types.Structure
	Gathering
	GameMode              types.UInt32
	Attributes            types.List[types.UInt32]
	OpenParticipation     types.Bool
	MatchmakeSystemType   types.UInt32
	ApplicationBuffer     types.Buffer
	ParticipationCount    types.UInt32
	ProgressScore         types.UInt8    // * NEX v3.4.0
	SessionKey            types.Buffer   // * NEX v3.0.0
	Option                types.UInt32   // * NEX v3.5.0
	MatchmakeParam        MatchmakeParam // * NEX v3.6.0
	StartedTime           types.DateTime // * NEX v3.6.0
	UserPassword          types.String   // * NEX v3.7.0
	ReferGID              types.UInt32   // * NEX v3.8.0
	UserPasswordEnabled   types.Bool     // * NEX v3.8.0
	SystemPasswordEnabled types.Bool     // * NEX v3.8.0
	CodeWord              types.String   // * NEX v4.0.0
}

MatchmakeSession is a type within the Matchmaking protocol

func NewMatchmakeSession 

func NewMatchmakeSession() MatchmakeSession

NewMatchmakeSession returns a new MatchmakeSession

func (MatchmakeSession) Copy 

func (ms MatchmakeSession) Copy() types.RVType

Copy returns a new copied instance of MatchmakeSession

func (MatchmakeSession) CopyRef added in v2.1.0 

func (ms MatchmakeSession) CopyRef() types.RVTypePtr

CopyRef copies the current value of the MatchmakeSession and returns a pointer to the new copy

func (*MatchmakeSession) Deref added in v2.1.0 

func (ms *MatchmakeSession) Deref() types.RVType

Deref takes a pointer to the MatchmakeSession and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (MatchmakeSession) Equals 

func (ms MatchmakeSession) Equals(o types.RVType) bool

Equals checks if the given MatchmakeSession contains the same data as the current MatchmakeSession

func (*MatchmakeSession) ExtractFrom 

func (ms *MatchmakeSession) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the MatchmakeSession from the given readable

func (MatchmakeSession) FormatToString 

func (ms MatchmakeSession) FormatToString(indentationLevel int) string

FormatToString pretty-prints the MatchmakeSession using the provided indentation level

func (MatchmakeSession) GatheringObjectID added in v2.1.0 

func (ms MatchmakeSession) GatheringObjectID() types.RVType

DataObjectID returns the object identifier of the type embedding Gathering

func (MatchmakeSession) ObjectID added in v2.1.0 

func (ms MatchmakeSession) ObjectID() types.RVType

ObjectID returns the object identifier of the type

func (MatchmakeSession) String 

func (ms MatchmakeSession) String() string

String returns the string representation of the MatchmakeSession

func (MatchmakeSession) WriteTo 

func (ms MatchmakeSession) WriteTo(writable types.Writable)

WriteTo writes the MatchmakeSession to the given writable

type MatchmakeSessionSearchCriteria 

type MatchmakeSessionSearchCriteria struct {
	types.Structure
	Attribs                  types.List[types.String]
	GameMode                 types.String
	MinParticipants          types.String // * NEX v2.0.0
	MaxParticipants          types.String // * NEX v2.0.0
	MatchmakeSystemType      types.String
	VacantOnly               types.Bool
	ExcludeLocked            types.Bool
	ExcludeNonHostPID        types.Bool
	SelectionMethod          types.UInt32      // * NEX v3.0.0
	VacantParticipants       types.UInt16      // * NEX v3.4.0
	MatchmakeParam           MatchmakeParam    // * NEX v3.6.0
	ExcludeUserPasswordSet   types.Bool        // * NEX v3.7.0
	ExcludeSystemPasswordSet types.Bool        // * NEX v3.7.0
	ReferGID                 types.UInt32      // * NEX v3.8.0
	CodeWord                 types.String      // * NEX v4.0.0
	ResultRange              types.ResultRange // * NEX v4.0.0
}

MatchmakeSessionSearchCriteria is a type within the Matchmaking protocol

func NewMatchmakeSessionSearchCriteria 

func NewMatchmakeSessionSearchCriteria() MatchmakeSessionSearchCriteria

NewMatchmakeSessionSearchCriteria returns a new MatchmakeSessionSearchCriteria

func (MatchmakeSessionSearchCriteria) Copy 

func (mssc MatchmakeSessionSearchCriteria) Copy() types.RVType

Copy returns a new copied instance of MatchmakeSessionSearchCriteria

func (MatchmakeSessionSearchCriteria) CopyRef added in v2.1.0 

func (mssc MatchmakeSessionSearchCriteria) CopyRef() types.RVTypePtr

CopyRef copies the current value of the MatchmakeSessionSearchCriteria and returns a pointer to the new copy

func (*MatchmakeSessionSearchCriteria) Deref added in v2.1.0 

func (mssc *MatchmakeSessionSearchCriteria) Deref() types.RVType

Deref takes a pointer to the MatchmakeSessionSearchCriteria and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (MatchmakeSessionSearchCriteria) Equals 

func (mssc MatchmakeSessionSearchCriteria) Equals(o types.RVType) bool

Equals checks if the given MatchmakeSessionSearchCriteria contains the same data as the current MatchmakeSessionSearchCriteria

func (*MatchmakeSessionSearchCriteria) ExtractFrom 

func (mssc *MatchmakeSessionSearchCriteria) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the MatchmakeSessionSearchCriteria from the given readable

func (MatchmakeSessionSearchCriteria) FormatToString 

func (mssc MatchmakeSessionSearchCriteria) FormatToString(indentationLevel int) string

FormatToString pretty-prints the MatchmakeSessionSearchCriteria using the provided indentation level

func (MatchmakeSessionSearchCriteria) String 

func (mssc MatchmakeSessionSearchCriteria) String() string

String returns the string representation of the MatchmakeSessionSearchCriteria

func (MatchmakeSessionSearchCriteria) WriteTo 

func (mssc MatchmakeSessionSearchCriteria) WriteTo(writable types.Writable)

WriteTo writes the MatchmakeSessionSearchCriteria to the given writable

type ParticipantDetails 

type ParticipantDetails struct {
	types.Structure
	IDParticipant  types.PID
	StrName        types.String
	StrMessage     types.String
	UIParticipants types.UInt16
}

ParticipantDetails is a type within the Matchmaking protocol

func NewParticipantDetails 

func NewParticipantDetails() ParticipantDetails

NewParticipantDetails returns a new ParticipantDetails

func (ParticipantDetails) Copy 

func (pd ParticipantDetails) Copy() types.RVType

Copy returns a new copied instance of ParticipantDetails

func (ParticipantDetails) CopyRef added in v2.1.0 

func (pd ParticipantDetails) CopyRef() types.RVTypePtr

CopyRef copies the current value of the ParticipantDetails and returns a pointer to the new copy

func (*ParticipantDetails) Deref added in v2.1.0 

func (pd *ParticipantDetails) Deref() types.RVType

Deref takes a pointer to the ParticipantDetails and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (ParticipantDetails) Equals 

func (pd ParticipantDetails) Equals(o types.RVType) bool

Equals checks if the given ParticipantDetails contains the same data as the current ParticipantDetails

func (*ParticipantDetails) ExtractFrom 

func (pd *ParticipantDetails) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the ParticipantDetails from the given readable

func (ParticipantDetails) FormatToString 

func (pd ParticipantDetails) FormatToString(indentationLevel int) string

FormatToString pretty-prints the ParticipantDetails using the provided indentation level

func (ParticipantDetails) String 

func (pd ParticipantDetails) String() string

String returns the string representation of the ParticipantDetails

func (ParticipantDetails) WriteTo 

func (pd ParticipantDetails) WriteTo(writable types.Writable)

WriteTo writes the ParticipantDetails to the given writable

type PersistentGathering 

type PersistentGathering struct {
	types.Structure
	Gathering
	CommunityType          types.UInt32
	Password               types.String
	Attribs                types.List[types.UInt32]
	ApplicationBuffer      types.Buffer
	ParticipationStartDate types.DateTime
	ParticipationEndDate   types.DateTime
	MatchmakeSessionCount  types.UInt32
	ParticipationCount     types.UInt32
}

PersistentGathering is a type within the Matchmaking protocol

func NewPersistentGathering 

func NewPersistentGathering() PersistentGathering

NewPersistentGathering returns a new PersistentGathering

func (PersistentGathering) Copy 

func (pg PersistentGathering) Copy() types.RVType

Copy returns a new copied instance of PersistentGathering

func (PersistentGathering) CopyRef added in v2.1.0 

func (pg PersistentGathering) CopyRef() types.RVTypePtr

CopyRef copies the current value of the PersistentGathering and returns a pointer to the new copy

func (*PersistentGathering) Deref added in v2.1.0 

func (pg *PersistentGathering) Deref() types.RVType

Deref takes a pointer to the PersistentGathering and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (PersistentGathering) Equals 

func (pg PersistentGathering) Equals(o types.RVType) bool

Equals checks if the given PersistentGathering contains the same data as the current PersistentGathering

func (*PersistentGathering) ExtractFrom 

func (pg *PersistentGathering) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the PersistentGathering from the given readable

func (PersistentGathering) FormatToString 

func (pg PersistentGathering) FormatToString(indentationLevel int) string

FormatToString pretty-prints the PersistentGathering using the provided indentation level

func (PersistentGathering) String 

func (pg PersistentGathering) String() string

String returns the string representation of the PersistentGathering

func (PersistentGathering) WriteTo 

func (pg PersistentGathering) WriteTo(writable types.Writable)

WriteTo writes the PersistentGathering to the given writable

type PlayingSession 

type PlayingSession struct {
	types.Structure
	PrincipalID types.PID
	Gathering   GatheringHolder
}

PlayingSession is a type within the Matchmaking protocol

func NewPlayingSession 

func NewPlayingSession() PlayingSession

NewPlayingSession returns a new PlayingSession

func (PlayingSession) Copy 

func (ps PlayingSession) Copy() types.RVType

Copy returns a new copied instance of PlayingSession

func (PlayingSession) CopyRef added in v2.1.0 

func (ps PlayingSession) CopyRef() types.RVTypePtr

CopyRef copies the current value of the PlayingSession and returns a pointer to the new copy

func (*PlayingSession) Deref added in v2.1.0 

func (ps *PlayingSession) Deref() types.RVType

Deref takes a pointer to the PlayingSession and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (PlayingSession) Equals 

func (ps PlayingSession) Equals(o types.RVType) bool

Equals checks if the given PlayingSession contains the same data as the current PlayingSession

func (*PlayingSession) ExtractFrom 

func (ps *PlayingSession) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the PlayingSession from the given readable

func (PlayingSession) FormatToString 

func (ps PlayingSession) FormatToString(indentationLevel int) string

FormatToString pretty-prints the PlayingSession using the provided indentation level

func (PlayingSession) String 

func (ps PlayingSession) String() string

String returns the string representation of the PlayingSession

func (PlayingSession) WriteTo 

func (ps PlayingSession) WriteTo(writable types.Writable)

WriteTo writes the PlayingSession to the given writable

type SimpleCommunity 

type SimpleCommunity struct {
	types.Structure
	GatheringID           types.UInt32
	MatchmakeSessionCount types.UInt32
}

SimpleCommunity is a type within the Matchmaking protocol

func NewSimpleCommunity 

func NewSimpleCommunity() SimpleCommunity

NewSimpleCommunity returns a new SimpleCommunity

func (SimpleCommunity) Copy 

func (sc SimpleCommunity) Copy() types.RVType

Copy returns a new copied instance of SimpleCommunity

func (SimpleCommunity) CopyRef added in v2.1.0 

func (sc SimpleCommunity) CopyRef() types.RVTypePtr

CopyRef copies the current value of the SimpleCommunity and returns a pointer to the new copy

func (*SimpleCommunity) Deref added in v2.1.0 

func (sc *SimpleCommunity) Deref() types.RVType

Deref takes a pointer to the SimpleCommunity and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (SimpleCommunity) Equals 

func (sc SimpleCommunity) Equals(o types.RVType) bool

Equals checks if the given SimpleCommunity contains the same data as the current SimpleCommunity

func (*SimpleCommunity) ExtractFrom 

func (sc *SimpleCommunity) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the SimpleCommunity from the given readable

func (SimpleCommunity) FormatToString 

func (sc SimpleCommunity) FormatToString(indentationLevel int) string

FormatToString pretty-prints the SimpleCommunity using the provided indentation level

func (SimpleCommunity) String 

func (sc SimpleCommunity) String() string

String returns the string representation of the SimpleCommunity

func (SimpleCommunity) WriteTo 

func (sc SimpleCommunity) WriteTo(writable types.Writable)

WriteTo writes the SimpleCommunity to the given writable

type SimplePlayingSession 

type SimplePlayingSession struct {
	types.Structure
	PrincipalID types.PID
	GatheringID types.UInt32
	GameMode    types.UInt32
	Attribute0  types.UInt32
}

SimplePlayingSession is a type within the Matchmaking protocol

func NewSimplePlayingSession 

func NewSimplePlayingSession() SimplePlayingSession

NewSimplePlayingSession returns a new SimplePlayingSession

func (SimplePlayingSession) Copy 

func (sps SimplePlayingSession) Copy() types.RVType

Copy returns a new copied instance of SimplePlayingSession

func (SimplePlayingSession) CopyRef added in v2.1.0 

func (sps SimplePlayingSession) CopyRef() types.RVTypePtr

CopyRef copies the current value of the SimplePlayingSession and returns a pointer to the new copy

func (*SimplePlayingSession) Deref added in v2.1.0 

func (sps *SimplePlayingSession) Deref() types.RVType

Deref takes a pointer to the SimplePlayingSession and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (SimplePlayingSession) Equals 

func (sps SimplePlayingSession) Equals(o types.RVType) bool

Equals checks if the given SimplePlayingSession contains the same data as the current SimplePlayingSession

func (*SimplePlayingSession) ExtractFrom 

func (sps *SimplePlayingSession) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the SimplePlayingSession from the given readable

func (SimplePlayingSession) FormatToString 

func (sps SimplePlayingSession) FormatToString(indentationLevel int) string

FormatToString pretty-prints the SimplePlayingSession using the provided indentation level

func (SimplePlayingSession) String 

func (sps SimplePlayingSession) String() string

String returns the string representation of the SimplePlayingSession

func (SimplePlayingSession) WriteTo 

func (sps SimplePlayingSession) WriteTo(writable types.Writable)

WriteTo writes the SimplePlayingSession to the given writable

type UpdateMatchmakeSessionParam 

type UpdateMatchmakeSessionParam struct {
	types.Structure
	GID                 types.UInt32
	ModificationFlag    types.UInt32
	Attributes          types.List[types.UInt32]
	OpenParticipation   types.Bool
	ApplicationBuffer   types.Buffer
	ProgressScore       types.UInt8
	MatchmakeParam      MatchmakeParam
	StartedTime         types.DateTime
	UserPassword        types.String
	GameMode            types.UInt32
	Description         types.String
	MinParticipants     types.UInt16
	MaxParticipants     types.UInt16
	MatchmakeSystemType types.UInt32
	ParticipationPolicy types.UInt32
	PolicyArgument      types.UInt32
	Codeword            types.String
}

UpdateMatchmakeSessionParam is a type within the Matchmaking protocol

func NewUpdateMatchmakeSessionParam 

func NewUpdateMatchmakeSessionParam() UpdateMatchmakeSessionParam

NewUpdateMatchmakeSessionParam returns a new UpdateMatchmakeSessionParam

func (UpdateMatchmakeSessionParam) Copy 

func (umsp UpdateMatchmakeSessionParam) Copy() types.RVType

Copy returns a new copied instance of UpdateMatchmakeSessionParam

func (UpdateMatchmakeSessionParam) CopyRef added in v2.1.0 

func (umsp UpdateMatchmakeSessionParam) CopyRef() types.RVTypePtr

CopyRef copies the current value of the UpdateMatchmakeSessionParam and returns a pointer to the new copy

func (*UpdateMatchmakeSessionParam) Deref added in v2.1.0 

func (umsp *UpdateMatchmakeSessionParam) Deref() types.RVType

Deref takes a pointer to the UpdateMatchmakeSessionParam and dereferences it to the raw value. Only useful when working with an instance of RVTypePtr

func (UpdateMatchmakeSessionParam) Equals 

func (umsp UpdateMatchmakeSessionParam) Equals(o types.RVType) bool

Equals checks if the given UpdateMatchmakeSessionParam contains the same data as the current UpdateMatchmakeSessionParam

func (*UpdateMatchmakeSessionParam) ExtractFrom 

func (umsp *UpdateMatchmakeSessionParam) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the UpdateMatchmakeSessionParam from the given readable

func (UpdateMatchmakeSessionParam) FormatToString 

func (umsp UpdateMatchmakeSessionParam) FormatToString(indentationLevel int) string

FormatToString pretty-prints the UpdateMatchmakeSessionParam using the provided indentation level

func (UpdateMatchmakeSessionParam) String 

func (umsp UpdateMatchmakeSessionParam) String() string

String returns the string representation of the UpdateMatchmakeSessionParam

func (UpdateMatchmakeSessionParam) WriteTo 

func (umsp UpdateMatchmakeSessionParam) WriteTo(writable types.Writable)

WriteTo writes the UpdateMatchmakeSessionParam to the given writable

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.