allocate

open suspend override fun allocate()(source)

Notifies Agones that this instance has been allocated/claimed and is currently not available for any other GameServerAllocations. It is preferred, that instances are assigned through GameServerAllocations. However, in cases where this is not possible (e.g., when working with external systems), this interface can be used to manually assign the instance.

This sets this GameServer into the Allocated state, which means, that it won't be deleted on fleet scaling or updates. This indicates that the instance is currently being used and can therefore not be shut down without interrupting the gameplay.

See also