Module content.gui.menu.savegame_react_util🔗

 
global record SavegameReactUtil  
record SavegameCardParams    saveGame: SaveGroup
    saveGameNamespace: string
    mapEditor: boolean
    mapNewGame: boolean
    builtinSavegame: boolean
    builtinMap: boolean
    onClickMain: function(SaveGameData, SaveGameId)
    onClickDetails: function(SaveGameData, SaveGameId)
    onDoubleClickMain: function(SaveGameData, SaveGameId)
    save: boolean
    extraClass: string
    calloutContainerRef: ReactRefWrapApi0<CalloutApi>
    commonParams: CommonMenuParams
end

  
record SavegameFiltersParam    
enum SortMode      "Date"
      "Name"
end

    sortMode: SortMode
    setSortMode: function(SortMode)
    filterText: string
    setFilterText: function(string)
end

  
record SelectedSavegame    saveGroup: GroupId
    savegameData: SaveGameData
    initialData: SaveGameData
    index: integer
end

  
record SavegameCardSelectParams    selectedSavegame: SelectedSavegame
    saveNameSpace: string
    map: boolean
    inPauseMenu: boolean
    commonParams: CommonMenuParams
    onDelete: function()
end

  
record AchievementListParam    cardMode: boolean
end

  makeModIdList: function({string}): {Mod.ModId}
  makeModStringList: function({Mod.ModId}): {string}
  groupSaves: function({SaveGameInfo}, string, string, SavegameFiltersParam.SortMode, boolean, SaveGameType): {SaveGroup}
  getSaveGroupAndType: function(string): string, SaveGameType, string, string
  
enum ErrorType    "CannotLoad"
    "ModMissing"
    "UnsupportedMapDimension"
end

  checkForError: function(SaveGameData): {ErrorType}, string
  SavegameCard: Recipe<SavegameCardParams>
  SavegameFilters: Recipe<SavegameFiltersParam>
  SavegameSelectCard: Recipe<SavegameCardSelectParams>
  SavegameStorageBar: Recipe0
  
record LoadPreviewParam    saveGameData: SaveGameData
    saveGameId: SaveGameId
end

  LoadPreview: Recipe<LoadPreviewParam>
  ScrollableAchievementsList: Recipe<AchievementListParam>
  ScrollableAchievementsCardList: Recipe0
  
record CampaignInfo    
record MissionInfo      name: string
      desc: MissionDesc
      enabled: boolean
end

    missionInfo: {MissionInfo}
    desc: CampaignDesc
    highestUnlocked: integer
end

  getCampaignInfoSorted: function(ResName): CampaignInfo
end

Category: globals🔗

SavegameReactUtil🔗

 
global record SavegameReactUtil  
record SavegameCardParams    saveGame: SaveGroup
    saveGameNamespace: string
    mapEditor: boolean
    mapNewGame: boolean
    builtinSavegame: boolean
    builtinMap: boolean
    onClickMain: function(SaveGameData, SaveGameId)
    onClickDetails: function(SaveGameData, SaveGameId)
    onDoubleClickMain: function(SaveGameData, SaveGameId)
    save: boolean
    extraClass: string
    calloutContainerRef: ReactRefWrapApi0<CalloutApi>
    commonParams: CommonMenuParams
end

  
record SavegameFiltersParam    
enum SortMode      "Date"
      "Name"
end

    sortMode: SortMode
    setSortMode: function(SortMode)
    filterText: string
    setFilterText: function(string)
end

  
record SelectedSavegame    saveGroup: GroupId
    savegameData: SaveGameData
    initialData: SaveGameData
    index: integer
end

  
record SavegameCardSelectParams    selectedSavegame: SelectedSavegame
    saveNameSpace: string
    map: boolean
    inPauseMenu: boolean
    commonParams: CommonMenuParams
    onDelete: function()
end

  
record AchievementListParam    cardMode: boolean
end

  makeModIdList: function({string}): {Mod.ModId}
  makeModStringList: function({Mod.ModId}): {string}
  groupSaves: function({SaveGameInfo}, string, string, SavegameFiltersParam.SortMode, boolean, SaveGameType): {SaveGroup}
  getSaveGroupAndType: function(string): string, SaveGameType, string, string
  
