flfa

package

v0.0.0-...-8b058bf Latest Latest Go to latest Published: Apr 17, 2022 License: MIT Imports: 14 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/FlagrantGarden/flfa

Links

Open Source Insights

Documentation ¶

Index ¶

type Api
type Configuration
- func (config *Configuration) Initialize() error
type DataCache

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
data
state
player
skirmish
tui
company
company/prompts
editor
editor/prompts
group
group/prompts
player
player/prompts
prompts
traits/prompts

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