xp

Documentation

Index

• Constants
• type AkSession
• type Data
• type MsgEmbed
• type System
  • func NewXpStore(mtx *sync.Mutex, s *dg.Session) *System
  • func (x *System) AutoSaveXP()
  • func (x *System) Execute(req []string, msg *dg.MessageCreate) (MsgEmbed, error)
  • func (x *System) LoadXP(file string) error
  • func (x *System) ManipulateXP(action string, msg *dg.MessageCreate)

Constants

const AutoRankFile string = "data/autoRanks.json"

AutoRankFile is the default file for loading and saving auto promote ranks

const XpFile string = "data/xp.json"

XpFile is the path where the xp data is saved.

Types

type AkSession

type AkSession interface {
	GuildMember(guildID string, userID string) (st *dg.Member, err error)
	GuildMembers(guildID string, after string, limit int) (st []*dg.Member, err error)
	GuildRoles(guildID string) (st []*dg.Role, err error)
	GuildMemberRoleAdd(guildID string, userID string, roleID string) (err error)
}

AkSession allows for tests to mock discordgo session method calls

type Data

type Data struct {
	Users map[string]float64 `json:"users"`
}

Data holds the experience gained by each user.

type MsgEmbed

type MsgEmbed *dg.MessageEmbed

MsgEmbed is used to shorten the name of the original embed type from discordGo

type System

type System struct {
	Data *Data
	// contains filtered or unexported fields
}

System holds all data needed to execute the functionality.

func NewXpStore

func NewXpStore(mtx *sync.Mutex, s *dg.Session) *System

NewXpStore creates the experience data storage map for the session

func (*System) AutoSaveXP

func (x *System) AutoSaveXP()

AutoSaveXP is launched by main.go before accepting new messages. Default time is coded to 5 minutes.

func (*System) Execute

func (x *System) Execute(req []string, msg *dg.MessageCreate) (MsgEmbed, error)

Execute is the method used to run the correct method based on user input.

func (*System) LoadXP

func (x *System) LoadXP(file string) error

LoadXP loads the saved xp data from the json file

func (*System) ManipulateXP

func (x *System) ManipulateXP(action string, msg *dg.MessageCreate)

ManipulateXP is used by any part of the program that needs to read or write data after startup.