dicebot

Documentation

Overview

ダイスボットのインターフェースを定義するパッケージ。

Index

• type DiceBot
• type DiceBotBasicInfo
• type DiceBotConstructor
• type DiceBotImpl
  • func (b *DiceBotImpl) ExecuteCommand(_ string, _ *evaluator.Evaluator) (*command.Result, error)
  • func (d *DiceBotImpl) GameID() string
  • func (d *DiceBotImpl) GameName() string
  • func (d *DiceBotImpl) SortKey() string
  • func (d *DiceBotImpl) Usage() string

Types

type DiceBot

type DiceBot interface {
	// GameID はゲーム識別子を返す。
	GameID() string
	// GameName はゲームシステム名を返す。
	GameName() string
	// Usage はダイスボットの使用法の説明を返す。
	Usage() string
	// SortKey は並べ替え順のよみがなを返す。
	SortKey() string
	// ExecuteCommand は指定されたコマンドを実行する。
	ExecuteCommand(command string, ev *evaluator.Evaluator) (*command.Result, error)
}

ダイスボットのインターフェース。

type DiceBotBasicInfo

type DiceBotBasicInfo struct {
	// GameID はゲーム識別子。
	GameID string
	// GameName はゲームシステム名。
	GameName string
	// Usage はダイスボットの使用法の説明。
	Usage string
	// SortKey は並べ替え順のよみがな。
	SortKey string
}

DiceBotBasicInfo はダイスボットの基本情報を表す構造体。

type DiceBotConstructor

type DiceBotConstructor func() DiceBot

ダイスボットを構築する関数の型。

type DiceBotImpl

type DiceBotImpl struct {
	// BasicInfo はダイスボットの基本情報。
	BasicInfo *DiceBotBasicInfo
}

DiceBotImpl はダイスボットの実装のベースとなる構造体。

func (*DiceBotImpl) ExecuteCommand

func (b *DiceBotImpl) ExecuteCommand(
	_ string,
	_ *evaluator.Evaluator,
) (*command.Result, error)

ExecuteCommand は指定されたコマンドを実行する。

基本のダイスボットには特別なコマンドが存在しないため、必ずエラーを返す。

func (*DiceBotImpl) GameID

func (d *DiceBotImpl) GameID() string

GameID はゲーム識別子を返す。

func (*DiceBotImpl) GameName

func (d *DiceBotImpl) GameName() string

GameName はゲームシステム名を返す。

func (*DiceBotImpl) SortKey

func (d *DiceBotImpl) SortKey() string

SortKey は並べ替え順のよみがなを返す。

func (*DiceBotImpl) Usage

func (d *DiceBotImpl) Usage() string

Usage はダイスボットの使用法の説明を返す。