PlayerEntity(LoadSave) Category Reference

#include <PlayerEntityLoadSave.h>

Instance Methods
(BOOL)	- loadPlayer
(void)	- savePlayer
(void)	- quicksavePlayer
(void)	- autosavePlayer
(void)	- setGuiToScenarioScreen:
(void)	- addScenarioModel:
(void)	- showScenarioDetails
(BOOL)	- startScenario
(NSString *)	- commanderSelector
(void)	- saveCommanderInputHandler
(void)	- overwriteCommanderInputHandler
(BOOL)	- loadPlayerFromFile:asNew:

Detailed Description

Definition at line 64 of file PlayerEntityLoadSave.h.

Method Documentation

addScenarioModel:

- (void) addScenarioModel:

(NSString *)

shipKey

Extends class PlayerEntity.

Definition at line 1412 of file PlayerEntityLoadSave.m.

                         :(NSString *)shipKey
{
    [self showShipModelWithKey:shipKey shipData:nil personality:0 factorX:1.2 factorY:0.8 factorZ:6.4 inContext:@"scenario"];
}

References OODeciCreditsFromDouble(), and OOUnsignedLongLongFromObject().

Here is the call graph for this function:

autosavePlayer

- (void) autosavePlayer

Extends class PlayerEntity.

Definition at line 1412 of file PlayerEntityLoadSave.m.

{
    NSString        *tmp_path = nil;
    NSString        *tmp_name = nil;
    NSString        *dir = [[UNIVERSE gameController] playerFileDirectory];
    
    tmp_name = [self lastsaveName];
    tmp_path = save_path;
    
    ShipScriptEventNoCx(self, "playerWillSaveGame", OOJSSTR("AUTO_SAVE"));
    
    NSString *saveName = [self lastsaveName];
    NSString *autosaveSuffix = DESC(@"autosave-commander-suffix");
    
    if (![saveName hasSuffix:autosaveSuffix])
    {
        saveName = [saveName stringByAppendingString:autosaveSuffix];
    }
    NSString *savePath = [dir stringByAppendingPathComponent:[saveName stringByAppendingString:@".oolite-save"]];
    
    [self setLastsaveName:saveName];
    
    @try
    {
        [self writePlayerToPath:savePath];
    }
    @catch (id exception)
    {
        // Suppress exceptions silently. Warning the user about failed autosaves would be pretty unhelpful.
    }
    
    if (tmp_path != nil)
    {
        [save_path autorelease];
        save_path = [tmp_path copy];
    }
    [self setLastsaveName:tmp_name];
}

commanderSelector

- (NSString *) commanderSelector

Extends class PlayerEntity.

Definition at line 1412 of file PlayerEntityLoadSave.m.

