commands

Documentation

Overview

Package commands provides GCI command entrypoints other than voice commands.

Index

• type ChatListener
  • func NewChatListener(coalition secoalition.Coalition, callsign string, ...) *ChatListener
  • func (l *ChatListener) Run(ctx context.Context, messages chan<- Request)
• type Request

Types

type ChatListener

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

ChatListener listens for commands from the in-game chat.

func NewChatListener

func NewChatListener(
	coalition secoalition.Coalition,
	callsign string,
	missionClient mission.MissionServiceClient,
	coalitionClient grpccoalition.CoalitionServiceClient,
	netClient net.NetServiceClient,
) *ChatListener

NewChatListener creates a new ChatListener.

func (*ChatListener) Run

func (l *ChatListener) Run(ctx context.Context, messages chan<- Request)

Run monitors the in-game chat for commands.

type Request

type Request struct {
	// TraceID of the request.
	TraceID string
	// PlayerName is the name of the player that sent the message.
	PlayerName string
	// Text message.
	Text string
}

Request is an envelope containing a trace ID, player name and text message.