enum ErrorType    "CannotLoad"
    "ModMissing"
    "UnsupportedMapDimension"
end

  checkForError: function(SaveGameData): {ErrorType}, string
  SavegameCard: Recipe<SavegameCardParams>
  SavegameFilters: Recipe<SavegameFiltersParam>
  SavegameSelectCard: Recipe<SavegameCardSelectParams>
  SavegameStorageBar: Recipe0
  
record LoadPreviewParam    saveGameData: SaveGameData
    saveGameId: SaveGameId
end

  LoadPreview: Recipe<LoadPreviewParam>
  ScrollableAchievementsList: Recipe<AchievementListParam>
  ScrollableAchievementsCardList: Recipe0
  
record CampaignInfo    
record MissionInfo      name: string
      desc: MissionDesc
      enabled: boolean
end

    missionInfo: {MissionInfo}
    desc: CampaignDesc
    highestUnlocked: integer
end

  getCampaignInfoSorted: function(ResName): CampaignInfo
end

SavegameReactUtil.SavegameCardParams🔗

record SavegameReactUtil.SavegameCardParams  saveGame: SaveGroup
  saveGameNamespace: string
  mapEditor: boolean
  mapNewGame: boolean
  builtinSavegame: boolean
  builtinMap: boolean
  onClickMain: function(SaveGameData, SaveGameId)
  onClickDetails: function(SaveGameData, SaveGameId)
  onDoubleClickMain: function(SaveGameData, SaveGameId)
  save: boolean
  extraClass: string
  calloutContainerRef: ReactRefWrapApi0<CalloutApi>
  commonParams: CommonMenuParams
end

SavegameReactUtil.SavegameCardParams.saveGame🔗

SavegameReactUtil.SavegameCardParams.saveGame: SaveGroup

SavegameReactUtil.SavegameCardParams.saveGameNamespace🔗

SavegameReactUtil.SavegameCardParams.saveGameNamespace: string

SavegameReactUtil.SavegameCardParams.mapEditor🔗

SavegameReactUtil.SavegameCardParams.mapEditor: boolean

SavegameReactUtil.SavegameCardParams.mapNewGame🔗

SavegameReactUtil.SavegameCardParams.mapNewGame: boolean

SavegameReactUtil.SavegameCardParams.builtinSavegame🔗

SavegameReactUtil.SavegameCardParams.builtinSavegame: boolean

SavegameReactUtil.SavegameCardParams.builtinMap🔗

SavegameReactUtil.SavegameCardParams.builtinMap: boolean

SavegameReactUtil.SavegameCardParams.onClickMain🔗

function SavegameReactUtil.SavegameCardParams.onClickMain(SaveGameData, SaveGameId)
Parameters
  • SaveGameData
  • SaveGameId

SavegameReactUtil.SavegameCardParams.onClickDetails🔗

function SavegameReactUtil.SavegameCardParams.onClickDetails(SaveGameData, SaveGameId)
Parameters
  • SaveGameData
  • SaveGameId

SavegameReactUtil.SavegameCardParams.onDoubleClickMain🔗

function SavegameReactUtil.SavegameCardParams.onDoubleClickMain(SaveGameData, SaveGameId)
Parameters
  • SaveGameData
  • SaveGameId

SavegameReactUtil.SavegameCardParams.save🔗

SavegameReactUtil.SavegameCardParams.save: boolean

SavegameReactUtil.SavegameCardParams.extraClass🔗

SavegameReactUtil.SavegameCardParams.extraClass: string

SavegameReactUtil.SavegameCardParams.calloutContainerRef🔗

SavegameReactUtil.SavegameCardParams.calloutContainerRef: ReactRefWrapApi0<CalloutApi>

SavegameReactUtil.SavegameCardParams.commonParams🔗

SavegameReactUtil.SavegameCardParams.commonParams: CommonMenuParams

SavegameReactUtil.SavegameFiltersParam🔗

 
record SavegameReactUtil.SavegameFiltersParam  
enum SortMode    "Date"
    "Name"
