Struct FriendsGroupID_t

Wraps the Steamworks FriendsGroupID_t handle, a short.

Implements

IEquatable<FriendsGroupID_t>

IComparable<FriendsGroupID_t>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.Steamworks.Interop

Assembly: Unity.Steamworks.Interop.dll

Syntax

[Serializable]
public struct FriendsGroupID_t : IEquatable<FriendsGroupID_t>, IComparable<FriendsGroupID_t>

Constructors

FriendsGroupID_t(short)

Initializes a new FriendsGroupID_t from its underlying value.

Declaration

public FriendsGroupID_t(short value)

Parameters

Type	Name	Description
short	value	The underlying short value.

Fields

Invalid

The value the SDK reserves to mean "no FriendsGroupID_t".

Declaration

public static readonly FriendsGroupID_t Invalid

Field Value

Type	Description
FriendsGroupID_t

m_FriendsGroupID

The underlying short value.

Declaration

public short m_FriendsGroupID

Field Value

Type	Description
short

Methods

CompareTo(FriendsGroupID_t)

Orders this value against other by their underlying values.

Declaration

public int CompareTo(FriendsGroupID_t other)

Parameters

Type	Name	Description
FriendsGroupID_t	other	The value to compare against.

Returns

Type	Description
int	Negative, zero or positive as this value sorts before, with or after other.

Equals(object)

Returns true when other is a FriendsGroupID_t with the same value.

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
object	other	The object to compare against.

Returns

Type	Description
bool	true when other is a FriendsGroupID_t holding the same value.

Overrides

ValueType.Equals(object)

Equals(FriendsGroupID_t)

Returns true when this value equals other.

Declaration

public bool Equals(FriendsGroupID_t other)

Parameters

Type	Name	Description
FriendsGroupID_t	other	The value to compare against.

Returns

Type	Description
bool	true when both hold the same underlying value.

GetHashCode()

Returns the hash code of the underlying value.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	The underlying value's hash code.

Overrides

ValueType.GetHashCode()

ToString()

Returns the underlying value as a string.

Declaration

public override string ToString()

Returns

Type	Description
string	The underlying value formatted by its own ToString.

Overrides

ValueType.ToString()

Operators

operator ==(FriendsGroupID_t, FriendsGroupID_t)

Returns true when both operands hold the same value.

Declaration

public static bool operator ==(FriendsGroupID_t x, FriendsGroupID_t y)

Parameters

Type	Name	Description
FriendsGroupID_t	x	The first value to compare.
FriendsGroupID_t	y	The second value to compare.

Returns

Type	Description
bool	true when the two hold the same underlying value.

explicit operator FriendsGroupID_t(short)

Converts a short to a FriendsGroupID_t. Explicit, so two handle types cannot convert into each other through the type they share.

Declaration

public static explicit operator FriendsGroupID_t(short value)

Parameters

Type	Name	Description
short	value	The underlying short value.

Returns

Type	Description
FriendsGroupID_t	A FriendsGroupID_t holding value.

explicit operator short(FriendsGroupID_t)

Converts a FriendsGroupID_t to its underlying short.

Declaration

public static explicit operator short(FriendsGroupID_t that)

Parameters

Type	Name	Description
FriendsGroupID_t	that	The handle to unwrap.

Returns

Type	Description
short	The underlying short value.

operator !=(FriendsGroupID_t, FriendsGroupID_t)

Returns true when the operands hold different values.

Declaration

public static bool operator !=(FriendsGroupID_t x, FriendsGroupID_t y)

Parameters

Type	Name	Description
FriendsGroupID_t	x	The first value to compare.
FriendsGroupID_t	y	The second value to compare.

Returns

Type	Description
bool	true when the two hold different underlying values.

Implements

IEquatable<T>

IComparable<T>