import Civ5Save from 'civ5save/src/Civ5Save.js'

public class | source

Civ5Save

A Civilization V save file object.

Static Method Summary

Static Public Methods
public static	async fromFile(saveFile: File): Civ5Save Create a Civ5Save object from a file.

Constructor Summary

Public Constructor
public	constructor(saveData: DataView) Create a Civ5Save object.

Member Summary

Public Members
public set	alwaysPeace: boolean Always peace.
public get	alwaysPeace: boolean Always peace.
public set	alwaysWar: boolean Always war.
public get	alwaysWar: boolean Always war.
public get	completeKills: boolean Complete kills.
public set	completeKills: boolean Complete kills.
public get	culturalVictory: boolean Cultural victory.
public set	culturalVictory: boolean Cultural victory.
public get	currentEra: string Current era.
public get	currentTurn: number Current turn.
public get	difficulty: string Game difficulty.
public set	diplomaticVictory: boolean Diplomatic victory.
public get	diplomaticVictory: boolean Diplomatic victory.
public get	dominationVictory: boolean Domination victory.
public set	dominationVictory: boolean Domination victory.
public get	enabledDLC: Array List of enabled DLC.
public get	enabledMods: Array List of enabled mods.
public get	gameBuild: string Game build number.
public get	gameMode: string \| undefined Game mode: one of `Civ5Save.GAME_MODES.SINGLE`, `Civ5Save.GAME_MODES.MULTI`, or `Civ5Save.GAME_MODES.HOTSEAT`.
public get	gamePace: string Game pace.
public get	gameVersion: string \| undefined Game version.
public get	lockMods: boolean Lock mods.
public set	lockMods: boolean Lock mods.
public get	mapFile: string Map file.
public get	mapSize: string Map size.
public set	maxTurns: number Max turns.
public get	maxTurns: number Max turns.
public set	newRandomSeed: boolean New random seed.
public get	newRandomSeed: boolean New random seed.
public set	noBarbarians: boolean No barbarians.
public get	noBarbarians: boolean No barbarians.
public set	noChangingWarPeace: boolean No changing war or peace.
public get	noChangingWarPeace: boolean No changing war or peace.
public set	noCityRazing: boolean No city razing.
public get	noCityRazing: boolean No city razing.
public get	noCultureOverviewUI: boolean No cultural overview UI.
public set	noCultureOverviewUI: boolean No cultural overview UI.
public set	noEspionage: boolean No espionage.
public get	noEspionage: boolean No espionage.
public set	noHappiness: boolean No happiness.
public get	noHappiness: boolean No happiness.
public get	noPolicies: boolean No policies.
public set	noPolicies: boolean No policies.
public get	noReligion: boolean No religion.
public set	noReligion: boolean No religion.
public set	noScience: boolean No science.
public get	noScience: boolean No science.
public set	noWorldCongress: boolean No world congress.
public get	noWorldCongress: boolean No world congress.
public set	oneCityChallenge: boolean One-city challenge.
public get	oneCityChallenge: boolean One-city challenge.
public get	pitboss: boolean Pitboss.
public set	pitboss: boolean Pitboss.
public get	players: Array<{civilization: string\|undefined, status: number}> List of players as objects with their civilization and status as properties.
public get	policySaving: boolean Policy saving.
public set	policySaving: boolean Policy saving.
public set	privateGame: boolean Private setting for multiplayer games.
public get	privateGame: boolean Private setting for multiplayer games.
public set	promotionSaving: boolean Promotion saving.
public get	promotionSaving: boolean Promotion saving.
public set	ragingBarbarians: boolean Raging barbarians.
public get	ragingBarbarians: boolean Raging barbarians.
public get	randomPersonalities: boolean Random personalities.
public set	randomPersonalities: boolean Random personalities.
public get	scienceVictory: boolean Science victory.
public set	scienceVictory: boolean Science victory.
public get	startingEra: string Starting era.
public get	timeVictory: boolean Time victory.
public set	timeVictory: boolean Time victory.
public get	turnMode: string Turn mode: one of `Civ5Save.TURN_MODES.HYBRID`, `Civ5Save.TURN_MODES.SEQUENTIAL`, or `Civ5Save.TURN_MODES.SIMULTANEOUS`.
public set	turnMode: string Turn mode: one of `Civ5Save.TURN_MODES.HYBRID`, `Civ5Save.TURN_MODES.SEQUENTIAL`, or `Civ5Save.TURN_MODES.SIMULTANEOUS`.
public get	turnTimerEnabled: boolean Turn timer enabled.
public set	turnTimerEnabled: boolean Turn timer enabled.
public get	turnTimerLength: number Turn timer length for multiplayer games.
public set	turnTimerLength: number Turn timer length for multiplayer games.

Method Summary

