akevitt

package module

Go to main page

Versions in this module

v0

v0.3.5

May 28, 2024

Changes in this version

type Exit

+ OnPreEnter func(*Akevitt, *ActiveSession) error

type Room

+ func (room *Room) Enter(engine *Akevitt, session *ActiveSession, targetExit *Exit) error

v0.3.4

May 27, 2024

Changes in this version

+ func FetchPluginUnsafe[T Plugin](engine *Akevitt) T

+ func FetchPlugin[T Plugin](engine *Akevitt) (*T, error)

+ func PurgeDeadSessions(engine *Akevitt, callback DeadSessionFunc)

type Account

+ PersistentData map[string]any

+ func (account *Account) GetName() string

type Akevitt

+ func (engine *Akevitt) AddCommand(command string, function CommandFunc)

+ func (engine *Akevitt) AddInit(fn func(*ActiveSession))

+ func (engine *Akevitt) GetOnDeadSession() DeadSessionFunc

+ func (engine *Akevitt) GetSessions() Sessions

+ type DatabasePlugin interface

+ LoadAll func() ([]T, error)

+ Save func(T) error

type Object

+ GetName func() string

+ type Pair struct

+ L TFirst

+ R TSecond

+ type Plugin interface

+ Build func(*Akevitt) error

v0.3.3

Feb 13, 2024

Changes in this version

+ func AppendText(message string, chatlog *logview.LogView)

+ func ErrorBox(message string, app *tview.Application, back tview.Primitive)

+ func FindByKey[TCollection, T comparable](collection []TCollection, selector func(key TCollection) T, value T) *TCollection

+ func FindNeighboringRoomByName(currentRoom *Room, name string) (*Room, *Exit, error)

+ func LoginScreen(engine *Akevitt, session *ActiveSession, nextScreen UIFunc) tview.Primitive

+ func OocCmd(engine *Akevitt, session *ActiveSession, command string) error

+ func RegistrationScreen(engine *Akevitt, session *ActiveSession, nextScreen UIFunc) tview.Primitive

+ func RemoveItemByIndex[T any](l []T, i int) []T

type ActiveSession

+ Account *Account

+ Application *tview.Application

+ Data map[string]any

type Akevitt

+ func (engine *Akevitt) Run() error

type Exit

+ Name string

+ Room *Room

type GameObject

+ GetName func() string

type Room

+ Exits []*Exit

+ Name string

+ Objects []GameObject

+ OnPreEnter func(*ActiveSession) error

v0.3.2

Aug 26, 2023

v0.3.1

Aug 26, 2023

v0.3.0

Aug 26, 2023

Changes in this version

+ func LogError(message string)

+ func LogInfo(message string)

+ func LogWarn(message string)

type Akevitt

+ func (engine *Akevitt) GlobalLookup(room Room, name string) []GameObject

v0.2.7

Aug 25, 2023

v0.2.4

Aug 25, 2023

v0.2.3

Aug 24, 2023

v0.2.2

Aug 24, 2023

Changes in this version

+ func BindRooms(room Room, otherRooms ...Room)

+ func CreateObject(engine *Akevitt, session ActiveSession, object T, params interface{}) (T, error)

+ func FilterByType(collection []TCollection) []T

+ func Find(collection []T, value T) bool

+ func FindObject(engine *Akevitt, session ActiveSession, key uint64) (T, error)

+ func LookupOfType(room Room) []T

+ func MapSlice(l []T, callback func(v T) TResult) []TResult

+ func RemoveItem(l []T, item T) []T

+ func Run(engine *Akevitt) error

+ func SaveObject(engine *Akevitt, obj T, category string, key uint64) error

+ type Account struct

+ Password string

+ Username string

+ func (account *Account) Save(engine *Akevitt) error

+ type ActiveSession interface

+ GetAccount func() *Account

+ GetApplication func() *tview.Application

+ SetAccount func(acc *Account)

+ SetApplication func(app *tview.Application)

+ type Akevitt struct

+ func NewEngine() *Akevitt