end

  sortMode: SortMode
  setSortMode: function(SortMode)
  filterText: string
  setFilterText: function(string)
end

SavegameReactUtil.SavegameFiltersParam.SortMode🔗

enum SavegameReactUtil.SavegameFiltersParam.SortMode  "Date"
  "Name"
end

SavegameReactUtil.SavegameFiltersParam.SortMode."Date"🔗

SavegameReactUtil.SavegameFiltersParam.SortMode."Name"🔗

SavegameReactUtil.SavegameFiltersParam.sortMode🔗

SavegameReactUtil.SavegameFiltersParam.sortMode: SortMode

SavegameReactUtil.SavegameFiltersParam.setSortMode🔗

function SavegameReactUtil.SavegameFiltersParam.setSortMode(SortMode)
Parameters
  • SortMode

SavegameReactUtil.SavegameFiltersParam.filterText🔗

SavegameReactUtil.SavegameFiltersParam.filterText: string

SavegameReactUtil.SavegameFiltersParam.setFilterText🔗

function SavegameReactUtil.SavegameFiltersParam.setFilterText(string)
Parameters
  • string

SavegameReactUtil.SelectedSavegame🔗

record SavegameReactUtil.SelectedSavegame  saveGroup: GroupId
  savegameData: SaveGameData
  initialData: SaveGameData
  index: integer
end

SavegameReactUtil.SelectedSavegame.saveGroup🔗

SavegameReactUtil.SelectedSavegame.saveGroup: GroupId

SavegameReactUtil.SelectedSavegame.savegameData🔗

SavegameReactUtil.SelectedSavegame.savegameData: SaveGameData

SavegameReactUtil.SelectedSavegame.initialData🔗

SavegameReactUtil.SelectedSavegame.initialData: SaveGameData

SavegameReactUtil.SelectedSavegame.index🔗

SavegameReactUtil.SelectedSavegame.index: integer

SavegameReactUtil.SavegameCardSelectParams🔗

record SavegameReactUtil.SavegameCardSelectParams  selectedSavegame: SelectedSavegame
  saveNameSpace: string
  map: boolean
  inPauseMenu: boolean
  commonParams: CommonMenuParams
  onDelete: function()
end

SavegameReactUtil.SavegameCardSelectParams.selectedSavegame🔗

SavegameReactUtil.SavegameCardSelectParams.selectedSavegame: SelectedSavegame

SavegameReactUtil.SavegameCardSelectParams.saveNameSpace🔗

SavegameReactUtil.SavegameCardSelectParams.saveNameSpace: string

SavegameReactUtil.SavegameCardSelectParams.map🔗

SavegameReactUtil.SavegameCardSelectParams.map: boolean

SavegameReactUtil.SavegameCardSelectParams.inPauseMenu🔗

SavegameReactUtil.SavegameCardSelectParams.inPauseMenu: boolean

SavegameReactUtil.SavegameCardSelectParams.commonParams🔗

SavegameReactUtil.SavegameCardSelectParams.commonParams: CommonMenuParams

SavegameReactUtil.SavegameCardSelectParams.onDelete🔗

function SavegameReactUtil.SavegameCardSelectParams.onDelete()

SavegameReactUtil.AchievementListParam🔗

record SavegameReactUtil.AchievementListParam  cardMode: boolean
end

SavegameReactUtil.AchievementListParam.cardMode🔗

SavegameReactUtil.AchievementListParam.cardMode: boolean

SavegameReactUtil.makeModIdList🔗

function SavegameReactUtil.makeModIdList({string}): {Mod.ModId}
Parameters
  • {string}
Returns
  1. {Mod.ModId}

SavegameReactUtil.makeModStringList🔗

function SavegameReactUtil.makeModStringList({Mod.ModId}): {string}
Parameters
  • {Mod.ModId}
Returns
  1. {string}

SavegameReactUtil.groupSaves🔗

function SavegameReactUtil.groupSaves({SaveGameInfo}, string, string, SavegameFiltersParam.SortMode, boolean, SaveGameType): {SaveGroup}
Parameters
  • {SaveGameInfo}
  • string
  • string
  • SavegameFiltersParam.SortMode
  • boolean
  • SaveGameType
Returns
  1. {SaveGroup}

SavegameReactUtil.getSaveGroupAndType🔗

function SavegameReactUtil.getSaveGroupAndType(string): string, SaveGameType, string, string
Parameters
  • string
Returns
  1. string
  2. SaveGameType
  3. string
  4. string

SavegameReactUtil.ErrorType🔗

enum SavegameReactUtil.ErrorType  "CannotLoad"
  "ModMissing"
  "UnsupportedMapDimension"
end

SavegameReactUtil.ErrorType."CannotLoad"🔗

SavegameReactUtil.ErrorType."ModMissing"🔗

SavegameReactUtil.ErrorType."UnsupportedMapDimension"🔗

SavegameReactUtil.checkForError🔗

function SavegameReactUtil.checkForError(SaveGameData): {ErrorType}, string
Parameters
  • SaveGameData
Returns
  1. {ErrorType}
  2. string

SavegameReactUtil.SavegameCard🔗

SavegameReactUtil.SavegameCard: Recipe<SavegameCardParams>

SavegameReactUtil.SavegameFilters🔗

SavegameReactUtil.SavegameFilters: Recipe<SavegameFiltersParam>

SavegameReactUtil.SavegameSelectCard🔗

SavegameReactUtil.SavegameSelectCard: Recipe<SavegameCardSelectParams>

SavegameReactUtil.SavegameStorageBar🔗

SavegameReactUtil.SavegameStorageBar: Recipe0

SavegameReactUtil.LoadPreviewParam🔗

record SavegameReactUtil.LoadPreviewParam  saveGameData: SaveGameData
  saveGameId: SaveGameId
end

SavegameReactUtil.LoadPreviewParam.saveGameData🔗

SavegameReactUtil.LoadPreviewParam.saveGameData: SaveGameData

SavegameReactUtil.LoadPreviewParam.saveGameId🔗

SavegameReactUtil.LoadPreviewParam.saveGameId: SaveGameId

SavegameReactUtil.LoadPreview🔗

SavegameReactUtil.LoadPreview: Recipe<LoadPreviewParam>

SavegameReactUtil.ScrollableAchievementsList🔗

SavegameReactUtil.ScrollableAchievementsList: Recipe<AchievementListParam>

SavegameReactUtil.ScrollableAchievementsCardList🔗

SavegameReactUtil.ScrollableAchievementsCardList: Recipe0

SavegameReactUtil.CampaignInfo🔗

 
record SavegameReactUtil.CampaignInfo  
record MissionInfo    name: string
    desc: MissionDesc
    enabled: boolean
end

  missionInfo: {MissionInfo}
  desc: CampaignDesc
  highestUnlocked: integer
end

SavegameReactUtil.CampaignInfo.MissionInfo🔗

record SavegameReactUtil.CampaignInfo.MissionInfo  name: string
  desc: MissionDesc
  enabled: boolean
end

SavegameReactUtil.CampaignInfo.MissionInfo.name🔗

SavegameReactUtil.CampaignInfo.MissionInfo.name: string

SavegameReactUtil.CampaignInfo.MissionInfo.desc🔗

SavegameReactUtil.CampaignInfo.MissionInfo.desc: MissionDesc

SavegameReactUtil.CampaignInfo.MissionInfo.enabled🔗

SavegameReactUtil.CampaignInfo.MissionInfo.enabled: boolean

SavegameReactUtil.CampaignInfo.missionInfo🔗

SavegameReactUtil.CampaignInfo.missionInfo: {MissionInfo}

SavegameReactUtil.CampaignInfo.desc🔗

SavegameReactUtil.CampaignInfo.desc: CampaignDesc

SavegameReactUtil.CampaignInfo.highestUnlocked🔗

SavegameReactUtil.CampaignInfo.highestUnlocked: integer

SavegameReactUtil.getCampaignInfoSorted🔗

function SavegameReactUtil.getCampaignInfoSorted(ResName): CampaignInfo
Parameters
  • ResName
Returns
  1. CampaignInfo