{
    MyOpenGLView    *gameView = [UNIVERSE gameView];
    GuiDisplayGen   *gui = [UNIVERSE gui];
    NSString        *dir = [[UNIVERSE gameController] playerFileDirectory];
    
    int idx;
    if([self handleGUIUpDownArrowKeys])
    {
        int guiSelectedRow=[gui selectedRow];
        idx=(guiSelectedRow - STARTROW) + (currentPage * NUMROWS);
        if (guiSelectedRow != MOREROW && guiSelectedRow != BACKROW && guiSelectedRow != EXITROW)
        {
            [self showCommanderShip: idx];
        }
        else
        {
            [UNIVERSE removeDemoShips];
            [gui setText:@"" forRow:CDRDESCROW align:GUI_ALIGN_LEFT];
            [gui setText:@"" forRow:CDRDESCROW + 1 align:GUI_ALIGN_LEFT];
            [gui setText:@"" forRow:CDRDESCROW + 2 align:GUI_ALIGN_LEFT];
        }
 
    }
    else
    {
        idx=([gui selectedRow] - STARTROW) + (currentPage * NUMROWS);
    }
    
    // handle page <-- and page --> keys
    if (([self checkKeyPress:n_key_gui_arrow_left] || [self checkKeyPress:n_key_gui_page_up]) && [[gui keyForRow:BACKROW] isEqual: GUI_KEY_OK])
    {
        currentPage--;
        [self playMenuPagePrevious];
        [self lsCommanders: gui directory: dir  pageNumber: currentPage  highlightName: nil];
        [gameView suppressKeysUntilKeyUp];
    }
    if (([self checkKeyPress:n_key_gui_arrow_right] || [self checkKeyPress:n_key_gui_page_down]) && [[gui keyForRow:MOREROW] isEqual: GUI_KEY_OK])
    {
        currentPage++;
        [self playMenuPageNext];
        [self lsCommanders: gui directory: dir  pageNumber: currentPage  highlightName: nil];
        [gameView suppressKeysUntilKeyUp];
    }
    
    // Enter pressed - find the commander name underneath.
    // ignore Ctrl for the moment - we check for it explicitly later
    if ([self checkKeyPress:n_key_gui_select ignore_ctrl:YES]||[gameView isDown:gvMouseDoubleClick])
    {
        NSDictionary *cdr;
        switch ([gui selectedRow])
        {
            case EXITROW:
                if ([self status] == STATUS_START_GAME)
                {
                    [self setGuiToIntroFirstGo:YES];
                    return nil;
                }
                break;
            case BACKROW:
                currentPage--;
                [self lsCommanders: gui directory: dir  pageNumber: currentPage  highlightName: nil];
                [gameView suppressKeysUntilKeyUp];
                break;
            case MOREROW:
                currentPage++;
                [self lsCommanders: gui directory: dir  pageNumber: currentPage  highlightName: nil];
                [gameView suppressKeysUntilKeyUp];
                break;
            default:
                cdr=[cdrDetailArray objectAtIndex: idx];
                if ([cdr oo_boolForKey:@"isSavedGame"])
                    return [cdr oo_stringForKey:@"saved_game_path"];
                else
                {
                    if ([gameView isCommandModifierKeyDown]||[gameView isDown:gvMouseDoubleClick])
                    {
                        // change directory to the selected path
                        NSString* newDir = [cdr oo_stringForKey:@"saved_game_path"];
                        [[UNIVERSE gameController] setPlayerFileDirectory: newDir];
                        dir = newDir;
                        currentPage = 0;
                        [self lsCommanders: gui directory: dir  pageNumber: currentPage  highlightName: nil];
                        [gameView suppressKeysUntilKeyUp];
                    }
                }
        }
    }
    
    if([gameView isDown: 27]) // escape key
    {
        [self setGuiToStatusScreen];
    }
    return nil;
}

loadPlayer

- (BOOL) loadPlayer

Extends class PlayerEntity.

Definition at line 1412 of file PlayerEntityLoadSave.m.

{
    BOOL                OK = YES;
    
#if OO_USE_APPKIT_LOAD_SAVE_ALWAYS
    OK = [self loadPlayerWithPanel];
#elif OOLITE_USE_APPKIT_LOAD_SAVE
    // OS X: use system open/save dialogs in windowed mode, custom interface in full-screen.
    if ([[UNIVERSE gameController] inFullScreenMode])
    {
        [self setGuiToLoadCommanderScreen];
    }
    else
    {
        OK = [self loadPlayerWithPanel];
    }
#else
    // Other platforms: use custom interface all the time.
    [self setGuiToLoadCommanderScreen];
#endif
    return OK;
}

loadPlayerFromFile:asNew:

- (BOOL) loadPlayerFromFile:		(NSString *)	fileToOpen
asNew:		(BOOL)	asNew

Extends class PlayerEntity.

