v1.2.1
Latest
2020.3+

Struct ChangedOrRemovedLobbyValue<T>

Contains whether or not a particular change or removal has occurred. If a change has occurred, also provides the value of the change.

Namespace: Unity.Services.Lobbies
Syntax
public struct ChangedOrRemovedLobbyValue<T>
Type Parameters
NameDescription
T

The type of the value of the change.

Constructors

ChangedOrRemovedLobbyValue(T, LobbyValueChangeType)

Creates a changed or removed value.

Declaration
public ChangedOrRemovedLobbyValue(T value, LobbyValueChangeType status)
Parameters
TypeNameDescription
Tvalue

The new value provided by the change.

LobbyValueChangeTypestatus

The status of this change.

Fields

RemoveThisValue

A helper for providing a removal of the value without having to call a constructor.

Declaration
public static readonly ChangedOrRemovedLobbyValue<T> RemoveThisValue
Field Value
TypeDescription
ChangedOrRemovedLobbyValue<T>

Properties

Added

True if the value was newly added, false otherwise. Removed and Added properties are mutually exclusive.

Declaration
public readonly bool Added { get; }
Property Value
TypeDescription
Boolean

Changed

True if a change has occurred, false if there has been no change. Removed and Changed properties are mutually exclusive.

Declaration
public readonly bool Changed { get; }
Property Value
TypeDescription
Boolean

ChangeType

Whether this is a change, a removal, or an addition.

Declaration
public readonly LobbyValueChangeType ChangeType { get; }
Property Value
TypeDescription
LobbyValueChangeType

Removed

True if the value has been removed, false if it hasn't been removed. Removed properties are mutually exclusive with Changed and Added properties.

Declaration
public readonly bool Removed { get; }
Property Value
TypeDescription
Boolean

Value

The new value provided by the change.

Declaration
public readonly T Value { get; }
Property Value
TypeDescription
T