Class SteamData<T>
Data for lobbies which can be searched upon.
Namespace: KaijuSolutions.SteamMultiplayerEngine
Syntax
public abstract class SteamData<T>Type Parameters
| Name | Description |
|---|---|
| T | The type of data this is for. |
Fields
sortingOrder
How to handle this value when sorting lobbies. Sorting priority will be done in the order of greatest to least. Values greater than zero will be applied before sorting based on player counts. Values less than zero will be applied after sorting based on player counts. Setting to zero means this has no impact on sorting.
Declaration
public int sortingOrderField Value
| Type | Description |
|---|---|
| System.Int32 |
Properties
Key
The key.
Declaration
public string Key { get; protected set; }Property Value
| Type | Description |
|---|---|
| System.String |
Value
The value.
Declaration
public T Value { get; protected set; }Property Value
| Type | Description |
|---|---|
| T |
Methods
Ordering(UInt64)
Get the ordering value of this for a given lobby, with lower values being a better match.
Declaration
public int Ordering(ulong id)Parameters
| Type | Name | Description |
|---|---|---|
| System.UInt64 | id | The lobby ID. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The ordering value of this for the given lobby, with lower values being a better match. |
OrderingCheck()
Check if based on the current sorting requirements if we should even bother ordering.
Declaration
protected virtual bool OrderingCheck()Returns
| Type | Description |
|---|---|
| System.Boolean | If this should be ordered. |
OrderingInternal(String)
Implement the actual ordering method.
Declaration
protected abstract int OrderingInternal(string current)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | current | The value in the lobby's metadata. |
Returns
| Type | Description |
|---|---|
| System.Int32 |
Search()
Add this data to the lobby search.
Declaration
public bool Search()Returns
| Type | Description |
|---|---|
| System.Boolean |
SearchInternal()
Implement the actual search method.
Declaration
protected abstract void SearchInternal()Set()
Add lobby data if we are the owner.
Declaration
public abstract bool Set()Returns
| Type | Description |
|---|---|
| System.Boolean | If the data was successfully set. |