Definition at line 1412 of file PlayerEntityLoadSave.m.

                           :(NSString *)fileToOpen asNew:(BOOL)asNew
{
    /*  TODO: it would probably be better to load by creating a new
        PlayerEntity, verifying that's OK, then replacing the global player.
        
        Actually, it'd be better to separate PlayerEntity into OOPlayer and
        OOPlayerShipEntity. And then move most of OOPlayerShipEntity into
        ShipEntity, and make NPC ships behave more like player ships.
        -- Ahruman
    */
    
    BOOL            loadedOK = YES;
    NSDictionary    *fileDic = nil;
    NSString        *fail_reason = nil;
    
    if (fileToOpen == nil)
    {
        fail_reason = DESC(@"loadfailed-no-file-specified");
        loadedOK = NO;
    }
    
    if (loadedOK)
    {
        OOLog(@"load.progress", @"%@", @"Reading file");
        fileDic = OODictionaryFromFile(fileToOpen);
        if (fileDic == nil)
        {
            fail_reason = DESC(@"loadfailed-could-not-load-file");
            loadedOK = NO;
        }
    }
 
    if (loadedOK)
    {
        OOLog(@"load.progress", @"%@", @"Restricting scenario");
        NSString *scenarioRestrict = [fileDic oo_stringForKey:@"scenario_restriction" defaultValue:nil];
        if (scenarioRestrict == nil)
        {
            // older save game - use the 'strict' key instead
            BOOL strict = [fileDic oo_boolForKey:@"strict" defaultValue:NO];
            if (strict)
            {
                scenarioRestrict = SCENARIO_OXP_DEFINITION_NONE;
            }
            else
            {
                scenarioRestrict = SCENARIO_OXP_DEFINITION_ALL;
            }
        }
 
        if (![UNIVERSE setUseAddOns:scenarioRestrict fromSaveGame:YES forceReinit:YES]) 
        {
            fail_reason = DESC(@"loadfailed-saved-game-failed-to-load");
            loadedOK = NO;
        } 
    }
    
 
    if (loadedOK)
    {
        OOLog(@"load.progress", @"%@", @"Creating player ship");
        // Check that player ship exists
        NSString        *shipKey = nil;
        NSDictionary    *shipDict = nil;
        
        shipKey = [fileDic oo_stringForKey:@"ship_desc"];
        shipDict = [[OOShipRegistry sharedRegistry] shipInfoForKey:shipKey];
        
        if (shipDict == nil)
        {
            loadedOK = NO;
            if (shipKey != nil)  fail_reason = [NSString stringWithFormat:DESC(@"loadfailed-could-not-find-ship-type-@-please-reinstall-the-appropriate-OXP"), shipKey];
            else  fail_reason = DESC(@"loadfailed-invalid-saved-game-no-ship-specified");
        }
    }
    
    if (loadedOK)
    {
        OOLog(@"load.progress", @"%@", @"Initialising player entity");
        if (![self setUpAndConfirmOK:YES saveGame:YES])
        {
            fail_reason = DESC(@"loadfailed-could-not-reset-javascript");
            loadedOK = NO;
        }
    }
    
    if (loadedOK)
    {
        OOLog(@"load.progress", @"%@", @"Loading commander data");
        if (![self setCommanderDataFromDictionary:fileDic])
        {
            // this could still be a reset js issue, if switching from strict / unrestricted
            // TODO: use "could not reset js message" if that's the case.
            fail_reason = DESC(@"loadfailed-could-not-set-up-player-ship");
            loadedOK = NO;
        }
    }
    
    if (loadedOK)
    {
        OOLog(@"load.progress", @"%@", @"Recording save path");
        if (!asNew)
        {
            [save_path autorelease];
            save_path = [fileToOpen retain];
        
            [[[UNIVERSE gameView] gameController] setPlayerFileToLoad:fileToOpen];
            [[[UNIVERSE gameView] gameController] setPlayerFileDirectory:fileToOpen];
        }
    }
    else
    {
        OOLog(@"load.failed", @"***** Failed to load saved game \"%@\": %@", [fileToOpen lastPathComponent], fail_reason ? fail_reason : (NSString *)@"unknown error");
        [[UNIVERSE gameController] setPlayerFileToLoad:nil];
        [UNIVERSE handleGameOver];
        [UNIVERSE clearPreviousMessage];
        [UNIVERSE addMessage:DESC(@"loadfailed-saved-game-failed-to-load") forCount: 9.0];
        if (fail_reason != nil)  [UNIVERSE addMessage: fail_reason forCount: 9.0];
        return NO;
    }
    
    OOLog(@"load.progress", @"%@", @"Creating system");
    [UNIVERSE setTimeAccelerationFactor:TIME_ACCELERATION_FACTOR_DEFAULT];
    [UNIVERSE setSystemTo:system_id];
    [UNIVERSE removeAllEntitiesExceptPlayer];
    [UNIVERSE setGalaxyTo: galaxy_number andReinit:YES]; // set overridden planet names on long range map
    [UNIVERSE setUpSpace];
    [UNIVERSE setAutoSaveNow:NO];
    
    OOLog(@"load.progress", @"%@", @"Resetting player flight variables");
    [self setDockedAtMainStation];
    StationEntity *dockedStation = [self dockedStation];
    
    [UNIVERSE enterGUIViewModeWithMouseInteraction:NO];
    
    if (dockedStation)
    {
        position = [dockedStation position];
        [self setOrientation: kIdentityQuaternion];
        v_forward = vector_forward_from_quaternion(orientation);
        v_right = vector_right_from_quaternion(orientation);
        v_up = vector_up_from_quaternion(orientation);
    }
    
    flightRoll = 0.0;
    flightPitch = 0.0;
    flightYaw = 0.0;
    flightSpeed = 0.0;
    
    [self setEntityPersonalityInt:PersonalityForCommanderDict(fileDic)];
    
    OOLog(@"load.progress", @"%@", @"Loading system market");
    // dockedStation is always the main station at this point;
    // "localMarket" save key always refers to the main station (system) market
    NSArray *market = [fileDic oo_arrayForKey:@"localMarket"];
    if (market != nil) 
    {
        [dockedStation setLocalMarket:market];
    }
    else
    {
        [dockedStation initialiseLocalMarket];
    }
 
    [self calculateCurrentCargo];
    
    OOLog(@"load.progress", @"%@", @"Setting scenario key");
    // set scenario key if the scenario allows saving and has one
    NSString *scenario = [fileDic oo_stringForKey:@"scenario_key" defaultValue:nil];
    DESTROY(scenarioKey);
    if (scenario != nil)
    {
        scenarioKey = [scenario retain];
    }
 
    OOLog(@"load.progress", @"%@", @"Starting JS engine");
    // Remember the savegame target, run js startUp.
    [self completeSetUpAndSetTarget:NO];
    // run initial system population
    OOLog(@"load.progress", @"%@", @"Populating initial system");
    [UNIVERSE populateNormalSpace];
 
    // might as well start off with a collected JS environment
    [[OOJavaScriptEngine sharedEngine] garbageCollectionOpportunity:YES];
    
    // read saved position vector and primary role, check for an
    // appropriate station at those coordinates, if found, switch
    // docked station to that one.
    HPVector dockedPos = [fileDic oo_hpvectorForKey:@"docked_station_position"];
    NSString *dockedRole = [fileDic oo_stringForKey:@"docked_station_role" defaultValue:@""];
    StationEntity *saveStation = [UNIVERSE stationWithRole:dockedRole andPosition:dockedPos];
    if (saveStation != nil && [saveStation allowsSaving])
    {
        [self setDockedStation:saveStation];
        position = [saveStation position];
    }
    // and initialise markets for the secondary stations
    [UNIVERSE loadStationMarkets:[fileDic oo_arrayForKey:@"station_markets"]];
 
    OOLog(@"load.progress", @"%@", @"Completing JS startup");
    [self startUpComplete];
 
    [[UNIVERSE gameView] suppressKeysUntilKeyUp];
    gui_screen = GUI_SCREEN_LOAD; // force evaluation of new gui screen on startup
    [self setGuiToStatusScreen];
    if (loadedOK) [self doWorldEventUntilMissionScreen:OOJSID("missionScreenOpportunity")];  // trigger missionScreenOpportunity immediately after loading
    OOLog(@"load.progress", @"%@", @"Loading complete");
    return loadedOK;
}

