GameController Class Reference

#include <GameController.h>

Inheritance diagram for GameController:

Collaboration diagram for GameController:

Instance Methods
(void)	- applicationDidFinishLaunching:
(BOOL)	- finishedLaunching
(BOOL)	- isGamePaused
(void)	- setGamePaused:
(void)	- setEcoQoS:
(OOMouseInteractionMode)	- mouseInteractionMode
(void)	- setMouseInteractionMode:
(void)	- setMouseInteractionModeForFlight
(void)	- setMouseInteractionModeForUIWithMouseInteraction:
(void)	- performGameTick:
(IBAction)	- showLogAction:
(IBAction)	- showLogFolderAction:
(IBAction)	- showSnapshotsAction:
(IBAction)	- showAddOnsAction:
(void)	- recenterVirtualJoystick
(void)	- exitAppWithContext:
(void)	- exitAppCommandQ
(NSString *)	- playerFileToLoad
(void)	- setPlayerFileToLoad:
(NSString *)	- playerFileDirectory
(void)	- setPlayerFileDirectory:
(void)	- loadPlayerIfRequired
(void)	- beginSplashScreen
(void)	- logProgress:
(void)	- endSplashScreen
(void)	- startAnimationTimer
(void)	- stopAnimationTimer
(MyOpenGLView *)	- gameView
(void)	- setGameView:
(void)	- windowDidResize:
(void)	- setUpBasicOpenGLStateWithSize:
(NSURL *)	- snapshotsURLCreatingIfNeeded:
(id)	- init [implementation]
(void)	- dealloc [implementation]
(void)	- doPerformGameTick [implementation]
(BOOL)	- isDirectoryAtPath: [implementation]
(BOOL)	- addOnsExistAtPath: [implementation]
(void)	- openPath: [implementation]
(BOOL)	- validateMenuItem: [implementation]
(NSMenu *)	- applicationDockMenu: [implementation]
(void)	- awakeFromNib [implementation]
(BOOL)	- application:openFile: [implementation]
(NSApplicationTerminateReply)	- applicationShouldTerminate: [implementation]
(void)	- reportUnhandledStartupException: [implementation]
(BOOL)	- suppressClangStuff [implementation]
(IBAction)	- toggleFullScreenAction: [implementation]
(void)	- setFullScreenMode: [implementation]
(void)	- exitFullScreenMode [implementation]
(BOOL)	- inFullScreenMode [implementation]
(BOOL)	- setDisplayWidth:Height:Refresh: [implementation]
(NSDictionary *)	- findDisplayModeForWidth:Height:Refresh: [implementation]
(NSArray *)	- displayModes [implementation]
(NSUInteger)	- indexOfCurrentDisplayMode [implementation]
(void)	- pauseFullScreenModeToPerform:onTarget: [implementation]
(void)	- setUpDisplayModes [implementation]
(void)	- toggleFullScreenCalledForWindow:withSender: [implementation]

Class Methods
(GameController *)	+ sharedController
(static id)	+ GetPreference [implementation]
(static void)	+ SetPreference [implementation]
(static void)	+ RemovePreference [implementation]

Private Attributes
IBOutlet NSTextField *	splashProgressTextField
IBOutlet NSView *	splashView
IBOutlet NSWindow *	gameWindow
IBOutlet PDFView *	helpView
IBOutlet NSMenu *	dockMenu
IBOutlet MyOpenGLView *	gameView
NSTimeInterval	last_timeInterval
double	delta_t
int	my_mouse_x
int	my_mouse_y
NSString *	playerFileDirectory
NSString *	playerFileToLoad
NSMutableArray *	expansionPathsToInclude
NSTimer *	timer
NSTimeInterval	_animationTimerInterval
NSDate *	_splashStart
SEL	pauseSelector
NSObject *	pauseTarget
BOOL	gameIsPaused
OOMouseInteractionMode	_mouseMode
OOMouseInteractionMode	_resumeMode
OOFullScreenController *	_fullScreenController

Detailed Description

Definition at line 52 of file GameController.h.

Method Documentation

addOnsExistAtPath:

- (BOOL) addOnsExistAtPath: (NSString *)  path

implementation

Definition at line 479 of file GameController.m.

                          :(NSString *)path
{
    if (![self isDirectoryAtPath:path])  return NO;
    
    NSWorkspace *workspace = NSWorkspace.sharedWorkspace;
    for (NSString *subPath in [NSFileManager.defaultManager enumeratorAtPath:path]) {
        subPath = [path stringByAppendingPathComponent:subPath];
        NSString *type = [workspace typeOfFile:subPath error:NULL];
        if ([workspace type:type conformsToType:@"org.aegidian.oolite.expansion"])  return YES;
    }
    
    return NO;
}

application:openFile:

- (BOOL) application: (NSApplication *)  theApplication openFile: (NSString *)  filename

implementation

Definition at line 479 of file GameController.m.

                   :(NSApplication *)theApplication openFile:(NSString *)filename
{
    if ([[filename pathExtension] isEqual:@"oolite-save"])
    {
        [self setPlayerFileToLoad:filename];
        [self setPlayerFileDirectory:filename];
        return YES;
    }
    if ([[filename pathExtension] isEqualToString:@"oxp"])
    {
        BOOL dir_test;
        [[NSFileManager defaultManager] fileExistsAtPath:filename isDirectory:&dir_test];
        if (dir_test)
        {
            if (expansionPathsToInclude == nil)
            {
                expansionPathsToInclude = [[NSMutableArray alloc] init];
            }
            [expansionPathsToInclude addObject:filename];
            return YES;
        }
    }
    return NO;
}

