cg

package

Go to main page

Versions in this module

v0

v0.9.2

Dec 29, 2022

v0.9.1

Dec 29, 2022

retracted

Changes in this version

+ type CGInfo struct

+ CGVersion string

+ Description string

+ DisplayName string

+ Name string

+ RepositoryURL string

+ Version string

type Socket

+ func (s *Socket) Info() CGInfo

v0.9.0

Aug 8, 2022

Changes in this version

+ const DebugError

+ const DebugInfo

+ const DebugTrace

+ const DebugWarning

+ const Green

+ const Red

+ const Reset

+ const Yellow

+ func FetchGameConfig(socket *Socket, gameId string) (T, error)

+ type Command struct

+ Data json.RawMessage

+ Name CommandName

+ type CommandName string

+ type DebugMessageCallback func(severity DebugSeverity, message string, data string)

+ type DebugSeverity string

+ type DebugSocket struct

+ func NewDebugSocket(url string) *DebugSocket

+ func (s *DebugSocket) Close() error

+ func (s *DebugSocket) DebugGame(gameId string) error

+ func (s *DebugSocket) DebugPlayer(gameId, playerId, playerSecret string) error

+ func (s *DebugSocket) DebugServer() error

+ func (s *DebugSocket) OnMessage(callback DebugMessageCallback) CallbackId

+ func (s *DebugSocket) RemoveCallback(id CallbackId)

+ func (s *DebugSocket) SetSeverities(enableTrace, enableInfo, enableWarning, enableError bool)

+ func (s *DebugSocket) URL() string

+ type EventCallback func(event Event)

type Session

+ GameURL string

type Socket

+ func (s *Socket) CreateGame(public, protected bool, config any) (gameId, joinSecret string, err error)

+ func (s *Socket) Username(playerId string) string

v0.8.0

Jun 1, 2022

Changes in this version

+ type ConnectEventData struct

+ GameId string

+ PlayerId string

+ Secret string

+ type ConnectedEventData struct

+ Username string

+ type ErrorEventData struct

+ Message string

type EventName

+ const ConnectEvent

+ const ConnectedEvent

+ const ErrorEvent

+ const InfoEvent

+ const JoinEvent

+ const JoinedEvent

+ const LeaveEvent

+ const LeftEvent

+ const NewPlayerEvent

+ const SpectateEvent

+ type InfoEventData struct

+ Players map[string]string

+ type JoinEventData struct

+ GameId string

+ Username string

+ type JoinedEventData struct

+ Secret string

+ type LeaveEventData struct

+ type LeftEventData struct

+ type NewPlayerEventData struct

+ Username string

+ type SpectateEventData struct

+ GameId string

v0.7.0

May 26, 2022

Changes in this version

type Socket

+ func (s *Socket) Once(event EventName, callback OnEventCallback) CallbackId

v0.6.1

May 23, 2022

Changes in this version

type Session

+ Path string

+ Username string

type Socket

+ func (s *Socket) Session() Session

v0.6.0

May 22, 2022

Changes in this version

type EventName

+ const EventSpectate

+ type EventSpectateData struct

+ GameId string

type Socket

+ func (s *Socket) Spectate(gameId string) error

v0.5.0

May 21, 2022

Changes in this version

+ const CGVersion

type EventConnectedData

+ Username string

type EventErrorData

+ Message string

type Socket

+ func (s *Socket) ResolveUsername(playerId string) string

+ func (s *Socket) RestoreSession(username string) error

v0.4.0

May 17, 2022

Changes in this version

+ var ErrClosed = errors.New("connection closed")

+ type EventWrapper struct

+ Event Event

+ Origin string

type Socket

+ func (s *Socket) NextEvent() (EventWrapper, bool, error)

+ func (s *Socket) RunEventLoop() error

+ func (s *Socket) Send(eventName EventName, eventData any) error

v0.3.1

May 14, 2022

v0.3.0

May 14, 2022

Changes in this version

+ type EventCreateData struct

+ Public bool

+ type EventCreatedData struct

+ GameId string

+ type EventInfoData struct

+ Players map[string]string

+ type EventJoinData struct

+ GameId string

+ Username string

+ type EventJoinedData struct

+ Secret string

+ type EventLeaveData struct

+ type EventLeftData struct

type EventName

+ const EventCreate

+ const EventCreated

+ const EventInfo

+ const EventJoin

+ const EventJoined

+ const EventLeave

+ const EventLeft

+ const EventNewPlayer

+ type EventNewPlayerData struct

+ Username string

v0.2.0

May 13, 2022

Changes in this version

+ var ErrDecodeFailed = errors.New("failed to decode event")

+ var ErrEncodeFailed = errors.New("failed to encode json object")

+ var ErrInvalidMessageType = errors.New("invalid message type")

+ func IsStandardEvent(eventName EventName) bool

+ type CallbackId uuid.UUID

+ type Event struct

+ Data json.RawMessage

+ Name EventName

+ func (e *Event) UnmarshalData(targetObjPtr interface{}) error

+ type EventConnectData struct

+ GameId string

+ PlayerId string

+ Secret string

+ type EventConnectedData struct

+ type EventCreateGameData struct

+ Public bool

+ type EventCreatedGameData struct

+ GameId string

+ type EventErrorData struct

+ Reason string

+ type EventGameInfoData struct

+ Players map[string]string

+ type EventJoinGameData struct

+ GameId string

+ Username string

+ type EventJoinedGameData struct

+ Username string

+ type EventLeaveGameData struct

+ type EventLeftGameData struct

+ type EventName string

+ const EventConnect

+ const EventConnected

+ const EventCreateGame

+ const EventCreatedGame

+ const EventError

+ const EventGameInfo

+ const EventJoinGame

+ const EventJoinedGame

+ const EventLeaveGame

+ const EventLeftGame

+ const EventPlayerSecret

+ type EventPlayerSecretData struct

+ Secret string

+ type OnEventCallback func(origin string, event Event)

+ type Session struct

+ GameId string

+ Name string

+ PlayerId string

+ PlayerSecret string

+ func RestoreSession(name string) (Session, error)

+ func (s Session) Remove() error

+ func (s Session) Save() error

+ type Socket struct

+ func NewSocket(game string, wsURL string) (*Socket, error)

+ func (s *Socket) Close() error

+ func (s *Socket) Connect(gameId, playerId, secret string) error

+ func (s *Socket) Create(public bool) (string, error)

+ func (s *Socket) Emit(eventName EventName, eventData interface{}) error

+ func (s *Socket) GetUser(playerId string) string

+ func (s *Socket) Join(gameId, username string) (Session, error)

+ func (s *Socket) Leave() error

+ func (s *Socket) Listen() error

+ func (s *Socket) On(event EventName, callback OnEventCallback) CallbackId

+ func (s *Socket) OnOnce(event EventName, callback OnEventCallback) CallbackId

+ func (s *Socket) RemoveCallback(id CallbackId)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL