flfa

Documentation

Index

• type Api
  • func (ffapi *Api) CacheCompanies(modulePath string, embedded bool)
  • func (ffapi *Api) CacheModuleData(modulePath string, embedded bool)
  • func (ffapi *Api) CachePlayers(cachePath string)
  • func (ffapi *Api) CacheProfiles(modulePath string, embedded bool)
  • func (ffapi *Api) CacheRosters(modulePath string, embedded bool)
  • func (ffapi *Api) CacheScriptLibraries(modulePath string, embedded bool)
  • func (ffapi *Api) CacheScriptModules(modulePath string, embedded bool)
  • func (ffapi *Api) CacheSpells(modulePath string, embedded bool)
  • func (ffapi *Api) CacheTraits(modulePath string, embedded bool)
  • func (ffapi *Api) CachingFs(embedded bool) *afero.Afero
  • func (ffapi *Api) GetActiveSkirmish(activeUserPersona *persona.Persona[player.Data, player.Settings], ...) (*instance.Instance[skirmish.Skirmish], error)
  • func (ffapi *Api) GetPlayer(name string, cachePath string) (foundPlayer player.Player, err error)
  • func (ffapi *Api) InitializeEngine()
  • func (ffapi *Api) InitializeGameState() error
  • func (ffapi *Api) InstalledModules() (installedModules []string, err error)
• type Configuration
  • func (config *Configuration) Initialize() error
• type DataCache

Types

type Api

type Api struct {
	Tympan       *tympan.Tympan[*Configuration]
	EMFS         *embed.FS
	Cache        DataCache
	ScriptEngine *scripting.Engine
}

func (*Api) CacheCompanies

func (ffapi *Api) CacheCompanies(modulePath string, embedded bool)

func (*Api) CacheModuleData

func (ffapi *Api) CacheModuleData(modulePath string, embedded bool)

func (*Api) CachePlayers

func (ffapi *Api) CachePlayers(cachePath string)

func (*Api) CacheProfiles

func (ffapi *Api) CacheProfiles(modulePath string, embedded bool)

func (*Api) CacheRosters

func (ffapi *Api) CacheRosters(modulePath string, embedded bool)

func (*Api) CacheScriptLibraries

func (ffapi *Api) CacheScriptLibraries(modulePath string, embedded bool)

func (*Api) CacheScriptModules

func (ffapi *Api) CacheScriptModules(modulePath string, embedded bool)

func (*Api) CacheSpells

func (ffapi *Api) CacheSpells(modulePath string, embedded bool)

func (*Api) CacheTraits

func (ffapi *Api) CacheTraits(modulePath string, embedded bool)

func (*Api) CachingFs

func (ffapi *Api) CachingFs(embedded bool) *afero.Afero

func (*Api) GetActiveSkirmish

func (ffapi *Api) GetActiveSkirmish(activeUserPersona *persona.Persona[player.Data, player.Settings], cachePath string) (*instance.Instance[skirmish.Skirmish], error)

func (*Api) GetPlayer

func (ffapi *Api) GetPlayer(name string, cachePath string) (foundPlayer player.Player, err error)

func (*Api) InitializeEngine

func (ffapi *Api) InitializeEngine()

func (*Api) InitializeGameState

func (ffapi *Api) InitializeGameState() error

func (*Api) InstalledModules

func (ffapi *Api) InstalledModules() (installedModules []string, err error)

type Configuration

type Configuration struct {
	tympan.SharedConfig `mapstructure:",squash" tympanconfig:"ignore"`
	ActiveUserPersona   string `mapstructure:"active_user_persona"`
}

func (*Configuration) Initialize

func (config *Configuration) Initialize() error

type DataCache

type DataCache struct {
	Traits          []data.Trait
	Profiles        []data.Profile
	Spells          []data.Spell
	Companies       []data.Company
	Players         []player.Player
	ScriptModules   []scripting.Module
	ScriptLibraries []scripting.Library
}