applicationDidFinishLaunching:

- (void) applicationDidFinishLaunching:

(NSNotification *)

notification

Definition at line 1048 of file GameController.m.

                                      :(NSNotification *)notification
{
    NSAutoreleasePool   *pool = nil;
    unsigned            i;
    
    pool = [[NSAutoreleasePool alloc] init];
    
    @try
    {
        // if not verifying oxps, ensure that gameView is drawn to using beginSplashScreen
        // OpenGL is initialised and that allows textures to initialise too.
 
#if OO_OXP_VERIFIER_ENABLED
 
        if ([OOOXPVerifier runVerificationIfRequested])
        {
            [self exitAppWithContext:@"OXP verifier run"];
        }
        else 
        {
            [self beginSplashScreen];
        }
        
#else
        [self beginSplashScreen];
#endif
        
#if OOLITE_MAC_OS_X
        [OOJoystickManager setStickHandlerClass:[OOMacJoystickManager class]];
        SetUpSparkle();
#endif
        
        [self setUpDisplayModes];
        
        // moved to before the Universe is created
        if (expansionPathsToInclude)
        {
            for (i = 0; i < [expansionPathsToInclude count]; i++)
            {
                [ResourceManager addExternalPath: (NSString*)[expansionPathsToInclude objectAtIndex: i]];
            }
        }
        
        // initialise OXZ manager
        [OOOXZManager sharedManager];
 
        // moved here to try to avoid initialising this before having an Open GL context
        //[self logProgress:DESC(@"Initialising universe")]; // DESC expansions only possible after Universe init
        [[Universe alloc] initWithGameView:gameView];
        
        [self loadPlayerIfRequired];
        
        [self logProgress:@""];
        
        // get the run loop and add the call to performGameTick:
        [self startAnimationTimer];
        
        [self endSplashScreen];
    }
    @catch (NSException *exception)
    {
        [self reportUnhandledStartupException:exception];
        exit(EXIT_FAILURE);
    }
    
    OOLog(@"startup.complete", @"========== Loading complete in %.2f seconds. ==========", -[_splashStart timeIntervalSinceNow]);
    
#if OO_USE_FULLSCREEN_CONTROLLER
    [self setFullScreenMode:[[NSUserDefaults standardUserDefaults] boolForKey:@"fullscreen"]];
#endif
 
    _finishedLaunching = YES;
    
    // Release anything allocated above that is not required.
    [pool release];
    
#if !OOLITE_MAC_OS_X
    [[NSRunLoop currentRunLoop] run];
#endif
}

Referenced by main().

Here is the caller graph for this function:

applicationDockMenu:

- (NSMenu *) applicationDockMenu: (NSApplication *)  sender

implementation

Definition at line 479 of file GameController.m.

                               :(NSApplication *)sender
{
    return dockMenu;
}

applicationShouldTerminate:

- (NSApplicationTerminateReply) applicationShouldTerminate: (NSApplication *)  sender

implementation

Definition at line 479 of file GameController.m.

                                                         :(NSApplication *)sender
{
    [[OOCacheManager sharedCache] finishOngoingFlush];
    OOLoggingTerminate();
    return NSTerminateNow;
}

awakeFromNib

- (void) awakeFromNib

implementation

Definition at line 479 of file GameController.m.

{
    NSString                *path = nil;
    
    // Set contents of Help window
    path = [[NSBundle mainBundle] pathForResource:@"OoliteReadMe" ofType:@"pdf"];
    if (path != nil)
    {
        PDFDocument *document = [[PDFDocument alloc] initWithURL:[NSURL fileURLWithPath:path]];
        [helpView setDocument:document];
        [document release];
    }
    [helpView setBackgroundColor:[NSColor whiteColor]];
}

beginSplashScreen

- (void) beginSplashScreen

Definition at line 1048 of file GameController.m.

{
#if !OOLITE_MAC_OS_X
    if(!gameView)
    {
        gameView = [MyOpenGLView alloc];
        [gameView init];
        [gameView setGameController:self];
        [gameView initSplashScreen];
    }
#else
    [gameView updateScreen];
#endif
}

dealloc

- (void) dealloc

implementation

Definition at line 1048 of file GameController.m.

{
#if OOLITE_MAC_OS_X
    [[[NSWorkspace sharedWorkspace] notificationCenter] removeObserver:UNIVERSE];
#endif
    
    [timer release];
    [gameView release];
    [UNIVERSE release];
    
    [playerFileToLoad release];
    [playerFileDirectory release];
    [expansionPathsToInclude release];
    
    [super dealloc];
}

displayModes

- (NSArray *) displayModes

implementation

Provided by category GameController(FullScreen).

Definition at line 1 of file GameController+FullScreen.m.

{
    return [_fullScreenController displayModes];
}

doPerformGameTick

- (void) doPerformGameTick

implementation

Provided by category GameController(OOPrivate).

Definition at line 1048 of file GameController.m.

{
    @try
    {
        if (gameIsPaused)
            delta_t = 0.0;  // no movement!
        else
        {
            delta_t = [NSDate timeIntervalSinceReferenceDate] - last_timeInterval;
            last_timeInterval += delta_t;
            if (delta_t > MINIMUM_GAME_TICK)
                delta_t = MINIMUM_GAME_TICK;        // peg the maximum pause (at 0.5->1.0 seconds) to protect against when the machine sleeps   
        }
        
        [UNIVERSE update:delta_t];
        if (EXPECT_NOT([PLAYER status] == STATUS_RESTART_GAME))
        {
            [UNIVERSE reinitAndShowDemo:YES];
        }
        [OOSound update];
        if (!gameIsPaused)
        {
            OOJSFrameCallbacksInvoke(delta_t);
        }
    }
    @catch (id exception) 
    {
        OOLog(@"exception.backtrace",@"%@",[exception callStackSymbols]);
    }
    
    @try
    {
        [gameView display];
    }
    @catch (id exception) {}
}

endSplashScreen

- (void) endSplashScreen

Definition at line 479 of file GameController.m.

{
    OOLogSetDisplayMessagesInClass(@"startup.progress", NO);
    
#if OOLITE_MAC_OS_X
    // These views will be released when we replace the content view.
    splashProgressTextField = nil;
    splashView = nil;
    
    [gameWindow setAcceptsMouseMovedEvents:YES];
    [gameWindow setContentView:gameView];
    [gameWindow makeFirstResponder:gameView];
#elif OOLITE_SDL
    [gameView endSplashScreen];
#endif
}

exitAppCommandQ

- (void) exitAppCommandQ

Definition at line 479 of file GameController.m.

{
    [self exitAppWithContext:@"Command-Q"];
}

exitAppWithContext:

- (void) exitAppWithContext:

(NSString *)

context

Definition at line 479 of file GameController.m.

                           :(NSString *)context
{
    [gameView.window orderOut:nil];
    [(OoliteApp *)NSApp setExitContext:context];
    [NSApp terminate:self];
}

Referenced by OOStandardsInternal().

Here is the caller graph for this function:

exitFullScreenMode

- (void) exitFullScreenMode

implementation

Provided by category GameController(FullScreen).

Definition at line 1 of file GameController+FullScreen.m.

{
    [self setFullScreenMode:NO];
}

findDisplayModeForWidth:Height:Refresh:

- (NSDictionary *) findDisplayModeForWidth: (unsigned int)  d_width Height: (unsigned int)  d_height Refresh: (unsigned int)  d_refresh

implementation

Provided by category GameController(FullScreen).

Definition at line 1 of file GameController+FullScreen.m.

                                          :(unsigned int)d_width Height:(unsigned int)d_height Refresh:(unsigned int)d_refresh
{
    return [_fullScreenController findDisplayModeForWidth:d_width height:d_height refreshRate:d_refresh];
}

finishedLaunching

- (BOOL) finishedLaunching

Definition at line 1048 of file GameController.m.

{
    return _finishedLaunching;
}

gameView

- (MyOpenGLView *) gameView

GetPreference

+ (static id) GetPreference (NSString *)  key (Class)  expectedClass

implementation

Definition at line 464 of file GameController.m.

{
    id result = [[NSUserDefaults standardUserDefaults] objectForKey:key];
    if (expectedClass != Nil && ![result isKindOfClass:expectedClass])  result = nil;
    
    return result;
}

References nil.

indexOfCurrentDisplayMode

- (NSUInteger) indexOfCurrentDisplayMode

implementation

Provided by category GameController(FullScreen).

Definition at line 1 of file GameController+FullScreen.m.

{
    return [_fullScreenController indexOfCurrentDisplayMode];
}

inFullScreenMode

- (BOOL) inFullScreenMode

implementation

Provided by category GameController(FullScreen).

Definition at line 1 of file GameController+FullScreen.m.

{
    return [_fullScreenController inFullScreenMode];
}

init

- (id) init

implementation

Definition at line 1048 of file GameController.m.

{
    if (sSharedController != nil)
    {
        [self release];
        [NSException raise:NSInternalInconsistencyException format:@"%s: expected only one GameController to exist at a time.", __PRETTY_FUNCTION__];
    }
    
    if ((self = [super init]))
    {
        _finishedLaunching = NO;
        last_timeInterval = [NSDate timeIntervalSinceReferenceDate];
        delta_t = 0.01; // one hundredth of a second 
        _animationTimerInterval = [[NSUserDefaults standardUserDefaults] oo_doubleForKey:@"animation_timer_interval" defaultValue:MINIMUM_ANIMATION_TICK];
        
        // rather than seeding this with the date repeatedly, seed it
        // once here at startup
        ranrot_srand((uint32_t)[[NSDate date] timeIntervalSince1970]);   // reset randomiser with current time
        
        _splashStart = [[NSDate alloc] init];
    }
    
    return self;
}

isDirectoryAtPath:

- (BOOL) isDirectoryAtPath: (NSString *)  path

implementation

Definition at line 479 of file GameController.m.

                          :(NSString *)path
{
    BOOL isDirectory;
    return [NSFileManager.defaultManager fileExistsAtPath:path isDirectory:&isDirectory] && isDirectory;
}