overwriteCommanderInputHandler

- (void) overwriteCommanderInputHandler

Extends class PlayerEntity.

Definition at line 1412 of file PlayerEntityLoadSave.m.

{
    MyOpenGLView    *gameView = [UNIVERSE gameView];
    GuiDisplayGen   *gui = [UNIVERSE gui];
    
    [self handleGUIUpDownArrowKeys];
    
    // Translation issue: we can't confidently use raw Y and N ascii as shortcuts. It's better to use the load-previous-commander keys.
    id valueYes = [[[UNIVERSE descriptions] oo_stringForKey:@"load-previous-commander-yes" defaultValue:@"y"] lowercaseString];
    id valueNo = [[[UNIVERSE descriptions] oo_stringForKey:@"load-previous-commander-no" defaultValue:@"n"] lowercaseString];
    unsigned char cYes, cNo;
    
    cYes = [valueYes characterAtIndex: 0] & 0x00ff; // Use lower byte of unichar.
    cNo = [valueNo characterAtIndex: 0] & 0x00ff;   // Use lower byte of unichar.
    
    if (([self checkKeyPress:n_key_gui_select] && ([gui selectedRow] == SAVE_OVERWRITE_YES_ROW))||[gameView isDown:cYes]||[gameView isDown:cYes - 32])
    {
        pollControls=YES;
        [self nativeSavePlayer: commanderNameString];
        [self playSaveOverwriteYes];
        [[UNIVERSE gameView] suppressKeysUntilKeyUp];
        [self setGuiToStatusScreen];
    }
    
    if (([self checkKeyPress:n_key_gui_select] && ([gui selectedRow] == SAVE_OVERWRITE_NO_ROW))||[gameView isDown:27]||[gameView isDown:cNo]||[gameView isDown:cNo - 32])
    {
        // esc or NO was pressed - get out of here
        pollControls=YES;
        [self playSaveOverwriteNo];
        [self setGuiToSaveCommanderScreen:@""];
    }
}

