Struct UGCHandle_t

Wraps the Steamworks UGCHandle_t handle, a ulong.

Implements

IEquatable<UGCHandle_t>

IComparable<UGCHandle_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 UGCHandle_t : IEquatable<UGCHandle_t>, IComparable<UGCHandle_t>

Constructors

UGCHandle_t(ulong)

Initializes a new UGCHandle_t from its underlying value.

Declaration

public UGCHandle_t(ulong value)

Parameters

Type	Name	Description
ulong	value	The underlying ulong value.

Fields

Invalid

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

Declaration

public static readonly UGCHandle_t Invalid

Field Value

Type	Description
UGCHandle_t

m_UGCHandle

The underlying ulong value.

Declaration

public ulong m_UGCHandle

Field Value

Type	Description
ulong

Methods

CompareTo(UGCHandle_t)

Orders this value against other by their underlying values.

Declaration

public int CompareTo(UGCHandle_t other)

Parameters

Type	Name	Description
UGCHandle_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 UGCHandle_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 UGCHandle_t holding the same value.

Overrides

ValueType.Equals(object)

Equals(UGCHandle_t)

Returns true when this value equals other.

Declaration

public bool Equals(UGCHandle_t other)

Parameters

Type	Name	Description
UGCHandle_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 ==(UGCHandle_t, UGCHandle_t)

Returns true when both operands hold the same value.

Declaration

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

Parameters

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

Returns

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

explicit operator UGCHandle_t(ulong)

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

Declaration

public static explicit operator UGCHandle_t(ulong value)

Parameters

Type	Name	Description
ulong	value	The underlying ulong value.

Returns

Type	Description
UGCHandle_t	A UGCHandle_t holding value.

explicit operator ulong(UGCHandle_t)

Converts a UGCHandle_t to its underlying ulong.

Declaration

public static explicit operator ulong(UGCHandle_t that)

Parameters

Type	Name	Description
UGCHandle_t	that	The handle to unwrap.

Returns

Type	Description
ulong	The underlying ulong value.

operator !=(UGCHandle_t, UGCHandle_t)

Returns true when the operands hold different values.

Declaration

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

Parameters

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

Returns

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

Implements

IEquatable<T>

IComparable<T>