#include <PlayerEntityControls.h>

Instance Methods
(void)	- initControls

(void)	- initKeyConfigSettings

(void)	- pollControls:

(BOOL)	- handleGUIUpDownArrowKeys

(void)	- clearPlanetSearchString

(void)	- targetNewSystem:

(void)	- switchToMainView

(void)	- noteSwitchToView:fromView:

(void)	- beginWitchspaceCountdown:

(void)	- beginWitchspaceCountdown

(void)	- cancelWitchspaceCountdown

(NSArray *)	- processKeyCode:

(BOOL)	- checkNavKeyPress:

(BOOL)	- checkKeyPress:

(BOOL)	- checkKeyPress:fKey_only:

(BOOL)	- checkKeyPress:ignore_ctrl:

(BOOL)	- checkKeyPress:fKey_only:ignore_ctrl:

(int)	- getFirstKeyCode:

(void)	- targetNewSystem:whileTyping: `[implementation]`

Detailed Description

Definition at line 30 of file PlayerEntityControls.h.

Method Documentation

◆ beginWitchspaceCountdown

- (void) beginWitchspaceCountdown

Extends class PlayerEntity.

Definition at line 891 of file PlayerEntityControls.m.

{
    if ([self hasHyperspaceMotor]) {
        [self beginWitchspaceCountdown:hyperspaceMotorSpinTime];
    }
}

References beginWitchspaceCountdown, and PlayerEntity::beginWitchspaceCountdown:.

Referenced by beginWitchspaceCountdown, and beginWitchspaceCountdown:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ beginWitchspaceCountdown:

- (void) beginWitchspaceCountdown: (int) spin_time

Extends class PlayerEntity.

Definition at line 856 of file PlayerEntityControls.m.

                                :(int)spin_time
{
    if ([self hasHyperspaceMotor]) 
    {
        if (spin_time == 0) 
        {
            witchspaceCountdown = hyperspaceMotorSpinTime;
        }
        else 
        {
#ifndef OO_DUMP_PLANETINFO
            if (spin_time < 5) 
            {
                witchspaceCountdown = 5;
            } 
            else 
#endif
            {
                witchspaceCountdown = spin_time;
            }
        }
        [self setStatus:STATUS_WITCHSPACE_COUNTDOWN];
        [self playStandardHyperspace];
        // say it!
        [UNIVERSE clearPreviousMessage];
        int seconds = round(witchspaceCountdown);
        NSString *destination = [UNIVERSE getSystemName:[self nextHopTargetSystemID]];
        [UNIVERSE displayCountdownMessage:OOExpandKey(@"witch-to-x-in-y-seconds", seconds, destination) forCount:1.0];
        [self doScriptEvent:OOJSID("playerStartedJumpCountdown")
                    withArguments:[NSArray arrayWithObjects:@"standard", [NSNumber numberWithFloat:witchspaceCountdown], nil]];
        [UNIVERSE preloadPlanetTexturesForSystem:target_system_id];
    }
}

References beginWitchspaceCountdown, ShipEntity::doScriptEvent:withArguments:, PlayerEntity::nextHopTargetSystemID, PlayerEntity::playStandardHyperspace, and ShipEntity::setStatus:.

Here is the call graph for this function:

◆ cancelWitchspaceCountdown

- (void) cancelWitchspaceCountdown

Extends class PlayerEntity.

Definition at line 899 of file PlayerEntityControls.m.

{
    if ([self status] == STATUS_WITCHSPACE_COUNTDOWN) {
        [self setStatus:STATUS_IN_FLIGHT];
        [self playHyperspaceAborted];
    }
    // say it!
    [UNIVERSE clearPreviousMessage];
    [self doScriptEvent:OOJSID("playerCancelledJumpCountdown")];
}

References cancelWitchspaceCountdown, ShipEntity::doScriptEvent:, PlayerEntity::playHyperspaceAborted, and ShipEntity::setStatus:.

Referenced by cancelWitchspaceCountdown.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkKeyPress:

- (BOOL) checkKeyPress: (NSArray*) key_def

Extends class PlayerEntity.

Definition at line 613 of file PlayerEntityControls.m.

                      :(NSArray*)key_def
{
    return [self checkKeyPress:key_def fKey_only:NO ignore_ctrl:NO];
}

References PlayerEntity::checkKeyPress:fKey_only:ignore_ctrl:.

Here is the call graph for this function:

◆ checkKeyPress:fKey_only:

- (BOOL) checkKeyPress:		(NSArray*)	key_def
fKey_only:		(BOOL)	fKey_only

Extends class PlayerEntity.

Definition at line 619 of file PlayerEntityControls.m.

                      :(NSArray*)key_def fKey_only:(BOOL)fKey_only
{
    return [self checkKeyPress:key_def fKey_only:fKey_only ignore_ctrl:NO];
}

References PlayerEntity::checkKeyPress:fKey_only:ignore_ctrl:.

Here is the call graph for this function:

◆ checkKeyPress:fKey_only:ignore_ctrl:

- (BOOL) checkKeyPress:	(NSArray*)	key_def
fKey_only:	(BOOL)	fKey_only
ignore_ctrl:	(BOOL)	ignore_ctrl

Extends class PlayerEntity.