quicksavePlayer

- (void) quicksavePlayer

Extends class PlayerEntity.

Definition at line 1412 of file PlayerEntityLoadSave.m.

{
    MyOpenGLView    *gameView = [UNIVERSE gameView];
    NSString        *path = nil;
    
    path = save_path;
    if (!path)  path = [[gameView gameController] playerFileToLoad];
    if (!path)
    {
        OOLog(@"quickSave.failed.noName", @"%@", @"ERROR no file name returned by [[gameView gameController] playerFileToLoad]");
        [NSException raise:@"OoliteGameNotSavedException"
                    format:@"ERROR no file name returned by [[gameView gameController] playerFileToLoad]"];
    }
    
    ShipScriptEventNoCx(self, "playerWillSaveGame", OOJSSTR("QUICK_SAVE"));
    
    [self writePlayerToPath:path];
    [[UNIVERSE gameView] suppressKeysUntilKeyUp];
    [self setGuiToStatusScreen];
}

saveCommanderInputHandler

- (void) saveCommanderInputHandler

Extends class PlayerEntity.

Definition at line 1412 of file PlayerEntityLoadSave.m.

{
    MyOpenGLView    *gameView = [UNIVERSE gameView];
    GuiDisplayGen   *gui = [UNIVERSE gui];
    NSString        *dir = [[UNIVERSE gameController] playerFileDirectory];
    
    if ([self handleGUIUpDownArrowKeys])
    {
        int guiSelectedRow=[gui selectedRow];
        int idx = (guiSelectedRow - STARTROW) + (currentPage * NUMROWS);
        if (guiSelectedRow != MOREROW && guiSelectedRow != BACKROW)
        {
            [self showCommanderShip: idx];
            if ([(NSDictionary *)[cdrDetailArray objectAtIndex:idx] oo_boolForKey:@"isSavedGame"])  // don't show things that aren't saved games
                commanderNameString = [[cdrDetailArray oo_dictionaryAtIndex:idx] oo_stringForKey:@"player_save_name" defaultValue:[[cdrDetailArray oo_dictionaryAtIndex:idx] oo_stringForKey:@"player_name"]];
            else
                commanderNameString = [gameView typedString];
        }
        else
        {
            [UNIVERSE removeDemoShips];
            [gui setText:@"" forRow:CDRDESCROW align:GUI_ALIGN_LEFT];
            [gui setText:@"" forRow:CDRDESCROW + 1 align:GUI_ALIGN_LEFT];
            [gui setText:@"" forRow:CDRDESCROW + 2 align:GUI_ALIGN_LEFT];
        }
    }
    else
    {
        commanderNameString = [gameView typedString];
    }
    
    [gameView setTypedString: commanderNameString];
    
    [gui setText:
        [NSString stringWithFormat:DESC(@"savescreen-commander-name-@"), commanderNameString]
          forRow: INPUTROW];
    [gui setColor:[OOColor cyanColor] forRow:INPUTROW];
    
    // handle page <-- and page --> keys, and on-screen buttons
    if (((([gameView isDown:gvMouseDoubleClick] || [self checkKeyPress:n_key_gui_select]) && [gui selectedRow] == BACKROW) || ([self checkKeyPress:n_key_gui_arrow_left] || [self checkKeyPress:n_key_gui_page_up]))
                    && [[gui keyForRow:BACKROW] isEqual: GUI_KEY_OK])
    {
        currentPage--;
        [self lsCommanders: gui directory: dir  pageNumber: currentPage  highlightName: nil];
        [gameView suppressKeysUntilKeyUp];
    }
    //
    if (((([gameView isDown:gvMouseDoubleClick] || [self checkKeyPress:n_key_gui_select]) && [gui selectedRow] == MOREROW) || ([self checkKeyPress:n_key_gui_arrow_right] || [self checkKeyPress:n_key_gui_page_down]))
                    && [[gui keyForRow:MOREROW] isEqual: GUI_KEY_OK])
    {
        currentPage++;
        [self lsCommanders: gui directory: dir  pageNumber: currentPage  highlightName: nil];
        [gameView suppressKeysUntilKeyUp];
    }
    
    // ignore Ctrl if pressed together with Enter for the moment - we check for it explicitly immediately after
    if(([self checkKeyPress:n_key_gui_select ignore_ctrl:YES]||[gameView isDown:gvMouseDoubleClick]) && [commanderNameString length])
    {
        if ([gameView isCommandModifierKeyDown]||[gameView isDown:gvMouseDoubleClick])
        {
            int guiSelectedRow=[gui selectedRow];
            int idx = (guiSelectedRow - STARTROW) + (currentPage * NUMROWS);
            NSDictionary* cdr = [cdrDetailArray objectAtIndex:idx];
            
            if (![cdr oo_boolForKey:@"isSavedGame"])    // don't open saved games
            {
                // change directory to the selected path
                NSString* newDir = [cdr oo_stringForKey:@"saved_game_path"];
                [[UNIVERSE gameController] setPlayerFileDirectory: newDir];
                dir = newDir;
                currentPage = 0;
                [self lsCommanders: gui directory: dir  pageNumber: currentPage  highlightName: nil];
                [gameView suppressKeysUntilKeyUp];
            }
        }
        else
        {
            pollControls = YES;
            if ([self existingNativeSave: commanderNameString])
            {
                [gameView suppressKeysUntilKeyUp];
                [self setGuiToOverwriteScreen: commanderNameString];
            }
            else
            {
                [self nativeSavePlayer: commanderNameString];
                [[UNIVERSE gameView] suppressKeysUntilKeyUp];
                [self setGuiToStatusScreen];
            }
        }
    }
    
    if([gameView isDown: 27]) // escape key
    {
        // get out of here
        pollControls = YES;
        [[UNIVERSE gameView] resetTypedString];
        [self setGuiToStatusScreen];
    }
}

