listCapacity

open suspend override fun listCapacity(name: String): Long(source)

Retrieves the current capacity of the list with the supplied name. The return value is guaranteed to match the value set within the SDK, even if the value was not yet synchronized with the Kubernetes resource. If no list with this name exists, an appropriate exception will be thrown.

The Counts and Lists API will eventually supersede the specific player tracking APIs of the AgonesSdk, as these cover a broader use-case and offer similar interfaces for tracking. Therefore, this method should be preferred.

Return

The current capacity of the list with the supplied name. This is guaranteed to be between 0 and the capacity of this list.

Parameters

name

The unique identifier of this instance's list whose capacity should be queried.

See also

Throws

If null is supplied as the list identifier and therefore no list can be derived from it.


open suspend override fun listCapacity(name: String, capacity: Long)(source)

Sets a new capacity for the list with the supplied name. If no list with this name exists or the capacity is not in the interval [0, 1000], an appropriate exception will be thrown.

The Counts and Lists API will eventually supersede the specific player tracking APIs of the AgonesSdk, as these cover a broader use-case and offer similar interfaces for tracking. Therefore, this method should be preferred.

Parameters

name

The unique identifier of this instance's list whose capacity should be modified.

capacity

The new capacity that should be applied to the desired list.

See also

Throws

If null is supplied as the list identifier and therefore no list can be derived from it.