bf2

Documentation

Overview

Methods for working specifically with Battlefield 2 configuration files (.con)

Index

• Constants
• func GetDefaultProfileKey(h game.Handler) (string, error)
• func GetDefaultProfileProfileCon(h game.Handler) (*config.Config, error)
• func GetEncryptedLogin(profileCon *config.Config) (string, string, error)
• func GetProfiles(h game.Handler) ([]game.Profile, error)
• func MarkAllVoiceOverHelpAsPlayed(generalCon *config.Config)
• func PurgeLogoCache(h game.Handler) error
• func PurgeOldDemoBookmarks(demoBookmarksCon *config.Config, reference time.Time, maxAge time.Duration)
• func PurgeServerFavorites(generalCon *config.Config)
• func PurgeServerHistory(generalCon *config.Config)
• func PurgeShaderCache(h game.Handler) error
• func ReadProfileConfigFile(h game.Handler, profileKey string, configFile ProfileConfigFile) (*config.Config, error)
• func SetDefaultProfile(globalCon *config.Config, profileKey string)
• type ProfileConfigFile

Constants

const (
	ProfileConfigFileAudioCon          ProfileConfigFile = "Audio.con"
	ProfileConfigFileControlsCon       ProfileConfigFile = "Controls.con"
	ProfileConfigFileDemoBookmarksCon  ProfileConfigFile = "DemoBookmarks.con"
	ProfileConfigFileGeneralCon        ProfileConfigFile = "General.con"
	ProfileConfigFileHapticCon         ProfileConfigFile = "Haptic.con"
	ProfileConfigFileMapListCon        ProfileConfigFile = "mapList.con"
	ProfileConfigFileProfileCon        ProfileConfigFile = "Profile.con"
	ProfileConfigFileServerSettingsCon ProfileConfigFile = "ServerSettings.con"
	ProfileConfigFileVideoCon          ProfileConfigFile = "Video.con"

	DefaultProfileKey = "Default"

	GlobalConKeyDefaultProfileRef = "GlobalSettings.setDefaultUser"

	ProfileConKeyName        = "LocalProfile.setName"
	ProfileConKeyNick        = "LocalProfile.setNick"
	ProfileConKeyGamespyNick = "LocalProfile.setGamespyNick"
	ProfileConKeyEmail       = "LocalProfile.setEmail"
	ProfileConKeyPassword    = "LocalProfile.setPassword"

	GeneralConKeyServerHistory       = "GeneralSettings.addServerHistory"
	GeneralConKeyFavoriteServer      = "GeneralSettings.addFavouriteServer"
	GeneralConKeyVoiceOverHelpPlayed = "GeneralSettings.setPlayedVOHelp"

	DemoBookmarksConKeyDemoBookmark = "LocalProfile.addDemoBookmark"
)

Functions

func GetDefaultProfileKey

func GetDefaultProfileKey(h game.Handler) (string, error)

Get the default profile's key by reading and parsing the Battlefield 2 Global.con file

func GetDefaultProfileProfileCon

func GetDefaultProfileProfileCon(h game.Handler) (*config.Config, error)

Read and parse the Battlefield 2 Profile.con file for the current default profile

func GetEncryptedLogin

func GetEncryptedLogin(profileCon *config.Config) (string, string, error)

Extract profile name and encrypted password from a parsed Battlefield 2 Profile.con file

func GetProfiles

func GetProfiles(h game.Handler) ([]game.Profile, error)

func MarkAllVoiceOverHelpAsPlayed

func MarkAllVoiceOverHelpAsPlayed(generalCon *config.Config)

Add all voice over help lines as played (GeneralSettings.setPlayedVOHelp) in given General.con config

func PurgeLogoCache

func PurgeLogoCache(h game.Handler) error

func PurgeOldDemoBookmarks

func PurgeOldDemoBookmarks(demoBookmarksCon *config.Config, reference time.Time, maxAge time.Duration)

Remove all demo bookmarks older than the given duration (actual age is calculated based on the given reference)

func PurgeServerFavorites

func PurgeServerFavorites(generalCon *config.Config)

func PurgeServerHistory

func PurgeServerHistory(generalCon *config.Config)

Remove all server history entries (GeneralSettings.addServerHistory) from given General.con config

func PurgeShaderCache

func PurgeShaderCache(h game.Handler) error

func ReadProfileConfigFile

func ReadProfileConfigFile(h game.Handler, profileKey string, configFile ProfileConfigFile) (*config.Config, error)

Read a config file from the given Battlefield 2 profile

func SetDefaultProfile

func SetDefaultProfile(globalCon *config.Config, profileKey string)

Types

type ProfileConfigFile

type ProfileConfigFile string