Skip to content
ArchmageDocs

ConfigAtlas

Variables

Section titled “Variables”
var (
    // GetConfigAtlas returns the active ConfigAtlas. It must be set before
    // calling any XxxCfgId.Cfg.
    GetConfigAtlas func() *ConfigAtlas
)

Types

Section titled “Types”

ConfigAtlas

Section titled “ConfigAtlas”

ConfigAtlas holds all game configuration tables and provides cross-table reference binding.

Implements archmage.Atlas.

type ConfigAtlas struct {
    AtlasExtension


    // DataVersion is the version info of the config repo at export time.
    DataVersion *archmage.VersionInfo


    // One field per config type.
    // ...
}

NewConfigAtlas

Section titled “NewConfigAtlas”
func NewConfigAtlas() *ConfigAtlas

AtlasItems

Section titled “AtlasItems”

AtlasItems returns the internal map of config-name to AtlasItem.

func (atlas *ConfigAtlas) AtlasItems() map[string]*AtlasItem

BindRefs

Section titled “BindRefs”

BindRefs is for internal use only.

func (atlas *ConfigAtlas) BindRefs()

OnLoaded

Section titled “OnLoaded”

OnLoaded is called after all config data has been loaded and refs bound. It delegates to AtlasExtension.OnLoaded. For internal use only.

func (atlas *ConfigAtlas) OnLoaded() error

SetDataVersion

Section titled “SetDataVersion”

SetDataVersion is for internal use only.

func (atlas *ConfigAtlas) SetDataVersion(v *archmage.VersionInfo)