isGamePaused

- (BOOL) isGamePaused

Definition at line 1048 of file GameController.m.

{
    return gameIsPaused;
}

loadPlayerIfRequired

- (void) loadPlayerIfRequired

Definition at line 1048 of file GameController.m.

{
    if (playerFileToLoad != nil)
    {
        [self logProgress:DESC(@"loading-player")];
        // fix problem with non-shader lighting when starting skips
        // the splash screen
        [UNIVERSE useGUILightSource:YES];
        [UNIVERSE useGUILightSource:NO];
        [PLAYER loadPlayerFromFile:playerFileToLoad asNew:NO];
    }
}

logProgress:

- (void) logProgress:

(NSString *)

message

Definition at line 479 of file GameController.m.

                    :(NSString *)message
{
    if (![UNIVERSE doingStartUp])  return;
    
#if OOLITE_MAC_OS_X
    [splashProgressTextField setStringValue:message];
    [splashProgressTextField display];
#endif
    if([message length] > 0)
    {
        OOLog(@"startup.progress", @"===== [%.2f s] %@", -[_splashStart timeIntervalSinceNow], message);
    }
}

Referenced by NoteVerificationStage().

Here is the caller graph for this function:

mouseInteractionMode

- (OOMouseInteractionMode) mouseInteractionMode

Definition at line 1048 of file GameController.m.

{
    return _mouseMode;
}

openPath:

- (void) openPath: (NSString *)  path

implementation

Definition at line 479 of file GameController.m.

                 :(NSString *)path
{
    [NSWorkspace.sharedWorkspace openURL:[NSURL fileURLWithPath:path]];
}

pauseFullScreenModeToPerform:onTarget:

- (void) pauseFullScreenModeToPerform: (SEL)  selector onTarget: (id)  target

implementation

Provided by category GameController(FullScreen).

Definition at line 1 of file GameController+FullScreen.m.

                                     :(SEL)selector onTarget:(id)target
{
    [target performSelector:selector];
}

performGameTick:

- (void) performGameTick:

(id)

sender

Definition at line 1048 of file GameController.m.

                        :(id)sender
{
    [gameView pollControls];
    [self doPerformGameTick];
}

playerFileDirectory

- (NSString *) playerFileDirectory

playerFileToLoad

- (NSString *) playerFileToLoad

recenterVirtualJoystick

- (void) recenterVirtualJoystick

Definition at line 1048 of file GameController.m.

{
    // FIXME: does this really need to be spread across GameController and MyOpenGLView? -- Ahruman 2011-01-22
    my_mouse_x = my_mouse_y = 0;    // center mouse
    [gameView setVirtualJoystick:0.0 :0.0];
}

RemovePreference

+ (static void) RemovePreference (NSString *)  key

implementation

Definition at line 479 of file GameController.m.

{
    [[NSUserDefaults standardUserDefaults] removeObjectForKey:key];
}

reportUnhandledStartupException:

- (void) reportUnhandledStartupException: (NSException *)  exception

implementation

Provided by category GameController(OOPrivate).

Definition at line 479 of file GameController.m.

                                       :(NSException *)exception
{
    OOLog(@"startup.exception", @"***** Unhandled exception during startup: %@ (%@).", [exception name], [exception reason]);
    
    #if OOLITE_MAC_OS_X
        // Display an error alert.
        // TODO: provide better information on reporting bugs in the manual, and refer to it here.
        NSRunCriticalAlertPanel(@"Oolite failed to start up, because an unhandled exception occurred.", @"An exception of type %@ occurred. If this problem persists, please file a bug report.", @"OK", NULL, NULL, [exception name]);
    #endif
}

setDisplayWidth:Height:Refresh:

- (BOOL) setDisplayWidth: (unsigned int)  d_width Height: (unsigned int)  d_height Refresh: (unsigned int)  d_refresh

implementation

Provided by category GameController(FullScreen).

Definition at line 1 of file GameController+FullScreen.m.

                        :(unsigned int)width Height:(unsigned int)height Refresh:(unsigned int)refreshRate
{
    if ([_fullScreenController setDisplayWidth:width height:height refreshRate:refreshRate])
    {
        NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
        
        [userDefaults setInteger:width          forKey:@"display_width"];
        [userDefaults setInteger:height         forKey:@"display_height"];
        [userDefaults setInteger:refreshRate    forKey:@"display_refresh"];
        
        [userDefaults synchronize];
        
        return YES;
    }
    else
    {
        return NO;
    }
}

setEcoQoS:

- (void) setEcoQoS:

(BOOL)

efficiencyModeRequested

Definition at line 1048 of file GameController.m.

                  : (BOOL)efficiencyModeRequested
{
#if OOLITE_WINDOWS
    if ([[NSUserDefaults standardUserDefaults] oo_boolForKey:@"ecoqos" defaultValue:YES])
    {
        BOOL setEfficiencyMode = !!efficiencyModeRequested; // yes or no, not 42
        HANDLE currentProcess = GetCurrentProcess();
        
        if (EXPECT_NOT(!SetPriorityClass(currentProcess, setEfficiencyMode ? IDLE_PRIORITY_CLASS : NORMAL_PRIORITY_CLASS)))
        {
            OOLog(@"gameController.setEcoQos", @"SetPriorityClass failed with error %lu", GetLastError());
        }
        
        PROCESS_POWER_THROTTLING_STATE powerThrottling;
        RtlZeroMemory(&powerThrottling, sizeof(powerThrottling));
        powerThrottling.Version = PROCESS_POWER_THROTTLING_CURRENT_VERSION;
        powerThrottling.ControlMask = PROCESS_POWER_THROTTLING_EXECUTION_SPEED;
        powerThrottling.StateMask = setEfficiencyMode ? PROCESS_POWER_THROTTLING_EXECUTION_SPEED : 0;
        if (EXPECT_NOT(!SetProcessInformation(currentProcess, ProcessPowerThrottling, &powerThrottling, sizeof(powerThrottling))))
        {
            OOLog(@"gameController.setEcoQos", @"SetProcessInformation failed with error %lu", GetLastError());
        }
    }
#endif
}

setFullScreenMode:

- (void) setFullScreenMode: (BOOL)  value

implementation

Provided by category GameController(FullScreen).

Definition at line 1 of file GameController+FullScreen.m.

                          :(BOOL)value
{
    if (value == [self inFullScreenMode])  return;
    
    [[NSUserDefaults standardUserDefaults] setBool:value forKey:@"fullscreen"];
    
    if (value)
    {
        [_fullScreenController setFullScreenMode:YES];
    }
    else
    {
        [_fullScreenController setFullScreenMode:NO];
    }
}

setGamePaused:

- (void) setGamePaused:

(BOOL)

value

Definition at line 1048 of file GameController.m.

                      :(BOOL)value
{
    if (value && !gameIsPaused)
    {
        _resumeMode = [self mouseInteractionMode];
        [self setMouseInteractionModeForUIWithMouseInteraction:NO];
        [self setEcoQoS:YES];
        gameIsPaused = YES;
        [PLAYER doScriptEvent:OOJSID("gamePaused")];
    }
    else if (!value && gameIsPaused)
    {
        [self setMouseInteractionMode:_resumeMode];
        [self setEcoQoS:NO];
        gameIsPaused = NO;
        [PLAYER doScriptEvent:OOJSID("gameResumed")];
    }
}

Referenced by StationDockPlayer().

Here is the caller graph for this function:

setGameView:

- (void) setGameView:

(MyOpenGLView *)

view

Definition at line 1048 of file GameController.m.

                    :(MyOpenGLView *)view
{
    [gameView release];
    gameView = [view retain];
    [gameView setGameController:self];
    [UNIVERSE setGameView:gameView];
}

setMouseInteractionMode:

- (void) setMouseInteractionMode:

(OOMouseInteractionMode)

mode

Definition at line 1048 of file GameController.m.

                                :(OOMouseInteractionMode)mode
{
    OOMouseInteractionMode oldMode = _mouseMode;
    if (mode == oldMode)  return;
    
    _mouseMode = mode;
    OOLog(@"input.mouseMode.changed", @"Mouse interaction mode changed from %@ to %@", OOStringFromMouseInteractionMode(oldMode), OOStringFromMouseInteractionMode(mode));
    
#if OO_USE_FULLSCREEN_CONTROLLER
    if ([self inFullScreenMode])
    {
        [_fullScreenController noteMouseInteractionModeChangedFrom:oldMode to:mode];
    }
    else
#endif
    {
        [[self gameView] noteMouseInteractionModeChangedFrom:oldMode to:mode];
    }
}

setMouseInteractionModeForFlight

- (void) setMouseInteractionModeForFlight

Definition at line 1048 of file GameController.m.

{
    [self setMouseInteractionMode:[PLAYER isMouseControlOn] ? MOUSE_MODE_FLIGHT_WITH_MOUSE_CONTROL : MOUSE_MODE_FLIGHT_NO_MOUSE_CONTROL];
}

setMouseInteractionModeForUIWithMouseInteraction:

- (void) setMouseInteractionModeForUIWithMouseInteraction:

(BOOL)

interaction

Definition at line 1048 of file GameController.m.

                                                         :(BOOL)interaction
{
    [self setMouseInteractionMode:interaction ? MOUSE_MODE_UI_SCREEN_WITH_INTERACTION : MOUSE_MODE_UI_SCREEN_NO_INTERACTION];
}

setPlayerFileDirectory:

- (void) setPlayerFileDirectory:

(NSString *)

filename

Definition at line 479 of file GameController.m.

                               :(NSString *)filename
{   
    if (playerFileDirectory != nil)
    {
        [playerFileDirectory autorelease];
        playerFileDirectory = nil;
    }
    
    if ([[[filename pathExtension] lowercaseString] isEqual:@"oolite-save"])
    {
        filename = [filename stringByDeletingLastPathComponent];
    }
    
    playerFileDirectory = [filename retain];
    [[NSUserDefaults standardUserDefaults] setObject:filename forKey:@"save-directory"];
}

setPlayerFileToLoad:

- (void) setPlayerFileToLoad:

(NSString *)

filename

Definition at line 479 of file GameController.m.

                            :(NSString *)filename
{
    if (playerFileToLoad)
        [playerFileToLoad autorelease];
    playerFileToLoad = nil;
    if ([[[filename pathExtension] lowercaseString] isEqual:@"oolite-save"])
        playerFileToLoad = [filename copy];
}