Public Methods
public	toBlob(): Blob Write Civ5Save object to a blob.

Static Public Methods

public static async fromFile(saveFile: File): Civ5Save source

Create a Civ5Save object from a file.

Reading data from a file needs to be done asynchronously; since the constructor cannot be async, this static factory is provided as an alternative way to instantiate a Civ5Save object from a file (https://stackoverflow.com/a/24686979/399105).

Params:

Name	Type	Attribute	Description
saveFile	File		A Civilization V save file.

Return:

Civ5Save

A Civ5Save object.

Throw:

InvalidSignatureError	Invalid file signature.
ParseError	Error while parsing the save file.

Example:

try {
  let save = await Civ5Save.fromFile(saveFile);
  ...

Public Constructors

public constructor(saveData: DataView) source

Create a Civ5Save object.

As an alternative, a static factory method is available for more convenient instantiation from a file: fromFile

Params:

Name	Type	Attribute	Description
saveData	DataView		The save file contents.

Throw:

InvalidSignatureError	Invalid file signature.
ParseError	Error while parsing the save file.

Public Members

public set alwaysPeace: boolean source

Always peace.

public get alwaysPeace: boolean source

Always peace.

Throw:

ParseError

Error while parsing the save file.

public set alwaysWar: boolean source

Always war.

public get alwaysWar: boolean source

Always war.

Throw:

ParseError

Error while parsing the save file.

public get completeKills: boolean source

Complete kills.

Throw:

ParseError

Error while parsing the save file.

public set completeKills: boolean source

Complete kills.

public get culturalVictory: boolean source

Cultural victory.

Throw:

ParseError

Error while parsing the save file.

public set culturalVictory: boolean source

Cultural victory.

public get currentEra: string source

Current era.

Throw:

ParseError

Error while parsing the save file.

public get currentTurn: number source

Current turn.

Throw:

ParseError

Error while parsing the save file.

public get difficulty: string source

Game difficulty.

Throw:

ParseError

Error while parsing the save file.

public set diplomaticVictory: boolean source

Diplomatic victory.

public get diplomaticVictory: boolean source

Diplomatic victory.

Throw:

ParseError

Error while parsing the save file.

public get dominationVictory: boolean source

Domination victory.

Throw:

ParseError

Error while parsing the save file.

public set dominationVictory: boolean source

Domination victory.

public get enabledDLC: Array source

List of enabled DLC.

Throw:

ParseError

Error while parsing the save file.

public get enabledMods: Array source

List of enabled mods.

Throw:

ParseError

Error while parsing the save file.

public get gameBuild: string source

Game build number.

Note that for games created or saved before build 230620, this will return the game build that was used to create the save file. Starting with build 230620, this will return the game build that was last used to save the save file.

Throw:

ParseError

Error while parsing the save file.

public get gameMode: string | undefined source

Game mode: one of Civ5Save.GAME_MODES.SINGLE, Civ5Save.GAME_MODES.MULTI, or Civ5Save.GAME_MODES.HOTSEAT.

Note that this will be undefined if gameBuild is less than 230620 because the meaning of its value is unknown. undefined is used instead of null because null might incorrectly imply the value is empty.

Throw:

ParseError

Error while parsing the save file.

public get gamePace: string source

Game pace.

Throw:

ParseError

Error while parsing the save file.

public get gameVersion: string | undefined source

Game version.

Note that this will be undefined if gameBuild is less than 230620. undefined is used instead of null because older save files do not have a spot for this information (null might incorrectly imply the spot is there but empty).

Throw:

ParseError

Error while parsing the save file.

public get lockMods: boolean source

Lock mods.

Throw:

ParseError

Error while parsing the save file.

public set lockMods: boolean source

Lock mods.

public get mapFile: string source

Map file.

Throw:

ParseError

Error while parsing the save file.

public get mapSize: string source

Map size.

Throw:

ParseError

Error while parsing the save file.

public set maxTurns: number source

Max turns.

public get maxTurns: number source

Max turns.

Throw:

ParseError

Error while parsing the save file.

public set newRandomSeed: boolean source

New random seed.

public get newRandomSeed: boolean source

New random seed.

Throw:

ParseError

Error while parsing the save file.

public set noBarbarians: boolean source

No barbarians.

public get noBarbarians: boolean source

No barbarians.

Throw:

ParseError

Error while parsing the save file.

public set noChangingWarPeace: boolean source

No changing war or peace.

public get noChangingWarPeace: boolean source

No changing war or peace.

Throw:

ParseError

Error while parsing the save file.

public set noCityRazing: boolean source

No city razing.

public get noCityRazing: boolean source

No city razing.

Throw:

ParseError

Error while parsing the save file.

public get noCultureOverviewUI: boolean source

No cultural overview UI.

Throw:

ParseError

Error while parsing the save file.

public set noCultureOverviewUI: boolean source

No cultural overview UI.

public set noEspionage: boolean source

No espionage.

public get noEspionage: boolean source

No espionage.

Throw:

ParseError

Error while parsing the save file.

public set noHappiness: boolean source

No happiness.

public get noHappiness: boolean source

No happiness.

Throw:

ParseError

Error while parsing the save file.

public get noPolicies: boolean source

No policies.

Throw:

ParseError

Error while parsing the save file.

public set noPolicies: boolean source

No policies.

public get noReligion: boolean source

No religion.

Throw:

ParseError

Error while parsing the save file.

public set noReligion: boolean source

No religion.

public set noScience: boolean source

No science.

public get noScience: boolean source

No science.

Throw:

ParseError

Error while parsing the save file.

public set noWorldCongress: boolean source

No world congress.

public get noWorldCongress: boolean source

No world congress.

Throw:

ParseError

Error while parsing the save file.

public set oneCityChallenge: boolean source

One-city challenge.

public get oneCityChallenge: boolean source

One-city challenge.

Throw:

ParseError

Error while parsing the save file.

public get pitboss: boolean source

Pitboss.

Throw:

ParseError

Error while parsing the save file.

See:

https://github.com/Bownairo/Civ5SaveEditor

public set pitboss: boolean source

Pitboss.

See:

https://github.com/Bownairo/Civ5SaveEditor

public get players: Array<{civilization: string|undefined, status: number}> source

List of players as objects with their civilization and status as properties.

Civilization will be undefined if gameBuild is less than 310700.

Status is one of Civ5Save.PLAYER_STATUSES.AI, Civ5Save.PLAYER_STATUSES.DEAD, Civ5Save.PLAYER_STATUSES.HUMAN, Civ5Save.PLAYER_STATUSES.NONE.

Throw:

ParseError

Error while parsing the save file.

public get policySaving: boolean source

Policy saving.

Throw:

ParseError

Error while parsing the save file.

public set policySaving: boolean source

Policy saving.

public set privateGame: boolean source

Private setting for multiplayer games.

public get privateGame: boolean source

Private setting for multiplayer games.

Note that this will be undefined if gameBuild is less than 310700 because it isn't implemented. undefined is used instead of null because null might incorrectly imply the value is empty.

Throw:

ParseError

Error while parsing the save file.

public set promotionSaving: boolean source

Promotion saving.

public get promotionSaving: boolean source

Promotion saving.

Throw:

ParseError

Error while parsing the save file.

public set ragingBarbarians: boolean source

Raging barbarians.

public get ragingBarbarians: boolean source

Raging barbarians.

Throw:

ParseError

Error while parsing the save file.

public get randomPersonalities: boolean source

Random personalities.

Throw:

ParseError

Error while parsing the save file.

public set randomPersonalities: boolean source

Random personalities.

public get scienceVictory: boolean source

Science victory.

Throw:

ParseError

Error while parsing the save file.

public set scienceVictory: boolean source

Science victory.

public get startingEra: string source

Starting era.

Throw:

ParseError

Error while parsing the save file.

public get timeVictory: boolean source

Time victory.

Throw:

ParseError

Error while parsing the save file.

public set timeVictory: boolean source

Time victory.

public get turnMode: string source

Turn mode: one of Civ5Save.TURN_MODES.HYBRID, Civ5Save.TURN_MODES.SEQUENTIAL, or Civ5Save.TURN_MODES.SIMULTANEOUS.

Throw:

ParseError

Error while parsing the save file.

See:

http://blog.frank-mich.com/civilization-v-how-to-change-turn-type-of-a-started-game/

public set turnMode: string source

Turn mode: one of Civ5Save.TURN_MODES.HYBRID, Civ5Save.TURN_MODES.SEQUENTIAL, or Civ5Save.TURN_MODES.SIMULTANEOUS.

See:

http://blog.frank-mich.com/civilization-v-how-to-change-turn-type-of-a-started-game/

public get turnTimerEnabled: boolean source

Turn timer enabled.

Throw:

ParseError

Error while parsing the save file.

public set turnTimerEnabled: boolean source

Turn timer enabled.

public get turnTimerLength: number source

Turn timer length for multiplayer games. If pitboss is enabled, this value represents turn timer in hours. Otherwise, it is in minutes.

Throw:

ParseError

Error while parsing the save file.

public set turnTimerLength: number source

Turn timer length for multiplayer games. If pitboss is enabled, this value represents turn timer in hours. Otherwise, it is in minutes.

Public Methods

public toBlob(): Blob source

Write Civ5Save object to a blob.

Return:

Blob	The save file with any changes.

Example:

let downloadURL = window.URL.createObjectURL(save.toBlob());