Definition at line 631 of file PlayerEntityControls.m.

                      :(NSArray*)key_def fKey_only:(BOOL)fKey_only ignore_ctrl:(BOOL)ignore_ctrl
{
    MyOpenGLView  *gameView = [UNIVERSE gameView];
    int i;
    for (i = 0; i < [key_def count]; i++) 
    {
        NSDictionary *def = [key_def objectAtIndex:i];
        int keycode = [[def objectForKey:@"key"] intValue];
        // skip normal keys if the fKey_only flag is set
        // note: if the player has remapped the gui screen keys to not include function keys, they will not be able to 
        // switch screens directly (they would need to finish the task - ie press enter, or use the escape key to cancel the function)
        // note: the logic below now means that the state of the modifiers must match the requirements for the key binding, including 
        // when all settings are off. This means, if the player presses two functions at once, one that requires a modifier and
        // one that doesn't, the one that doesn't will not be triggered.
        if (fKey_only == YES && (keycode < gvFunctionKey1 || keycode > gvFunctionKey11)) continue;
        if ([gameView isDown:keycode] 
            && ([[def objectForKey:@"shift"] boolValue] == [gameView isShiftDown])
            && (ignore_ctrl || ([[def objectForKey:@"mod1"] boolValue] == [gameView isCtrlDown]))
            && ([[def objectForKey:@"mod2"] boolValue] == [gameView isOptDown])
        ) return YES;
    }
    return NO;
}

References gvFunctionKey11.

◆ checkKeyPress:ignore_ctrl:

- (BOOL) checkKeyPress:		(NSArray*)	key_def
ignore_ctrl:		(BOOL)	ignore_ctrl

Extends class PlayerEntity.

Definition at line 625 of file PlayerEntityControls.m.

                      :(NSArray*)key_def ignore_ctrl:(BOOL)ignore_ctrl
{
    return [self checkKeyPress:key_def fKey_only:NO ignore_ctrl:ignore_ctrl];
}

References PlayerEntity::checkKeyPress:fKey_only:ignore_ctrl:.

Here is the call graph for this function:

◆ checkNavKeyPress:

- (BOOL) checkNavKeyPress: (NSArray*) key_def

Extends class PlayerEntity.

Definition at line 600 of file PlayerEntityControls.m.

                         :(NSArray*)key_def
{
    MyOpenGLView  *gameView = [UNIVERSE gameView];
    int i;
    for (i = 0; i < [key_def count]; i++) 
    {
        NSDictionary *def = [key_def objectAtIndex:i];
        if ([gameView isDown:[[def objectForKey:@"key"] intValue]]) return YES;
    }
    return NO;
}

◆ clearPlanetSearchString

- (void) clearPlanetSearchString

Extends class PlayerEntity.

Definition at line 819 of file PlayerEntityControls.m.

{
    [[UNIVERSE gameView] resetTypedString];
    if (planetSearchString)  [planetSearchString release];
    planetSearchString = nil;
}

References clearPlanetSearchString, and nil.

Referenced by clearPlanetSearchString.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFirstKeyCode:

- (int) getFirstKeyCode: (NSArray*) key_def

Extends class PlayerEntity.

Definition at line 656 of file PlayerEntityControls.m.

                       :(NSArray*)key_def
{
    NSDictionary *def = [key_def objectAtIndex:0];
    return [[def objectForKey:@"key"] intValue];
}

References int().

Here is the call graph for this function:

◆ handleGUIUpDownArrowKeys

- (BOOL) handleGUIUpDownArrowKeys

Extends class PlayerEntity.

Definition at line 716 of file PlayerEntityControls.m.

{
    MyOpenGLView    *gameView = [UNIVERSE gameView];
    GuiDisplayGen   *gui = [UNIVERSE gui];
    BOOL            result = NO;
    BOOL            arrow_up = [self checkKeyPress:n_key_gui_arrow_up]; 
    BOOL            arrow_down = [self checkKeyPress:n_key_gui_arrow_down]; 
    BOOL            mouse_click = [gameView isDown:gvMouseLeftButton];
    BOOL            mouse_dbl_click = [gameView isDown:gvMouseDoubleClick];
 
    if (arrow_down)
    {
        if ((!upDownKeyPressed) || (script_time > timeLastKeyPress + KEY_REPEAT_INTERVAL))
        {
            if ([gui setNextRow: +1])
            {
                result = YES;
            }
            else
            {
                if ([gui setFirstSelectableRow])  result = YES;
            }
            
            if (result && [gui selectableRange].length > 1)  [self playMenuNavigationDown];
            else  [self playMenuNavigationNot];
            
            timeLastKeyPress = script_time;
        }
    }
    
    if (arrow_up)
    {
        if ((!upDownKeyPressed) || (script_time > timeLastKeyPress + KEY_REPEAT_INTERVAL))
        {
            if ([gui setNextRow: -1])
            {
                result = YES;
            }
            else
            {
                if ([gui setLastSelectableRow])  result = YES;
            }
            
            if (result && [gui selectableRange].length > 1)  [self playMenuNavigationUp];
            else  [self playMenuNavigationNot];
 
            timeLastKeyPress = script_time;
        }
    }
    
    if (mouse_click)
    {
        if (!upDownKeyPressed)
        {
            int click_row = 0;
            if (UNIVERSE)
                click_row = UNIVERSE->cursor_row;
            if ([gui setSelectedRow:click_row])
            {
                result = YES;
            }
        }
    }
    if (mouse_dbl_click)
    {
        int click_row = 0;
        if (UNIVERSE)
            click_row = UNIVERSE->cursor_row;
        if ([gui setSelectedRow:click_row])
        {
            result = YES;
        }
        else
        {
            // if double-clicked on an unselectable row, clear the
            // state so it doesn't activate whatever was last
            // selected
            [gameView clearMouse];
        }
    }
 
    
    upDownKeyPressed = (arrow_up || arrow_down || mouse_click);
    
    return result;
}