savePlayer

- (void) savePlayer

Extends class PlayerEntity.

Definition at line 1412 of file PlayerEntityLoadSave.m.

{
#if OO_USE_APPKIT_LOAD_SAVE_ALWAYS
    [self savePlayerWithPanel];
#elif OOLITE_USE_APPKIT_LOAD_SAVE
    // OS X: use system open/save dialogs in windowed mode, custom interface in full-screen.
    if ([[UNIVERSE gameController] inFullScreenMode])
    {
        [self setGuiToSaveCommanderScreen:self.lastsaveName];
    }
    else
    {
        [self savePlayerWithPanel];
    }
#else
    // Other platforms: use custom interface all the time.
    [self setGuiToSaveCommanderScreen:[self lastsaveName]];
#endif
}

setGuiToScenarioScreen:

- (void) setGuiToScenarioScreen:

(int)

page

Extends class PlayerEntity.

Definition at line 1412 of file PlayerEntityLoadSave.m.

                               :(int)page
{
    NSArray *scenarios = [UNIVERSE scenarios];
    [UNIVERSE removeDemoShips];
    // GUI stuff
    {
        GuiDisplayGen   *gui = [UNIVERSE gui];
        OOGUIRow        start_row = GUI_ROW_SCENARIOS_START;
        OOGUIRow        row = start_row;
        BOOL            guiChanged = (gui_screen != GUI_SCREEN_NEWGAME);
 
        [gui clearAndKeepBackground:!guiChanged];
        [gui setTitle:DESC(@"oolite-newgame-title")];
 
        OOGUITabSettings tab_stops;
        tab_stops[0] = 0;
        tab_stops[1] = -480;
        [gui setTabStops:tab_stops];
 
        unsigned n_rows = GUI_MAX_ROWS_SCENARIOS;
        NSUInteger i, count = [scenarios count];
 
        NSDictionary *scenario = nil;
 
        [gui setArray:[NSArray arrayWithObjects:DESC(@"oolite-scenario-exit"), @" <----- ", nil] forRow:start_row - 2];
        [gui setColor:[OOColor redColor] forRow:start_row - 2];
        [gui setKey:@"exit" forRow:start_row - 2];
        
 
        if (page > 0)
        {
            [gui setArray:[NSArray arrayWithObjects:DESC(@"gui-back"), @" <-- ", nil] forRow:start_row - 1];
            [gui setColor:[OOColor greenColor] forRow:start_row - 1];
            [gui setKey:[NSString stringWithFormat:@"__page:%i",page-1] forRow:start_row - 1];
        }
 
        [self setShowDemoShips:NO];
 
        for (i = page*n_rows ; i < count && row < start_row + n_rows ; i++)
        {
            scenario = [[UNIVERSE scenarios] objectAtIndex:i];
            NSString *scenarioName = [NSString stringWithFormat:@" %@ ",[scenario oo_stringForKey:@"name"]];
            [gui setText:OOExpand(scenarioName) forRow:row];
            [gui setKey:[NSString stringWithFormat:@"Scenario:%lu", (unsigned long)i] forRow:row];
            ++row;
        }
 
        if ((page+1) * n_rows < count)
        {
            [gui setArray:[NSArray arrayWithObjects:DESC(@"gui-more"), @" --> ", nil] forRow:row];
            [gui setColor:[OOColor greenColor] forRow:row];
            [gui setKey:[NSString stringWithFormat:@"__page:%i",page+1] forRow:row];
            ++row;
        }
        
        [gui setSelectableRange:NSMakeRange(start_row - 2,3 + row - start_row)];
        [gui setSelectedRow:start_row];
        [self showScenarioDetails];
 
        gui_screen = GUI_SCREEN_NEWGAME;
    
        if (guiChanged)
        {
            [gui setBackgroundTextureKey:@"newgame"];
            [gui setForegroundTextureKey:@"newgame_overlay"];
        }
    }
    
    [UNIVERSE enterGUIViewModeWithMouseInteraction:YES];
}