Referenced by main().

Here is the caller graph for this function:

SetPreference

+ (static void) SetPreference (NSString *)  key (id)  value

implementation

Definition at line 473 of file GameController.m.

{
    [[NSUserDefaults standardUserDefaults] setObject:value forKey:key];
}

setUpBasicOpenGLStateWithSize:

- (void) setUpBasicOpenGLStateWithSize:

(NSSize)

viewSize

Definition at line 479 of file GameController.m.

                                     :(NSSize)viewSize
{
    OOOpenGLExtensionManager    *extMgr = [OOOpenGLExtensionManager sharedManager];
    
    float   ratio = 0.5;
    float   aspect = viewSize.height/viewSize.width;
    
    OOGL(glClearColor(0.0, 0.0, 0.0, 0.0));
    OOGL(glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT));
    
    OOGL(glClearDepth(1.0));
    OOGL(glViewport(0, 0, viewSize.width, viewSize.height));
    
    OOGLResetProjection(); // reset matrix
    OOGLFrustum(-ratio, ratio, -aspect*ratio, aspect*ratio, 1.0, MAX_CLEAR_DEPTH);  // set projection matrix
        
    OOGL(glDepthFunc(GL_LESS));         // depth buffer
    
    if (UNIVERSE)
    {
        [UNIVERSE setLighting];
    }
    else
    {
        GLfloat black[4] =  {0.0, 0.0, 0.0, 1.0};
        GLfloat white[] =   {1.0, 1.0, 1.0, 1.0};
        GLfloat stars_ambient[] =   {0.25, 0.2, 0.25, 1.0};
        
        OOGL(glLightfv(GL_LIGHT1, GL_AMBIENT, black));
        OOGL(glLightfv(GL_LIGHT1, GL_SPECULAR, white));
        OOGL(glLightfv(GL_LIGHT1, GL_DIFFUSE, white));
        OOGL(glLightfv(GL_LIGHT1, GL_POSITION, black));
        OOGL(glLightModelfv(GL_LIGHT_MODEL_AMBIENT, stars_ambient));
        
    }
    
    if ([extMgr usePointSmoothing])  OOGL(glEnable(GL_POINT_SMOOTH));
    if ([extMgr useLineSmoothing])  OOGL(glEnable(GL_LINE_SMOOTH));
    
    // world's simplest OpenGL optimisations...
#if GL_APPLE_transform_hint
    if ([extMgr haveExtension:@"GL_APPLE_transform_hint"])
    {
        OOGL(glHint(GL_TRANSFORM_HINT_APPLE, GL_FASTEST));
    }
#endif
    
    OOGL(glDisable(GL_NORMALIZE));
    OOGL(glDisable(GL_RESCALE_NORMAL));
    
#if GL_VERSION_1_2
    // For OpenGL 1.2 or later, we want GL_SEPARATE_SPECULAR_COLOR all the time.
    if ([extMgr versionIsAtLeastMajor:1 minor:2])
    {
        OOGL(glLightModeli(GL_LIGHT_MODEL_COLOR_CONTROL, GL_SEPARATE_SPECULAR_COLOR));
    }
#endif
}

setUpDisplayModes

- (void) setUpDisplayModes

implementation

Provided by category GameController(FullScreen).

Definition at line 1 of file GameController+FullScreen.m.

{
#if OOLITE_MAC_OS_X
    OOFullScreenController *fullScreenController = nil;
    
#if OO_MAC_SUPPORT_SYSTEM_STANDARD_FULL_SCREEN
    if ([OOMacSystemStandardFullScreenController shouldUseSystemStandardFullScreenController])
    {
        fullScreenController = [[OOMacSystemStandardFullScreenController alloc] initWithGameView:gameView];
    }
#endif
    
    if (fullScreenController == nil)
    {
        fullScreenController = [[OOMacSnowLeopardFullScreenController alloc] initWithGameView:gameView];
    }
#endif
    
    // Load preferred display mode, falling back to current mode if no preferences set.
    NSDictionary *currentMode = [fullScreenController currentDisplayMode];
    NSUInteger width = [currentMode oo_unsignedIntegerForKey:kOODisplayWidth];
    NSUInteger height = [currentMode oo_unsignedIntegerForKey:kOODisplayHeight];
    NSUInteger refresh = [currentMode oo_unsignedIntegerForKey:kOODisplayRefreshRate];
    
    NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
    width = [userDefaults oo_unsignedIntegerForKey:@"display_width" defaultValue:width];
    height = [userDefaults oo_unsignedIntegerForKey:@"display_height" defaultValue:height];
    refresh = [userDefaults oo_unsignedIntegerForKey:@"display_refresh" defaultValue:refresh];
    
    [fullScreenController setDisplayWidth:width height:height refreshRate:refresh];
    
    _fullScreenController = fullScreenController;
}

sharedController

+ (GameController *) sharedController

Definition at line 1048 of file GameController.m.

{
    if (sSharedController == nil)
    {
        sSharedController = [[self alloc] init];
    }
    return sSharedController;
}

Referenced by NoteVerificationStage(), and OOStandardsInternal().

Here is the caller graph for this function:

showAddOnsAction:

- (IBAction) showAddOnsAction:

(id)

sender

Definition at line 479 of file GameController.m.

                             :sender
{
    NSArray *paths = ResourceManager.userRootPaths;
    
    // Look for an AddOns directory that actually contains some AddOns.
    for (NSString *path in paths) {
        if ([self addOnsExistAtPath:path]) {
            [self openPath:path];
            return;
        }
    }
    
    // If that failed, look for an AddOns directory that actually exists.
    for (NSString *path in paths) {
        if ([self isDirectoryAtPath:path]) {
            [self openPath:path];
            return;
        }
    }
    
    // None found, create the default path.
    [NSFileManager.defaultManager createDirectoryAtPath:[paths objectAtIndex:0]
                            withIntermediateDirectories:YES
                                             attributes:nil
                                                  error:NULL];
    [self openPath:[paths objectAtIndex:0]];
}

showLogAction:

- (IBAction) showLogAction:

(id)

sender

Definition at line 1048 of file GameController.m.

                          :sender
{
    [[NSWorkspace sharedWorkspace] openFile:[OOLogHandlerGetLogBasePath() stringByAppendingPathComponent:@"Previous.log"]];
}

showLogFolderAction:

- (IBAction) showLogFolderAction:

(id)

sender

Definition at line 1048 of file GameController.m.

                                :sender
{
    [[NSWorkspace sharedWorkspace] openFile:OOLogHandlerGetLogBasePath()];
}

showSnapshotsAction:

- (IBAction) showSnapshotsAction:

(id)

sender

Definition at line 479 of file GameController.m.

                                :sender
{
    [[NSWorkspace sharedWorkspace] openURL:[self snapshotsURLCreatingIfNeeded:YES]];
}

snapshotsURLCreatingIfNeeded:

- (NSURL *) snapshotsURLCreatingIfNeeded:

(BOOL)

create

Definition at line 479 of file GameController.m.

                                        :(BOOL)create
{
    BOOL            stale = NO;
    NSDictionary    *snapshotDirDict = GetPreference(kSnapshotsDirRefKey, [NSDictionary class]);
    NSURL           *url = nil;
    NSString        *name = DESC(@"snapshots-directory-name-mac");
    
    if (snapshotDirDict != nil)
    {
        url = JAURLFromPersistentFileReference(snapshotDirDict, kJAPersistentFileReferenceWithoutUI | kJAPersistentFileReferenceWithoutMounting, &stale);
        if (url != nil)
        {
            NSString *existingName = [[url path] lastPathComponent];
            if ([existingName compare:name options:NSCaseInsensitiveSearch] != 0)
            {
                // Check name from previous access, because we might have changed localizations.
                NSString *originalOldName = GetPreference(kSnapshotsDirNameKey, [NSString class]);
                if (originalOldName == nil || [existingName compare:originalOldName options:NSCaseInsensitiveSearch] != 0)
                {
                    url = nil;
                }
            }
            
            // did we put the old directory in the trash?
            Boolean inTrash = false;
            const UInt8 *utfPath = (const UInt8 *)[[url path] UTF8String];
            
            OSStatus err = DetermineIfPathIsEnclosedByFolder(kOnAppropriateDisk, kTrashFolderType, utfPath, false, &inTrash);
            // if so, create a new directory.
            if (err == noErr && inTrash == true) url = nil;
        }
    }
    
    if (url == nil)
    {
        NSString *path = nil;
        NSArray *searchPaths = NSSearchPathForDirectoriesInDomains(NSDesktopDirectory, NSUserDomainMask, YES);
        if ([searchPaths count] > 0)
        {
            path = [[searchPaths objectAtIndex:0] stringByAppendingPathComponent:name];
        }
        url = [NSURL fileURLWithPath:path];
        
        if (url != nil)
        {
            stale = YES;
            if (create)
            {
                NSFileManager *fmgr = [NSFileManager defaultManager];
                if (![fmgr fileExistsAtPath:path])
                {
                    [fmgr oo_createDirectoryAtPath:path attributes:nil];
                }
            }
        }
    }
    
    if (stale)
    {
        snapshotDirDict = JAPersistentFileReferenceFromURL(url);
        if (snapshotDirDict != nil)
        {
            SetPreference(kSnapshotsDirRefKey, snapshotDirDict);
            SetPreference(kSnapshotsDirNameKey, [[url path] lastPathComponent]);
        }
        else
        {
            RemovePreference(kSnapshotsDirRefKey);
        }
    }
    
    return url;
}

startAnimationTimer

- (void) startAnimationTimer

Definition at line 1048 of file GameController.m.

{
    if (timer == nil)
    {   
        NSTimeInterval ti = _animationTimerInterval; // default one two-hundredth of a second (should be a fair bit faster than expected frame rate ~60Hz to avoid problems with phase differences)
        
        timer = [[NSTimer timerWithTimeInterval:ti target:self selector:@selector(performGameTick:) userInfo:nil repeats:YES] retain];
        
        [[NSRunLoop currentRunLoop] addTimer:timer forMode:NSDefaultRunLoopMode];
#if OOLITE_MAC_OS_X
        [[NSRunLoop currentRunLoop] addTimer:timer forMode:NSEventTrackingRunLoopMode];
#endif
 
    }
}

stopAnimationTimer

