​

XGameRuntimeInitializeWithOptions

​

Syntaxe

HRESULT XGameRuntimeInitializeWithOptions(
    _In_ const XGameRuntimeOptions* options
)  

​

Paramètres

​

Valeur de retour

​

Remarques

• Une classe appelée « GameEngine » qui prend le chemin d’accès aux fichiers du jeu et démarre le jeu. Il s’agit du même moteur que celui utilisé au moment de l’exécution par le « lecteur » du moteur de jeu.
• Une instance de cette classe est stockée comme variable globale dans l’éditeur et représente le jeu actuel.

void StartGame(const char* gamePath) 
{ 
    // If there is an existing game running, shut it down 
    if (g_game.IsRunning()) 
    { 
        g_game.Stop() 
    } 
 
    // Initialize the runtime in this process for this path 
    std::string gameConfig(gamePath); 
    gameConfig.append(“\\MicrosoftGame.config”); 
    XGameRuntimeOptions options{}; 
    options.gameConfigSource = XGameRuntimeGameConfigSource::File; 
    options.gameConfig = gameConfig.c_str(); 
    THROW_IF_FAILED(XGameRuntimeInitializeWithOptions(&options)); 
 
    // Now launch the game normally. 
    GameEngine game; 
    game.Launch(gamePath); 
    g_game = std::move(game); 
} 
 

// Examples of Launch / Stop behavior in GameEngine 
void GameEngine::Stop() 
{ 
    // Disconnect all globals from the runtime, closing handles and removing event 
    // handlers 

    // Handle game shut down before uninitializing the runtime

    XGameRuntimeUninitialize(); 
} 

void GameEngine::Launch(const char* gamePath) 
{ 
    // Standard XGameRuntimeInitialize here is fine to call – it will adopt the 
    // GameConfig settings from the earlier XGameRuntimeInitializeWithOptions call. 

    XGameRuntimeInitialize(); 
    RunGame(gamePath); 
}

• XGameRuntimeInitialize : si la DLL du runtime a déjà été initialisée par un autre appel, cette API s’aligne sur les options d’initialisation fournies lors de cet autre appel. Si c’est la première fois que le runtime est initialisé, des valeurs par défaut sont utilisées pour les options d’initialisation. Les jeux doivent toujours initialiser le runtime à l’aide de cette API.
• XGameRuntimeInitializeWithOptions : tous les composants qui initialisent le runtime doivent transmettre les mêmes options s’ils utilisent cette méthode. Si le runtime a déjà été initialisé avec un autre ensemble d’options, cet appel échoue avec E_GAMERUNTIME_OPTIONS_MISMATCH. Les composants intergiciels, comme un éditeur de jeu Unity, peuvent utiliser cette API pour initialiser le runtime avec un GameConfig personnalisé avant de démarrer le jeu. Le runtime peut être réinitialisé avec des options différentes s’il est d’abord complètement désinitialisé. Pour cela, tous les modules qui ont appelé l’une des méthodes XGameRuntimeInitialize* doivent appeler XGameRuntimeUninitialize.

• Ne décharge pas la DLL du runtime, car cela pourrait provoquer un plantage.
• Stocke l’erreur afin de la retourner lors d’un appel ultérieur à XGameRuntimeInitialize*
• Un XErrorReport est émis.

​

Configuration requise

​

Voir aussi