References PlayerEntity::checkKeyPress:, MyOpenGLView::clearMouse, handleGUIUpDownArrowKeys, MyOpenGLView::isDown:, KEY_REPEAT_INTERVAL, PlayerEntity::playMenuNavigationDown, PlayerEntity::playMenuNavigationNot, PlayerEntity::playMenuNavigationUp, timeLastKeyPress, UNIVERSE, and upDownKeyPressed.

Referenced by handleGUIUpDownArrowKeys.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initControls

- (void) initControls

Extends class PlayerEntity.

Definition at line 207 of file PlayerEntityControls.m.

{
    [keyCodeLookups release];
    // all entries in this dict must be in lowercase
    keyCodeLookups = [[NSDictionary alloc] initWithObjectsAndKeys:
        [NSNumber numberWithUnsignedShort:gvArrowKeyLeft], @"arrowleft", 
        [NSNumber numberWithUnsignedShort:gvArrowKeyLeft], @"leftarrow", 
        [NSNumber numberWithUnsignedShort:gvArrowKeyLeft], @"left", 
        [NSNumber numberWithUnsignedShort:gvArrowKeyRight], @"arrowright", 
        [NSNumber numberWithUnsignedShort:gvArrowKeyRight], @"rightarrow", 
        [NSNumber numberWithUnsignedShort:gvArrowKeyRight], @"right", 
        [NSNumber numberWithUnsignedShort:gvArrowKeyUp], @"arrowup", 
        [NSNumber numberWithUnsignedShort:gvArrowKeyUp], @"uparrow", 
        [NSNumber numberWithUnsignedShort:gvArrowKeyUp], @"up", 
        [NSNumber numberWithUnsignedShort:gvArrowKeyDown], @"arrowdown", 
        [NSNumber numberWithUnsignedShort:gvArrowKeyDown], @"downarrow", 
        [NSNumber numberWithUnsignedShort:gvArrowKeyDown], @"down", 
        [NSNumber numberWithUnsignedShort:gvPageUpKey], @"pageup", 
        [NSNumber numberWithUnsignedShort:gvPageDownKey], @"pagedown", 
        [NSNumber numberWithUnsignedShort:13], @"enter", 
        [NSNumber numberWithUnsignedShort:13], @"return", 
        [NSNumber numberWithUnsignedShort:27], @"escape", 
        [NSNumber numberWithUnsignedShort:27], @"esc", 
        [NSNumber numberWithUnsignedShort:9], @"tab", 
        [NSNumber numberWithUnsignedShort:32], @"space", 
        [NSNumber numberWithUnsignedShort:32], @"spc", 
        [NSNumber numberWithUnsignedShort:gvHomeKey], @"home", 
        [NSNumber numberWithUnsignedShort:gvEndKey], @"end", 
        [NSNumber numberWithUnsignedShort:gvDeleteKey], @"delete", 
        [NSNumber numberWithUnsignedShort:gvDeleteKey], @"del", 
        [NSNumber numberWithUnsignedShort:gvBackspaceKey], @"backspace", 
        [NSNumber numberWithUnsignedShort:gvBackspaceKey], @"backspc", 
        [NSNumber numberWithUnsignedShort:gvBackspaceKey], @"bkspace", 
        [NSNumber numberWithUnsignedShort:gvBackspaceKey], @"bkspc", 
        [NSNumber numberWithUnsignedShort:gvInsertKey], @"insert", 
        [NSNumber numberWithUnsignedShort:gvInsertKey], @"ins", 
        [NSNumber numberWithUnsignedShort:gvFunctionKey1], @"f1", 
        [NSNumber numberWithUnsignedShort:gvFunctionKey2], @"f2", 
        [NSNumber numberWithUnsignedShort:gvFunctionKey3], @"f3", 
        [NSNumber numberWithUnsignedShort:gvFunctionKey4], @"f4", 
        [NSNumber numberWithUnsignedShort:gvFunctionKey5], @"f5", 
        [NSNumber numberWithUnsignedShort:gvFunctionKey6], @"f6", 
        [NSNumber numberWithUnsignedShort:gvFunctionKey7], @"f7", 
        [NSNumber numberWithUnsignedShort:gvFunctionKey8], @"f8", 
        [NSNumber numberWithUnsignedShort:gvFunctionKey9], @"f9", 
        [NSNumber numberWithUnsignedShort:gvFunctionKey10], @"f10", 
        [NSNumber numberWithUnsignedShort:gvFunctionKey11], @"f11", 
        [NSNumber numberWithUnsignedShort:gvPauseKey], @"pause",
        [NSNumber numberWithUnsignedShort:gvPrintScreenKey], @"printscreen",
        [NSNumber numberWithUnsignedShort:gvPrintScreenKey], @"prtscrn",
        [NSNumber numberWithUnsignedShort:gvPrintScreenKey], @"prntscrn",
        [NSNumber numberWithUnsignedShort:gvPrintScreenKey], @"prtscn",
        [NSNumber numberWithUnsignedShort:gvNumberPadKey0], @"numpad0", 
        [NSNumber numberWithUnsignedShort:gvNumberPadKey1], @"numpad1", 
        [NSNumber numberWithUnsignedShort:gvNumberPadKey2], @"numpad2", 
        [NSNumber numberWithUnsignedShort:gvNumberPadKey3], @"numpad3", 
        [NSNumber numberWithUnsignedShort:gvNumberPadKey4], @"numpad4", 
        [NSNumber numberWithUnsignedShort:gvNumberPadKey5], @"numpad5", 
        [NSNumber numberWithUnsignedShort:gvNumberPadKey6], @"numpad6", 
        [NSNumber numberWithUnsignedShort:gvNumberPadKey7], @"numpad7", 
        [NSNumber numberWithUnsignedShort:gvNumberPadKey8], @"numpad8", 
        [NSNumber numberWithUnsignedShort:gvNumberPadKey9], @"numpad9", 
        [NSNumber numberWithUnsignedShort:gvNumberPadKeyDivide], @"numpad/",
        [NSNumber numberWithUnsignedShort:gvNumberPadKeyDivide], @"numpaddivide",
        [NSNumber numberWithUnsignedShort:gvNumberPadKeyMultiply], @"numpad*",
        [NSNumber numberWithUnsignedShort:gvNumberPadKeyMultiply], @"numpadmultiply",
        [NSNumber numberWithUnsignedShort:gvNumberPadKeyMinus], @"numpad-",
        [NSNumber numberWithUnsignedShort:gvNumberPadKeyMinus], @"numpadminus",
        [NSNumber numberWithUnsignedShort:gvNumberPadKeyPlus], @"numpad+",
        [NSNumber numberWithUnsignedShort:gvNumberPadKeyPlus], @"numpadplus",
        [NSNumber numberWithUnsignedShort:gvNumberPadKeyPeriod], @"numpad.",
        [NSNumber numberWithUnsignedShort:gvNumberPadKeyPeriod], @"numpadperiod",
        [NSNumber numberWithUnsignedShort:gvNumberPadKeyEquals], @"numpad=",
        [NSNumber numberWithUnsignedShort:gvNumberPadKeyEquals], @"numpadequals",
        [NSNumber numberWithUnsignedShort:gvNumberPadKeyEnter], @"numpadenter", nil];
 
    keyShiftText = [DESC(@"oolite-keyconfig-shift") retain];
    keyMod1Text = [DESC(@"oolite-keyconfig-mod1") retain];
#if OOLITE_MAC_OS_X
    keyMod2Text = [DESC(@"oolite-keyconfig-mod2-mac") retain];
#else
    keyMod2Text = [DESC(@"oolite-keyconfig-mod2-pc") retain];
#endif
 
    [self initKeyConfigSettings];
 
    // Enable polling
    pollControls=YES;
}