- (void) stopAnimationTimer

Definition at line 1048 of file GameController.m.

{
    if (timer != nil)
    {
        [timer invalidate];
        [timer release];
        timer = nil;
    }
}

suppressClangStuff

- (BOOL) suppressClangStuff

implementation

Definition at line 479 of file GameController.m.

{
    return pauseSelector &&
    pauseTarget;
}

toggleFullScreenAction:

- (IBAction) toggleFullScreenAction: (id)  sender

implementation

Provided by category GameController(FullScreen).

Definition at line 1 of file GameController+FullScreen.m.

                                   :(id)sender
{
    [self setFullScreenMode:![self inFullScreenMode]];
}

toggleFullScreenCalledForWindow:withSender:

- (void) toggleFullScreenCalledForWindow: (OOPrimaryWindow *)  window withSender: (id)  sender

implementation

Provided by category GameController(FullScreen).

Definition at line 1 of file GameController+FullScreen.m.

                                        :(OOPrimaryWindow *)window withSender:(id)sender
{
    [self toggleFullScreenAction:sender];
}

validateMenuItem:

- (BOOL) validateMenuItem: (NSMenuItem *)  menuItem

implementation

Definition at line 479 of file GameController.m.

                         :(NSMenuItem *)menuItem
{
    SEL action = menuItem.action;
    
    if (action == @selector(showLogAction:))
    {
        // the first path is always Resources
        return ([[NSFileManager defaultManager] fileExistsAtPath:[OOLogHandlerGetLogBasePath() stringByAppendingPathComponent:@"Previous.log"]]);
    }
    
    if (action == @selector(showAddOnsAction:))
    {
        // Always enabled in unrestricted mode, to allow users to add OXPs more easily.
        return [ResourceManager useAddOns] != nil;
    }
    
    if (action == @selector(showSnapshotsAction:))
    {
        BOOL    pathIsDirectory;
        if(![[NSFileManager defaultManager] fileExistsAtPath:[self snapshotsURLCreatingIfNeeded:NO].path isDirectory:&pathIsDirectory])
        {
            return NO;
        }
        return pathIsDirectory;
    }
    
    if (action == @selector(toggleFullScreenAction:))
    {
        if (_fullScreenController.fullScreenMode)
        {
            // NOTE: not DESC, because menu titles are not generally localizable.
            menuItem.title = NSLocalizedString(@"Exit Full Screen", NULL);
        }
        else
        {
            menuItem.title = NSLocalizedString(@"Enter Full Screen", NULL);
        }
    }
    
    // default
    return YES;
}

windowDidResize:

- (void) windowDidResize:

(NSNotification *)

aNotification

Definition at line 479 of file GameController.m.

                       :(NSNotification *)aNotification
{
    [gameView updateScreen];
}

Member Data Documentation

_animationTimerInterval

- (NSTimeInterval) _animationTimerInterval

private

Definition at line 75 of file GameController.h.

_fullScreenController

- (OOFullScreenController*) _fullScreenController

private

Definition at line 89 of file GameController.h.

_mouseMode

- (OOMouseInteractionMode) _mouseMode

private

Definition at line 84 of file GameController.h.

_resumeMode

- (OOMouseInteractionMode) _resumeMode

private

Definition at line 85 of file GameController.h.

_splashStart

- (NSDate*) _splashStart

private

Definition at line 77 of file GameController.h.

delta_t

- (double) delta_t

private

Definition at line 66 of file GameController.h.

dockMenu

- (IBOutlet NSMenu*) dockMenu

private

Definition at line 60 of file GameController.h.

expansionPathsToInclude

- (NSMutableArray*) expansionPathsToInclude

private

Definition at line 72 of file GameController.h.

gameIsPaused

- (BOOL) gameIsPaused

private

Definition at line 82 of file GameController.h.

gameView

- (MyOpenGLView *) gameView

private

Definition at line 63 of file GameController.h.

Referenced by OoliteApp::sendEvent:.

gameWindow

- (IBOutlet NSWindow*) gameWindow

private

Definition at line 58 of file GameController.h.

helpView

- (IBOutlet PDFView*) helpView

private

Definition at line 59 of file GameController.h.

last_timeInterval

- (NSTimeInterval) last_timeInterval

private

Definition at line 65 of file GameController.h.

my_mouse_x

- (int) my_mouse_x

private

Definition at line 68 of file GameController.h.

my_mouse_y

- (int) my_mouse_y

private

Definition at line 68 of file GameController.h.

pauseSelector

- (SEL) pauseSelector

private

Definition at line 79 of file GameController.h.

pauseTarget

- (NSObject*) pauseTarget

private

Definition at line 80 of file GameController.h.

playerFileDirectory

- (NSString *) playerFileDirectory

private

Definition at line 70 of file GameController.h.

playerFileToLoad

- (NSString *) playerFileToLoad

private

Definition at line 71 of file GameController.h.

splashProgressTextField

- (IBOutlet NSTextField*) splashProgressTextField

private

Definition at line 56 of file GameController.h.

splashView

- (IBOutlet NSView*) splashView

private

Definition at line 57 of file GameController.h.

timer

- (NSTimer*) timer

private

Definition at line 74 of file GameController.h.

---

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

• src/Core/GameController.h
• src/Core/GameController.m