+ func (engine *Akevitt) Dialogue(dialogue *Dialogue, session ActiveSession) error

+ func (engine *Akevitt) ExecuteCommand(command string, session ActiveSession) error

+ func (engine *Akevitt) GenerateKey(gameobject GameObject) (uint64, error)

+ func (engine *Akevitt) GetCommands() []string

+ func (engine *Akevitt) GetRoom(key uint64) (Room, error)

+ func (engine *Akevitt) GetSpawnRoom() Room

+ func (engine *Akevitt) Login(username, password string, session ActiveSession) error

+ func (engine *Akevitt) Lookup(room Room) []GameObject

+ func (engine *Akevitt) Message(channel, message, username string, session ActiveSession) error

+ func (engine *Akevitt) Register(username, password string, session ActiveSession) error

+ func (engine *Akevitt) SaveGameObject(gameObject GameObject, key uint64, account *Account) error

+ func (engine *Akevitt) SaveObject(gameObject GameObject, key uint64) error

+ func (engine *Akevitt) SubscribeToHeartBeat(interval int, fn func()) error

+ func (engine *Akevitt) UseBind(bindAddress string) *Akevitt

+ func (engine *Akevitt) UseDBPath(path string) *Akevitt

+ func (engine *Akevitt) UseMouse() *Akevitt

+ func (engine *Akevitt) UseNewHeartbeat(interval int) *Akevitt

+ func (engine *Akevitt) UseOnDialogue(f DialogueFunc) *Akevitt

+ func (engine *Akevitt) UseOnMessage(f MessageFunc) *Akevitt

+ func (engine *Akevitt) UseOnSessionEnd(f DeadSessionFunc) *Akevitt

+ func (engine *Akevitt) UseRegisterCommand(command string, function CommandFunc) *Akevitt

+ func (engine *Akevitt) UseRootUI(uiFunc UIFunc) *Akevitt

+ func (engine *Akevitt) UseSpawnRoom(r Room) *Akevitt

+ type CommandFunc = func(engine *Akevitt, session ActiveSession, arguments string) error

+ type DeadSessionFunc = func(deadSession ActiveSession, liveSessions []ActiveSession, engine *Akevitt)

+ type Dialogue struct

+ func NewDialogue(title string) *Dialogue

+ func (dial *Dialogue) AddOption(title string, content tview.Primitive) *Dialogue

+ func (dial *Dialogue) End() *Dialogue

+ func (dial *Dialogue) GetContents() tview.Primitive

+ func (dial *Dialogue) GetOptions() []*Dialogue

+ func (dial *Dialogue) GetTitle() string

+ func (dial *Dialogue) Proceed(index int, session ActiveSession, engine *Akevitt) error

+ func (dial *Dialogue) SetContent(content tview.Primitive) *Dialogue

+ type DialogueFunc = func(engine *Akevitt, session ActiveSession, dialogue *Dialogue) error

+ type Exit interface

+ Enter func(engine *Akevitt, session ActiveSession) error

+ GetKey func() uint64

+ GetRoom func() Room

+ SetRoom func(room Room)

+ func IsRoomReachable(engine *Akevitt, session ActiveSession, roomKey uint64, currentRoomKey uint64) (Exit, error)

+ type GameObject interface

+ Create func(engine *Akevitt, session ActiveSession, params interface{}) error

+ type MessageFunc = func(engine *Akevitt, session ActiveSession, channel, message, username string) error

+ type NamedObject interface

+ GetDescription func() string

+ GetName func() string

+ type Object interface

+ Save func(engine *Akevitt) error

+ type Room interface

+ AddObjects func(objects ...GameObject)

+ GetExits func() []Exit

+ GetKey func() uint64

+ GetObjects func() []GameObject

+ OnCreate func()

+ RemoveObject func(object GameObject)

+ SetExits func(exits ...Exit)

+ type Sessions = map[ssh.Session]ActiveSession

+ type UIFunc = func(engine *Akevitt, session ActiveSession) tview.Primitive

v0.2.0

Aug 24, 2023

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