References initControls, and PlayerEntity::initKeyConfigSettings.

Referenced by initControls.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initKeyConfigSettings

- (void) initKeyConfigSettings

Extends class PlayerEntity.

Definition at line 297 of file PlayerEntityControls.m.

{
    NSMutableDictionary *kdicmaster = [NSMutableDictionary dictionaryWithDictionary:[ResourceManager dictionaryFromFilesNamed:@"keyconfig2.plist" inFolder:@"Config" mergeMode:MERGE_BASIC cache:NO]];
    NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
    NSString *kbd = [defaults oo_stringForKey:@"keyboard-code" defaultValue:@"default"];
    NSMutableDictionary *kdic2 = [NSMutableDictionary dictionaryWithDictionary:[kdicmaster objectForKey:kbd]];
 
    unsigned        i;
    NSArray         *keys = nil;
    id              key = nil;
    NSArray         *def_list = nil;
 
    keys = [kdic2 allKeys];
    for (i = 0; i < [keys count]; i++)
    {
        key = [keys objectAtIndex:i];
        if ([[kdic2 objectForKey:key] isKindOfClass:[NSArray class]])
        {
            def_list = (NSArray*)[kdic2 objectForKey: key];
            [kdic2 setObject:[self processKeyCode:def_list] forKey:key];
        }
    }
 
    // load custom equipment keys/buttons
    [customEquipActivation release];
    if ([defaults objectForKey:KEYCONFIG_CUSTOMEQUIP]) 
    {
        NSArray *temp = [defaults arrayForKey:KEYCONFIG_CUSTOMEQUIP];
        customEquipActivation = [[NSMutableArray arrayWithArray:temp] retain];
    }
    else 
    {
        customEquipActivation = [[NSMutableArray alloc] init];
    }
    [customActivatePressed release];
    [customModePressed release];
    customActivatePressed = [[NSMutableArray alloc] init];
    customModePressed = [[NSMutableArray alloc] init];
    for (i = 0; i < [customEquipActivation count]; i++)
    {
        [customActivatePressed addObject:[NSNumber numberWithBool:NO]];
        [customModePressed addObject:[NSNumber numberWithBool:NO]];
    }
 
    NSMutableArray *keyDef = nil;
    NSString *lookup = nil;
    NSArray *curr = nil;
    NSDictionary *key1 = nil;
    NSDictionary *key2 = nil;
 
    // update with overrides from defaults file
    NSDictionary *dict = [defaults objectForKey:KEYCONFIG_OVERRIDES];
 
    keys = [dict allKeys];
    for (i = 0; i < [keys count]; i++)
    {
        key = [keys objectAtIndex:i];
        [kdic2 setObject:[dict objectForKey:key] forKey:key];
    }
 
// by default none of the standard key functions require more than 2 entries, so our macro will limit itself to 2
// also, none of the standard key functions utilise "Alt" (mod2), so we're defaulting that setting
#define LOAD_KEY_SETTING2(name, default_1, shift_1, mod1_1, default_2, shift_2, mod1_2) \
    lookup = [@#name substringFromIndex:2]; \
    curr = (NSArray*)[[kdic2 objectForKey:lookup] copy]; \
    key1 = [[NSDictionary alloc] initWithObjectsAndKeys:[NSNumber numberWithUnsignedShort:default_1], @"key", [NSNumber numberWithBool:shift_1], @"shift", [NSNumber numberWithBool:mod1_1], @"mod1", [NSNumber numberWithBool:NO], @"mod2", nil]; \
    [keyDef addObject:key1]; \
    if (default_2 > 0) \
    { \
        key2 = [[NSDictionary alloc] initWithObjectsAndKeys:[NSNumber numberWithUnsignedShort:default_2], @"key", [NSNumber numberWithBool:shift_2], @"shift", [NSNumber numberWithBool:mod1_2], @"mod1", [NSNumber numberWithBool:NO], @"mod2", nil]; \
        [keyDef addObject:key2]; \
    } \
    name = curr?:keyDef; \
    [kdic2 setObject:curr?:keyDef forKey:lookup]; \
    [keyDef release];
 
    LOAD_KEY_SETTING2(n_key_roll_left, gvArrowKeyLeft, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_roll_right,    gvArrowKeyRight, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_pitch_forward, gvArrowKeyUp, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_pitch_back, gvArrowKeyDown, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_yaw_left, ',', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_yaw_right, '.', NO, NO, 0, NO, NO);
 
    LOAD_KEY_SETTING2(n_key_view_forward, '1', NO, NO, gvFunctionKey1, NO, NO);
    LOAD_KEY_SETTING2(n_key_view_aft, '2', NO, NO, gvFunctionKey2, NO, NO);
    LOAD_KEY_SETTING2(n_key_view_port, '3', NO, NO, gvFunctionKey3, NO, NO);
    LOAD_KEY_SETTING2(n_key_view_starboard, '4', NO, NO, gvFunctionKey4, NO, NO);
 
    LOAD_KEY_SETTING2(n_key_launch_ship, '1', NO, NO, gvFunctionKey1, NO, NO);
    LOAD_KEY_SETTING2(n_key_gui_screen_options, '2', NO, NO, gvFunctionKey2, NO, NO);
    LOAD_KEY_SETTING2(n_key_gui_screen_equipship, '3', NO, NO, gvFunctionKey3, NO, NO);
    LOAD_KEY_SETTING2(n_key_gui_screen_interfaces, '4', NO, NO, gvFunctionKey4, NO, NO);
    LOAD_KEY_SETTING2(n_key_gui_screen_status, '5', NO, NO, gvFunctionKey5, NO, NO);
    LOAD_KEY_SETTING2(n_key_gui_chart_screens, '6', NO, NO, gvFunctionKey6, NO, NO);
    LOAD_KEY_SETTING2(n_key_gui_system_data, '7', NO, NO, gvFunctionKey7, NO, NO);
    LOAD_KEY_SETTING2(n_key_gui_market, '8', NO, NO, gvFunctionKey8, NO, NO);
 
    LOAD_KEY_SETTING2(n_key_gui_arrow_left, gvArrowKeyLeft, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_gui_arrow_right, gvArrowKeyRight, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_gui_arrow_up, gvArrowKeyUp, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_gui_arrow_down, gvArrowKeyDown, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_gui_page_up, gvPageUpKey, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_gui_page_down, gvPageDownKey, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_gui_select, 13, NO, NO, gvNumberPadKeyEnter, NO, NO);
    
    LOAD_KEY_SETTING2(n_key_increase_speed, 'w', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_decrease_speed, 's', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_inject_fuel, 'i', NO, NO, 0, NO, NO);
    
    LOAD_KEY_SETTING2(n_key_fire_lasers, 'a', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_weapons_online_toggle, '_', YES, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_launch_missile, 'm', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_next_missile, 'y', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_ecm, 'e', NO, NO, 0, NO, NO);
    
    LOAD_KEY_SETTING2(n_key_prime_next_equipment, 'N', YES, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_prime_previous_equipment, 'N', YES, YES, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_activate_equipment, 'n', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_mode_equipment, 'b', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_fastactivate_equipment_a, '0', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_fastactivate_equipment_b, 9, NO, NO, 0, NO, NO);
    
    LOAD_KEY_SETTING2(n_key_target_missile, 't', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_untarget_missile, 'u', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_target_incoming_missile, 'T', YES, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_ident_system, 'r', NO, NO, 0, NO, NO);
    
    LOAD_KEY_SETTING2(n_key_scanner_zoom, 'z', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_scanner_unzoom, 'Z', YES, NO, 0, NO, NO);
    
    LOAD_KEY_SETTING2(n_key_launch_escapepod, 27, NO, NO, 0, NO, NO);
    
    LOAD_KEY_SETTING2(n_key_galactic_hyperspace, 'g', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_hyperspace, 'h', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_jumpdrive, 'j', NO, NO, 0, NO, NO);
    
    LOAD_KEY_SETTING2(n_key_dump_cargo, 'D', YES, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_rotate_cargo, 'R', YES, NO, 0, NO, NO);
    
    LOAD_KEY_SETTING2(n_key_autopilot, 'c', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_autodock, 'C', YES, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_docking_clearance_request, 'L', YES, NO, 0, NO, NO);
    
    LOAD_KEY_SETTING2(n_key_snapshot, '*', YES, NO, gvNumberPadKeyMultiply, NO, NO);
    LOAD_KEY_SETTING2(n_key_docking_music, 's', NO, NO, 0, NO, NO);
    
    LOAD_KEY_SETTING2(n_key_advanced_nav_array_next, '^', YES, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_advanced_nav_array_previous, '^', YES, YES, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_map_home, gvHomeKey, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_map_end, gvEndKey, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_map_next_system, gvArrowKeyRight, NO, NO, gvArrowKeyDown, NO, NO);
    LOAD_KEY_SETTING2(n_key_map_previous_system, gvArrowKeyLeft, NO, NO, gvArrowKeyUp, NO, NO);
    LOAD_KEY_SETTING2(n_key_map_zoom_in, gvPageDownKey, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_map_zoom_out, gvPageUpKey, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_map_info, 'i', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_chart_highlight, '?', YES, NO, 0, NO, NO);
 
    LOAD_KEY_SETTING2(n_key_system_home, gvHomeKey, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_system_end, gvEndKey, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_system_next_system, gvArrowKeyRight, NO, NO, gvArrowKeyDown, NO, NO);
    LOAD_KEY_SETTING2(n_key_system_previous_system, gvArrowKeyLeft, NO, NO, gvArrowKeyUp, NO, NO);
 
    LOAD_KEY_SETTING2(n_key_pausebutton, 'p', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_show_fps, 'F', YES, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_bloom_toggle, gvFunctionKey9, YES, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_mouse_control_roll, 'M', YES, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_mouse_control_yaw, 'M', YES, YES, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_hud_toggle, 'o', NO, NO, 0, NO, NO);
    
    LOAD_KEY_SETTING2(n_key_comms_log, '`', YES, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_prev_compass_mode, '|', YES, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_next_compass_mode, '\\', NO, NO, 0, NO, NO);
    
    LOAD_KEY_SETTING2(n_key_market_filter_cycle, '?', YES, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_market_sorter_cycle, '/', NO, NO, gvNumberPadKeyDivide, NO, NO);
    LOAD_KEY_SETTING2(n_key_market_buy_one, gvArrowKeyRight, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_market_sell_one, gvArrowKeyLeft, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_market_buy_max, gvArrowKeyRight, YES, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_market_sell_max, gvArrowKeyLeft, YES, NO, 0, NO, NO);
 
    LOAD_KEY_SETTING2(n_key_cycle_next_mfd, ';', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_cycle_previous_mfd, ';', NO, YES, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_switch_next_mfd, ':', YES, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_switch_previous_mfd, ':', YES, YES, 0, NO, NO);
 
    LOAD_KEY_SETTING2(n_key_next_target, '+', YES, NO, gvNumberPadKeyPlus, NO, NO);
    LOAD_KEY_SETTING2(n_key_previous_target, '-', NO, NO, gvNumberPadKeyMinus, NO, NO);
    
    LOAD_KEY_SETTING2(n_key_custom_view, 'v', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_custom_view_zoom_out, gvPageDownKey, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_custom_view_zoom_in, gvPageUpKey, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_custom_view_roll_left, gvArrowKeyLeft, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_custom_view_pan_left, gvArrowKeyLeft, YES, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_custom_view_roll_right, gvArrowKeyRight, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_custom_view_pan_right, gvArrowKeyRight, YES, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_custom_view_rotate_up, gvArrowKeyUp, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_custom_view_pan_up, gvArrowKeyUp, YES, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_custom_view_rotate_down, gvArrowKeyDown, NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_custom_view_pan_down, gvArrowKeyDown, YES, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_custom_view_rotate_left, ',', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_custom_view_rotate_right, '.', NO, NO, 0, NO, NO);
 
    LOAD_KEY_SETTING2(n_key_oxzmanager_setfilter, 'f', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_oxzmanager_showinfo, 'i', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_oxzmanager_extract, 'x', NO, NO, 0, NO, NO);
    
#if OO_FOV_INFLIGHT_CONTROL_ENABLED
    LOAD_KEY_SETTING2(n_key_inc_field_of_view, 'l', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_dec_field_of_view, 'k', NO, NO, 0, NO, NO);
#endif
 
#ifndef NDEBUG
    LOAD_KEY_SETTING2(n_key_dump_target_state, 'H', YES, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_dump_entity_list, '0', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_debug_full, 'd', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_debug_collision, 'b', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_debug_console_connect, 'c', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_debug_bounding_boxes, 'x', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_debug_shaders, 's', NO, NO, 0, NO, NO);
    LOAD_KEY_SETTING2(n_key_debug_off, 'n', NO, NO, 0, NO, NO);
#endif
 
    [keyconfig2_settings release];
    keyconfig2_settings = [[NSDictionary alloc] initWithDictionary:kdic2 copyItems:YES];
}

References ResourceManager::dictionaryFromFilesNamed:inFolder:mergeMode:cache:, gvArrowKeyDown, gvArrowKeyLeft, gvArrowKeyRight, gvArrowKeyUp, gvEndKey, gvFunctionKey1, gvFunctionKey2, gvFunctionKey3, gvFunctionKey4, gvFunctionKey5, gvFunctionKey6, gvFunctionKey7, gvFunctionKey8, gvFunctionKey9, gvHomeKey, gvNumberPadKeyDivide, gvNumberPadKeyEnter, gvNumberPadKeyMinus, gvNumberPadKeyMultiply, gvNumberPadKeyPlus, gvPageDownKey, gvPageUpKey, initKeyConfigSettings, KEYCONFIG_CUSTOMEQUIP, LOAD_KEY_SETTING2, nil, and PlayerEntity::processKeyCode:.

Referenced by initKeyConfigSettings.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ noteSwitchToView:fromView:

- (void) noteSwitchToView:		(OOViewID)	toView
fromView:		(OOViewID)	fromView

Extends class PlayerEntity.

Definition at line 849 of file PlayerEntityControls.m.

                         :(OOViewID)toView fromView:(OOViewID)fromView
{
    [self switchToThisView:toView fromView:fromView andProcessWeaponFacing:NO justNotify:YES]; // no extra processing needed!
}

References PlayerEntity::switchToThisView:fromView:andProcessWeaponFacing:justNotify:.

Here is the call graph for this function:

◆ pollControls:

- (void) pollControls: (double) delta_t

Extends class PlayerEntity.

Definition at line 663 of file PlayerEntityControls.m.

                     :(double)delta_t
{
    MyOpenGLView  *gameView = [UNIVERSE gameView];
    NSString *exceptionContext = @"setup";
    
    @try
    {
        if (gameView)
        {
            // poll the gameView keyboard things
            exceptionContext = @"pollApplicationControls";
            [self pollApplicationControls]; // quit command-f etc.
            switch ([self status])
            {
                case STATUS_WITCHSPACE_COUNTDOWN:
                case STATUS_IN_FLIGHT:
                    exceptionContext = @"pollFlightControls";
                    [self pollFlightControls:delta_t];
                    break;
                    
                case STATUS_DEAD:
                    exceptionContext = @"pollGameOverControls";
                    [self pollGameOverControls:delta_t];
                    break;
                    
                case STATUS_AUTOPILOT_ENGAGED:
                    exceptionContext = @"pollAutopilotControls";
                    [self pollAutopilotControls:delta_t];
                    break;
                    
                case STATUS_DOCKED:
                    exceptionContext = @"pollDockedControls";
                    [self pollDockedControls:delta_t];
                    break;
                    
                case STATUS_START_GAME:
                    exceptionContext = @"pollDemoControls";
                    [self pollDemoControls:delta_t];
                    break;
                    
                default:
                    // don't poll extra controls at any other times.
                    break;
            }
        }
    }
    @catch (NSException *exception)
    {
        OOLog(kOOLogException, @"***** Exception checking controls [%@]: %@ : %@", exceptionContext, [exception name], [exception reason]);
    }
}

References kOOLogException, OOLog, PlayerEntity::pollApplicationControls, PlayerEntity::pollAutopilotControls:, PlayerEntity::pollDemoControls:, PlayerEntity::pollDockedControls:, PlayerEntity::pollFlightControls:, and PlayerEntity::pollGameOverControls:.

Here is the call graph for this function:

◆ processKeyCode:

- (NSArray *) processKeyCode: (NSArray*) key_def

Extends class PlayerEntity.

Definition at line 524 of file PlayerEntityControls.m.

                           :(NSArray*)key_def
{
    int i;
    id              key = nil, value = nil;
    int             iValue;
    unsigned char   keychar;
    NSString        *keystring = nil;
    NSDictionary    *def = nil;
    NSMutableArray  *newList = [[NSMutableArray alloc] init];
 
    for (i = 0; i < [key_def count]; i++) 
    {
        def = [key_def objectAtIndex:i];
        if ([def count] == 0) continue; // skip this if the definition is empty
        value = [def objectForKey:@"key"];
        iValue = [value intValue];
 
        // we're going to fully expand all the shift/mod1/mod2 properties for all the key setting with defaults
        // to avoid the need to check for the presence of a property during game loops
        NSMutableDictionary *defNew = [[NSMutableDictionary alloc] init];
        if ([def objectForKey:@"shift"]) [defNew setObject:[def objectForKey:@"shift"] forKey:@"shift"]; else [defNew setObject:[NSNumber numberWithBool:NO] forKey:@"shift"];
        if ([def objectForKey:@"mod1"]) [defNew setObject:[def objectForKey:@"mod1"] forKey:@"mod1"]; else [defNew setObject:[NSNumber numberWithBool:NO] forKey:@"mod1"];
        if ([def objectForKey:@"mod2"]) [defNew setObject:[def objectForKey:@"mod2"] forKey:@"mod2"]; else [defNew setObject:[NSNumber numberWithBool:NO] forKey:@"mod2"];
 
        //  for '0' '1' '2' '3' '4' '5' '6' '7' '8' '9' - we want to interpret those as strings - not numbers
        //  alphabetical characters and symbols will return an intValue of 0.
        
        if ([value isKindOfClass:[NSString class]] && (iValue < 10))
        {
            keystring = value;
 
            // check for a named lookup
            if ([keystring length] != 0)
            {
                int checkVal;
                checkVal = [[keyCodeLookups objectForKey:[keystring lowercaseString]] intValue];
                if (checkVal > 0) {
                    iValue = checkVal;
 
                    [defNew setObject:[NSNumber numberWithUnsignedShort:iValue] forKey:@"key"];
                    [newList addObject:defNew];
                    [defNew release];
                    continue;
                }
            }
 
            if ([keystring length] == 1 || (iValue == 0 && [keystring length] != 0))
            {
                keychar = [keystring characterAtIndex:0] & 0x00ff; // uses lower byte of unichar
            }
            else if (iValue <= 0xFF) keychar = iValue;
            else {
                OOLogWARN(@"testing", @"continue hit for key %@.", key);
                [defNew setObject:[def objectForKey:@"key"] forKey:@"key"];
                [newList addObject:defNew];
                [defNew release];
                continue;
            }
        
            [defNew setObject:[NSNumber numberWithUnsignedShort:keychar] forKey:@"key"];
            [newList addObject:defNew];
            [defNew release];
        } 
        else 
        {
            [defNew setObject:[def objectForKey:@"key"] forKey:@"key"];
            [newList addObject:defNew];
            [defNew release];
        }
    }
 
    return newList;
}

References count, nil, and OOLogWARN.

◆ switchToMainView

- (void) switchToMainView

Extends class PlayerEntity.

Definition at line 833 of file PlayerEntityControls.m.

{
    OOGUIScreenID oldScreen = gui_screen;
    gui_screen = GUI_SCREEN_MAIN;
    if (showDemoShips)
    {
        [self setShowDemoShips: NO];
        [UNIVERSE removeDemoShips];
    }
    [(MyOpenGLView *)[UNIVERSE gameView] allowStringInput:NO];
    if ([self isMouseControlOn])  [[UNIVERSE gameView] resetMouse];
    [UNIVERSE enterGUIViewModeWithMouseInteraction:NO];
    [self noteGUIDidChangeFrom:oldScreen to:gui_screen];
}

References MyOpenGLView::allowStringInput:, PlayerEntity::noteGUIDidChangeFrom:to:, PlayerEntity::setShowDemoShips:, and switchToMainView.

Referenced by switchToMainView.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ targetNewSystem:

- (void) targetNewSystem: (int) direction

Extends class PlayerEntity.

Definition at line 827 of file PlayerEntityControls.m.

                        :(int) direction
{
    [self targetNewSystem:direction whileTyping:NO];
}

References PlayerEntity::targetNewSystem:whileTyping:.

Here is the call graph for this function:

◆ targetNewSystem:whileTyping:

- (void) targetNewSystem:		(int)	direction
whileTyping:		(BOOL)	whileTyping

implementation

Extends class PlayerEntity.

Definition at line 804 of file PlayerEntityControls.m.

                        :(int) direction whileTyping:(BOOL) whileTyping
{
    target_system_id = [[UNIVERSE gui] targetNextFoundSystem:direction];
    [self setInfoSystemID: target_system_id moveChart: YES];
    cursor_coordinates = [[UNIVERSE systemManager] getCoordinatesForSystem:target_system_id inGalaxy:galaxy_number];
 
    found_system_id = target_system_id;
    if (!whileTyping)
    {
        [self clearPlanetSearchString];
    }
    cursor_moving = YES;
}

References PlayerEntity::clearPlanetSearchString, cursor_moving, and PlayerEntity::setInfoSystemID:moveChart:.

Here is the call graph for this function:

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

src/Core/Entities/PlayerEntityControls.h
src/Core/Entities/PlayerEntityControls.m

Instance Methods

Detailed Description

Method Documentation

◆ beginWitchspaceCountdown

◆ beginWitchspaceCountdown:

◆ cancelWitchspaceCountdown

◆ checkKeyPress:

◆ checkKeyPress:fKey_only:

◆ checkKeyPress:fKey_only:ignore_ctrl:

◆ checkKeyPress:ignore_ctrl:

◆ checkNavKeyPress:

◆ clearPlanetSearchString

◆ getFirstKeyCode:

◆ handleGUIUpDownArrowKeys

◆ initControls

◆ initKeyConfigSettings

◆ noteSwitchToView:fromView:

◆ pollControls:

◆ processKeyCode:

◆ switchToMainView

◆ targetNewSystem:

◆ targetNewSystem:whileTyping: