Struct SupportedGames 

pub struct SupportedGames { /* private fields */ }

Registry of all supported Total War games.

This struct maintains the complete list of games supported by RPFM along with their full configuration. It provides lookup by game key and maintains release order for UI sorting.

Structure

• games: HashMap for O(1) lookup by game key
• order: Vector maintaining games in release order (newest first)

Usage

Create via Default::default() to get the full game registry:

use rpfm_lib::games::supported_games::{SupportedGames, KEY_WARHAMMER_3};

let games = SupportedGames::default();

// Lookup specific game
if let Some(game) = games.game(&KEY_WARHAMMER_3) {
    println!("{}", game.display_name());
}

// Iterate all games in release order
for game in games.games_sorted() {
    println!("{}", game.display_name());
}

Implementations

impl SupportedGames

Implementation for SupportedGames.

pub fn game(&self, key: &str) -> Option<&GameInfo>

Retrieves game information by key.

Arguments

• key - Game key constant (e.g., KEY_WARHAMMER_3)

Returns

Returns Some(&GameInfo) if the game is supported, None otherwise.

Example

use rpfm_lib::games::supported_games::{SupportedGames, KEY_WARHAMMER_3};

let games = SupportedGames::default();
let game = games.game(&KEY_WARHAMMER_3).unwrap();
assert_eq!(game.key(), KEY_WARHAMMER_3);

pub fn games(&self) -> Vec<&GameInfo>

Returns all supported games in arbitrary order.

For games sorted by release date, use SupportedGames::games_sorted().

Returns

Vector of references to all game configurations.

pub fn game_keys(&self) -> Vec<&str>

Returns all game keys in arbitrary order.

For keys sorted by release date, use SupportedGames::game_keys_sorted().

Returns

Vector of game key strings.

pub fn games_sorted(&self) -> Vec<&GameInfo>

Returns all supported games sorted by release date (newest first).

Use this when displaying games in UI to show them in chronological order.

Returns

Vector of game references in release order.

pub fn game_keys_sorted(&self) -> &[&'static str]

Returns all game keys sorted by release date (newest first).

Returns

Slice of game keys in release order.

Trait Implementations

impl Default for SupportedGames

fn default() -> Self

Returns the “default value” for a type.