showScenarioDetails

- (void) showScenarioDetails

Extends class PlayerEntity.

Definition at line 1412 of file PlayerEntityLoadSave.m.

{
    GuiDisplayGen* gui = [UNIVERSE gui];
    NSString* key = [gui selectedRowKey];
    [UNIVERSE removeDemoShips];
 
    if ([key hasPrefix:@"Scenario"])
    {
        int item = [[key componentsSeparatedByString:@":"] oo_intAtIndex:1];
        NSDictionary *scenario = [[UNIVERSE scenarios] objectAtIndex:item];
        [self setShowDemoShips:NO];
        for (NSUInteger i=GUI_ROW_SCENARIOS_DETAIL;i<=27;i++)
        {
            [gui setText:@"" forRow:i];
        }
        if (scenario)
        {
            [gui addLongText:OOExpand([scenario oo_stringForKey:@"description"]) startingAtRow:GUI_ROW_SCENARIOS_DETAIL align:GUI_ALIGN_LEFT];
            NSString *shipKey = [scenario oo_stringForKey:@"model"];
            if (shipKey != nil)
            {
                [self addScenarioModel:shipKey];
                [self setShowDemoShips:YES];
            }
        }
 
    }
}

startScenario

- (BOOL) startScenario

Extends class PlayerEntity.

Definition at line 1412 of file PlayerEntityLoadSave.m.

{
    GuiDisplayGen* gui = [UNIVERSE gui];
    NSString* key = [gui selectedRowKey];
 
    if ([key isEqualToString:@"exit"])
    {
        // intended to return to main menu
        return NO; 
    }
    if ([key hasPrefix:@"__page"])
    {
        int page = [[key componentsSeparatedByString:@":"] oo_intAtIndex:1];
        [self setGuiToScenarioScreen:page];
        return YES;
    }
    int selection = [[key componentsSeparatedByString:@":"] oo_intAtIndex:1];
 
    NSDictionary *scenario = [[UNIVERSE scenarios] objectAtIndex:selection];
    NSString *file = [scenario oo_stringForKey:@"file" defaultValue:nil];
    if (file == nil) 
    {
        OOLog(@"scenario.init.error", @"%@", @"No file entry found for scenario");
        return NO;
    }
    NSString *path = [ResourceManager pathForFileNamed:file inFolder:@"Scenarios"];
    if (path == nil)
    {
        OOLog(@"scenario.init.error", @"Game file not found for scenario %@",file);
        return NO;
    }
    BOOL result = [self loadPlayerFromFile:path asNew:YES];
    if (!result)
    {
        return NO;
    }
    [scenarioKey release];
    scenarioKey = [[scenario oo_stringForKey:@"scenario" defaultValue:nil] retain];
 
    // don't drop the save game directory in
    return YES;
}

---

The documentation for this category was generated from the following files:

• src/Core/Entities/PlayerEntityLoadSave.h
• src/Core/Entities/PlayerEntityLoadSave.m