command

package

v0.0.0-...-0e3aaa5 Latest Latest Go to latest Published: Oct 11, 2023 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/andrewstuart/gopip

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Command
type CommandType
- func (i CommandType) String() string
type Commander
- func (c *Commander) Execute(cmd CommandType, args ...any) (*Result, error)
type Result

Constants ¶

View Source

const (
	CommandTypeUseItem = CommandType(iota)
	CommandTypeDropItem
	CommandTypeSetFavorite
	CommandTypeToggleComponentFavorite
	CommandTypeSortInventory
	CommandTypeToggleQuest
	CommandTypeSetCustomMapMarker
	CommandTypeRemoveCustomMapMarker
	CommandTypeCheckFastTravel
	CommandTypeFastTravel
	CommandTypeMoveLocalMap
	CommandTypeZoomLocalMap
	CommandTypeToggleRadioStation
	CommandTypeRequestLocalMapSnapshot
	CommandTypeClearIdle
)

Well-known commands

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Command ¶

type Command struct {
	Type CommandType `json:"type"`
	Args []any       `json:"args"`
	ID   int         `json:"id"`
}

Command is the type for a Pip Boy fallout 4 command

type CommandType ¶

type CommandType int

CommandType is the type for the command.type

func (CommandType) String ¶

func (i CommandType) String() string

type Commander ¶

type Commander struct {
	W io.ReadWriter
	// contains filtered or unexported fields
}

Commander is an abstraction for writing commands

func (*Commander) Execute ¶

func (c *Commander) Execute(cmd CommandType, args ...any) (*Result, error)

Execute executes a command

type Result ¶

type Result struct {
	Allowed bool
	Success bool
	ID      int
	Message string
}

Result is the response for a command

Source Files ¶

View all Source files

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