sdk

Documentation

Overview

Package sdk is the Go game server sdk.

Index

• type Alpha
  • func (a *Alpha) GetConnectedPlayers() ([]string, error)
  • func (a *Alpha) GetPlayerCapacity() (int64, error)
  • func (a *Alpha) GetPlayerCount() (int64, error)
  • func (a *Alpha) IsPlayerConnected(id string) (bool, error)
  • func (a *Alpha) PlayerConnect(id string) (bool, error)
  • func (a *Alpha) PlayerDisconnect(id string) (bool, error)
  • func (a *Alpha) SetPlayerCapacity(capacity int64) error
• type GameServerCallback
• type SDK
  • func NewSDK() (*SDK, error)
  • func (s *SDK) Allocate() error
  • func (s *SDK) Alpha() *Alpha
  • func (s *SDK) GameServer() (*sdk.GameServer, error)
  • func (s *SDK) Health() error
  • func (s *SDK) Ready() error
  • func (s *SDK) Reserve(d time.Duration) error
  • func (s *SDK) SetAnnotation(key, value string) error
  • func (s *SDK) SetLabel(key, value string) error
  • func (s *SDK) Shutdown() error
  • func (s *SDK) WatchGameServer(f GameServerCallback) error

Types

type Alpha

type Alpha struct {
	// contains filtered or unexported fields
}

Alpha is the struct for Alpha SDK functionality.

func (*Alpha) GetConnectedPlayers

func (a *Alpha) GetConnectedPlayers() ([]string, error)

GetConnectedPlayers returns the list of the currently connected player ids. This is always accurate, even if the value hasn’t been updated to the GameServer status yet.

func (*Alpha) GetPlayerCapacity

func (a *Alpha) GetPlayerCapacity() (int64, error)

GetPlayerCapacity gets the last player capacity that was set through the SDK. If the player capacity is set from outside the SDK, use SDK.GameServer() instead.

func (*Alpha) GetPlayerCount

func (a *Alpha) GetPlayerCount() (int64, error)

GetPlayerCount returns the current player count.

func (*Alpha) IsPlayerConnected

func (a *Alpha) IsPlayerConnected(id string) (bool, error)

IsPlayerConnected returns if the playerID is currently connected to the GameServer. This is always accurate, even if the value hasn’t been updated to the GameServer status yet.

func (*Alpha) PlayerConnect

func (a *Alpha) PlayerConnect(id string) (bool, error)

PlayerConnect increases the SDK’s stored player count by one, and appends this playerID to status.players.id. Will return true and add the playerID to the list of playerIDs if the playerIDs was not already in the list of connected playerIDs.

func (*Alpha) PlayerDisconnect

func (a *Alpha) PlayerDisconnect(id string) (bool, error)

PlayerDisconnect Decreases the SDK’s stored player count by one, and removes the playerID from status.players.id. Will return true and remove the supplied playerID from the list of connected playerIDs if the playerID value exists within the list.

func (*Alpha) SetPlayerCapacity

func (a *Alpha) SetPlayerCapacity(capacity int64) error

SetPlayerCapacity changes the player capacity to a new value.

type GameServerCallback

type GameServerCallback func(gs *sdk.GameServer)

GameServerCallback is a function definition to be called when a GameServer CRD has been changed.

type SDK

type SDK struct {
	// contains filtered or unexported fields
}

SDK is an instance of the Agones SDK.

func NewSDK

func NewSDK() (*SDK, error)

NewSDK starts a new SDK instance, and connects to localhost on port "AGONES_SDK_GRPC_PORT" which by default is 9357. Blocks until connection and handshake are made. Times out after 30 seconds.

func (*SDK) Allocate

func (s *SDK) Allocate() error

Allocate self marks this gameserver as Allocated.

func (*SDK) Alpha

func (s *SDK) Alpha() *Alpha

Alpha returns the Alpha SDK.

func (*SDK) GameServer

func (s *SDK) GameServer() (*sdk.GameServer, error)

GameServer retrieve the GameServer details.

func (*SDK) Health

func (s *SDK) Health() error

Health sends a ping to the sidecar health check to indicate that this Game Server is healthy.

func (*SDK) Ready

func (s *SDK) Ready() error

Ready marks the Game Server as ready to receive connections.

func (*SDK) Reserve

func (s *SDK) Reserve(d time.Duration) error

Reserve marks the Game Server as Reserved for a given duration, at which point it will return the GameServer to a Ready state. Do note, the smallest unit available in the time.Duration argument is a second.

func (*SDK) SetAnnotation

func (s *SDK) SetAnnotation(key, value string) error

SetAnnotation sets a metadata annotation on the `GameServer` with the prefix "agones.dev/sdk-".

func (*SDK) SetLabel

func (s *SDK) SetLabel(key, value string) error

SetLabel sets a metadata label on the `GameServer` with the prefix "agones.dev/sdk-".

func (*SDK) Shutdown

func (s *SDK) Shutdown() error

Shutdown marks the Game Server as ready to shutdown.

func (*SDK) WatchGameServer

func (s *SDK) WatchGameServer(f GameServerCallback) error

WatchGameServer asynchronously calls the given GameServerCallback with the current GameServer configuration when the backing GameServer configuration is updated. This function can be called multiple times to add more than one GameServerCallback.